Namespace versioning & upgrade path (#129)

* rule ast new

* Upgrade strategy

* comment

* make sure eval still works

* comments

Author: shubhitms

cmd/lekko/main.go

@@ -104,7 +104,7 @@ func formatCmd() *cobra.Command {
 }
 
 func compileCmd() *cobra.Command {
-	var force, dryRun bool
+	var force, dryRun, upgrade bool
 	cmd := &cobra.Command{
 		Use:   "compile [namespace[/feature]]",
 		Short: "compiles features based on individual definitions",
@@ -142,7 +142,8 @@ func compileCmd() *cobra.Command {
 				IgnoreBackwardsCompatibility: force,
 				// don't verify file structure, since we may have not yet generated
 				// the DSLs for newly added features.
-				Verify: false,
+				Verify:  false,
+				Upgrade: upgrade,
 			}); err != nil {
 				return errors.Wrap(err, "compile")
 			}
@@ -151,6 +152,7 @@ func compileCmd() *cobra.Command {
 	}
 	cmd.Flags().BoolVarP(&force, "force", "f", false, "force compilation, ignoring validation check failures.")
 	cmd.Flags().BoolVarP(&dryRun, "dry-run", "d", false, "skip persisting any newly compiled changes to disk.")
+	cmd.Flags().BoolVarP(&upgrade, "upgrade", "u", false, "upgrade any of the requested namespaces that are behind the latest version.")
 	return cmd
 }
 

go.mod

@@ -9,7 +9,7 @@ require (
 	github.com/cli/browser v1.0.0
 	github.com/go-git/go-billy/v5 v5.3.1
 	github.com/go-git/go-git/v5 v5.4.2
-	github.com/lekkodev/rules v1.4.0
+	github.com/lekkodev/rules v1.4.1-0.20230316183402-c634bcfe3adf
 	github.com/mitchellh/go-homedir v1.1.0
 	github.com/spf13/cobra v1.5.0
 	github.com/stretchr/testify v1.7.0
@@ -26,6 +26,7 @@ require (
 	github.com/PuerkitoBio/purell v1.1.1 // indirect
 	github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578 // indirect
 	github.com/acomagu/bufpipe v1.0.3 // indirect
+	github.com/antlr/antlr4/runtime/Go/antlr/v4 v4.0.0-20230305170008-8188dc5388df // indirect
 	github.com/cli/safeexec v1.0.0 // indirect
 	github.com/emicklei/go-restful/v3 v3.8.0 // indirect
 	github.com/emirpasic/gods v1.12.0 // indirect
@@ -55,6 +56,7 @@ require (
 	github.com/sergi/go-diff v1.1.0 // indirect
 	github.com/xanzy/ssh-agent v0.3.0 // indirect
 	golang.org/x/crypto v0.0.0-20220315160706-3147a52a75dd // indirect
+	golang.org/x/exp v0.0.0-20220722155223-a9213eeb770e // indirect
 	golang.org/x/net v0.0.0-20220722155237-a158d28d115b // indirect
 	golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 // indirect
 	golang.org/x/text v0.3.7 // indirect
@@ -73,8 +75,6 @@ require (
 )
 
 require (
-	github.com/antlr/antlr4/runtime/Go/antlr v0.0.0-20220415221154-79c36419192d // indirect
-	github.com/blang/semver v3.5.1+incompatible // indirect
 	github.com/cenkalti/backoff/v4 v4.2.0
 	github.com/cli/oauth v0.9.0
 	github.com/davecgh/go-spew v1.1.1 // indirect

go.sum

@@ -50,14 +50,12 @@ github.com/acomagu/bufpipe v1.0.3 h1:fxAGrHZTgQ9w5QqVItgzwj235/uYZYgbXitB+dLupOk
 github.com/acomagu/bufpipe v1.0.3/go.mod h1:mxdxdup/WdsKVreO5GpW4+M/1CE2sMG4jeGJ2sYmHc4=
 github.com/anmitsu/go-shlex v0.0.0-20161002113705-648efa622239 h1:kFOfPq6dUM1hTo4JG6LR5AXSUEsOjtdm0kw0FtQtMJA=
 github.com/anmitsu/go-shlex v0.0.0-20161002113705-648efa622239/go.mod h1:2FmKhYUyUczH0OGQWaF5ceTx0UBShxjsH6f8oGKYe2c=
-github.com/antlr/antlr4/runtime/Go/antlr v0.0.0-20220415221154-79c36419192d h1:Kts4bTFz6tSE4bPFhcZxpCafiBnSOPSnUaame7SqSDc=
-github.com/antlr/antlr4/runtime/Go/antlr v0.0.0-20220415221154-79c36419192d/go.mod h1:F7bn7fEU90QkQ3tnmaTx3LTKLEDqnwWODIYppRQ5hnY=
+github.com/antlr/antlr4/runtime/Go/antlr/v4 v4.0.0-20230305170008-8188dc5388df h1:7RFfzj4SSt6nnvCPbCqijJi1nWCd+TqAT3bYCStRC18=
+github.com/antlr/antlr4/runtime/Go/antlr/v4 v4.0.0-20230305170008-8188dc5388df/go.mod h1:pSwJ0fSY5KhvocuWSx4fz3BA8OrA1bQn+K1Eli3BRwM=
 github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio=
 github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs=
 github.com/bazelbuild/buildtools v0.0.0-20220907133145-b9bfff5d7f91 h1:7xSt0nPZ74liqR8jjBYmjentrQVrdQEhoW4/+4BrmoM=
 github.com/bazelbuild/buildtools v0.0.0-20220907133145-b9bfff5d7f91/go.mod h1:689QdV3hBP7Vo9dJMmzhoYIyo/9iMhEmHkJcnaPRCbo=
-github.com/blang/semver v3.5.1+incompatible h1:cQNTCjp13qL8KC3Nbxr/y2Bqb63oX6wdnnjpJbkM4JQ=
-github.com/blang/semver v3.5.1+incompatible/go.mod h1:kRBLl5iJ+tD4TcOOxsy/0fnwebNt5EWlYSAyrTnjyyk=
 github.com/bufbuild/connect-go v0.3.0 h1:B0vyZrTR11SNEYpodL6P0NzluDCsuqmr8CNKblXvVto=
 github.com/bufbuild/connect-go v0.3.0/go.mod h1:4efZ2eXFENwd4p7tuLaL9m0qtTsCOzuBvrohvRGevDM=
 github.com/cenkalti/backoff/v4 v4.2.0 h1:HN5dHm3WBOgndBH6E8V0q2jIYIR3s9yglV8k/+MN3u4=
@@ -214,8 +212,8 @@ github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
 github.com/kylelemons/godebug v0.0.0-20170820004349-d65d576e9348/go.mod h1:B69LEHPfb2qLo0BaaOLcbitczOKLWTsrBG9LczfCD4k=
-github.com/lekkodev/rules v1.4.0 h1:88mp56JxGXuSfnLi79JSenr3CtlYSVMNHmg8ABTb/RI=
-github.com/lekkodev/rules v1.4.0/go.mod h1:YYiuiYOsmdgoV5thcmmyoQv7ZacVkPgcEAXySY328v0=
+github.com/lekkodev/rules v1.4.1-0.20230316183402-c634bcfe3adf h1:wO8Nxokdz3cdqIla/R3KILA5a/7KTyQRg8/nrNM5PRQ=
+github.com/lekkodev/rules v1.4.1-0.20230316183402-c634bcfe3adf/go.mod h1:Htxk+nSZEY46blL2nniZdmbrVffAfFAF5JfoNAIFulQ=
 github.com/mailru/easyjson v0.0.0-20190614124828-94de47d64c63/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc=
 github.com/mailru/easyjson v0.0.0-20190626092158-b2ccc519800e/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc=
 github.com/mailru/easyjson v0.7.6 h1:8yTIVnZgCoiM1TgqoeTl+LfU5Jg6/xL3QhGQnimLYnA=
@@ -305,6 +303,8 @@ golang.org/x/exp v0.0.0-20191227195350-da58074b4299/go.mod h1:2RIsYlXP63K8oxa1u0
 golang.org/x/exp v0.0.0-20200119233911-0405dc783f0a/go.mod h1:2RIsYlXP63K8oxa1u096TMicItID8zy7Y6sNkU49FU4=
 golang.org/x/exp v0.0.0-20200207192155-f17229e696bd/go.mod h1:J/WKrq2StrnmMY6+EHIKF9dgMWnmCNThgcyBT1FY9mM=
 golang.org/x/exp v0.0.0-20200224162631-6cc2880d07d6/go.mod h1:3jZMyOhIsHpP37uCMkUooju7aAi5cS1Q23tOzKc+0MU=
+golang.org/x/exp v0.0.0-20220722155223-a9213eeb770e h1:+WEEuIdZHnUeJJmEUjyYC2gfUMj69yZXw17EnHg/otA=
+golang.org/x/exp v0.0.0-20220722155223-a9213eeb770e/go.mod h1:Kr81I6Kryrl9sr8s2FK3vxD90NdsKWRuOIl2O4CvYbA=
 golang.org/x/image v0.0.0-20190227222117-0694c2d4d067/go.mod h1:kZ7UVZpmo3dzQBMxlp+ypCbDeSB+sBbTgSJuh5dn5js=
 golang.org/x/image v0.0.0-20190802002840-cff245a6509b/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0=
 golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE=

pkg/encoding/encoding.go

@@ -32,7 +32,13 @@ import (
 // type.
 func ParseFeature(ctx context.Context, rootPath string, featureFile feature.FeatureFile, nsMD *metadata.NamespaceConfigRepoMetadata, provider fs.Provider) (feature.EvaluableFeature, error) {
 	switch nsMD.Version {
-	case "v1beta3":
+	case feature.NamespaceVersionV1Beta1.String():
+		fallthrough
+	case feature.NamespaceVersionV1Beta2.String():
+		fallthrough
+	case feature.NamespaceVersionV1Beta3.String():
+		fallthrough
+	case feature.NamespaceVersionV1Beta4.String():
 		var f featurev1beta1.Feature
 		contents, err := provider.GetFileContents(ctx, filepath.Join(rootPath, nsMD.Name, featureFile.CompiledProtoBinFileName))
 		if err != nil {

pkg/feature/feature.go

@@ -21,6 +21,7 @@ import (
 
 	featurev1beta1 "github.com/lekkodev/cli/pkg/gen/proto/go/lekko/feature/v1beta1"
 	rulesv1beta2 "github.com/lekkodev/cli/pkg/gen/proto/go/lekko/rules/v1beta2"
+	rulesv1beta3 "github.com/lekkodev/cli/pkg/gen/proto/go/lekko/rules/v1beta3"
 	"github.com/pkg/errors"
 	"google.golang.org/protobuf/encoding/protojson"
 	"google.golang.org/protobuf/proto"
@@ -99,9 +100,10 @@ func FeatureTypeFromProto(ft featurev1beta1.FeatureType) FeatureType {
 var ErrTypeMismatch = fmt.Errorf("type mismatch")
 
 type Rule struct {
-	Condition    string             // source of truth
-	ConditionAST *rulesv1beta2.Rule // by-product of Condition
-	Value        interface{}
+	Condition      string             // source of truth
+	ConditionAST   *rulesv1beta2.Rule // by-product of Condition
+	ConditionASTV3 *rulesv1beta3.Rule
+	Value          interface{}
 }
 
 type UnitTest struct {
@@ -311,19 +313,20 @@ func valFromJSON(encoded []byte) (*structpb.Value, error) {
 	return val, nil
 }
 
-func (f *Feature) AddBoolRule(rule string, ast *rulesv1beta2.Rule, val bool) error {
+func (f *Feature) AddBoolRule(rule string, ast *rulesv1beta2.Rule, astNew *rulesv1beta3.Rule, val bool) error {
 	if f.FeatureType != FeatureTypeBool {
 		return newTypeMismatchErr(FeatureTypeBool, f.FeatureType)
 	}
 	f.Rules = append(f.Rules, &Rule{
-		Condition:    rule,
-		ConditionAST: ast,
-		Value:        val,
+		Condition:      rule,
+		ConditionAST:   ast,
+		ConditionASTV3: astNew,
+		Value:          val,
 	})
 	return nil
 }
 
-func (f *Feature) AddStringRule(rule string, ast *rulesv1beta2.Rule, val string) error {
+func (f *Feature) AddStringRule(rule string, ast *rulesv1beta2.Rule, astNew *rulesv1beta3.Rule, val string) error {
 	if f.FeatureType != FeatureTypeString {
 		return newTypeMismatchErr(FeatureTypeString, f.FeatureType)
 	}
@@ -335,38 +338,41 @@ func (f *Feature) AddStringRule(rule string, ast *rulesv1beta2.Rule, val string)
 	return nil
 }
 
-func (f *Feature) AddIntRule(rule string, ast *rulesv1beta2.Rule, val int64) error {
+func (f *Feature) AddIntRule(rule string, ast *rulesv1beta2.Rule, astNew *rulesv1beta3.Rule, val int64) error {
 	if f.FeatureType != FeatureTypeInt {
 		return newTypeMismatchErr(FeatureTypeInt, f.FeatureType)
 	}
 	f.Rules = append(f.Rules, &Rule{
-		Condition:    rule,
-		ConditionAST: ast,
-		Value:        val,
+		Condition:      rule,
+		ConditionAST:   ast,
+		ConditionASTV3: astNew,
+		Value:          val,
 	})
 	return nil
 }
 
-func (f *Feature) AddFloatRule(rule string, ast *rulesv1beta2.Rule, val float64) error {
+func (f *Feature) AddFloatRule(rule string, ast *rulesv1beta2.Rule, astNew *rulesv1beta3.Rule, val float64) error {
 	if f.FeatureType != FeatureTypeFloat {
 		return newTypeMismatchErr(FeatureTypeFloat, f.FeatureType)
 	}
 	f.Rules = append(f.Rules, &Rule{
-		Condition:    rule,
-		ConditionAST: ast,
-		Value:        val,
+		Condition:      rule,
+		ConditionAST:   ast,
+		ConditionASTV3: astNew,
+		Value:          val,
 	})
 	return nil
 }
 
-func (f *Feature) AddJSONRule(rule string, ast *rulesv1beta2.Rule, val *structpb.Value) error {
+func (f *Feature) AddJSONRule(rule string, ast *rulesv1beta2.Rule, astNew *rulesv1beta3.Rule, val *structpb.Value) error {
 	if f.FeatureType != FeatureTypeJSON {
 		return newTypeMismatchErr(FeatureTypeJSON, f.FeatureType)
 	}
 	f.Rules = append(f.Rules, &Rule{
-		Condition:    rule,
-		ConditionAST: ast,
-		Value:        val,
+		Condition:      rule,
+		ConditionAST:   ast,
+		ConditionASTV3: astNew,
+		Value:          val,
 	})
 	return nil
 }
@@ -399,9 +405,10 @@ func (f *Feature) ToProto() (*featurev1beta1.Feature, error) {
 			return nil, errors.Wrap(err, "rule value to any")
 		}
 		tree.Constraints = append(tree.Constraints, &featurev1beta1.Constraint{
-			Rule:    rule.Condition,
-			RuleAst: rule.ConditionAST,
-			Value:   ruleAny,
+			Rule:       rule.Condition,
+			RuleAst:    rule.ConditionAST,
+			RuleAstNew: rule.ConditionASTV3,
+			Value:      ruleAny,
 		})
 	}
 	ret.Tree = tree
@@ -428,9 +435,10 @@ func FromProto(fProto *featurev1beta1.Feature, registry *protoregistry.Types) (*
 			return nil, errors.Wrap(err, "rule any to val")
 		}
 		ret.Rules = append(ret.Rules, &Rule{
-			Condition:    constraint.Rule,
-			ConditionAST: constraint.RuleAst,
-			Value:        ruleVal,
+			Condition:      constraint.Rule,
+			ConditionAST:   constraint.RuleAst,
+			ConditionASTV3: constraint.RuleAstNew,
+			Value:          ruleVal,
 		})
 	}
 	return ret, nil

pkg/feature/feature_test.go

@@ -24,7 +24,7 @@ import (
 
 func TestFeatureProtoRoundTripBool(t *testing.T) {
 	f := NewBoolFeature(false)
-	require.NoError(t, f.AddBoolRule("foo", nil, true))
+	require.NoError(t, f.AddBoolRule("foo", nil, nil, true))
 	proto, err := f.ToProto()
 	require.NoError(t, err)
 	require.NotNil(t, proto)
@@ -36,7 +36,7 @@ func TestFeatureProtoRoundTripBool(t *testing.T) {
 
 func TestFeatureProtoRoundTripString(t *testing.T) {
 	f := NewStringFeature("a")
-	require.NoError(t, f.AddStringRule("foo", nil, "b"))
+	require.NoError(t, f.AddStringRule("foo", nil, nil, "b"))
 	proto, err := f.ToProto()
 	require.NoError(t, err)
 	require.NotNil(t, proto)
@@ -48,7 +48,7 @@ func TestFeatureProtoRoundTripString(t *testing.T) {
 
 func TestFeatureProtoRoundTripInt(t *testing.T) {
 	f := NewIntFeature(1)
-	require.NoError(t, f.AddIntRule("foo", nil, 2))
+	require.NoError(t, f.AddIntRule("foo", nil, nil, 2))
 	proto, err := f.ToProto()
 	require.NoError(t, err)
 	require.NotNil(t, proto)
@@ -60,7 +60,7 @@ func TestFeatureProtoRoundTripInt(t *testing.T) {
 
 func TestFeatureProtoRoundTripFloat(t *testing.T) {
 	f := NewFloatFeature(1.2)
-	require.NoError(t, f.AddFloatRule("foo", nil, 3.0))
+	require.NoError(t, f.AddFloatRule("foo", nil, nil, 3.0))
 	proto, err := f.ToProto()
 	require.NoError(t, err)
 	require.NotNil(t, proto)
@@ -81,7 +81,7 @@ func TestFeatureProtoRoundTripJSON(t *testing.T) {
 		"a": 1,
 	})
 	require.NoError(t, err)
-	require.NoError(t, f.AddJSONRule("foo", nil, ruleVal))
+	require.NoError(t, f.AddJSONRule("foo", nil, nil, ruleVal))
 	proto, err := f.ToProto()
 	require.NoError(t, err)
 	require.NotNil(t, proto)

pkg/feature/version.go

@@ -0,0 +1,103 @@
+// Copyright 2022 Lekko Technologies, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package feature
+
+import (
+	"errors"
+	"fmt"
+)
+
+type NamespaceVersion string
+
+const (
+	NamespaceVersionV1Beta1 NamespaceVersion = "v1beta1"
+	NamespaceVersionV1Beta2 NamespaceVersion = "v1beta2"
+	NamespaceVersionV1Beta3 NamespaceVersion = "v1beta3"
+	// Supports generating n-ary rules AST
+	NamespaceVersionV1Beta4 NamespaceVersion = "v1beta4"
+)
+
+var (
+	ErrUnsupportedVersion error = errors.New("namespace version is unsupported, please upgrade")
+)
+
+func NewNamespaceVersion(v string) (*NamespaceVersion, error) {
+	for _, nv := range AllNamespaceVersions() {
+		if string(nv) == v {
+			return &nv, nil
+		}
+	}
+	return nil, fmt.Errorf("version %s not found", v)
+}
+
+// Returns all namespace versions in the order that they were released
+func AllNamespaceVersions() []NamespaceVersion {
+	return []NamespaceVersion{
+		NamespaceVersionV1Beta1,
+		NamespaceVersionV1Beta2,
+		NamespaceVersionV1Beta3,
+		NamespaceVersionV1Beta4,
+	}
+}
+
+// Returns the list of namespace versions that are supported.
+func SupportedNamespaceVersions() []NamespaceVersion {
+	all := AllNamespaceVersions()
+	start := 0
+	for i, v := range all {
+		if v == NamespaceVersionV1Beta3 { // Last supported version
+			start = i
+			break
+		}
+	}
+	return all[start:]
+}
+
+// Returns the latest namespace version.
+func LatestNamespaceVersion() NamespaceVersion {
+	all := SupportedNamespaceVersions()
+	return all[len(all)-1]
+}
+
+func (nv NamespaceVersion) IsLatest() bool {
+	return nv == LatestNamespaceVersion()
+}
+
+func (nv NamespaceVersion) Supported() error {
+	all := SupportedNamespaceVersions()
+	for _, v := range all {
+		if v == nv {
+			return nil
+		}
+	}
+	return ErrUnsupportedVersion
+}
+
+func (nv NamespaceVersion) Before(cmp NamespaceVersion) bool {
+	var myIdx, cmpIdx int
+	for i, v := range AllNamespaceVersions() {
+		if v == nv {
+			myIdx = i
+		}
+		if v == cmp {
+			cmpIdx = i
+		}
+	}
+	return myIdx < cmpIdx
+}
+
+func (nv NamespaceVersion) String() string {
+	return string(nv)
+}