feat: display 'Player #' in logs to distinguish log messages from different Conductors

CHANGELOG.md

@@ -7,9 +7,12 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 ### Added
 - A new method `storageArc` that polls for network metrics and to check if an agent's storage arc is equal to a desired storage arc for a given dna hash. ([#300](https://github.com/holochain/tryorama/pull/301))
 -  A new configuration field `targetArcFactor` has been added to `NetworkConfig`, allowing test scenarios to be written with 0-arc conductors ([#300](https://github.com/holochain/tryorama/pull/300))
+- A new optional field `label` was added to the types `AppWithOptions`, `ConductorOptions`, `CreateConductorOptions`, and to the function `addConductor`. It allows overriding the default label which will prefix log messages of that Conductor instance.
 
 ### Removed
 ### Changed
+- Log messages from Conductors that were created with `addPlayers` functions are now prefixed by `Tryorama - Player #` where "#" is the Player index. This makes it easier to distinguish log messages from different conductors. ([#302](https://github.com/holochain/tryorama/pull/302))
+
 ### Fixed
 - Network options are now applied before the conductor launches, to ensure they actually alter the conductor configuration. ([#300](https://github.com/holochain/tryorama/pull/300))
 

docs/tryorama.appwithoptions.label.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@holochain/tryorama](./tryorama.md) &gt; [AppWithOptions](./tryorama.appwithoptions.md) &gt; [label](./tryorama.appwithoptions.label.md)
+
+## AppWithOptions.label property
+
+**Signature:**
+
+```typescript
+label?: string;
+```

docs/tryorama.appwithoptions.md

@@ -50,6 +50,25 @@ AppBundleSource
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[label?](./tryorama.appwithoptions.label.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
 </td></tr>
 <tr><td>
 

docs/tryorama.conductoroptions.label.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@holochain/tryorama](./tryorama.md) &gt; [ConductorOptions](./tryorama.conductoroptions.md) &gt; [label](./tryorama.conductoroptions.label.md)
+
+## ConductorOptions.label property
+
+Label to identify this conductor in logs.
+
+**Signature:**
+
+```typescript
+label?: string;
+```

docs/tryorama.conductoroptions.md

@@ -52,6 +52,25 @@ URL
 _(Optional)_ A bootstrap server URL for peers to discover each other.
 
 
+</td></tr>
+<tr><td>
+
+[label?](./tryorama.conductoroptions.label.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ Label to identify this conductor in logs.
+
+
 </td></tr>
 <tr><td>
 

docs/tryorama.createconductoroptions.md

@@ -9,7 +9,7 @@ Options for using the conductor factory.
 **Signature:**
 
 ```typescript
-export type CreateConductorOptions = Pick<ConductorOptions, "bootstrapServerUrl" | "timeout">;
+export type CreateConductorOptions = Pick<ConductorOptions, "bootstrapServerUrl" | "timeout" | "label">;
 ```
 **References:** [ConductorOptions](./tryorama.conductoroptions.md)
 

docs/tryorama.scenario.addconductor.md

@@ -9,7 +9,7 @@ Create and add a conductor to the scenario.
 **Signature:**
 
 ```typescript
-addConductor(networkConfig?: NetworkConfig): Promise<Conductor>;
+addConductor(networkConfig?: NetworkConfig, label?: string): Promise<Conductor>;
 ```
 
 ## Parameters
@@ -45,6 +45,22 @@ networkConfig
 _(Optional)_
 
 
+</td></tr>
+<tr><td>
+
+label
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
 </td></tr>
 </tbody></table>
 **Returns:**

docs/tryorama.scenario.md

@@ -227,7 +227,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[addConductor(networkConfig)](./tryorama.scenario.addconductor.md)
+[addConductor(networkConfig, label)](./tryorama.scenario.addconductor.md)
 
 
 </td><td>

ts/src/conductor.ts

@@ -21,8 +21,9 @@ import { _ALLOWED_ORIGIN } from "./conductor-helpers.js";
 import { makeLogger } from "./logger.js";
 import { AppWithOptions } from "./scenario.js";
 import { AgentsAppsOptions } from "./types.js";
+import { Logger } from "winston";
 
-const logger = makeLogger();
+const defaultLogger = makeLogger();
 
 /**
  * @public
@@ -52,6 +53,11 @@ export interface ConductorOptions {
    * Timeout for requests to Admin and App API.
    */
   timeout?: number;
+
+  /**
+   * Label to identify this conductor in logs.
+   */
+  label?: string;
 }
 
 /**
@@ -162,7 +168,7 @@ interface ConductorConfigYaml {
  */
 export type CreateConductorOptions = Pick<
   ConductorOptions,
-  "bootstrapServerUrl" | "timeout"
+  "bootstrapServerUrl" | "timeout" | "label"
 >;
 
 /**
@@ -180,6 +186,7 @@ export const createConductor = async (
   const createConductorOptions: CreateConductorOptions = pick(options, [
     "bootstrapServerUrl",
     "timeout",
+    "label",
   ]);
   const conductor = await Conductor.create(
     signalingServerUrl,
@@ -211,14 +218,16 @@ export class Conductor {
   private adminApiUrl: URL;
   private _adminWs: AdminWebsocket | undefined;
   private _appWs: AppWebsocket | undefined;
+  private _logger: Logger;
   private readonly timeout: number;
 
-  private constructor(timeout?: number) {
+  private constructor(label?: string, timeout?: number) {
     this.conductorProcess = undefined;
     this.conductorDir = undefined;
     this.adminApiUrl = new URL(HOST_URL.href);
     this._adminWs = undefined;
     this._appWs = undefined;
+    this._logger = makeLogger(label);
     this.timeout = timeout ?? DEFAULT_TIMEOUT;
   }
 
@@ -238,15 +247,15 @@ export class Conductor {
     }
     args.push("webrtc");
     args.push(signalingServerUrl.href);
-    logger.debug("spawning hc sandbox with args:", args);
+    defaultLogger.debug("spawning hc sandbox with args:", args);
     const createConductorProcess = spawn("hc", args);
     createConductorProcess.stdin.write(LAIR_PASSWORD);
     createConductorProcess.stdin.end();
 
-    const conductor = new Conductor(options?.timeout);
+    const conductor = new Conductor(options?.label, options?.timeout);
     return new Promise<Conductor>((resolve, reject) => {
       createConductorProcess.stdout.on("data", (data: Buffer) => {
-        logger.debug(`creating conductor config\n${data.toString()}`);
+        defaultLogger.debug(`creating conductor config\n${data.toString()}`);
         const tmpDirMatches = [
           ...data.toString().matchAll(/DataRootPath\("(.*?)"\)/g),
         ];
@@ -258,7 +267,7 @@ export class Conductor {
         resolve(conductor);
       });
       createConductorProcess.stderr.on("data", (err) => {
-        logger.error(`error when creating conductor config: ${err}\n`);
+        defaultLogger.error(`error when creating conductor config: ${err}\n`);
         reject(err);
       });
     });
@@ -298,8 +307,8 @@ export class Conductor {
       },
     };
     const yamlDump = yaml.dump(conductorConfigYaml);
-    logger.debug("Updated conductor config:");
-    logger.debug(yamlDump);
+    this._logger.debug("Updated conductor config:");
+    this._logger.debug(yamlDump);
     writeFileSync(`${this.conductorDir}/${CONDUCTOR_CONFIG}`, yamlDump);
   }
 
@@ -313,7 +322,9 @@ export class Conductor {
       "error starting conductor: conductor has not been created",
     );
     if (this.conductorProcess) {
-      logger.error("error starting conductor: conductor is already running\n");
+      this._logger.error(
+        "error starting conductor: conductor is already running\n",
+      );
       return;
     }
 
@@ -327,7 +338,7 @@ export class Conductor {
 
     const startPromise = new Promise<void>((resolve) => {
       runConductorProcess.stdout.on("data", (data: Buffer) => {
-        logger.info(data.toString());
+        this._logger.info(data.toString());
         const conductorLaunched = data.toString().match(/Conductor ready\./);
         if (conductorLaunched) {
           // This is the last output of the startup process.
@@ -340,7 +351,7 @@ export class Conductor {
       });
 
       runConductorProcess.stderr.on("data", (data: Buffer) => {
-        logger.error(data.toString());
+        this._logger.error(data.toString());
       });
     });
     await startPromise;
@@ -352,11 +363,11 @@ export class Conductor {
    */
   async shutDown() {
     if (!this.conductorProcess) {
-      logger.info("shut down conductor: conductor is not running");
+      this._logger.info("shut down conductor: conductor is not running");
       return null;
     }
 
-    logger.debug("closing admin and app web sockets\n");
+    this._logger.debug("closing admin and app web sockets\n");
     if (this._adminWs) {
       await this._adminWs.client.close();
       this._adminWs = undefined;
@@ -366,7 +377,7 @@ export class Conductor {
       this._appWs = undefined;
     }
 
-    logger.debug("shutting down conductor\n");
+    this._logger.debug("shutting down conductor\n");
     return new Promise<number | null>((resolve) => {
       assert(this.conductorProcess);
       // Kill process after timeout if terminating didn't succeed.
@@ -391,7 +402,7 @@ export class Conductor {
       wsClientOptions: { origin: _ALLOWED_ORIGIN },
       defaultTimeout: this.timeout,
     });
-    logger.debug(`connected to Admin API @ ${this.adminApiUrl.href}\n`);
+    this._logger.debug(`connected to Admin API @ ${this.adminApiUrl.href}\n`);
   }
 
   /**
@@ -405,7 +416,7 @@ export class Conductor {
       port: await getPort({ port: portNumbers(30000, 40000) }),
       allowed_origins: _ALLOWED_ORIGIN,
     };
-    logger.debug(`attaching App API to port ${request.port}\n`);
+    this._logger.debug(`attaching App API to port ${request.port}\n`);
     const { port } = await this.adminWs().attachAppInterface(request);
     return port;
   }
@@ -418,7 +429,7 @@ export class Conductor {
    * @returns An app websocket.
    */
   async connectAppWs(token: AppAuthenticationToken, port: number) {
-    logger.debug(`connecting App WebSocket to port ${port}\n`);
+    this._logger.debug(`connecting App WebSocket to port ${port}\n`);
     const appApiUrl = new URL(this.adminApiUrl.href);
     appApiUrl.port = port.toString();
     const appWs = await AppWebsocket.connect({
@@ -496,7 +507,7 @@ export class Conductor {
       installed_app_id,
       network_seed,
     };
-    logger.debug(
+    this._logger.debug(
       `installing app with id ${installed_app_id} for agent ${encodeHashToBase64(
         agent_key,
       )}`,
@@ -525,7 +536,7 @@ export const cleanAllConductors = async () => {
   const conductorProcess = spawn("hc", ["sandbox", "clean"]);
   return new Promise<void>((resolve) => {
     conductorProcess.stdout.once("end", () => {
-      logger.debug("sandbox conductors cleaned\n");
+      defaultLogger.debug("sandbox conductors cleaned\n");
       resolve();
     });
   });