feat(internal): add src/lib-nodejs/ava-unhandled-rejection.js

Author: michaelfig

packages/internal/src/lib-nodejs/ava-unhandled-rejection.js

@@ -0,0 +1,67 @@
+// @ts-check
+import { spawn } from 'child_process';
+import { fileURLToPath } from 'url';
+
+import engineGC from './engine-gc.js';
+import { makeGcAndFinalize } from './gc-and-finalize.js';
+
+/**
+ * @import {ExecutionContext, Macro} from 'ava';
+ */
+
+export const AVA_EXPECT_UNHANDLED_REJECTIONS =
+  'AGORIC_AVA_EXPECT_UNHANDLED_REJECTIONS';
+
+export const SUBTEST_PREFIX = '(unhandled rejection subprocess): ';
+
+/**
+ * @template C
+ * @param {string} importMetaUrl
+ * @returns {Macro<
+ *   [
+ *     expectedUnhandled: number,
+ *     name: string,
+ *     testFn: (t: ExecutionContext<C>) => any,
+ *   ],
+ *   C
+ * >}
+ */
+export const makeExpectUnhandledRejectionMacro = importMetaUrl => {
+  const self = fileURLToPath(importMetaUrl);
+  const gcAndFinalize = makeGcAndFinalize(engineGC);
+
+  if (process.env[AVA_EXPECT_UNHANDLED_REJECTIONS]) {
+    return {
+      title: (_, _expectedUnhandled, name, _testFn) => SUBTEST_PREFIX + name,
+      exec: async (t, _expectedUnhandled, _name, testFn) => {
+        await null;
+        try {
+          const result = await testFn(t);
+          return result;
+        } finally {
+          await gcAndFinalize();
+        }
+      },
+    };
+  }
+
+  return {
+    title: (_, _expectedUnhandled, name, _testFn) => name,
+    exec: async (t, expectedUnhandled, name, _testFn) =>
+      new Promise((resolve, reject) => {
+        const ps = spawn('ava', [self, '-m', SUBTEST_PREFIX + name], {
+          env: {
+            ...process.env,
+            [AVA_EXPECT_UNHANDLED_REJECTIONS]: `${expectedUnhandled}`,
+          },
+          stdio: ['ignore', 'inherit', 'inherit', 'ignore'],
+        });
+
+        ps.on('close', code => {
+          t.is(code, 0, `got exit code ${code}, expected 0 for ${name}`);
+          resolve();
+        });
+        ps.on('error', reject);
+      }),
+  };
+};

patches/ava+5.3.1.patch

@@ -95,17 +95,20 @@ index 7630baa..78ced77 100644
  		notifyOfPeerFailure() {
  			send({type: 'peer-failed'});
 diff --git a/node_modules/ava/lib/reporters/default.js b/node_modules/ava/lib/reporters/default.js
-index 804e285..330164c 100644
+index 804e285..8daf5ee 100644
 --- a/node_modules/ava/lib/reporters/default.js
 +++ b/node_modules/ava/lib/reporters/default.js
-@@ -679,7 +679,9 @@ export default class Reporter {
+@@ -678,8 +678,11 @@ export default class Reporter {
+ 			this.lineWriter.writeLine(colors.todo(`${this.stats.todoTests} ${plur('test', this.stats.todoTests)} todo`));
  		}
 
- 		if (this.stats.unhandledRejections > 0) {
+-		if (this.stats.unhandledRejections > 0) {
 -			this.lineWriter.writeLine(colors.error(`${this.stats.unhandledRejections} unhandled ${plur('rejection', this.stats.unhandledRejections)}`));
-+      const allowed = Number(process.env.AGORIC_AVA_ALLOW_UNHANDLED_REJECTIONS)
-+      const color = this.stats.unhandledRejections <= allowed ? 'skip' : 'error';
-+			this.lineWriter.writeLine(colors[color](`${this.stats.unhandledRejections} unhandled ${plur('rejection', this.stats.unhandledRejections)} (AGORIC_AVA_ALLOW_UNHANDLED_REJECTIONS=${allowed})`));
++		// AGORIC: TODO(#11028): unhandled exceptions patch should be accomplished in userspace.
++    if (this.stats.unhandledRejections > 0 || process.env.AGORIC_AVA_EXPECT_UNHANDLED_REJECTIONS) {
++			const expected = Number(process.env.AGORIC_AVA_EXPECT_UNHANDLED_REJECTIONS || 0)
++			const color = this.stats.unhandledRejections === expected ? 'skip' : 'error';
++			this.lineWriter.writeLine(colors[color](`${this.stats.unhandledRejections} unhandled ${plur('rejection', this.stats.unhandledRejections)} (AGORIC_AVA_EXPECT_UNHANDLED_REJECTIONS=${expected})`));
  		}
 
  		if (this.stats.uncaughtExceptions > 0) {
@@ -142,19 +145,32 @@ index b1989a4..fa1617f 100644
  			error: evt.err ? dumpError(evt.err) : null,
  			index: ++this.i,
 diff --git a/node_modules/ava/lib/run-status.js b/node_modules/ava/lib/run-status.js
-index 8471345..3110074 100644
+index 8471345..7433712 100644
 --- a/node_modules/ava/lib/run-status.js
 +++ b/node_modules/ava/lib/run-status.js
-@@ -230,6 +230,10 @@ export default class RunStatus extends Emittery {
+@@ -228,7 +228,7 @@ export default class RunStatus extends Emittery {
+ 			|| this.stats.sharedWorkerErrors > 0
+ 			|| this.stats.timeouts > 0
  			|| this.stats.uncaughtExceptions > 0
- 			|| this.stats.unhandledRejections > 0
+-			|| this.stats.unhandledRejections > 0
++      // AGORIC: `unhandledRejections` are processed below.
  		) {
-+      const allowed = Number(process.env.AGORIC_AVA_ALLOW_UNHANDLED_REJECTIONS);
-+      if (this.stats.unhandledRejections <= allowed) {
-+        return 0;
-+      }
  			return 1;
  		}
+@@ -237,6 +237,14 @@ export default class RunStatus extends Emittery {
+ 			return 1;
+ 		}
+ 
++		// AGORIC: TODO(#11028): unhandled exceptions patch should be accomplished in userspace.
++		if (this.stats.unhandledRejections > 0 || process.env.AGORIC_AVA_EXPECT_UNHANDLED_REJECTIONS) {
++			const expected = Number(process.env.AGORIC_AVA_EXPECT_UNHANDLED_REJECTIONS || 0);
++			if (this.stats.unhandledRejections !== expected) {
++				return 1;
++			}
++		}
++
+ 		return 0;
+ 	}
 
 diff --git a/node_modules/ava/lib/worker/base.js b/node_modules/ava/lib/worker/base.js
 index cdd3c4a..4302a4a 100644