Merge branch 'main' into node16-part-3

microsoft · Dec 14, 2023 · 7e1756d · 7e1756d
2 parents aa81da0 + de43f3c
commit 7e1756d
Show file tree

Hide file tree

Showing 438 changed files with 11,937 additions and 9,649 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -15,11 +15,16 @@
 	"overrideCommand": false,
 
 	// Add the IDs of extensions you want installed when the container is created.
-	"extensions": [
-		"dbaeumer.vscode-eslint",
-		"ms-azuretools.vscode-docker",
-		"mutantdino.resourcemonitor"
-	],
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"dbaeumer.vscode-eslint",
+				"esbenp.prettier-vscode",
+				"ms-azuretools.vscode-docker",
+				"mutantdino.resourcemonitor"
+			]
+		}
+	},
 
 	// Forward port for Tinylicious
 	"forwardPorts": [7070],

diff --git a/azure/packages/azure-client/api-extractor-lint.json b/azure/packages/azure-client/api-extractor-lint.json
@@ -1,13 +1,4 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-lint.json",
-	"messages": {
-		"extractorMessageReporting": {
-			// TODO: remove once base config has this enabled as an error
-			"ae-incompatible-release-tags": {
-				"logLevel": "error",
-				"addToApiReportFile": false
-			}
-		}
-	}
+	"extends": "../../../common/build/build-common/api-extractor-lint.json"
 }
diff --git a/azure/packages/azure-local-service/api-extractor-lint.json b/azure/packages/azure-local-service/api-extractor-lint.json
@@ -1,13 +1,4 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-lint.json",
-	"messages": {
-		"extractorMessageReporting": {
-			// TODO: remove once base config has this enabled as an error
-			"ae-incompatible-release-tags": {
-				"logLevel": "error",
-				"addToApiReportFile": false
-			}
-		}
-	}
+	"extends": "../../../common/build/build-common/api-extractor-lint.json"
 }
diff --git a/azure/packages/azure-service-utils/api-extractor-lint.json b/azure/packages/azure-service-utils/api-extractor-lint.json
@@ -1,13 +1,4 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-lint.json",
-	"messages": {
-		"extractorMessageReporting": {
-			// TODO: remove once base config has this enabled as an error
-			"ae-incompatible-release-tags": {
-				"logLevel": "error",
-				"addToApiReportFile": false
-			}
-		}
-	}
+	"extends": "../../../common/build/build-common/api-extractor-lint.json"
 }
diff --git a/azure/packages/external-controller/src/app.ts b/azure/packages/external-controller/src/app.ts
@@ -4,7 +4,7 @@
  */
 import { IFluidContainer, IValueChanged, SharedMap } from "fluid-framework";
 
-import { DevtoolsLogger, initializeDevtools } from "@fluid-experimental/devtools";
+import { createDevtoolsLogger, initializeDevtools } from "@fluid-experimental/devtools";
 import {
 	AzureClient,
 	AzureContainerServices,
@@ -116,7 +116,7 @@ async function start(): Promise<void> {
 	const baseLogger = createChildLogger();
 
 	// Wrap telemetry logger for use with Devtools
-	const devtoolsLogger = new DevtoolsLogger(baseLogger);
+	const devtoolsLogger = createDevtoolsLogger(baseLogger);
 
 	const clientProps = {
 		connection: connectionConfig,

diff --git a/common/build/build-common/api-extractor-lint.json b/common/build/build-common/api-extractor-lint.json
@@ -45,7 +45,7 @@
 			// This is the primary error we are looking for with the linter pass.
 			// Ensure that release tags of API members are compatible **across package boundaries**.
 			"ae-incompatible-release-tags": {
-				"logLevel": "none", // TODO: change to "error" once we are ready to start enforcing repo-wide
+				"logLevel": "error",
 				"addToApiReportFile": false
 			}
 		}

diff --git a/common/lib/common-definitions/api-extractor-lint.json b/common/lib/common-definitions/api-extractor-lint.json
@@ -1,13 +1,4 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../build/build-common/api-extractor-lint.json",
-	"messages": {
-		"extractorMessageReporting": {
-			// TODO: remove once base config has this enabled as an error
-			"ae-incompatible-release-tags": {
-				"logLevel": "error",
-				"addToApiReportFile": false
-			}
-		}
-	}
+	"extends": "../../build/build-common/api-extractor-lint.json"
 }
diff --git a/common/lib/common-utils/api-extractor-lint.json b/common/lib/common-utils/api-extractor-lint.json
@@ -1,13 +1,4 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../build/build-common/api-extractor-lint.json",
-	"messages": {
-		"extractorMessageReporting": {
-			// TODO: remove once base config has this enabled as an error
-			"ae-incompatible-release-tags": {
-				"logLevel": "error",
-				"addToApiReportFile": false
-			}
-		}
-	}
+	"extends": "../../build/build-common/api-extractor-lint.json"
 }
diff --git a/common/lib/protocol-definitions/api-extractor-lint.json b/common/lib/protocol-definitions/api-extractor-lint.json
@@ -1,13 +1,4 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../build/build-common/api-extractor-lint.json",
-	"messages": {
-		"extractorMessageReporting": {
-			// TODO: remove once base config has this enabled as an error
-			"ae-incompatible-release-tags": {
-				"logLevel": "error",
-				"addToApiReportFile": false
-			}
-		}
-	}
+	"extends": "../../build/build-common/api-extractor-lint.json"
 }
diff --git a/common/lib/protocol-definitions/api-report/protocol-definitions.api.md b/common/lib/protocol-definitions/api-report/protocol-definitions.api.md
@@ -4,7 +4,7 @@
 
 ```ts
 
-// @alpha
+// @public
 export type ConnectionMode = "write" | "read";
 
 // @alpha (undocumented)
@@ -42,19 +42,19 @@ export interface IBlob {
     encoding: "utf-8" | "base64";
 }
 
-// @alpha
+// @public
 export interface IBranchOrigin {
     id: string;
     minimumSequenceNumber: number;
     sequenceNumber: number;
 }
 
-// @alpha
+// @public
 export interface ICapabilities {
     interactive: boolean;
 }
 
-// @alpha
+// @public
 export interface IClient {
     details: IClientDetails;
     mode: ConnectionMode;
@@ -65,15 +65,15 @@ export interface IClient {
     user: IUser;
 }
 
-// @alpha
+// @public
 export interface IClientConfiguration {
     blockSize: number;
     maxMessageSize: number;
     noopCountFrequency?: number;
     noopTimeFrequency?: number;
 }
 
-// @alpha
+// @public
 export interface IClientDetails {
     capabilities: ICapabilities;
     // (undocumented)
@@ -142,7 +142,7 @@ export interface IDocumentAttributes {
     sequenceNumber: number;
 }
 
-// @alpha
+// @public
 export interface IDocumentMessage {
     clientSequenceNumber: number;
     compression?: string;
@@ -211,7 +211,7 @@ export interface IQuorum extends Omit<IQuorumClients, "on" | "once" | "off">, Om
     once: IQuorum["on"];
 }
 
-// @alpha
+// @public
 export interface IQuorumClients {
     // (undocumented)
     getMember(clientId: string): ISequencedClient | undefined;
@@ -277,7 +277,7 @@ export interface ISentSignalMessage extends ISignalMessageBase {
     targetClientId?: string;
 }
 
-// @alpha
+// @public
 export interface ISequencedClient {
     client: IClient;
     sequenceNumber: number;
@@ -289,7 +289,7 @@ export interface ISequencedDocumentAugmentedMessage extends ISequencedDocumentMe
     additionalContent: string;
 }
 
-// @alpha
+// @public
 export interface ISequencedDocumentMessage {
     clientId: string | null;
     clientSequenceNumber: number;
@@ -340,12 +340,12 @@ export interface ISignalClient {
     referenceSequenceNumber?: number;
 }
 
-// @alpha
+// @public
 export interface ISignalMessage extends ISignalMessageBase {
     clientId: string | null;
 }
 
-// @alpha
+// @public
 export interface ISignalMessageBase {
     clientConnectionNumber?: number;
     content: unknown;
@@ -387,15 +387,15 @@ export interface ISummaryAck {
     summaryProposal: ISummaryProposal;
 }
 
-// @alpha
+// @public
 export interface ISummaryAttachment {
     // (undocumented)
     id: string;
     // (undocumented)
     type: SummaryType.Attachment;
 }
 
-// @alpha
+// @public
 export interface ISummaryBlob {
     // (undocumented)
     content: string | Uint8Array;
@@ -412,7 +412,7 @@ export interface ISummaryContent {
     parents: string[];
 }
 
-// @alpha
+// @public
 export interface ISummaryHandle {
     handle: string;
     handleType: SummaryTypeNoHandle;
@@ -443,7 +443,7 @@ export interface ISummaryTokenClaims {
     sub: string;
 }
 
-// @alpha
+// @public
 export interface ISummaryTree {
     // (undocumented)
     tree: {
@@ -454,7 +454,7 @@ export interface ISummaryTree {
     unreferenced?: true;
 }
 
-// @alpha
+// @public
 export interface ITokenClaims {
     documentId: string;
     exp: number;
@@ -477,7 +477,7 @@ export interface ITokenService {
     extractClaims(token: string): ITokenClaims;
 }
 
-// @alpha
+// @public
 export interface ITrace {
     action: string;
     service: string;
@@ -512,7 +512,7 @@ export interface IUploadedSummaryDetails {
     includesProtocolTree?: boolean;
 }
 
-// @alpha
+// @public
 export interface IUser {
     id: string;
 }
@@ -562,13 +562,13 @@ export enum SignalType {
     ClientLeave = "leave"
 }
 
-// @alpha
+// @public
 export type SummaryObject = ISummaryTree | ISummaryBlob | ISummaryHandle | ISummaryAttachment;
 
 // @alpha
 export type SummaryTree = ISummaryTree | ISummaryHandle;
 
-// @alpha
+// @public
 export namespace SummaryType {
     // @internal (undocumented)
     export type Attachment = 4;
@@ -584,10 +584,10 @@ export namespace SummaryType {
     const Attachment: Attachment;
 }
 
-// @alpha
+// @public
 export type SummaryType = SummaryType.Attachment | SummaryType.Blob | SummaryType.Handle | SummaryType.Tree;
 
-// @alpha
+// @public
 export type SummaryTypeNoHandle = SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment;
 
 // @alpha

diff --git a/common/lib/protocol-definitions/src/clients.ts b/common/lib/protocol-definitions/src/clients.ts
@@ -12,14 +12,14 @@ import { IUser } from "./users";
  *
  * Note: a user's connection mode is dependent on their permissions.
  * E.g. a user with read-only permissions will not be allowed a "write" connection mode.
- * @alpha
+ * @public
  */
 export type ConnectionMode = "write" | "read";
 
 /**
  * Capabilities of a Client.
  * In particular, whether or not the client is {@link ICapabilities.interactive}.
- * @alpha
+ * @public
  */
 export interface ICapabilities {
 	/**
@@ -36,7 +36,7 @@ export interface ICapabilities {
 
 /**
  * {@link IClient} connection / environment metadata.
- * @alpha
+ * @public
  */
 export interface IClientDetails {
 	/**
@@ -63,7 +63,7 @@ export interface IClientDetails {
 
 /**
  * Represents a client connected to a Fluid service, including associated user details, permissions, and connection mode.
- * @alpha
+ * @public
  */
 export interface IClient {
 	/**
@@ -96,7 +96,7 @@ export interface IClient {
 
 /**
  * A {@link IClient} that has been acknowledged by the sequencer.
- * @alpha
+ * @public
  */
 export interface ISequencedClient {
 	/**

diff --git a/common/lib/protocol-definitions/src/config.ts b/common/lib/protocol-definitions/src/config.ts
@@ -5,7 +5,7 @@
 
 /**
  * Key value store of service configuration properties provided to the client as part of connection.
- * @alpha
+ * @public
  */
 export interface IClientConfiguration {
 	/**

diff --git a/common/lib/protocol-definitions/src/consensus.ts b/common/lib/protocol-definitions/src/consensus.ts
@@ -86,7 +86,7 @@ export type IQuorumEvents = IQuorumClientsEvents & IQuorumProposalsEvents;
 
 /**
  * Interface for tracking clients in the Quorum.
- * @alpha
+ * @public
  */
 export interface IQuorumClients {
 	getMembers(): Map<string, ISequencedClient>;