feat(generate:assertTags): Enable per package assert tagging configuration

build-tools/packages/build-cli/api-report/build-cli.api.md

@@ -8,13 +8,16 @@ import { InterdependencyRange } from '@fluid-tools/version-tools';
 import { run } from '@oclif/core';
 import { VersionBumpType } from '@fluid-tools/version-tools';
 
-// @public (undocumented)
+// @public
 export interface AssertTaggingConfig {
-    // (undocumented)
+    enabledPaths?: RegExp[];
+}
+
+// @public
+export interface AssertTaggingPackageConfig {
     assertionFunctions: {
         [functionName: string]: number;
     };
-    enabledPaths?: RegExp[];
 }
 
 // @public

build-tools/packages/build-cli/src/config.ts

@@ -40,6 +40,11 @@ export interface FlubConfig {
 
 	/**
 	 * Configuration for assert tagging.
+	 * @remarks
+	 * Some of this applies to the root where flub is being run,
+	 * and some of it applies to the specific package being processed.
+	 * @privateRemarks
+	 * It seems like having each package have its own configuration would be simpler.
 	 */
 	assertTagging?: AssertTaggingConfig;
 
@@ -212,12 +217,16 @@ export interface PolicyConfig {
 	publicPackageRequirements?: PackageRequirements;
 }
 
+/**
+ * Used by `TagAssertsCommand`.
+ */
 export interface AssertTaggingConfig {
-	assertionFunctions: { [functionName: string]: number };
-
 	/**
 	 * An array of paths under which assert tagging applies to. If this setting is provided, only packages whose paths
 	 * match the regular expressions in this setting will be assert-tagged.
+	 *
+	 * This is used from the root where flub is run.
+	 * TODO: this should be replaced by package selection flags passed to the command.
 	 */
 	enabledPaths?: RegExp[];
 }

build-tools/packages/build-cli/src/index.ts

@@ -19,3 +19,6 @@ export type {
 	ScriptRequirement,
 } from "./config.js";
 export type { knownReleaseGroups, ReleaseGroup, ReleasePackage } from "./releaseGroups.js";
+
+// Exported for use in config files.
+export type { AssertTaggingPackageConfig } from "./commands/generate/assertTags.js";

fluidBuild.config.cjs

@@ -585,9 +585,6 @@ module.exports = {
 
 	assertTagging: {
 		enabledPaths: [/^common\/lib\/common-utils/i, /^experimental/i, /^packages/i],
-		assertionFunctions: {
-			assert: 1,
-		},
 	},
 
 	// `flub bump` config. These settings influence `flub bump` behavior for a release group. These settings can be

packages/dds/test-dds-utils/assertTagging.config.mjs

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * @type {import("@fluid-tools/build-cli").AssertTaggingConfig}
+ */
+export default { assertionFunctions: {} };

packages/dds/tree/assertTagging.config.mjs

@@ -0,0 +1,14 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * @type {import("@fluid-tools/build-cli").AssertTaggingConfig}
+ */
+export default {
+	assertionFunctions: {
+		"assert": 1,
+		"fail": 0,
+	},
+};

packages/dds/tree/src/feature-libraries/sequence-field/sequenceFieldCodecV1.ts

@@ -145,7 +145,7 @@ export function makeV1Codec(
 						context,
 					);
 				case NoopMarkType:
-					fail(`Mark type: ${type} should not be encoded.`);
+					fail("Mark type: NoopMarkType should not be encoded.");
 				default:
 					unreachableCase(type);
 			}

packages/dds/tree/src/feature-libraries/sequence-field/sequenceFieldCodecV2.ts

@@ -132,7 +132,7 @@ export function makeV2CodecHelpers(
 						context,
 					);
 				case NoopMarkType:
-					fail(`Mark type: ${type} should not be encoded.`);
+					fail("Mark type: NoopMarkType should not be encoded.");
 				default:
 					unreachableCase(type);
 			}

packages/dds/tree/src/simple-tree/api/treeNodeApi.ts

@@ -174,7 +174,7 @@ export const treeNodeApi: TreeNodeApi = {
 								changedFields,
 								(field) =>
 									nodeSchema.storedKeyToPropertyKey.get(field) ??
-									fail(`Could not find stored key '${field}' in schema.`),
+									fail("Could not find stored key in schema."),
 							),
 						);
 						listener({ changedProperties });

packages/dds/tree/src/simple-tree/toMapTree.ts

@@ -196,7 +196,7 @@ function nodeDataToMapTree(
 			result = objectToMapTree(data, schema);
 			break;
 		default:
-			fail(`Unrecognized schema kind: ${schema.kind}.`);
+			fail("Unrecognized schema kind");
 	}
 
 	return result;

packages/dds/tree/src/util/utils.ts

@@ -47,8 +47,17 @@ export function asMutable<T>(readonly: T): Mutable<T> {
 
 export const clone = structuredClone;
 
-export function fail(message: string): never {
-	throw new Error(message);
+/**
+ * Throw an error with a constant message.
+ * @remarks
+ * Works like {@link @fluidframework/core-utils/internal#assert}.
+ */
+export function fail(message: string | number): never {
+	// Declaring this here aliased to a different name avoids the assert tagging objecting to the usages of `assert` below.
+	// Since users of `fail` do the assert message tagging instead, suppressing tagging errors here makes sense.
+	const assertNoTag: (condition: boolean, message: string | number) => asserts condition =
+		assert;
+	assertNoTag(false, message);
 }
 
 /**

packages/runtime/test-runtime-utils/assertTagging.config.mjs

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * @type {import("@fluid-tools/build-cli").AssertTaggingConfig}
+ */
+export default { assertionFunctions: { assertionFunctions: {} } };

packages/test/assertTagging.config.mjs

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * @type {import("@fluid-tools/build-cli").AssertTaggingConfig}
+ */
+export default { assertionFunctions: {} };