@adobe/acc-js-sdk 1.1.6 → 1.1.7

package/test/mock.js

@@ -12,37 +12,37 @@ governing permissions and limitations under the License.
 
 
 /**********************************************************************************
- * 
+ *
  * Mock functions for unit tests
- * 
+ *
  *********************************************************************************/
- const sdk = require('../src/index.js');
- const crypto = require("crypto");
-
- const makeKey = () => {
-    const a = [];
-    for (let i=0; i<32; i++) {
-        a.push(Math.floor(crypto.randomInt(0, 256))); 
-    }
-    const buffer = Buffer.from(a);
-    const s = buffer.toString('base64');
-    return s;
- }
-
- async function makeAnonymousClient(options) {
-    const connectionParameters = sdk.ConnectionParameters.ofAnonymousUser("http://acc-sdk:8080", options);
-    const client = await sdk.init(connectionParameters);
-    if (!options || !options.transport) // allow tests to explicitely set the transport
-        client._transport = jest.fn();
-    return client;
+const sdk = require('../src/index.js');
+const crypto = require("crypto");
+
+const makeKey = () => {
+  const a = [];
+  for (let i=0; i<32; i++) {
+    a.push(Math.floor(crypto.randomInt(0, 256)));
+  }
+  const buffer = Buffer.from(a);
+  const s = buffer.toString('base64');
+  return s;
+}
+
+async function makeAnonymousClient(options) {
+  const connectionParameters = sdk.ConnectionParameters.ofAnonymousUser("http://acc-sdk:8080", options);
+  const client = await sdk.init(connectionParameters);
+  if (!options || !options.transport) // allow tests to explicitely set the transport
+    client._transport = jest.fn();
+  return client;
 }
 
 async function makeClient(options) {
-    const connectionParameters = sdk.ConnectionParameters.ofUserAndPassword("http://acc-sdk:8080", "admin", "admin", options);
-    const client = await sdk.init(connectionParameters);
-    if (!options || !options.transport) // allow tests to explicitely set the transport
-        client._transport = jest.fn();
-    return client;
+  const connectionParameters = sdk.ConnectionParameters.ofUserAndPassword("http://acc-sdk:8080", "admin", "admin", options);
+  const client = await sdk.init(connectionParameters);
+  if (!options || !options.transport) // allow tests to explicitely set the transport
+    client._transport = jest.fn();
+  return client;
 }
 
 /**
@@ -51,16 +51,16 @@ async function makeClient(options) {
  * @returns an array of logged messages
  */
 async function withMockConsole(fn) {
-    const logs = [];
-    jest.spyOn(console, 'log').mockImplementation((message) => {
-        logs.push(message);
-    });
-    try {
-        await fn();
-        return logs;
-    } finally {
-        console.log.mockRestore();   
-    }
+  const logs = [];
+  jest.spyOn(console, 'log').mockImplementation((message) => {
+    logs.push(message);
+  });
+  try {
+    await fn();
+    return logs;
+  } finally {
+    console.log.mockRestore();
+  }
 }
 
 const R_TEST = Promise.resolve(`<redir status='OK' date='2021-08-27 08:02:07.963-07' build='9236' sha1='cc45440' instance='xxx_mkt_prod1' sourceIP='193.104.215.11' host='xxxol.campaign.adobe.com' localHost='xxxol-mkt-prod1-1'/>`);
@@ -91,7 +91,7 @@ const LOGON_RESPONSE = Promise.resolve(`<?xml version='1.0'?>
     </SOAP-ENV:Body>
     </SOAP-ENV:Envelope>`);
 
-    const BEARER_LOGON_RESPONSE = Promise.resolve(`<?xml version='1.0'?>
+const BEARER_LOGON_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:xtk:session' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
     <SOAP-ENV:Body>
         <BearerTokenLogonResponse xmlns='urn:xtk:session' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
@@ -302,7 +302,7 @@ const GET_XTK_QUERY_SCHEMA_RESPONSE = Promise.resolve(`<?xml version='1.0'?>
     </SOAP-ENV:Envelope>`);
 
 const GET_MID_EXT_ACCOUNT_RESPONSE = (encryptedPassword) => {
-    return  Promise.resolve(`<?xml version='1.0'?>
+  return  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/'>
@@ -315,7 +315,7 @@ const GET_MID_EXT_ACCOUNT_RESPONSE = (encryptedPassword) => {
 }
 
 const GET_BAD_EXT_ACCOUNT_RESPONSE = (encryptedPassword) => {
-    return Promise.resolve(`<?xml version='1.0'?>
+  return 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/'>
@@ -328,7 +328,7 @@ const GET_BAD_EXT_ACCOUNT_RESPONSE = (encryptedPassword) => {
 }
 
 const GET_SECRET_KEY_OPTION_RESPONSE = (key) => {
-    return Promise.resolve(`<?xml version='1.0'?>
+  return 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:session' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
     <SOAP-ENV:Body>
         <GetOptionResponse xmlns='urn:xtk:session' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
@@ -354,7 +354,7 @@ const GET_LOGON_MID_RESPONSE = Promise.resolve(`<?xml version='1.0'?>
         </LogonResponse>
     </SOAP-ENV:Body>
     </SOAP-ENV:Envelope>`);
-    
+
 const GET_TSTCNX_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:xtk:session' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
     <SOAP-ENV:Body>
@@ -432,7 +432,7 @@ const GET_XTK_ALL_SCHEMA_RESPONSE = Promise.resolve(`<?xml version='1.0'?>
         </GetEntityIfMoreRecentResponse>
     </SOAP-ENV:Body>
     </SOAP-ENV:Envelope>`);
-    
+
 const GET_XTK_ALL_TYPES_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>
@@ -473,7 +473,7 @@ const GET_USER_INFO_RESPONSE = Promise.resolve(`<?xml version='1.0'?>
         </pUserInfo>
     </GetUserInfoResponse>
     </SOAP-ENV:Body>
-    </SOAP-ENV:Envelope>`); 
+    </SOAP-ENV:Envelope>`);
 
 const GET_MISSING_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/'>
@@ -483,8 +483,8 @@ const GET_MISSING_SCHEMA_RESPONSE = Promise.resolve(`<?xml version='1.0'?>
             </pdomDoc>
         </GetEntityIfMoreRecentResponse>
     </SOAP-ENV:Body>
-    </SOAP-ENV:Envelope>`); 
-   
+    </SOAP-ENV:Envelope>`);
+
 const GET_XTK_WORKFLOW_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>
@@ -635,6 +635,114 @@ const GETMODIFIEDENTITIES_CLEAR_RESPONSE = Promise.resolve(`<?xml version='1.0'?
         </GetModifiedEntitiesResponse>
     </SOAP-ENV:Body>
     </SOAP-ENV:Envelope>`);
+const GET_XTK_COUNTER_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="counter" namespace="xtk" xtkschema="xtk:schema">
+                        <element name="counter"></element>
+                        <methods>
+                        <method name="IncreaseValue" static="true">
+                          <parameters>
+                            <param name="name" type="string" label="Name" desc="Counter name"/>
+                            <param name="value" type="long" inout="out" label="Value" desc="New value of counter"/>
+                          </parameters>
+                        </method>
+                      </methods>                   
+                       </schema>
+                </pdomDoc>
+            </GetEntityIfMoreRecentResponse>
+        </SOAP-ENV:Body>
+        </SOAP-ENV:Envelope>`);
+
+const GET_FILERES_QUERY_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="fileRes" namespace="xtk" xtkschema="xtk:schema">
+                        <element name="fileRes"></element>
+                        <methods>
+                        <method name="PublishIfNeeded">
+                        </method>
+                        <method name="GetURL">
+                        <parameters>
+                          <param name="url" type="string" inout="out"/>
+                        </parameters>
+                          </method>
+                    </methods>                   
+                       </schema>
+                </pdomDoc>
+            </GetEntityIfMoreRecentResponse>
+        </SOAP-ENV:Body>
+        </SOAP-ENV:Envelope>`);
+
+const INCREASE_VALUE_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:xtk:counter'
+    xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
+    <SOAP-ENV:Body>
+        <IncreaseValueResponse
+            xmlns='urn:xtk:counter' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
+            <plValue xsi:type='xsd:int'>1</plValue>
+        </IncreaseValueResponse>
+    </SOAP-ENV:Body>
+</SOAP-ENV:Envelope>
+
+`);
+
+const FILE_RES_WRITE_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 _cs="Sessions to the application server (xtk)" created="2022-02-03 12:55:02.621Z" createdBy-id="0" dependingSchemas="" desc="Sessions to the application server" entitySchema="xtk:schema" img="" implements="xtk:persist" label="Sessions to the application server" labelSingular="Session" lastModified="2022-07-11 02:29:30.026Z" library="true" mappingType="xmlFile" md5="9D716FE59E174E87C5BA8A834DD4B11B" modifiedBy-id="0" name="session" namespace="xtk" xtkschema="xtk:schema">
+
+  <interface async="true" label="Persistence" name="persist">
+    <method name="Write" static="true">
+      <help>Update an entity</help>
+      <parameters>
+        <param desc="Document of difference" name="doc" type="DOMDocument"/>
+      </parameters>
+      <example><para>A simple recipient creation:</para>
+    \t  <programlisting>
+xtk.session.Write(
+    {recipient: {xtkschema: "nms:recipient", firstName: "Raul", lastName: "Endymion"}})
+      \t</programlisting>
+      </example>
+    </method>
+  </interface>
+
+</schema></pdomDoc></GetEntityIfMoreRecentResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>
+
+`);
+
+const PUBLISH_IF_NEEDED_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:xtk:fileRes'
+    xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
+    <SOAP-ENV:Body>
+        <PublishIfNeededResponse
+            xmlns='urn:xtk:fileRes' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
+        </PublishIfNeededResponse>
+    </SOAP-ENV:Body>
+</SOAP-ENV:Envelope>`);
+
+const GET_URL_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:xtk:fileRes'
+    xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
+    <SOAP-ENV:Body>
+        <GetURLResponse
+            xmlns='urn:xtk:fileRes' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
+            <pUrl xsi:type='xsd:string'>http://hello.com</pUrl>
+        </GetURLResponse>
+    </SOAP-ENV:Body>
+</SOAP-ENV:Envelope>`);
+
+
 
 
 const GETMODIFIEDENTITIES_SCHEMA_RESPONSE = Promise.resolve(`<?xml version='1.0'?>
@@ -721,5 +829,11 @@ exports.Mock = {
   GETMODIFIEDENTITIES_CLEAR_RESPONSE: GETMODIFIEDENTITIES_CLEAR_RESPONSE,
   GETMODIFIEDENTITIES_SCHEMA_RESPONSE: GETMODIFIEDENTITIES_SCHEMA_RESPONSE,
   GETMODIFIEDENTITIES_UNDEFINED_RESPONSE: GETMODIFIEDENTITIES_UNDEFINED_RESPONSE,
-  GETMODIFIEDENTITIES_ERROR_RESPONSE: GETMODIFIEDENTITIES_ERROR_RESPONSE
+  GETMODIFIEDENTITIES_ERROR_RESPONSE: GETMODIFIEDENTITIES_ERROR_RESPONSE,
+  GET_XTK_COUNTER_RESPONSE: GET_XTK_COUNTER_RESPONSE,
+  GET_FILERES_QUERY_SCHEMA_RESPONSE: GET_FILERES_QUERY_SCHEMA_RESPONSE,
+  INCREASE_VALUE_RESPONSE: INCREASE_VALUE_RESPONSE,
+  FILE_RES_WRITE_RESPONSE: FILE_RES_WRITE_RESPONSE,
+  PUBLISH_IF_NEEDED_RESPONSE: PUBLISH_IF_NEEDED_RESPONSE,
+  GET_URL_RESPONSE: GET_URL_RESPONSE
 }

package/test/observability.test.js

@@ -0,0 +1,267 @@
+/*
+Copyright 2020 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 the ACC client observability hooks
+ * 
+ *********************************************************************************/
+const sdk = require('../src/index.js');
+const Mock = require('./mock.js').Mock;
+
+const makeObservableClient = async(options, callback) => {
+    // No TTL for option cache so that we can test that we send cache stats every 5 mins
+    const client = await Mock.makeClient({ ...options, optionCacheTTL: 999999000 });
+    return [client, new ObservabilityAssertion(client, callback)];
+}
+
+class ObservabilityAssertion {
+    constructor(client, callback) {
+        const that = this;
+        this._callback = callback;
+        client.registerObserver({
+            event: (event, parentEvent) => { return that.onEvent(event, parentEvent); },
+        });
+        this._eventsByName = {};
+    }
+
+    onEvent(event, parentEvent) {
+        if (!this._eventsByName[event.eventName]) this._eventsByName[event.eventName] = [];
+        this._eventsByName[event.eventName].push({ event: event, parentEvent: parentEvent });
+        if (this._callback) this._callback.call(this, event, parentEvent);
+    }
+
+    hasObserved(eventName) {
+        if (!this._eventsByName[eventName]) return false;
+        return this._eventsByName[eventName].length > 0;
+    }
+    
+    getFirstObserved(eventName) {
+        if (!this._eventsByName[eventName]) return;
+        return this._eventsByName[eventName][0];
+    }
+
+    getObserved(eventName) {
+        if (!this._eventsByName[eventName]) [];
+        return this._eventsByName[eventName].filter(o => o.event.eventName === eventName).map(o => o.event);
+    }
+}
+
+describe('ACC Client Observability', function () {
+
+    it('Should observe logon and logoff', async function () {
+        const [client, assertion] = await makeObservableClient();
+
+        client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+        await client.NLWS.xtkSession.logon();
+        expect(assertion.hasObserved("SDK//logon")).toBe(true);
+        expect(assertion.hasObserved("SDK//logoff")).toBe(false);;
+        const logon = assertion.getFirstObserved("SDK//logon");
+        expect(logon.parentEvent).toBeUndefined();
+        expect(logon.event).toMatchObject({ eventId: 1, eventName: "SDK//logon" });
+        expect(logon.event.timestamp).toBeGreaterThan(0);
+
+        client._transport.mockReturnValueOnce(Mock.LOGOFF_RESPONSE);
+        await client.NLWS.xtkSession.logoff();
+        expect(assertion.hasObserved("SDK//logoff")).toBe(true);
+        const logoff = assertion.getFirstObserved("SDK//logoff");
+        expect(logoff.event).toMatchObject({ eventName: "SDK//logoff" });
+        expect(logoff.event.eventId).toBeGreaterThan(1);
+        expect(logoff.event.timestamp).toBeGreaterThanOrEqual(logon.event.timestamp);
+
+        // there should not be an auto refresh event if auto-refresh mechanism
+        // is off
+        expect(assertion.hasObserved("CACHE_REFRESHER//stop")).toBe(false);
+    });
+
+    it('Should ignore exceptions throws from observer', async () => {
+        const [client, assertion] = await makeObservableClient({}, (event, parentEvent) => {
+            throw new Error("Simulated failure in observer");
+        });
+        client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+        // logon will send an observability event, but the error will be logged and ignored
+        await client.NLWS.xtkSession.logon();
+        expect(assertion.hasObserved("SDK//logon")).toBe(true);
+    });
+
+    it('Should send internal stats every 5 minutes', async () => {
+        jest.useFakeTimers();
+        const [client, assertion] = await makeObservableClient();
+
+        client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+        await client.NLWS.xtkSession.logon();
+        expect(assertion.hasObserved("SDK//logon")).toBe(true);
+
+        // Calling get option should generate some cache hits
+        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");
+
+        jest.advanceTimersByTime(310000);
+        client._trackEvent("TEST/dummy", undefined, {});
+        // Note: options cache is written twice: once in the SOAP call itself, and once by the getOption method
+        // entity cache is also written twice: once for xtk:session and once from xtk:persist
+        expect(assertion.getObserved("CACHE//stats")).toEqual(expect.arrayContaining(
+            [
+                expect.objectContaining({ payload: { name: 'entityCache', clears: 0, loads: 1, memoryHits: 0, reads: 1, removals: 0, saves: 2, storageHits: 0, writes: 2 } }),
+                expect.objectContaining({ payload: { name: 'optionCache', clears: 0, loads: 1, memoryHits: 0, reads: 1, removals: 0, saves: 2, storageHits: 0, writes: 2 } }),
+            ]
+        ));
+
+        // Calling get option again should make a cache hit
+        // Only work if options cache TTL is very high
+        databaseId = await client.getOption("XtkDatabaseId");
+        expect(databaseId).toBe("uFE80000000000000F1FA913DD7CC7C480041161C");
+        jest.advanceTimersByTime(310000);
+        client._trackEvent("TEST/dummy", undefined, {});
+        expect(assertion.getObserved("CACHE//stats")).toEqual(expect.arrayContaining(
+            [
+                expect.objectContaining({ payload: { name: 'entityCache', clears: 0, loads: 1, memoryHits: 0, reads: 1, removals: 0, saves: 2, storageHits: 0, writes: 2 } }),
+                expect.objectContaining({ payload: { name: 'optionCache', clears: 0, loads: 1, memoryHits: 1, reads: 2, removals: 0, saves: 2, storageHits: 0, writes: 2 } }),
+            ]
+        ));
+
+        client._transport.mockReturnValueOnce(Mock.LOGOFF_RESPONSE);
+        await client.NLWS.xtkSession.logoff();
+        expect(assertion.hasObserved("SDK//logoff")).toBe(true);
+
+        jest.useRealTimers();
+    });
+
+    it('_trackCacheStats should support cache with no stats', async () => {
+        const [client, assertion] = await makeObservableClient();
+        client._trackEvent = jest.fn();
+        client._trackCacheStats('hello', undefined);
+        expect(client._trackEvent.mock.calls.length).toBe(0);
+        client._trackCacheStats('hello', {});
+        expect(client._trackEvent.mock.calls.length).toBe(0);
+        client._trackCacheStats('hello', { _stats: {} });
+        expect(client._trackEvent.mock.calls.length).toBe(1);
+    });
+
+    it('Should track SOAP calls', async () => {
+        const [client, assertion] = await makeObservableClient();
+
+        client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+        await client.NLWS.xtkSession.logon();
+        expect(assertion.hasObserved("SDK//logon")).toBe(true);
+
+        // Calling get option should generate some cache hits
+        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 requests = assertion.getObserved("SOAP//request");
+        expect(requests.length).toBe(3);
+        expect(requests[0].payload).toMatchObject({ internal: false, urn: 'xtk:session', methodName: 'Logon', retry: false, retryCount: 0 });
+        expect(requests[1].payload).toMatchObject({ internal: true, urn: 'xtk:persist', methodName: 'GetEntityIfMoreRecent', retry: false, retryCount: 0 });
+        expect(requests[2].payload).toMatchObject({ internal: false, urn: 'xtk:session', methodName: 'GetOption', retry: false, retryCount: 0 });
+
+        const responses = assertion.getObserved("SOAP//response");
+        expect(responses.length).toBe(3);
+        expect(responses[0].payload).toMatchObject({ });
+        expect(responses[1].payload).toMatchObject({ });
+        expect(responses[2].payload).toMatchObject({ });
+    });
+
+    it('Should track caches auto-refresh (error in GetModifiedEntities API)', async () => {
+        jest.useFakeTimers();
+        const [client, assertion] = await makeObservableClient();
+
+        client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+        await client.NLWS.xtkSession.logon();
+        expect(assertion.hasObserved("SDK//logon")).toBe(true);
+
+        client.startRefreshCaches();
+        expect(assertion.hasObserved("CACHE_REFRESHER//start")).toBe(true);
+        const start = assertion.getFirstObserved("CACHE_REFRESHER//start");
+        expect(start.event).toMatchObject({ eventName:"CACHE_REFRESHER//start", payload:{ cacheSchemaId: "xtk:option", refreshFrequency: 10000 } });
+
+        // No mock implementation => the API call to get modified entities will fail generating a CACHE_REFRESHER//error event
+        await client._optionCacheRefresher._safeCallAndRefresh();
+        expect(assertion.hasObserved("CACHE_REFRESHER//tick")).toBe(true);
+        const tick = assertion.getFirstObserved("CACHE_REFRESHER//tick");
+        expect(tick.event).toMatchObject({ eventName:"CACHE_REFRESHER//tick", payload:{ cacheSchemaId: "xtk:option" } });
+        expect(assertion.hasObserved("CACHE_REFRESHER//error")).toBe(true);
+        const error = assertion.getFirstObserved("CACHE_REFRESHER//error");
+        expect(error.event).toMatchObject({ eventName:"CACHE_REFRESHER//error", payload:{ cacheSchemaId: "xtk:option" } });
+        // An error in the API should not stop the auto-refresh mechanism
+        expect(assertion.hasObserved("CACHE_REFRESHER//stop")).toBe(false);
+
+        client._transport.mockReturnValueOnce(Mock.LOGOFF_RESPONSE);
+        await client.NLWS.xtkSession.logoff();
+        expect(assertion.hasObserved("SDK//logoff")).toBe(true);
+        expect(assertion.hasObserved("CACHE_REFRESHER//stop")).toBe(true);
+        jest.useRealTimers();
+    });
+
+    it('Should track caches auto-refresh (success in GetModifiedEntities API)', async () => {
+        jest.useFakeTimers();
+        const [client, assertion] = await makeObservableClient();
+
+        client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+        await client.NLWS.xtkSession.logon();
+        expect(assertion.hasObserved("SDK//logon")).toBe(true);
+
+        client.startRefreshCaches();
+        expect(assertion.hasObserved("CACHE_REFRESHER//start")).toBe(true);
+        const start = assertion.getFirstObserved("CACHE_REFRESHER//start");
+        expect(start.event).toMatchObject({ eventName:"CACHE_REFRESHER//start", payload:{ cacheSchemaId: "xtk:option", refreshFrequency: 10000 } });
+
+        client._transport.mockReturnValue(Promise.resolve(Mock.GETMODIFIEDENTITIES_RESPONSE));
+        await client._optionCacheRefresher._safeCallAndRefresh();
+        expect(assertion.hasObserved("CACHE_REFRESHER//tick")).toBe(true);
+        const tick = assertion.getFirstObserved("CACHE_REFRESHER//tick");
+        expect(tick.event).toMatchObject({ eventName:"CACHE_REFRESHER//tick", payload:{ cacheSchemaId: "xtk:option" } });
+        expect(assertion.hasObserved("CACHE_REFRESHER//error")).toBe(false);
+        expect(assertion.hasObserved("CACHE_REFRESHER//abort")).toBe(false);
+        expect(assertion.hasObserved("CACHE_REFRESHER//stop")).toBe(false);
+
+        client._transport.mockReturnValueOnce(Mock.LOGOFF_RESPONSE);
+        await client.NLWS.xtkSession.logoff();
+        expect(assertion.hasObserved("SDK//logoff")).toBe(true);
+        expect(assertion.hasObserved("CACHE_REFRESHER//stop")).toBe(true);
+        jest.useRealTimers();
+    });
+
+    it('Should track caches auto-refresh (GetModifiedEntities API missing)', async () => {
+        jest.useFakeTimers();
+        const [client, assertion] = await makeObservableClient();
+
+        client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+        await client.NLWS.xtkSession.logon();
+        expect(assertion.hasObserved("SDK//logon")).toBe(true);
+
+        client.startRefreshCaches();
+        expect(assertion.hasObserved("CACHE_REFRESHER//start")).toBe(true);
+        const start = assertion.getFirstObserved("CACHE_REFRESHER//start");
+        expect(start.event).toMatchObject({ eventName:"CACHE_REFRESHER//start", payload:{ cacheSchemaId: "xtk:option", refreshFrequency: 10000 } });
+
+        client._transport.mockReturnValue(Promise.resolve(Mock.GETMODIFIEDENTITIES_UNDEFINED_RESPONSE));
+        await client._optionCacheRefresher._safeCallAndRefresh();
+        expect(assertion.hasObserved("CACHE_REFRESHER//tick")).toBe(true);
+        const tick = assertion.getFirstObserved("CACHE_REFRESHER//tick");
+        expect(tick.event).toMatchObject({ eventName:"CACHE_REFRESHER//tick", payload:{ cacheSchemaId: "xtk:option" } });
+        expect(assertion.hasObserved("CACHE_REFRESHER//error")).toBe(false);
+        // Should send an abort event and stop the auto-refresher
+        expect(assertion.hasObserved("CACHE_REFRESHER//abort")).toBe(true);
+        expect(assertion.hasObserved("CACHE_REFRESHER//stop")).toBe(true);
+
+        client._transport.mockReturnValueOnce(Mock.LOGOFF_RESPONSE);
+        await client.NLWS.xtkSession.logoff();
+        jest.useRealTimers();
+    });
+
+});
+