@fluid-internal/mocha-test-setup 2.101.1 → 2.103.0

package/.attw.json

@@ -0,0 +1,3 @@
+{
+	"ignoreRules": ["cjs-resolves-to-esm"]
+}

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @fluid-internal/mocha-test-setup
 
+## 2.103.0
+
+Dependency updates only.
+
+## 2.102.0
+
+Dependency updates only.
+
 ## 2.101.0
 
 Dependency updates only.

package/eslint.config.mts

@@ -15,6 +15,7 @@ const config: Linter.Config[] = [
 			"@typescript-eslint/no-unsafe-assignment": "off",
 			"@typescript-eslint/no-unsafe-call": "off",
 			"@typescript-eslint/no-unsafe-member-access": "off",
+			"import-x/no-nodejs-modules": "off",
 			"unicorn/no-negated-condition": "off",
 			"unicorn/no-null": "off",
 		},

package/lib/mocharcCommon.d.ts

@@ -0,0 +1,36 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Mocha configuration object returned by {@link getFluidTestMochaConfig}.
+ */
+export interface FluidTestMochaConfig {
+    recursive: boolean;
+    require: string[];
+    "unhandled-rejections": string;
+    "fail-zero": boolean;
+    ignore: string[];
+    "node-option": string[];
+    spec: string;
+    exit?: boolean;
+    timeout?: number | string;
+    fgrep?: string[];
+    reporter?: string;
+    reporterOptions?: string[];
+    "reporter-options"?: string[];
+    "forbid-only"?: boolean;
+}
+/**
+ * Get the mocha configuration for running tests using the conventions followed in the Fluid Framework repository.
+ *
+ * @param packageDir - the directory of the package, typically set using `__dirname`
+ * @param additionalRequiredModules - modules to require in addition to the standard set.
+ * @param testReportPrefix - prefix for the test output report file names.
+ * @remarks
+ * Additional configuration can be provided via environment variables: see {@link file://./README.md}.
+ *
+ * Users desiring exact control over the `spec` from the CLI should delete or replace the spec from the returned config, since mocha's behavior is to extend it, not override it.
+ */
+export declare function getFluidTestMochaConfig(packageDir: string, additionalRequiredModules?: string[], testReportPrefix?: string): FluidTestMochaConfig;
+//# sourceMappingURL=mocharcCommon.d.ts.map

package/lib/mocharcCommon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mocharcCommon.d.ts","sourceRoot":"","sources":["../src/mocharcCommon.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,uBAAuB,CACtC,UAAU,EAAE,MAAM,EAClB,yBAAyB,CAAC,EAAE,MAAM,EAAE,EACpC,gBAAgB,CAAC,EAAE,MAAM,GACvB,oBAAoB,CAyGtB"}

package/lib/mocharcCommon.js

@@ -0,0 +1,106 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { readFileSync } from "node:fs";
+import path from "node:path";
+/**
+ * Get the mocha configuration for running tests using the conventions followed in the Fluid Framework repository.
+ *
+ * @param packageDir - the directory of the package, typically set using `__dirname`
+ * @param additionalRequiredModules - modules to require in addition to the standard set.
+ * @param testReportPrefix - prefix for the test output report file names.
+ * @remarks
+ * Additional configuration can be provided via environment variables: see {@link file://./README.md}.
+ *
+ * Users desiring exact control over the `spec` from the CLI should delete or replace the spec from the returned config, since mocha's behavior is to extend it, not override it.
+ */
+export function getFluidTestMochaConfig(packageDir, additionalRequiredModules, testReportPrefix) {
+    const requiredModules = [
+        // General mocha setup e.g. suppresses console.log,
+        // This has to be before others (except logger) so that registerMochaTestWrapperFuncs is available
+        "@fluid-internal/mocha-test-setup",
+        "source-map-support/register",
+        ...(additionalRequiredModules ?? []),
+    ];
+    if (process.env.FLUID_TEST_LOGGER_PKG_SPECIFIER !== undefined) {
+        // Inject implementation of createTestLogger, put it first before mocha-test-setup
+        requiredModules.unshift(process.env.FLUID_TEST_LOGGER_PKG_SPECIFIER);
+    }
+    let reportPrefix = testReportPrefix;
+    let defaultSpec = "lib/test";
+    if (process.env.FLUID_TEST_MODULE_SYSTEM === "CJS") {
+        defaultSpec = "dist/test";
+        const testVariant = process.env.FLUID_TEST_VARIANT;
+        process.env.FLUID_TEST_VARIANT = testVariant !== undefined ? `CJS,${testVariant}` : "CJS";
+        reportPrefix = reportPrefix !== undefined ? `${reportPrefix}-CJS` : "CJS";
+    }
+    const config = {
+        "recursive": true,
+        "require": requiredModules,
+        "unhandled-rejections": "strict",
+        // Fail the test run if no tests are found/run. This catches cases where test files fail to
+        // load silently (e.g. due to broken imports), which would otherwise produce a green "0 passing"
+        // result with exit code 0.
+        "fail-zero": true,
+        ignore: [
+            // Ignore "tools" which are scripts intended to be run, not part of the test suite.
+            "**/*.tool.{js,cjs,mjs}",
+        ],
+        "node-option": [
+            // Allow test-only indexes to be imported. Search the FF repo for package.json files with this condition to see example usage.
+            "conditions=allow-ff-test-exports",
+            // Performance tests benefit from having access to GC, and memory tests require it.
+            // Exposing it here avoids all packages which do perf testing from having to expose it.
+            // Note that since "node-option" is explicitly set,
+            // these must be provided here and not via mocha's --v8-expose-gc.
+            "expose-gc",
+        ],
+        spec: process.env.MOCHA_SPEC ?? defaultSpec,
+    };
+    // This approach to checking for this flag is consistent with some (but not all) others in this file,
+    // but not with tools/benchmark/src/Configuration.ts.
+    // For now, undefined, "1" and "true" should work consistently across all known use, and "1" is the main form we explicitly use.
+    // All these should be made to match, see AB#69054.
+    if (process.env.FLUID_TEST_PERF_MODE !== undefined) {
+        if (process.env.SILENT_TEST_OUTPUT === undefined) {
+            console.log(`Running performance tests...`);
+        }
+        // Some perf tests are often quite slow, and we don't want to lose the data by hitting a timeout.
+        // This is 1000 seconds, so ~16 minutes.
+        // This can be overridden by setting FLUID_TEST_TIMEOUT to a different value if desired.
+        config.timeout = 1_000_000;
+        // If there is no filter specified, limit to benchmarks.
+        // If mocha allowed multiple filters to all be applied to further narrow results, we would do this unconditionally.
+        if (!(process.argv.includes("--fgrep") || process.argv.includes("--grep"))) {
+            config.fgrep = ["@Benchmark"];
+        }
+        config.reporter = "@fluid-tools/benchmark/dist/mocha/Reporter.js";
+        if (!process.argv.includes("--reporterOptions")) {
+            // If report options were not specified, default to:
+            config.reporterOptions = ["reportFile=./benchmarkOutput.json"];
+        }
+    }
+    else {
+        const packageJsonPath = path.join(packageDir, "package.json");
+        const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf8"));
+        config.reporter = `mocha-multi-reporters`;
+        // See https://www.npmjs.com/package/mocha-multi-reporters#cmroutput-option
+        const outputFilePrefix = reportPrefix !== undefined ? `${reportPrefix}-` : "";
+        if (process.env.SILENT_TEST_OUTPUT === undefined) {
+            console.log(`Writing test results relative to package to nyc/${outputFilePrefix}junit-report.xml`);
+        }
+        const suiteName = reportPrefix !== undefined ? `${packageJson.name} - ${reportPrefix}` : packageJson.name;
+        config["reporter-options"] = [
+            `configFile=${path.join(import.meta.dirname, "..", "test-config.json")},cmrOutput=xunit+output+${outputFilePrefix}:xunit+suiteName+${suiteName}`,
+        ];
+    }
+    if (process.env.FLUID_TEST_TIMEOUT !== undefined) {
+        config.timeout = process.env.FLUID_TEST_TIMEOUT;
+    }
+    if (process.env.FLUID_TEST_FORBID_ONLY !== undefined) {
+        config["forbid-only"] = true;
+    }
+    return config;
+}
+//# sourceMappingURL=mocharcCommon.js.map

package/lib/mocharcCommon.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mocharcCommon.js","sourceRoot":"","sources":["../src/mocharcCommon.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,IAAI,MAAM,WAAW,CAAC;AAsB7B;;;;;;;;;;GAUG;AACH,MAAM,UAAU,uBAAuB,CACtC,UAAkB,EAClB,yBAAoC,EACpC,gBAAyB;IAEzB,MAAM,eAAe,GAAG;QACvB,mDAAmD;QACnD,kGAAkG;QAClG,kCAAkC;QAClC,6BAA6B;QAC7B,GAAG,CAAC,yBAAyB,IAAI,EAAE,CAAC;KACpC,CAAC;IAEF,IAAI,OAAO,CAAC,GAAG,CAAC,+BAA+B,KAAK,SAAS,EAAE,CAAC;QAC/D,kFAAkF;QAClF,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;IACtE,CAAC;IAED,IAAI,YAAY,GAAG,gBAAgB,CAAC;IACpC,IAAI,WAAW,GAAG,UAAU,CAAC;IAC7B,IAAI,OAAO,CAAC,GAAG,CAAC,wBAAwB,KAAK,KAAK,EAAE,CAAC;QACpD,WAAW,GAAG,WAAW,CAAC;QAC1B,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;QACnD,OAAO,CAAC,GAAG,CAAC,kBAAkB,GAAG,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAC1F,YAAY,GAAG,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,YAAY,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;IAC3E,CAAC;IAED,MAAM,MAAM,GAAyB;QACpC,WAAW,EAAE,IAAI;QACjB,SAAS,EAAE,eAAe;QAC1B,sBAAsB,EAAE,QAAQ;QAChC,2FAA2F;QAC3F,gGAAgG;QAChG,2BAA2B;QAC3B,WAAW,EAAE,IAAI;QACjB,MAAM,EAAE;YACP,mFAAmF;YACnF,wBAAwB;SACxB;QACD,aAAa,EAAE;YACd,8HAA8H;YAC9H,kCAAkC;YAClC,mFAAmF;YACnF,uFAAuF;YACvF,mDAAmD;YACnD,kEAAkE;YAClE,WAAW;SACX;QACD,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,WAAW;KAC3C,CAAC;IAEF,qGAAqG;IACrG,qDAAqD;IACrD,gIAAgI;IAChI,mDAAmD;IACnD,IAAI,OAAO,CAAC,GAAG,CAAC,oBAAoB,KAAK,SAAS,EAAE,CAAC;QACpD,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;YAClD,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;QAC7C,CAAC;QAED,iGAAiG;QACjG,wCAAwC;QACxC,wFAAwF;QACxF,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;QAE3B,wDAAwD;QACxD,mHAAmH;QACnH,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;YAC5E,MAAM,CAAC,KAAK,GAAG,CAAC,YAAY,CAAC,CAAC;QAC/B,CAAC;QAED,MAAM,CAAC,QAAQ,GAAG,+CAA+C,CAAC;QAClE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC;YACjD,oDAAoD;YACpD,MAAM,CAAC,eAAe,GAAG,CAAC,mCAAmC,CAAC,CAAC;QAChE,CAAC;IACF,CAAC;SAAM,CAAC;QACP,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;QAC9D,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,eAAe,EAAE,MAAM,CAAC,CAEnE,CAAC;QACF,MAAM,CAAC,QAAQ,GAAG,uBAAuB,CAAC;QAC1C,2EAA2E;QAC3E,MAAM,gBAAgB,GAAG,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,YAAY,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9E,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;YAClD,OAAO,CAAC,GAAG,CACV,mDAAmD,gBAAgB,kBAAkB,CACrF,CAAC;QACH,CAAC;QACD,MAAM,SAAS,GACd,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,IAAI,MAAM,YAAY,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC;QACzF,MAAM,CAAC,kBAAkB,CAAC,GAAG;YAC5B,cAAc,IAAI,CAAC,IAAI,CACtB,MAAM,CAAC,IAAI,CAAC,OAAO,EACnB,IAAI,EACJ,kBAAkB,CAClB,2BAA2B,gBAAgB,oBAAoB,SAAS,EAAE;SAC3E,CAAC;IACH,CAAC;IAED,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;QAClD,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;IACjD,CAAC;IAED,IAAI,OAAO,CAAC,GAAG,CAAC,sBAAsB,KAAK,SAAS,EAAE,CAAC;QACtD,MAAM,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;IAC9B,CAAC;IAED,OAAO,MAAM,CAAC;AACf,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { readFileSync } from \"node:fs\";\nimport path from \"node:path\";\n\n/**\n * Mocha configuration object returned by {@link getFluidTestMochaConfig}.\n */\nexport interface FluidTestMochaConfig {\n\trecursive: boolean;\n\trequire: string[];\n\t\"unhandled-rejections\": string;\n\t\"fail-zero\": boolean;\n\tignore: string[];\n\t\"node-option\": string[];\n\tspec: string;\n\texit?: boolean;\n\ttimeout?: number | string;\n\tfgrep?: string[];\n\treporter?: string;\n\treporterOptions?: string[];\n\t\"reporter-options\"?: string[];\n\t\"forbid-only\"?: boolean;\n}\n\n/**\n * Get the mocha configuration for running tests using the conventions followed in the Fluid Framework repository.\n *\n * @param packageDir - the directory of the package, typically set using `__dirname`\n * @param additionalRequiredModules - modules to require in addition to the standard set.\n * @param testReportPrefix - prefix for the test output report file names.\n * @remarks\n * Additional configuration can be provided via environment variables: see {@link file://./README.md}.\n *\n * Users desiring exact control over the `spec` from the CLI should delete or replace the spec from the returned config, since mocha's behavior is to extend it, not override it.\n */\nexport function getFluidTestMochaConfig(\n\tpackageDir: string,\n\tadditionalRequiredModules?: string[],\n\ttestReportPrefix?: string,\n): FluidTestMochaConfig {\n\tconst requiredModules = [\n\t\t// General mocha setup e.g. suppresses console.log,\n\t\t// This has to be before others (except logger) so that registerMochaTestWrapperFuncs is available\n\t\t\"@fluid-internal/mocha-test-setup\",\n\t\t\"source-map-support/register\",\n\t\t...(additionalRequiredModules ?? []),\n\t];\n\n\tif (process.env.FLUID_TEST_LOGGER_PKG_SPECIFIER !== undefined) {\n\t\t// Inject implementation of createTestLogger, put it first before mocha-test-setup\n\t\trequiredModules.unshift(process.env.FLUID_TEST_LOGGER_PKG_SPECIFIER);\n\t}\n\n\tlet reportPrefix = testReportPrefix;\n\tlet defaultSpec = \"lib/test\";\n\tif (process.env.FLUID_TEST_MODULE_SYSTEM === \"CJS\") {\n\t\tdefaultSpec = \"dist/test\";\n\t\tconst testVariant = process.env.FLUID_TEST_VARIANT;\n\t\tprocess.env.FLUID_TEST_VARIANT = testVariant !== undefined ? `CJS,${testVariant}` : \"CJS\";\n\t\treportPrefix = reportPrefix !== undefined ? `${reportPrefix}-CJS` : \"CJS\";\n\t}\n\n\tconst config: FluidTestMochaConfig = {\n\t\t\"recursive\": true,\n\t\t\"require\": requiredModules,\n\t\t\"unhandled-rejections\": \"strict\",\n\t\t// Fail the test run if no tests are found/run. This catches cases where test files fail to\n\t\t// load silently (e.g. due to broken imports), which would otherwise produce a green \"0 passing\"\n\t\t// result with exit code 0.\n\t\t\"fail-zero\": true,\n\t\tignore: [\n\t\t\t// Ignore \"tools\" which are scripts intended to be run, not part of the test suite.\n\t\t\t\"**/*.tool.{js,cjs,mjs}\",\n\t\t],\n\t\t\"node-option\": [\n\t\t\t// Allow test-only indexes to be imported. Search the FF repo for package.json files with this condition to see example usage.\n\t\t\t\"conditions=allow-ff-test-exports\",\n\t\t\t// Performance tests benefit from having access to GC, and memory tests require it.\n\t\t\t// Exposing it here avoids all packages which do perf testing from having to expose it.\n\t\t\t// Note that since \"node-option\" is explicitly set,\n\t\t\t// these must be provided here and not via mocha's --v8-expose-gc.\n\t\t\t\"expose-gc\",\n\t\t],\n\t\tspec: process.env.MOCHA_SPEC ?? defaultSpec,\n\t};\n\n\t// This approach to checking for this flag is consistent with some (but not all) others in this file,\n\t// but not with tools/benchmark/src/Configuration.ts.\n\t// For now, undefined, \"1\" and \"true\" should work consistently across all known use, and \"1\" is the main form we explicitly use.\n\t// All these should be made to match, see AB#69054.\n\tif (process.env.FLUID_TEST_PERF_MODE !== undefined) {\n\t\tif (process.env.SILENT_TEST_OUTPUT === undefined) {\n\t\t\tconsole.log(`Running performance tests...`);\n\t\t}\n\n\t\t// Some perf tests are often quite slow, and we don't want to lose the data by hitting a timeout.\n\t\t// This is 1000 seconds, so ~16 minutes.\n\t\t// This can be overridden by setting FLUID_TEST_TIMEOUT to a different value if desired.\n\t\tconfig.timeout = 1_000_000;\n\n\t\t// If there is no filter specified, limit to benchmarks.\n\t\t// If mocha allowed multiple filters to all be applied to further narrow results, we would do this unconditionally.\n\t\tif (!(process.argv.includes(\"--fgrep\") || process.argv.includes(\"--grep\"))) {\n\t\t\tconfig.fgrep = [\"@Benchmark\"];\n\t\t}\n\n\t\tconfig.reporter = \"@fluid-tools/benchmark/dist/mocha/Reporter.js\";\n\t\tif (!process.argv.includes(\"--reporterOptions\")) {\n\t\t\t// If report options were not specified, default to:\n\t\t\tconfig.reporterOptions = [\"reportFile=./benchmarkOutput.json\"];\n\t\t}\n\t} else {\n\t\tconst packageJsonPath = path.join(packageDir, \"package.json\");\n\t\tconst packageJson = JSON.parse(readFileSync(packageJsonPath, \"utf8\")) as {\n\t\t\tname: string;\n\t\t};\n\t\tconfig.reporter = `mocha-multi-reporters`;\n\t\t// See https://www.npmjs.com/package/mocha-multi-reporters#cmroutput-option\n\t\tconst outputFilePrefix = reportPrefix !== undefined ? `${reportPrefix}-` : \"\";\n\t\tif (process.env.SILENT_TEST_OUTPUT === undefined) {\n\t\t\tconsole.log(\n\t\t\t\t`Writing test results relative to package to nyc/${outputFilePrefix}junit-report.xml`,\n\t\t\t);\n\t\t}\n\t\tconst suiteName =\n\t\t\treportPrefix !== undefined ? `${packageJson.name} - ${reportPrefix}` : packageJson.name;\n\t\tconfig[\"reporter-options\"] = [\n\t\t\t`configFile=${path.join(\n\t\t\t\timport.meta.dirname,\n\t\t\t\t\"..\",\n\t\t\t\t\"test-config.json\",\n\t\t\t)},cmrOutput=xunit+output+${outputFilePrefix}:xunit+suiteName+${suiteName}`,\n\t\t];\n\t}\n\n\tif (process.env.FLUID_TEST_TIMEOUT !== undefined) {\n\t\tconfig.timeout = process.env.FLUID_TEST_TIMEOUT;\n\t}\n\n\tif (process.env.FLUID_TEST_FORBID_ONLY !== undefined) {\n\t\tconfig[\"forbid-only\"] = true;\n\t}\n\n\treturn config;\n}\n"]}

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluid-internal/mocha-test-setup";
-export declare const pkgVersion = "2.101.1";
+export declare const pkgVersion = "2.103.0";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluid-internal/mocha-test-setup";
-export const pkgVersion = "2.101.1";
+export const pkgVersion = "2.103.0";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,kCAAkC,CAAC;AAC1D,MAAM,CAAC,MAAM,UAAU,GAAG,SAAS,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluid-internal/mocha-test-setup\";\nexport const pkgVersion = \"2.101.1\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,kCAAkC,CAAC;AAC1D,MAAM,CAAC,MAAM,UAAU,GAAG,SAAS,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluid-internal/mocha-test-setup\";\nexport const pkgVersion = \"2.103.0\";\n"]}

package/mocharc-common-cjswrapper.cjs

@@ -0,0 +1,15 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+// This file exists to preserve CommonJS default export compatibility for the mocharc-common entrypoint.
+// Once all consumers are using named imports, this file can be removed and all conditions can point
+// directly to the ESM file. attw mocharc-common exclusion can also be removed at that time.
+
+"use strict";
+
+const { getFluidTestMochaConfig } = require("./lib/mocharcCommon.js");
+
+module.exports = getFluidTestMochaConfig;
+module.exports.getFluidTestMochaConfig = getFluidTestMochaConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-internal/mocha-test-setup",
-  "version": "2.101.1",
+  "version": "2.103.0",
   "description": "Utilities for Fluid tests",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -14,24 +14,16 @@
   "type": "module",
   "exports": {
     ".": {
-      "import": {
-        "types": "./lib/index.d.ts",
-        "default": "./lib/index.js"
-      },
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      }
+      "default": "./lib/index.js"
     },
     "./mocharc-common": {
-      "require": "./mocharc-common.cjs"
+      "require": "./mocharc-common-cjswrapper.cjs",
+      "default": "./lib/mocharcCommon.js"
     }
   },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
   "dependencies": {
-    "@fluid-internal/test-driver-definitions": "~2.101.1",
-    "@fluidframework/core-interfaces": "~2.101.1",
+    "@fluid-internal/test-driver-definitions": "~2.103.0",
+    "@fluidframework/core-interfaces": "~2.103.0",
     "mocha": "^11.7.5",
     "source-map-support": "^0.5.21"
   },
@@ -52,6 +44,17 @@
     "rimraf": "^6.1.3",
     "typescript": "~5.4.5"
   },
+  "fluidBuild": {
+    "_tasks_comment": "tsc is configured to depend on build:esnext task as all CommonJS consumers expect mocha support which is implemented in ESM. Building ESM when CommonJS is requested ensures the implementation expectation is satisfied.",
+    "tasks": {
+      "tsc": {
+        "dependsOn": [
+          "build:esnext"
+        ],
+        "script": false
+      }
+    }
+  },
   "typeValidation": {
     "disabled": true
   },
@@ -63,11 +66,10 @@
     "build:docs": "api-extractor run --local",
     "build:esnext": "tsc --project ./tsconfig.json",
     "build:genver": "gen-version",
-    "check:are-the-types-wrong": "attw --pack . --exclude-entrypoints ./mocharc-common",
+    "check:are-the-types-wrong": "attw --pack . --profile node16 --exclude-entrypoints ./mocharc-common",
     "check:biome": "biome check .",
     "check:exports": "concurrently \"npm:check:exports:*\"",
     "check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
-    "check:exports:cjs:index": "api-extractor run --config api-extractor/api-extractor-lint-index.cjs.json",
     "check:exports:esm:index": "api-extractor run --config api-extractor/api-extractor-lint-index.esm.json",
     "check:format": "npm run check:biome",
     "ci:build:docs": "api-extractor run",
@@ -77,7 +79,6 @@
     "format": "npm run format:biome",
     "format:biome": "biome check . --write",
     "lint": "fluid-build . --task lint",
-    "lint:fix": "fluid-build . --task eslint:fix --task format",
-    "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist"
+    "lint:fix": "fluid-build . --task eslint:fix --task format"
   }
 }

package/{mocharc-common.cjs → src/mocharcCommon.ts}

@@ -3,44 +3,68 @@
  * Licensed under the MIT License.
  */
 
-"use strict";
+import { readFileSync } from "node:fs";
+import path from "node:path";
 
-const path = require("path");
+/**
+ * Mocha configuration object returned by {@link getFluidTestMochaConfig}.
+ */
+export interface FluidTestMochaConfig {
+	recursive: boolean;
+	require: string[];
+	"unhandled-rejections": string;
+	"fail-zero": boolean;
+	ignore: string[];
+	"node-option": string[];
+	spec: string;
+	exit?: boolean;
+	timeout?: number | string;
+	fgrep?: string[];
+	reporter?: string;
+	reporterOptions?: string[];
+	"reporter-options"?: string[];
+	"forbid-only"?: boolean;
+}
 
 /**
  * Get the mocha configuration for running tests using the conventions followed in the Fluid Framework repository.
  *
- * @param {string} packageDir - the directory of the package, typically set using `__dirname`
- * @param {string[]} additionalRequiredModules - modules to require in addition to the standard set.
- * @param {string} testReportPrefix - prefix for the test output report file names.
+ * @param packageDir - the directory of the package, typically set using `__dirname`
+ * @param additionalRequiredModules - modules to require in addition to the standard set.
+ * @param testReportPrefix - prefix for the test output report file names.
  * @remarks
  * Additional configuration can be provided via environment variables: see {@link file://./README.md}.
  *
  * Users desiring exact control over the `spec` from the CLI should delete or replace the spec from the returned config, since mocha's behavior is to extend it, not override it.
  */
-function getFluidTestMochaConfig(packageDir, additionalRequiredModules, testReportPrefix) {
+export function getFluidTestMochaConfig(
+	packageDir: string,
+	additionalRequiredModules?: string[],
+	testReportPrefix?: string,
+): FluidTestMochaConfig {
 	const requiredModules = [
 		// General mocha setup e.g. suppresses console.log,
 		// This has to be before others (except logger) so that registerMochaTestWrapperFuncs is available
 		"@fluid-internal/mocha-test-setup",
 		"source-map-support/register",
-		...(additionalRequiredModules ? additionalRequiredModules : []),
+		...(additionalRequiredModules ?? []),
 	];
 
-	if (process.env.FLUID_TEST_LOGGER_PKG_SPECIFIER) {
+	if (process.env.FLUID_TEST_LOGGER_PKG_SPECIFIER !== undefined) {
 		// Inject implementation of createTestLogger, put it first before mocha-test-setup
 		requiredModules.unshift(process.env.FLUID_TEST_LOGGER_PKG_SPECIFIER);
 	}
 
+	let reportPrefix = testReportPrefix;
 	let defaultSpec = "lib/test";
 	if (process.env.FLUID_TEST_MODULE_SYSTEM === "CJS") {
 		defaultSpec = "dist/test";
 		const testVariant = process.env.FLUID_TEST_VARIANT;
 		process.env.FLUID_TEST_VARIANT = testVariant !== undefined ? `CJS,${testVariant}` : "CJS";
-		testReportPrefix = testReportPrefix !== undefined ? `${testReportPrefix}-CJS` : "CJS";
+		reportPrefix = reportPrefix !== undefined ? `${reportPrefix}-CJS` : "CJS";
 	}
 
-	const config = {
+	const config: FluidTestMochaConfig = {
 		"recursive": true,
 		"require": requiredModules,
 		"unhandled-rejections": "strict",
@@ -69,50 +93,52 @@ function getFluidTestMochaConfig(packageDir, additionalRequiredModules, testRepo
 	// For now, undefined, "1" and "true" should work consistently across all known use, and "1" is the main form we explicitly use.
 	// All these should be made to match, see AB#69054.
 	if (process.env.FLUID_TEST_PERF_MODE !== undefined) {
-		if (!process.env.SILENT_TEST_OUTPUT) {
+		if (process.env.SILENT_TEST_OUTPUT === undefined) {
 			console.log(`Running performance tests...`);
 		}
 
 		// Some perf tests are often quite slow, and we don't want to lose the data by hitting a timeout.
 		// This is 1000 seconds, so ~16 minutes.
 		// This can be overridden by setting FLUID_TEST_TIMEOUT to a different value if desired.
-		config["timeout"] = 1_000_000;
+		config.timeout = 1_000_000;
 
 		// If there is no filter specified, limit to benchmarks.
 		// If mocha allowed multiple filters to all be applied to further narrow results, we would do this unconditionally.
 		if (!(process.argv.includes("--fgrep") || process.argv.includes("--grep"))) {
-			config["fgrep"] = ["@Benchmark"];
+			config.fgrep = ["@Benchmark"];
 		}
 
-		config["reporter"] = "@fluid-tools/benchmark/dist/mocha/Reporter.js";
+		config.reporter = "@fluid-tools/benchmark/dist/mocha/Reporter.js";
 		if (!process.argv.includes("--reporterOptions")) {
 			// If report options were not specified, default to:
-			config["reporterOptions"] = ["reportFile=./benchmarkOutput.json"];
+			config.reporterOptions = ["reportFile=./benchmarkOutput.json"];
 		}
 	} else {
-		const packageJson = require(`${packageDir}/package.json`);
-		config["reporter"] = `mocha-multi-reporters`;
+		const packageJsonPath = path.join(packageDir, "package.json");
+		const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf8")) as {
+			name: string;
+		};
+		config.reporter = `mocha-multi-reporters`;
 		// See https://www.npmjs.com/package/mocha-multi-reporters#cmroutput-option
-		const outputFilePrefix = testReportPrefix !== undefined ? `${testReportPrefix}-` : "";
-		if (!process.env.SILENT_TEST_OUTPUT) {
+		const outputFilePrefix = reportPrefix !== undefined ? `${reportPrefix}-` : "";
+		if (process.env.SILENT_TEST_OUTPUT === undefined) {
 			console.log(
 				`Writing test results relative to package to nyc/${outputFilePrefix}junit-report.xml`,
 			);
 		}
 		const suiteName =
-			testReportPrefix !== undefined
-				? `${packageJson.name} - ${testReportPrefix}`
-				: packageJson.name;
+			reportPrefix !== undefined ? `${packageJson.name} - ${reportPrefix}` : packageJson.name;
 		config["reporter-options"] = [
 			`configFile=${path.join(
-				__dirname,
+				import.meta.dirname,
+				"..",
 				"test-config.json",
 			)},cmrOutput=xunit+output+${outputFilePrefix}:xunit+suiteName+${suiteName}`,
 		];
 	}
 
 	if (process.env.FLUID_TEST_TIMEOUT !== undefined) {
-		config["timeout"] = process.env.FLUID_TEST_TIMEOUT;
+		config.timeout = process.env.FLUID_TEST_TIMEOUT;
 	}
 
 	if (process.env.FLUID_TEST_FORBID_ONLY !== undefined) {
@@ -121,5 +147,3 @@ function getFluidTestMochaConfig(packageDir, additionalRequiredModules, testRepo
 
 	return config;
 }
-
-module.exports = getFluidTestMochaConfig;

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluid-internal/mocha-test-setup";
-export const pkgVersion = "2.101.1";
+export const pkgVersion = "2.103.0";

package/dist/index.d.ts

@@ -1,6 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-export { mochaHooks } from "./mochaHooks.js";
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/index.js

@@ -1,10 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mochaHooks = void 0;
-var mochaHooks_js_1 = require("./mochaHooks.js");
-Object.defineProperty(exports, "mochaHooks", { enumerable: true, get: function () { return mochaHooks_js_1.mochaHooks; } });
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iDAA6C;AAApC,2GAAA,UAAU,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { mochaHooks } from \"./mochaHooks.js\";\n"]}

package/dist/mochaHooks.d.ts

@@ -1,15 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-/// <reference types="mocha" />
-/**
- * @internal
- */
-export declare const mochaHooks: {
-    beforeAll(): Promise<void>;
-    beforeEach(this: Mocha.Context): void;
-    afterEach(this: Mocha.Context): void;
-    afterAll(this: Mocha.Context): Promise<void>;
-};
-//# sourceMappingURL=mochaHooks.d.ts.map

package/dist/mochaHooks.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"mochaHooks.d.ts","sourceRoot":"","sources":["../src/mochaHooks.ts"],"names":[],"mappings":"AAAA;;;GAGG;;AA0FH;;GAEG;AACH,eAAO,MAAM,UAAU;;qBAkCL,MAAM,OAAO;oBAwBd,MAAM,OAAO;mBAqBR,MAAM,OAAO;CAMlC,CAAC"}

package/dist/mochaHooks.js

@@ -1,193 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mochaHooks = void 0;
-const mochaModule = __importStar(require("mocha"));
-const packageVersion_js_1 = require("./packageVersion.js");
-// This will enable capturing the full stack for errors.
-// Since this package is only used when we run tests, capturing the full stack is worth it.
-// In non-test environments we need to be more cautious as this will incur a perf impact when errors are
-// thrown and will take more storage in any logging sink.
-// https://v8.dev/docs/stack-trace-api
-Error.stackTraceLimit = Number.POSITIVE_INFINITY;
-const testVariant = process.env.FLUID_TEST_VARIANT;
-const envLoggerProps = process.env.FLUID_LOGGER_PROPS != null
-    ? JSON.parse(process.env.FLUID_LOGGER_PROPS)
-    : undefined;
-const _global = global;
-/**
- * A logger that adds context about the current test run to all events logged through it, like the test variant being
- * run (odsp, r11s, etc) and the name of the current test (while in the context of a particular test running).
- */
-class FluidTestRunLogger {
-    send(event) {
-        // TODO: Remove when issue #7061 is resolved.
-        // Don't log this event as we generate too much.
-        if (event.eventName === "fluid:telemetry:RouterliciousDriver:readBlob_end") {
-            return;
-        }
-        if (this.currentTestName !== undefined) {
-            event.testName = this.currentTestName;
-        }
-        event.testVariant = testVariant;
-        this.parentLogger.send({
-            ...event,
-            // Setting hostname to pkgName is the behavior we had for a long time, so keeping it just in case.
-            // But prefer a value set through FLUID_LOGGER_PROPS if it exists.
-            hostName: envLoggerProps?.hostName ?? packageVersion_js_1.pkgName,
-            testEnvProps: JSON.stringify(envLoggerProps),
-        });
-    }
-    async flush() {
-        return this.parentLogger.flush();
-    }
-    constructor(parentLogger) {
-        this.parentLogger = parentLogger;
-    }
-    /**
-     * Sets the test that is currently running.
-     * The test name will be included in all events logged through the logger until {@link clearCurrentTest} is called.
-     * @param testName - The name of the test that is currently running.
-     */
-    setCurrentTest(testName) {
-        this.currentTestName = testName;
-    }
-    /**
-     * Clears the test that is currently running.
-     * Must be called after a given test has completed so that events logged outside the context of a test
-     * don't include the name of the last test that ran.
-     */
-    clearCurrentTest() {
-        this.currentTestName = undefined;
-    }
-}
-const nullLogger = {
-    send: () => { },
-    flush: async () => { },
-};
-// Keep references to the original console functions so we can restore them after each test.
-const log = console.log;
-const error = console.log;
-const warn = console.warn;
-let testLogger;
-/**
- * The amount of time to wait after logging an event before flushing the logger.
- * This amount was decided after doing tests with different values. See AB#44378 for details.
- */
-const AFTER_FLUSH_DELAY_MS = 1250;
-/**
- * @internal
- */
-exports.mochaHooks = {
-    async beforeAll() {
-        // Code in our tests will call the global `getTestLogger` function to get a logger to use.
-        // First we call the version of that function that was (potentially) injected dynamicaly to get the logger that it
-        // provides and wrap it with a more intelligent logger which adds test-run-related context to all events logged
-        // through it. See the documentation on `FluidTestRunLogger` for details.
-        let originalLogger;
-        if (process.env.FLUID_TEST_LOGGER_PKG_SPECIFIER === undefined) {
-            originalLogger = nullLogger;
-        }
-        else {
-            const { createTestLogger } = await import(process.env.FLUID_TEST_LOGGER_PKG_SPECIFIER);
-            if (typeof createTestLogger !== "function") {
-                throw new TypeError(`Expected package '${process.env.FLUID_TEST_LOGGER_PKG_SPECIFIER}' to export a function, but got an object of type '${typeof createTestLogger}' instead`);
-            }
-            else {
-                originalLogger = createTestLogger({
-                    afterFlushDelayMs: AFTER_FLUSH_DELAY_MS,
-                    throttleLogging: false,
-                });
-            }
-        }
-        testLogger = new FluidTestRunLogger(originalLogger);
-        // Then we redefine `getTestLogger` so it returns the wrapper logger.
-        // NOTE: if we have other global mocha hooks defined somewhere, they include a `beforeEach` hook, and the module in
-        // which they are defined gets loaded before this one, then if that `beforeEach` hook calls `getTestLogger` the logger
-        // it will get will still have a lot of the test-run-related context, but not the name of the current test, because
-        // it will run before the `beforeEach` hook in this file which sets that.
-        _global.getTestLogger = () => testLogger;
-    },
-    beforeEach() {
-        // If not in verbose mode, suppress console output while the current test runs.
-        if (process.env.FLUID_TEST_VERBOSE === undefined) {
-            console.log = () => { };
-            console.error = () => { };
-            console.warn = () => { };
-        }
-        ensureTestRunLoggerIsInitialized(testLogger);
-        let testTitle = "";
-        if (this.currentTest !== undefined) {
-            if (testVariant !== undefined) {
-                this.currentTest.title = `[${testVariant}] ${this.currentTest.title}`;
-            }
-            testTitle = this.currentTest.fullTitle();
-        }
-        testLogger.setCurrentTest(testTitle);
-        testLogger.send({
-            category: "generic",
-            eventName: "fluid:telemetry:Test_start",
-        });
-    },
-    afterEach() {
-        ensureTestRunLoggerIsInitialized(testLogger);
-        testLogger.send({
-            category: "generic",
-            eventName: "fluid:telemetry:Test_end",
-            state: this.currentTest?.state,
-            duration: this.currentTest?.duration,
-            timedOut: this.currentTest?.timedOut,
-            error: this.currentTest?.err?.message,
-            stack: this.currentTest?.err?.stack,
-        });
-        // Restore console output now that the current test is done running.
-        console.log = log;
-        console.error = error;
-        console.warn = warn;
-        // Clear the current test from the logger. Important so if anything calls `getTestLogger` outside the context of a
-        // test (e.g. during a `before` or `after` hook), it doesn't log events with the name of the last test that ran.
-        testLogger.clearCurrentTest();
-    },
-    async afterAll() {
-        // Allow 5 seconds for the logger to flush.
-        this.timeout(5000);
-        // After all tests ran, flush the logger to ensure all events are sent before the process exits.
-        await testLogger.flush();
-    },
-};
-globalThis.getMochaModule = () => {
-    return mochaModule;
-};
-function ensureTestRunLoggerIsInitialized(loggerToTest) {
-    if (loggerToTest instanceof FluidTestRunLogger) {
-        return true;
-    }
-    throw new Error("Test run logger is not initialized");
-}
-//# sourceMappingURL=mochaHooks.js.map

package/dist/mochaHooks.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"mochaHooks.js","sourceRoot":"","sources":["../src/mochaHooks.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;AAIH,mDAAqC;AAErC,2DAA8C;AAE9C,wDAAwD;AACxD,2FAA2F;AAC3F,wGAAwG;AACxG,yDAAyD;AACzD,sCAAsC;AACtC,KAAK,CAAC,eAAe,GAAG,MAAM,CAAC,iBAAiB,CAAC;AAEjD,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;AACnD,MAAM,cAAc,GACnB,OAAO,CAAC,GAAG,CAAC,kBAAkB,IAAI,IAAI;IACrC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;IAC5C,CAAC,CAAC,SAAS,CAAC;AAEd,MAAM,OAAO,GAAQ,MAAM,CAAC;AAE5B;;;GAGG;AACH,MAAM,kBAAkB;IAGvB,IAAI,CAAC,KAA0B;QAC9B,6CAA6C;QAC7C,gDAAgD;QAChD,IAAI,KAAK,CAAC,SAAS,KAAK,kDAAkD,EAAE,CAAC;YAC5E,OAAO;QACR,CAAC;QAED,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACxC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC;QACvC,CAAC;QACD,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;YACtB,GAAG,KAAK;YACR,kGAAkG;YAClG,kEAAkE;YAClE,QAAQ,EAAE,cAAc,EAAE,QAAQ,IAAI,2BAAO;YAC7C,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC;SAC5C,CAAC,CAAC;IACJ,CAAC;IACD,KAAK,CAAC,KAAK;QACV,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IACD,YAA6B,YAAsC;QAAtC,iBAAY,GAAZ,YAAY,CAA0B;IAAG,CAAC;IAEvE;;;;OAIG;IACI,cAAc,CAAC,QAAgB;QACrC,IAAI,CAAC,eAAe,GAAG,QAAQ,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACI,gBAAgB;QACtB,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;IAClC,CAAC;CACD;AACD,MAAM,UAAU,GAA6B;IAC5C,IAAI,EAAE,GAAS,EAAE,GAAE,CAAC;IACpB,KAAK,EAAE,KAAK,IAAmB,EAAE,GAAE,CAAC;CACpC,CAAC;AAEF,4FAA4F;AAC5F,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;AACxB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;AAC1B,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;AAE1B,IAAI,UAA8B,CAAC;AAEnC;;;GAGG;AACH,MAAM,oBAAoB,GAAG,IAAI,CAAC;AAElC;;GAEG;AACU,QAAA,UAAU,GAAG;IACzB,KAAK,CAAC,SAAS;QACd,0FAA0F;QAE1F,kHAAkH;QAClH,+GAA+G;QAC/G,yEAAyE;QACzE,IAAI,cAAwC,CAAC;QAE7C,IAAI,OAAO,CAAC,GAAG,CAAC,+BAA+B,KAAK,SAAS,EAAE,CAAC;YAC/D,cAAc,GAAG,UAAU,CAAC;QAC7B,CAAC;aAAM,CAAC;YACP,MAAM,EAAE,gBAAgB,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;YACvF,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE,CAAC;gBAC5C,MAAM,IAAI,SAAS,CAClB,qBAAqB,OAAO,CAAC,GAAG,CAAC,+BAA+B,sDAAsD,OAAO,gBAAgB,WAAW,CACxJ,CAAC;YACH,CAAC;iBAAM,CAAC;gBACP,cAAc,GAAG,gBAAgB,CAAC;oBACjC,iBAAiB,EAAE,oBAAoB;oBACvC,eAAe,EAAE,KAAK;iBACtB,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;QAED,UAAU,GAAG,IAAI,kBAAkB,CAAC,cAAc,CAAC,CAAC;QAEpD,qEAAqE;QACrE,mHAAmH;QACnH,sHAAsH;QACtH,mHAAmH;QACnH,yEAAyE;QACzE,OAAO,CAAC,aAAa,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC;IAC1C,CAAC;IACD,UAAU;QACT,+EAA+E;QAC/E,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;YAClD,OAAO,CAAC,GAAG,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;YACvB,OAAO,CAAC,KAAK,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;YACzB,OAAO,CAAC,IAAI,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;QACzB,CAAC;QAED,gCAAgC,CAAC,UAAU,CAAC,CAAC;QAE7C,IAAI,SAAS,GAAG,EAAE,CAAC;QACnB,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACpC,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC/B,IAAI,CAAC,WAAW,CAAC,KAAK,GAAG,IAAI,WAAW,KAAK,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;YACvE,CAAC;YACD,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC;QAC1C,CAAC;QACD,UAAU,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;QAErC,UAAU,CAAC,IAAI,CAAC;YACf,QAAQ,EAAE,SAAS;YACnB,SAAS,EAAE,4BAA4B;SACvC,CAAC,CAAC;IACJ,CAAC;IACD,SAAS;QACR,gCAAgC,CAAC,UAAU,CAAC,CAAC;QAC7C,UAAU,CAAC,IAAI,CAAC;YACf,QAAQ,EAAE,SAAS;YACnB,SAAS,EAAE,0BAA0B;YACrC,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK;YAC9B,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE,QAAQ;YACpC,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE,QAAQ;YACpC,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE,OAAO;YACrC,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE,KAAK;SACnC,CAAC,CAAC;QAEH,oEAAoE;QACpE,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;QAClB,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;QACtB,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;QAEpB,kHAAkH;QAClH,gHAAgH;QAChH,UAAU,CAAC,gBAAgB,EAAE,CAAC;IAC/B,CAAC;IACD,KAAK,CAAC,QAAQ;QACb,2CAA2C;QAC3C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnB,gGAAgG;QAChG,MAAM,UAAU,CAAC,KAAK,EAAE,CAAC;IAC1B,CAAC;CACD,CAAC;AAEF,UAAU,CAAC,cAAc,GAAG,GAAG,EAAE;IAChC,OAAO,WAAW,CAAC;AACpB,CAAC,CAAC;AAEF,SAAS,gCAAgC,CACxC,YAA4C;IAE5C,IAAI,YAAY,YAAY,kBAAkB,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC;IACb,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;AACvD,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ITelemetryBufferedLogger } from \"@fluid-internal/test-driver-definitions\";\nimport type { ITelemetryBaseEvent } from \"@fluidframework/core-interfaces\";\nimport * as mochaModule from \"mocha\";\n\nimport { pkgName } from \"./packageVersion.js\";\n\n// This will enable capturing the full stack for errors.\n// Since this package is only used when we run tests, capturing the full stack is worth it.\n// In non-test environments we need to be more cautious as this will incur a perf impact when errors are\n// thrown and will take more storage in any logging sink.\n// https://v8.dev/docs/stack-trace-api\nError.stackTraceLimit = Number.POSITIVE_INFINITY;\n\nconst testVariant = process.env.FLUID_TEST_VARIANT;\nconst envLoggerProps =\n\tprocess.env.FLUID_LOGGER_PROPS != null\n\t\t? JSON.parse(process.env.FLUID_LOGGER_PROPS)\n\t\t: undefined;\n\nconst _global: any = global;\n\n/**\n * A logger that adds context about the current test run to all events logged through it, like the test variant being\n * run (odsp, r11s, etc) and the name of the current test (while in the context of a particular test running).\n */\nclass FluidTestRunLogger implements ITelemetryBufferedLogger {\n\tprivate currentTestName: string | undefined;\n\n\tsend(event: ITelemetryBaseEvent): void {\n\t\t// TODO: Remove when issue #7061 is resolved.\n\t\t// Don't log this event as we generate too much.\n\t\tif (event.eventName === \"fluid:telemetry:RouterliciousDriver:readBlob_end\") {\n\t\t\treturn;\n\t\t}\n\n\t\tif (this.currentTestName !== undefined) {\n\t\t\tevent.testName = this.currentTestName;\n\t\t}\n\t\tevent.testVariant = testVariant;\n\t\tthis.parentLogger.send({\n\t\t\t...event,\n\t\t\t// Setting hostname to pkgName is the behavior we had for a long time, so keeping it just in case.\n\t\t\t// But prefer a value set through FLUID_LOGGER_PROPS if it exists.\n\t\t\thostName: envLoggerProps?.hostName ?? pkgName,\n\t\t\ttestEnvProps: JSON.stringify(envLoggerProps),\n\t\t});\n\t}\n\tasync flush(): Promise<void> {\n\t\treturn this.parentLogger.flush();\n\t}\n\tconstructor(private readonly parentLogger: ITelemetryBufferedLogger) {}\n\n\t/**\n\t * Sets the test that is currently running.\n\t * The test name will be included in all events logged through the logger until {@link clearCurrentTest} is called.\n\t * @param testName - The name of the test that is currently running.\n\t */\n\tpublic setCurrentTest(testName: string): void {\n\t\tthis.currentTestName = testName;\n\t}\n\n\t/**\n\t * Clears the test that is currently running.\n\t * Must be called after a given test has completed so that events logged outside the context of a test\n\t * don't include the name of the last test that ran.\n\t */\n\tpublic clearCurrentTest(): void {\n\t\tthis.currentTestName = undefined;\n\t}\n}\nconst nullLogger: ITelemetryBufferedLogger = {\n\tsend: (): void => {},\n\tflush: async (): Promise<void> => {},\n};\n\n// Keep references to the original console functions so we can restore them after each test.\nconst log = console.log;\nconst error = console.log;\nconst warn = console.warn;\n\nlet testLogger: FluidTestRunLogger;\n\n/**\n * The amount of time to wait after logging an event before flushing the logger.\n * This amount was decided after doing tests with different values. See AB#44378 for details.\n */\nconst AFTER_FLUSH_DELAY_MS = 1250;\n\n/**\n * @internal\n */\nexport const mochaHooks = {\n\tasync beforeAll() {\n\t\t// Code in our tests will call the global `getTestLogger` function to get a logger to use.\n\n\t\t// First we call the version of that function that was (potentially) injected dynamicaly to get the logger that it\n\t\t// provides and wrap it with a more intelligent logger which adds test-run-related context to all events logged\n\t\t// through it. See the documentation on `FluidTestRunLogger` for details.\n\t\tlet originalLogger: ITelemetryBufferedLogger;\n\n\t\tif (process.env.FLUID_TEST_LOGGER_PKG_SPECIFIER === undefined) {\n\t\t\toriginalLogger = nullLogger;\n\t\t} else {\n\t\t\tconst { createTestLogger } = await import(process.env.FLUID_TEST_LOGGER_PKG_SPECIFIER);\n\t\t\tif (typeof createTestLogger !== \"function\") {\n\t\t\t\tthrow new TypeError(\n\t\t\t\t\t`Expected package '${process.env.FLUID_TEST_LOGGER_PKG_SPECIFIER}' to export a function, but got an object of type '${typeof createTestLogger}' instead`,\n\t\t\t\t);\n\t\t\t} else {\n\t\t\t\toriginalLogger = createTestLogger({\n\t\t\t\t\tafterFlushDelayMs: AFTER_FLUSH_DELAY_MS,\n\t\t\t\t\tthrottleLogging: false,\n\t\t\t\t});\n\t\t\t}\n\t\t}\n\n\t\ttestLogger = new FluidTestRunLogger(originalLogger);\n\n\t\t// Then we redefine `getTestLogger` so it returns the wrapper logger.\n\t\t// NOTE: if we have other global mocha hooks defined somewhere, they include a `beforeEach` hook, and the module in\n\t\t// which they are defined gets loaded before this one, then if that `beforeEach` hook calls `getTestLogger` the logger\n\t\t// it will get will still have a lot of the test-run-related context, but not the name of the current test, because\n\t\t// it will run before the `beforeEach` hook in this file which sets that.\n\t\t_global.getTestLogger = () => testLogger;\n\t},\n\tbeforeEach(this: Mocha.Context) {\n\t\t// If not in verbose mode, suppress console output while the current test runs.\n\t\tif (process.env.FLUID_TEST_VERBOSE === undefined) {\n\t\t\tconsole.log = () => {};\n\t\t\tconsole.error = () => {};\n\t\t\tconsole.warn = () => {};\n\t\t}\n\n\t\tensureTestRunLoggerIsInitialized(testLogger);\n\n\t\tlet testTitle = \"\";\n\t\tif (this.currentTest !== undefined) {\n\t\t\tif (testVariant !== undefined) {\n\t\t\t\tthis.currentTest.title = `[${testVariant}] ${this.currentTest.title}`;\n\t\t\t}\n\t\t\ttestTitle = this.currentTest.fullTitle();\n\t\t}\n\t\ttestLogger.setCurrentTest(testTitle);\n\n\t\ttestLogger.send({\n\t\t\tcategory: \"generic\",\n\t\t\teventName: \"fluid:telemetry:Test_start\",\n\t\t});\n\t},\n\tafterEach(this: Mocha.Context) {\n\t\tensureTestRunLoggerIsInitialized(testLogger);\n\t\ttestLogger.send({\n\t\t\tcategory: \"generic\",\n\t\t\teventName: \"fluid:telemetry:Test_end\",\n\t\t\tstate: this.currentTest?.state,\n\t\t\tduration: this.currentTest?.duration,\n\t\t\ttimedOut: this.currentTest?.timedOut,\n\t\t\terror: this.currentTest?.err?.message,\n\t\t\tstack: this.currentTest?.err?.stack,\n\t\t});\n\n\t\t// Restore console output now that the current test is done running.\n\t\tconsole.log = log;\n\t\tconsole.error = error;\n\t\tconsole.warn = warn;\n\n\t\t// Clear the current test from the logger. Important so if anything calls `getTestLogger` outside the context of a\n\t\t// test (e.g. during a `before` or `after` hook), it doesn't log events with the name of the last test that ran.\n\t\ttestLogger.clearCurrentTest();\n\t},\n\tasync afterAll(this: Mocha.Context) {\n\t\t// Allow 5 seconds for the logger to flush.\n\t\tthis.timeout(5000);\n\t\t// After all tests ran, flush the logger to ensure all events are sent before the process exits.\n\t\tawait testLogger.flush();\n\t},\n};\n\nglobalThis.getMochaModule = () => {\n\treturn mochaModule;\n};\n\nfunction ensureTestRunLoggerIsInitialized(\n\tloggerToTest: FluidTestRunLogger | undefined,\n): loggerToTest is FluidTestRunLogger {\n\tif (loggerToTest instanceof FluidTestRunLogger) {\n\t\treturn true;\n\t}\n\tthrow new Error(\"Test run logger is not initialized\");\n}\n"]}

package/dist/package.json

@@ -1,4 +0,0 @@
-{
-	"type": "commonjs",
-	"sideEffects": false
-}

package/dist/packageVersion.d.ts

@@ -1,9 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- *
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
- */
-export declare const pkgName = "@fluid-internal/mocha-test-setup";
-export declare const pkgVersion = "2.101.1";
-//# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,qCAAqC,CAAC;AAC1D,eAAO,MAAM,UAAU,YAAY,CAAC"}

package/dist/packageVersion.js

@@ -1,12 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- *
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.pkgVersion = exports.pkgName = void 0;
-exports.pkgName = "@fluid-internal/mocha-test-setup";
-exports.pkgVersion = "2.101.1";
-//# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,kCAAkC,CAAC;AAC7C,QAAA,UAAU,GAAG,SAAS,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluid-internal/mocha-test-setup\";\nexport const pkgVersion = \"2.101.1\";\n"]}

package/tsconfig.cjs.json

@@ -1,7 +0,0 @@
-{
-	// This config must be used in a "type": "commonjs" environment. (Use `fluid-tsc commonjs`.)
-	"extends": "./tsconfig.json",
-	"compilerOptions": {
-		"outDir": "./dist",
-	},
-}

package/tsconfig.esnext.json

@@ -1,7 +0,0 @@
-{
-	"extends": "./tsconfig.json",
-	"compilerOptions": {
-		"outDir": "./lib",
-		"module": "esnext",
-	},
-}