@unito/integration-cli 0.55.1 → 0.55.4

package/README.md

@@ -27,6 +27,6 @@ COMMANDS
 
 ## Terms and Conditions
 
-By using the Integration Debugger, you agree to be bound by our terms and conditions.
+By using the Integration CLI, you agree to be bound by our terms and conditions.
 Please ensure you have read and understood the Unito Software Development Kit Agreement before using the API.
 The full agreement can be found at [Unito SDK Agreement](https://unito.io/sdk-agreement/).

package/dist/integrationGenerator/integrationBoilerplate/src/index.ts

@@ -4,6 +4,7 @@ import { Error as APIError } from '@unito/integration-api';
 import indexRouter from './routes/index';
 import { extractCredentials } from './middlewares/credentials';
 import { extractCorrelationId } from './middlewares/correlationId';
+import { extractAdditionalLoggingContext } from './middlewares/additionalLoggingContext';
 import { logger } from './logger';
 
 // Express Server initialization
@@ -21,7 +22,7 @@ app.use((req: express.Request, res: express.Response, next: express.NextFunction
       const loggerLevel = res.statusCode >= 500 ? 'error' : 'info';
 
       // eslint-disable-next-line
-      logger[loggerLevel](`${req.method} ${req.originalUrl} ${res.statusCode}`, res.locals.correlationId);
+      logger[loggerLevel](`${req.method} ${req.originalUrl} ${res.statusCode}`);
     });
   }
 
@@ -37,6 +38,9 @@ app.use(extractCorrelationId);
 // Load the routes.
 app.use('/', indexRouter);
 
+// Extract the additional logging context.
+app.use(extractAdditionalLoggingContext);
+
 // Must be the (last - 1) handler.
 app.use((err: Error, _req: express.Request, res: express.Response, next: express.NextFunction) => {
   if (res.headersSent) {

package/dist/integrationGenerator/integrationBoilerplate/src/logger.ts

@@ -7,30 +7,48 @@ enum LogLevel {
 }
 
 export class Logger {
-  private send(logLevel: LogLevel, message: string, correlationId: string) {
+  private metadata: { [key: string]: string } = {};
+
+  private send(logLevel: LogLevel, message: string) {
     console[logLevel](
       // Datadog automatically parses JSON-formatted logs
       JSON.stringify({
         message: message,
-        correlation_id: correlationId,
+        ...this.metadata,
       }),
     );
   }
 
-  public log(message: string, correlationId: string) {
-    this.send(LogLevel.LOG, message, correlationId);
+  public log(message: string) {
+    this.send(LogLevel.LOG, message);
+  }
+
+  public error(message: string) {
+    this.send(LogLevel.ERROR, message);
   }
-  public error(message: string, correlationId: string) {
-    this.send(LogLevel.ERROR, message, correlationId);
+
+  public warn(message: string) {
+    this.send(LogLevel.WARN, message);
   }
-  public warn(message: string, correlationId: string) {
-    this.send(LogLevel.WARN, message, correlationId);
+
+  public info(message: string) {
+    this.send(LogLevel.INFO, message);
   }
-  public info(message: string, correlationId: string) {
-    this.send(LogLevel.INFO, message, correlationId);
+
+  public debug(message: string) {
+    this.send(LogLevel.DEBUG, message);
   }
-  public debug(message: string, correlationId: string) {
-    this.send(LogLevel.DEBUG, message, correlationId);
+
+  public decorate(metadata: { [key: string]: string }) {
+    this.metadata = metadata;
+  }
+
+  public setMeta(key: string, value: string) {
+    this.metadata[key] = value;
+  }
+
+  public clearMeta() {
+    this.metadata = {};
   }
 }
 

package/dist/integrationGenerator/integrationBoilerplate/src/middlewares/additionalLoggingContext.ts

@@ -0,0 +1,22 @@
+import express from 'express';
+import { logger } from '../logger';
+
+export const extractAdditionalLoggingContext = (req: express.Request, res: express.Response, next: express.NextFunction) => {
+  const additionalLoggingContextHeader = req.header('X-Unito-Additional-Logging-Context');
+
+  let additionalLoggingContext;
+
+  if (typeof additionalLoggingContextHeader === 'string') {
+    try {
+      additionalLoggingContext = JSON.parse(additionalLoggingContextHeader);
+    } catch (error) {
+      logger.warn(`Failed parsing header X-Unito-Additional-Logging-Context: ${additionalLoggingContext}`);
+    }
+  }
+
+  for (const [key, value] of Object.entries(additionalLoggingContext || {})) {
+    logger.setMeta(key, String(value));
+  }
+
+  next();
+};

package/dist/integrationGenerator/integrationBoilerplate/src/middlewares/correlationId.ts

@@ -1,18 +1,13 @@
 import express from 'express';
 import * as uuid from 'uuid';
+import { logger } from '../logger';
 
 export const extractCorrelationId = (req: express.Request, res: express.Response, next: express.NextFunction) => {
   const correlationIdHeader = req.header('X-Unito-Correlation-Id');
 
-  let correlationId;
+  const correlationId = correlationIdHeader ?? uuid.v4();
 
-  if (correlationIdHeader) {
-    correlationId = correlationIdHeader;
-  } else {
-    correlationId = uuid.v4();
-  }
-
-  res.locals.correlationId = correlationId;
+  logger.setMeta('correlation_id', correlationId);
 
   next();
 };

package/dist/src/commands/upgrade.js

@@ -32,13 +32,9 @@ class Upgrade extends baseCommand_1.BaseCommand {
         //
         // Global command options
         //
-        const packageName = '@unitoio/integration-cli';
+        const packageName = '@unito/integration-cli';
         const execOptions = { env: { ...process.env } };
-        const npmOptions = [
-            '--global',
-            '--registry=https://npm.pkg.github.com/unitoio',
-            '--//npm.pkg.github.com/:_authToken=$UNITO_GITHUB_PKG_TOKEN',
-        ].join(' ');
+        const npmOptions = ['--global'].join(' ');
         //
         // Current version
         //

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.55.1",
+  "version": "0.55.4",
   "commands": {
     "activity": {
       "id": "activity",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unito/integration-cli",
-  "version": "0.55.1",
+  "version": "0.55.4",
   "description": "Integration CLI",
   "bin": {
     "integration-cli": "./bin/run"
@@ -38,7 +38,7 @@
     "@oclif/core": "2.x",
     "@typescript-eslint/eslint-plugin": "6.x",
     "@typescript-eslint/parser": "6.13.x",
-    "@unito/integration-debugger": "0.22.7",
+    "@unito/integration-debugger": "0.22.8",
     "@unito/integrations-platform-client": "0.44.4",
     "ajv": "8.x",
     "ajv-formats": "2.x",

package/dist/schemas/automation.json

@@ -1,81 +0,0 @@
-{
-  "$id": "https://unito.io/integration_cli/automation.schema.json",
-  "title": "Automation",
-  "type": "object",
-  "description": "The configuration of the automation of an integration",
-  "additionalProperties": false,
-  "properties": {
-    "headers": {
-      "type": "object",
-      "description": "The headers to add to the request",
-      "required": ["authorizationHeaderPrefix"],
-      "properties": {
-        "authorizationHeaderPrefix": {
-          "type": "string",
-          "description": "The value of the Authorization header. e.g \"Bearer\""
-        }
-      },
-      "additionalProperties": {
-        "type": "string",
-        "description": "Custom headers values"
-      }
-    },
-    "items": {
-      "type": "object",
-      "description": "The items to generate",
-      "additionalProperties": {
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "collection": {
-            "$ref": "#/$defs/endpoint"
-          },
-          "item": {
-            "$ref": "#/$defs/endpoint"
-          }
-        }
-      }
-    }
-  },
-  "$defs": {
-    "endpoint": {
-      "type": "object",
-      "description": "The endpoint to generate",
-      "additionalProperties": false,
-      "required": ["endpointURI", "idKey"],
-      "properties": {
-        "endpointURI": {
-          "type": "string",
-          "description": "Endpoint of the resource e.g /foo/bar/resource"
-        },
-        "idKey": {
-          "type": "string",
-          "description": "Which field is the unique identifier (id) of your item"
-        },
-        "keyToResponse": {
-          "type": "string",
-          "description": "Key to Access Nested Item (if applicable) like \"data\" that will lead to the item"
-        },
-        "usedId": {
-          "type": "string",
-          "default": ""
-        },
-        "directParent": {
-          "type": "string",
-          "default": ""
-        },
-        "httpMethod": {
-          "type": "string",
-          "description": "The verb of the HTTP request",
-          "default": "GET",
-          "enum": ["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS"],
-          "tsEnumNames": ["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS"]
-        },
-        "body": {
-          "type": "string",
-          "default": ""
-        }
-      }
-    }
-  }
-}