Fix/clear sub scope with new root value (#67)

* fixed update scoped values logic

* add a test where root scope value

Author: rlindner81

src/featureToggles.js

@@ -1080,39 +1080,36 @@ class FeatureToggles {
     scopeKey = SCOPE_ROOT_KEY,
     { clearSubScopes = false } = {}
   ) {
-    // NOTE: this first check is just an optimization
-    if (clearSubScopes && scopeKey === SCOPE_ROOT_KEY) {
-      return null;
+    // NOTE: if there are no existing scoped values, or we want to delete everything but the root key, than the
+    //   response is trivial.
+    if (!scopedValues || (clearSubScopes && scopeKey === SCOPE_ROOT_KEY)) {
+      if (newValue !== null) {
+        return { [scopeKey]: newValue };
+      } else {
+        return null;
+      }
     }
 
-    if (scopedValues) {
-      if (clearSubScopes) {
-        const scopeKeyInnerPairs = scopeKey.split(SCOPE_KEY_OUTER_SEPARATOR);
-        const subScopeKeys = Object.keys(scopedValues).filter((someScopeKey) =>
-          scopeKeyInnerPairs.every((scopeKeyInnerPair) => someScopeKey.includes(scopeKeyInnerPair))
-        );
-        for (const subScopeKey of subScopeKeys) {
-          Reflect.deleteProperty(scopedValues, subScopeKey);
-        }
+    if (clearSubScopes) {
+      // NOTE: we use here, that the scopeKey !== SCOPE_ROOT_KEY
+      const scopeKeyInnerPairs = scopeKey.split(SCOPE_KEY_OUTER_SEPARATOR);
+      const subScopeKeys = Object.keys(scopedValues).filter((someScopeKey) =>
+        scopeKeyInnerPairs.every((scopeKeyInnerPair) => someScopeKey.includes(scopeKeyInnerPair))
+      );
+      for (const subScopeKey of subScopeKeys) {
+        Reflect.deleteProperty(scopedValues, subScopeKey);
       }
+    }
 
-      if (newValue !== null) {
-        scopedValues[scopeKey] = newValue;
-      } else {
-        if (Object.keys(scopedValues).length > 1) {
-          Reflect.deleteProperty(scopedValues, scopeKey);
-        } else {
-          return null;
-        }
-      }
-      return scopedValues;
+    if (newValue !== null) {
+      scopedValues[scopeKey] = newValue;
     } else {
-      if (newValue !== null) {
-        return { [scopeKey]: newValue };
-      } else {
+      Reflect.deleteProperty(scopedValues, scopeKey);
+      if (Object.keys(scopedValues).length === 0) {
         return null;
       }
     }
+    return scopedValues;
   }
 
   // NOTE: stateScopedValues needs to be at least an empty object {}

test/integration-local/__snapshots__/featureToggles.integration.test.js.snap

@@ -16,7 +16,7 @@ exports[`local integration test common config init getFeatureValue, changeFeatur
 
 exports[`local integration test common config init getFeatureValue, changeFeatureValue with scopes 8`] = `[]`;
 
-exports[`local integration test common config init getFeatureValue, changeFeatureValue with scopes and clearSubScopes, resetFeatureValue 5`] = `[]`;
+exports[`local integration test common config init getFeatureValue, changeFeatureValue with scopes and clearSubScopes, resetFeatureValue 7`] = `[]`;
 
 exports[`local integration test common config init getFeatureValue, changeFeatureValue without scopes 1`] = `
 [

test/integration-local/featureToggles.integration.test.js

@@ -551,6 +551,7 @@ describe("local integration test", () => {
       const superScopeNewValue = 2;
       const scopeNewValue = 3;
       const subScopeNewValue = 4;
+      const rootClearNewValue = 5;
 
       expect(await toggles.changeFeatureValue(FEATURE.E, scopeNewValue, scopeMap)).toBeUndefined();
       expect(await toggles.changeFeatureValue(FEATURE.E, superScopeNewValue, superScopeMap)).toBeUndefined();
@@ -588,6 +589,34 @@ describe("local integration test", () => {
       expect(toggles.getFeatureValue(FEATURE.E, superScopeMap)).toEqual(superScopeNewValue);
       expect(toggles.getFeatureValue(FEATURE.E)).toEqual(rootNewValue);
 
+      expect(
+        await toggles.changeFeatureValue(FEATURE.E, rootClearNewValue, undefined, { clearSubScopes: true })
+      ).toBeUndefined();
+      expect(stateFromInfo(toggles.getFeatureInfo(FEATURE.E))).toMatchInlineSnapshot(`
+        {
+          "rootValue": 5,
+        }
+      `);
+      expect(toggles.getFeatureValue(FEATURE.E, subScopeMap)).toEqual(rootClearNewValue);
+      expect(toggles.getFeatureValue(FEATURE.E, scopeMap)).toEqual(rootClearNewValue);
+      expect(toggles.getFeatureValue(FEATURE.E, superScopeMap)).toEqual(rootClearNewValue);
+      expect(toggles.getFeatureValue(FEATURE.E)).toEqual(rootClearNewValue);
+
+      // re-add scoped values for reset test
+      expect(await toggles.changeFeatureValue(FEATURE.E, scopeNewValue, scopeMap)).toBeUndefined();
+      expect(await toggles.changeFeatureValue(FEATURE.E, superScopeNewValue, superScopeMap)).toBeUndefined();
+      expect(await toggles.changeFeatureValue(FEATURE.E, subScopeNewValue, subScopeMap)).toBeUndefined();
+      expect(stateFromInfo(toggles.getFeatureInfo(FEATURE.E))).toMatchInlineSnapshot(`
+        {
+          "rootValue": 5,
+          "scopedValues": {
+            "component::c1##layer::l1##tenant::t1": 4,
+            "component::c1##tenant::t1": 3,
+            "tenant::t1": 2,
+          },
+        }
+      `);
+
       expect(await toggles.resetFeatureValue(FEATURE.E)).toBeUndefined();
       expect(stateFromInfo(toggles.getFeatureInfo(FEATURE.E))).toMatchInlineSnapshot(`{}`);
       expect(toggles.getFeatureValue(FEATURE.E, subScopeMap)).toEqual(rootOldValue);