Added Client.assume:when criteria to bypass Switcher results (#195)

Author: petruki

.github/workflows/master.yml

@@ -29,7 +29,7 @@ jobs:
           SWITCHER_API_KEY: ${{ secrets.SWITCHER_API_KEY }}
 
       - name: SonarCloud Scan
-        uses: sonarsource/sonarcloud-github-action@master
+        uses: sonarsource/sonarqube-scan-action@v4.1.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

README.md

@@ -46,7 +46,7 @@ const apiKey = '[API_KEY]';
 const environment = 'default';
 const domain = 'My Domain';
 const component = 'MyApp';
-const url = 'https://switcherapi.com/api';
+const url = 'https://api.switcherapi.com';
 ```
 
 - **domain**: Domain name.
@@ -148,13 +148,13 @@ Client.subscribeNotifyError((error) => {
 6. **Hybrid mode**
 Forcing Switchers to resolve remotely can help you define exclusive features that cannot be resolved locally.
 This feature is ideal if you want to run the SDK in local mode but still want to resolve a specific switcher remotely.
-```ts
+```js
 const switcher = Client.getSwitcher();
 await switcher.remote().isItOn('FEATURE01');
 ```
 
 ## Built-in mock feature
-You can also bypass your switcher configuration by invoking 'Client.assume'. This is perfect for your test code where you want to test both scenarios when the switcher is true and false.
+You can also bypass your switcher configuration by invoking 'Client.assume'. This is perfect for your test code where you want to validate both scenarios when the switcher is true and false.
 
 ```js
 Client.assume('FEATURE01').true();
@@ -166,6 +166,12 @@ switcher.isItOn('FEATURE01'); // Now, it's going to return the result retrieved
 Client.assume('FEATURE01').false().withMetadata({ message: 'Feature is disabled' }); // Include metadata to emulate Relay response
 const response = await switcher.detail().isItOn('FEATURE01'); // false
 console.log(response.metadata.message); // Feature is disabled
+
+Client.assume('FEATURE01').true().when(StrategiesType.VALUE, 'USER_1');
+switcher.checkValue('USER_1').isItOn('FEATURE01'); // true when the value is 'USER_1'
+
+Client.assume('FEATURE01').true().when(StrategiesType.NETWORK, ['USER_2', 'USER_3']);
+switcher.checkValue('USER_1').isItOn('FEATURE01'); // false as the value is not in the list
 ```
 
 **Enabling Test Mode**

package.json

@@ -1,6 +1,6 @@
 {
   "name": "switcher-client",
-  "version": "4.1.2",
+  "version": "4.2.0",
   "description": "Client JS SDK for working with Switcher-API",
   "main": "./switcher-client.js",
   "type": "module",
@@ -30,14 +30,14 @@
     "src/"
   ],
   "devDependencies": {
-    "@babel/eslint-parser": "^7.25.8",
-    "@typescript-eslint/eslint-plugin": "^8.10.0",
-    "@typescript-eslint/parser": "^8.10.0",
+    "@babel/eslint-parser": "^7.25.9",
+    "@typescript-eslint/eslint-plugin": "^8.17.0",
+    "@typescript-eslint/parser": "^8.17.0",
     "c8": "^10.1.2",
-    "chai": "^5.1.1",
+    "chai": "^5.1.2",
     "env-cmd": "^10.1.0",
-    "eslint": "^9.13.0",
-    "mocha": "^10.7.3",
+    "eslint": "^9.16.0",
+    "mocha": "^11.0.1",
     "mocha-sonarqube-reporter": "^1.0.2",
     "sinon": "^19.0.2"
   },

sonar-project.properties

@@ -1,7 +1,7 @@
 sonar.projectKey=switcherapi_switcher-client-master
 sonar.projectName=switcher-client-js
 sonar.organization=switcherapi
-sonar.projectVersion=4.1.2
+sonar.projectVersion=4.2.0
 sonar.links.homepage=https://github.com/switcherapi/switcher-client-js
 
 sonar.javascript.lcov.reportPaths=coverage/lcov.info

src/client.d.ts

@@ -123,8 +123,22 @@ export class Client {
  */
 export type ResultDetail = {
   result: boolean;
-  reason: string;
-  metadata: any;
+  reason: string | undefined;
+  metadata: object | undefined;
+}
+
+/**
+ * Criteria defines the condition(s) to evaluate the switcher when using Client.assume(key)
+ */
+export type Criteria = {
+
+  /**
+   * Add a new strategy/input to the criteria
+   * 
+   * @param strategy (StrategiesType) value to be evaluated
+   */
+  and(strategy: string, input: string | string[]): this;
+
 }
 
 /**
@@ -199,8 +213,15 @@ declare class Key {
    */
   withMetadata(metadata: any): Key;
 
+  /**
+   * Conditionally set result based on strategy
+   * 
+   * @param strategy (StrategiesType) value to be evaluated
+   */
+  when(strategy: string, input: string | string[]): Criteria;
+
   /**
    * Return key response
    */
-  getResponse(): ResultDetail;
+  getResponse(input?: string[][]): ResultDetail;
 }

src/lib/bypasser/criteria.js

@@ -0,0 +1,28 @@
+import { StrategiesType } from '../snapshot.js';
+
+/**
+ * Criteria defines a set of conditions (when) that are used to evaluate the bypasser strategies
+ */
+export default class Criteria {
+    #when;
+
+    constructor(strategy, input) {
+        this.#when = new Map();
+        this.#when.set(strategy, Array.isArray(input) ? input : [input]);
+    }
+
+    /**
+     * Add a new strategy/input to the criteria
+     */
+    and(strategy, input) {
+        if (Object.values(StrategiesType).filter((s) => s === strategy).length) {
+            this.#when.set(strategy, Array.isArray(input) ? input : [input]);
+        }
+
+        return this;
+    }
+
+    getWhen() {
+        return this.#when;
+    }
+}

src/lib/bypasser/key.js

@@ -1,13 +1,15 @@
+import Criteria from './criteria.js';
+
 /**
  * Key record used to store key response when bypassing criteria execution
  */
 export default class Key {
-
     #key;
     #result;
     #reason;
     #metadata;
-    
+    #criteria;
+
     constructor(key) {
         this.#key = key;
         this.#result = undefined;
@@ -41,6 +43,14 @@ export default class Key {
         return this;
     }
 
+    /**
+     * Conditionally set result based on strategy
+     */
+    when(strategy, input) {
+        this.#criteria = new Criteria(strategy, input);
+        return this.#criteria;
+    }
+
     /**
      * Return selected switcher name
      */
@@ -51,12 +61,28 @@ export default class Key {
     /**
      * Return key response
      */
-    getResponse() {
+    getResponse(input) {
+        let result = this.#result;
+        if (this.#criteria && input) {
+            result = this.#getResultBasedOnCriteria(this.#criteria, input);
+        }
+
         return {
-            key: this.#key,
-            result: this.#result,
+            result,
             reason: this.#reason,
-            metadata: this.#metadata
+            metadata: this.#metadata,
         };
     }
+
+    #getResultBasedOnCriteria(criteria, input) {
+        for (const [strategyWhen, inputWhen] of criteria.getWhen()) {
+            const entry = input.filter((e) => e[0] === strategyWhen);
+            if (entry.length && !inputWhen.includes(entry[0][1])) {
+                this.#reason = `Forced to ${!this.#result} when: [${inputWhen}] - input: ${entry[0][1]}`;
+                return !this.#result;
+            }
+        }
+
+        return this.#result;
+    }
 }

src/switcher.js

@@ -54,7 +54,7 @@ export class Switcher {
     // verify if query from Bypasser
     const bypassKey = Bypasser.searchBypassed(this.#key);
     if (bypassKey) {
-      const response = bypassKey.getResponse();
+      const response = bypassKey.getResponse(util.get(this.#input, []));
       return this.#showDetail ? response : response.result;
     }
 

switcher-client.js

@@ -16,4 +16,5 @@
  */
 
 export { Client, ResultDetail, SwitcherContext, SwitcherOptions } from './src/client.js';
-export { Switcher } from './src/switcher.js';
+export { Switcher } from './src/switcher.js';
+export { StrategiesType } from './src/lib/snapshot.js';