Add basic unit tests.

launchdarkly · Aug 28, 2023 · 71c4325 · 71c4325
1 parent b4709f9
commit 71c4325
Show file tree

Hide file tree

Showing 6 changed files with 120 additions and 51 deletions.
diff --git a/contract-tests/index.js b/contract-tests/index.js
@@ -29,7 +29,7 @@ app.get('/', (req, res) => {
       'big-segments',
       'user-type',
       'migrations',
-      'event-sampling'
+      'event-sampling',
     ],
   });
 });

diff --git a/contract-tests/sdkClientEntity.js b/contract-tests/sdkClientEntity.js
@@ -64,7 +64,7 @@ export function makeSdkConfig(options, tag) {
 }
 
 function getExecution(order) {
-  switch(order) {
+  switch (order) {
     case 'serial': {
       return new LDSerialExecution(LDExecutionOrdering.Fixed);
     }
@@ -164,7 +164,7 @@ export async function newSdkClientEntity(options) {
       case 'migrationOperation':
         const migrationOperation = params.migrationOperation;
         const readExecutionOrder = migrationOperation.readExecutionOrder;
-        
+
         const migration = new Migration(client, {
           execution: getExecution(readExecutionOrder),
           latencyTracking: migrationOperation.trackLatency,

diff --git a/packages/shared/sdk-server/__tests__/MigrationOpEvent.test.ts b/packages/shared/sdk-server/__tests__/MigrationOpEvent.test.ts
@@ -191,6 +191,44 @@ describe('given an LDClient with test data', () => {
         });
       });
 
+      it.each([
+        [LDMigrationStage.Off, { old: true }],
+        [LDMigrationStage.DualWrite, { old: true }],
+        [LDMigrationStage.Shadow, { old: true, new: true }],
+        [LDMigrationStage.RampDown, { new: true }],
+        [LDMigrationStage.Complete, { new: true }],
+      ])('tracks the invoked methods for reads', async (stage, values) => {
+        const flagKey = 'migration';
+        td.update(td.flag(flagKey).valueForAll(stage));
+
+        await migration.read(flagKey, { key: 'test' }, stage);
+        // Feature event.
+        await events.take();
+        // Migration event.
+        const migrationEvent = (await events.take()) as internal.InputMigrationEvent;
+        expect(migrationEvent.measurements[0].key).toEqual('invoked');
+        expect(migrationEvent.measurements[0].values).toEqual(values);
+      });
+
+      it.each([
+        [LDMigrationStage.Off, { old: true }],
+        [LDMigrationStage.DualWrite, { old: true, new: true }],
+        [LDMigrationStage.Shadow, { old: true, new: true }],
+        [LDMigrationStage.RampDown, { old: true, new: true }],
+        [LDMigrationStage.Complete, { new: true }],
+      ])('tracks the invoked methods for writes', async (stage, values) => {
+        const flagKey = 'migration';
+        td.update(td.flag(flagKey).valueForAll(stage));
+
+        await migration.write(flagKey, { key: 'test' }, stage);
+        // Feature event.
+        await events.take();
+        // Migration event.
+        const migrationEvent = (await events.take()) as internal.InputMigrationEvent;
+        expect(migrationEvent.measurements[0].key).toEqual('invoked');
+        expect(migrationEvent.measurements[0].values).toEqual(values);
+      });
+
       it.each([LDMigrationStage.Shadow, LDMigrationStage.Live])(
         'can report read latency for new and old',
         async (stage) => {
@@ -338,14 +376,13 @@ describe('given an LDClient with test data', () => {
           // Migration event.
           const migrationEvent = (await events.take()) as internal.InputMigrationEvent;
           // Only check the measurements component of the event.
-          expect(migrationEvent.measurements).toContainEqual(
-            {
-              key: 'error',
-              values: {
-                old: true,
-              },
-            });
-        }
+          expect(migrationEvent.measurements).toContainEqual({
+            key: 'error',
+            values: {
+              old: true,
+            },
+          });
+        },
       );
 
       it.each([LDMigrationStage.RampDown, LDMigrationStage.Complete])(
@@ -359,13 +396,12 @@ describe('given an LDClient with test data', () => {
           await events.take();
           // Migration event.
           const migrationEvent = (await events.take()) as internal.InputMigrationEvent;
-          expect(migrationEvent.measurements).toContainEqual(
-            {
-              key: 'error',
-              values: {
-                new: true,
-              },
-            });
+          expect(migrationEvent.measurements).toContainEqual({
+            key: 'error',
+            values: {
+              new: true,
+            },
+          });
         },
       );
 
@@ -381,14 +417,13 @@ describe('given an LDClient with test data', () => {
           // Migration event.
           const migrationEvent = (await events.take()) as internal.InputMigrationEvent;
           // Only check the measurements component of the event.
-          expect(migrationEvent.measurements).toContainEqual(
-            {
-              key: 'error',
-              values: {
-                old: true,
-                new: true,
-              },
-            });
+          expect(migrationEvent.measurements).toContainEqual({
+            key: 'error',
+            values: {
+              old: true,
+              new: true,
+            },
+          });
         },
       );
 
@@ -403,13 +438,44 @@ describe('given an LDClient with test data', () => {
           await events.take();
           // Migration event.
           const migrationEvent = (await events.take()) as internal.InputMigrationEvent;
-          expect(migrationEvent.measurements).toContainEqual(
-            {
-              key: 'error',
-              values: {
-                old: true,
-              },
-            });
+          expect(migrationEvent.measurements).toContainEqual({
+            key: 'error',
+            values: {
+              old: true,
+            },
+          });
+        },
+      );
+
+      it.each([LDMigrationStage.Off, LDMigrationStage.DualWrite, LDMigrationStage.Shadow])(
+        'it does not invoke non-authoritative write after an error with authoritative old',
+        async (stage) => {
+          const flagKey = 'migration';
+          td.update(td.flag(flagKey).valueForAll(stage));
+
+          await migration.write(flagKey, { key: 'test' }, stage);
+          // Feature event.
+          await events.take();
+          // Migration event.
+          const migrationEvent = (await events.take()) as internal.InputMigrationEvent;
+          expect(migrationEvent.measurements[0].key).toEqual('invoked');
+          expect(migrationEvent.measurements[0].values).toEqual({ old: true });
+        },
+      );
+
+      it.each([LDMigrationStage.Live, LDMigrationStage.RampDown, LDMigrationStage.Complete])(
+        'it does not invoke non-authoritative write after an error with authoritative new',
+        async (stage) => {
+          const flagKey = 'migration';
+          td.update(td.flag(flagKey).valueForAll(stage));
+
+          await migration.write(flagKey, { key: 'test' }, stage);
+          // Feature event.
+          await events.take();
+          // Migration event.
+          const migrationEvent = (await events.take()) as internal.InputMigrationEvent;
+          expect(migrationEvent.measurements[0].key).toEqual('invoked');
+          expect(migrationEvent.measurements[0].values).toEqual({ new: true });
         },
       );
 
@@ -425,13 +491,12 @@ describe('given an LDClient with test data', () => {
           // Migration event.
           const migrationEvent = (await events.take()) as internal.InputMigrationEvent;
           // Only check the measurements component of the event.
-          expect(migrationEvent.measurements).toContainEqual(
-            {
-              key: 'error',
-              values: {
-                new: true,
-              },
-            });
+          expect(migrationEvent.measurements).toContainEqual({
+            key: 'error',
+            values: {
+              new: true,
+            },
+          });
         },
       );
     });

diff --git a/packages/shared/sdk-server/__tests__/MigrationOpTracker.test.ts b/packages/shared/sdk-server/__tests__/MigrationOpTracker.test.ts
@@ -1,6 +1,6 @@
 import { LDConsistencyCheck, LDMigrationStage } from '../src';
-import MigrationOpTracker from '../src/MigrationOpTracker';
 import { LDMigrationOrigin } from '../src/api/LDMigration';
+import MigrationOpTracker from '../src/MigrationOpTracker';
 
 it('does not generate an event if an op is not set', () => {
   const tracker = new MigrationOpTracker(
@@ -45,12 +45,14 @@ it('generates an event if the minimal requirements are met.', () => {
     contextKeys: { user: 'bob' },
     evaluation: { default: 'off', key: 'flag', reason: { kind: 'FALLTHROUGH' }, value: 'off' },
     kind: 'migration_op',
-    measurements: [{
-      key: 'invoked',
-      values: {
-        old: true,
-      }
-    }],
+    measurements: [
+      {
+        key: 'invoked',
+        values: {
+          old: true,
+        },
+      },
+    ],
     operation: 'write',
   });
 });
@@ -220,4 +222,4 @@ it('includes when both origins were invoked', () => {
     key: 'invoked',
     values: { old: true, new: true },
   });
-});
+});
diff --git a/packages/shared/sdk-server/src/MigrationOpEventConversion.ts b/packages/shared/sdk-server/src/MigrationOpEventConversion.ts
@@ -29,7 +29,9 @@ function isErrorMeasurement(value: LDMigrationMeasurement): value is LDMigration
   return (value as any).kind === undefined && value.key === 'error';
 }
 
-function isInvokedMeasurement(value: LDMigrationMeasurement): value is LDMigrationInvokedMeasurement {
+function isInvokedMeasurement(
+  value: LDMigrationMeasurement,
+): value is LDMigrationInvokedMeasurement {
   return (value as any).kind === undefined && value.key === 'invoked';
 }
 
@@ -119,7 +121,7 @@ function validateMeasurement(
     };
   }
 
-  if(isInvokedMeasurement(measurement)) {
+  if (isInvokedMeasurement(measurement)) {
     if (!TypeValidators.Object.is(measurement.values)) {
       return undefined;
     }

diff --git a/packages/shared/sdk-server/src/api/data/LDMigrationOpEvent.ts b/packages/shared/sdk-server/src/api/data/LDMigrationOpEvent.ts
@@ -43,7 +43,7 @@ export interface LDMigrationInvokedMeasurement {
   values: {
     old?: boolean;
     new?: boolean;
-  }
+  };
 }
 
 /**
-Original file line number
+Diff line change
@@ Expand Up / @@ -43,7 +43,7 @@ export interface LDMigrationInvokedMeasurement { @@
       values: {
         old?: boolean;
         new?: boolean;
-      }
+      };
     }
     /**
@@ Expand Down @@