add test coverage

Author: ZamoraEmmanuel

.github/workflows/ci-cd.yml

@@ -57,7 +57,7 @@ jobs:
         run: BUILD_BRANCH=$(echo "${GITHUB_REF#refs/heads/}") npm run build
 
       - name: Store assets
-        if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/fme-12310' || github.ref == 'refs/heads/main') }}
+        if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/development' || github.ref == 'refs/heads/main') }}
         uses: actions/upload-artifact@v5
         with:
           name: assets
@@ -68,7 +68,7 @@ jobs:
     name: Upload assets
     runs-on: ubuntu-latest
     needs: build
-    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/fme-12310' }}
+    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/development' }}
     strategy:
       matrix:
         environment:

src/__tests__/browserSuites/push-synchronization.spec.js

@@ -91,7 +91,7 @@ const EXPECTED_DELAY_AND_BACKOFF = 241 + 100;
 export function testSynchronization(fetchMock, assert) {
   // Force the backoff base of UpdateWorkers to reduce test time
   Backoff.__TEST__BASE_MILLIS = 100;
-  assert.plan(34);
+  assert.plan(39); // +3 for FLAGS_UPDATE metadata, +2 for SEGMENTS_UPDATE metadata
   fetchMock.reset();
 
   let start, splitio, client, otherClient, keylistAddClient, keylistRemoveClient, bitmapTrueClient, sharedClients = [];
@@ -108,7 +108,10 @@ export function testSynchronization(fetchMock, assert) {
 
     setTimeout(() => {
       assert.equal(client.getTreatment('whitelist'), 'not_allowed', 'evaluation of initial Split');
-      client.once(client.Event.SDK_UPDATE, () => {
+      client.once(client.Event.SDK_UPDATE, (metadata) => {
+        assert.equal(metadata.type, 'FLAGS_UPDATE', 'SDK_UPDATE for SPLIT_UPDATE should have type FLAGS_UPDATE');
+        assert.true(Array.isArray(metadata.names), 'metadata.names should be an array');
+        assert.true(metadata.names.includes('whitelist'), 'metadata.names should include the updated whitelist split');
         const lapse = Date.now() - start;
         assert.true(nearlyEqual(lapse, MILLIS_FIRST_SPLIT_UPDATE_EVENT), 'SDK_UPDATE due to SPLIT_UPDATE event');
         assert.equal(client.getTreatment('whitelist'), 'allowed', 'evaluation of updated Split');
@@ -202,7 +205,9 @@ export function testSynchronization(fetchMock, assert) {
 
               const timestampUnboundEvent = Date.now();
 
-              client.once(client.Event.SDK_UPDATE, () => {
+              client.once(client.Event.SDK_UPDATE, (metadata) => {
+                assert.equal(metadata.type, 'SEGMENTS_UPDATE', 'SDK_UPDATE for MEMBERSHIPS_LS_UPDATE should have type SEGMENTS_UPDATE');
+                assert.true(Array.isArray(metadata.names), 'metadata.names should be an array');
                 assert.true(nearlyEqual(Date.now() - timestampUnboundEvent, EXPECTED_DELAY_AND_BACKOFF), 'SDK_UPDATE after fetching memberships with a delay');
                 assert.equal(client.getTreatment('in_large_segment'), 'yes', 'evaluation after myLargeSegment fetch');
               });

src/__tests__/browserSuites/ready-from-cache.spec.js

@@ -179,7 +179,7 @@ export default function (fetchMock, assert) {
       events: 'https://events.baseurl/readyFromCacheWithData'
     };
     localStorage.clear();
-    t.plan(12 * 2 + 3);
+    t.plan(12 * 2 + 3 + 2); // +2 for SDK_READY and SDK_READY_FROM_CACHE metadata.initialCacheLoad asserts
 
     fetchMock.get(testUrls.sdk + '/splitChanges?s=1.3&since=25&rbSince=-1', () => {
       return new Promise(res => { setTimeout(() => res({ status: 200, body: { ff: { ...splitChangesMock1.ff, s: 25 } }, headers: {} }), 200); }); // 400ms is how long it'll take to reply with Splits, no SDK_READY should be emitted before that.
@@ -225,7 +225,8 @@ export default function (fetchMock, assert) {
       t.end();
     });
 
-    client.on(client.Event.SDK_READY_FROM_CACHE, () => {
+    client.on(client.Event.SDK_READY_FROM_CACHE, (metadata) => {
+      t.false(metadata.initialCacheLoad, 'SDK_READY_FROM_CACHE from cache should have initialCacheLoad false');
       t.true(Date.now() - startTime < 400, 'It should emit SDK_READY_FROM_CACHE on every client if there was data in the cache and we subscribe on time. Should be considerably faster than actual readiness from the cloud.');
       t.equal(client.getTreatment('always_on'), 'off', 'It should evaluate treatments with data from cache instead of control due to Input Validation');
     });
@@ -238,7 +239,8 @@ export default function (fetchMock, assert) {
       t.equal(client3.getTreatment('always_on'), 'off', 'It should evaluate treatments with data from cache instead of control due to Input Validation');
     });
 
-    client.on(client.Event.SDK_READY, () => {
+    client.on(client.Event.SDK_READY, (metadata) => {
+      t.false(metadata.initialCacheLoad, 'SDK_READY when from cache first should have initialCacheLoad false');
       t.true(Date.now() - startTime >= 400, 'It should emit SDK_READY too but after syncing with the cloud.');
       t.equal(client.getTreatment('always_on'), 'on', 'It should evaluate treatments with updated data after syncing with the cloud.');
     });
@@ -474,7 +476,9 @@ export default function (fetchMock, assert) {
       t.end();
     });
 
-    client.once(client.Event.SDK_READY_FROM_CACHE, () => {
+    client.once(client.Event.SDK_READY_FROM_CACHE, (metadata) => {
+      t.true(metadata.initialCacheLoad, 'SDK_READY_FROM_CACHE on fresh install should have initialCacheLoad true');
+      t.equal(metadata.lastUpdateTimestamp, undefined, 'lastUpdateTimestamp should be undefined when initialCacheLoad is true');
       t.true(nearlyEqual(Date.now() - startTime, CLIENT_READY_MS), 'It should emit SDK_READY_FROM_CACHE alongside SDK_READY');
     });
     client2.once(client2.Event.SDK_READY_FROM_CACHE, () => {
@@ -484,7 +488,8 @@ export default function (fetchMock, assert) {
       t.true(nearlyEqual(Date.now() - startTime, CLIENT3_READY_MS), 'It should emit SDK_READY_FROM_CACHE alongside SDK_READY');
     });
 
-    client.on(client.Event.SDK_READY, () => {
+    client.on(client.Event.SDK_READY, (metadata) => {
+      t.true(metadata.initialCacheLoad, 'SDK_READY on fresh install should have initialCacheLoad true');
       t.true(nearlyEqual(Date.now() - startTime, CLIENT_READY_MS), 'It should emit SDK_READY after syncing with the cloud.');
       t.equal(client.getTreatment('always_on'), 'on', 'It should evaluate treatments with updated data after syncing with the cloud.');
     });

src/__tests__/nodeSuites/push-synchronization.spec.js

@@ -92,7 +92,7 @@ const MILLIS_DESTROY = 1700;
  *  1.6 secs: RB_SEGMENT_UPDATE IFFU event with ZLib compression
  */
 export function testSynchronization(fetchMock, assert) {
-  assert.plan(53);
+  assert.plan(56); // +3 for SDK_UPDATE metadata (type, names array, names includes whitelist)
   fetchMock.reset();
   __setEventSource(EventSourceMock);
 
@@ -114,7 +114,10 @@ export function testSynchronization(fetchMock, assert) {
     }, MILLIS_SSE_OPEN); // open SSE connection after 0.1 seconds
     setTimeout(() => {
       assert.equal(client.getTreatment(key, 'whitelist'), 'not_allowed', 'evaluation of initial Split');
-      client.once(client.Event.SDK_UPDATE, () => {
+      client.once(client.Event.SDK_UPDATE, (metadata) => {
+        assert.equal(metadata.type, 'FLAGS_UPDATE', 'SDK_UPDATE for SPLIT_UPDATE should have type FLAGS_UPDATE');
+        assert.true(Array.isArray(metadata.names), 'metadata.names should be an array');
+        assert.true(metadata.names.includes('whitelist'), 'metadata.names should include the updated whitelist split');
         const lapse = Date.now() - start;
         assert.true(nearlyEqual(lapse, MILLIS_FIRST_SPLIT_UPDATE_EVENT), 'SDK_UPDATE due to SPLIT_UPDATE event');
         assert.equal(client.getTreatment(key, 'whitelist'), 'allowed', 'evaluation of updated Split');

src/__tests__/offline/browser.spec.js

@@ -105,7 +105,9 @@ tape('Browser offline mode', function (assert) {
       assert.equal(client.getTreatment('testing_split_with_config'), 'off');
       readyCount++;
     });
-    client.on(client.Event.SDK_UPDATE, () => {
+    client.on(client.Event.SDK_UPDATE, (metadata) => {
+      assert.equal(metadata.type, 'FLAGS_UPDATE', 'SDK_UPDATE for localhost features update should have type FLAGS_UPDATE');
+      assert.true(Array.isArray(metadata.names), 'metadata.names should be an array');
       assert.deepEqual(manager.names().sort(), ['testing_split', 'testing_split_2', 'testing_split_3', 'testing_split_with_config']);
       assert.equal(client.getTreatment('testing_split_with_config'), 'nope');
       updateCount++;