@unito/integration-sdk 2.3.0 → 2.3.2

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.
@@ -1409,6 +1415,7 @@ class Provider {
             }
         }
         const callToProvider = async () => {
+            const beforeRequestTimestamp = process.hrtime.bigint();
             let response;
             try {
                 response = await fetch(absoluteUrl, {
@@ -1430,6 +1437,20 @@ class Provider {
                 }
                 throw this.handleError(500, 'Unexpected error while calling the provider - this is not normal, investigate', options);
             }
+            const afterRequestTimestamp = process.hrtime.bigint();
+            const requestDurationInNS = Number(afterRequestTimestamp - beforeRequestTimestamp);
+            const requestDurationInMs = (requestDurationInNS / 1_000_000) | 0;
+            options.logger.info(`Connector API Request ${options.method} ${absoluteUrl} ${response.status} - ${requestDurationInMs} ms`, {
+                duration: requestDurationInNS,
+                http: {
+                    method: options.method,
+                    status_code: response.status,
+                    content_type: headers['Content-Type'],
+                    url_details: {
+                        path: absoluteUrl,
+                    },
+                },
+            });
             if (response.status >= 400) {
                 const textResult = await response.text();
                 throw this.handleError(response.status, textResult, options);
@@ -1511,5 +1532,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/middlewares/credentials.d.ts

@@ -6,9 +6,25 @@ declare global {
         }
     }
 }
+/**
+ * The credentials object passed to every handler function.
+ *
+ * It contains the parsed credentials payload associated with the request through the X-Unito-Credentials header.
+ */
 export type Credentials = {
+    /**
+     * The access token for the provider.
+     */
     accessToken?: string;
-    unitoCredentialId: string;
+    /**
+     * The id of the unito credential record.
+     *
+     * This is not available on the initial call to /me before the creation of the credential.
+     */
+    unitoCredentialId?: string;
+    /**
+     * The id of the unito user record.
+     */
     unitoUserId?: string;
     [keys: string]: unknown;
 };

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/src/resources/provider.js

@@ -284,6 +284,7 @@ export class Provider {
             }
         }
         const callToProvider = async () => {
+            const beforeRequestTimestamp = process.hrtime.bigint();
             let response;
             try {
                 response = await fetch(absoluteUrl, {
@@ -305,6 +306,20 @@ export class Provider {
                 }
                 throw this.handleError(500, 'Unexpected error while calling the provider - this is not normal, investigate', options);
             }
+            const afterRequestTimestamp = process.hrtime.bigint();
+            const requestDurationInNS = Number(afterRequestTimestamp - beforeRequestTimestamp);
+            const requestDurationInMs = (requestDurationInNS / 1_000_000) | 0;
+            options.logger.info(`Connector API Request ${options.method} ${absoluteUrl} ${response.status} - ${requestDurationInMs} ms`, {
+                duration: requestDurationInNS,
+                http: {
+                    method: options.method,
+                    status_code: response.status,
+                    content_type: headers['Content-Type'],
+                    url_details: {
+                        path: absoluteUrl,
+                    },
+                },
+            });
             if (response.status >= 400) {
                 const textResult = await response.text();
                 throw this.handleError(response.status, textResult, options);

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/dist/test/resources/provider.test.js

@@ -50,7 +50,7 @@ describe('Provider', () => {
         ]);
         assert.deepEqual(actualResponse, { status: 200, headers: response.headers, body: { data: 'value' } });
     });
-    it('should accept text/html type response', async (context) => {
+    it('accepts text/html type response', async (context) => {
         const response = new Response('', {
             status: 200,
             headers: { 'Content-Type': 'text/html; charset=UTF-8' },
@@ -79,7 +79,7 @@ describe('Provider', () => {
         ]);
         assert.deepEqual(actualResponse, { status: 200, headers: response.headers, body: '' });
     });
-    it('should accept application/schema+json type response', async (context) => {
+    it('accepts application/schema+json type response', async (context) => {
         const response = new Response('{"data": "value"}', {
             status: 200,
             headers: { 'Content-Type': 'application/schema+json; charset=UTF-8' },
@@ -108,7 +108,7 @@ describe('Provider', () => {
         ]);
         assert.deepEqual(actualResponse, { status: 200, headers: response.headers, body: { data: 'value' } });
     });
-    it('should accept application/swagger+json type response', async (context) => {
+    it('accepts application/swagger+json type response', async (context) => {
         const response = new Response('{"data": "value"}', {
             status: 200,
             headers: { 'Content-Type': 'application/swagger+json; charset=UTF-8' },
@@ -137,7 +137,7 @@ describe('Provider', () => {
         ]);
         assert.deepEqual(actualResponse, { status: 200, headers: response.headers, body: { data: 'value' } });
     });
-    it('should accept application/vnd.oracle.resource+json type response', async (context) => {
+    it('accepts application/vnd.oracle.resource+json type response', async (context) => {
         const response = new Response('{"data": "value"}', {
             status: 200,
             headers: { 'Content-Type': 'application/vnd.oracle.resource+json; type=collection; charset=UTF-8' },
@@ -166,7 +166,7 @@ describe('Provider', () => {
         ]);
         assert.deepEqual(actualResponse, { status: 200, headers: response.headers, body: { data: 'value' } });
     });
-    it('should return the raw response body if specified', async (context) => {
+    it('returns the raw response body if specified', async (context) => {
         const response = new Response(`IMAGINE A HUGE PAYLOAD`, {
             status: 200,
             headers: { 'Content-Type': 'image/png' },
@@ -244,7 +244,7 @@ describe('Provider', () => {
         ]);
         assert.deepEqual(actualResponse, { status: 201, headers: response.headers, body: { data: 'value' } });
     });
-    it('accept an array as body for post request', async (context) => {
+    it('accepts an array as body for post request', async (context) => {
         const response = new Response('{"data": "value"}', {
             status: 201,
             headers: { 'Content-Type': 'application/json' },
@@ -485,7 +485,7 @@ describe('Provider', () => {
         assert.ok(error instanceof HttpErrors.HttpError);
         assert.equal(error.message, 'Weird provider behavior');
     });
-    it('should contain the credential in the custom error handler', async (context) => {
+    it('contains the credential in the custom error handler', async (context) => {
         const provider = new Provider({
             prepareRequest: requestOptions => {
                 return {
@@ -761,4 +761,16 @@ describe('Provider', () => {
         assert.ok(error instanceof HttpErrors.RateLimitExceededError);
         assert.equal(error.message, 'response body');
     });
+    it('logs provider requests', async (context) => {
+        const response = new Response(undefined, { status: 201 });
+        context.mock.method(global, 'fetch', () => Promise.resolve(response));
+        const loggerStub = context.mock.method(logger, 'info');
+        await provider.get('/endpoint/123', {
+            credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
+            signal: new AbortController().signal,
+            logger: logger,
+        });
+        assert.equal(loggerStub.mock.callCount(), 1);
+        assert.match(String(loggerStub.mock.calls[0]?.arguments[0]), /Connector API Request GET www.myApi.com\/endpoint\/123 201 - \d+ ms/);
+    });
 });

package/dist/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/errors.ts","../src/handler.ts","../src/helpers.ts","../src/httpErrors.ts","../src/index.ts","../src/integration.ts","../src/middlewares/correlationId.ts","../src/middlewares/credentials.ts","../src/middlewares/errors.ts","../src/middlewares/filters.ts","../src/middlewares/finish.ts","../src/middlewares/health.ts","../src/middlewares/logger.ts","../src/middlewares/notFound.ts","../src/middlewares/relations.ts","../src/middlewares/search.ts","../src/middlewares/secrets.ts","../src/middlewares/selects.ts","../src/middlewares/signal.ts","../src/middlewares/start.ts","../src/resources/cache.ts","../src/resources/context.ts","../src/resources/logger.ts","../src/resources/provider.ts","../test/errors.test.ts","../test/handler.test.ts","../test/helpers.test.ts","../test/integration.test.ts","../test/middlewares/correlationId.test.ts","../test/middlewares/credentials.test.ts","../test/middlewares/errors.test.ts","../test/middlewares/filters.test.ts","../test/middlewares/finish.test.ts","../test/middlewares/health.test.ts","../test/middlewares/logger.test.ts","../test/middlewares/notFound.test.ts","../test/middlewares/relations.test.ts","../test/middlewares/search.test.ts","../test/middlewares/secrets.test.ts","../test/middlewares/selects.test.ts","../test/middlewares/signal.test.ts","../test/middlewares/start.test.ts","../test/resources/cache.test.ts","../test/resources/logger.test.ts","../test/resources/provider.test.ts"],"version":"5.8.3"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unito/integration-sdk",
-  "version": "2.3.0",
+  "version": "2.3.2",
   "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/middlewares/credentials.ts

@@ -10,9 +10,25 @@ declare global {
   }
 }
 
+/**
+ * The credentials object passed to every handler function.
+ *
+ * It contains the parsed credentials payload associated with the request through the X-Unito-Credentials header.
+ */
 export type Credentials = {
+  /**
+   * The access token for the provider.
+   */
   accessToken?: string;
-  unitoCredentialId: string;
+  /**
+   * The id of the unito credential record.
+   *
+   * This is not available on the initial call to /me before the creation of the credential.
+   */
+  unitoCredentialId?: string;
+  /**
+   * The id of the unito user record.
+   */
   unitoUserId?: string;
   [keys: string]: unknown;
 };

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/src/resources/provider.ts

@@ -388,6 +388,8 @@ export class Provider {
     }
 
     const callToProvider = async (): Promise<Response<T>> => {
+      const beforeRequestTimestamp = process.hrtime.bigint();
+
       let response: globalThis.Response;
 
       try {
@@ -420,6 +422,25 @@ export class Provider {
         );
       }
 
+      const afterRequestTimestamp = process.hrtime.bigint();
+      const requestDurationInNS = Number(afterRequestTimestamp - beforeRequestTimestamp);
+      const requestDurationInMs = (requestDurationInNS / 1_000_000) | 0;
+
+      options.logger.info(
+        `Connector API Request ${options.method} ${absoluteUrl} ${response.status} - ${requestDurationInMs} ms`,
+        {
+          duration: requestDurationInNS,
+          http: {
+            method: options.method,
+            status_code: response.status,
+            content_type: headers['Content-Type'],
+            url_details: {
+              path: absoluteUrl,
+            },
+          },
+        },
+      );
+
       if (response.status >= 400) {
         const textResult = await response.text();
         throw this.handleError(response.status, textResult, options);

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);
+  });
 });

package/test/resources/provider.test.ts

@@ -59,7 +59,7 @@ describe('Provider', () => {
     assert.deepEqual(actualResponse, { status: 200, headers: response.headers, body: { data: 'value' } });
   });
 
-  it('should accept text/html type response', async context => {
+  it('accepts text/html type response', async context => {
     const response = new Response('', {
       status: 200,
       headers: { 'Content-Type': 'text/html; charset=UTF-8' },
@@ -94,7 +94,7 @@ describe('Provider', () => {
     assert.deepEqual(actualResponse, { status: 200, headers: response.headers, body: '' });
   });
 
-  it('should accept application/schema+json type response', async context => {
+  it('accepts application/schema+json type response', async context => {
     const response = new Response('{"data": "value"}', {
       status: 200,
       headers: { 'Content-Type': 'application/schema+json; charset=UTF-8' },
@@ -129,7 +129,7 @@ describe('Provider', () => {
     assert.deepEqual(actualResponse, { status: 200, headers: response.headers, body: { data: 'value' } });
   });
 
-  it('should accept application/swagger+json type response', async context => {
+  it('accepts application/swagger+json type response', async context => {
     const response = new Response('{"data": "value"}', {
       status: 200,
       headers: { 'Content-Type': 'application/swagger+json; charset=UTF-8' },
@@ -164,7 +164,7 @@ describe('Provider', () => {
     assert.deepEqual(actualResponse, { status: 200, headers: response.headers, body: { data: 'value' } });
   });
 
-  it('should accept application/vnd.oracle.resource+json type response', async context => {
+  it('accepts application/vnd.oracle.resource+json type response', async context => {
     const response = new Response('{"data": "value"}', {
       status: 200,
       headers: { 'Content-Type': 'application/vnd.oracle.resource+json; type=collection; charset=UTF-8' },
@@ -199,7 +199,7 @@ describe('Provider', () => {
     assert.deepEqual(actualResponse, { status: 200, headers: response.headers, body: { data: 'value' } });
   });
 
-  it('should return the raw response body if specified', async context => {
+  it('returns the raw response body if specified', async context => {
     const response = new Response(`IMAGINE A HUGE PAYLOAD`, {
       status: 200,
       headers: { 'Content-Type': 'image/png' },
@@ -293,7 +293,7 @@ describe('Provider', () => {
     assert.deepEqual(actualResponse, { status: 201, headers: response.headers, body: { data: 'value' } });
   });
 
-  it('accept an array as body for post request', async context => {
+  it('accepts an array as body for post request', async context => {
     const response = new Response('{"data": "value"}', {
       status: 201,
       headers: { 'Content-Type': 'application/json' },
@@ -580,7 +580,7 @@ describe('Provider', () => {
     assert.equal(error.message, 'Weird provider behavior');
   });
 
-  it('should contain the credential in the custom error handler', async context => {
+  it('contains the credential in the custom error handler', async context => {
     const provider = new Provider({
       prepareRequest: requestOptions => {
         return {
@@ -911,4 +911,24 @@ describe('Provider', () => {
     assert.ok(error instanceof HttpErrors.RateLimitExceededError);
     assert.equal(error.message, 'response body');
   });
+
+  it('logs provider requests', async context => {
+    const response = new Response(undefined, { status: 201 });
+
+    context.mock.method(global, 'fetch', () => Promise.resolve(response));
+
+    const loggerStub = context.mock.method(logger, 'info');
+
+    await provider.get('/endpoint/123', {
+      credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
+      signal: new AbortController().signal,
+      logger: logger,
+    });
+
+    assert.equal(loggerStub.mock.callCount(), 1);
+    assert.match(
+      String(loggerStub.mock.calls[0]?.arguments[0]),
+      /Connector API Request GET www.myApi.com\/endpoint\/123 201 - \d+ ms/,
+    );
+  });
 });