FilesExpand file tree

main

/

validationerror.go

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

79 lines (65 loc) · 2.67 KB

main

/

validationerror.go

Copy path

Top

File metadata and controls

• Code
• Blame

79 lines (65 loc) · 2.67 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

// Package validationerror provides a shared, dependency-neutral payload and

// message formatting for structured field/value/reason/suggestion validation

// errors. Packages such as parser and workflow embed Payload in their own

// error types so that:

// - the message formatting logic (including value truncation) lives in one

// place and future fixes don't need to be duplicated per package, and

// - callers can uniformly detect any structured validation error with

// errors.As(err, &validationerror.ValidationError) regardless of which

// package produced it.

package validationerror

import (

"fmt"

"strings"

"github.com/github/gh-aw/pkg/stringutil"

)

// MaxValueLength is the maximum number of characters kept for the Value field

// when formatting a message with value truncation enabled.

const MaxValueLength = 100

// Payload holds the common field/value/reason/suggestion data shared by

// structured validation errors across packages.

type Payload struct {

Field string

Value string

Reason string

Suggestion string

}

// ValidationField returns the name of the field that failed validation.

func (p Payload) ValidationField() string { return p.Field }

// ValidationValue returns the offending value, if any.

func (p Payload) ValidationValue() string { return p.Value }

// ValidationReason returns the reason validation failed.

func (p Payload) ValidationReason() string { return p.Reason }

// ValidationSuggestion returns actionable remediation guidance, if any.

func (p Payload) ValidationSuggestion() string { return p.Suggestion }

// ValidationError is the common interface implemented by structured

// field/value/reason/suggestion validation errors across packages (for

// example parser.ValidationError and workflow.WorkflowValidationError).

// Use errors.As(err, &target) with a variable of this interface type to

// uniformly extract validation details regardless of the concrete type.

type ValidationError interface {

error

ValidationField() string

ValidationValue() string

ValidationReason() string

ValidationSuggestion() string

}

// Format renders header followed by the payload's value/reason/suggestion in

// a deterministic multi-line shape. When truncateValue is true, Value is

// truncated to MaxValueLength before being included.

func Format(header string, p Payload, truncateValue bool) string {

var b strings.Builder

b.WriteString(header)

if p.Value != "" {

value := p.Value

if truncateValue {

value = stringutil.Truncate(value, MaxValueLength)

}

fmt.Fprintf(&b, "\n\nValue: %s", value)

}

fmt.Fprintf(&b, "\nReason: %s", p.Reason)

if p.Suggestion != "" {

fmt.Fprintf(&b, "\nSuggestion: %s", p.Suggestion)

}

return b.String()

}