@travetto/runtime 5.0.14 → 5.0.16

package/README.md

@@ -69,6 +69,9 @@ class $Runtime {
 }
 ```
 
+### Class and Function Metadata
+For the framework to work properly, metadata needs to be collected about files, classes and functions to uniquely identify them, with support for detecting changes during live reloads.  To achieve this, every `class` is decorated with metadata, including methods, line numbers, and ultimately a unique id stored at `Ⲑid`.
+
 ## Environment Support
 The functionality we support for testing and retrieving environment information for known environment variables. They can be accessed directly on the [Env](https://github.com/travetto/travetto/tree/main/module/runtime/src/env.ts#L111) object, and will return a scoped [EnvProp](https://github.com/travetto/travetto/tree/main/module/runtime/src/env.ts#L8), that is compatible with the property definition.  E.g. only showing boolean related fields when the underlying flag supports `true` or `false`
 
@@ -213,20 +216,20 @@ export function work() {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.work = work;
 const tslib_1 = require("tslib");
-const Ⲑ_function_1 = tslib_1.__importStar(require("@travetto/runtime/src/function.js"));
-const ᚕ_c = tslib_1.__importStar(require("@travetto/runtime/src/console.js"));
-var ᚕm = ["@travetto/runtime", "doc/transpile.ts"];
+const Δfunction = tslib_1.__importStar(require("@travetto/runtime/src/function.js"));
+const Δconsole = tslib_1.__importStar(require("@travetto/runtime/src/console.js"));
+var mod_1 = ["@travetto/runtime", "doc/transpile.ts"];
 function work() {
-    ᚕ_c.log({ level: "debug", import: ᚕm, line: 2, scope: "work", args: ['Start Work'] });
+    Δconsole.log({ level: "debug", import: mod_1, line: 2, scope: "work", args: ['Start Work'] });
     try {
         1 / 0;
     }
     catch (err) {
-        ᚕ_c.log({ level: "error", import: ᚕm, line: 7, scope: "work", args: ['Divide by zero', { error: err }] });
+        Δconsole.log({ level: "error", import: mod_1, line: 7, scope: "work", args: ['Divide by zero', { error: err }] });
     }
-    ᚕ_c.log({ level: "debug", import: ᚕm, line: 9, scope: "work", args: ['End Work'] });
+    Δconsole.log({ level: "debug", import: mod_1, line: 9, scope: "work", args: ['End Work'] });
 }
-Ⲑ_function_1.registerFunction(work, ᚕm, { hash: 1030247697, lines: [1, 10, 2] });
+Δfunction.registerFunction(work, mod_1, { hash: 1030247697, lines: [1, 10, 2] });
 ```
 
 #### Filtering Debug

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/runtime",
-  "version": "5.0.14",
+  "version": "5.0.16",
   "description": "Runtime for travetto applications.",
   "keywords": [
     "console-manager",
@@ -21,16 +21,16 @@
   ],
   "main": "__index__.ts",
   "repository": {
-    "url": "https://github.com/travetto/travetto.git",
+    "url": "git+https://github.com/travetto/travetto.git",
     "directory": "module/runtime"
   },
   "dependencies": {
-    "@travetto/manifest": "^5.0.10",
+    "@travetto/manifest": "^5.0.12",
     "@types/debug": "^4.1.12",
     "debug": "^4.4.0"
   },
   "peerDependencies": {
-    "@travetto/transformer": "^5.0.11"
+    "@travetto/transformer": "^5.0.13"
   },
   "peerDependenciesMeta": {
     "@travetto/transformer": {

package/src/binary.ts

@@ -11,7 +11,7 @@ import { BinaryInput, BlobMeta } from './types';
 import { AppError } from './error';
 import { Util } from './util';
 
-const BlobMetaⲐ = Symbol.for('@travetto/runtime:blob-meta');
+const BlobMetaSymbol = Symbol.for('@travetto/runtime:blob-meta');
 
 /**
  * Common functions for dealing with binary data/streams
@@ -86,7 +86,7 @@ export class BinaryUtil {
       arrayBuffer: { value: () => toBuffer(go()) },
       text: { value: () => toText(go()) },
       bytes: { value: () => toBuffer(go()).then(v => new Uint8Array(v)) },
-      [BlobMetaⲐ]: { value: metadata }
+      [BlobMetaSymbol]: { value: metadata }
     });
   }
 
@@ -94,8 +94,8 @@ export class BinaryUtil {
    * Get blob metadata
    */
   static getBlobMeta(blob: Blob): BlobMeta | undefined {
-    const withMeta: Blob & { [BlobMetaⲐ]?: BlobMeta } = blob;
-    return withMeta[BlobMetaⲐ];
+    const withMeta: Blob & { [BlobMetaSymbol]?: BlobMeta } = blob;
+    return withMeta[BlobMetaSymbol];
   }
 
   /**

package/src/function.ts

@@ -5,12 +5,11 @@ export type FunctionMetadata = FunctionMetadataTag & {
   module: string;
   modulePath: string;
   methods?: Record<string, FunctionMetadataTag>;
-  synthetic?: boolean;
   class?: boolean;
   abstract?: boolean;
 };
 
-const METADATA = Symbol.for('@travetto/runtime:function-metadata');
+const MetadataSymbol = Symbol.for('@travetto/runtime:function-metadata');
 
 const pending = new Set<Function>([]);
 
@@ -22,24 +21,23 @@ const pending = new Set<Function>([]);
  * @param `line` Line number in source
  * @param `methods` Methods and their hashes
  * @param `abstract` Is the class abstract
- * @param `synthetic` Is this code generated at build time
  * @private
  */
 export function registerFunction(
   fn: Function, [pkg, pth]: [string, string], tag: FunctionMetadataTag,
-  methods?: Record<string, FunctionMetadataTag>, abstract?: boolean, synthetic?: boolean
+  methods?: Record<string, FunctionMetadataTag>, abstract?: boolean,
 ): void {
   const modulePath = pth.replace(/[.][cm]?[tj]sx?$/, '');
 
   const metadata: FunctionMetadata = {
-    id: (fn.name ? `${pkg}:${modulePath}￮${fn.name}` : `${pkg}:${modulePath}`),
+    id: (fn.name ? `${pkg}:${modulePath}#${fn.name}` : `${pkg}:${modulePath}`),
     import: `${pkg}/${pth}`,
     module: pkg,
     modulePath,
-    ...tag, methods, abstract, synthetic, class: abstract !== undefined
+    ...tag, methods, abstract, class: abstract !== undefined
   };
   pending.add(fn);
-  Object.defineProperties(fn, { Ⲑid: { value: metadata.id }, [METADATA]: { value: metadata } });
+  Object.defineProperties(fn, { Ⲑid: { value: metadata.id }, [MetadataSymbol]: { value: metadata } });
 }
 
 /**
@@ -56,6 +54,6 @@ export function flushPendingFunctions(): Function[] {
  */
 export function describeFunction(fn: Function): FunctionMetadata;
 export function describeFunction(fn?: Function): FunctionMetadata | undefined {
-  const _fn: (Function & { [METADATA]?: FunctionMetadata }) | undefined = fn;
-  return _fn?.[METADATA];
-}
+  const _fn: (Function & { [MetadataSymbol]?: FunctionMetadata }) | undefined = fn;
+  return _fn?.[MetadataSymbol];
+}

package/src/global.d.ts

@@ -6,7 +6,9 @@ declare global {
   interface WritableStreamDefaultWriter<W = any> {
     [write]?: (a: W) => void;
   }
+
   interface Function {
-    Ⲑid: string;
+    /* Exposed for use within framework, only applies to framework managed classes */
+    readonly Ⲑid: string;
   }
 }

package/src/shutdown.ts

@@ -15,13 +15,13 @@ export class ShutdownManager {
    * @param name name to log for
    * @param handler synchronous or asynchronous handler
    */
-  static onGracefulShutdown(handler: () => Promise<void>, name?: string | { constructor: { Ⲑid: string } }): () => void {
+  static onGracefulShutdown(handler: () => Promise<void>, name?: string | { constructor: Function }): () => void {
     if (!this.#registered) {
       this.#registered = true;
       const done = (): void => { this.gracefulShutdown(0); };
       process.on('SIGUSR2', done).on('SIGTERM', done).on('SIGINT', done);
     }
-    this.#handlers.push({ handler, name: typeof name === 'string' ? name : name?.constructor.Ⲑid });
+    this.#handlers.push({ handler, name: typeof name === 'string' ? name : name?.constructor?.Ⲑid });
     return () => {
       const idx = this.#handlers.findIndex(x => x.handler === handler);
       if (idx >= 0) {

package/src/types.ts

@@ -6,9 +6,7 @@ export type Any = any;
 
 export type AnyMap = { [key: string]: Any };
 export type Class<T = Any> = abstract new (...args: Any[]) => T;
-export type ClassInstance<T = Any> = T & {
-  constructor: Class<T> & { Ⲑid: string };
-};
+export type ClassInstance<T = Any> = T & { constructor: Class<T> };
 
 export type BinaryInput = Blob | Buffer | Readable | ReadableStream;
 

package/support/transformer.console-log.ts

@@ -1,9 +1,6 @@
 import ts from 'typescript';
 
-import {
-  TransformerState, OnCall, LiteralUtil,
-  OnClass, AfterClass, OnMethod, AfterMethod, AfterFunction, OnFunction
-} from '@travetto/transformer';
+import { TransformerState, OnCall, LiteralUtil, OnClass, AfterClass, OnMethod, AfterMethod, AfterFunction, OnFunction } from '@travetto/transformer';
 
 const CONSOLE_IMPORT = '@travetto/runtime/src/console';
 
@@ -89,7 +86,7 @@ export class ConsoleLogTransformer {
     const level = name.escapedText!;
 
     if (VALID_LEVELS[level]) {
-      const ident = state.imported ??= state.importFile(CONSOLE_IMPORT, 'ᚕ_c').ident;
+      const ident = state.imported ??= state.importFile(CONSOLE_IMPORT).ident;
       return state.factory.updateCallExpression(
         node,
         state.createAccess(ident, 'log'),

package/support/transformer.debug-method.ts

@@ -2,13 +2,13 @@ import ts from 'typescript';
 
 import { TransformerState, OnMethod, CoreUtil } from '@travetto/transformer';
 
-const DebugⲐ = Symbol.for('@travetto/runtime:debug');
+const DebugSymbol = Symbol.for('@travetto/runtime:debug');
 
 /**
  * Debug transformation state
  */
 interface DebugState {
-  [DebugⲐ]?: ts.Expression;
+  [DebugSymbol]?: ts.Expression;
 }
 
 /**
@@ -18,9 +18,9 @@ export class DebugEntryTransformer {
 
   @OnMethod('DebugBreak')
   static debugOnEntry(state: TransformerState & DebugState, node: ts.MethodDeclaration): ts.MethodDeclaration {
-    if (!state[DebugⲐ]) {
+    if (!state[DebugSymbol]) {
       const imp = state.importFile('@travetto/runtime/src/debug').ident;
-      state[DebugⲐ] = CoreUtil.createAccess(state.factory, imp, 'tryDebugger');
+      state[DebugSymbol] = CoreUtil.createAccess(state.factory, imp, 'tryDebugger');
     }
 
     return state.factory.updateMethodDeclaration(node,
@@ -32,7 +32,7 @@ export class DebugEntryTransformer {
       node.parameters,
       node.type,
       node.body ? state.factory.updateBlock(node.body, [
-        state.factory.createIfStatement(state[DebugⲐ]!,
+        state.factory.createIfStatement(state[DebugSymbol]!,
           state.factory.createExpressionStatement(state.factory.createIdentifier('debugger'))),
         ...node.body.statements
       ]) : node.body

package/support/transformer.function-metadata.ts

@@ -1,9 +1,6 @@
 import ts from 'typescript';
 
-import {
-  TransformerState, OnMethod, OnClass, AfterClass,
-  CoreUtil, SystemUtil, Import, OnFunction
-} from '@travetto/transformer';
+import { TransformerState, OnMethod, OnClass, AfterClass, CoreUtil, SystemUtil, Import, OnFunction } from '@travetto/transformer';
 
 import type { FunctionMetadataTag } from '../src/function';
 
@@ -95,7 +92,6 @@ export class RegisterTransformer {
         state.fromLiteral(state[cls]),
         state.extendObjectLiteral(state[methods] || {}),
         state.fromLiteral(CoreUtil.isAbstract(node)),
-        state.fromLiteral(name.endsWith(TransformerState.SYNTHETIC_EXT))
       ]
     );
 
@@ -109,7 +105,11 @@ export class RegisterTransformer {
       node.typeParameters,
       node.heritageClauses,
       [
-        state.createStaticField('Ⲑinit', meta),
+        state.factory.createClassStaticBlockDeclaration(
+          state.factory.createBlock([
+            state.factory.createExpressionStatement(meta)
+          ])
+        ),
         ...node.members
       ]
     );