@travetto/registry 6.0.0-rc.1 → 6.0.0

package/README.md

@@ -23,6 +23,7 @@ The primary flow occurs on initialization of the application. At that point, the
    1. Initialize [RootRegistry](https://github.com/travetto/travetto/tree/main/module/registry/src/service/root.ts#L10) and will automatically register/load all relevant files
    1. As files are imported, decorators within the files will record various metadata relevant to the respective registries
    1. When all files are processed, the [RootRegistry](https://github.com/travetto/travetto/tree/main/module/registry/src/service/root.ts#L10) is finished, and it will signal to anything waiting on registered data that its free to use it.
+
 This flow ensures all files are loaded and processed before application starts. A sample registry could like:
 
 **Code: Sample Registry**
@@ -69,7 +70,7 @@ export class SampleRegistry extends MetadataRegistry<Group, Child> {
 }
 ```
 
-The registry is a [MetadataRegistry](https://github.com/travetto/travetto/tree/main/module/registry/src/service/metadata.ts#L13) that similar to the [Schema](https://github.com/travetto/travetto/tree/main/module/schema#readme "Data type registry for runtime validation, reflection and binding.")'s Schema registry and [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.")'s Dependency registry.
+The registry is a [MetadataRegistry](https://github.com/travetto/travetto/tree/main/module/registry/src/service/metadata.ts#L14) that similar to the [Schema](https://github.com/travetto/travetto/tree/main/module/schema#readme "Data type registry for runtime validation, reflection and binding.")'s Schema registry and [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.")'s Dependency registry.
 
 ### Live Flow
 At runtime, the registry is designed to listen for changes and to propagate the changes as necessary. In many cases the same file is handled by multiple registries. 
@@ -84,16 +85,17 @@ As mentioned in [Manifest](https://github.com/travetto/travetto/tree/main/module
 
 #handleFileChanges(importFile: string, classes: Class[] = []): number {
     const next = new Map<string, Class>(classes.map(cls => [cls.Ⲑid, cls] as const));
+    const sourceFile = RuntimeIndex.getSourceFile(importFile);
 
     let prev = new Map<string, Class>();
-    if (this.#classes.has(importFile)) {
-      prev = new Map(this.#classes.get(importFile)!.entries());
+    if (this.#classes.has(sourceFile)) {
+      prev = new Map(this.#classes.get(sourceFile)!.entries());
     }
 
     const keys = new Set([...Array.from(prev.keys()), ...Array.from(next.keys())]);
 
-    if (!this.#classes.has(importFile)) {
-      this.#classes.set(importFile, new Map());
+    if (!this.#classes.has(sourceFile)) {
+      this.#classes.set(sourceFile, new Map());
     }
 
     let changes = 0;
@@ -103,9 +105,9 @@ As mentioned in [Manifest](https://github.com/travetto/travetto/tree/main/module
       if (!next.has(k)) {
         changes += 1;
         this.emit({ type: 'removing', prev: prev.get(k)! });
-        this.#classes.get(importFile)!.delete(k);
+        this.#classes.get(sourceFile)!.delete(k);
       } else {
-        this.#classes.get(importFile)!.set(k, next.get(k)!);
+        this.#classes.get(sourceFile)!.set(k, next.get(k)!);
         if (!prev.has(k)) {
           changes += 1;
           this.emit({ type: 'added', curr: next.get(k)! });

package/__index__.ts

@@ -1,8 +1,8 @@
-export * from './src/registry';
-export * from './src/service/metadata';
-export * from './src/service/root';
-export * from './src/proxy';
-export * from './src/registry';
-export * from './src/source/class-source';
-export * from './src/source/method-source';
-export * from './src/types';
+export * from './src/registry.ts';
+export * from './src/service/metadata.ts';
+export * from './src/service/root.ts';
+export * from './src/proxy.ts';
+export * from './src/registry.ts';
+export * from './src/source/class-source.ts';
+export * from './src/source/method-source.ts';
+export * from './src/types.ts';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/registry",
-  "version": "6.0.0-rc.1",
+  "version": "6.0.0",
   "description": "Patterns and utilities for handling registration of metadata and functionality for run-time use",
   "keywords": [
     "ast-transformations",
@@ -27,11 +27,11 @@
     "directory": "module/registry"
   },
   "dependencies": {
-    "@travetto/runtime": "^6.0.0-rc.1"
+    "@travetto/runtime": "^6.0.0"
   },
   "peerDependencies": {
-    "@travetto/cli": "^6.0.0-rc.1",
-    "@travetto/transformer": "^6.0.0-rc.1"
+    "@travetto/cli": "^6.0.0",
+    "@travetto/transformer": "^6.0.0"
   },
   "peerDependenciesMeta": {
     "@travetto/transformer": {

package/src/internal/commonjs-loader.ts

@@ -3,7 +3,7 @@ import { Module } from 'node:module';
 import { path } from '@travetto/manifest';
 import { Runtime, RuntimeIndex } from '@travetto/runtime';
 
-import { RetargettingProxy } from '../proxy';
+import { RetargettingProxy } from '../proxy.ts';
 
 declare module 'module' {
   // eslint-disable-next-line @typescript-eslint/naming-convention

package/src/internal/file-loader.ts

@@ -1,78 +1,46 @@
 import { ManifestModuleUtil } from '@travetto/manifest';
 import { watchCompiler, WatchEvent, Runtime, RuntimeIndex } from '@travetto/runtime';
 
-interface ModuleLoader {
-  init?(): Promise<void>;
-  load(file: string): Promise<void>;
-  unload(file: string): Promise<void>;
-}
-
-type Handler = (ev: WatchEvent) => unknown;
-
 const VALID_FILE_TYPES = new Set(['js', 'ts']);
 
-/**
- * Listens to file changes, and provides a unified interface for watching file changes, reloading files as needed
- */
-class $DynamicFileLoader {
-  #handlers: Handler[] = [];
-  #loader: ModuleLoader;
-  #initialized = false;
-
-  async dispatch(ev: WatchEvent): Promise<void> {
-    if (ev.action === 'update' || ev.action === 'delete') {
-      await this.#loader.unload(ev.output);
-    }
-    if (ev.action === 'create' || ev.action === 'delete') {
-      RuntimeIndex.reinitForModule(Runtime.main.name);
-    }
-    if (ev.action === 'create' || ev.action === 'update') {
-      await this.#loader.load(ev.output);
-    }
-
-    for (const handler of this.#handlers) {
-      await handler(ev);
-    }
-  }
-
-  onLoadEvent(handler: Handler): void {
-    this.#handlers.push(handler);
+const handle = (err: Error): void => {
+  if (err && (err.message ?? '').includes('Cannot find module')) { // Handle module reloading
+    console.error('Cannot find module', { error: err });
+  } else {
+    throw err;
   }
+};
 
-  async init(): Promise<void> {
-    if (this.#initialized) {
-      return;
-    }
-
-    this.#initialized = true;
+/**
+ * Listens to file changes, and handles loading/unloading as needed (when supported)
+ */
+export class DynamicFileLoader {
 
+  static async * listen(): AsyncIterable<WatchEvent> {
     // TODO: ESM Support?
-    const { DynamicCommonjsLoader } = await import('./commonjs-loader');
-    this.#loader = new DynamicCommonjsLoader();
-
-    await this.#loader.init?.();
-
-    const handle = (err: Error): void => {
-      if (err && (err.message ?? '').includes('Cannot find module')) { // Handle module reloading
-        console.error('Cannot find module', { error: err });
-      } else {
-        throw err;
-      }
-    };
+    const { DynamicCommonjsLoader } = await import('./commonjs-loader.ts');
+    const loader = new DynamicCommonjsLoader();
+    await loader.init?.();
 
     process
       .on('unhandledRejection', handle)
       .on('uncaughtException', handle);
 
     // Fire off, and let it run in the bg. Restart on exit
-    (async (): Promise<void> => {
-      for await (const ev of watchCompiler({ restartOnExit: true })) {
-        if (ev.file && RuntimeIndex.hasModule(ev.module) && VALID_FILE_TYPES.has(ManifestModuleUtil.getFileType(ev.file))) {
-          await this.dispatch(ev);
+    for await (const ev of watchCompiler({ restartOnExit: true })) {
+      if (ev.file && RuntimeIndex.hasModule(ev.module) && VALID_FILE_TYPES.has(ManifestModuleUtil.getFileType(ev.file))) {
+        if (ev.action === 'update' || ev.action === 'delete') {
+          await loader.unload(ev.output);
+        }
+        if (ev.action === 'create' || ev.action === 'delete') {
+          RuntimeIndex.reinitForModule(Runtime.main.name);
+        }
+        if (ev.action === 'create' || ev.action === 'update') {
+          await loader.load(ev.output);
         }
+
+        yield ev;
       }
-    })();
+    }
   }
-}
-
-export const DynamicFileLoader = new $DynamicFileLoader();
+}

package/src/proxy.ts

@@ -1,6 +1,7 @@
+/* eslint @typescript-eslint/no-unused-vars: ["error", { "args": "none", "varsIgnorePattern": "^(_.*|[A-Z])$" } ] */
 import { Any, castKey, castTo, classConstruct } from '@travetto/runtime';
 
-const ProxyTargetSymbol = Symbol.for('@travetto/runtime:proxy-target');
+const ProxyTargetSymbol = Symbol();
 
 const AsyncGeneratorFunction = Object.getPrototypeOf(async function* () { });
 const GeneratorFunction = Object.getPrototypeOf(function* () { });
@@ -54,12 +55,12 @@ export class RetargettingHandler<T> implements ProxyHandler<Any> {
     if (prop === ProxyTargetSymbol) {
       return this.target;
     }
-    let ret = this.target[castKey<T>(prop)];
-    if (isFunction(ret) && !/^class\s/.test(Function.prototype.toString.call(ret))) {
+    let result = this.target[castKey<T>(prop)];
+    if (isFunction(result) && !/^class\s/.test(Function.prototype.toString.call(result))) {
       // Bind class members to class instance instead of proxy propagating
-      ret = ret.bind(this.target);
+      result = result.bind(this.target);
     }
-    return ret;
+    return result;
   }
 
   has(target: T, prop: PropertyKey): boolean {
@@ -123,4 +124,4 @@ export class RetargettingProxy<T> {
   get<V extends T>(): V {
     return castTo(this.#instance);
   }
-}
+}

package/src/registry.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from 'node:events';
 import { Class, Env } from '@travetto/runtime';
-import { ChangeSource, ChangeEvent, ChangeHandler } from './types';
+import { ChangeSource, ChangeEvent, ChangeHandler } from './types.ts';
 
 /**
  * Base registry class, designed to listen to changes over time

package/src/service/metadata.ts

@@ -1,7 +1,8 @@
+/* eslint @typescript-eslint/no-unused-vars: ["error", { "args": "none"} ] */
 import { Class } from '@travetto/runtime';
 
-import { Registry } from '../registry';
-import { ChangeEvent } from '../types';
+import { Registry } from '../registry.ts';
+import { ChangeEvent } from '../types.ts';
 
 function id(cls: string | Class): string {
   return cls && typeof cls !== 'string' ? cls.Ⲑid : cls;

package/src/service/root.ts

@@ -1,8 +1,8 @@
 import { Class } from '@travetto/runtime';
 
-import { Registry } from '../registry';
-import { ClassSource } from '../source/class-source';
-import { ChangeEvent } from '../types';
+import { Registry } from '../registry.ts';
+import { ClassSource } from '../source/class-source.ts';
+import { ChangeEvent } from '../types.ts';
 
 /**
  * The root registry that controls all registries

package/src/source/class-source.ts

@@ -2,8 +2,8 @@ import { EventEmitter } from 'node:events';
 
 import { Class, Env, Runtime, RuntimeIndex, describeFunction, flushPendingFunctions } from '@travetto/runtime';
 
-import { DynamicFileLoader } from '../internal/file-loader';
-import { ChangeSource, ChangeEvent, ChangeHandler } from '../types';
+import { DynamicFileLoader } from '../internal/file-loader.ts';
+import { ChangeSource, ChangeEvent, ChangeHandler } from '../types.ts';
 
 function isClass(cls: Function): cls is Class {
   return !!describeFunction(cls).class;
@@ -18,6 +18,7 @@ export class ClassSource implements ChangeSource<Class> {
 
   #classes = new Map<string, Map<string, Class>>();
   #emitter = new EventEmitter();
+  #listening: Promise<void> | undefined;
 
   /**
    * Are we in a mode that should have enhanced debug info
@@ -29,7 +30,7 @@ export class ClassSource implements ChangeSource<Class> {
    */
   #flush(): void {
     for (const cls of flushPendingFunctions().filter(isClass)) {
-      const src = Runtime.getImport(cls);
+      const src = Runtime.getSourceFile(cls);
       if (!this.#classes.has(src)) {
         this.#classes.set(src, new Map());
       }
@@ -38,21 +39,32 @@ export class ClassSource implements ChangeSource<Class> {
     }
   }
 
+  #removeFile(file: string): void {
+    const data = this.#classes.get(file);
+    if (data) {
+      this.#classes.delete(file);
+      for (const cls of data) {
+        this.emit({ type: 'removing', prev: cls[1] });
+      }
+    }
+  }
+
   /**
    * Process changes for a single file, looking for add/remove/update of classes
    */
   #handleFileChanges(importFile: string, classes: Class[] = []): number {
     const next = new Map<string, Class>(classes.map(cls => [cls.Ⲑid, cls] as const));
+    const sourceFile = RuntimeIndex.getSourceFile(importFile);
 
     let prev = new Map<string, Class>();
-    if (this.#classes.has(importFile)) {
-      prev = new Map(this.#classes.get(importFile)!.entries());
+    if (this.#classes.has(sourceFile)) {
+      prev = new Map(this.#classes.get(sourceFile)!.entries());
     }
 
     const keys = new Set([...Array.from(prev.keys()), ...Array.from(next.keys())]);
 
-    if (!this.#classes.has(importFile)) {
-      this.#classes.set(importFile, new Map());
+    if (!this.#classes.has(sourceFile)) {
+      this.#classes.set(sourceFile, new Map());
     }
 
     let changes = 0;
@@ -62,9 +74,9 @@ export class ClassSource implements ChangeSource<Class> {
       if (!next.has(k)) {
         changes += 1;
         this.emit({ type: 'removing', prev: prev.get(k)! });
-        this.#classes.get(importFile)!.delete(k);
+        this.#classes.get(sourceFile)!.delete(k);
       } else {
-        this.#classes.get(importFile)!.set(k, next.get(k)!);
+        this.#classes.get(sourceFile)!.set(k, next.get(k)!);
         if (!prev.has(k)) {
           changes += 1;
           this.emit({ type: 'added', curr: next.get(k)! });
@@ -115,15 +127,20 @@ export class ClassSource implements ChangeSource<Class> {
    * Initialize
    */
   async init(): Promise<void> {
-    if (Runtime.dynamic) {
-      DynamicFileLoader.onLoadEvent(ev => {
-        this.#handleChanges(flushPendingFunctions().filter(isClass));
+    if (Runtime.dynamic && !this.#listening) {
+      this.#listening = (async (): Promise<void> => {
+        for await (const ev of await DynamicFileLoader.listen()) {
+          if (ev.action === 'delete') {
+            this.#removeFile(ev.file); // File no longer exists
+          } else {
+            this.#handleChanges(flushPendingFunctions().filter(isClass));
+          }
 
-        if (ev.action === 'create') {
-          this.#flush();
+          if (ev.action === 'create') {
+            this.#flush();
+          }
         }
-      });
-      await DynamicFileLoader.init();
+      })();
     }
 
     // Ensure everything is loaded

package/src/source/method-source.ts

@@ -2,7 +2,7 @@ import { EventEmitter } from 'node:events';
 
 import { Class, describeFunction } from '@travetto/runtime';
 
-import { ChangeSource, ChangeEvent, ChangeHandler } from '../types';
+import { ChangeSource, ChangeEvent, ChangeHandler } from '../types.ts';
 
 /**
  * Change source specific to individual methods of classes.  Useful