|
| 1 | +package apiversion |
| 2 | + |
| 3 | +import ( |
| 4 | + "strconv" |
| 5 | + "strings" |
| 6 | + |
| 7 | + "golang.org/x/xerrors" |
| 8 | +) |
| 9 | + |
| 10 | +// New returns an *APIVersion with the given major.minor and |
| 11 | +// additional supported major versions. |
| 12 | +func New(maj, min int) *APIVersion { |
| 13 | + v := &APIVersion{ |
| 14 | + supportedMajor: maj, |
| 15 | + supportedMinor: min, |
| 16 | + additionalMajors: make([]int, 0), |
| 17 | + } |
| 18 | + return v |
| 19 | +} |
| 20 | + |
| 21 | +type APIVersion struct { |
| 22 | + supportedMajor int |
| 23 | + supportedMinor int |
| 24 | + additionalMajors []int |
| 25 | +} |
| 26 | + |
| 27 | +func (v *APIVersion) WithBackwardCompat(majs ...int) *APIVersion { |
| 28 | + v.additionalMajors = append(v.additionalMajors, majs[:]...) |
| 29 | + return v |
| 30 | +} |
| 31 | + |
| 32 | +// Validate validates the given version against the given constraints: |
| 33 | +// A given major.minor version is valid iff: |
| 34 | +// 1. The requested major version is contained within v.supportedMajors |
| 35 | +// 2. If the requested major version is the 'current major', then |
| 36 | +// the requested minor version must be less than or equal to the supported |
| 37 | +// minor version. |
| 38 | +// |
| 39 | +// For example, given majors {1, 2} and minor 2, then: |
| 40 | +// - 0.x is not supported, |
| 41 | +// - 1.x is supported, |
| 42 | +// - 2.0, 2.1, and 2.2 are supported, |
| 43 | +// - 2.3+ is not supported. |
| 44 | +func (v *APIVersion) Validate(version string) error { |
| 45 | + major, minor, err := Parse(version) |
| 46 | + if err != nil { |
| 47 | + return err |
| 48 | + } |
| 49 | + if major > v.supportedMajor { |
| 50 | + return xerrors.Errorf("server is at version %d.%d, behind requested major version %s", |
| 51 | + v.supportedMajor, v.supportedMinor, version) |
| 52 | + } |
| 53 | + if major == v.supportedMajor { |
| 54 | + if minor > v.supportedMinor { |
| 55 | + return xerrors.Errorf("server is at version %d.%d, behind requested minor version %s", |
| 56 | + v.supportedMajor, v.supportedMinor, version) |
| 57 | + } |
| 58 | + return nil |
| 59 | + } |
| 60 | + for _, mjr := range v.additionalMajors { |
| 61 | + if major == mjr { |
| 62 | + return nil |
| 63 | + } |
| 64 | + } |
| 65 | + return xerrors.Errorf("version %s is no longer supported", version) |
| 66 | +} |
| 67 | + |
| 68 | +// Parse parses a valid major.minor version string into (major, minor). |
| 69 | +// Both major and minor must be valid integers separated by a period '.'. |
| 70 | +func Parse(version string) (major int, minor int, err error) { |
| 71 | + parts := strings.Split(version, ".") |
| 72 | + if len(parts) != 2 { |
| 73 | + return 0, 0, xerrors.Errorf("invalid version string: %s", version) |
| 74 | + } |
| 75 | + major, err = strconv.Atoi(parts[0]) |
| 76 | + if err != nil { |
| 77 | + return 0, 0, xerrors.Errorf("invalid major version: %s", version) |
| 78 | + } |
| 79 | + minor, err = strconv.Atoi(parts[1]) |
| 80 | + if err != nil { |
| 81 | + return 0, 0, xerrors.Errorf("invalid minor version: %s", version) |
| 82 | + } |
| 83 | + return major, minor, nil |
| 84 | +} |
0 commit comments