@adobe/acc-js-sdk 1.1.29 → 1.1.31

package/docs/changeLog.html

@@ -3,6 +3,22 @@ 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>
+    Fixed an issue causing errors when parsing some specific enumerations such as xtk:dataTransfer:decimalCount which
+    contain enumeration values without "value" attributes and whose "name" attribute contains stringified numbers.
+  </li>
+</section>
+
 <section class="changelog"><h1>Version 1.1.29</h1>
   <h2>2023/06/15</h2>
   <li>

package/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@adobe/acc-js-sdk",
-  "version": "1.1.29",
+  "version": "1.1.31",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@adobe/acc-js-sdk",
-      "version": "1.1.29",
+      "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.29",
+  "version": "1.1.31",
   "description": "ACC Javascript SDK",
   "main": "src/index.js",
   "homepage": "https://github.com/adobe/acc-js-sdk#readme",

package/src/application.js

@@ -1021,7 +1021,12 @@ function XtkEnumerationValue(xml, baseType, parentTranslationId) {
      * @type {string}
      */
     this.applicableIf = EntityAccessor.getAttributeAsString(xml, "applicableIf");
-    const stringValue = EntityAccessor.getAttributeAsString(xml, "value");
+    let stringValue = EntityAccessor.getAttributeAsString(xml, "value");
+    if (stringValue == "" && XtkCaster.isNumericType(baseType)) {
+        // Some enumerations (ex: xtk:dataTransfer:decimalCount) are of numeric type but do
+        // not have a "value" defined. In this case, we try to cas the name as the value
+        stringValue = this.name;
+    }
     /**
      * The enumeration value, casted according to the enumeration type
      * @type {*}
@@ -1082,31 +1087,46 @@ class XtkEnumeration {
          * The enumerations values 
          * @type {Utils.ArrayMap<Campaign.XtkEnumerationValue>}
          */
-         this.values = new ArrayMap();
-
-         var defaultValue = EntityAccessor.getAttributeAsString(xml, "default");
-         this._localizationId = `${schemaId}__${this.name}`.replace(':','__');
+        this.values = new ArrayMap();
+
+        var defaultValue = EntityAccessor.getAttributeAsString(xml, "default");
+        this._localizationId = `${schemaId}__${this.name}`.replace(':','__');
+
+         // Determine if the enumeration can support both access by name and by index.
+         // Some enumerations, such as xtk:dataTransfer:decimalCount are ambiguous since
+         // they have names which are string reprensentation of their values (ex: name="0").
+         // In this case enumValue[0] may mean either the first enumeration value (index 0)
+         // or the enumeration value with value "0" which happens to be the second
+        let supportsIndexing = true;
+        const values = [];
+        for (var child of EntityAccessor.getChildElements(xml, "value")) {
+            const e = new XtkEnumerationValue(child, this.baseType, this._localizationId);
+            values.push(e);
+            const numericName = +e.name;
+            if (numericName === numericName) {
+                // Name is a number
+                supportsIndexing = false;
+            }
+        }
 
-         for (var child of EntityAccessor.getChildElements(xml, "value")) {
-             const e = new XtkEnumerationValue(child, this.baseType, this._localizationId);
-             this.values._push(e.name, e);
-             if (e.image != "") this.hasImage = true;
-             const stringValue = EntityAccessor.getAttributeAsString(child, "name");
-             if (defaultValue == stringValue)
-                 this.default = e;
-         }
+        for (const e of values) {
+            this.values._push(e.name, e, !supportsIndexing);
+            if (e.image != "") this.hasImage = true;
+            const stringValue = e.name;
+            if (defaultValue == stringValue)
+                this.default = e;
+        }
 
-         this.labelLocalizationId = this._localizationId + "__@label";
-         this.descriptionLocalizationId = this._localizationId + "__@desc";
-         propagateImplicitValues(this, true);
+        this.labelLocalizationId = this._localizationId + "__@label";
+        this.descriptionLocalizationId = this._localizationId + "__@desc";
+        propagateImplicitValues(this, true);
 
         /**
          * The system enumeration name, without the schema id prefix
          * @type {string}
          */
-         this.shortName = this.name;
-         this.name = `${schemaId}:${this.shortName}`;
-         
+        this.shortName = this.name;
+        this.name = `${schemaId}:${this.shortName}`;
     }
 }
 

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/src/util.js

@@ -194,14 +194,15 @@ class ArrayMap {
       });
   }
 
-  _push(key, value) {
+  _push(key, value, withoutIndexing) {
       let isNumKey = false;
       if (key) {
         // reserved keyworkds
         const isReserved = key === "_items" || key === "length" || key === "_push" || key === "forEach" || key === "map" || key === "_map" || key === "get" || key === "find" || key === "flatMap" || key === "filter";
 
         // already a child with the name => there's a problem with the schema
-        if (!isReserved && this[key]) throw new Error(`Failed to add element '${key}' to ArrayMap. There's already an item with the same name`);
+        if (!isReserved && this[key]) 
+          throw new Error(`Failed to add element '${key}' to ArrayMap. There's already an item with the same name`);
 
         // Set key as a enumerable property, so that elements can be accessed by key, 
         // but also iterated on with a for ... in loop
@@ -218,7 +219,7 @@ class ArrayMap {
         }
       }
 
-      if (!isNumKey) {
+      if (!withoutIndexing && !isNumKey) {
         // Set the index property so that items can be accessed by array index.
         // However, make it non-enumerable to make sure indexes do not show up in a for .. in loop
         Object.defineProperty(this, this._items.length, {

package/test/application.test.js

@@ -700,6 +700,43 @@ describe('Application', () => {
                     expect(enumeration).toBeFalsy();
                 });
             });
+
+            it("Should support numeric enumeration with implicit value", async () => {
+                // Example in xtk:dataTransfer:decimalCount
+                const client = await Mock.makeClient();
+                client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+                await client.NLWS.xtkSession.logon();
+                client._transport.mockReturnValueOnce(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="dataTransfer" namespace="xtk" xtkschema="xtk:schema">
+                                <enumeration name="decimalCount" basetype="short">
+                                    <value value="-1" name="all" label="All"/>
+                                    <value name="0"/>
+                                    <value name="1"/>
+                                    <value name="2"/>
+                                    <value name="3"/>
+                                    <value name="4"/>
+                                    <value name="5"/>
+                                    <value name="6"/>
+                                    <value name="7"/>
+                                    <value name="8"/>
+                                    <value name="9"/>
+                                </enumeration>
+                            </schema>
+                        </pdomDoc>
+                    </GetEntityIfMoreRecentResponse>
+                </SOAP-ENV:Body>
+                </SOAP-ENV:Envelope>`));
+                const enumeration = await client.application.getSysEnum("decimalCount", "xtk:dataTransfer");
+                expect(enumeration.label).toBe("DecimalCount");
+                const values = enumeration.values;
+                expect(values["all"].value).toBe(-1)
+                expect(values["0"].value).toBe(0)
+                expect(values["1"].value).toBe(1)
+            });
         });
 
         describe("Keys", () => {

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,