@fluid-internal/mocha-test-setup 2.0.0-dev-rc.3.0.0.250606

package/.eslintrc.cjs

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	extends: ["@fluidframework/eslint-config-fluid/minimal-deprecated", "prettier"],
+};

package/CHANGELOG.md

@@ -0,0 +1,132 @@
+# @fluid-internal/mocha-test-setup
+
+## 2.0.0-rc.2.0.0
+
+### Minor Changes
+
+-   @fluidframework/mocha-test-setup moved to @fluid-internal/mocha-test-setup ([#19759](https://github.com/microsoft/FluidFramework/issues/19759)) [d530594684](https://github.com/microsoft/FluidFramework/commits/d530594684e074caa3c1899fdf332d3a3208969f)
+
+    The mocha-test-setup package is intended to aid in testing internal to the FluidFramework repo, and should not be used outside of the repo.
+
+## 2.0.0-rc.1.0.0
+
+Dependency updates only.
+
+## 2.0.0-internal.8.0.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.4.0
+
+### Minor Changes
+
+-   azure-client: Deprecated FluidStatic Classes ([#18402](https://github.com/microsoft/FluidFramework/issues/18402)) [589ec39de5](https://github.com/microsoft/FluidFramework/commits/589ec39de52116c7f782319e6f6aa61bc5aa9964)
+
+    Several FluidStatic classes were unnecessarily exposed. They have been replaced with creation functions. This helps us
+    keep implementations decoupled from usage which is easier to maintain and extend. It has very minimal impact on the
+    public surface area of downstream packages. The deprecated classes are as follows:
+
+    -   `AzureAudience` (use `IAzureAudience` instead)
+    -   `TinyliciousAudience` (use `ITinyliciousAudience` instead)
+    -   `DOProviderContainerRuntimeFactory`
+    -   `FluidContainer`
+    -   `ServiceAudience`
+
+## 2.0.0-internal.7.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.0.0
+
+### Major Changes
+
+-   Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
+
+## 2.0.0-internal.6.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.2.0
+
+### Minor Changes
+
+-   Remove use of @fluidframework/common-definitions ([#16638](https://github.com/microsoft/FluidFramework/issues/16638)) [a8c81509c9](https://github.com/microsoft/FluidFramework/commits/a8c81509c9bf09cfb2092ebcf7265205f9eb6dbf)
+
+    The **@fluidframework/common-definitions** package is being deprecated, so the following interfaces and types are now
+    imported from the **@fluidframework/core-interfaces** package:
+
+    -   interface IDisposable
+    -   interface IErrorEvent
+    -   interface IErrorEvent
+    -   interface IEvent
+    -   interface IEventProvider
+    -   interface ILoggingError
+    -   interface ITaggedTelemetryPropertyType
+    -   interface ITelemetryBaseEvent
+    -   interface ITelemetryBaseLogger
+    -   interface ITelemetryErrorEvent
+    -   interface ITelemetryGenericEvent
+    -   interface ITelemetryLogger
+    -   interface ITelemetryPerformanceEvent
+    -   interface ITelemetryProperties
+    -   type ExtendEventProvider
+    -   type IEventThisPlaceHolder
+    -   type IEventTransformer
+    -   type ReplaceIEventThisPlaceHolder
+    -   type ReplaceIEventThisPlaceHolder
+    -   type TelemetryEventCategory
+    -   type TelemetryEventPropertyType
+
+## 2.0.0-internal.6.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.0.0
+
+### Major Changes
+
+-   Upgraded typescript transpilation target to ES2020 [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
+
+    Upgraded typescript transpilation target to ES2020. This is done in order to decrease the bundle sizes of Fluid Framework packages. This has provided size improvements across the board for ex. Loader, Driver, Runtime etc. Reduced bundle sizes helps to load lesser code in apps and hence also helps to improve the perf.If any app wants to target any older versions of browsers with which this target version is not compatible, then they can use packages like babel to transpile to a older target.
+
+## 2.0.0-internal.5.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.0.0
+
+Dependency updates only.
+
+## 2.0.0-internal.4.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.4.1.0
+
+Dependency updates only.

package/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,151 @@
+# @fluid-internal/mocha-test-setup
+
+<!-- AUTO-GENERATED-CONTENT:START (README_PACKAGE_SCOPE_NOTICE:packageJsonPath=./package.json) -->
+
+**IMPORTANT: This package is intended strictly as an implementation detail of the Fluid Framework and is not intended for public consumption.**
+**We make no stability guarantees regarding its APIs.**
+
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+This package has a few main purposes:
+
+-   Expose/generate a default `.mocharc.cjs` configuration for running [mocha](https://mochajs.org) tests, which other
+    packages can extend.
+-   Map paths for required packages/modules to account for [Lerna](https://lerna.js.org/)'s dependency hoisting.
+-   Add mocha `beforeAll`, `beforeEach` and `afterEach` [root hook plugins](https://mochajs.org/#root-hook-plugins) to add
+    some special behavior when we run tests.
+
+## Base `mocharc.cjs` configuration
+
+To leverage the base mocha configuration exposed by this package, first add it as a `devDependency` to your `package.json`
+(the rest of the file has been omitted):
+
+```json
+{
+	"devDependencies": {
+		"@fluid-internal/mocha-test-setup": "version-that-matches-the-rest-of-the-release-group"
+	}
+}
+```
+
+Then put this in a `.mocharc.cjs` file at the root of your package:
+
+```javascript
+"use strict";
+
+const getFluidTestMochaConfig = require("@fluid-internal/mocha-test-setup/mocharc-common");
+
+const packageDir = __dirname;
+const config = getFluidTestMochaConfig(packageDir);
+module.exports = config;
+```
+
+If you need extra configuration, make changes to the `config` object before assigning it to `module.exports`.
+
+Mocha will use this file by default if no path to a configuration file is provided explicitly.
+
+The default configuration generated by `getFluidTestMochaConfig()` looks like this:
+
+```jsonc
+{
+  "exit": true,
+  "recursive": true,
+  "require": ["path1", "path2"], // Mapped paths for packages/modules indicated as required when calling getFluidTestMochaConfig()
+  "unhandled-rejections": "strict",
+};
+```
+
+The configuration will have additional settings if the following environment variables are present:
+
+### FLUID_TEST_TIMEOUT
+
+If it exists, the default configuration will also include this:
+
+```json
+{
+	"timeout": "<value-of-FLUID_TEST_TIMEOUT>"
+}
+```
+
+### FLUID_TEST_FORBID_ONLY
+
+If it exists, the default configuration will also include this:
+
+```json
+{
+	"forbid-only": "true"
+}
+```
+
+### FLUID_LOGGER_PROPS
+
+In case there is a need to override telemetry metrics, one can make use of an environment variable `FLUID_LOGGER_PROPS`,
+that to override them during execution time:
+
+```
+FLUID_LOGGER_PROPS='{ "hostName": "Benchmark" }'
+```
+
+## Mapping of package paths to account for Lerna hoisting
+
+The way we use Lerna to manage our monorepo, package dependencies are sometimes moved out of the `node_modules` folder
+of the package that declares them, and into a `node_modules` folder at the root of the release group.
+This applies to external dependencies (i.e. not between packages in our repo) that are present in more than one of our
+packages, including `mocha` itself as well as other test runners, which means that their path when they execute
+might not be the one you'd normally expect.
+This can cause issues when test scripts point to other dependencies of the package being tested (e.g. with the `-r/--require`
+flag) when running tests.
+This utility maps the paths of packages/modules passed to the `getFluidTestMochaConfig()` function, to ensure they are
+imported from whichever location they end up at.
+
+**NOTE**: once we move to `pnpm` this functionality might become irrelevant because `pnpm` keeps all dependencies in the
+expected paths and creates the necessary symlinks, instead of changing where dependency folders are located.
+
+### Considerations for non-package/module arguments
+
+Sometimes you'll want to provide a package/module/path as an argument when executing your tests but outside of the
+required packages that you can pass to `getFluidTestMochaConfig()`.
+For example, the path to a reporter file:
+
+```console
+mocha --require @fluid-internal/mocha-test-setup --reporter @fluid-tools/benchmark/dist/MochaMemoryTestReporter.js
+```
+
+Depending on where that file is coming from, you'll need to be careful with how that path is specified.
+E.g. `@fluid-tools/benchmark`, while being part of the repository, is not part of any release group, so it will always
+be downloaded from the public npm feed and treated as an external dependency.
+Since several packages declare it as a dependency, Lerna will hoist it to `node_modules` at the root of the release group.
+In general, the safest solution is to specify it starting with the package name (including scope if applicable).
+This might break in a few edge cases as long as we use Lerna with hoisting, so we'll have to deal with them individually.
+
+A particular way of specifying a package/module/path (e.g. starting with the package name vs starting with `node_modules/`)
+might behave differently locally and in CI builds, so that's another factor to keep in mind.
+
+## Special behavior
+
+### Supress console output by default
+
+`console.log()`, `console.warn()` and `console.error()` are disabled by default when using this package.
+They can be re-enabled by setting the `FLUID_TEST_VERBOSE` environment variable to any non-empty value, e.g.
+`FLUID_TEST_VERBOSE=1`.
+
+### Telemetry events
+
+A couple of telemetry events `fluid:telemetry:Test_start` and `fluid:telemetry:Test_end` will be generated for each test.
+The `Test_end` event includes fields with the test's state (passing/failed), its duration, if it timed out.
+If a `FLUID_TEST_VARIANT` environment variable exists, the `testVariant` field in the events will have its value.
+
+### Support for a custom logger
+
+This utility supports using a custom logger implementation.
+This can be useful to send the operational telemetry generated by the FluidFramework while the tests are running, to a
+particular log sink.
+
+It is expected that the package with the custom logger implementation adds a `getTestLogger() => ITelemetryBufferedLogger`
+function to the `global` object, which this package will call in order to obtain an instance of the custom logger.
+
+If a custom logger implementation will be used when executing tests in a package that leverages this utility, the path
+to the module with that implementation should **not** be specified with the `--require/-r` flag, but through the
+`FLUID_TEST_LOGGER_PKG_PATH` environment variable.
+This package has logic that needs the custom logger to be imported/executed at a particular time, and we ensure that
+by requiring that the path be provided through that environment variable.

package/api-extractor-lint.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-lint.esm.primary.json"
+}

package/api-extractor.json

@@ -0,0 +1,8 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-base.esm.primary.json",
+	"dtsRollup": {
+		// all APIs are internal - no rollup needed/used
+		"enabled": false
+	}
+}

package/api-report/mocha-test-setup.api.md

@@ -0,0 +1,18 @@
+## API Report File for "@fluid-internal/mocha-test-setup"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+/// <reference types="mocha" />
+
+// @internal (undocumented)
+export const mochaHooks: {
+    beforeAll(): void;
+    beforeEach(this: Mocha.Context): void;
+    afterEach(this: Mocha.Context): void;
+};
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+/*!
+ * 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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,10 @@
+"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

@@ -0,0 +1 @@
+{"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

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

package/dist/mochaHooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mochaHooks.d.ts","sourceRoot":"","sources":["../src/mochaHooks.ts"],"names":[],"mappings":"AAAA;;;GAGG;;AAuDH;;GAEG;AACH,eAAO,MAAM,UAAU;;qBAoBL,MAAM,OAAO;oBAoBd,MAAM,OAAO;CAqB7B,CAAC"}

package/dist/mochaHooks.js

@@ -0,0 +1,138 @@
+"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 enabling capturing the full stack for errors
+// since this is test capturing the full stack is worth it
+// in non-test environment 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 = Infinity;
+const testVariant = process.env.FLUID_TEST_VARIANT;
+const propsDict = process.env.FLUID_LOGGER_PROPS != null ? JSON.parse(process.env.FLUID_LOGGER_PROPS) : undefined;
+const _global = global;
+class TestLogger {
+    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;
+        }
+        // The test logger is currently instantiated once and for each event triggered between begin and
+        // end of a test, in case the testName is undefined, we will use the currentTestName.
+        event.testName = this.testName ?? currentTestName;
+        event.testVariant = testVariant;
+        event.hostName = packageVersion_js_1.pkgName;
+        this.parentLogger.send({ ...event, ...propsDict });
+    }
+    async flush() {
+        return this.parentLogger.flush();
+    }
+    constructor(parentLogger, testName) {
+        this.parentLogger = parentLogger;
+        this.testName = testName;
+    }
+}
+const nullLogger = {
+    send: () => { },
+    flush: async () => { },
+};
+const log = console.log;
+const error = console.log;
+const warn = console.warn;
+let currentTestLogger;
+let currentTestName;
+let originalLogger;
+/**
+ * @internal
+ */
+exports.mochaHooks = {
+    beforeAll() {
+        originalLogger = _global.getTestLogger?.() ?? nullLogger;
+        _global.getTestLogger = () => {
+            // If a current test logger exists, use that. Otherwise, create a new one. This should become the
+            // current test logger if this function is running in a context which understands the current test.
+            // Otherwise, just return the created TestLogger. (This happens e.g. if someone calls `getTestLogger`
+            // in a `before` or `after` hook, due to the order in which mocha hooks run)
+            if (currentTestLogger !== undefined) {
+                return currentTestLogger;
+            }
+            const testLogger = new TestLogger(originalLogger, currentTestName);
+            if (currentTestName !== undefined) {
+                currentTestLogger = testLogger;
+            }
+            return testLogger;
+        };
+    },
+    beforeEach() {
+        // Suppress console.log if not verbose mode
+        if (process.env.FLUID_TEST_VERBOSE === undefined) {
+            console.log = () => { };
+            console.error = () => { };
+            console.warn = () => { };
+        }
+        // save the test name can and clear the previous logger (if afterEach didn't get ran and it got left behind)
+        currentTestName = this.currentTest?.fullTitle();
+        currentTestLogger = undefined;
+        // send event on test start
+        originalLogger.send({
+            category: "generic",
+            eventName: "fluid:telemetry:Test_start",
+            testName: currentTestName,
+            testVariant,
+            hostName: packageVersion_js_1.pkgName,
+        });
+    },
+    afterEach() {
+        // send event on test end
+        originalLogger.send({
+            category: "generic",
+            eventName: "fluid:telemetry:Test_end",
+            testName: currentTestName,
+            state: this.currentTest?.state,
+            duration: this.currentTest?.duration,
+            timedOut: this.currentTest?.timedOut,
+            testVariant,
+            hostName: packageVersion_js_1.pkgName,
+        });
+        console.log = log;
+        console.error = error;
+        console.warn = warn;
+        // clear the test logger and test name after each test
+        currentTestLogger = undefined;
+        currentTestName = undefined;
+    },
+};
+globalThis.getMochaModule = () => {
+    return mochaModule;
+};
+//# sourceMappingURL=mochaHooks.js.map

package/dist/mochaHooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mochaHooks.js","sourceRoot":"","sources":["../src/mochaHooks.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;AAIH,mDAAqC;AACrC,2DAA8C;AAE9C,yDAAyD;AACzD,0DAA0D;AAC1D,sDAAsD;AACtD,mDAAmD;AACnD,wDAAwD;AACxD,sCAAsC;AACtC,KAAK,CAAC,eAAe,GAAG,QAAQ,CAAC;AAEjC,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;AACnD,MAAM,SAAS,GACd,OAAO,CAAC,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAEjG,MAAM,OAAO,GAAQ,MAAM,CAAC;AAC5B,MAAM,UAAU;IACf,IAAI,CAAC,KAA0B;QAC9B,6CAA6C;QAC7C,gDAAgD;QAChD,IAAI,KAAK,CAAC,SAAS,KAAK,kDAAkD,EAAE;YAC3E,OAAO;SACP;QAED,gGAAgG;QAChG,qFAAqF;QACrF,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,eAAe,CAAC;QAClD,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;QAChC,KAAK,CAAC,QAAQ,GAAG,2BAAO,CAAC;QACzB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,GAAG,KAAK,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC;IACpD,CAAC;IACD,KAAK,CAAC,KAAK;QACV,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IACD,YACkB,YAAsC,EACtC,QAA4B;QAD5B,iBAAY,GAAZ,YAAY,CAA0B;QACtC,aAAQ,GAAR,QAAQ,CAAoB;IAC3C,CAAC;CACJ;AACD,MAAM,UAAU,GAA6B;IAC5C,IAAI,EAAE,GAAG,EAAE,GAAE,CAAC;IACd,KAAK,EAAE,KAAK,IAAI,EAAE,GAAE,CAAC;CACrB,CAAC;AAEF,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;AACxB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;AAC1B,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;AAC1B,IAAI,iBAAuD,CAAC;AAC5D,IAAI,eAAmC,CAAC;AACxC,IAAI,cAAwC,CAAC;AAE7C;;GAEG;AACU,QAAA,UAAU,GAAG;IACzB,SAAS;QACR,cAAc,GAAG,OAAO,CAAC,aAAa,EAAE,EAAE,IAAI,UAAU,CAAC;QACzD,OAAO,CAAC,aAAa,GAAG,GAAG,EAAE;YAC5B,iGAAiG;YACjG,mGAAmG;YACnG,qGAAqG;YACrG,4EAA4E;YAC5E,IAAI,iBAAiB,KAAK,SAAS,EAAE;gBACpC,OAAO,iBAAiB,CAAC;aACzB;YAED,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;YACnE,IAAI,eAAe,KAAK,SAAS,EAAE;gBAClC,iBAAiB,GAAG,UAAU,CAAC;aAC/B;YAED,OAAO,UAAU,CAAC;QACnB,CAAC,CAAC;IACH,CAAC;IACD,UAAU;QACT,2CAA2C;QAC3C,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,KAAK,SAAS,EAAE;YACjD,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;SACxB;QACD,4GAA4G;QAC5G,eAAe,GAAG,IAAI,CAAC,WAAW,EAAE,SAAS,EAAE,CAAC;QAChD,iBAAiB,GAAG,SAAS,CAAC;QAE9B,2BAA2B;QAC3B,cAAc,CAAC,IAAI,CAAC;YACnB,QAAQ,EAAE,SAAS;YACnB,SAAS,EAAE,4BAA4B;YACvC,QAAQ,EAAE,eAAe;YACzB,WAAW;YACX,QAAQ,EAAE,2BAAO;SACjB,CAAC,CAAC;IACJ,CAAC;IACD,SAAS;QACR,yBAAyB;QACzB,cAAc,CAAC,IAAI,CAAC;YACnB,QAAQ,EAAE,SAAS;YACnB,SAAS,EAAE,0BAA0B;YACrC,QAAQ,EAAE,eAAe;YACzB,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK;YAC9B,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE,QAAQ;YACpC,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE,QAAQ;YACpC,WAAW;YACX,QAAQ,EAAE,2BAAO;SACjB,CAAC,CAAC;QAEH,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;QAClB,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;QACtB,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;QAEpB,sDAAsD;QACtD,iBAAiB,GAAG,SAAS,CAAC;QAC9B,eAAe,GAAG,SAAS,CAAC;IAC7B,CAAC;CACD,CAAC;AAEF,UAAU,CAAC,cAAc,GAAG,GAAG,EAAE;IAChC,OAAO,WAAW,CAAC;AACpB,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseEvent } from \"@fluidframework/core-interfaces\";\nimport { ITelemetryBufferedLogger } from \"@fluidframework/test-driver-definitions\";\nimport * as mochaModule from \"mocha\";\nimport { pkgName } from \"./packageVersion.js\";\n\n// this will enabling capturing the full stack for errors\n// since this is test capturing the full stack is worth it\n// in non-test environment we need to be more cautious\n// 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 = Infinity;\n\nconst testVariant = process.env.FLUID_TEST_VARIANT;\nconst propsDict =\n\tprocess.env.FLUID_LOGGER_PROPS != null ? JSON.parse(process.env.FLUID_LOGGER_PROPS) : undefined;\n\nconst _global: any = global;\nclass TestLogger implements ITelemetryBufferedLogger {\n\tsend(event: ITelemetryBaseEvent) {\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\t// The test logger is currently instantiated once and for each event triggered between begin and\n\t\t// end of a test, in case the testName is undefined, we will use the currentTestName.\n\t\tevent.testName = this.testName ?? currentTestName;\n\t\tevent.testVariant = testVariant;\n\t\tevent.hostName = pkgName;\n\t\tthis.parentLogger.send({ ...event, ...propsDict });\n\t}\n\tasync flush() {\n\t\treturn this.parentLogger.flush();\n\t}\n\tconstructor(\n\t\tprivate readonly parentLogger: ITelemetryBufferedLogger,\n\t\tprivate readonly testName: string | undefined,\n\t) {}\n}\nconst nullLogger: ITelemetryBufferedLogger = {\n\tsend: () => {},\n\tflush: async () => {},\n};\n\nconst log = console.log;\nconst error = console.log;\nconst warn = console.warn;\nlet currentTestLogger: ITelemetryBufferedLogger | undefined;\nlet currentTestName: string | undefined;\nlet originalLogger: ITelemetryBufferedLogger;\n\n/**\n * @internal\n */\nexport const mochaHooks = {\n\tbeforeAll() {\n\t\toriginalLogger = _global.getTestLogger?.() ?? nullLogger;\n\t\t_global.getTestLogger = () => {\n\t\t\t// If a current test logger exists, use that. Otherwise, create a new one. This should become the\n\t\t\t// current test logger if this function is running in a context which understands the current test.\n\t\t\t// Otherwise, just return the created TestLogger. (This happens e.g. if someone calls `getTestLogger`\n\t\t\t// in a `before` or `after` hook, due to the order in which mocha hooks run)\n\t\t\tif (currentTestLogger !== undefined) {\n\t\t\t\treturn currentTestLogger;\n\t\t\t}\n\n\t\t\tconst testLogger = new TestLogger(originalLogger, currentTestName);\n\t\t\tif (currentTestName !== undefined) {\n\t\t\t\tcurrentTestLogger = testLogger;\n\t\t\t}\n\n\t\t\treturn testLogger;\n\t\t};\n\t},\n\tbeforeEach(this: Mocha.Context) {\n\t\t// Suppress console.log if not verbose mode\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\t\t// save the test name can and clear the previous logger (if afterEach didn't get ran and it got left behind)\n\t\tcurrentTestName = this.currentTest?.fullTitle();\n\t\tcurrentTestLogger = undefined;\n\n\t\t// send event on test start\n\t\toriginalLogger.send({\n\t\t\tcategory: \"generic\",\n\t\t\teventName: \"fluid:telemetry:Test_start\",\n\t\t\ttestName: currentTestName,\n\t\t\ttestVariant,\n\t\t\thostName: pkgName,\n\t\t});\n\t},\n\tafterEach(this: Mocha.Context) {\n\t\t// send event on test end\n\t\toriginalLogger.send({\n\t\t\tcategory: \"generic\",\n\t\t\teventName: \"fluid:telemetry:Test_end\",\n\t\t\ttestName: currentTestName,\n\t\t\tstate: this.currentTest?.state,\n\t\t\tduration: this.currentTest?.duration,\n\t\t\ttimedOut: this.currentTest?.timedOut,\n\t\t\ttestVariant,\n\t\t\thostName: pkgName,\n\t\t});\n\n\t\tconsole.log = log;\n\t\tconsole.error = error;\n\t\tconsole.warn = warn;\n\n\t\t// clear the test logger and test name after each test\n\t\tcurrentTestLogger = undefined;\n\t\tcurrentTestName = undefined;\n\t},\n};\n\nglobalThis.getMochaModule = () => {\n\treturn mochaModule;\n};\n"]}

package/dist/package.json

@@ -0,0 +1,3 @@
+{
+	"type": "commonjs"
+}

package/dist/packageVersion.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * 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.0.0-dev-rc.3.0.0.250606";
+//# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -0,0 +1 @@
+{"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,8BAA8B,CAAC"}

package/dist/packageVersion.js

@@ -0,0 +1,12 @@
+"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.0.0-dev-rc.3.0.0.250606";
+//# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,kCAAkC,CAAC;AAC7C,QAAA,UAAU,GAAG,2BAA2B,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.0.0-dev-rc.3.0.0.250606\";\n"]}

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.42.3"
+    }
+  ]
+}

package/lib/index.d.ts

@@ -0,0 +1,6 @@
+/*!
+ * 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/lib/index.d.ts.map

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

package/lib/index.js

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

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC","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/lib/mochaHooks.d.ts

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

package/lib/mochaHooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mochaHooks.d.ts","sourceRoot":"","sources":["../src/mochaHooks.ts"],"names":[],"mappings":"AAAA;;;GAGG;;AAuDH;;GAEG;AACH,eAAO,MAAM,UAAU;;qBAoBL,MAAM,OAAO;oBAoBd,MAAM,OAAO;CAqB7B,CAAC"}

package/lib/mochaHooks.js

@@ -0,0 +1,112 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import * as mochaModule from "mocha";
+import { pkgName } from "./packageVersion.js";
+// this will enabling capturing the full stack for errors
+// since this is test capturing the full stack is worth it
+// in non-test environment 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 = Infinity;
+const testVariant = process.env.FLUID_TEST_VARIANT;
+const propsDict = process.env.FLUID_LOGGER_PROPS != null ? JSON.parse(process.env.FLUID_LOGGER_PROPS) : undefined;
+const _global = global;
+class TestLogger {
+    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;
+        }
+        // The test logger is currently instantiated once and for each event triggered between begin and
+        // end of a test, in case the testName is undefined, we will use the currentTestName.
+        event.testName = this.testName ?? currentTestName;
+        event.testVariant = testVariant;
+        event.hostName = pkgName;
+        this.parentLogger.send({ ...event, ...propsDict });
+    }
+    async flush() {
+        return this.parentLogger.flush();
+    }
+    constructor(parentLogger, testName) {
+        this.parentLogger = parentLogger;
+        this.testName = testName;
+    }
+}
+const nullLogger = {
+    send: () => { },
+    flush: async () => { },
+};
+const log = console.log;
+const error = console.log;
+const warn = console.warn;
+let currentTestLogger;
+let currentTestName;
+let originalLogger;
+/**
+ * @internal
+ */
+export const mochaHooks = {
+    beforeAll() {
+        originalLogger = _global.getTestLogger?.() ?? nullLogger;
+        _global.getTestLogger = () => {
+            // If a current test logger exists, use that. Otherwise, create a new one. This should become the
+            // current test logger if this function is running in a context which understands the current test.
+            // Otherwise, just return the created TestLogger. (This happens e.g. if someone calls `getTestLogger`
+            // in a `before` or `after` hook, due to the order in which mocha hooks run)
+            if (currentTestLogger !== undefined) {
+                return currentTestLogger;
+            }
+            const testLogger = new TestLogger(originalLogger, currentTestName);
+            if (currentTestName !== undefined) {
+                currentTestLogger = testLogger;
+            }
+            return testLogger;
+        };
+    },
+    beforeEach() {
+        // Suppress console.log if not verbose mode
+        if (process.env.FLUID_TEST_VERBOSE === undefined) {
+            console.log = () => { };
+            console.error = () => { };
+            console.warn = () => { };
+        }
+        // save the test name can and clear the previous logger (if afterEach didn't get ran and it got left behind)
+        currentTestName = this.currentTest?.fullTitle();
+        currentTestLogger = undefined;
+        // send event on test start
+        originalLogger.send({
+            category: "generic",
+            eventName: "fluid:telemetry:Test_start",
+            testName: currentTestName,
+            testVariant,
+            hostName: pkgName,
+        });
+    },
+    afterEach() {
+        // send event on test end
+        originalLogger.send({
+            category: "generic",
+            eventName: "fluid:telemetry:Test_end",
+            testName: currentTestName,
+            state: this.currentTest?.state,
+            duration: this.currentTest?.duration,
+            timedOut: this.currentTest?.timedOut,
+            testVariant,
+            hostName: pkgName,
+        });
+        console.log = log;
+        console.error = error;
+        console.warn = warn;
+        // clear the test logger and test name after each test
+        currentTestLogger = undefined;
+        currentTestName = undefined;
+    },
+};
+globalThis.getMochaModule = () => {
+    return mochaModule;
+};
+//# sourceMappingURL=mochaHooks.js.map

package/lib/mochaHooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mochaHooks.js","sourceRoot":"","sources":["../src/mochaHooks.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,WAAW,MAAM,OAAO,CAAC;AACrC,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C,yDAAyD;AACzD,0DAA0D;AAC1D,sDAAsD;AACtD,mDAAmD;AACnD,wDAAwD;AACxD,sCAAsC;AACtC,KAAK,CAAC,eAAe,GAAG,QAAQ,CAAC;AAEjC,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;AACnD,MAAM,SAAS,GACd,OAAO,CAAC,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAEjG,MAAM,OAAO,GAAQ,MAAM,CAAC;AAC5B,MAAM,UAAU;IACf,IAAI,CAAC,KAA0B;QAC9B,6CAA6C;QAC7C,gDAAgD;QAChD,IAAI,KAAK,CAAC,SAAS,KAAK,kDAAkD,EAAE;YAC3E,OAAO;SACP;QAED,gGAAgG;QAChG,qFAAqF;QACrF,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,eAAe,CAAC;QAClD,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;QAChC,KAAK,CAAC,QAAQ,GAAG,OAAO,CAAC;QACzB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,GAAG,KAAK,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC;IACpD,CAAC;IACD,KAAK,CAAC,KAAK;QACV,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IACD,YACkB,YAAsC,EACtC,QAA4B;QAD5B,iBAAY,GAAZ,YAAY,CAA0B;QACtC,aAAQ,GAAR,QAAQ,CAAoB;IAC3C,CAAC;CACJ;AACD,MAAM,UAAU,GAA6B;IAC5C,IAAI,EAAE,GAAG,EAAE,GAAE,CAAC;IACd,KAAK,EAAE,KAAK,IAAI,EAAE,GAAE,CAAC;CACrB,CAAC;AAEF,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;AACxB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;AAC1B,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;AAC1B,IAAI,iBAAuD,CAAC;AAC5D,IAAI,eAAmC,CAAC;AACxC,IAAI,cAAwC,CAAC;AAE7C;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACzB,SAAS;QACR,cAAc,GAAG,OAAO,CAAC,aAAa,EAAE,EAAE,IAAI,UAAU,CAAC;QACzD,OAAO,CAAC,aAAa,GAAG,GAAG,EAAE;YAC5B,iGAAiG;YACjG,mGAAmG;YACnG,qGAAqG;YACrG,4EAA4E;YAC5E,IAAI,iBAAiB,KAAK,SAAS,EAAE;gBACpC,OAAO,iBAAiB,CAAC;aACzB;YAED,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;YACnE,IAAI,eAAe,KAAK,SAAS,EAAE;gBAClC,iBAAiB,GAAG,UAAU,CAAC;aAC/B;YAED,OAAO,UAAU,CAAC;QACnB,CAAC,CAAC;IACH,CAAC;IACD,UAAU;QACT,2CAA2C;QAC3C,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,KAAK,SAAS,EAAE;YACjD,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;SACxB;QACD,4GAA4G;QAC5G,eAAe,GAAG,IAAI,CAAC,WAAW,EAAE,SAAS,EAAE,CAAC;QAChD,iBAAiB,GAAG,SAAS,CAAC;QAE9B,2BAA2B;QAC3B,cAAc,CAAC,IAAI,CAAC;YACnB,QAAQ,EAAE,SAAS;YACnB,SAAS,EAAE,4BAA4B;YACvC,QAAQ,EAAE,eAAe;YACzB,WAAW;YACX,QAAQ,EAAE,OAAO;SACjB,CAAC,CAAC;IACJ,CAAC;IACD,SAAS;QACR,yBAAyB;QACzB,cAAc,CAAC,IAAI,CAAC;YACnB,QAAQ,EAAE,SAAS;YACnB,SAAS,EAAE,0BAA0B;YACrC,QAAQ,EAAE,eAAe;YACzB,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK;YAC9B,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE,QAAQ;YACpC,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE,QAAQ;YACpC,WAAW;YACX,QAAQ,EAAE,OAAO;SACjB,CAAC,CAAC;QAEH,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;QAClB,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;QACtB,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;QAEpB,sDAAsD;QACtD,iBAAiB,GAAG,SAAS,CAAC;QAC9B,eAAe,GAAG,SAAS,CAAC;IAC7B,CAAC;CACD,CAAC;AAEF,UAAU,CAAC,cAAc,GAAG,GAAG,EAAE;IAChC,OAAO,WAAW,CAAC;AACpB,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseEvent } from \"@fluidframework/core-interfaces\";\nimport { ITelemetryBufferedLogger } from \"@fluidframework/test-driver-definitions\";\nimport * as mochaModule from \"mocha\";\nimport { pkgName } from \"./packageVersion.js\";\n\n// this will enabling capturing the full stack for errors\n// since this is test capturing the full stack is worth it\n// in non-test environment we need to be more cautious\n// 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 = Infinity;\n\nconst testVariant = process.env.FLUID_TEST_VARIANT;\nconst propsDict =\n\tprocess.env.FLUID_LOGGER_PROPS != null ? JSON.parse(process.env.FLUID_LOGGER_PROPS) : undefined;\n\nconst _global: any = global;\nclass TestLogger implements ITelemetryBufferedLogger {\n\tsend(event: ITelemetryBaseEvent) {\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\t// The test logger is currently instantiated once and for each event triggered between begin and\n\t\t// end of a test, in case the testName is undefined, we will use the currentTestName.\n\t\tevent.testName = this.testName ?? currentTestName;\n\t\tevent.testVariant = testVariant;\n\t\tevent.hostName = pkgName;\n\t\tthis.parentLogger.send({ ...event, ...propsDict });\n\t}\n\tasync flush() {\n\t\treturn this.parentLogger.flush();\n\t}\n\tconstructor(\n\t\tprivate readonly parentLogger: ITelemetryBufferedLogger,\n\t\tprivate readonly testName: string | undefined,\n\t) {}\n}\nconst nullLogger: ITelemetryBufferedLogger = {\n\tsend: () => {},\n\tflush: async () => {},\n};\n\nconst log = console.log;\nconst error = console.log;\nconst warn = console.warn;\nlet currentTestLogger: ITelemetryBufferedLogger | undefined;\nlet currentTestName: string | undefined;\nlet originalLogger: ITelemetryBufferedLogger;\n\n/**\n * @internal\n */\nexport const mochaHooks = {\n\tbeforeAll() {\n\t\toriginalLogger = _global.getTestLogger?.() ?? nullLogger;\n\t\t_global.getTestLogger = () => {\n\t\t\t// If a current test logger exists, use that. Otherwise, create a new one. This should become the\n\t\t\t// current test logger if this function is running in a context which understands the current test.\n\t\t\t// Otherwise, just return the created TestLogger. (This happens e.g. if someone calls `getTestLogger`\n\t\t\t// in a `before` or `after` hook, due to the order in which mocha hooks run)\n\t\t\tif (currentTestLogger !== undefined) {\n\t\t\t\treturn currentTestLogger;\n\t\t\t}\n\n\t\t\tconst testLogger = new TestLogger(originalLogger, currentTestName);\n\t\t\tif (currentTestName !== undefined) {\n\t\t\t\tcurrentTestLogger = testLogger;\n\t\t\t}\n\n\t\t\treturn testLogger;\n\t\t};\n\t},\n\tbeforeEach(this: Mocha.Context) {\n\t\t// Suppress console.log if not verbose mode\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\t\t// save the test name can and clear the previous logger (if afterEach didn't get ran and it got left behind)\n\t\tcurrentTestName = this.currentTest?.fullTitle();\n\t\tcurrentTestLogger = undefined;\n\n\t\t// send event on test start\n\t\toriginalLogger.send({\n\t\t\tcategory: \"generic\",\n\t\t\teventName: \"fluid:telemetry:Test_start\",\n\t\t\ttestName: currentTestName,\n\t\t\ttestVariant,\n\t\t\thostName: pkgName,\n\t\t});\n\t},\n\tafterEach(this: Mocha.Context) {\n\t\t// send event on test end\n\t\toriginalLogger.send({\n\t\t\tcategory: \"generic\",\n\t\t\teventName: \"fluid:telemetry:Test_end\",\n\t\t\ttestName: currentTestName,\n\t\t\tstate: this.currentTest?.state,\n\t\t\tduration: this.currentTest?.duration,\n\t\t\ttimedOut: this.currentTest?.timedOut,\n\t\t\ttestVariant,\n\t\t\thostName: pkgName,\n\t\t});\n\n\t\tconsole.log = log;\n\t\tconsole.error = error;\n\t\tconsole.warn = warn;\n\n\t\t// clear the test logger and test name after each test\n\t\tcurrentTestLogger = undefined;\n\t\tcurrentTestName = undefined;\n\t},\n};\n\nglobalThis.getMochaModule = () => {\n\treturn mochaModule;\n};\n"]}

package/lib/packageVersion.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * 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.0.0-dev-rc.3.0.0.250606";
+//# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.d.ts.map

@@ -0,0 +1 @@
+{"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,8BAA8B,CAAC"}

package/lib/packageVersion.js

@@ -0,0 +1,9 @@
+/*!
+ * 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 const pkgName = "@fluid-internal/mocha-test-setup";
+export const pkgVersion = "2.0.0-dev-rc.3.0.0.250606";
+//# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -0,0 +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,2BAA2B,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.0.0-dev-rc.3.0.0.250606\";\n"]}

package/mocharc-common.cjs

@@ -0,0 +1,88 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+"use strict";
+
+const { existsSync } = require("fs");
+const path = require("path");
+
+function getFluidTestMochaConfig(packageDir, additionalRequiredModules, testReportPrefix) {
+	const moduleDir = `${packageDir}/node_modules`;
+
+	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 : []),
+	];
+
+	// mocha install node_modules directory might not be the same as the module required because of hoisting
+	// We need to give the full path in that case.
+	// TODO: this path mapping might not be necessary once we move to pnpm, since it sets up node_modules differently
+	// from what Lerna does (all dependencies of a given package show up in its own node_modules folder and just symlink
+	// to the actual location of the installed package, instead of common dependencies being hoisted to a parent
+	// node_modules folder and not being present at all in the package's own node_modules).
+	const requiredModulePaths = requiredModules.map((mod) => {
+		// Just return if it is path already
+		if (existsSync(mod) || existsSync(`${mod}.js`)) {
+			return mod;
+		}
+
+		// Try to find it in the test package's directory
+		const modulePath = path.join(moduleDir, mod);
+		if (existsSync(modulePath)) {
+			return modulePath;
+		}
+
+		// Otherwise keep it as is
+		return mod;
+	});
+
+	if (process.env.FLUID_TEST_LOGGER_PKG_PATH) {
+		// Inject implementation of getTestLogger, put it first before mocha-test-setup
+		requiredModulePaths.unshift(process.env.FLUID_TEST_LOGGER_PKG_PATH);
+	}
+
+	const config = {
+		"exit": true,
+		"recursive": true,
+		"require": requiredModulePaths,
+		"unhandled-rejections": "strict",
+		// 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.
+		"v8-expose-gc": true,
+	};
+
+	if (process.env.FLUID_TEST_TIMEOUT !== undefined) {
+		config["timeout"] = process.env.FLUID_TEST_TIMEOUT;
+	}
+
+	const packageJson = require(`${packageDir}/package.json`);
+	config["reporter"] = `mocha-multi-reporters`;
+	// See https://www.npmjs.com/package/mocha-multi-reporters#cmroutput-option
+	const outputFilePrefix = testReportPrefix !== undefined ? `${testReportPrefix}-` : "";
+	console.log(
+		`Writing test results relative to package to nyc/${outputFilePrefix}junit-report.xml and nyc/${outputFilePrefix}junit-report.json`,
+	);
+	const suiteName =
+		testReportPrefix !== undefined
+			? `${packageJson.name} - ${testReportPrefix}`
+			: packageJson.name;
+	config["reporter-options"] = [
+		`configFile=${path.join(
+			__dirname,
+			"test-config.json",
+		)},cmrOutput=xunit+output+${outputFilePrefix}:mocha-json-output-reporter+output+${outputFilePrefix}:xunit+suiteName+${suiteName}`,
+	];
+
+	if (process.env.FLUID_TEST_FORBID_ONLY !== undefined) {
+		config["forbid-only"] = true;
+	}
+
+	return config;
+}
+
+module.exports = getFluidTestMochaConfig;

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "@fluid-internal/mocha-test-setup",
+  "version": "2.0.0-dev-rc.3.0.0.250606",
+  "description": "Utilities for Fluid tests",
+  "homepage": "https://fluidframework.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/FluidFramework.git",
+    "directory": "packages/test/mocha-test-setup"
+  },
+  "license": "MIT",
+  "author": "Microsoft and contributors",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/index.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./mocharc-common": {
+      "require": "./mocharc-common.cjs"
+    }
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.3.0.0.250606",
+    "@fluidframework/test-driver-definitions": "2.0.0-dev-rc.3.0.0.250606",
+    "mocha": "^10.2.0",
+    "source-map-support": "^0.5.21"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.13.3",
+    "@biomejs/biome": "^1.6.2",
+    "@fluid-tools/build-cli": "^0.34.0",
+    "@fluidframework/build-common": "^2.0.3",
+    "@fluidframework/build-tools": "^0.34.0",
+    "@fluidframework/eslint-config-fluid": "^5.1.0",
+    "@microsoft/api-extractor": "^7.42.3",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^18.19.0",
+    "copyfiles": "^2.4.1",
+    "eslint": "~8.55.0",
+    "prettier": "~3.0.3",
+    "rimraf": "^4.4.0",
+    "typescript": "~5.1.6"
+  },
+  "typeValidation": {
+    "disabled": true,
+    "broken": {}
+  },
+  "scripts": {
+    "build": "fluid-build . --task build",
+    "build:commonjs": "fluid-build . --task commonjs",
+    "build:compile": "fluid-build . --task compile",
+    "build:compile:min": "npm run build:compile",
+    "build:docs": "api-extractor run --local",
+    "build:esnext": "tsc --project ./tsconfig.json",
+    "build:genver": "gen-version",
+    "check:are-the-types-wrong": "attw --pack . --entrypoints .",
+    "check:biome": "biome check .",
+    "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
+    "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
+    "ci:build:docs": "api-extractor run",
+    "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
+    "eslint": "eslint --format stylish src",
+    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "format": "fluid-build --task format .",
+    "format:biome": "biome check --apply .",
+    "format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
+    "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"
+  }
+}

package/prettier.config.cjs

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	...require("@fluidframework/build-common/prettier.config.cjs"),
+};

package/src/index.ts

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

package/src/mochaHooks.ts

@@ -0,0 +1,127 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ITelemetryBaseEvent } from "@fluidframework/core-interfaces";
+import { ITelemetryBufferedLogger } from "@fluidframework/test-driver-definitions";
+import * as mochaModule from "mocha";
+import { pkgName } from "./packageVersion.js";
+
+// this will enabling capturing the full stack for errors
+// since this is test capturing the full stack is worth it
+// in non-test environment 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 = Infinity;
+
+const testVariant = process.env.FLUID_TEST_VARIANT;
+const propsDict =
+	process.env.FLUID_LOGGER_PROPS != null ? JSON.parse(process.env.FLUID_LOGGER_PROPS) : undefined;
+
+const _global: any = global;
+class TestLogger implements ITelemetryBufferedLogger {
+	send(event: ITelemetryBaseEvent) {
+		// 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;
+		}
+
+		// The test logger is currently instantiated once and for each event triggered between begin and
+		// end of a test, in case the testName is undefined, we will use the currentTestName.
+		event.testName = this.testName ?? currentTestName;
+		event.testVariant = testVariant;
+		event.hostName = pkgName;
+		this.parentLogger.send({ ...event, ...propsDict });
+	}
+	async flush() {
+		return this.parentLogger.flush();
+	}
+	constructor(
+		private readonly parentLogger: ITelemetryBufferedLogger,
+		private readonly testName: string | undefined,
+	) {}
+}
+const nullLogger: ITelemetryBufferedLogger = {
+	send: () => {},
+	flush: async () => {},
+};
+
+const log = console.log;
+const error = console.log;
+const warn = console.warn;
+let currentTestLogger: ITelemetryBufferedLogger | undefined;
+let currentTestName: string | undefined;
+let originalLogger: ITelemetryBufferedLogger;
+
+/**
+ * @internal
+ */
+export const mochaHooks = {
+	beforeAll() {
+		originalLogger = _global.getTestLogger?.() ?? nullLogger;
+		_global.getTestLogger = () => {
+			// If a current test logger exists, use that. Otherwise, create a new one. This should become the
+			// current test logger if this function is running in a context which understands the current test.
+			// Otherwise, just return the created TestLogger. (This happens e.g. if someone calls `getTestLogger`
+			// in a `before` or `after` hook, due to the order in which mocha hooks run)
+			if (currentTestLogger !== undefined) {
+				return currentTestLogger;
+			}
+
+			const testLogger = new TestLogger(originalLogger, currentTestName);
+			if (currentTestName !== undefined) {
+				currentTestLogger = testLogger;
+			}
+
+			return testLogger;
+		};
+	},
+	beforeEach(this: Mocha.Context) {
+		// Suppress console.log if not verbose mode
+		if (process.env.FLUID_TEST_VERBOSE === undefined) {
+			console.log = () => {};
+			console.error = () => {};
+			console.warn = () => {};
+		}
+		// save the test name can and clear the previous logger (if afterEach didn't get ran and it got left behind)
+		currentTestName = this.currentTest?.fullTitle();
+		currentTestLogger = undefined;
+
+		// send event on test start
+		originalLogger.send({
+			category: "generic",
+			eventName: "fluid:telemetry:Test_start",
+			testName: currentTestName,
+			testVariant,
+			hostName: pkgName,
+		});
+	},
+	afterEach(this: Mocha.Context) {
+		// send event on test end
+		originalLogger.send({
+			category: "generic",
+			eventName: "fluid:telemetry:Test_end",
+			testName: currentTestName,
+			state: this.currentTest?.state,
+			duration: this.currentTest?.duration,
+			timedOut: this.currentTest?.timedOut,
+			testVariant,
+			hostName: pkgName,
+		});
+
+		console.log = log;
+		console.error = error;
+		console.warn = warn;
+
+		// clear the test logger and test name after each test
+		currentTestLogger = undefined;
+		currentTestName = undefined;
+	},
+};
+
+globalThis.getMochaModule = () => {
+	return mochaModule;
+};

package/src/packageVersion.ts

@@ -0,0 +1,9 @@
+/*!
+ * 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 const pkgName = "@fluid-internal/mocha-test-setup";
+export const pkgVersion = "2.0.0-dev-rc.3.0.0.250606";

package/test-config.json

@@ -0,0 +1,10 @@
+{
+	"reporterEnabled": "xunit,mocha-json-output-reporter,spec",
+	"xunitReporterOptions": {
+		"output": "nyc/{id}junit-report.xml",
+		"suiteName": "{id}"
+	},
+	"mochaJsonOutputReporterReporterOptions": {
+		"output": "nyc/{id}junit-report.json"
+	}
+}

package/tsconfig.cjs.json

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

package/tsconfig.esnext.json

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

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+	"extends": "../../../common/build/build-common/tsconfig.node16.json",
+	"include": ["src/**/*"],
+	"exclude": ["dist", "node_modules"],
+	"compilerOptions": {
+		"rootDir": "./src",
+		"outDir": "./lib",
+		"types": ["node", "mocha"],
+	},
+}