@dxos/log 0.1.56-main.f3d4052 → 0.1.56-next.71eb10c

package/dist/types/src/index.d.ts

@@ -1,10 +1,12 @@
+import omit from 'lodash.omit';
+import pick from 'lodash.pick';
+export { omit, pick };
 export * from './config';
 export * from './context';
 export * from './log';
 export { parseFilter } from './options';
 export * from './processors';
 export * from './scope';
-export * from './invariant';
 export * from './meta';
 export { getCurrentOwnershipScope } from './experimental/ownership';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,OAAO,CAAC;AACtB,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AAEvB,OAAO,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,IAAI,MAAM,aAAa,CAAC;AAC/B,OAAO,IAAI,MAAM,aAAa,CAAC;AAE/B,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;AAEtB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,OAAO,CAAC;AACtB,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AAEvB,OAAO,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC"}

package/dist/types/src/options.d.ts

@@ -8,5 +8,5 @@ export declare const processors: {
 };
 export declare const DEFAULT_PROCESSORS: LogProcessor[];
 export declare const parseFilter: (filter: string | string[] | LogLevel) => LogFilter[];
-export declare const getConfig: (_options?: LogOptions) => LogConfig;
+export declare const getConfig: (options?: LogOptions) => LogConfig;
 //# sourceMappingURL=options.d.ts.map

package/dist/types/src/options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../src/options.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAA4B,MAAM,UAAU,CAAC;AAChG,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAIzC;;GAEG;AACH,eAAO,MAAM,UAAU,EAAE;IAAE,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAA;CAIvD,CAAC;AAIF,eAAO,MAAM,kBAAkB,gBAAuD,CAAC;AAEvF,eAAO,MAAM,WAAW,WAAY,MAAM,GAAG,MAAM,EAAE,GAAG,QAAQ,KAAG,SAAS,EAY3E,CAAC;AAEF,eAAO,MAAM,SAAS,cAAe,UAAU,KAAG,SAqBjD,CAAC"}
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../src/options.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAA4B,MAAM,UAAU,CAAC;AAChG,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAIzC;;GAEG;AACH,eAAO,MAAM,UAAU,EAAE;IAAE,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAA;CAIvD,CAAC;AAIF,eAAO,MAAM,kBAAkB,gBAAuD,CAAC;AAEvF,eAAO,MAAM,WAAW,WAAY,MAAM,GAAG,MAAM,EAAE,GAAG,QAAQ,KAAG,SAAS,EAY3E,CAAC;AAEF,eAAO,MAAM,SAAS,aAAc,UAAU,KAAG,SAuBhD,CAAC"}

package/dist/types/src/processors/console-processor.d.ts

@@ -8,6 +8,7 @@ export type FormatParts = {
     message: string;
     context?: any;
     error?: Error;
+    scope?: any;
 };
 export type Formatter = (config: LogConfig, parts: FormatParts) => (string | undefined)[];
 export declare const DEFAULT_FORMATTER: Formatter;

package/dist/types/src/processors/console-processor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"console-processor.d.ts","sourceRoot":"","sources":["../../../../src/processors/console-processor.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAkB,MAAM,WAAW,CAAC;AAChE,OAAO,EAAuB,YAAY,EAAa,MAAM,YAAY,CAAC;AAU1E,eAAO,MAAM,QAAQ,UAAW,MAAM,6CAGrC,CAAC;AAiBF,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,QAAQ,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAC;AAE1F,eAAO,MAAM,iBAAiB,EAAE,SAe/B,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,SAI7B,CAAC;AAKF,eAAO,MAAM,iBAAiB,EAAE,YAyB/B,CAAC"}
+{"version":3,"file":"console-processor.d.ts","sourceRoot":"","sources":["../../../../src/processors/console-processor.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAkB,MAAM,WAAW,CAAC;AAChE,OAAO,EAAuB,YAAY,EAAa,MAAM,YAAY,CAAC;AAU1E,eAAO,MAAM,QAAQ,UAAW,MAAM,6CAGrC,CAAC;AAiBF,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,QAAQ,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,KAAK,CAAC,EAAE,GAAG,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAC;AAE1F,eAAO,MAAM,iBAAiB,EAAE,SAuB/B,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,SAI7B,CAAC;AAKF,eAAO,MAAM,iBAAiB,EAAE,YAkC/B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/log",
-  "version": "0.1.56-main.f3d4052",
+  "version": "0.1.56-next.71eb10c",
   "description": "Logger",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -21,15 +21,19 @@
     "chalk": "^4.1.0",
     "js-yaml": "^4.1.0",
     "lodash.defaultsdeep": "^4.6.1",
+    "lodash.omit": "^4.5.0",
+    "lodash.pick": "^4.4.0",
     "lodash.pickby": "^4.6.0",
-    "@dxos/node-std": "0.1.56-main.f3d4052",
-    "@dxos/util": "0.1.56-main.f3d4052"
+    "@dxos/node-std": "0.1.56-next.71eb10c",
+    "@dxos/util": "0.1.56-next.71eb10c"
   },
   "devDependencies": {
     "@swc-node/sourcemap-support": "^0.2.0",
     "@swc/core": "1.3.70",
     "@types/js-yaml": "^4.0.5",
     "@types/lodash.defaultsdeep": "^4.6.6",
+    "@types/lodash.omit": "^4.5.7",
+    "@types/lodash.pick": "^4.4.7",
     "@types/lodash.pickby": "^4.6.7",
     "@types/node": "^18.11.9",
     "pirates": "~4.0.5",

package/src/config.ts

@@ -8,6 +8,7 @@ import { LogProcessor } from './context';
  * Standard levels.
  */
 // NOTE: Keep aligned with LogLevel in @dxos/protocols.
+// TODO(burdon): Update numbers?
 export enum LogLevel {
   TRACE = 5,
   DEBUG = 10,

package/src/index.ts

@@ -2,13 +2,18 @@
 // Copyright 2022 DXOS.org
 //
 
+// Message helpers.
+import omit from 'lodash.omit';
+import pick from 'lodash.pick';
+
+export { omit, pick };
+
 export * from './config';
 export * from './context';
 export * from './log';
 export { parseFilter } from './options';
 export * from './processors';
 export * from './scope';
-export * from './invariant';
 export * from './meta';
 
 export { getCurrentOwnershipScope } from './experimental/ownership';

package/src/options.ts

@@ -36,25 +36,27 @@ export const parseFilter = (filter: string | string[] | LogLevel): LogFilter[] =
   });
 };
 
-export const getConfig = (_options?: LogOptions): LogConfig => {
-  let options: LogOptions = defaultsDeep(
+export const getConfig = (options?: LogOptions): LogConfig => {
+  const nodeOptions: LogOptions | undefined =
+    'process' in globalThis
+      ? {
+          file: process!.env.LOG_CONFIG,
+          filter: process!.env.LOG_FILTER,
+          processor: process!.env.LOG_PROCESSOR,
+        }
+      : undefined;
+
+  const mergedOptions: LogOptions = defaultsDeep(
     {},
-    _options,
-    'process' in globalThis && {
-      // TODO(burdon): Node only.
-      file: process!.env?.LOG_CONFIG,
-      filter: process!.env?.LOG_FILTER,
-      processor: process!.env?.LOG_PROCESSOR,
-    },
+    options,
+    nodeOptions && loadOptions(nodeOptions.file),
+    nodeOptions,
   );
 
-  // TODO(burdon): Verbose option.
-  // console.log(JSON.stringify(options, undefined, 2));
-  options = defaultsDeep({}, loadOptions(options.file), options);
   return {
-    options,
-    filters: parseFilter(options.filter ?? LogLevel.INFO),
-    processors: options.processor ? [processors[options.processor]] : DEFAULT_PROCESSORS,
-    prefix: options.prefix,
+    options: mergedOptions,
+    filters: parseFilter(mergedOptions.filter ?? LogLevel.INFO),
+    processors: mergedOptions.processor ? [processors[mergedOptions.processor]] : DEFAULT_PROCESSORS,
+    prefix: mergedOptions.prefix,
   };
 };

package/src/platform/node/index.ts

@@ -14,7 +14,7 @@ import { LogOptions } from '../../config';
 export const loadOptions = (filepath?: string): LogOptions | undefined => {
   if (filepath) {
     const fullpath = path.join(process.cwd(), filepath);
-    console.log(`Log file: ${fullpath}`);
+    // console.log(`Log file: ${fullpath}`);
     try {
       const text = fs.readFileSync(fullpath, 'utf-8');
       if (text) {

package/src/processors/console-processor.ts

@@ -6,6 +6,8 @@ import chalk from 'chalk';
 import pickBy from 'lodash.pickby';
 import { inspect } from 'node:util';
 
+import { getPrototypeSpecificInstanceId } from '@dxos/util';
+
 import { LogConfig, LogLevel, shortLevelName } from '../config';
 import { getContextFromEntry, LogProcessor, shouldLog } from '../context';
 
@@ -44,21 +46,30 @@ export type FormatParts = {
   message: string;
   context?: any;
   error?: Error;
+  scope?: any;
 };
 
 export type Formatter = (config: LogConfig, parts: FormatParts) => (string | undefined)[];
 
-export const DEFAULT_FORMATTER: Formatter = (config, { path, line, level, message, context, error }) => {
+export const DEFAULT_FORMATTER: Formatter = (config, { path, line, level, message, context, error, scope }) => {
   const column = config.options?.formatter?.column;
 
   const filepath = path !== undefined && line !== undefined ? chalk.grey(`${path}:${line}`) : undefined;
 
+  let instance;
+  if (scope) {
+    const prototype = Object.getPrototypeOf(scope);
+    const id = getPrototypeSpecificInstanceId(scope);
+    instance = chalk.magentaBright(`${prototype.constructor.name}#${id}`);
+  }
+
   return [
     // NOTE: File path must come fist for console hyperlinks.
     // Must not truncate for terminal output.
     filepath,
     column && filepath ? ''.padStart(column - filepath.length) : undefined,
     chalk[LEVEL_COLORS[level]](column ? shortLevelName[level] : LogLevel[level]),
+    instance,
     message,
     context,
     error,
@@ -80,11 +91,20 @@ export const CONSOLE_PROCESSOR: LogProcessor = (config, entry) => {
     return;
   }
 
-  const parts: FormatParts = { level, message, error };
+  const parts: FormatParts = {
+    level,
+    message,
+    error,
+    path: undefined,
+    line: undefined,
+    scope: undefined,
+    context: undefined,
+  };
 
   if (meta) {
     parts.path = getRelativeFilename(meta.F);
     parts.line = meta.L;
+    parts.scope = meta.S;
   }
 
   const context = getContextFromEntry(entry);

package/dist/types/src/invariant.d.ts

@@ -1,12 +0,0 @@
-import { CallMetadata } from './meta';
-export type InvariantFn = (condition: unknown, message?: string, meta?: CallMetadata) => asserts condition;
-/**
- * Asserts that the condition is true.
- *
- * @param message Optional message.
- */
-export declare const invariant: InvariantFn;
-export declare class InvariantViolation extends Error {
-    constructor(message: string);
-}
-//# sourceMappingURL=invariant.d.ts.map

package/dist/types/src/invariant.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"invariant.d.ts","sourceRoot":"","sources":["../../../src/invariant.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,MAAM,MAAM,WAAW,GAAG,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC,SAAS,CAAC;AAE3G;;;;GAIG;AACH,eAAO,MAAM,SAAS,EAAE,WAwBvB,CAAC;AAEF,qBAAa,kBAAmB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM;CAK5B"}

package/src/invariant.ts

@@ -1,46 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { CallMetadata } from './meta';
-
-export type InvariantFn = (condition: unknown, message?: string, meta?: CallMetadata) => asserts condition;
-
-/**
- * Asserts that the condition is true.
- *
- * @param message Optional message.
- */
-export const invariant: InvariantFn = (
-  condition: unknown,
-  message?: string,
-  meta?: CallMetadata,
-): asserts condition => {
-  if (condition) {
-    return;
-  }
-
-  let errorMessage = 'invariant violation';
-
-  if (message) {
-    errorMessage += `: ${message}`;
-  }
-
-  if (meta?.A) {
-    errorMessage += ` [${meta.A[0]}]`;
-  }
-
-  if (meta?.F) {
-    errorMessage += ` at ${meta.F}:${meta.L}`;
-  }
-
-  throw new InvariantViolation(errorMessage);
-};
-
-export class InvariantViolation extends Error {
-  constructor(message: string) {
-    super(message);
-    // NOTE: Restores prototype chain (https://stackoverflow.com/a/48342359).
-    Object.setPrototypeOf(this, new.target.prototype);
-  }
-}