Fb/custom validator with scopemap (#13)

* cds 7 changes

* tests for custom validator with scopeMap

Author: rlindner81

example-cap-server/package.json

@@ -7,7 +7,7 @@
   },
   "dependencies": {
     "@cap-js-community/feature-toggle-library": "file:../",
-    "@sap/cds": "^6.8.4",
+    "@sap/cds": "^7.0.0",
     "express": "^4.18.2"
   }
 }

example-cap-server/srv/service/check-service.cds

@@ -1,5 +1,6 @@
 @protocol: 'rest'
 @impl: './../handler/check-service.js'
+@path: '/check'
 service CheckService {
     function priority() returns String;
 }

example-cap-server/srv/service/feature-service.cds

@@ -1,6 +1,7 @@
 @protocol: 'rest'
 @impl: './../handler/feature-service.js'
 @(requires: 'authenticated-user')
+@path: '/feature'
 // NOTE: in practice this needs proper security restrictions
 service FeatureService {
     type JSON {};

src/featureToggles.js

@@ -364,7 +364,7 @@ class FeatureToggles {
       validators.map(async (validator) => {
         const validatorName = validator.name || "anonymous";
         try {
-          const validationErrorOrErrors = (await validator(value, scopeKey)) || [];
+          const validationErrorOrErrors = (await validator(value, scopeMap, scopeKey)) || [];
           const validationErrors = Array.isArray(validationErrorOrErrors)
             ? validationErrorOrErrors
             : [validationErrorOrErrors];
@@ -1251,9 +1251,11 @@ class FeatureToggles {
    *
    * The validator gets the new value and can do any number of checks on it. Returning anything falsy, like undefined,
    * means the new value passes validation, otherwise the validator must return either a single {@link ValidationError},
-   * or a list of ValidationErrors.
+   * or a list of ValidationErrors. The validator will receive either no scoping information or both the scopeMap and
+   * scopeKey for reference.
    *
    * @param {boolean | number | string}  newValue
+   * @param {Map<string, string>}        [scopeMap]  optional scopeMap for reference
    * @param {string}                     [scopeKey]  optional scopeKey for reference
    * @returns {undefined | ValidationError | Array<ValidationError>} in case of failure a ValidationError, or an array
    *   of ValidationErrors, otherwise undefined

test/featureToggles.test.js

@@ -708,14 +708,25 @@ describe("feature toggles test", () => {
 
       // NOTE: we get called twice here once for upstream to redis and once downstream from redis
       expect(validator).toHaveBeenCalledTimes(2);
-      expect(validator).toHaveBeenNthCalledWith(1, newValue, SCOPE_ROOT_KEY);
-      expect(validator).toHaveBeenNthCalledWith(2, newValue, SCOPE_ROOT_KEY);
+      expect(validator).toHaveBeenNthCalledWith(1, newValue, undefined, SCOPE_ROOT_KEY);
+      expect(validator).toHaveBeenNthCalledWith(2, newValue, undefined, SCOPE_ROOT_KEY);
+
+      // with scopes
+      validator.mockClear();
+      const testScopeMap = { domain: "value " };
+      const testScopeKey = FeatureToggles.getScopeKey(testScopeMap);
+      expect(await featureToggles.changeFeatureValue(FEATURE.B, 102, testScopeMap)).toBeUndefined();
+      expect(await featureToggles.changeFeatureValue(FEATURE.C, newValue, testScopeMap)).toBeUndefined();
+
+      expect(validator).toHaveBeenCalledTimes(2);
+      expect(validator).toHaveBeenNthCalledWith(1, newValue, testScopeMap, testScopeKey);
+      expect(validator).toHaveBeenNthCalledWith(2, newValue, testScopeMap, testScopeKey);
 
       // right toggle but failing
       validator.mockClear();
       const mockErrorMessage = "wrong input";
       validator.mockResolvedValueOnce({ errorMessage: mockErrorMessage });
-      expect(await featureToggles.changeFeatureValue(FEATURE.B, 102)).toBeUndefined();
+      expect(await featureToggles.changeFeatureValue(FEATURE.B, 103)).toBeUndefined();
       expect(await featureToggles.changeFeatureValue(FEATURE.C, newValue)).toMatchInlineSnapshot(`
         [
           {
@@ -726,7 +737,7 @@ describe("feature toggles test", () => {
         ]
       `);
       expect(validator).toHaveBeenCalledTimes(1);
-      expect(validator).toHaveBeenCalledWith(newValue, SCOPE_ROOT_KEY);
+      expect(validator).toHaveBeenCalledWith(newValue, undefined, SCOPE_ROOT_KEY);
 
       // right toggle but failing with messageValues
       validator.mockClear();
@@ -736,7 +747,7 @@ describe("feature toggles test", () => {
         errorMessage: mockErrorMessageWithValues,
         errorMessageValues: mockErrorMessageValues,
       });
-      expect(await featureToggles.changeFeatureValue(FEATURE.B, 102)).toBeUndefined();
+      expect(await featureToggles.changeFeatureValue(FEATURE.B, 104)).toBeUndefined();
       expect(await featureToggles.changeFeatureValue(FEATURE.C, newValue)).toMatchInlineSnapshot(`
         [
           {
@@ -751,7 +762,7 @@ describe("feature toggles test", () => {
         ]
       `);
       expect(validator).toHaveBeenCalledTimes(1);
-      expect(validator).toHaveBeenCalledWith(newValue, SCOPE_ROOT_KEY);
+      expect(validator).toHaveBeenCalledWith(newValue, undefined, SCOPE_ROOT_KEY);
 
       // right toggle but failing with multiple errors
       validator.mockClear();
@@ -768,7 +779,7 @@ describe("feature toggles test", () => {
           errorMessageValues: mockErrorMessageValues,
         },
       ]);
-      expect(await featureToggles.changeFeatureValue(FEATURE.B, 102)).toBeUndefined();
+      expect(await featureToggles.changeFeatureValue(FEATURE.B, 105)).toBeUndefined();
       expect(await featureToggles.changeFeatureValue(FEATURE.C, newValue)).toMatchInlineSnapshot(`
         [
           {
@@ -788,7 +799,7 @@ describe("feature toggles test", () => {
         ]
       `);
       expect(validator).toHaveBeenCalledTimes(1);
-      expect(validator).toHaveBeenCalledWith(newValue, SCOPE_ROOT_KEY);
+      expect(validator).toHaveBeenCalledWith(newValue, undefined, SCOPE_ROOT_KEY);
 
       expect(loggerSpy.warning).not.toHaveBeenCalled();
       expect(loggerSpy.error).not.toHaveBeenCalled();