@outputai/core 0.8.2-next.7929835.0 → 0.8.2-next.89b6f8c.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@outputai/core",
-  "version": "0.8.2-next.7929835.0",
+  "version": "0.8.2-next.89b6f8c.0",
   "description": "The core module of the output framework",
   "type": "module",
   "exports": {

package/src/interface/index.d.ts

@@ -7,4 +7,4 @@ export * from './step.js';
 export * from './evaluator.js';
 export * from './workflow.js';
 export * from './evaluation_result.js';
-export * as Logger from './logger.js';
+export * from './logger.js';

package/src/interface/index.js

@@ -10,7 +10,7 @@ import { step } from './step.js';
 import { workflow } from './workflow.js';
 import { executeInParallel } from './workflow_utils.js';
 import { sendHttpRequest, sendPostRequestAndAwaitWebhook } from './webhook.js';
-import * as Logger from './logger.js';
+import { Logger } from './logger.js';
 
 export {
   evaluator,

package/src/interface/logger.d.ts

@@ -1,53 +1,61 @@
-/**
- * Additional structured fields attached to a log record.
- */
-export type LogMetadata = Record<string, unknown>;
+type Logger = {
+  /**
+   * Log an error (level 0)
+   * @param message Log message
+   * @param metadata Additional information to be displayed
+   */
+  error( message: string, metadata?: Record<string, unknown> ) : void,
 
-/**
- * Log an error (level 0)
- * @param message Log message
- * @param metadata Additional information to be displayed
- */
-export declare function error( message: string, metadata?: LogMetadata ) : void;
+  /**
+   * Log a warn (level 1)
+   * @param message Log message
+   * @param metadata Additional information to be displayed
+   */
+  warn( message: string, metadata?: Record<string, unknown> ) : void,
 
-/**
- * Log a warn (level 1)
- * @param message Log message
- * @param metadata Additional information to be displayed
- */
-export declare function warn( message: string, metadata?: LogMetadata ) : void;
+  /**
+   * Log an info (level 2)
+   * @param message Log message
+   * @param metadata Additional information to be displayed
+   */
+  info( message: string, metadata?: Record<string, unknown> ) : void,
 
-/**
- * Log an info (level 2)
- * @param message Log message
- * @param metadata Additional information to be displayed
- */
-export declare function info( message: string, metadata?: LogMetadata ) : void;
+  /**
+   * Log http (level 3)
+   * @param message Log message
+   * @param metadata Additional information to be displayed
+   */
+  http( message: string, metadata?: Record<string, unknown> ) : void,
 
-/**
- * Log http (level 3)
- * @param message Log message
- * @param metadata Additional information to be displayed
- */
-export declare function http( message: string, metadata?: LogMetadata ) : void;
+  /**
+   * Log verbose (level 4)
+   * @param message Log message
+   * @param metadata Additional information to be displayed
+   */
+  verbose( message: string, metadata?: Record<string, unknown> ) : void,
 
-/**
- * Log verbose (level 4)
- * @param message Log message
- * @param metadata Additional information to be displayed
- */
-export declare function verbose( message: string, metadata?: LogMetadata ) : void;
+  /**
+   * Log debug (level 5)
+   * @param message Log message
+   * @param metadata Additional information to be displayed
+   */
+  debug( message: string, metadata?: Record<string, unknown> ) : void,
 
-/**
- * Log debug (level 5)
- * @param message Log message
- * @param metadata Additional information to be displayed
- */
-export declare function debug( message: string, metadata?: LogMetadata ) : void;
+  /**
+   * Log silly (level 6)
+   * @param message Log message
+   * @param metadata Additional information to be displayed
+   */
+  silly( message: string, metadata?: Record<string, unknown> ) : void,
+
+  /**
+   * Creates a new Logger with a namespace value preset for all emitted logs.
+   * @param namespace
+   */
+  createLogger( namespace: string ) : Logger
+};
 
 /**
- * Log silly (level 6)
- * @param message Log message
- * @param metadata Additional information to be displayed
+ * Logger tool. Can be used in activities or workflows. Logs together with the framework's own logs.
  */
-export declare function silly( message: string, metadata?: LogMetadata ) : void;
+export declare const Logger : Logger;

package/src/interface/logger.js

@@ -9,7 +9,6 @@ const reservedMetadataFields = new Set( [
   'level',
   'message',
   'metadata',
-  'namespace',
   'splat',
   'stack',
   'timestamp',
@@ -26,6 +25,7 @@ const reservedMetadataFields = new Set( [
 // This is inoffensive and can be used outside workflow sandbox
 const sinks = proxySinks();
 
+// Winston uses npm levels by default: https://github.com/winstonjs/winston#logging-levels
 // Convert npm log levels to console levels
 const levelToConsole = {
   error: 'error',
@@ -36,14 +36,17 @@ const levelToConsole = {
   debug: 'debug',
   silly: 'log'
 };
+const levels = Object.keys( levelToConsole );
 
 /** Drops reserved keys from object */
 const removeReservedFields = obj => Object.fromEntries( Object.entries( obj ).filter( ( [ k ] ) => !reservedMetadataFields.has( k ) ) );
 
-const log = ( level, message, metadata ) => {
+/** Dispatch the log message downstream */
+const log = ( level, namespace, message, metadata ) => {
+  const baseMetadata = namespace ? { namespace } : {};
   const sanitized = {
     message: String( message ),
-    ...( isPlainObject( metadata ) && { metadata: removeReservedFields( metadata ) } )
+    metadata: { ...baseMetadata, ...isPlainObject( metadata ) ? removeReservedFields( metadata ) : {} }
   };
 
   // When inside workflow, use sinks to send logs out
@@ -58,11 +61,13 @@ const log = ( level, message, metadata ) => {
   }
 };
 
-// Winston uses npm levels by default: https://github.com/winstonjs/winston#logging-levels
-export const error = log.bind( null, 'error' );
-export const warn = log.bind( null, 'warn' );
-export const info = log.bind( null, 'info' );
-export const http = log.bind( null, 'http' );
-export const verbose = log.bind( null, 'verbose' );
-export const debug = log.bind( null, 'debug' );
-export const silly = log.bind( null, 'silly' );
+/** Creates a new logger. It uses the npm levels, and for each level, bind the log function */
+const createLogger = namespace => ( {
+  ...Object.fromEntries( levels.map( l => [ l, log.bind( null, l, namespace ) ] ) ),
+  createLogger
+} );
+
+/** This is the default logger instance */
+const logger = createLogger( null );
+
+export { logger as Logger };

package/src/interface/logger.spec.js

@@ -34,7 +34,7 @@ const consoleMethodsByLevel = {
   silly: 'log'
 };
 
-const loadLogger = async () => import( './logger.js' );
+const loadLogger = async () => ( await import( './logger.js' ) ).Logger;
 
 describe( 'interface/logger', () => {
   beforeEach( () => {
@@ -135,4 +135,38 @@ describe( 'interface/logger', () => {
     expect( consoleMocks.log ).toHaveBeenCalledTimes( 3 );
     expect( workflowLogMock ).not.toHaveBeenCalled();
   } );
+
+  it( 'creates a logger with a default namespace for every level', async () => {
+    const logger = await loadLogger();
+    inWorkflowContextMock.mockReturnValue( true );
+
+    const namespacedLogger = logger.createLogger( 'Namespace' );
+    logLevels.forEach( level => {
+      namespacedLogger[level]( `${level} message`, { requestId: level } );
+    } );
+
+    logLevels.forEach( ( level, index ) => {
+      expect( workflowLogMock ).toHaveBeenNthCalledWith( index + 1, {
+        level,
+        message: `${level} message`,
+        metadata: {
+          namespace: 'Namespace',
+          requestId: level
+        }
+      } );
+    } );
+  } );
+
+  it( 'lets log metadata override the default namespace', async () => {
+    const logger = await loadLogger();
+    inWorkflowContextMock.mockReturnValue( true );
+
+    logger.createLogger( 'Default namespace' ).info( 'message', { namespace: 'Inline namespace' } );
+
+    expect( workflowLogMock ).toHaveBeenCalledWith( {
+      level: 'info',
+      message: 'message',
+      metadata: { namespace: 'Inline namespace' }
+    } );
+  } );
 } );