feat: removed data attribute from snapshot (#212)

Author: petruki

package.json

@@ -1,6 +1,6 @@
 {
   "name": "switcher-client",
-  "version": "4.4.2",
+  "version": "4.5.0",
   "description": "Client JS SDK for working with Switcher-API",
   "main": "./switcher-client.js",
   "type": "module",
@@ -32,8 +32,8 @@
   ],
   "devDependencies": {
     "@babel/eslint-parser": "^7.28.4",
-    "@typescript-eslint/eslint-plugin": "^8.45.0",
-    "@typescript-eslint/parser": "^8.45.0",
+    "@typescript-eslint/eslint-plugin": "^8.46.0",
+    "@typescript-eslint/parser": "^8.46.0",
     "c8": "^10.1.3",
     "chai": "^6.2.0",
     "env-cmd": "^11.0.0",

sonar-project.properties

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

src/client.js

@@ -118,7 +118,7 @@ export class Client {
 
     const snapshot = await validateSnapshot(
       Client.#context,
-      GlobalSnapshot.snapshot.data.domain.version
+      GlobalSnapshot.snapshot.domain.version
     );
 
     if (snapshot) {
@@ -149,7 +149,7 @@ export class Client {
       Client.watchSnapshot();
     }
 
-    return GlobalSnapshot.snapshot?.data.domain.version || 0;
+    return GlobalSnapshot.snapshot?.domain.version || 0;
   }
 
   /**
@@ -160,7 +160,7 @@ export class Client {
    * - GlobalOptions.local is false, meaning it will not use the local snapshot.
    */
   static #isCheckSnapshotAvailable(fetchRemote) {
-    return GlobalSnapshot.snapshot?.data.domain.version == 0 && (fetchRemote || !GlobalOptions.local);
+    return GlobalSnapshot.snapshot?.domain.version == 0 && (fetchRemote || !GlobalOptions.local);
   }
 
   static watchSnapshot(callback = {}) {
@@ -256,7 +256,7 @@ export class Client {
   }
 
   static get snapshotVersion() {
-    return GlobalSnapshot.snapshot?.data.domain.version || 0;
+    return GlobalSnapshot.snapshot?.domain.version || 0;
   }
 }
 

src/lib/remote.js

@@ -166,7 +166,7 @@ export async function resolveSnapshot(domain, environment, component) {
         });
 
         if (response.status == 200) {
-            return JSON.stringify(response.json(), null, 4);
+            return JSON.stringify(response.json().data, null, 4);
         }
 
         throw new RemoteError(`[resolveSnapshot] failed with status ${response.status}`);

src/lib/resolver.js

@@ -4,18 +4,18 @@ import * as util from '../lib/utils/index.js';
 import { SwitcherResult } from './result.js';
 
 /**
- * Resolves the criteria for a given switcher request against the snapshot data.
+ * Resolves the criteria for a given switcher request against the snapshot domain.
  * 
- * @param {SnapshotData} data - The snapshot data containing domain and group information.
+ * @param {Domain} domain - The domain containing groups and configurations.
  * @param {SwitcherRequest} switcher - The switcher request to be evaluated.
  * @returns {SwitcherResult} - The result of the switcher evaluation.
  */
-function resolveCriteria(data, switcher) {
-    if (!data.domain.activated) {
+function resolveCriteria(domain, switcher) {
+    if (!domain.activated) {
         return SwitcherResult.disabled('Domain disabled');
     }
 
-    const { group } = data.domain;
+    const { group } = domain;
     return checkGroup(group, switcher);
 }
 
@@ -127,7 +127,7 @@ function isStrategyFulfilled(strategyEntry, strategyConfig) {
 /**
  * Checks the criteria for a switcher request against the local snapshot.
  * 
- * @param {Snapshot | undefined} snapshot - The snapshot containing the data to check against.
+ * @param {Snapshot | undefined} snapshot - The snapshot containing the domain to check against.
  * @param {SwitcherRequest} switcher - The switcher request to be evaluated.
  * @returns {SwitcherResult} - The result of the switcher evaluation.
  * @throws {Error} - If the snapshot is not loaded.
@@ -137,6 +137,6 @@ export default function checkCriteriaLocal(snapshot, switcher) {
         throw new Error('Snapshot not loaded. Try to use \'Client.loadSnapshot()\'');
     }
 
-    const { data } = snapshot;
-    return resolveCriteria(data, switcher);
+    const { domain } = snapshot;
+    return resolveCriteria(domain, switcher);
 }

src/lib/snapshot.js

@@ -14,7 +14,7 @@ const loadDomain = (snapshotLocation, environment) => {
         if (existsSync(snapshotFile)) {
             dataBuffer = readFileSync(snapshotFile);
         } else {
-            dataBuffer = JSON.stringify({ data: { domain: { version: 0 } } }, null, 4);
+            dataBuffer = JSON.stringify({ domain: { version: 0 } }, null, 4);
 
             if (snapshotLocation.length) {
                 mkdirSync(snapshotLocation, { recursive: true });
@@ -40,7 +40,7 @@ const validateSnapshot = async (context, snapshotVersion) => {
 };
 
 const checkSwitchersLocal = (snapshot, switcherKeys) => {
-    const { group } = snapshot.data.domain;
+    const { group } = snapshot.domain;
     let notFound = [], found = false;
 
     for (const switcher of switcherKeys) {

tests/playground/index.js

@@ -187,7 +187,7 @@ const _testSnapshotAutoUpdate = async () => {
         const time = Date.now();
         await switcher.checkValue('user_1').isItOn(SWITCHER_KEY);
         console.clear();
-        console.log(Client.getLogger(SWITCHER_KEY), `executed in ${Date.now() - time}ms`);
+        console.log(JSON.stringify(Client.getLogger(SWITCHER_KEY)), `executed in ${Date.now() - time}ms`);
     }, 2000);
 };
 

tests/playground/snapshot/default.json

@@ -1,34 +1,32 @@
 {
-    "data": {
-        "domain": {
-            "name": "Switcher API",
-            "version": 1,
-            "activated": true,
-            "group": [
-                {
-                    "name": "Test Project",
-                    "activated": true,
-                    "config": [
-                        {
-                            "key": "CLIENT_JS_FEATURE",
-                            "activated": true,
-                            "strategies": [
-                                {
-                                    "strategy": "VALUE_VALIDATION",
-                                    "activated": false,
-                                    "operation": "EXIST",
-                                    "values": [
-                                        "user_1"
-                                    ]
-                                }
-                            ],
-                            "components": [
-                                "switcher-client-js"
-                            ]
-                        }
-                    ]
-                }
-            ]
-        }
+    "domain": {
+        "name": "Switcher API",
+        "version": 1,
+        "activated": true,
+        "group": [
+            {
+                "name": "Test Project",
+                "activated": true,
+                "config": [
+                    {
+                        "key": "CLIENT_JS_FEATURE",
+                        "activated": true,
+                        "strategies": [
+                            {
+                                "strategy": "VALUE_VALIDATION",
+                                "activated": false,
+                                "operation": "EXIST",
+                                "values": [
+                                    "user_1"
+                                ]
+                            }
+                        ],
+                        "components": [
+                            "switcher-client-js"
+                        ]
+                    }
+                ]
+            }
+        ]
     }
 }

tests/playground/snapshot/local.json

@@ -1,25 +1,23 @@
 {
-    "data": {
-        "domain": {
-            "name": "Switcher API",
-            "version": 1,
-            "activated": true,
-            "group": [
-                {
-                    "name": "Test Project",
-                    "activated": true,
-                    "config": [
-                        {
-                            "key": "CLIENT_JS_FEATURE",
-                            "activated": true,
-                            "strategies": [],
-                            "components": [
-                                "switcher-client-js"
-                            ]
-                        }
-                    ]
-                }
-            ]
-        }
+    "domain": {
+        "name": "Switcher API",
+        "version": 1,
+        "activated": true,
+        "group": [
+            {
+                "name": "Test Project",
+                "activated": true,
+                "config": [
+                    {
+                        "key": "CLIENT_JS_FEATURE",
+                        "activated": true,
+                        "strategies": [],
+                        "components": [
+                            "switcher-client-js"
+                        ]
+                    }
+                ]
+            }
+        ]
     }
 }