@adobe/acc-js-sdk 1.1.25 → 1.1.27

package/test/client.test.js

@@ -434,6 +434,129 @@ describe('ACC Client', function () {
             await client.NLWS.xtkSession.logoff();
         });
 
+        it("Should return temp group schema definition", async () => {
+            const client = await Mock.makeClient();
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+           
+            client._transport.mockReturnValueOnce(Mock.GET_XTK_QUERY_SCHEMA_RESPONSE);
+            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:xtk:queryDef' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
+              <SOAP-ENV:Body>
+              <ExecuteQueryResponse xmlns='urn:xtk:queryDef' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
+                  <pdomOutput xsi:type='ns:Element' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
+                  <group expirationDate="" folder-id="1199" id="2200" label="testlist" name="LST260" schema="nms:recipient" type="1">
+                    <extension label="email is not empty" mappingType="sql" name="query" namespace="temp">
+                      <element advanced="false" dataSource="nms:extAccount:ffda" label="email is not empty" name="query" pkSequence="" sqltable="grp2200" unbound="false">
+                        <compute-string expr=""/>
+                        <key internal="true" name="internal">
+                          <keyfield xpath="@id"/>
+                        </key>
+                        <attribute advanced="false" belongsTo="@id" label="Primary key" length="0" name="id" notNull="false" sql="true" sqlname="uId" type="uuid" xml="false"/>
+                        <element advanced="false" externalJoin="true" label="Targeting dimension" name="target" revLink="" target="nms:recipient" type="link" unbound="false">
+                          <join xpath-dst="@id" xpath-src="@id"/>
+                        </element>
+                      </element>
+                    </extension>
+                    <desc><![CDATA[]]></desc>
+                    <folder _cs="Lists" fullName="/Profiles and Targets/Lists/" id="1199"/>
+                  </group>
+                  </pdomOutput></ExecuteQueryResponse>
+              </SOAP-ENV:Body>
+              </SOAP-ENV:Envelope>`));
+          
+            var schema = await client.getSchema("temp:group:2200");
+            expect(schema["namespace"]).toBe("temp");
+            expect(schema["name"]).toBe("query");
+            expect(schema["element"].label).toBe("email is not empty");
+
+            // Update label of first element
+            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:xtk:queryDef' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
+              <SOAP-ENV:Body>
+              <ExecuteQueryResponse xmlns='urn:xtk:queryDef' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
+                  <pdomOutput xsi:type='ns:Element' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
+                  <group expirationDate="" folder-id="1199" id="2200" label="testlist" name="LST260" schema="nms:recipient" type="1">
+                    <extension label="email is not empty" mappingType="sql" name="query" namespace="temp">
+                      <element advanced="false" dataSource="nms:extAccount:ffda" label="email is empty" name="query" pkSequence="" sqltable="grp2200" unbound="false">
+                        <compute-string expr=""/>
+                        <key internal="true" name="internal">
+                          <keyfield xpath="@id"/>
+                        </key>
+                        <attribute advanced="false" belongsTo="@id" label="Primary key" length="0" name="id" notNull="false" sql="true" sqlname="uId" type="uuid" xml="false"/>
+                        <element advanced="false" externalJoin="true" label="Targeting dimension" name="target" revLink="" target="nms:recipient" type="link" unbound="false">
+                          <join xpath-dst="@id" xpath-src="@id"/>
+                        </element>
+                      </element>
+                    </extension>
+                    <desc><![CDATA[]]></desc>
+                    <folder _cs="Lists" fullName="/Profiles and Targets/Lists/" id="1199"/>
+                  </group>
+                  </pdomOutput></ExecuteQueryResponse>
+              </SOAP-ENV:Body>
+              </SOAP-ENV:Envelope>`));
+             var schema = await client.getSchema("temp:group:2200");
+             expect(schema["namespace"]).toBe("temp");
+             expect(schema["name"]).toBe("query");
+             //check that we have the updated label
+             expect(schema["element"].label).toBe("email is empty");
+        });
+
+        it("Should return null when temp group schema definition is empty", async () => {
+            const client = await Mock.makeClient();
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+           
+            client._transport.mockReturnValueOnce(Mock.GET_XTK_QUERY_SCHEMA_RESPONSE);
+            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:xtk:queryDef' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
+                  <SOAP-ENV:Body>
+                    <ExecuteQueryResponse xmlns='urn:xtk:queryDef' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
+                      <pdomOutput xsi:type='ns:Element' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
+                        <group />
+                      </pdomOutput></ExecuteQueryResponse>
+                  </SOAP-ENV:Body>
+                </SOAP-ENV:Envelope>`));
+           
+            var schema = await client.getSchema("temp:group:2200");
+            expect(schema).toBeNull();
+        });
+
+        it("Should return null when temp group schema definition does not exist", async () => {
+            const client = await Mock.makeClient();
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+          
+            client._transport.mockReturnValueOnce(Mock.GET_XTK_QUERY_SCHEMA_RESPONSE);
+            client._transport.mockReturnValueOnce(Promise.resolve(`<?xml version='1.0' encoding='UTF-8'?>
+                <SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/' xmlns:ns='http://xml.apache.org/xml-soap'>
+                  <SOAP-ENV:Body>
+                    <SOAP-ENV:Fault>
+                        <faultcode>faultcode</faultcode>
+                        <faultstring>SOP-330011</faultstring>
+                        <detail>"Error while executing the method 'ExecuteQuery' of service 'xtk:queryDef'."</detail>
+                    </SOAP-ENV:Fault>
+                  </SOAP-ENV:Body>
+                </SOAP-ENV:Envelope>`));
+                
+            var schema = await client.getSchema("temp:group:2200");
+            expect(schema).toBeNull();
+        });
+
+        it("Should rethrow exception when exception is not related to not existing group", async () => {
+            const client = await Mock.makeClient();
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+            
+            client._transport.mockReturnValueOnce(Mock.GET_XTK_QUERY_SCHEMA_RESPONSE);
+            client._transport.mockReturnValueOnce(Mock.GET_XTK_SESSION_SCHEMA_RESPONSE);
+
+            try {
+                var schema = await client.getSchema("temp:group:2200");
+                expect(schema).toBe('not be called')
+            } catch (ex) {}
+        });
+      
         it("Should return sys enum definition", async () => {
             const client = await Mock.makeClient({ representation: "BadgerFish" });
             client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
@@ -3874,7 +3997,9 @@ describe('ACC Client', function () {
             const schema = client.newSchema(xml);
             const jobs = schema.root.children["jobs"];
             expect(jobs.target).toBe("xtk:job");
-            await expect(jobs.linkTarget()).rejects.toThrow("Cannot read property 'getSchema' of null");
+            // node 14 throws "Cannot read property 'getSchema' of null"
+            // node 16+ throws "Cannot read properties of null (reading 'getSchema')"
+            await expect(jobs.linkTarget()).rejects.toThrow(/Cannot read (.*getSchema.*of null)|(.*of null.*getSchema)/);
         });
     });
 });

package/test/domUtil.test.js

@@ -157,6 +157,20 @@ describe('DomUtil', function() {
             assert.strictEqual(fromJSON({ "a": null }), '<root/>');
             assert.strictEqual(fromJSON({ "a": undefined }), '<root/>');
         });
+
+        it("Should support attributes named 'length'", () => {
+            const json = {
+                element: {
+                  attribute: {
+                    length: "256",
+                    name: "id",
+                  },
+              }
+            };
+            const doc = DomUtil.fromJSON("extension", json);
+            const xml = DomUtil.toXMLString(doc);
+            expect(xml).toEqual('<extension><element><attribute length="256" name="id"/></element></extension>');
+        });
     });
 
     describe('fromJSON (default)', function() {

package/test/imBearerToken.test.js

@@ -0,0 +1,174 @@
+/*
+Copyright 2023 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+
+/**********************************************************************************
+ *
+ * Unit tests for IMS Bearer Token authentication
+ *
+ *********************************************************************************/
+const sdk = require('../src/index.js');
+const Mock = require('./mock.js').Mock;
+
+describe('IMS Bearer Toekn', function () {
+
+    async function makeImsClient(options) {
+        const connectionParameters = sdk.ConnectionParameters.ofImsBearerToken("http://acc-sdk:8080", "ey...", options);
+        const client = await sdk.init(connectionParameters);
+        if (!options || !options.transport) // allow tests to explicitely set the transport
+          client._transport = jest.fn();
+        return client;
+      }
+
+    it('Should logon with IMS Bearer Token', async () => {
+        const client = await makeImsClient();
+        // No "Logon" API call is made when using IMS Bearer Token
+        //client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+        await client.NLWS.xtkSession.logon();
+        expect(client.isLogged()).toBe(true);
+    });
+
+    // The logoff API invalidates the session created on the server side and does not invalidate 
+    // the bearer token. To invalidate the bearer token, IMS should be used
+    it('Should logoff', async () => {
+        const client = await makeImsClient();
+        await client.NLWS.xtkSession.logon();
+
+        client._transport.mockReturnValueOnce(Mock.LOGOFF_RESPONSE);
+        await client.NLWS.xtkSession.logoff();
+        expect(client.isLogged()).toBe(false);
+
+        expect(client._transport).toBeCalledTimes(1);
+        const calls = client._transport.mock.calls;
+        expect(calls[0][0].headers).toMatchObject({
+            "ACC-SDK-Auth": "ImsBearerToken",
+            "Authorization": "Bearer ey..."
+        });
+        expect(calls[0][0].headers["X-Security-Token"]).toBeUndefined();
+        expect(calls[0][0].headers["X-Session-Token"]).toBeUndefined();
+    });
+
+    it('Should call API with Bearer Token', async () => {
+        const client = await makeImsClient();
+        await client.NLWS.xtkSession.logon();
+
+        // Get Option
+        client._transport.mockReturnValueOnce(Mock.GET_XTK_SESSION_SCHEMA_RESPONSE);
+        client._transport.mockReturnValueOnce(Mock.GET_DATABASEID_RESPONSE);
+        var databaseId = await client.getOption("XtkDatabaseId");
+        expect(databaseId).toBe("uFE80000000000000F1FA913DD7CC7C480041161C");
+
+        // Check that headers were correctly populated for both calls
+        expect(client._transport).toBeCalledTimes(2);
+        const calls = client._transport.mock.calls;
+        expect(calls[0][0].headers).toMatchObject({
+            "ACC-SDK-Auth": "ImsBearerToken",
+            "ACC-SDK-Call-Internal": "1",
+            "Authorization": "Bearer ey..."
+        });
+        expect(calls[0][0].headers["X-Security-Token"]).toBeUndefined();
+        expect(calls[0][0].headers["X-Session-Token"]).toBeUndefined();
+
+        expect(calls[1][0].headers).toMatchObject({
+            "ACC-SDK-Auth": "ImsBearerToken",
+            "Authorization": "Bearer ey..."
+        });
+        expect(calls[1][0].headers["ACC-SDK-Call-Internal"]).toBeUndefined();
+        expect(calls[1][0].headers["X-Security-Token"]).toBeUndefined();
+        expect(calls[1][0].headers["X-Session-Token"]).toBeUndefined();
+    });
+
+    it("Expired session refresh client callback", async () => {
+
+        const refreshClient = async (client) => {
+            const connectionParameters = sdk.ConnectionParameters.ofImsBearerToken("http://acc-sdk:8080", "ey2...", options);
+            client.reinit(connectionParameters);
+            await client.NLWS.xtkSession.logon();
+            return client;
+        };
+
+        const transport = jest.fn();
+        const options = {
+            transport: transport,
+            refreshClient: refreshClient,
+        };
+        const connectionParameters = sdk.ConnectionParameters.ofImsBearerToken("http://acc-sdk:8080", "ey1...", options);
+        const client = await sdk.init(connectionParameters);
+        await client.NLWS.xtkSession.logon();
+
+        client._transport.mockReturnValueOnce(Promise.resolve(`XSV-350008 Session has expired or is invalid. Please reconnect.`));
+        client._transport.mockReturnValueOnce(Mock.GET_XTK_SESSION_SCHEMA_RESPONSE);
+        client._transport.mockReturnValueOnce(Mock.GET_DATABASEID_RESPONSE);
+        var databaseId = await client.getOption("XtkDatabaseId");
+        expect(databaseId).toBe("uFE80000000000000F1FA913DD7CC7C480041161C");
+        const lastCall = client._transport.mock.calls[client._transport.mock.calls.length - 1];
+        expect(lastCall[0].headers).toMatchObject({
+            "ACC-SDK-Auth": "ImsBearerToken",
+            "Authorization": "Bearer ey2..."
+        });
+        expect(lastCall[0].headers["X-Security-Token"]).toBeUndefined();
+        expect(lastCall[0].headers["X-Session-Token"]).toBeUndefined();
+    });
+
+
+    it("Should call ping API", async () => {
+        const client = await makeImsClient();
+        await client.NLWS.xtkSession.logon();
+
+        client._transport.mockReturnValueOnce(Mock.PING);
+        const ping = await client.ping();
+        expect(ping.status).toBe("OK");
+        expect(ping.timestamp).toBe("2021-08-27 15:43:48.862Z");
+
+        const lastCall = client._transport.mock.calls[client._transport.mock.calls.length - 1];
+        expect(lastCall[0].headers).toMatchObject({
+            "ACC-SDK-Auth": "ImsBearerToken",
+            "Authorization": "Bearer ey..."
+        });
+        expect(lastCall[0].headers["X-Security-Token"]).toBeUndefined();
+        expect(lastCall[0].headers["X-Session-Token"]).toBeUndefined();
+    });
+
+    it("Should call mcPing API", async () => {
+        const client = await makeImsClient();
+        await client.NLWS.xtkSession.logon();
+
+        client._transport.mockReturnValueOnce(Mock.MC_PING);
+        const ping = await client.mcPing();
+        expect(ping.status).toBe("Ok");
+
+        const lastCall = client._transport.mock.calls[client._transport.mock.calls.length - 1];
+        expect(lastCall[0].headers).toMatchObject({
+            "ACC-SDK-Auth": "ImsBearerToken",
+            "Authorization": "Bearer ey..."
+        });
+        expect(lastCall[0].headers["X-Security-Token"]).toBeUndefined();
+        expect(lastCall[0].headers["X-Session-Token"]).toBeUndefined();
+    });
+
+    it("Should allow to use the application object", async () => {
+        const client = await makeImsClient();
+        await client.NLWS.xtkSession.logon();
+        const application = client.application;
+        expect(application).toBeDefined();
+
+        client._transport.mockReturnValueOnce(Mock.GET_NMS_EXTACCOUNT_SCHEMA_RESPONSE);
+        const schema = await application.getSchema("nms:extAccount");
+        expect(schema).toBeDefined();
+        expect(schema.name).toBe("extAccount");
+
+        // But the application object does not have any info about packages
+        // since we are using a bearer token. Packages are only available
+        // when using one of the Logon methods (Logno or BearertokenLogon)
+        expect(application.packages).toBeUndefined();
+    });
+});