@unito/integration-sdk 2.3.0 → 2.3.1

package/dist/src/index.cjs

@@ -67,8 +67,10 @@ const LOGMETA_BLACKLIST = [
  * Logger class that can be configured with metadata add creation and when logging to add additional context to your logs.
  */
 class Logger {
+    isDisabled;
     metadata;
-    constructor(metadata = {}) {
+    constructor(metadata = {}, isDisabled = false) {
+        this.isDisabled = isDisabled;
         this.metadata = structuredClone(metadata);
     }
     /**
@@ -142,6 +144,9 @@ class Logger {
         this.metadata = {};
     }
     send(logLevel, message, metadata) {
+        if (this.isDisabled) {
+            return;
+        }
         // We need to provide the date to Datadog. Otherwise, the date is set to when they receive the log.
         const date = Date.now();
         if (message.length > MAX_LOG_MESSAGE_SIZE) {
@@ -188,6 +193,7 @@ class Logger {
         return prunedMetadata;
     }
 }
+const NULL_LOGGER = new Logger({}, true);
 
 /**
  * The Cache class provides caching capabilities that can be used across your integration.
@@ -1511,5 +1517,6 @@ exports.Cache = Cache;
 exports.Handler = Handler;
 exports.HttpErrors = httpErrors;
 exports.Integration = Integration;
+exports.NULL_LOGGER = NULL_LOGGER;
 exports.Provider = Provider;
 exports.getApplicableFilters = getApplicableFilters;

package/dist/src/index.d.ts

@@ -9,4 +9,4 @@ export type { Filter } from './middlewares/filters.js';
 export * as HttpErrors from './httpErrors.js';
 export { getApplicableFilters } from './helpers.js';
 export * from './resources/context.js';
-export { type default as Logger } from './resources/logger.js';
+export { type default as Logger, NULL_LOGGER } from './resources/logger.js';

package/dist/src/index.js

@@ -7,4 +7,5 @@ export { Provider, } from './resources/provider.js';
 export * as HttpErrors from './httpErrors.js';
 export { getApplicableFilters } from './helpers.js';
 export * from './resources/context.js';
+export { NULL_LOGGER } from './resources/logger.js';
 /* c8 ignore stop */

package/dist/src/resources/logger.d.ts

@@ -10,8 +10,9 @@ type ForbidenMetadataKey = 'message';
  * Logger class that can be configured with metadata add creation and when logging to add additional context to your logs.
  */
 export default class Logger {
+    private isDisabled;
     private metadata;
-    constructor(metadata?: Metadata);
+    constructor(metadata?: Metadata, isDisabled?: boolean);
     /**
      * Logs a message with the 'log' log level.
      * @param message The message to be logged.
@@ -68,4 +69,5 @@ export default class Logger {
     private static snakifyKeys;
     private static pruneSensitiveMetadata;
 }
+export declare const NULL_LOGGER: Logger;
 export {};

package/dist/src/resources/logger.js

@@ -39,8 +39,10 @@ const LOGMETA_BLACKLIST = [
  * Logger class that can be configured with metadata add creation and when logging to add additional context to your logs.
  */
 export default class Logger {
+    isDisabled;
     metadata;
-    constructor(metadata = {}) {
+    constructor(metadata = {}, isDisabled = false) {
+        this.isDisabled = isDisabled;
         this.metadata = structuredClone(metadata);
     }
     /**
@@ -114,6 +116,9 @@ export default class Logger {
         this.metadata = {};
     }
     send(logLevel, message, metadata) {
+        if (this.isDisabled) {
+            return;
+        }
         // We need to provide the date to Datadog. Otherwise, the date is set to when they receive the log.
         const date = Date.now();
         if (message.length > MAX_LOG_MESSAGE_SIZE) {
@@ -160,3 +165,4 @@ export default class Logger {
         return prunedMetadata;
     }
 }
+export const NULL_LOGGER = new Logger({}, true);

package/dist/test/resources/logger.test.js

@@ -1,6 +1,6 @@
 import assert from 'node:assert/strict';
 import { describe, it } from 'node:test';
-import { default as Logger } from '../../src/resources/logger.js';
+import { default as Logger, NULL_LOGGER } from '../../src/resources/logger.js';
 describe('Logger', () => {
     it('metadata', () => {
         let metadata = { correlation_id: 'test' };
@@ -140,4 +140,22 @@ describe('Logger', () => {
         assert.deepEqual(actual['http'], { method: 'GET', status_code: 200, jwt: '[REDACTED]' });
         assert.deepEqual(actual['user']['contact'], { email: '[REDACTED]', first_name: '[REDACTED]' });
     });
+    it(`NULL_LOGGER should not log`, testContext => {
+        const logger = NULL_LOGGER;
+        const logSpy = testContext.mock.method(global.console, 'log', () => { });
+        const errorSpy = testContext.mock.method(global.console, 'error', () => { });
+        const warnSpy = testContext.mock.method(global.console, 'warn', () => { });
+        const infoSpy = testContext.mock.method(global.console, 'info', () => { });
+        const debugSpy = testContext.mock.method(global.console, 'debug', () => { });
+        logger.log('test');
+        logger.info('test');
+        logger.warn('test');
+        logger.error('test');
+        logger.debug('test');
+        assert.strictEqual(logSpy.mock.calls.length, 0);
+        assert.strictEqual(errorSpy.mock.calls.length, 0);
+        assert.strictEqual(warnSpy.mock.calls.length, 0);
+        assert.strictEqual(infoSpy.mock.calls.length, 0);
+        assert.strictEqual(debugSpy.mock.calls.length, 0);
+    });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unito/integration-sdk",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "description": "Integration SDK",
   "type": "module",
   "types": "dist/src/index.d.ts",

package/src/index.ts

@@ -15,5 +15,5 @@ export type { Filter } from './middlewares/filters.js';
 export * as HttpErrors from './httpErrors.js';
 export { getApplicableFilters } from './helpers.js';
 export * from './resources/context.js';
-export { type default as Logger } from './resources/logger.js';
+export { type default as Logger, NULL_LOGGER } from './resources/logger.js';
 /* c8 ignore stop */

package/src/resources/logger.ts

@@ -50,8 +50,10 @@ const LOGMETA_BLACKLIST = [
  */
 export default class Logger {
   private metadata: Metadata;
-
-  constructor(metadata: Metadata = {}) {
+  constructor(
+    metadata: Metadata = {},
+    private isDisabled: boolean = false,
+  ) {
     this.metadata = structuredClone(metadata);
   }
 
@@ -138,6 +140,10 @@ export default class Logger {
   }
 
   private send(logLevel: LogLevel, message: string, metadata?: Metadata): void {
+    if (this.isDisabled) {
+      return;
+    }
+
     // We need to provide the date to Datadog. Otherwise, the date is set to when they receive the log.
     const date = Date.now();
 
@@ -191,3 +197,5 @@ export default class Logger {
     return prunedMetadata;
   }
 }
+
+export const NULL_LOGGER = new Logger({}, true);

package/test/resources/logger.test.ts

@@ -1,6 +1,6 @@
 import assert from 'node:assert/strict';
 import { describe, it } from 'node:test';
-import { default as Logger, Metadata } from '../../src/resources/logger.js';
+import { default as Logger, Metadata, NULL_LOGGER } from '../../src/resources/logger.js';
 
 describe('Logger', () => {
   it('metadata', () => {
@@ -168,4 +168,26 @@ describe('Logger', () => {
     assert.deepEqual(actual['http'], { method: 'GET', status_code: 200, jwt: '[REDACTED]' });
     assert.deepEqual(actual['user']['contact'], { email: '[REDACTED]', first_name: '[REDACTED]' });
   });
+
+  it(`NULL_LOGGER should not log`, testContext => {
+    const logger = NULL_LOGGER;
+
+    const logSpy = testContext.mock.method(global.console, 'log', () => {});
+    const errorSpy = testContext.mock.method(global.console, 'error', () => {});
+    const warnSpy = testContext.mock.method(global.console, 'warn', () => {});
+    const infoSpy = testContext.mock.method(global.console, 'info', () => {});
+    const debugSpy = testContext.mock.method(global.console, 'debug', () => {});
+
+    logger.log('test');
+    logger.info('test');
+    logger.warn('test');
+    logger.error('test');
+    logger.debug('test');
+
+    assert.strictEqual(logSpy.mock.calls.length, 0);
+    assert.strictEqual(errorSpy.mock.calls.length, 0);
+    assert.strictEqual(warnSpy.mock.calls.length, 0);
+    assert.strictEqual(infoSpy.mock.calls.length, 0);
+    assert.strictEqual(debugSpy.mock.calls.length, 0);
+  });
 });