Remove global logger.

launchdarkly · Aug 16, 2024 · 135219f · 135219f
1 parent d1194b8
commit 135219f
Show file tree

Hide file tree

Showing 12 changed files with 41 additions and 24 deletions.
diff --git a/packages/shared/common/__tests__/options/ApplicationTags.test.ts b/packages/shared/common/__tests__/options/ApplicationTags.test.ts
@@ -88,11 +88,13 @@ describe.each([
     });
 
     it(`logs issues it encounters for ${JSON.stringify(config)}`, () => {
-      expect(config?.logger?.warn).toHaveBeenCalledTimes(warnings.length);
+      if (config?.logger) {
+        expect(config?.logger?.warn).toHaveBeenCalledTimes(warnings.length);
 
-      warnings.forEach((regExp) => {
-        expect(config?.logger?.warn).toHaveBeenCalledWith(expect.stringMatching(regExp));
-      });
+        warnings.forEach((regExp) => {
+          expect(config?.logger?.warn).toHaveBeenCalledWith(expect.stringMatching(regExp));
+        });
+      }
     });
   });
 });
diff --git a/packages/shared/common/src/internal/stream/StreamingProcessor.test.ts b/packages/shared/common/src/internal/stream/StreamingProcessor.test.ts
@@ -22,7 +22,7 @@ function getBasicConfiguration(inLogger: LDLogger) {
   return {
     sdkKey: 'testSdkKey',
     serviceEndpoints,
-    inLogger,
+    logger: inLogger,
   };
 }
 

diff --git a/packages/shared/mocks/src/index.ts b/packages/shared/mocks/src/index.ts
@@ -1,11 +1,10 @@
 import ContextDeduplicator from './contextDeduplicator';
 import { MockEventProcessor, setupMockEventProcessor } from './eventProcessor';
-import logger, { createLogger } from './logger';
+import { createLogger } from './logger';
 import { createBasicPlatform } from './platform';
 import { MockStreamingProcessor, setupMockStreamingProcessor } from './streamingProcessor';
 
 export {
-  logger,
   createLogger,
   ContextDeduplicator,
   MockEventProcessor,

diff --git a/packages/shared/mocks/src/logger.ts b/packages/shared/mocks/src/logger.ts
@@ -1,12 +1,3 @@
-const logger = {
-  error: jest.fn(),
-  warn: jest.fn(),
-  info: jest.fn(),
-  debug: jest.fn(),
-};
-
-export default logger;
-
 export const createLogger = () => ({
   error: jest.fn(),
   warn: jest.fn(),

diff --git a/packages/shared/sdk-client/src/LDClientImpl.events.test.ts b/packages/shared/sdk-client/src/LDClientImpl.events.test.ts
@@ -8,7 +8,7 @@ import {
 } from '@launchdarkly/js-sdk-common';
 import {
   createBasicPlatform,
-  logger,
+  createLogger,
   MockEventProcessor,
   setupMockStreamingProcessor,
 } from '@launchdarkly/private-js-mocks';
@@ -21,9 +21,11 @@ type InputCustomEvent = internal.InputCustomEvent;
 type InputIdentifyEvent = internal.InputIdentifyEvent;
 
 let mockPlatform: ReturnType<typeof createBasicPlatform>;
+let logger: ReturnType<typeof createLogger>;
 
 beforeEach(() => {
   mockPlatform = createBasicPlatform();
+  logger = createLogger();
 });
 
 jest.mock('@launchdarkly/js-sdk-common', () => {

diff --git a/packages/shared/sdk-client/src/LDClientImpl.storage.test.ts b/packages/shared/sdk-client/src/LDClientImpl.storage.test.ts
@@ -1,7 +1,7 @@
 import { AutoEnvAttributes, clone, type LDContext, noop } from '@launchdarkly/js-sdk-common';
 import {
   createBasicPlatform,
-  logger,
+  createLogger,
   setupMockStreamingProcessor,
 } from '@launchdarkly/private-js-mocks';
 
@@ -12,9 +12,11 @@ import LDClientImpl from './LDClientImpl';
 import { DeleteFlag, Flags, PatchFlag } from './types';
 
 let mockPlatform: ReturnType<typeof createBasicPlatform>;
+let logger: ReturnType<typeof createLogger>;
 
 beforeEach(() => {
   mockPlatform = createBasicPlatform();
+  logger = createLogger();
 });
 
 jest.mock('@launchdarkly/js-sdk-common', () => {

diff --git a/packages/shared/sdk-client/src/LDClientImpl.test.ts b/packages/shared/sdk-client/src/LDClientImpl.test.ts
@@ -1,7 +1,7 @@
 import { AutoEnvAttributes, clone, Hasher, LDContext } from '@launchdarkly/js-sdk-common';
 import {
   createBasicPlatform,
-  logger,
+  createLogger,
   MockStreamingProcessor,
   setupMockStreamingProcessor,
 } from '@launchdarkly/private-js-mocks';
@@ -11,9 +11,11 @@ import LDClientImpl from './LDClientImpl';
 import { Flags } from './types';
 
 let mockPlatform: ReturnType<typeof createBasicPlatform>;
+let logger: ReturnType<typeof createLogger>;
 
 beforeEach(() => {
   mockPlatform = createBasicPlatform();
+  logger = createLogger();
 });
 
 jest.mock('@launchdarkly/js-sdk-common', () => {

diff --git a/packages/shared/sdk-client/src/LDClientImpl.timeout.test.ts b/packages/shared/sdk-client/src/LDClientImpl.timeout.test.ts
@@ -1,7 +1,7 @@
 import { AutoEnvAttributes, clone, LDContext } from '@launchdarkly/js-sdk-common';
 import {
   createBasicPlatform,
-  logger,
+  createLogger,
   setupMockStreamingProcessor,
 } from '@launchdarkly/private-js-mocks';
 
@@ -11,9 +11,11 @@ import LDClientImpl from './LDClientImpl';
 import { Flags } from './types';
 
 let mockPlatform: ReturnType<typeof createBasicPlatform>;
+let logger: ReturnType<typeof createLogger>;
 
 beforeEach(() => {
   mockPlatform = createBasicPlatform();
+  logger = createLogger();
 });
 
 jest.mock('@launchdarkly/js-sdk-common', () => {

diff --git a/packages/shared/sdk-client/src/LDClientImpl.variation.test.ts b/packages/shared/sdk-client/src/LDClientImpl.variation.test.ts
@@ -1,7 +1,7 @@
 import { AutoEnvAttributes, clone, Context, LDContext } from '@launchdarkly/js-sdk-common';
 import {
   createBasicPlatform,
-  logger,
+  createLogger,
   setupMockStreamingProcessor,
 } from '@launchdarkly/private-js-mocks';
 
@@ -10,11 +10,14 @@ import LDClientImpl from './LDClientImpl';
 import { Flags } from './types';
 
 let mockPlatform: ReturnType<typeof createBasicPlatform>;
+let logger: ReturnType<typeof createLogger>;
 
 beforeEach(() => {
   mockPlatform = createBasicPlatform();
+  logger = createLogger();
 });
 
+
 jest.mock('@launchdarkly/js-sdk-common', () => {
   const actual = jest.requireActual('@launchdarkly/js-sdk-common');
   const actualMock = jest.requireActual('@launchdarkly/private-js-mocks');

diff --git a/packages/shared/sdk-client/src/context/addAutoEnv.test.ts b/packages/shared/sdk-client/src/context/addAutoEnv.test.ts
@@ -5,15 +5,17 @@ import {
   LDMultiKindContext,
   LDUser,
 } from '@launchdarkly/js-sdk-common';
-import { createBasicPlatform, logger } from '@launchdarkly/private-js-mocks';
+import { createBasicPlatform, createLogger } from '@launchdarkly/private-js-mocks';
 
 import Configuration from '../configuration';
 import { addApplicationInfo, addAutoEnv, addDeviceInfo, toMulti } from './addAutoEnv';
 
 let mockPlatform: ReturnType<typeof createBasicPlatform>;
+let logger: ReturnType<typeof createLogger>;
 
 beforeEach(() => {
   mockPlatform = createBasicPlatform();
+  logger = createLogger();
 });
 
 describe('automatic environment attributes', () => {

diff --git a/packages/shared/sdk-server-edge/src/api/createCallbacks.test.ts b/packages/shared/sdk-server-edge/src/api/createCallbacks.test.ts
@@ -1,10 +1,16 @@
 import { EventEmitter } from 'node:events';
 
 import { noop } from '@launchdarkly/js-server-sdk-common';
-import { logger } from '@launchdarkly/private-js-mocks';
+import { createLogger } from '@launchdarkly/private-js-mocks';
 
 import createCallbacks from './createCallbacks';
 
+let logger: ReturnType<typeof createLogger>;
+
+beforeEach(() => {
+  logger = createLogger();
+});
+
 describe('createCallbacks', () => {
   let emitter: EventEmitter;
   const err = new Error('test error');

diff --git a/packages/shared/sdk-server/src/data_sources/createStreamListeners.test.ts b/packages/shared/sdk-server/src/data_sources/createStreamListeners.test.ts
@@ -1,4 +1,4 @@
-import { logger } from '@launchdarkly/private-js-mocks';
+import { createLogger } from '@launchdarkly/private-js-mocks';
 
 import { LDDataSourceUpdates } from '../api/subsystems';
 import { deserializeAll, deserializeDelete, deserializePatch } from '../store/serialization';
@@ -7,6 +7,12 @@ import { createStreamListeners } from './createStreamListeners';
 
 jest.mock('../store/serialization');
 
+let logger: ReturnType<typeof createLogger>;
+
+beforeEach(() => {
+  logger = createLogger();
+});
+
 const allData = {
   data: {
     flags: {