chore: Remove shared mocks package. (#601)

The dependencies between the mocks, and the unpublished nature of the package, made maintenance complex. Additionally the mocks themselves cause the tests to be harder to maintain and understand. This PR changes all test dependencies to be in their own project. If we need shared test code, then we could make shared code and not a package. The main motivator for removal is the circular dependency relationship between the mocks and common. Updating common to support ESM is made more difficult, but needs to be done. Overall this makes things much simpler at the cost of a couple hundred lines of total duplication. (As indicated by the PR additions versus subtractions.) There was code that was shared that was actually only used in singular test locations. Fixes SDK-729.
launchdarkly · Oct 1, 2024 · 9ad25bd · 9ad25bd
1 parent 6f26204
commit 9ad25bd
Show file tree

Hide file tree

Showing 78 changed files with 710 additions and 553 deletions.
diff --git a/.github/workflows/mocks.yml b/.github/workflows/mocks.yml
diff --git a/.github/workflows/react-native-detox.yml b/.github/workflows/react-native-detox.yml
@@ -16,7 +16,6 @@ on:
       - 'packages/shared/common/**'
       - 'packages/shared/sdk-client/**'
       - 'packages/sdk/react-native/**'
-      - 'packages/shared/mocks/**'
 
 jobs:
   detox-android:

diff --git a/package.json b/package.json
@@ -2,7 +2,6 @@
   "name": "@launchdarkly/js-core",
   "workspaces": [
     "packages/shared/common",
-    "packages/shared/mocks",
     "packages/shared/sdk-client",
     "packages/shared/sdk-server",
     "packages/shared/sdk-server-edge",

diff --git a/packages/sdk/browser/package.json b/packages/sdk/browser/package.json
@@ -40,7 +40,6 @@
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",
-    "@launchdarkly/private-js-mocks": "0.0.1",
     "@rollup/plugin-commonjs": "^25.0.0",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.0.2",

diff --git a/packages/sdk/cloudflare/jsr.json b/packages/sdk/cloudflare/jsr.json
@@ -3,15 +3,7 @@
   "version": "2.5.14",
   "exports": "./src/index.ts",
   "publish": {
-    "include": [
-      "LICENSE",
-      "README.md",
-      "package.json",
-      "jsr.json",
-      "src/**/*.ts"
-    ],
-    "exclude": [
-      "src/**/*.test.ts"
-    ]
+    "include": ["LICENSE", "README.md", "package.json", "jsr.json", "src/**/*.ts"],
+    "exclude": ["src/**/*.test.ts"]
   }
 }
diff --git a/packages/sdk/react-native/__tests__/fromExternal/react-native-sse/EventSource.test.ts b/packages/sdk/react-native/__tests__/fromExternal/react-native-sse/EventSource.test.ts
@@ -1,15 +1,19 @@
-import { type EventName } from '@launchdarkly/js-client-sdk-common';
-import { createLogger } from '@launchdarkly/private-js-mocks';
+import { type EventName, LDLogger } from '@launchdarkly/js-client-sdk-common';
 
 import EventSource, {
   backoff,
   jitter,
 } from '../../../src/fromExternal/react-native-sse/EventSource';
 
-let logger: ReturnType<typeof createLogger>;
+let logger: LDLogger;
 
 beforeEach(() => {
-  logger = createLogger();
+  logger = {
+    error: jest.fn(),
+    warn: jest.fn(),
+    info: jest.fn(),
+    debug: jest.fn(),
+  };
 });
 
 describe('EventSource', () => {

diff --git a/packages/sdk/react-native/package.json b/packages/sdk/react-native/package.json
@@ -46,7 +46,6 @@
     "base64-js": "^1.5.1"
   },
   "devDependencies": {
-    "@launchdarkly/private-js-mocks": "0.0.1",
     "@testing-library/react": "^14.1.2",
     "@trivago/prettier-plugin-sort-imports": "^4.1.1",
     "@types/jest": "^29.5.11",

diff --git a/packages/sdk/server-node/__tests__/LDClientNode.listeners.test.ts b/packages/sdk/server-node/__tests__/LDClientNode.listeners.test.ts
@@ -1,15 +1,18 @@
-import { integrations } from '@launchdarkly/js-server-sdk-common';
-import { createLogger } from '@launchdarkly/private-js-mocks';
+import { integrations, LDLogger } from '@launchdarkly/js-server-sdk-common';
 
 import { Context, LDClient } from '../src';
 import LDClientNode from '../src/LDClientNode';
 
-let logger: ReturnType<typeof createLogger>;
+let logger: LDLogger;
 
 beforeEach(() => {
-  logger = createLogger();
+  logger = {
+    error: jest.fn(),
+    warn: jest.fn(),
+    info: jest.fn(),
+    debug: jest.fn(),
+  };
 });
-
 describe('given an LDClient with test data', () => {
   let client: LDClient;
   let td: integrations.TestData;

diff --git a/packages/sdk/server-node/__tests__/LDClientNode.test.ts b/packages/sdk/server-node/__tests__/LDClientNode.test.ts
@@ -1,12 +1,16 @@
-import { LDContext } from '@launchdarkly/js-server-sdk-common';
-import { createLogger } from '@launchdarkly/private-js-mocks';
+import { LDContext, LDLogger } from '@launchdarkly/js-server-sdk-common';
 
 import { init } from '../src';
 
-let logger: ReturnType<typeof createLogger>;
+let logger: LDLogger;
 
 beforeEach(() => {
-  logger = createLogger();
+  logger = {
+    error: jest.fn(),
+    warn: jest.fn(),
+    info: jest.fn(),
+    debug: jest.fn(),
+  };
 });
 
 it('fires ready event in offline mode', (done) => {

diff --git a/packages/sdk/server-node/__tests__/LDClientNode.tls.test.ts b/packages/sdk/server-node/__tests__/LDClientNode.tls.test.ts
@@ -6,15 +6,18 @@ import {
   TestHttpServer,
 } from 'launchdarkly-js-test-helpers';
 
-import { createLogger } from '@launchdarkly/private-js-mocks';
-
-import { LDClient } from '../src';
+import { LDClient, LDLogger } from '../src';
 import LDClientNode from '../src/LDClientNode';
 
-let logger: ReturnType<typeof createLogger>;
+let logger: LDLogger;
 
 beforeEach(() => {
-  logger = createLogger();
+  logger = {
+    error: jest.fn(),
+    warn: jest.fn(),
+    info: jest.fn(),
+    debug: jest.fn(),
+  };
 });
 
 describe('When using a TLS connection', () => {

diff --git a/packages/sdk/server-node/package.json b/packages/sdk/server-node/package.json
@@ -50,7 +50,6 @@
     "launchdarkly-eventsource": "2.0.3"
   },
   "devDependencies": {
-    "@launchdarkly/private-js-mocks": "0.0.1",
     "@trivago/prettier-plugin-sort-imports": "^4.1.1",
     "@types/jest": "^29.4.0",
     "@typescript-eslint/eslint-plugin": "^6.20.0",

diff --git a/...s/shared/mocks/src/contextDeduplicator.ts → ...d/common/__tests__/contextDeduplicator.ts b/...s/shared/mocks/src/contextDeduplicator.ts → ...d/common/__tests__/contextDeduplicator.ts
@@ -1,4 +1,5 @@
-import type { Context, subsystem } from '@common';
+import { subsystem } from '../src/api';
+import Context from '../src/Context';
 
 export default class ContextDeduplicator implements subsystem.LDContextDeduplicator {
   flushInterval?: number | undefined = 0.1;

diff --git a/packages/shared/mocks/src/platform.ts → ...d/common/__tests__/createBasicPlatform.ts b/packages/shared/mocks/src/platform.ts → ...d/common/__tests__/createBasicPlatform.ts
@@ -1,6 +1,5 @@
-import type { PlatformData, SdkData } from '@common';
-
-import { setupCrypto } from './crypto';
+import { PlatformData, SdkData } from '../src/api';
+import { setupCrypto } from './setupCrypto';
 
 const setupInfo = () => ({
   platformData: jest.fn(

diff --git a/...al/diagnostics/DiagnosticsManager.test.ts → ...al/diagnostics/DiagnosticsManager.test.ts b/...al/diagnostics/DiagnosticsManager.test.ts → ...al/diagnostics/DiagnosticsManager.test.ts
@@ -1,6 +1,5 @@
-import { createBasicPlatform } from '@launchdarkly/private-js-mocks';
-
-import DiagnosticsManager from './DiagnosticsManager';
+import DiagnosticsManager from '../../../src/internal/diagnostics/DiagnosticsManager';
+import { createBasicPlatform } from '../../createBasicPlatform';
 
 describe('given a diagnostics manager', () => {
   const dateNowString = '2023-08-10';

diff --git a/packages/shared/common/__tests__/internal/events/EventProcessor.test.ts b/packages/shared/common/__tests__/internal/events/EventProcessor.test.ts
@@ -1,10 +1,5 @@
-import {
-  ContextDeduplicator,
-  createBasicPlatform,
-  createLogger,
-} from '@launchdarkly/private-js-mocks';
-
 import { LDContextCommon, LDMultiKindContext } from '../../../src/api/context';
+import { LDLogger } from '../../../src/api/logging/LDLogger';
 import { LDContextDeduplicator, LDDeliveryStatus, LDEventType } from '../../../src/api/subsystem';
 import Context from '../../../src/Context';
 import { EventProcessor, InputIdentifyEvent } from '../../../src/internal';
@@ -13,13 +8,20 @@ import shouldSample from '../../../src/internal/events/sampling';
 import BasicLogger from '../../../src/logging/BasicLogger';
 import format from '../../../src/logging/format';
 import ClientContext from '../../../src/options/ClientContext';
+import ContextDeduplicator from '../../contextDeduplicator';
+import { createBasicPlatform } from '../../createBasicPlatform';
 
 let mockPlatform: ReturnType<typeof createBasicPlatform>;
 let clientContext: ClientContext;
-let logger: ReturnType<typeof createLogger>;
+let logger: LDLogger;
 
 beforeEach(() => {
-  logger = createLogger();
+  logger = {
+    error: jest.fn(),
+    warn: jest.fn(),
+    info: jest.fn(),
+    debug: jest.fn(),
+  };
   mockPlatform = createBasicPlatform();
   clientContext = {
     basicConfiguration: {

diff --git a/...n/src/internal/events/EventSender.test.ts → ...sts__/internal/events/EventSender.test.ts b/...n/src/internal/events/EventSender.test.ts → ...sts__/internal/events/EventSender.test.ts
@@ -1,21 +1,20 @@
-import { createBasicPlatform } from '@launchdarkly/private-js-mocks';
-
-import { Info, PlatformData, SdkData } from '../../api';
-import { LDDeliveryStatus, LDEventSenderResult, LDEventType } from '../../api/subsystem';
-import { ApplicationTags, ClientContext } from '../../options';
-import EventSender from './EventSender';
+import { Info, PlatformData, SdkData } from '../../../src/api';
+import { LDDeliveryStatus, LDEventSenderResult, LDEventType } from '../../../src/api/subsystem';
+import EventSender from '../../../src/internal/events/EventSender';
+import { ApplicationTags, ClientContext } from '../../../src/options';
+import { createBasicPlatform } from '../../createBasicPlatform';
 
 let mockPlatform: ReturnType<typeof createBasicPlatform>;
 
+function runWithTimers<T>(fn: () => Promise<T>) {
+  const promise = fn();
+  return jest.runAllTimersAsync().then(() => promise);
+}
+
 beforeEach(() => {
   mockPlatform = createBasicPlatform();
 });
 
-jest.mock('../../utils', () => {
-  const actual = jest.requireActual('../../utils');
-  return { ...actual, sleep: jest.fn() };
-});
-
 const basicConfig = {
   tags: new ApplicationTags({ application: { id: 'testApplication1', version: '1.0.0' } }),
   serviceEndpoints: {
@@ -120,9 +119,8 @@ describe('given an event sender', () => {
       },
     );
 
-    eventSenderResult = await eventSender.sendEventData(
-      LDEventType.AnalyticsEvents,
-      testEventData1,
+    eventSenderResult = await runWithTimers(() =>
+      eventSender.sendEventData(LDEventType.AnalyticsEvents, testEventData1),
     );
   });
 
@@ -142,9 +140,8 @@ describe('given an event sender', () => {
 
   it('includes the payload', async () => {
     const { status: status1 } = eventSenderResult;
-    const { status: status2 } = await eventSender.sendEventData(
-      LDEventType.DiagnosticEvent,
-      testEventData2,
+    const { status: status2 } = await runWithTimers(() =>
+      eventSender.sendEventData(LDEventType.DiagnosticEvent, testEventData2),
     );
 
     expect(status1).toEqual(LDDeliveryStatus.Succeeded);
@@ -168,7 +165,9 @@ describe('given an event sender', () => {
 
   it('sends a unique payload for analytics events', async () => {
     // send the same request again to assert unique uuids
-    await eventSender.sendEventData(LDEventType.AnalyticsEvents, testEventData1);
+    await runWithTimers(() =>
+      eventSender.sendEventData(LDEventType.AnalyticsEvents, testEventData1),
+    );
 
     expect(mockFetch).toHaveBeenCalledTimes(2);
     expect(mockFetch).toHaveBeenNthCalledWith(
@@ -190,9 +189,8 @@ describe('given an event sender', () => {
   describe.each([400, 408, 429, 503])('given recoverable errors', (responseStatusCode) => {
     beforeEach(async () => {
       setupMockFetch(responseStatusCode);
-      eventSenderResult = await eventSender.sendEventData(
-        LDEventType.AnalyticsEvents,
-        testEventData1,
+      eventSenderResult = await runWithTimers(() =>
+        eventSender.sendEventData(LDEventType.AnalyticsEvents, testEventData1),
       );
     });
 
@@ -210,9 +208,8 @@ describe('given an event sender', () => {
 
   it('given a result for too large of a payload', async () => {
     setupMockFetch(413);
-    eventSenderResult = await eventSender.sendEventData(
-      LDEventType.AnalyticsEvents,
-      testEventData1,
+    eventSenderResult = await runWithTimers(() =>
+      eventSender.sendEventData(LDEventType.AnalyticsEvents, testEventData1),
     );
 
     const errorMessage = `Received error 413 for event posting - giving up permanently`;
@@ -228,9 +225,8 @@ describe('given an event sender', () => {
   describe.each([401, 403])('given unrecoverable errors', (responseStatusCode) => {
     beforeEach(async () => {
       setupMockFetch(responseStatusCode);
-      eventSenderResult = await eventSender.sendEventData(
-        LDEventType.AnalyticsEvents,
-        testEventData1,
+      eventSenderResult = await runWithTimers(() =>
+        eventSender.sendEventData(LDEventType.AnalyticsEvents, testEventData1),
       );
     });
 

diff --git a/...nternal/stream/StreamingProcessor.test.ts → ...nternal/stream/StreamingProcessor.test.ts b/...nternal/stream/StreamingProcessor.test.ts → ...nternal/stream/StreamingProcessor.test.ts
@@ -1,14 +1,13 @@
-import { createBasicPlatform, createLogger } from '@launchdarkly/private-js-mocks';
+import { EventName, Info, LDLogger, ProcessStreamResponse } from '../../../src/api';
+import { LDStreamProcessor } from '../../../src/api/subsystem';
+import { DataSourceErrorKind } from '../../../src/datasource/DataSourceErrorKinds';
+import { LDStreamingError } from '../../../src/datasource/errors';
+import { DiagnosticsManager } from '../../../src/internal/diagnostics';
+import StreamingProcessor from '../../../src/internal/stream/StreamingProcessor';
+import { defaultHeaders } from '../../../src/utils';
+import { createBasicPlatform } from '../../createBasicPlatform';
 
-import { EventName, Info, LDLogger, ProcessStreamResponse } from '../../api';
-import { LDStreamProcessor } from '../../api/subsystem';
-import { DataSourceErrorKind } from '../../datasource/DataSourceErrorKinds';
-import { LDStreamingError } from '../../datasource/errors';
-import { defaultHeaders } from '../../utils';
-import { DiagnosticsManager } from '../diagnostics';
-import StreamingProcessor from './StreamingProcessor';
-
-let logger: ReturnType<typeof createLogger>;
+let logger: LDLogger;
 
 const serviceEndpoints = {
   events: '',
@@ -44,7 +43,12 @@ let basicPlatform: any;
 
 beforeEach(() => {
   basicPlatform = createBasicPlatform();
-  logger = createLogger();
+  logger = {
+    error: jest.fn(),
+    warn: jest.fn(),
+    info: jest.fn(),
+    debug: jest.fn(),
+  };
 });
 
 const createMockEventSource = (streamUri: string = '', options: any = {}) => ({