Feat/synonyms (#88)

* feat: add synonyms category

* feat: add plan validations for synonyms

* fix: category ordering

* add: reusable index exists or not util

* fix: func type

* fix: export function

Co-authored-by: Siddharth Kothari <sids.aquarius@gmail.com>

Author: ShahAnuj2610

main.go

@@ -61,6 +61,8 @@ var (
 	FeatureFunctions string
 	// FeatureSearchRelevancy for testing
 	FeatureSearchRelevancy string
+	// FeatureSynonyms for testing
+	FeatureSynonyms string
 )
 
 func init() {
@@ -187,6 +189,9 @@ func main() {
 	if FeatureSearchRelevancy != "" && FeatureSearchRelevancy == "true" {
 		util.SetFeatureSearchRelevancy(true)
 	}
+	if FeatureSynonyms == "true" {
+		util.SetFeatureSynonyms(true)
+	}
 
 	// ES client instantiation
 	// ES v7 and v6 clients

model/category/category.go

@@ -36,6 +36,7 @@ const (
 	Functions
 	ReactiveSearch
 	SearchRelevancy
+	Synonyms
 )
 
 // String is an implementation of Stringer interface that returns the string representation of category.Categories.
@@ -58,6 +59,7 @@ func (c Category) String() string {
 		"functions",
 		"reactivesearch",
 		"searchrelevancy",
+		"synonyms",
 	}[c]
 }
 
@@ -103,6 +105,8 @@ func (c *Category) UnmarshalJSON(bytes []byte) error {
 		*c = ReactiveSearch
 	case SearchRelevancy.String():
 		*c = SearchRelevancy
+	case Synonyms.String():
+		*c = Synonyms
 	default:
 		return fmt.Errorf("invalid category encountered: %v", category)
 	}
@@ -147,6 +151,8 @@ func (c Category) MarshalJSON() ([]byte, error) {
 		category = ReactiveSearch.String()
 	case SearchRelevancy:
 		category = SearchRelevancy.String()
+	case Synonyms:
+		category = Synonyms.String()
 	default:
 		return nil, fmt.Errorf("invalid category encountered: %v" + c.String())
 	}

model/permission/defaults.go

@@ -30,6 +30,7 @@ var (
 		category.Functions,
 		category.ReactiveSearch,
 		category.SearchRelevancy,
+		category.Synonyms,
 	}
 
 	defaultOps = []op.Operation{

model/permission/permission.go

@@ -72,6 +72,7 @@ type Limits struct {
 	FunctionsLimit      int64 `json:"functions_limit"`
 	ReactiveSearchLimit int64 `json:"reactivesearch_limit"`
 	SearchRelevancyLimit int64 `json:"searchrelevancy_limit"`
+	SynonymsLimit       int64 `json:"synonyms_limit"`
 }
 
 // Options is a function type used to define a permission's properties.
@@ -474,6 +475,8 @@ func (p *Permission) GetLimitFor(c category.Category) (int64, error) {
 		return p.Limits.ReactiveSearchLimit, nil
 	case category.SearchRelevancy:
 		return p.Limits.SearchRelevancyLimit, nil
+	case category.Synonyms:
+		return p.Limits.SynonymsLimit, nil
 	default:
 		return -1, fmt.Errorf(`we do not rate limit "%s" category`, c)
 	}

model/user/defaults.go

@@ -30,6 +30,7 @@ var (
 		category.ReactiveSearch,
 		category.SearchRelevancy,
 		category.Auth,
+		category.Synonyms,
 	}
 
 	defaultOps = []op.Operation{

plugins/auth/e2e_test.go

@@ -29,6 +29,7 @@ var adminCategories = []category.Category{
 	category.Functions,
 	category.ReactiveSearch,
 	category.SearchRelevancy,
+	category.Synonyms,
 }
 
 var adminOps = []op.Operation{

plugins/permissions/e2e_test.go

@@ -30,6 +30,7 @@ var adminCategories = []category.Category{
 	category.Functions,
 	category.ReactiveSearch,
 	category.SearchRelevancy,
+	category.Synonyms,
 }
 
 var adminOps = []op.Operation{

util/billing.go

@@ -70,6 +70,7 @@ type ClusterPlan struct {
 	FeatureTemplates      bool   `json:"feature_templates"`
 	FeatureFunctions      bool   `json:"feature_functions"`
 	FeatureSearchRelevancy bool   `json:"feature_search_relevancy"`
+	FeatureSynonyms       bool   `json:"feature_synonyms"`
 	Trial                 bool   `json:"trial"`
 	TrialValidity         int64  `json:"trial_validity"`
 	TierValidity          int64  `json:"tier_validity"`
@@ -121,6 +122,7 @@ type ArcInstanceDetails struct {
 	FeatureTemplates      bool                   `json:"feature_templates"`
 	FeatureFunctions      bool                   `json:"feature_functions"`
 	FeatureSearchRelevancy bool                   `json:"feature_search_relevancy"`
+	FeatureSynonyms       bool                   `json:"feature_synonyms"`
 }
 
 // SetDefaultTier sets the default tier when billing is disabled
@@ -206,6 +208,7 @@ func getArcInstance(arcID string) (ArcInstance, error) {
 		SetFeatureRules(arcInstanceByID.FeatureRules)
 		SetFeatureFunctions(arcInstanceByID.FeatureFunctions)
 		SetFeatureSearchRelevancy(arcInstanceByID.FeatureSearchRelevancy)
+		SetFeatureSynonyms(arcInstanceByID.FeatureSynonyms)
 		SetFeatureTemplates(arcInstanceByID.FeatureTemplates)
 	} else {
 		return arcInstance, errors.New("No valid instance found for the provided ARC_ID")
@@ -256,6 +259,7 @@ func getArcClusterInstance(clusterID string) (ArcInstance, error) {
 		SetFeatureRules(arcInstanceDetails.FeatureRules)
 		SetFeatureFunctions(arcInstanceDetails.FeatureFunctions)
 		SetFeatureSearchRelevancy(arcInstanceDetails.FeatureSearchRelevancy)
+		SetFeatureSynonyms(arcInstanceDetails.FeatureSynonyms)
 		SetFeatureTemplates(arcInstanceDetails.FeatureTemplates)
 	} else {
 		return arcInstance, errors.New("No valid instance found for the provided CLUSTER_ID")
@@ -304,6 +308,7 @@ func getClusterPlan(clusterID string) (ClusterPlan, error) {
 	SetFeatureRules(response.Plan.FeatureRules)
 	SetFeatureFunctions(response.Plan.FeatureFunctions)
 	SetFeatureSearchRelevancy(response.Plan.FeatureSearchRelevancy)
+	SetFeatureSynonyms(response.Plan.FeatureSynonyms)
 	SetFeatureTemplates(response.Plan.FeatureTemplates)
 
 	return clusterPlan, nil

util/billing_test.go

@@ -52,6 +52,10 @@ func TestBilling(t *testing.T) {
 			SetFeatureSearchRelevancy(true)
 			So(GetFeatureSearchRelevancy(), ShouldEqual, true)
 		})
+		Convey("Set FeatureSynonyms", func() {
+			SetFeatureSynonyms(true)
+			So(GetFeatureSynonyms(), ShouldEqual, true)
+		})
 		Convey("Validate TimeValidity: Positive Value", func() {
 			// Set TimeValidity to a positive value
 			var timeValidityMock = 1200000

util/feature.go

@@ -77,3 +77,16 @@ func GetFeatureSearchRelevancy() bool {
 func SetFeatureSearchRelevancy(val bool) {
 	featureSearchRelevancy = val
 }
+
+// Feature synonyms
+var featureSynonyms bool
+
+// GetFeatureSynonyms returns the featureSynonyms
+func GetFeatureSynonyms() bool {
+	return featureSynonyms
+}
+
+// SetFeatureSynonyms sets the featureSynonyms
+func SetFeatureSynonyms(val bool) {
+	featureSynonyms = val
+}