@fluidframework/test-runtime-utils 2.71.0 → 2.73.0

package/lib/index.d.ts

@@ -11,5 +11,5 @@ export { MockHandle } from "./mockHandle.js";
 export { IMockContainerRuntimePendingMessage, MockContainerRuntime, IMockContainerRuntimeOptions, MockContainerRuntimeFactory, MockDeltaConnection, MockEmptyDeltaConnection, MockFluidDataStoreRuntime, MockObjectStorageService, MockQuorumClients, MockAudience, MockSharedObjectServices, IInternalMockRuntimeMessage, } from "./mocks.js";
 export { MockContainerRuntimeFactoryForReconnection, MockContainerRuntimeForReconnection, } from "./mocksForReconnection.js";
 export { MockStorage } from "./mockStorage.js";
-export { validateAssertionError } from "./validateAssertionError.js";
+export { validateAssertionError, validateUsageError, validateTypeError, validateError, } from "./validateAssertionError.js";
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EACN,mCAAmC,EACnC,oBAAoB,EACpB,4BAA4B,EAC5B,2BAA2B,EAC3B,mBAAmB,EACnB,wBAAwB,EACxB,yBAAyB,EACzB,wBAAwB,EACxB,iBAAiB,EACjB,YAAY,EACZ,wBAAwB,EACxB,2BAA2B,GAC3B,MAAM,YAAY,CAAC;AACpB,OAAO,EACN,0CAA0C,EAC1C,mCAAmC,GACnC,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EACN,mCAAmC,EACnC,oBAAoB,EACpB,4BAA4B,EAC5B,2BAA2B,EAC3B,mBAAmB,EACnB,wBAAwB,EACxB,yBAAyB,EACzB,wBAAwB,EACxB,iBAAiB,EACjB,YAAY,EACZ,wBAAwB,EACxB,2BAA2B,GAC3B,MAAM,YAAY,CAAC;AACpB,OAAO,EACN,0CAA0C,EAC1C,mCAAmC,GACnC,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EACN,sBAAsB,EACtB,kBAAkB,EAClB,iBAAiB,EACjB,aAAa,GACb,MAAM,6BAA6B,CAAC"}

package/lib/index.js

@@ -10,5 +10,5 @@ export { MockHandle } from "./mockHandle.js";
 export { MockContainerRuntime, MockContainerRuntimeFactory, MockDeltaConnection, MockEmptyDeltaConnection, MockFluidDataStoreRuntime, MockObjectStorageService, MockQuorumClients, MockAudience, MockSharedObjectServices, } from "./mocks.js";
 export { MockContainerRuntimeFactoryForReconnection, MockContainerRuntimeForReconnection, } from "./mocksForReconnection.js";
 export { MockStorage } from "./mockStorage.js";
-export { validateAssertionError } from "./validateAssertionError.js";
+export { validateAssertionError, validateUsageError, validateTypeError, validateError, } from "./validateAssertionError.js";
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAEN,oBAAoB,EAEpB,2BAA2B,EAC3B,mBAAmB,EACnB,wBAAwB,EACxB,yBAAyB,EACzB,wBAAwB,EACxB,iBAAiB,EACjB,YAAY,EACZ,wBAAwB,GAExB,MAAM,YAAY,CAAC;AACpB,OAAO,EACN,0CAA0C,EAC1C,mCAAmC,GACnC,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { deepFreeze } from \"./deepFreeze.js\";\nexport { IInsecureUser } from \"./insecureUsers.js\";\nexport { InsecureTokenProvider } from \"./insecureTokenProvider.js\";\nexport { MockFluidDataStoreContext } from \"./mocksDataStoreContext.js\";\nexport { MockDeltaManager, MockDeltaQueue } from \"./mockDeltas.js\";\nexport { MockHandle } from \"./mockHandle.js\";\nexport {\n\tIMockContainerRuntimePendingMessage,\n\tMockContainerRuntime,\n\tIMockContainerRuntimeOptions,\n\tMockContainerRuntimeFactory,\n\tMockDeltaConnection,\n\tMockEmptyDeltaConnection,\n\tMockFluidDataStoreRuntime,\n\tMockObjectStorageService,\n\tMockQuorumClients,\n\tMockAudience,\n\tMockSharedObjectServices,\n\tIInternalMockRuntimeMessage,\n} from \"./mocks.js\";\nexport {\n\tMockContainerRuntimeFactoryForReconnection,\n\tMockContainerRuntimeForReconnection,\n} from \"./mocksForReconnection.js\";\nexport { MockStorage } from \"./mockStorage.js\";\nexport { validateAssertionError } from \"./validateAssertionError.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAEN,oBAAoB,EAEpB,2BAA2B,EAC3B,mBAAmB,EACnB,wBAAwB,EACxB,yBAAyB,EACzB,wBAAwB,EACxB,iBAAiB,EACjB,YAAY,EACZ,wBAAwB,GAExB,MAAM,YAAY,CAAC;AACpB,OAAO,EACN,0CAA0C,EAC1C,mCAAmC,GACnC,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EACN,sBAAsB,EACtB,kBAAkB,EAClB,iBAAiB,EACjB,aAAa,GACb,MAAM,6BAA6B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { deepFreeze } from \"./deepFreeze.js\";\nexport { IInsecureUser } from \"./insecureUsers.js\";\nexport { InsecureTokenProvider } from \"./insecureTokenProvider.js\";\nexport { MockFluidDataStoreContext } from \"./mocksDataStoreContext.js\";\nexport { MockDeltaManager, MockDeltaQueue } from \"./mockDeltas.js\";\nexport { MockHandle } from \"./mockHandle.js\";\nexport {\n\tIMockContainerRuntimePendingMessage,\n\tMockContainerRuntime,\n\tIMockContainerRuntimeOptions,\n\tMockContainerRuntimeFactory,\n\tMockDeltaConnection,\n\tMockEmptyDeltaConnection,\n\tMockFluidDataStoreRuntime,\n\tMockObjectStorageService,\n\tMockQuorumClients,\n\tMockAudience,\n\tMockSharedObjectServices,\n\tIInternalMockRuntimeMessage,\n} from \"./mocks.js\";\nexport {\n\tMockContainerRuntimeFactoryForReconnection,\n\tMockContainerRuntimeForReconnection,\n} from \"./mocksForReconnection.js\";\nexport { MockStorage } from \"./mockStorage.js\";\nexport {\n\tvalidateAssertionError,\n\tvalidateUsageError,\n\tvalidateTypeError,\n\tvalidateError,\n} from \"./validateAssertionError.js\";\n"]}

package/lib/validateAssertionError.d.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 /**
- * Validates that an error thrown by our assert() function has the expected message, or a
+ * Validates that an error thrown by our `assert()` function has the expected message, or a
  * short code that corresponds to that message.
  *
  * @remarks
@@ -12,13 +12,29 @@
  * before the policy-check tool replaces those strings with short codes, or after. Note that
  * it either returns true or throws an error (the behavior expected by NodeJS' `assert.throws()`).
  *
- * @param error - The error object thrown by our `assert()` function. Its `message` property could
- * be a short code, or the original string message coded into the `assert()`.
  * @param expectedErrorMessage - The message that the error object should match (either explicitly,
  * or because it contains a short code which maps to that message).
- * @returns `true` if the message in the error object that was passed in matches the expected
- * message. Otherwise it throws an error.
+ * @returns an error validation function suitable for use with NodeJS's `assert.throws()`.
  * @internal
  */
-export declare function validateAssertionError(error: Error, expectedErrorMsg: string | RegExp): boolean;
+export declare function validateAssertionError(expectedErrorMsg: string | RegExp): (error: Error) => true;
+/**
+ * {@link validateError} for `UsageError`.
+ * @internal
+ */
+export declare function validateUsageError(expectedErrorMsg: string | RegExp): (error: Error) => true;
+/**
+ * {@link validateError} for `TypeError`.
+ * @internal
+ */
+export declare function validateTypeError(expectedErrorMsg: string | RegExp): (error: Error) => true;
+/**
+ * Validates that a specific kind of error was thrown with the expected message.
+ * @remarks
+ * Intended for use with NodeJS's `assert.throws`.
+ * @see {@link validateAssertionError}, {@link validateUsageError}, {@link validateTypeError} for more specialized versions.
+ * @returns an error validation function suitable for use with NodeJS's `assert.throws()`.
+ * @internal
+ */
+export declare function validateError(expectedErrorMsg: string | RegExp, errorType?: new (...args: any[]) => Error): (error: Error) => true;
 //# sourceMappingURL=validateAssertionError.d.ts.map

package/lib/validateAssertionError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validateAssertionError.d.ts","sourceRoot":"","sources":["../src/validateAssertionError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,sBAAsB,CACrC,KAAK,EAAE,KAAK,EACZ,gBAAgB,EAAE,MAAM,GAAG,MAAM,GAC/B,OAAO,CAqBT"}
+{"version":3,"file":"validateAssertionError.d.ts","sourceRoot":"","sources":["../src/validateAssertionError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,sBAAsB,CACrC,gBAAgB,EAAE,MAAM,GAAG,MAAM,GAC/B,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAmBxB;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,gBAAgB,EAAE,MAAM,GAAG,MAAM,GAAG,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAE5F;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,gBAAgB,EAAE,MAAM,GAAG,MAAM,GAAG,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAE3F;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC5B,gBAAgB,EAAE,MAAM,GAAG,MAAM,EACjC,SAAS,GAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,KAAa,GAC9C,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAaxB"}

package/lib/validateAssertionError.js

@@ -2,9 +2,11 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+import { UsageError } from "@fluidframework/telemetry-utils/internal";
+import { assert } from "@fluidframework/core-utils/internal";
 import { shortCodeMap } from "./assertionShortCodesMap.js";
 /**
- * Validates that an error thrown by our assert() function has the expected message, or a
+ * Validates that an error thrown by our `assert()` function has the expected message, or a
  * short code that corresponds to that message.
  *
  * @remarks
@@ -13,31 +15,64 @@ import { shortCodeMap } from "./assertionShortCodesMap.js";
  * before the policy-check tool replaces those strings with short codes, or after. Note that
  * it either returns true or throws an error (the behavior expected by NodeJS' `assert.throws()`).
  *
- * @param error - The error object thrown by our `assert()` function. Its `message` property could
- * be a short code, or the original string message coded into the `assert()`.
  * @param expectedErrorMessage - The message that the error object should match (either explicitly,
  * or because it contains a short code which maps to that message).
- * @returns `true` if the message in the error object that was passed in matches the expected
- * message. Otherwise it throws an error.
+ * @returns an error validation function suitable for use with NodeJS's `assert.throws()`.
  * @internal
  */
-export function validateAssertionError(error, expectedErrorMsg) {
-    // Asserts with custom debugMessageBuilder put extra content on the second line of the message, even when tagged.
-    // Thus extract the first line, which will be the assert tag if there is one, and replace it with the message from the shortCodeMap.
-    const split = error.message.split("\n");
-    const possibleShortCode = split[0].trim();
-    if (possibleShortCode in shortCodeMap) {
-        split[0] = shortCodeMap[possibleShortCode];
-    }
-    const mappedMsg = split.join("\n");
-    if (typeof expectedErrorMsg === "string"
-        ? mappedMsg !== expectedErrorMsg
-        : !expectedErrorMsg.test(mappedMsg)) {
-        // This throws an Error instead of an AssertionError because AssertionError would require a dependency on the
-        // node assert library, which we don't want to do for this library because it's used in the browser.
-        const message = `Unexpected assertion thrown\nActual: ${error.message === mappedMsg ? error.message : `${error.message} ('${mappedMsg}')}`}\nExpected: ${expectedErrorMsg}`;
-        throw new Error(message);
-    }
-    return true;
+export function validateAssertionError(expectedErrorMsg) {
+    return (error) => {
+        // Asserts with custom debugMessageBuilder put extra content on the second line of the message, even when tagged.
+        // Thus extract the first line, which will be the assert tag if there is one, and replace it with the message from the shortCodeMap.
+        const split = error.message.split("\n");
+        const possibleShortCode = split[0].trim();
+        if (possibleShortCode in shortCodeMap) {
+            split[0] = shortCodeMap[possibleShortCode];
+        }
+        const mappedMsg = split.join("\n");
+        if (testErrorMessage(mappedMsg, expectedErrorMsg)) {
+            // This throws an Error instead of an AssertionError because AssertionError would require a dependency on the
+            // node assert library, which we don't want to do for this library because it's used in the browser.
+            const message = `Unexpected assertion thrown\nActual: ${error.message === mappedMsg ? error.message : `${error.message} ('${mappedMsg}')}`}\nExpected: ${expectedErrorMsg}`;
+            throw new Error(message);
+        }
+        return true;
+    };
+}
+/**
+ * {@link validateError} for `UsageError`.
+ * @internal
+ */
+export function validateUsageError(expectedErrorMsg) {
+    return validateError(expectedErrorMsg, UsageError);
+}
+/**
+ * {@link validateError} for `TypeError`.
+ * @internal
+ */
+export function validateTypeError(expectedErrorMsg) {
+    return validateError(expectedErrorMsg, TypeError);
+}
+/**
+ * Validates that a specific kind of error was thrown with the expected message.
+ * @remarks
+ * Intended for use with NodeJS's `assert.throws`.
+ * @see {@link validateAssertionError}, {@link validateUsageError}, {@link validateTypeError} for more specialized versions.
+ * @returns an error validation function suitable for use with NodeJS's `assert.throws()`.
+ * @internal
+ */
+export function validateError(expectedErrorMsg, errorType = Error) {
+    return (error) => {
+        assert(error instanceof errorType, `Expected an error of type "${errorType.name}", but got "${error}"`);
+        if (testErrorMessage(error.message, expectedErrorMsg)) {
+            throw new Error(`Unexpected ${errorType.name} thrown\nActual: ${error.message}\nExpected: ${expectedErrorMsg}`);
+        }
+        return true;
+    };
+}
+function testErrorMessage(actualMessage, expectedErrorMsg) {
+    return typeof expectedErrorMsg === "string"
+        ? actualMessage !== expectedErrorMsg
+        : !expectedErrorMsg.test(actualMessage);
 }
 //# sourceMappingURL=validateAssertionError.js.map

package/lib/validateAssertionError.js.map

@@ -1 +1 @@
-{"version":3,"file":"validateAssertionError.js","sourceRoot":"","sources":["../src/validateAssertionError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAE3D;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,sBAAsB,CACrC,KAAY,EACZ,gBAAiC;IAEjC,iHAAiH;IACjH,oIAAoI;IACpI,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACxC,MAAM,iBAAiB,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC1C,IAAI,iBAAiB,IAAI,YAAY,EAAE,CAAC;QACvC,KAAK,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,iBAAiB,CAAC,CAAC;IAC5C,CAAC;IACD,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEnC,IACC,OAAO,gBAAgB,KAAK,QAAQ;QACnC,CAAC,CAAC,SAAS,KAAK,gBAAgB;QAChC,CAAC,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,EACnC,CAAC;QACF,6GAA6G;QAC7G,oGAAoG;QACpG,MAAM,OAAO,GAAG,wCAAwC,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,MAAM,SAAS,KAAK,eAAe,gBAAgB,EAAE,CAAC;QAC5K,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { shortCodeMap } from \"./assertionShortCodesMap.js\";\n\n/**\n * Validates that an error thrown by our assert() function has the expected message, or a\n * short code that corresponds to that message.\n *\n * @remarks\n * The main use case for this is so tests that expect specific assert() calls to fail can\n * always do comparisons based on the original string message, and work whether they run\n * before the policy-check tool replaces those strings with short codes, or after. Note that\n * it either returns true or throws an error (the behavior expected by NodeJS' `assert.throws()`).\n *\n * @param error - The error object thrown by our `assert()` function. Its `message` property could\n * be a short code, or the original string message coded into the `assert()`.\n * @param expectedErrorMessage - The message that the error object should match (either explicitly,\n * or because it contains a short code which maps to that message).\n * @returns `true` if the message in the error object that was passed in matches the expected\n * message. Otherwise it throws an error.\n * @internal\n */\nexport function validateAssertionError(\n\terror: Error,\n\texpectedErrorMsg: string | RegExp,\n): boolean {\n\t// Asserts with custom debugMessageBuilder put extra content on the second line of the message, even when tagged.\n\t// Thus extract the first line, which will be the assert tag if there is one, and replace it with the message from the shortCodeMap.\n\tconst split = error.message.split(\"\\n\");\n\tconst possibleShortCode = split[0].trim();\n\tif (possibleShortCode in shortCodeMap) {\n\t\tsplit[0] = shortCodeMap[possibleShortCode];\n\t}\n\tconst mappedMsg = split.join(\"\\n\");\n\n\tif (\n\t\ttypeof expectedErrorMsg === \"string\"\n\t\t\t? mappedMsg !== expectedErrorMsg\n\t\t\t: !expectedErrorMsg.test(mappedMsg)\n\t) {\n\t\t// This throws an Error instead of an AssertionError because AssertionError would require a dependency on the\n\t\t// node assert library, which we don't want to do for this library because it's used in the browser.\n\t\tconst message = `Unexpected assertion thrown\\nActual: ${error.message === mappedMsg ? error.message : `${error.message} ('${mappedMsg}')}`}\\nExpected: ${expectedErrorMsg}`;\n\t\tthrow new Error(message);\n\t}\n\treturn true;\n}\n"]}
+{"version":3,"file":"validateAssertionError.js","sourceRoot":"","sources":["../src/validateAssertionError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,0CAA0C,CAAC;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAE3D;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,sBAAsB,CACrC,gBAAiC;IAEjC,OAAO,CAAC,KAAY,EAAE,EAAE;QACvB,iHAAiH;QACjH,oIAAoI;QACpI,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,MAAM,iBAAiB,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC1C,IAAI,iBAAiB,IAAI,YAAY,EAAE,CAAC;YACvC,KAAK,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,iBAAiB,CAAC,CAAC;QAC5C,CAAC;QACD,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEnC,IAAI,gBAAgB,CAAC,SAAS,EAAE,gBAAgB,CAAC,EAAE,CAAC;YACnD,6GAA6G;YAC7G,oGAAoG;YACpG,MAAM,OAAO,GAAG,wCAAwC,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,MAAM,SAAS,KAAK,eAAe,gBAAgB,EAAE,CAAC;YAC5K,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;QAC1B,CAAC;QACD,OAAO,IAAI,CAAC;IACb,CAAC,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,gBAAiC;IACnE,OAAO,aAAa,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;AACpD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,gBAAiC;IAClE,OAAO,aAAa,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAAC;AACnD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAC5B,gBAAiC,EACjC,YAA2C,KAAK;IAEhD,OAAO,CAAC,KAAY,EAAE,EAAE;QACvB,MAAM,CACL,KAAK,YAAY,SAAS,EAC1B,8BAA8B,SAAS,CAAC,IAAI,eAAe,KAAK,GAAG,CACnE,CAAC;QACF,IAAI,gBAAgB,CAAC,KAAK,CAAC,OAAO,EAAE,gBAAgB,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,KAAK,CACd,cAAc,SAAS,CAAC,IAAI,oBAAoB,KAAK,CAAC,OAAO,eAAe,gBAAgB,EAAE,CAC9F,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACb,CAAC,CAAC;AACH,CAAC;AAED,SAAS,gBAAgB,CAAC,aAAqB,EAAE,gBAAiC;IACjF,OAAO,OAAO,gBAAgB,KAAK,QAAQ;QAC1C,CAAC,CAAC,aAAa,KAAK,gBAAgB;QACpC,CAAC,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;AAC1C,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport { shortCodeMap } from \"./assertionShortCodesMap.js\";\n\n/**\n * Validates that an error thrown by our `assert()` function has the expected message, or a\n * short code that corresponds to that message.\n *\n * @remarks\n * The main use case for this is so tests that expect specific assert() calls to fail can\n * always do comparisons based on the original string message, and work whether they run\n * before the policy-check tool replaces those strings with short codes, or after. Note that\n * it either returns true or throws an error (the behavior expected by NodeJS' `assert.throws()`).\n *\n * @param expectedErrorMessage - The message that the error object should match (either explicitly,\n * or because it contains a short code which maps to that message).\n * @returns an error validation function suitable for use with NodeJS's `assert.throws()`.\n * @internal\n */\nexport function validateAssertionError(\n\texpectedErrorMsg: string | RegExp,\n): (error: Error) => true {\n\treturn (error: Error) => {\n\t\t// Asserts with custom debugMessageBuilder put extra content on the second line of the message, even when tagged.\n\t\t// Thus extract the first line, which will be the assert tag if there is one, and replace it with the message from the shortCodeMap.\n\t\tconst split = error.message.split(\"\\n\");\n\t\tconst possibleShortCode = split[0].trim();\n\t\tif (possibleShortCode in shortCodeMap) {\n\t\t\tsplit[0] = shortCodeMap[possibleShortCode];\n\t\t}\n\t\tconst mappedMsg = split.join(\"\\n\");\n\n\t\tif (testErrorMessage(mappedMsg, expectedErrorMsg)) {\n\t\t\t// This throws an Error instead of an AssertionError because AssertionError would require a dependency on the\n\t\t\t// node assert library, which we don't want to do for this library because it's used in the browser.\n\t\t\tconst message = `Unexpected assertion thrown\\nActual: ${error.message === mappedMsg ? error.message : `${error.message} ('${mappedMsg}')}`}\\nExpected: ${expectedErrorMsg}`;\n\t\t\tthrow new Error(message);\n\t\t}\n\t\treturn true;\n\t};\n}\n\n/**\n * {@link validateError} for `UsageError`.\n * @internal\n */\nexport function validateUsageError(expectedErrorMsg: string | RegExp): (error: Error) => true {\n\treturn validateError(expectedErrorMsg, UsageError);\n}\n\n/**\n * {@link validateError} for `TypeError`.\n * @internal\n */\nexport function validateTypeError(expectedErrorMsg: string | RegExp): (error: Error) => true {\n\treturn validateError(expectedErrorMsg, TypeError);\n}\n\n/**\n * Validates that a specific kind of error was thrown with the expected message.\n * @remarks\n * Intended for use with NodeJS's `assert.throws`.\n * @see {@link validateAssertionError}, {@link validateUsageError}, {@link validateTypeError} for more specialized versions.\n * @returns an error validation function suitable for use with NodeJS's `assert.throws()`.\n * @internal\n */\nexport function validateError(\n\texpectedErrorMsg: string | RegExp,\n\terrorType: new (...args: any[]) => Error = Error,\n): (error: Error) => true {\n\treturn (error: Error) => {\n\t\tassert(\n\t\t\terror instanceof errorType,\n\t\t\t`Expected an error of type \"${errorType.name}\", but got \"${error}\"`,\n\t\t);\n\t\tif (testErrorMessage(error.message, expectedErrorMsg)) {\n\t\t\tthrow new Error(\n\t\t\t\t`Unexpected ${errorType.name} thrown\\nActual: ${error.message}\\nExpected: ${expectedErrorMsg}`,\n\t\t\t);\n\t\t}\n\t\treturn true;\n\t};\n}\n\nfunction testErrorMessage(actualMessage: string, expectedErrorMsg: string | RegExp): boolean {\n\treturn typeof expectedErrorMsg === \"string\"\n\t\t? actualMessage !== expectedErrorMsg\n\t\t: !expectedErrorMsg.test(actualMessage);\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/test-runtime-utils",
-  "version": "2.71.0",
+  "version": "2.73.0",
   "description": "Fluid runtime test utilities",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -69,31 +69,31 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.71.0",
-    "@fluidframework/container-definitions": "~2.71.0",
-    "@fluidframework/container-runtime-definitions": "~2.71.0",
-    "@fluidframework/core-interfaces": "~2.71.0",
-    "@fluidframework/core-utils": "~2.71.0",
-    "@fluidframework/datastore-definitions": "~2.71.0",
-    "@fluidframework/driver-definitions": "~2.71.0",
-    "@fluidframework/driver-utils": "~2.71.0",
-    "@fluidframework/id-compressor": "~2.71.0",
-    "@fluidframework/routerlicious-driver": "~2.71.0",
-    "@fluidframework/runtime-definitions": "~2.71.0",
-    "@fluidframework/runtime-utils": "~2.71.0",
-    "@fluidframework/telemetry-utils": "~2.71.0",
+    "@fluid-internal/client-utils": "~2.73.0",
+    "@fluidframework/container-definitions": "~2.73.0",
+    "@fluidframework/container-runtime-definitions": "~2.73.0",
+    "@fluidframework/core-interfaces": "~2.73.0",
+    "@fluidframework/core-utils": "~2.73.0",
+    "@fluidframework/datastore-definitions": "~2.73.0",
+    "@fluidframework/driver-definitions": "~2.73.0",
+    "@fluidframework/driver-utils": "~2.73.0",
+    "@fluidframework/id-compressor": "~2.73.0",
+    "@fluidframework/routerlicious-driver": "~2.73.0",
+    "@fluidframework/runtime-definitions": "~2.73.0",
+    "@fluidframework/runtime-utils": "~2.73.0",
+    "@fluidframework/telemetry-utils": "~2.73.0",
     "jsrsasign": "^11.0.0",
     "uuid": "^11.1.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.71.0",
-    "@fluid-tools/build-cli": "^0.58.3",
+    "@fluid-internal/mocha-test-setup": "~2.73.0",
+    "@fluid-tools/build-cli": "^0.60.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.58.3",
-    "@fluidframework/eslint-config-fluid": "^7.0.0",
-    "@fluidframework/test-runtime-utils-previous": "npm:@fluidframework/test-runtime-utils@2.70.0",
+    "@fluidframework/build-tools": "^0.60.0",
+    "@fluidframework/eslint-config-fluid": "~2.73.0",
+    "@fluidframework/test-runtime-utils-previous": "npm:@fluidframework/test-runtime-utils@2.71.0",
     "@microsoft/api-extractor": "7.52.11",
     "@types/jsrsasign": "^10.5.12",
     "@types/mocha": "^10.0.10",

package/src/assertionShortCodesMap.ts

@@ -1012,7 +1012,6 @@ export const shortCodeMap = {
 	"0x7a9": "Collision during index update",
 	"0x7aa": "Unknown removed node ID",
 	"0x7af": "Destination must be a new empty detached field",
-	"0x7b5": "kind must be FieldKindWithEditor",
 	"0x7b6": "Attach source field must be different from current field",
 	"0x7b7": "Attach source field must exist",
 	"0x7b8": "Attach must consume all nodes in source field",
@@ -1157,16 +1156,6 @@ export const shortCodeMap = {
 	"0x8cd": "detached node should exist",
 	"0x8ce": "Both replace replaces should not be undefined",
 	"0x8cf": "Both replace replaces should not be undefined",
-	"0x8d0": "Multiple detached nodes",
-	"0x8d1": "Multiple attached nodes",
-	"0x8d2": "Invalid change: pin must have a reserved detach ID",
-	"0x8d3": "Invalid reserved detach ID",
-	"0x8d4": "Invalid change: unexpected reserved detach ID on a change that detaches a node from the field",
-	"0x8d5": "Invalid change: attach must have a reserved detach ID",
-	"0x8d6": "Invalid reserved detach ID",
-	"0x8d7": "Invalid change: unexpected reserved detach ID on a change that detaches a node from the field",
-	"0x8d8": "Invalid detach ID",
-	"0x8d9": "Invalid detach ID",
 	"0x8da": "Unexpected node changeset collision",
 	"0x8db": "Cannot peek length unless both mark queues are non-empty",
 	"0x8dc": "Unexpected collision of new node changes",
@@ -1201,7 +1190,6 @@ export const shortCodeMap = {
 	"0x907": "unknown op type",
 	"0x908": "unknon type of op",
 	"0x909": "should not be called",
-	"0x90e": "Unknown format version",
 	"0x911": "Invalid operation on a disposed TreeCheckout",
 	"0x916": "invalid value",
 	"0x921": "Expected a leaf schema.",
@@ -1247,7 +1235,6 @@ export const shortCodeMap = {
 	"0x962": "overwriting wrong cache",
 	"0x963": "Invalid InternalTreeNode",
 	"0x964": "A tagged change should only contain the tagged revision",
-	"0x965": "Implicit revision should be provided",
 	"0x966": "Client id should be present and should be of type string",
 	"0x967": "Received message from user not in the quorumClients",
 	"0x969": "not connected yet",
@@ -1351,7 +1338,6 @@ export const shortCodeMap = {
 	"0x9f4": "Impactful cell rename must target empty cell",
 	"0x9f5": "Rename mark must have cell ID",
 	"0x9f6": "Expected empty cell",
-	"0x9f7": "Rename must have idOverride",
 	"0x9f8": "Rename must have idOverride",
 	"0x9f9": "Renames should only target empty cells",
 	"0x9fe": "node id should be an absolute route with child id part",
@@ -1598,7 +1584,6 @@ export const shortCodeMap = {
 	"0xb28": "missing schema",
 	"0xb29": "Expected defined output ID",
 	"0xb2a": "Revision must be defined",
-	"0xb2b": "Mark type: NoopMarkType should not be encoded.",
 	"0xb2c": "Mark type: NoopMarkType should not be encoded.",
 	"0xb2d": "Unable to split mark due to lengths",
 	"0xb2e": "missing schema for type in cursor",
@@ -1791,7 +1776,6 @@ export const shortCodeMap = {
 	"0xc15": "Expected ObjectNodeStoredSchema",
 	"0xc16": "missing schema for array node",
 	"0xc17": "Expected MapNodeStoredSchema",
-	"0xc19": "Expected FieldSchemaAlpha",
 	"0xc1a": "Expected MapNodeStoredSchema",
 	"0xc1b": "Expected at least two types",
 	"0xc1e": "Expected a constructed node to be an object",
@@ -1911,5 +1895,12 @@ export const shortCodeMap = {
 	"0xc99": "Registered version is not less than the current version.",
 	"0xc9a": "Presence capabilities should be empty.",
 	"0xc9b": "Presence extension called without own compatibility details",
-	"0xc9c": "Data store context does not implement ContainerExtensionProvider"
+	"0xc9c": "Data store context does not implement ContainerExtensionProvider",
+	"0xc9d": "missing schema",
+	"0xc9e": "Invalid configuration class constructed.",
+	"0xc9f": "Unsupported FieldBatchFormatVersion for incremental chunks; must be v2 or higher",
+	"0xca0": "Unsupported FieldBatchFormatVersion for incremental encoding; must be v2 or higher",
+	"0xca1": "Unsupported FieldBatchFormatVersion for incremental encoding; must be v2 or higher",
+	"0xca2": "localOpActivity must be undefined when entering rollback",
+	"0xca3": "localOpActivity must be undefined when entering applyStashedOp"
 };

package/src/index.ts

@@ -28,4 +28,9 @@ export {
 	MockContainerRuntimeForReconnection,
 } from "./mocksForReconnection.js";
 export { MockStorage } from "./mockStorage.js";
-export { validateAssertionError } from "./validateAssertionError.js";
+export {
+	validateAssertionError,
+	validateUsageError,
+	validateTypeError,
+	validateError,
+} from "./validateAssertionError.js";

package/src/validateAssertionError.ts

@@ -3,10 +3,12 @@
  * Licensed under the MIT License.
  */
 
+import { UsageError } from "@fluidframework/telemetry-utils/internal";
+import { assert } from "@fluidframework/core-utils/internal";
 import { shortCodeMap } from "./assertionShortCodesMap.js";
 
 /**
- * Validates that an error thrown by our assert() function has the expected message, or a
+ * Validates that an error thrown by our `assert()` function has the expected message, or a
  * short code that corresponds to that message.
  *
  * @remarks
@@ -15,36 +17,78 @@ import { shortCodeMap } from "./assertionShortCodesMap.js";
  * before the policy-check tool replaces those strings with short codes, or after. Note that
  * it either returns true or throws an error (the behavior expected by NodeJS' `assert.throws()`).
  *
- * @param error - The error object thrown by our `assert()` function. Its `message` property could
- * be a short code, or the original string message coded into the `assert()`.
  * @param expectedErrorMessage - The message that the error object should match (either explicitly,
  * or because it contains a short code which maps to that message).
- * @returns `true` if the message in the error object that was passed in matches the expected
- * message. Otherwise it throws an error.
+ * @returns an error validation function suitable for use with NodeJS's `assert.throws()`.
  * @internal
  */
 export function validateAssertionError(
-	error: Error,
 	expectedErrorMsg: string | RegExp,
-): boolean {
-	// Asserts with custom debugMessageBuilder put extra content on the second line of the message, even when tagged.
-	// Thus extract the first line, which will be the assert tag if there is one, and replace it with the message from the shortCodeMap.
-	const split = error.message.split("\n");
-	const possibleShortCode = split[0].trim();
-	if (possibleShortCode in shortCodeMap) {
-		split[0] = shortCodeMap[possibleShortCode];
-	}
-	const mappedMsg = split.join("\n");
+): (error: Error) => true {
+	return (error: Error) => {
+		// Asserts with custom debugMessageBuilder put extra content on the second line of the message, even when tagged.
+		// Thus extract the first line, which will be the assert tag if there is one, and replace it with the message from the shortCodeMap.
+		const split = error.message.split("\n");
+		const possibleShortCode = split[0].trim();
+		if (possibleShortCode in shortCodeMap) {
+			split[0] = shortCodeMap[possibleShortCode];
+		}
+		const mappedMsg = split.join("\n");
 
-	if (
-		typeof expectedErrorMsg === "string"
-			? mappedMsg !== expectedErrorMsg
-			: !expectedErrorMsg.test(mappedMsg)
-	) {
-		// This throws an Error instead of an AssertionError because AssertionError would require a dependency on the
-		// node assert library, which we don't want to do for this library because it's used in the browser.
-		const message = `Unexpected assertion thrown\nActual: ${error.message === mappedMsg ? error.message : `${error.message} ('${mappedMsg}')}`}\nExpected: ${expectedErrorMsg}`;
-		throw new Error(message);
-	}
-	return true;
+		if (testErrorMessage(mappedMsg, expectedErrorMsg)) {
+			// This throws an Error instead of an AssertionError because AssertionError would require a dependency on the
+			// node assert library, which we don't want to do for this library because it's used in the browser.
+			const message = `Unexpected assertion thrown\nActual: ${error.message === mappedMsg ? error.message : `${error.message} ('${mappedMsg}')}`}\nExpected: ${expectedErrorMsg}`;
+			throw new Error(message);
+		}
+		return true;
+	};
+}
+
+/**
+ * {@link validateError} for `UsageError`.
+ * @internal
+ */
+export function validateUsageError(expectedErrorMsg: string | RegExp): (error: Error) => true {
+	return validateError(expectedErrorMsg, UsageError);
+}
+
+/**
+ * {@link validateError} for `TypeError`.
+ * @internal
+ */
+export function validateTypeError(expectedErrorMsg: string | RegExp): (error: Error) => true {
+	return validateError(expectedErrorMsg, TypeError);
+}
+
+/**
+ * Validates that a specific kind of error was thrown with the expected message.
+ * @remarks
+ * Intended for use with NodeJS's `assert.throws`.
+ * @see {@link validateAssertionError}, {@link validateUsageError}, {@link validateTypeError} for more specialized versions.
+ * @returns an error validation function suitable for use with NodeJS's `assert.throws()`.
+ * @internal
+ */
+export function validateError(
+	expectedErrorMsg: string | RegExp,
+	errorType: new (...args: any[]) => Error = Error,
+): (error: Error) => true {
+	return (error: Error) => {
+		assert(
+			error instanceof errorType,
+			`Expected an error of type "${errorType.name}", but got "${error}"`,
+		);
+		if (testErrorMessage(error.message, expectedErrorMsg)) {
+			throw new Error(
+				`Unexpected ${errorType.name} thrown\nActual: ${error.message}\nExpected: ${expectedErrorMsg}`,
+			);
+		}
+		return true;
+	};
+}
+
+function testErrorMessage(actualMessage: string, expectedErrorMsg: string | RegExp): boolean {
+	return typeof expectedErrorMsg === "string"
+		? actualMessage !== expectedErrorMsg
+		: !expectedErrorMsg.test(actualMessage);
 }