[Not Tested][Squash][Sidetask] Meaningful names for components, mutations and reactions

[squashed] more thoughtful naming

Author: axmmisaka

src/benchmark/Sieve.ts

@@ -21,7 +21,7 @@ class Ramp extends Reactor {
   value = new OutPort<number>(this);
 
   constructor(parent: Reactor, until = 100000, period: TimeValue) {
-    super(parent);
+    super(parent, "Ramp");
     this.until = new Parameter(until);
     this.next = new Action<number>(this, Origin.logical, period);
     this.addReaction(
@@ -56,7 +56,7 @@ class Filter extends Reactor {
   hasChild: State<boolean>;
 
   constructor(parent: Reactor, startPrime: number, numberOfPrimes: number) {
-    super(parent);
+    super(parent, `FilterFor${startPrime}`);
     // console.log("Created filter with prime: " + prime)
     this.startPrime = new Parameter(startPrime);
     this.localPrimes = new State(new Array<number>());
@@ -126,7 +126,7 @@ class Sieve extends App {
     success?: () => void,
     fail?: () => void
   ) {
-    super(timeout, keepAlive, fast, success, fail);
+    super(timeout, keepAlive, fast, success, fail, name);
     this.source = new Ramp(this, 100000, TimeValue.nsec(1));
     this.filter = new Filter(this, 2, 1000);
     this._connect(this.source.value, this.filter.inp);

src/core/component.ts

@@ -1,5 +1,6 @@
 import type {Runtime} from "./internal";
 import {Reactor, App, MultiPort, IOPort, Bank} from "./internal";
+import {v4 as uuidv4} from "uuid";
 
 /**
  * Base class for named objects embedded in a hierarchy of reactors. Each
@@ -17,7 +18,7 @@ export abstract class Component {
    * A symbol that identifies this component, and it also used to selectively
    * grant access to its privileged functions.
    */
-  protected _key = Symbol("Unique component identifier");
+  protected _key = Symbol(uuidv4());
 
   /**
    * The container of this component. Each component is contained by a
@@ -26,6 +27,8 @@ export abstract class Component {
    */
   private readonly _container: Reactor;
 
+  protected _name: string;
+
   /**
    * Create a new component and register it with the given container.
    * @param container The reactor that will contain the new component,

src/core/reaction.ts

@@ -67,7 +67,8 @@ export class Reaction<T extends Variable[]>
     private deadline?: TimeValue,
     private readonly late: (...args: ArgList<T>) => void = () => {
       Log.global.warn("Deadline violation occurred!");
-    }
+    },
+    readonly name?: string
   ) {}
 
   /**
@@ -181,9 +182,9 @@ export class Reaction<T extends Variable[]>
    * Return string representation of the reaction.
    */
   public toString(): string {
-    return `${this.reactor._getFullyQualifiedName()}[R${this.reactor._getReactionIndex(
-      this as unknown as Reaction<Variable[]>
-    )}]`;
+    return `${this.reactor._getFullyQualifiedName()}` +
+      ((this.name != null) ? `${this.name} aka` : "") +
+      `[R${this.reactor._getReactionIndex(this as unknown as Reaction<Variable[]>)}]`;
   }
 }
 
@@ -199,18 +200,19 @@ export class Mutation<T extends Variable[]> extends Reaction<T> {
     args: [...ArgList<T>],
     react: (...args: ArgList<T>) => void,
     deadline?: TimeValue,
-    late?: (...args: ArgList<T>) => void
+    late?: (...args: ArgList<T>) => void,
+    name?: string
   ) {
-    super(__parent__, sandbox, trigs, args, react, deadline, late);
+    super(__parent__, sandbox, trigs, args, react, deadline, late, name);
     this.parent = __parent__;
   }
 
   /**
    * @override
    */
   public toString(): string {
-    return `${this.parent._getFullyQualifiedName()}[M${this.parent._getReactionIndex(
-      this as unknown as Reaction<Variable[]>
-    )}]`;
+    return `${this.parent._getFullyQualifiedName()}` +
+      ((this.name != null) ? `${this.name} aka` : "") +
+      `[M${this.parent._getReactionIndex(this as unknown as Reaction<Variable[]>)}]`;
   }
 }

src/core/reactor.ts

@@ -487,12 +487,15 @@ export abstract class Reactor extends Component {
     }
   };
 
+  protected _name: string;
+
   /**
    * Create a new reactor.
    * @param container The container of this reactor.
    */
-  constructor(container: Reactor | null) {
+  constructor(container: Reactor | null, name? : string) {
     super(container);
+    this._name = (name == null) ? this._key.description?.slice(0, 8) ?? "unknown reactor" : name;
     this._bankIndex = -1;
     if (container !== null) {
       const index = Bank.initializationMap.get(container);
@@ -2242,8 +2245,6 @@ export class App extends Reactor {
 
   private readonly snooze: Action<Tag>;
 
-  readonly _name: string;
-
   /**
    * Create a new top-level reactor.
    * @param executionTimeout Optional parameter to let the execution of the app time out.
@@ -2257,18 +2258,18 @@ export class App extends Reactor {
     keepAlive = false,
     fast = false,
     public success: () => void = () => undefined,
-    public failure: () => void = () => undefined
+    public failure: () => void = () => undefined,
+    name?: string
   ) {
-    super(null);
-
-    let name = this.constructor.name;
-    if (name === "") {
-      name = "app";
-    } else {
-      name = name.charAt(0).toLowerCase() + name.slice(1);
+    super(null, name);
+    
+    if (name == null) {
+      name = this.constructor.name;
+      if (name !== "") {
+        name = name.charAt(0).toLowerCase() + name.slice(1);
+      }
+      this._name = name;
     }
-    this._name = name;
-
     // Update pointer to runtime object for this reactor and
     // its startup and shutdown action since the inner class
     // instance this.__runtime isn't initialized up until here.