@travetto/test 3.4.0 → 3.4.2

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 ArcSine Technologies
+Copyright (c) 2023 ArcSine Technologies
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/test",
-  "version": "3.4.0",
+  "version": "3.4.2",
   "description": "Declarative test framework",
   "keywords": [
     "unit-testing",
@@ -27,15 +27,15 @@
     "directory": "module/test"
   },
   "dependencies": {
-    "@travetto/base": "^3.4.0",
-    "@travetto/registry": "^3.4.0",
+    "@travetto/base": "^3.4.1",
+    "@travetto/registry": "^3.4.1",
     "@travetto/terminal": "^3.4.0",
-    "@travetto/worker": "^3.4.0",
-    "@travetto/yaml": "^3.4.0"
+    "@travetto/worker": "^3.4.1",
+    "@travetto/yaml": "^3.4.1"
   },
   "peerDependencies": {
-    "@travetto/cli": "^3.4.0",
-    "@travetto/transformer": "^3.4.0"
+    "@travetto/cli": "^3.4.6",
+    "@travetto/transformer": "^3.4.2"
   },
   "peerDependenciesMeta": {
     "@travetto/transformer": {

package/src/consumer/error.ts

@@ -0,0 +1,77 @@
+import { TypedObject, ObjectUtil } from '@travetto/base';
+
+import { TestEvent, } from '../model/event';
+
+
+export type SerializedError = { $?: boolean, message: string, stack?: string, name: string };
+
+function isSerialized(e: unknown): e is SerializedError {
+  return !!e && (typeof e === 'object') && '$' in e;
+}
+
+export class ErrorUtil {
+
+  /**
+   *  Prepare error for transmission
+   */
+  static serializeError(e: Error | SerializedError): SerializedError;
+  static serializeError(e: undefined): undefined;
+  static serializeError(e: Error | SerializedError | undefined): SerializedError | undefined {
+    let error: SerializedError | undefined;
+
+    if (e) {
+      error = { $: true, name: e.name, message: '' };
+      for (const k of TypedObject.keys<{ name: string }>(e)) {
+        error[k] = e[k];
+      }
+      error.name = e.name;
+      if (ObjectUtil.hasToJSON(e)) {
+        Object.assign(error, e.toJSON());
+      }
+      error.message ??= e.message;
+      error.stack ??= e.stack;
+    }
+
+    return error;
+  }
+
+  /**
+   * Reconstitute the error, post serialization
+   */
+  static deserializeError(e: Error | SerializedError): Error;
+  static deserializeError(e: undefined): undefined;
+  static deserializeError(e: Error | SerializedError | undefined): Error | undefined {
+    if (isSerialized(e)) {
+      const err = new Error();
+
+      for (const k of TypedObject.keys<{ name: string }>(e)) {
+        err[k] = e[k];
+      }
+      err.message = e.message;
+      err.stack = e.stack;
+      err.name = e.name;
+      return err;
+    } else if (e) {
+      return e;
+    }
+  }
+
+  /**
+   * Serialize all errors for a given test for transmission between parent/child
+   */
+  static serializeTestErrors(out: TestEvent): void {
+    if (out.phase === 'after') {
+      if (out.type === 'test') {
+        if (out.test.error) {
+          // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+          out.test.error = this.serializeError(out.test.error) as Error;
+        }
+      } else if (out.type === 'assertion') {
+        if (out.assertion.error) {
+          // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+          out.assertion.error = this.serializeError(out.assertion.error) as Error;
+        }
+      }
+    }
+  }
+}

package/src/consumer/types/event.ts

@@ -2,7 +2,7 @@ import { Writable } from 'stream';
 
 import { TestEvent } from '../../model/event';
 import { TestConsumer } from '../types';
-import { ConsumerUtil } from '../util';
+import { ErrorUtil } from '../error';
 import { Consumable } from '../registry';
 
 /**
@@ -18,7 +18,7 @@ export class EventStreamer implements TestConsumer {
 
   onEvent(event: TestEvent): void {
     const out = { ...event };
-    ConsumerUtil.serializeErrors(out);
+    ErrorUtil.serializeTestErrors(out);
     this.#stream.write(`${JSON.stringify(out)}\n`);
   }
 }

package/src/consumer/types/execution.ts

@@ -2,7 +2,7 @@ import { ChildCommChannel } from '@travetto/worker';
 
 import { TestEvent } from '../../model/event';
 import { TestConsumer } from '../types';
-import { ConsumerUtil } from '../util';
+import { ErrorUtil } from '../error';
 import { Consumable } from '../registry';
 
 /**
@@ -13,7 +13,7 @@ export class ExecutionEmitter extends ChildCommChannel<TestEvent> implements Tes
 
   onEvent(event: TestEvent): void {
     const out = { ...event };
-    ConsumerUtil.serializeErrors(out);
+    ErrorUtil.serializeTestErrors(out);
     this.send(event.type, out);
   }
 }

package/src/consumer/types/tap.ts

@@ -1,11 +1,12 @@
 import { RootIndex } from '@travetto/manifest';
 import { GlobalTerminal, Terminal } from '@travetto/terminal';
-import { ErrorUtil, ObjectUtil, TimeUtil } from '@travetto/base';
+import { ObjectUtil, TimeUtil } from '@travetto/base';
 import { YamlUtil } from '@travetto/yaml';
 
 import { TestEvent } from '../../model/event';
 import { SuitesSummary, TestConsumer } from '../types';
 import { Consumable } from '../registry';
+import { ErrorUtil } from '../error';
 import { TestResultsEnhancer, CONSOLE_ENHANCER } from '../enhancer';
 
 /**

package/src/worker/child.ts

@@ -1,9 +1,10 @@
 import { createWriteStream } from 'fs';
 
 import { ManifestFileUtil, RootIndex } from '@travetto/manifest';
-import { ConsoleManager, ErrorUtil, TimeUtil } from '@travetto/base';
+import { ConsoleManager, TimeUtil } from '@travetto/base';
 import { ChildCommChannel } from '@travetto/worker';
 
+import { ErrorUtil } from '../consumer/error';
 import { RunnerUtil } from '../execute/util';
 import { Runner } from '../execute/runner';
 import { Events, RunEvent } from './types';

package/src/worker/standard.ts

@@ -1,9 +1,10 @@
 import { RootIndex } from '@travetto/manifest';
-import { ExecUtil, ErrorUtil } from '@travetto/base';
+import { ExecUtil } from '@travetto/base';
 import { ParentCommChannel, Worker } from '@travetto/worker';
 
 import { Events, RunEvent } from './types';
 import { TestConsumer } from '../consumer/types';
+import { ErrorUtil } from '../consumer/error';
 import { TestEvent } from '../model/event';
 
 let i = 0;

package/support/cli.test.ts

@@ -2,7 +2,7 @@ import { EventEmitter } from 'events';
 import fs from 'fs/promises';
 
 import { path } from '@travetto/manifest';
-import { EnvInit } from '@travetto/base';
+import { defineEnv } from '@travetto/base';
 import { CliCommandShape, CliCommand, CliValidationError } from '@travetto/cli';
 import { WorkPool } from '@travetto/worker';
 import { Max, Min } from '@travetto/schema';
@@ -22,9 +22,9 @@ export class TestCommand implements CliCommandShape {
   /** Test run mode */
   mode: TestMode = 'standard';
 
-  envInit(): EnvInit {
+  preMain(): void {
     EventEmitter.defaultMaxListeners = 1000;
-    return { envName: 'test' };
+    defineEnv({ envName: 'test' });
   }
 
   isFirstFile(first: string): Promise<boolean> {

package/support/cli.test_child.ts

@@ -1,15 +1,15 @@
 import { EventEmitter } from 'events';
 
-import { EnvInit, ShutdownManager } from '@travetto/base';
+import { defineEnv, ShutdownManager } from '@travetto/base';
 import { CliCommand } from '@travetto/cli';
 
 /** Test child worker target */
 @CliCommand({ hidden: true })
 export class TestChildWorkerCommand {
-  envInit(): EnvInit {
+  preMain(): void {
     EventEmitter.defaultMaxListeners = 1000;
     process.env.FORCE_COLOR = '0';
-    return { envName: 'test' };
+    defineEnv({ envName: 'test' });
   }
 
   async main(): Promise<void> {

package/support/cli.test_count.ts

@@ -1,6 +1,6 @@
 import { CliCommand } from '@travetto/cli';
 import { RootIndex } from '@travetto/manifest';
-import { EnvInit } from '@travetto/base';
+import { defineEnv } from '@travetto/base';
 
 import { SuiteRegistry } from '../src/registry/suite';
 import { RunnerUtil } from '../src/execute/util';
@@ -8,8 +8,8 @@ import { RunnerUtil } from '../src/execute/util';
 @CliCommand({ hidden: true })
 export class TestCountCommand {
 
-  envInit(): EnvInit {
-    return { debug: false, envName: 'test' };
+  preMain(): void {
+    defineEnv({ debug: false, envName: 'test' });
   }
 
   async main(patterns: string[]) {

package/support/cli.test_direct.ts

@@ -1,4 +1,4 @@
-import { EnvInit } from '@travetto/base';
+import { defineEnv } from '@travetto/base';
 import { CliCommand } from '@travetto/cli';
 
 import { runTests } from './bin/run';
@@ -10,8 +10,8 @@ export class TestDirectCommand {
 
   format: TestFormat = 'tap';
 
-  envInit(): EnvInit {
-    return { envName: 'test' };
+  preMain(): void {
+    defineEnv({ envName: 'test' });
   }
 
   main(file: string, args: string[]): Promise<void> {

package/support/cli.test_watch.ts

@@ -1,4 +1,4 @@
-import { EnvInit } from '@travetto/base';
+import { defineEnv } from '@travetto/base';
 import { CliCommand, CliUtil } from '@travetto/cli';
 
 import { TestFormat } from './bin/types';
@@ -12,8 +12,8 @@ export class TestWatcherCommand {
   format: TestFormat = 'tap';
   mode: 'all' | 'change' = 'all';
 
-  envInit(): EnvInit {
-    return { envName: 'test', dynamic: true };
+  preMain(): void {
+    defineEnv({ envName: 'test', dynamic: true });
   }
 
   async main(): Promise<void> {

package/src/consumer/util.ts

@@ -1,20 +0,0 @@
-import { ErrorUtil } from '@travetto/base';
-import { TestEvent, } from '../model/event';
-
-export class ConsumerUtil {
-  static serializeErrors(out: TestEvent): void {
-    if (out.phase === 'after') {
-      if (out.type === 'test') {
-        if (out.test.error) {
-          // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-          out.test.error = ErrorUtil.serializeError(out.test.error) as Error;
-        }
-      } else if (out.type === 'assertion') {
-        if (out.assertion.error) {
-          // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-          out.assertion.error = ErrorUtil.serializeError(out.assertion.error) as Error;
-        }
-      }
-    }
-  }
-}