@unito/integration-sdk 0.1.10 → 0.1.11

package/dist/src/index.cjs

@@ -118,13 +118,6 @@ class Logger {
     }
 }
 
-/**
- * Array of created caches kept to allow for graceful shutdown on exit signals.
- */
-const caches = [];
-const shutdownCaches = async () => {
-    return Promise.allSettled(caches.map(cache => cache.quit()));
-};
 class Cache {
     cacheInstance;
     constructor(cacheInstance) {
@@ -153,8 +146,6 @@ class Cache {
      */
     static create(redisUrl) {
         const cacheInstance = redisUrl ? new cachette.WriteThroughCache(redisUrl) : new cachette.LocalCache();
-        // Push to the array of caches for graceful shutdown on exit signals.
-        caches.push(cacheInstance);
         // Intended: the correlation id will be the same for all logs of Cachette.
         const correlationId = uuid__namespace.v4();
         const logger = new Logger({ correlation_id: correlationId });
@@ -265,13 +256,13 @@ function buildHttpError(responseStatus, message) {
     return httpError;
 }
 
-const middleware$6 = (req, res, next) => {
+const middleware$7 = (req, res, next) => {
     res.locals.correlationId = req.header('X-Unito-Correlation-Id') ?? uuid__namespace.v4();
     next();
 };
 
 const ADDITIONAL_CONTEXT_HEADER = 'X-Unito-Additional-Logging-Context';
-const middleware$5 = (req, res, next) => {
+const middleware$6 = (req, res, next) => {
     const logger = new Logger({ correlation_id: res.locals.correlationId });
     res.locals.logger = logger;
     const rawAdditionalContext = req.header(ADDITIONAL_CONTEXT_HEADER);
@@ -288,7 +279,7 @@ const middleware$5 = (req, res, next) => {
 };
 
 const CREDENTIALS_HEADER = 'X-Unito-Credentials';
-const middleware$4 = (req, res, next) => {
+const middleware$5 = (req, res, next) => {
     const credentialsHeader = req.header(CREDENTIALS_HEADER);
     if (credentialsHeader) {
         let credentials;
@@ -303,6 +294,22 @@ const middleware$4 = (req, res, next) => {
     next();
 };
 
+const SECRETS_HEADER = 'X-Unito-Secrets';
+const middleware$4 = (req, res, next) => {
+    const secretsHeader = req.header(SECRETS_HEADER);
+    if (secretsHeader) {
+        let secrets;
+        try {
+            secrets = JSON.parse(Buffer.from(secretsHeader, 'base64').toString('utf8'));
+        }
+        catch {
+            throw new BadRequestError(`Malformed HTTP header ${SECRETS_HEADER}`);
+        }
+        res.locals.secrets = secrets;
+    }
+    next();
+};
+
 const middleware$3 = (req, res, next) => {
     const rawSelect = req.query.select;
     if (typeof rawSelect === 'string') {
@@ -686,6 +693,7 @@ class Integration {
         app.use(express.json());
         // Must be one of the first handlers (to catch all the errors).
         app.use(middleware$1);
+        app.use(middleware$7);
         app.use(middleware$6);
         app.use(middleware$5);
         app.use(middleware$4);
@@ -710,22 +718,6 @@ class Integration {
         app.use(middleware);
         // Start the server.
         this.instance = app.listen(this.port, () => console.info(`Server started on port ${this.port}.`));
-        // Trap exit signals.
-        ['SIGTERM', 'SIGINT', 'SIGUSR2'].forEach(signalType => {
-            process.once(signalType, async () => {
-                console.info(`Received termination signal ${signalType}. Exiting.`);
-                try {
-                    if (this.instance) {
-                        this.instance.close();
-                    }
-                    await shutdownCaches();
-                }
-                catch (e) {
-                    console.error('Failed to gracefully exit', e);
-                }
-                process.exit();
-            });
-        });
     }
 }
 

package/dist/src/index.d.ts

@@ -3,6 +3,7 @@ export { Cache } from './resources/cache.js';
 export { default as Integration } from './integration.js';
 export * from './handler.js';
 export { Provider, type Response as ProviderResponse, type RequestOptions as ProviderRequestOptions, type RateLimiter, } from './resources/provider.js';
+export type { Secrets } from './middlewares/secrets.js';
 export type { Credentials } from './middlewares/credentials.js';
 export * as HttpErrors from './httpErrors.js';
 export * from './resources/context.js';

package/dist/src/integration.js

@@ -3,11 +3,11 @@ import { InvalidHandler } from './errors.js';
 import correlationIdMiddleware from './middlewares/correlationId.js';
 import loggerMiddleware from './middlewares/logger.js';
 import credentialsMiddleware from './middlewares/credentials.js';
+import secretsMiddleware from './middlewares/secrets.js';
 import selectsMiddleware from './middlewares/selects.js';
 import errorsMiddleware from './middlewares/errors.js';
 import finishMiddleware from './middlewares/finish.js';
 import notFoundMiddleware from './middlewares/notFound.js';
-import { shutdownCaches } from './resources/cache.js';
 import { Handler } from './handler.js';
 function printErrorMessage(message) {
     console.error();
@@ -65,6 +65,7 @@ export default class Integration {
         app.use(correlationIdMiddleware);
         app.use(loggerMiddleware);
         app.use(credentialsMiddleware);
+        app.use(secretsMiddleware);
         app.use(selectsMiddleware);
         // Load handlers as needed.
         if (this.handlers.length) {
@@ -86,21 +87,5 @@ export default class Integration {
         app.use(notFoundMiddleware);
         // Start the server.
         this.instance = app.listen(this.port, () => console.info(`Server started on port ${this.port}.`));
-        // Trap exit signals.
-        ['SIGTERM', 'SIGINT', 'SIGUSR2'].forEach(signalType => {
-            process.once(signalType, async () => {
-                console.info(`Received termination signal ${signalType}. Exiting.`);
-                try {
-                    if (this.instance) {
-                        this.instance.close();
-                    }
-                    await shutdownCaches();
-                }
-                catch (e) {
-                    console.error('Failed to gracefully exit', e);
-                }
-                process.exit();
-            });
-        });
     }
 }

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

@@ -1,5 +1,4 @@
 import { FetchingFunction, CachableValue } from 'cachette';
-export declare const shutdownCaches: () => Promise<PromiseSettledResult<void>[]>;
 export declare class Cache {
     private cacheInstance;
     private constructor();

package/dist/src/resources/cache.js

@@ -1,13 +1,6 @@
 import { WriteThroughCache, LocalCache } from 'cachette';
 import * as uuid from 'uuid';
 import Logger from './logger.js';
-/**
- * Array of created caches kept to allow for graceful shutdown on exit signals.
- */
-const caches = [];
-export const shutdownCaches = async () => {
-    return Promise.allSettled(caches.map(cache => cache.quit()));
-};
 export class Cache {
     cacheInstance;
     constructor(cacheInstance) {
@@ -36,8 +29,6 @@ export class Cache {
      */
     static create(redisUrl) {
         const cacheInstance = redisUrl ? new WriteThroughCache(redisUrl) : new LocalCache();
-        // Push to the array of caches for graceful shutdown on exit signals.
-        caches.push(cacheInstance);
         // Intended: the correlation id will be the same for all logs of Cachette.
         const correlationId = uuid.v4();
         const logger = new Logger({ correlation_id: correlationId });

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

@@ -9,14 +9,14 @@ import Logger from '../resources/logger.js';
  * NOTE: make sure to return one of the supported HttpErrors from the SDK, otherwise the error will be translated to a
  * generic server (500) error.
  *
- * @param context - The credentials of the caller.
+ * @param options - The credentials and the logger from the RequestOptions passed with the provider call.
  * @param targetFunction - The function to call the provider.
  * @returns The response from the provider.
  * @throws RateLimitExceededError when the rate limit is exceeded.
  * @throws WouldExceedRateLimitError when the next call would exceed the rate limit.
  * @throws HttpError when the provider returns an error.
  */
-export type RateLimiter = <T>(context: {
+export type RateLimiter = <T>(options: {
     credentials: Credentials;
     logger: Logger;
 }, targetFunction: () => Promise<Response<T>>) => Promise<Response<T>>;
@@ -37,7 +37,7 @@ export interface Response<T> {
 }
 export declare class Provider {
     protected rateLimiter: RateLimiter | undefined;
-    protected prepareRequest: (context: {
+    protected prepareRequest: (options: {
         credentials: Credentials;
         logger: Logger;
     }) => {

package/dist/test/resources/cache.test.js

@@ -1,14 +1,14 @@
 import assert from 'node:assert/strict';
 import { describe, it } from 'node:test';
 import { LocalCache } from 'cachette';
-import { Cache, shutdownCaches } from '../../src/resources/cache.js';
+import { Cache } from '../../src/resources/cache.js';
 describe('Cache', () => {
     describe('initializeCache', () => {
         it('no redis url returns Cache with a inner LocalCache', async () => {
             const cache = Cache.create();
             assert.ok(cache instanceof Cache);
             assert.ok(cache['cacheInstance'] instanceof LocalCache);
-            await shutdownCaches();
+            await cache['cacheInstance'].quit();
         });
         it('redis url returns (tries) WriteThroughCache', () => {
             assert.throws(() => Cache.create('fakeredis'), Error, 'Invalid redis url fakereis.');

package/package.json

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

package/src/index.ts

@@ -9,6 +9,7 @@ export {
   type RequestOptions as ProviderRequestOptions,
   type RateLimiter,
 } from './resources/provider.js';
+export type { Secrets } from './middlewares/secrets.js';
 export type { Credentials } from './middlewares/credentials.js';
 export * as HttpErrors from './httpErrors.js';
 export * from './resources/context.js';

package/src/integration.ts

@@ -5,11 +5,11 @@ import { InvalidHandler } from './errors.js';
 import correlationIdMiddleware from './middlewares/correlationId.js';
 import loggerMiddleware from './middlewares/logger.js';
 import credentialsMiddleware from './middlewares/credentials.js';
+import secretsMiddleware from './middlewares/secrets.js';
 import selectsMiddleware from './middlewares/selects.js';
 import errorsMiddleware from './middlewares/errors.js';
 import finishMiddleware from './middlewares/finish.js';
 import notFoundMiddleware from './middlewares/notFound.js';
-import { shutdownCaches } from './resources/cache.js';
 import { HandlersInput, Handler } from './handler.js';
 
 function printErrorMessage(message: string) {
@@ -81,6 +81,7 @@ export default class Integration {
     app.use(correlationIdMiddleware);
     app.use(loggerMiddleware);
     app.use(credentialsMiddleware);
+    app.use(secretsMiddleware);
     app.use(selectsMiddleware);
 
     // Load handlers as needed.
@@ -105,24 +106,5 @@ export default class Integration {
 
     // Start the server.
     this.instance = app.listen(this.port, () => console.info(`Server started on port ${this.port}.`));
-
-    // Trap exit signals.
-    ['SIGTERM', 'SIGINT', 'SIGUSR2'].forEach(signalType => {
-      process.once(signalType, async () => {
-        console.info(`Received termination signal ${signalType}. Exiting.`);
-
-        try {
-          if (this.instance) {
-            this.instance.close();
-          }
-
-          await shutdownCaches();
-        } catch (e) {
-          console.error('Failed to gracefully exit', e);
-        }
-
-        process.exit();
-      });
-    });
   }
 }

package/src/resources/cache.ts

@@ -2,15 +2,6 @@ import { WriteThroughCache, LocalCache, CacheInstance, FetchingFunction, Cachabl
 import * as uuid from 'uuid';
 import Logger from './logger.js';
 
-/**
- * Array of created caches kept to allow for graceful shutdown on exit signals.
- */
-const caches: CacheInstance[] = [];
-
-export const shutdownCaches = async () => {
-  return Promise.allSettled(caches.map(cache => cache.quit()));
-};
-
 export class Cache {
   private cacheInstance: CacheInstance;
 
@@ -53,9 +44,6 @@ export class Cache {
   public static create(redisUrl?: string): Cache {
     const cacheInstance: CacheInstance = redisUrl ? new WriteThroughCache(redisUrl) : new LocalCache();
 
-    // Push to the array of caches for graceful shutdown on exit signals.
-    caches.push(cacheInstance);
-
     // Intended: the correlation id will be the same for all logs of Cachette.
     const correlationId = uuid.v4();
 

package/src/resources/provider.ts

@@ -11,7 +11,7 @@ import Logger from '../resources/logger.js';
  * NOTE: make sure to return one of the supported HttpErrors from the SDK, otherwise the error will be translated to a
  * generic server (500) error.
  *
- * @param context - The credentials of the caller.
+ * @param options - The credentials and the logger from the RequestOptions passed with the provider call.
  * @param targetFunction - The function to call the provider.
  * @returns The response from the provider.
  * @throws RateLimitExceededError when the rate limit is exceeded.
@@ -19,7 +19,7 @@ import Logger from '../resources/logger.js';
  * @throws HttpError when the provider returns an error.
  */
 export type RateLimiter = <T>(
-  context: { credentials: Credentials; logger: Logger },
+  options: { credentials: Credentials; logger: Logger },
   targetFunction: () => Promise<Response<T>>,
 ) => Promise<Response<T>>;
 
@@ -38,7 +38,7 @@ export interface Response<T> {
 
 export class Provider {
   protected rateLimiter: RateLimiter | undefined = undefined;
-  protected prepareRequest: (context: { credentials: Credentials; logger: Logger }) => {
+  protected prepareRequest: (options: { credentials: Credentials; logger: Logger }) => {
     url: string;
     headers: Record<string, string>;
   };

package/test/resources/cache.test.ts

@@ -1,7 +1,7 @@
 import assert from 'node:assert/strict';
 import { describe, it } from 'node:test';
 import { LocalCache } from 'cachette';
-import { Cache, shutdownCaches } from '../../src/resources/cache.js';
+import { Cache } from '../../src/resources/cache.js';
 
 describe('Cache', () => {
   describe('initializeCache', () => {
@@ -11,7 +11,7 @@ describe('Cache', () => {
       assert.ok(cache instanceof Cache);
       assert.ok(cache['cacheInstance'] instanceof LocalCache);
 
-      await shutdownCaches();
+      await cache['cacheInstance'].quit();
     });
 
     it('redis url returns (tries) WriteThroughCache', () => {