feat!: Add uuidv4 to platform. (#56)

Author: kinyoklion

packages/sdk/server-node/src/platform/NodeCrypto.ts

@@ -1,14 +1,18 @@
 /* eslint-disable class-methods-use-this */
 import { platform } from '@launchdarkly/js-server-sdk-common';
 
-import * as crypto from 'crypto';
+import { createHash, createHmac, randomUUID } from 'crypto';
 
 export default class NodeCrypto implements platform.Crypto {
   createHash(algorithm: string): platform.Hasher {
-    return crypto.createHash(algorithm);
+    return createHash(algorithm);
   }
 
   createHmac(algorithm: string, key: string): platform.Hmac {
-    return crypto.createHmac(algorithm, key);
+    return createHmac(algorithm, key);
+  }
+
+  randomUUID() {
+    return randomUUID();
   }
 }

packages/shared/common/__tests__/internal/events/EventProcessor.test.ts

@@ -171,6 +171,10 @@ describe('given an event processor', () => {
         // Not used for this test.
         throw new Error('Function not implemented.');
       },
+      randomUUID(): string {
+        // Not used for this test.
+        throw new Error(`Function not implemented.`);
+      },
     },
     requests: {
       /* eslint-disable-next-line @typescript-eslint/no-unused-vars */

packages/shared/common/src/api/platform/Crypto.ts

@@ -28,4 +28,5 @@ export interface Hmac extends Hasher {
 export interface Crypto {
   createHash(algorithm: string): Hasher;
   createHmac(algorithm: string, key: string): Hmac;
+  randomUUID(): string;
 }

packages/shared/sdk-server/__tests__/BigSegmentsManager.test.ts

@@ -42,6 +42,10 @@ const crypto: Crypto = {
     // Not used for this test.
     throw new Error(`Function not implemented.${algorithm}${key}`);
   },
+  randomUUID(): string {
+    // Not used for this test.
+    throw new Error(`Function not implemented.`);
+  },
 };
 
 describe.each(['STALE', 'HEALTHY'])('given a %s store', (status) => {

packages/shared/sdk-server/__tests__/LDClientImpl.bigSegments.test.ts

@@ -45,6 +45,10 @@ const crypto: Crypto = {
     // Not used for this test.
     throw new Error(`Function not implemented.${algorithm}${key}`);
   },
+  randomUUID(): string {
+    // Not used for this test.
+    throw new Error(`Function not implemented.`);
+  },
 };
 
 describe('given test data with big segments', () => {

packages/shared/sdk-server/__tests__/evaluation/Evaluator.segments.test.ts

@@ -257,6 +257,10 @@ describe('when evaluating user equivalent contexts for segments', () => {
         // Not used for this test.
         throw new Error(`Function not implemented.${algorithm}${key}`);
       },
+      randomUUID(): string {
+        // Not used for this test.
+        throw new Error(`Function not implemented.`);
+      },
     };
 
     const bucketingPlatform = { ...basicPlatform, crypto };

packages/shared/sdk-server/__tests__/evaluation/mocks/hasher.ts

@@ -7,6 +7,8 @@ export const hasher: Hasher = {
   digest: jest.fn(() => '1234567890123456'),
 };
 
+let counter = 0;
+
 export const crypto: Crypto = {
   createHash(algorithm: string): Hasher {
     expect(algorithm).toEqual('sha1');
@@ -16,4 +18,10 @@ export const crypto: Crypto = {
     // Not used for this test.
     throw new Error(`Function not implemented.${algorithm}${key}`);
   },
+  randomUUID(): string {
+    counter += 1;
+    // Will provide a unique value for tests.
+    // Very much not a UUID of course.
+    return `${counter}`;
+  },
 };

packages/shared/sdk-server/__tests__/events/EventProcessor.test.ts

@@ -1,5 +1,4 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import { nanoid } from 'nanoid';
 import {
   EventSource,
   EventSourceInitDict,
@@ -13,6 +12,8 @@ import {
   ClientContext,
   Context,
   internal,
+  Hmac,
+  Hasher,
 } from '@launchdarkly/js-sdk-common';
 import DiagnosticsManager from '../../src/events/DiagnosticsManager';
 import Configuration from '../../src/options/Configuration';
@@ -29,11 +30,6 @@ interface RequestState {
   requestsMade: Array<{ url: string; options: Options }>;
 }
 
-// Mock the nanoid module so we can replace the implementation in specific tests.
-jest.mock('nanoid', () => ({
-  nanoid: jest.fn(() => jest.requireActual('nanoid').nanoid()),
-}));
-
 function makePlatform(requestState: RequestState) {
   const info: Info = {
     platformData(): PlatformData {
@@ -114,14 +110,27 @@ function makePlatform(requestState: RequestState) {
       throw new Error('Function not implemented.');
     },
   };
-  return { info, requests, waitForMessages };
+  return {
+    info,
+    requests,
+    waitForMessages,
+    crypto: {
+      createHash(algorithm: string): Hasher {
+        // Not used for this test.
+        throw new Error(`Function not implemented.${algorithm}`);
+      },
+      createHmac(algorithm: string, key: string): Hmac {
+        // Not used for this test.
+        throw new Error(`Function not implemented.${algorithm}${key}`);
+      },
+      randomUUID: () => '9-ypf7NswGfZ3CN2WpTix',
+    },
+  };
 }
 
 const user = { key: 'userKey', name: 'Red' };
 
 describe('given an event processor with diagnostics manager', () => {
-  jest.mock('nanoid', () => ({ nanoid: () => '9-ypf7NswGfZ3CN2WpTix' }));
-
   let eventProcessor: internal.EventProcessor;
 
   const requestState: RequestState = {
@@ -145,12 +154,11 @@ describe('given an event processor with diagnostics manager', () => {
   let waitForMessages: (count: number) => Promise<number>;
 
   beforeEach(() => {
-    // @ts-ignore
-    nanoid.mockImplementation(() => '9-ypf7NswGfZ3CN2WpTix');
-
     const platform = makePlatform(requestState);
+
     info = platform.info;
     requests = platform.requests;
+    const { crypto } = platform;
     waitForMessages = platform.waitForMessages;
 
     resetRequestState();
@@ -171,6 +179,7 @@ describe('given an event processor with diagnostics manager', () => {
         // Replace info and requests.
         info,
         requests,
+        crypto,
       },
       store
     );

packages/shared/sdk-server/package.json

@@ -22,7 +22,6 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@launchdarkly/js-sdk-common": "0.1.0",
-    "nanoid": "^3.0.0",
     "semver": "^7.3.8"
   },
   "devDependencies": {

packages/shared/sdk-server/src/events/DiagnosticsManager.ts

@@ -1,4 +1,3 @@
-import { nanoid } from 'nanoid';
 import { Platform } from '@launchdarkly/js-sdk-common';
 import { LDFeatureStore } from '../api/subsystems';
 import Configuration, { defaultValues } from '../options/Configuration';
@@ -103,7 +102,7 @@ export default class DiagnosticsManager {
     this.startTime = Date.now();
     this.dataSinceDate = this.startTime;
     this.id = {
-      diagnosticId: nanoid(),
+      diagnosticId: platform.crypto.randomUUID(),
       sdkKeySuffix: sdkKey.length > 6 ? sdkKey.substring(sdkKey.length - 6) : sdkKey,
     };
   }