@adobe/acc-js-sdk 1.1.30 → 1.1.31

package/docs/changeLog.html

@@ -3,6 +3,14 @@ layout: page
 title: Change Log
 ---
 
+<section class="changelog"><h1>Version 1.1.31</h1>
+  <h2>2023/06/19</h2>
+  <li>
+    Fixed a caching issue: xtk:session method can be missing from the cache. This is a temporary fix. A better fix is needed to
+    properly handle consistency of the entity and method caches.
+  </li>
+</section>
+
 <section class="changelog"><h1>Version 1.1.30</h1>
   <h2>2023/06/19</h2>
   <li>

package/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@adobe/acc-js-sdk",
-  "version": "1.1.30",
+  "version": "1.1.31",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@adobe/acc-js-sdk",
-      "version": "1.1.30",
+      "version": "1.1.31",
       "license": "ISC",
       "dependencies": {
         "axios": "^1.2.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/acc-js-sdk",
-  "version": "1.1.30",
+  "version": "1.1.31",
   "description": "ACC Javascript SDK",
   "main": "src/index.js",
   "homepage": "https://github.com/adobe/acc-js-sdk#readme",

package/src/client.js

@@ -1787,8 +1787,11 @@ class Client {
                   if (entity) {
                       const impls = DomUtil.getAttributeAsString(entity, "implements");
                       if (impls === "xtk:persist" && schemaId !== "xtk:session" && schemaId !== "xtk:persist") {
-                        // Ensure xtk:persist is present by loading the xtk:session schema
-                        await this.getSchema("xtk:session", "xml", true);
+                          // Ensure xtk:persist is present by loading the xtk:session schema
+                          const xtkSession = await this.getSchema("xtk:session", "xml", true);
+                          // it is possible that methodCache content has not be loaded in memory
+                          // so we re-put the methods 
+                          await this._methodCache.put(xtkSession);
                       }
                       await this._entityCache.put("xtk:schema", schemaId, entity);
                       await this._methodCache.put(entity);

package/test/client.test.js

@@ -965,6 +965,49 @@ describe('ACC Client', function () {
             await client.NLWS.xtkSession.logoff();
         });
 
+        it("Should always put in cache methods of schema to avoid a method is not found", async () => {
+            const client = await Mock.makeClient();
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+
+            client._transport.mockReturnValueOnce(Mock.GET_XTK_SESSION_SCHEMA_RESPONSE);
+            client._transport.mockReturnValueOnce(Mock.GET_USER_INFO_RESPONSE);
+            // call a method of xtk:session to have the schema xt:session in memory and in entityCache
+            await client.NLWS.xtkSession.getUserInfo();
+            
+            // simulate expiration of methodCache only (entityCache not expired)
+            client._methodCache.clear();
+
+            client._transport.mockReturnValueOnce(Mock.GET_XTK_IMPL_SCHEMA_RESPONSE);
+            client._transport.mockReturnValueOnce(Mock.GET_XTK_SESSION_SCHEMA_RESPONSE);
+            await client.NLWS.xtkImpl.Duplicate();
+
+            client._transport.mockReturnValueOnce(Mock.LOGOFF_RESPONSE);
+            await client.NLWS.xtkSession.logoff();
+        });
+
+        it("Should always put in memory methods of schema to avoid a method is not found", async () => {
+            const client = await Mock.makeClient();
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+
+            client._transport.mockReturnValueOnce(Mock.GET_XTK_SESSION_SCHEMA_RESPONSE);
+            client._transport.mockReturnValueOnce(Mock.GET_USER_INFO_RESPONSE);
+            // call a method of xtk:session to have the schema xt:session in memory and in entityCache
+            await client.NLWS.xtkSession.getUserInfo();
+
+            // simulate empty cache method in memory
+            client._methodCache._cache = {};
+
+            client._transport.mockReturnValueOnce(Mock.GET_XTK_IMPL_SCHEMA_RESPONSE);
+            client._transport.mockReturnValueOnce(Mock.GET_XTK_SESSION_SCHEMA_RESPONSE);
+            await client.NLWS.xtkImpl.Duplicate();
+
+            client._transport.mockReturnValueOnce(Mock.LOGOFF_RESPONSE);
+            await client.NLWS.xtkSession.logoff();
+        });
+
+
         it("Should fail if method parameter inout attribute is not correct", async () => {
             const client = await Mock.makeClient();
             client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);

package/test/mock.js

@@ -219,6 +219,8 @@ const GET_XTK_SESSION_SCHEMA_RESPONSE = Promise.resolve(`<?xml version='1.0'?>
                 <interface name="persist">
                     <method name="NewInstance">
                     </method>
+                    <method name="Duplicate" static="true">
+                    </method>
                     <method name="Write" static="true">
                         <parameters>
                             <param name="doc" type="DOMDocument"/>
@@ -565,6 +567,19 @@ const GET_NMS_EXTACCOUNT_SCHEMA_RESPONSE = Promise.resolve(`<?xml version='1.0'?
     </SOAP-ENV:Body>
     </SOAP-ENV:Envelope>`);
 
+const GET_XTK_IMPL_SCHEMA_RESPONSE = Promise.resolve(`<?xml version='1.0'?>
+    <SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ns='urn:wpp:default' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
+    <SOAP-ENV:Body>
+        <GetEntityIfMoreRecentResponse xmlns='urn:wpp:default' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
+            <pdomDoc xsi:type='ns:Element' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
+                <schema name="impl" namespace="xtk" xtkschema="xtk:schema" implements="xtk:persist">
+                    <element name="one"></element>
+                </schema>
+            </pdomDoc>
+        </GetEntityIfMoreRecentResponse>
+    </SOAP-ENV:Body>
+    </SOAP-ENV:Envelope>`);
+
 const GET_XTK_ALL_SCHEMA_RESPONSE = Promise.resolve(`<?xml version='1.0'?>
     <SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ns='urn:wpp:default' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
     <SOAP-ENV:Body>
@@ -999,6 +1014,7 @@ exports.Mock = {
   GET_TSTCNX_RESPONSE: GET_TSTCNX_RESPONSE,
   GET_NMS_EXTACCOUNT_SCHEMA_RESPONSE: GET_NMS_EXTACCOUNT_SCHEMA_RESPONSE,
   GET_XTK_ALL_SCHEMA_RESPONSE: GET_XTK_ALL_SCHEMA_RESPONSE,
+  GET_XTK_IMPL_SCHEMA_RESPONSE: GET_XTK_IMPL_SCHEMA_RESPONSE,
   GET_XTK_ALL_TYPES_RESPONSE: GET_XTK_ALL_TYPES_RESPONSE,
   GET_XTK_TYPE_UNSUPPORTED_TYPE_RESPONSE: GET_XTK_TYPE_UNSUPPORTED_TYPE_RESPONSE,
   GET_USER_INFO_RESPONSE: GET_USER_INFO_RESPONSE,