Skip to content

armgit / mocha

Public Imported from GitHub
0

☕️ Classic, reliable, trusted test framework for Node.js and the browser

chore: convert `lib/nodejs/` utility files to ESM (#6011)

Josh Goldberg ✨a8ffaa9375e5
diff --git a/lib/nodejs/serializer.js b/lib/nodejs/serializer.mjs
similarity index 96%
rename from lib/nodejs/serializer.js
rename to lib/nodejs/serializer.mjs
index 29e4fff6..ee6a84ac 100644
--- a/lib/nodejs/serializer.js
+++ b/lib/nodejs/serializer.mjs
@@ -4,18 +4,18 @@
* @private
*/
-"use strict";
-
/**
* @typedef {import('../types.d.ts').SerializedEvent} SerializedEvent
* @typedef {import('../types.d.ts').SerializedWorkerResult} SerializedWorkerResult
*/
-const { type, breakCircularDeps } = require("../utils");
-const { createInvalidArgumentTypeError } = require("../errors.mjs");
+import { type, breakCircularDeps } from "../utils.js";
+import { createInvalidArgumentTypeError } from "../errors.mjs";
+import d from "debug";
+
// this is not named `mocha:parallel:serializer` because it's noisy and it's
// helpful to be able to write `DEBUG=mocha:parallel*` and get everything else.
-const debug = require("debug")("mocha:serializer");
+const debug = d.debug("mocha:serializer");
const SERIALIZABLE_RESULT_NAME = "SerializableWorkerResult";
const SERIALIZABLE_TYPES = new Set(["object", "array", "function", "error"]);
@@ -24,7 +24,7 @@ const SERIALIZABLE_TYPES = new Set(["object", "array", "function", "error"]);
* The serializable result of a test file run from a worker.
* @private
*/
-class SerializableWorkerResult {
+export class SerializableWorkerResult {
/**
* Creates instance props; of note, the `__type` prop.
*
@@ -118,7 +118,7 @@ class SerializableWorkerResult {
* deserialization.
* @private
*/
-class SerializableEvent {
+export class SerializableEvent {
/**
* Constructs a `SerializableEvent`, throwing if we receive unexpected data.
*
@@ -371,14 +371,14 @@ class SerializableEvent {
*
* @param {*} [value] - A value to serialize
*/
-exports.serialize = function serialize(value) {
+export function serialize(value) {
const result =
type(value) === "object" && type(value.serialize) === "function"
? value.serialize()
: value;
debug("serialized: %O", result);
return result;
-};
+}
/**
* "Deserializes" a "message" received over IPC.
@@ -388,13 +388,10 @@ exports.serialize = function serialize(value) {
*
* @param {*} [value] - A "message" to deserialize
*/
-exports.deserialize = function deserialize(value) {
+export function deserialize(value) {
const result = SerializableWorkerResult.isSerializedWorkerResult(value)
? SerializableWorkerResult.deserialize(value)
: value;
debug("deserialized: %O", result);
return result;
-};
-
-exports.SerializableEvent = SerializableEvent;
-exports.SerializableWorkerResult = SerializableWorkerResult;
+}
diff --git a/lib/nodejs/worker.js b/lib/nodejs/worker.js
index 05c8887b..45505608 100644
--- a/lib/nodejs/worker.js
+++ b/lib/nodejs/worker.js
@@ -21,7 +21,7 @@ const { handleRequires, validateLegacyPlugin } = require("../cli/run-helpers");
const d = require("debug");
const debug = d.debug(`mocha:parallel:worker:${process.pid}`);
const isDebugEnabled = d.enabled(`mocha:parallel:worker:${process.pid}`);
-const { serialize } = require("./serializer");
+const { serialize } = require("./serializer.mjs");
const { setInterval, clearInterval } = global;
let rootHooks;
diff --git a/package.json b/package.json
index b0034ae9..33bb7490 100644
--- a/package.json
+++ b/package.json
@@ -180,7 +180,7 @@
"./lib/nodejs/esm-utils.js": false,
"./lib/nodejs/file-unloader.js": false,
"./lib/nodejs/parallel-buffered-runner.js": false,
- "./lib/nodejs/serializer.js": false,
+ "./lib/nodejs/serializer.mjs": false,
"./lib/nodejs/worker.js": false,
"./lib/nodejs/reporters/parallel-buffered.js": false,
"./lib/cli/index.js": false
diff --git a/test/node-unit/worker.spec.js b/test/node-unit/worker.spec.js
index 551cbb75..783e27e3 100644
--- a/test/node-unit/worker.spec.js
+++ b/test/node-unit/worker.spec.js
@@ -2,7 +2,7 @@
const serializeJavascript = require("serialize-javascript");
const rewiremock = require("rewiremock/node");
-const { SerializableWorkerResult } = require("../../lib/nodejs/serializer");
+const { SerializableWorkerResult } = require("../../lib/nodejs/serializer.mjs");
const sinon = require("sinon");
const WORKER_PATH = require.resolve("../../lib/nodejs/worker.js");
@@ -65,9 +65,9 @@ describe("worker", function () {
worker = rewiremock.proxy(WORKER_PATH, {
workerpool: stubs.workerpool,
"../../lib/mocha": stubs.Mocha,
- "../../lib/nodejs/serializer": stubs.serializer,
+ "../../lib/nodejs/serializer.mjs": stubs.serializer,
"../../lib/cli/run-helpers": stubs.runHelpers,
- "../../lib/plugin-loader": stubs.plugin,
+ "../../lib/plugin-loader.mjs": stubs.plugin,
});
});