Fb/scopemap complex entries (#16)

* new todo

* fail validation for scopeMaps with complex entries

Author: rlindner81

src/featureToggles.js

@@ -279,24 +279,35 @@ class FeatureToggles {
       return [{ featureKey, errorMessage: "feature key is not valid" }];
     }
 
-    if (!FeatureToggles._isValidScopeKey(scopeKey)) {
-      return [{ featureKey, scopeKey, errorMessage: "scopeKey is not valid" }];
+    if (scopeMap) {
+      const allowedScopesCheckMap = this.__config[featureKey][CONFIG_KEY.ALLOWED_SCOPES_CHECK_MAP];
+      for (const [scope, value] of Object.entries(scopeMap)) {
+        if (allowedScopesCheckMap && !allowedScopesCheckMap[scope]) {
+          return [
+            {
+              featureKey,
+              scopeKey,
+              errorMessage: 'scope "{0}" is not allowed',
+              errorMessageValues: [scope],
+            },
+          ];
+        }
+        const scopeType = typeof value;
+        if (scopeType !== "string") {
+          return [
+            {
+              featureKey,
+              scopeKey,
+              errorMessage: 'scope "{0}" has invalid type {1}, must be string',
+              errorMessageValues: [scope, scopeType],
+            },
+          ];
+        }
+      }
     }
 
-    const allowedScopesCheckMap = this.__config[featureKey][CONFIG_KEY.ALLOWED_SCOPES_CHECK_MAP];
-    if (allowedScopesCheckMap && scopeKey !== undefined && scopeKey !== SCOPE_ROOT_KEY) {
-      const actualScopes = Object.keys(scopeMap);
-      const mismatch = actualScopes.find((scope) => !allowedScopesCheckMap[scope]);
-      if (mismatch !== undefined) {
-        return [
-          {
-            featureKey,
-            scopeKey,
-            errorMessage: 'scope "{0}" is not allowed',
-            errorMessageValues: [mismatch],
-          },
-        ];
-      }
+    if (!FeatureToggles._isValidScopeKey(scopeKey)) {
+      return [{ featureKey, scopeKey, errorMessage: "scopeKey is not valid" }];
     }
 
     // NOTE: value === null is our way of encoding featureKey resetting changes, so it is always allowed

test/featureToggles.test.js

@@ -352,7 +352,7 @@ describe("feature toggles test", () => {
       await featureToggles.initializeFeatures({ config: mockConfig });
 
       const inputArgsList = [
-        [FEATURE.A, 1, { a: 1 }],
+        [FEATURE.A, 1, { a: "1" }],
         [FEATURE.A, 1, "a::1"],
         [FEATURE.AA, true],
         [FEATURE.AA, true, { tenant: "t1", user: "u1" }],

test/integration-local/featureToggles.test.js

@@ -357,6 +357,52 @@ describe("local integration test", () => {
       expect(redisWrapperLoggerSpy.error).toHaveBeenCalledTimes(0);
     });
 
+    it("validateFeatureValue with invalid scopes", async () => {
+      // valid
+      expect(await validateFeatureValue(FEATURE.C, "", { tenant: "t1" })).toMatchInlineSnapshot(`[]`);
+
+      // invalid
+      expect(await validateFeatureValue(FEATURE.C, "", { tenant: { subTenant: "bla" } })).toMatchInlineSnapshot(`
+        [
+          {
+            "errorMessage": "scope "{0}" has invalid type {1}, must be string",
+            "errorMessageValues": [
+              "tenant",
+              "object",
+            ],
+            "featureKey": "test/feature_c",
+            "scopeKey": "tenant::[object Object]",
+          },
+        ]
+      `);
+      expect(await validateFeatureValue(FEATURE.C, "", { tenant: ["a", "b", "c"] })).toMatchInlineSnapshot(`
+        [
+          {
+            "errorMessage": "scope "{0}" has invalid type {1}, must be string",
+            "errorMessageValues": [
+              "tenant",
+              "object",
+            ],
+            "featureKey": "test/feature_c",
+            "scopeKey": "tenant::a,b,c",
+          },
+        ]
+      `);
+      expect(await validateFeatureValue(FEATURE.C, "", { tenant: () => "1" })).toMatchInlineSnapshot(`
+        [
+          {
+            "errorMessage": "scope "{0}" has invalid type {1}, must be string",
+            "errorMessageValues": [
+              "tenant",
+              "function",
+            ],
+            "featureKey": "test/feature_c",
+            "scopeKey": "tenant::() => "1"",
+          },
+        ]
+      `);
+    });
+
     it("registerFeatureValueValidation, validateFeatureValue", async () => {
       const successfulValidator = () => undefined;
       const failingValidator1 = () => {