@adobe/acc-js-sdk 1.1.17 → 1.1.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/acc-js-sdk",
-  "version": "1.1.17",
+  "version": "1.1.18",
   "description": "ACC Javascript SDK",
   "main": "src/index.js",
   "homepage": "https://github.com/adobe/acc-js-sdk#readme",
@@ -10,17 +10,17 @@
     "test": "test"
   },
   "dependencies": {
-    "axios": "^0.25.0",
-    "jsdom": "^19.0.0",
+    "axios": "^1.2.1",
+    "jsdom": "^20.0.3",
     "qs-stringify": "^1.2.1"
   },
   "devDependencies": {
-    "docdash": "^1.2.0",
+    "docdash": "^2.0.0",
     "eslint": "^8.7.0",
-    "jest": "^27.4.7",
-    "jest-junit": "^13.0.0",
-    "jsdoc": "^3.6.7",
-    "jshint": "^2.13.3"
+    "jest": "^29.3.1",
+    "jest-junit": "^15.0.0",
+    "jsdoc": "^4.0.0",
+    "jshint": "^2.13.6"
   },
   "author": "",
   "scripts": {

package/src/client.js

@@ -647,6 +647,15 @@ class Client {
         if (instanceKey.startsWith("https://")) instanceKey = instanceKey.substr(8);
         const rootKey = `acc.js.sdk.${sdk.getSDKVersion().version}.${instanceKey}.cache`;
 
+        // Clear storage cache if the sdk versions or the instances are different
+        if (this._storage && typeof this._storage.removeItem === 'function') {
+          for (let key in this._storage) {
+            if (key.startsWith("acc.js.sdk.") && !key.startsWith(rootKey)) {
+              this._storage.removeItem(key);
+            }
+          }
+        }
+
         this._entityCache = new XtkEntityCache(this._storage, `${rootKey}.XtkEntityCache`, connectionParameters._options.entityCacheTTL);
         this._entityCacheRefresher = new CacheRefresher(this._entityCache, this, "xtk:schema", `${rootKey}.XtkEntityCache`);
         this._methodCache = new MethodCache(this._storage, `${rootKey}.MethodCache`, connectionParameters._options.methodCacheTTL);

package/test/client.test.js

@@ -2316,7 +2316,7 @@ describe('ACC Client', function () {
             expect(JSON.parse(call[1])).toMatchObject({
                 value: { value: "World", type: 6 }
             })
-        });
+        })
 
         it("Should ignore protocol for local storage root key", async () => {
             const version = sdk.getSDKVersion().version; // "${version}" or similar
@@ -2359,7 +2359,7 @@ describe('ACC Client', function () {
             client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
             await client.NLWS.xtkSession.logon();
             client._transport.mockReturnValueOnce(Mock.GET_NMS_EXTACCOUNT_SCHEMA_RESPONSE);
-             await client.getSchema("nms:extAccount");
+            await client.getSchema("nms:extAccount");
             // Schema should have been cached to local storage
             expect(storage.setItem.mock.calls.length).toBe(1);
             expect(storage.setItem.mock.calls[0][0]).toMatch("cache.XtkEntityCache$xtk:schema|nms:extAccount");
@@ -2375,6 +2375,73 @@ describe('ACC Client', function () {
             await client.NLWS.xtkSession.logon();
             client._transport.mockReturnValueOnce(Mock.GET_NMS_EXTACCOUNT_SCHEMA_RESPONSE);
             await client.getSchema("nms:extAccount");
+            // Here we can't simply check the length of mock calls since there're for "lastCleared"
+            // We check inside the new calls, since the creation of the second client, if there's 
+            // one for the schema "nms:extAccount"
+            let callLength = storage.getItem.mock.calls.length;
+            expect(storage.getItem.mock.calls[callLength-1][0]).toMatch("cache.XtkEntityCache$xtk:schema|nms:extAccount");
+        })
+
+        it("Should clear storage if necessary", async () => {
+            const sdkVersion = sdk.getSDKVersion().version;
+            const mockSdkVersionItemKey    = "acc.js.sdk.0.0.0.acc-sdk:8080.cache.Hello";
+            const otherItemKey             = "other.Hello";
+            const map = {};
+            const storage = {
+                "acc.js.sdk.0.0.0.acc-sdk:8080.cache.Hello": "0.0.0.World",
+                "other.Hello": "other.World",
+                getItem: jest.fn((key) => map[key]),
+                setItem: jest.fn((key, value) => map[key] = value),
+                removeItem: jest.fn((key) => { delete map[key] })
+            }
+
+            let client = await Mock.makeClient({ storage: storage });
+
+            // Remove item not matches to the current sdk version and begins with "acc.js.sdk"
+            expect(storage.removeItem.mock.calls.length).toBe(1);
+            expect(storage.removeItem.mock.calls[0][0]).toMatch(mockSdkVersionItemKey);
+
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+            client._transport.mockReturnValueOnce(Mock.GET_NMS_EXTACCOUNT_SCHEMA_RESPONSE);
+            await client.getSchema("nms:extAccount");
+            const currentSdkVersionItemKey = "acc.js.sdk."+sdkVersion+".acc-sdk:8080.cache.XtkEntityCache$xtk:schema|nms:extAccount";
+            expect(storage.setItem.mock.calls[0][0]).toMatch(currentSdkVersionItemKey);
+
+            // Remove ONLY the item not matches to the current sdk version but not the one matches
+            // Now simulate reusing the local storage to make sure that we remove ONLY the item 
+            // not matches to the current sdk version.
+            // We need a new client to make sure we do not reuse the in-memory cache of the client.
+            // We use the same test method as the one we use in the previous test "Should cache XML in storage"
+            client = await Mock.makeClient({ storage: storage });
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+            client._transport.mockReturnValueOnce(Mock.GET_NMS_EXTACCOUNT_SCHEMA_RESPONSE);
+            await client.getSchema("nms:extAccount");
+            let callLength = storage.getItem.mock.calls.length;
+            expect(storage.getItem.mock.calls[callLength-1][0]).toMatch("cache.XtkEntityCache$xtk:schema|nms:extAccount");
+        })
+
+        it("Should support 'storage.removeItem' not defined", async () => {
+            const mockSdkVersionItemKey    = "acc.js.sdk.0.0.0.acc-sdk:8080.cache.Hello";
+            const map = {};
+            const storage = {
+                "acc.js.sdk.0.0.0.acc-sdk:8080.cache.Hello": "0.0.0.World",
+                getItem: jest.fn((key) => map[key]),
+                setItem: jest.fn((key, value) => map[key] = value)
+            }
+            let client = await Mock.makeClient({ storage: storage });
+            // storage.removeItem not defined. Cache should not be removed.
+            expect(storage[mockSdkVersionItemKey]).toStrictEqual("0.0.0.World");
+        })
+
+        it("Should support 'storage' not defined", async () => {
+            const storage = undefined
+            let client = await Mock.makeClient({ storage: storage });
+            // Create a client with "storage" undefined
+            const NLWS = client.NLWS;
+            expect(NLWS).toBeTruthy();
+            expect(client.isLogged()).toBe(false);
         })
     })