@adobe/acc-js-sdk 1.1.60 → 1.1.62

package/package.json

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

package/src/client.js

@@ -309,6 +309,7 @@ class Credentials {
     * @property {number} timeout - Can be set to change the HTTP call timeout. Value is passed in ms.
     * @property {string} cacheRootKey - "default" or "none" - determine the prefix to use for the keys in the caches of schemas, options, etc.
     * @property {string} instanceKey - an optional value to override the instance key which is used for the caches of schemas, options, etc.
+    * @property {boolean} enableRequestIdHeader - an optional value to enable the request ID header for SOAP API calls
     * @memberOf Campaign
  */
 
@@ -1178,11 +1179,26 @@ class Client {
      * parameters should be set
      */
     _prepareSoapCall(urn, method, isStatic, internal, extraHttpHeaders, pushDownOptions) {
+
+        // Send request ID header if enableRequestIdHeader flag is set to true
+        const enableRequestIdHeader = this._connectionParameters._options &&
+          this._connectionParameters._options.enableRequestIdHeader;
+        let updatedExtraHttpHeaders = extraHttpHeaders;
+        if (enableRequestIdHeader) {
+          try {
+            const requestId = Util.getUUID();
+            updatedExtraHttpHeaders = Object.assign({}, extraHttpHeaders, {
+              "x-request-id": requestId,
+            });
+          } catch (error) {
+            console.error("Failed to generate request ID", error);
+          }
+        }
         const soapCall = new SoapMethodCall(this._transport, urn, method,
                                             this._sessionToken, this._securityToken,
                                             this._getUserAgentString(),
                                             Object.assign({}, this._connectionParameters._options, pushDownOptions),
-                                            extraHttpHeaders,
+                                            updatedExtraHttpHeaders,
                                             this._bearerToken);
         soapCall.internal = !!internal;
         soapCall.isStatic = isStatic;

package/test/client.test.js

@@ -3446,6 +3446,97 @@ describe('ACC Client', function () {
                 "X-Query-Source": `${sdk.getSDKVersion().name} ${sdk.getSDKVersion().version},Test client app`,
             });
         });
+
+        it("Should add x-request-id header to SOAP call when enableRequestIdHeader is true", async () => {
+            const client = await Mock.makeClient({ enableRequestIdHeader: true });
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+
+            const mockGetUUID = jest.spyOn(Util, 'getUUID').mockImplementation(() => { return 'test-uuid'; });
+
+            client._transport.mockReturnValueOnce(Mock.GET_XTK_QUERY_SCHEMA_RESPONSE);
+            client._transport.mockReturnValueOnce(Mock.GET_QUERY_EXECUTE_RESPONSE);
+            
+            const queryDef = {
+                "schema": "nms:extAccount",
+                "operation": "select",
+                "select": {
+                    "node": [
+                        { "expr": "@id" },
+                        { "expr": "@name" }
+                    ]
+                }
+            };
+            const query = client.NLWS.xtkQueryDef.create(queryDef);
+
+            const headers = await collectHeaders(client, async() => {
+                await query.executeQuery();
+            });
+
+            expect(headers["x-request-id"]).toBe('test-uuid');
+            
+            // Restore the mock
+            mockGetUUID.mockRestore();
+        });
+
+        it("Should call SOAP call on request ID generation failure", async () => {
+            const client = await Mock.makeClient({enableRequestIdHeader: true});
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+            
+            const mockGetUUID = jest.spyOn(Util, 'getUUID').mockImplementation(() => { throw new Error('UUID error'); });
+            
+            client._transport.mockReturnValueOnce(Mock.GET_XTK_QUERY_SCHEMA_RESPONSE);
+            client._transport.mockReturnValueOnce(Mock.GET_QUERY_EXECUTE_RESPONSE);
+            const queryDef = {
+                "schema": "nms:extAccount",
+                "operation": "select",
+                "select": {
+                    "node": [{ "expr": "@id" }]
+                }
+            };
+            
+            const query = client.NLWS.xtkQueryDef.create(queryDef);
+
+            const headers = await collectHeaders(client, async() => {
+                await query.executeQuery();
+            });
+
+            expect(headers["x-request-id"]).toBeUndefined();
+            
+            // Restore the mock
+            mockGetUUID.mockRestore();
+        });
+
+
+        it("Should not add x-request-id header to SOAP call when enableRequestIdHeader is false", async () => {
+            const client = await Mock.makeClient({ enableRequestIdHeader: false });
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+            
+            const mockGetUUID = jest.spyOn(Util, 'getUUID').mockImplementation(() => { throw new Error('UUID error'); });
+            
+            client._transport.mockReturnValueOnce(Mock.GET_XTK_QUERY_SCHEMA_RESPONSE);
+            client._transport.mockReturnValueOnce(Mock.GET_QUERY_EXECUTE_RESPONSE);
+            const queryDef = {
+                "schema": "nms:extAccount",
+                "operation": "select",
+                "select": {
+                    "node": [{ "expr": "@id" }]
+                }
+            };
+            
+            const query = client.NLWS.xtkQueryDef.create(queryDef);
+
+            const headers = await collectHeaders(client, async() => {
+                await query.executeQuery();
+            });
+
+            expect(headers["x-request-id"]).toBeUndefined();
+            
+            // Restore the mock
+            mockGetUUID.mockRestore();
+        });
     });
 
     describe("Pushdown parameters", () => {