@fluidframework/fluid-telemetry 2.0.0-rc.4.0.6 → 2.0.0-rc.5.0.1

package/lib/container/telemetryProducer.js

@@ -3,8 +3,8 @@
  * Licensed under the MIT License.
  */
 import { v4 as uuid } from "uuid";
-import { ContainerTelemetryEventNames, } from "./containerTelemetry.js";
 import { IFluidContainerSystemEventNames, } from "./containerSystemEvents.js";
+import { ContainerTelemetryEventNames, } from "./containerTelemetry.js";
 /**
  * This class produces {@link IContainerTelemetry} from raw container system events {@link @fluidframework/fluid-static#IFluidContainerEvents}.
  * The class contains different helper methods for simplifying and standardizing logic for adding additional information necessary

package/lib/container/telemetryProducer.js.map

@@ -1 +1 @@
-{"version":3,"file":"telemetryProducer.js","sourceRoot":"","sources":["../../src/container/telemetryProducer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,EACN,4BAA4B,GAI5B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAEN,+BAA+B,GAC/B,MAAM,4BAA4B,CAAC;AAEpC;;;;GAIG;AACH,MAAM,OAAO,+BAA+B;IAM3C,YAAoC,WAAmB;QAAnB,gBAAW,GAAX,WAAW,CAAQ;QALvD;;WAEG;QACc,wBAAmB,GAAG,IAAI,EAAE,CAAC;QA2BvC,8BAAyB,GAAG,GAAoB,EAAE;YACxD,OAAO;gBACN,SAAS,EAAE,oCAAoC;gBAC/C,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;aACf,CAAC;QACjC,CAAC,CAAC;QAEe,kCAA6B,GAAG,CAChD,SAAsC,EAChB,EAAE;YACxB,OAAO;gBACN,SAAS;gBACT,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;aACf,CAAC;QACjC,CAAC,CAAC;QAEe,4BAAuB,GAAG,CAAC,OAE3C,EAA8B,EAAE;YAChC,MAAM,SAAS,GAA+B;gBAC7C,SAAS,EAAE,4BAA4B,CAAC,QAAQ;gBAChD,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;aAC7C,CAAC;YACF,IAAI,OAAO,EAAE,KAAK,KAAK,SAAS,EAAE;gBACjC,SAAS,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;aAChC;YACD,OAAO,SAAS,CAAC;QAClB,CAAC,CAAC;IAvDwD,CAAC;IAEpD,sBAAsB,CAC5B,SAAyC,EACzC,OAAiB;QAEjB,QAAQ,SAAS,EAAE;YAClB,KAAK,+BAA+B,CAAC,SAAS,CAAC,CAAC;gBAC/C,OAAO,IAAI,CAAC,6BAA6B,CAAC,4BAA4B,CAAC,SAAS,CAAC,CAAC;aAClF;YACD,KAAK,+BAA+B,CAAC,YAAY,CAAC,CAAC;gBAClD,OAAO,IAAI,CAAC,6BAA6B,CACxC,4BAA4B,CAAC,YAAY,CACzC,CAAC;aACF;YACD,KAAK,+BAA+B,CAAC,QAAQ,CAAC,CAAC;gBAC9C,MAAM,YAAY,GAAG,OAA8C,CAAC;gBACpE,OAAO,IAAI,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;aAClD;YACD,OAAO,CAAC,CAAC;gBACR,MAAM;aACN;SACD;IACF,CAAC;CAiCD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { type ICriticalContainerError } from \"@fluidframework/container-definitions\";\nimport { v4 as uuid } from \"uuid\";\nimport type { IFluidTelemetry } from \"../index.js\";\nimport {\n\tContainerTelemetryEventNames,\n\ttype ContainerTelemetryEventName,\n\ttype IContainerTelemetry,\n\ttype ContainerDisposedTelemetry,\n} from \"./containerTelemetry.js\";\nimport {\n\ttype IFluidContainerSystemEventName,\n\tIFluidContainerSystemEventNames,\n} from \"./containerSystemEvents.js\";\n\n/**\n * This class produces {@link IContainerTelemetry} from raw container system events {@link @fluidframework/fluid-static#IFluidContainerEvents}.\n * The class contains different helper methods for simplifying and standardizing logic for adding additional information necessary\n * to produce different {@link IContainerTelemetry}.\n */\nexport class ContainerEventTelemetryProducer {\n\t/**\n\t * Unique identifier for the instance of the container that this class is generating telemetry for.\n\t */\n\tprivate readonly containerInstanceId = uuid();\n\n\tpublic constructor(private readonly containerId: string) {}\n\n\tpublic produceFromSystemEvent(\n\t\teventName: IFluidContainerSystemEventName,\n\t\tpayload?: unknown,\n\t): IContainerTelemetry | undefined {\n\t\tswitch (eventName) {\n\t\t\tcase IFluidContainerSystemEventNames.CONNECTED: {\n\t\t\t\treturn this.produceBaseContainerTelemetry(ContainerTelemetryEventNames.CONNECTED);\n\t\t\t}\n\t\t\tcase IFluidContainerSystemEventNames.DISCONNECTED: {\n\t\t\t\treturn this.produceBaseContainerTelemetry(\n\t\t\t\t\tContainerTelemetryEventNames.DISCONNECTED,\n\t\t\t\t);\n\t\t\t}\n\t\t\tcase IFluidContainerSystemEventNames.DISPOSED: {\n\t\t\t\tconst typedPayload = payload as { error?: ICriticalContainerError };\n\t\t\t\treturn this.produceDiposedTelemetry(typedPayload);\n\t\t\t}\n\t\t\tdefault: {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t}\n\n\tpublic produceHeartbeatTelemetry = (): IFluidTelemetry => {\n\t\treturn {\n\t\t\teventName: \"fluidframework.container.heartbeat\",\n\t\t\tcontainerId: this.containerId,\n\t\t\tcontainerInstanceId: this.containerInstanceId,\n\t\t} as unknown as IFluidTelemetry;\n\t};\n\n\tprivate readonly produceBaseContainerTelemetry = (\n\t\teventName: ContainerTelemetryEventName,\n\t): IContainerTelemetry => {\n\t\treturn {\n\t\t\teventName,\n\t\t\tcontainerId: this.containerId,\n\t\t\tcontainerInstanceId: this.containerInstanceId,\n\t\t} satisfies IContainerTelemetry;\n\t};\n\n\tprivate readonly produceDiposedTelemetry = (payload?: {\n\t\terror?: ICriticalContainerError;\n\t}): ContainerDisposedTelemetry => {\n\t\tconst telemetry: ContainerDisposedTelemetry = {\n\t\t\teventName: ContainerTelemetryEventNames.DISPOSED,\n\t\t\tcontainerId: this.containerId,\n\t\t\tcontainerInstanceId: this.containerInstanceId,\n\t\t};\n\t\tif (payload?.error !== undefined) {\n\t\t\ttelemetry.error = payload.error;\n\t\t}\n\t\treturn telemetry;\n\t};\n}\n"]}
+{"version":3,"file":"telemetryProducer.js","sourceRoot":"","sources":["../../src/container/telemetryProducer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAIlC,OAAO,EAEN,+BAA+B,GAC/B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACN,4BAA4B,GAI5B,MAAM,yBAAyB,CAAC;AAEjC;;;;GAIG;AACH,MAAM,OAAO,+BAA+B;IAM3C,YAAoC,WAAmB;QAAnB,gBAAW,GAAX,WAAW,CAAQ;QALvD;;WAEG;QACc,wBAAmB,GAAG,IAAI,EAAE,CAAC;QAyBvC,8BAAyB,GAAG,GAAoB,EAAE;YACxD,OAAO;gBACN,SAAS,EAAE,oCAAoC;gBAC/C,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;aACf,CAAC;QACjC,CAAC,CAAC;QAEe,kCAA6B,GAAG,CAChD,SAAsC,EAChB,EAAE;YACxB,OAAO;gBACN,SAAS;gBACT,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;aACf,CAAC;QACjC,CAAC,CAAC;QAEe,4BAAuB,GAAG,CAAC,OAE3C,EAA8B,EAAE;YAChC,MAAM,SAAS,GAA+B;gBAC7C,SAAS,EAAE,4BAA4B,CAAC,QAAQ;gBAChD,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;aAC7C,CAAC;YACF,IAAI,OAAO,EAAE,KAAK,KAAK,SAAS,EAAE,CAAC;gBAClC,SAAS,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;YACjC,CAAC;YACD,OAAO,SAAS,CAAC;QAClB,CAAC,CAAC;IArDwD,CAAC;IAEpD,sBAAsB,CAC5B,SAAyC,EACzC,OAAiB;QAEjB,QAAQ,SAAS,EAAE,CAAC;YACnB,KAAK,+BAA+B,CAAC,SAAS,CAAC,CAAC,CAAC;gBAChD,OAAO,IAAI,CAAC,6BAA6B,CAAC,4BAA4B,CAAC,SAAS,CAAC,CAAC;YACnF,CAAC;YACD,KAAK,+BAA+B,CAAC,YAAY,CAAC,CAAC,CAAC;gBACnD,OAAO,IAAI,CAAC,6BAA6B,CAAC,4BAA4B,CAAC,YAAY,CAAC,CAAC;YACtF,CAAC;YACD,KAAK,+BAA+B,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAC/C,MAAM,YAAY,GAAG,OAA8C,CAAC;gBACpE,OAAO,IAAI,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;YACnD,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACT,MAAM;YACP,CAAC;QACF,CAAC;IACF,CAAC;CAiCD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ICriticalContainerError } from \"@fluidframework/container-definitions\";\nimport { v4 as uuid } from \"uuid\";\n\nimport type { IFluidTelemetry } from \"../index.js\";\n\nimport {\n\ttype IFluidContainerSystemEventName,\n\tIFluidContainerSystemEventNames,\n} from \"./containerSystemEvents.js\";\nimport {\n\tContainerTelemetryEventNames,\n\ttype ContainerTelemetryEventName,\n\ttype IContainerTelemetry,\n\ttype ContainerDisposedTelemetry,\n} from \"./containerTelemetry.js\";\n\n/**\n * This class produces {@link IContainerTelemetry} from raw container system events {@link @fluidframework/fluid-static#IFluidContainerEvents}.\n * The class contains different helper methods for simplifying and standardizing logic for adding additional information necessary\n * to produce different {@link IContainerTelemetry}.\n */\nexport class ContainerEventTelemetryProducer {\n\t/**\n\t * Unique identifier for the instance of the container that this class is generating telemetry for.\n\t */\n\tprivate readonly containerInstanceId = uuid();\n\n\tpublic constructor(private readonly containerId: string) {}\n\n\tpublic produceFromSystemEvent(\n\t\teventName: IFluidContainerSystemEventName,\n\t\tpayload?: unknown,\n\t): IContainerTelemetry | undefined {\n\t\tswitch (eventName) {\n\t\t\tcase IFluidContainerSystemEventNames.CONNECTED: {\n\t\t\t\treturn this.produceBaseContainerTelemetry(ContainerTelemetryEventNames.CONNECTED);\n\t\t\t}\n\t\t\tcase IFluidContainerSystemEventNames.DISCONNECTED: {\n\t\t\t\treturn this.produceBaseContainerTelemetry(ContainerTelemetryEventNames.DISCONNECTED);\n\t\t\t}\n\t\t\tcase IFluidContainerSystemEventNames.DISPOSED: {\n\t\t\t\tconst typedPayload = payload as { error?: ICriticalContainerError };\n\t\t\t\treturn this.produceDiposedTelemetry(typedPayload);\n\t\t\t}\n\t\t\tdefault: {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t}\n\n\tpublic produceHeartbeatTelemetry = (): IFluidTelemetry => {\n\t\treturn {\n\t\t\teventName: \"fluidframework.container.heartbeat\",\n\t\t\tcontainerId: this.containerId,\n\t\t\tcontainerInstanceId: this.containerInstanceId,\n\t\t} as unknown as IFluidTelemetry;\n\t};\n\n\tprivate readonly produceBaseContainerTelemetry = (\n\t\teventName: ContainerTelemetryEventName,\n\t): IContainerTelemetry => {\n\t\treturn {\n\t\t\teventName,\n\t\t\tcontainerId: this.containerId,\n\t\t\tcontainerInstanceId: this.containerInstanceId,\n\t\t} satisfies IContainerTelemetry;\n\t};\n\n\tprivate readonly produceDiposedTelemetry = (payload?: {\n\t\terror?: ICriticalContainerError;\n\t}): ContainerDisposedTelemetry => {\n\t\tconst telemetry: ContainerDisposedTelemetry = {\n\t\t\teventName: ContainerTelemetryEventNames.DISPOSED,\n\t\t\tcontainerId: this.containerId,\n\t\t\tcontainerInstanceId: this.containerInstanceId,\n\t\t};\n\t\tif (payload?.error !== undefined) {\n\t\t\ttelemetry.error = payload.error;\n\t\t}\n\t\treturn telemetry;\n\t};\n}\n"]}

package/lib/factory/index.d.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 import type { IFluidContainer } from "@fluidframework/fluid-static";
-import { type ITelemetryConsumer } from "../common/index.js";
+import type { ITelemetryConsumer } from "../common/index.js";
 /**
  * Configuration object for subscribing to {@link @fluidframework/fluid-telemetry#IFluidTelemetry} and consuming said telemetry via one or more {@link ITelemetryConsumer}
  *

package/lib/factory/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/factory/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAEpE,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAE7D;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,SAAS,EAAE,eAAe,CAAC;IAC3B;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,SAAS,EAAE,kBAAkB,EAAE,CAAC;CAChC;AAED;;;;;GAKG;AACH,eAAO,MAAM,cAAc,WAAY,eAAe,KAAG,IAGxD,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/factory/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAEpE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAM7D;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,SAAS,EAAE,eAAe,CAAC;IAC3B;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,SAAS,EAAE,kBAAkB,EAAE,CAAC;CAChC;AAED;;;;;GAKG;AACH,eAAO,MAAM,cAAc,WAAY,eAAe,KAAG,IAGxD,CAAC"}

package/lib/factory/index.js

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { ContainerTelemetryManager, ContainerEventTelemetryProducer } from "../container/index.js";
+import { ContainerTelemetryManager, ContainerEventTelemetryProducer, } from "../container/index.js";
 /**
  * Starts creating {@link @fluidframework/fluid-telemetry#IFluidTelemetry} by transforming raw system events emitted by the specified container
  * into said telemetry and passing it onto to the specified {@link ITelemetryConsumer}

package/lib/factory/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/factory/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,yBAAyB,EAAE,+BAA+B,EAAE,MAAM,uBAAuB,CAAC;AA0BnG;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,MAAuB,EAAQ,EAAE;IAC/D,MAAM,iBAAiB,GAAG,IAAI,+BAA+B,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAClF,IAAI,yBAAyB,CAAC,MAAM,CAAC,SAAS,EAAE,iBAAiB,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;AACtF,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IFluidContainer } from \"@fluidframework/fluid-static\";\nimport { ContainerTelemetryManager, ContainerEventTelemetryProducer } from \"../container/index.js\";\nimport { type ITelemetryConsumer } from \"../common/index.js\";\n\n/**\n * Configuration object for subscribing to {@link @fluidframework/fluid-telemetry#IFluidTelemetry} and consuming said telemetry via one or more {@link ITelemetryConsumer}\n *\n * @beta\n */\nexport interface TelemetryConfig {\n\t/**\n\t * The container whose events should be monitored, transformed into Fluid telemetry, and sent to a {@link ITelemetryConsumer}.\n\t */\n\tcontainer: IFluidContainer;\n\t/**\n\t * Unique identifier for the passed in container, i.e. the return value of a call\n\t * to {@link @fluidframework/fluid-static#IFluidContainer.attach | `IFluidContainer.attach()`} when creating a new\n\t * Fluid container, or the id used to load a pre-existing one.\n\t */\n\tcontainerId: string;\n\t/**\n\t * Conusmers take incoming produced {@link @fluidframework/fluid-telemetry#IFluidTelemetry} and do something of your choice with it.\n\t * This could be sending the telemetry to a cloud platform or just console logging.\n\t */\n\tconsumers: ITelemetryConsumer[];\n}\n\n/**\n * Starts creating {@link @fluidframework/fluid-telemetry#IFluidTelemetry} by transforming raw system events emitted by the specified container\n * into said telemetry and passing it onto to the specified {@link ITelemetryConsumer}\n *\n * @beta\n */\nexport const startTelemetry = (config: TelemetryConfig): void => {\n\tconst telemetryProducer = new ContainerEventTelemetryProducer(config.containerId);\n\tnew ContainerTelemetryManager(config.container, telemetryProducer, config.consumers);\n};\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/factory/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EACN,yBAAyB,EACzB,+BAA+B,GAC/B,MAAM,uBAAuB,CAAC;AAyB/B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,MAAuB,EAAQ,EAAE;IAC/D,MAAM,iBAAiB,GAAG,IAAI,+BAA+B,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAClF,IAAI,yBAAyB,CAAC,MAAM,CAAC,SAAS,EAAE,iBAAiB,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;AACtF,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IFluidContainer } from \"@fluidframework/fluid-static\";\n\nimport type { ITelemetryConsumer } from \"../common/index.js\";\nimport {\n\tContainerTelemetryManager,\n\tContainerEventTelemetryProducer,\n} from \"../container/index.js\";\n\n/**\n * Configuration object for subscribing to {@link @fluidframework/fluid-telemetry#IFluidTelemetry} and consuming said telemetry via one or more {@link ITelemetryConsumer}\n *\n * @beta\n */\nexport interface TelemetryConfig {\n\t/**\n\t * The container whose events should be monitored, transformed into Fluid telemetry, and sent to a {@link ITelemetryConsumer}.\n\t */\n\tcontainer: IFluidContainer;\n\t/**\n\t * Unique identifier for the passed in container, i.e. the return value of a call\n\t * to {@link @fluidframework/fluid-static#IFluidContainer.attach | `IFluidContainer.attach()`} when creating a new\n\t * Fluid container, or the id used to load a pre-existing one.\n\t */\n\tcontainerId: string;\n\t/**\n\t * Conusmers take incoming produced {@link @fluidframework/fluid-telemetry#IFluidTelemetry} and do something of your choice with it.\n\t * This could be sending the telemetry to a cloud platform or just console logging.\n\t */\n\tconsumers: ITelemetryConsumer[];\n}\n\n/**\n * Starts creating {@link @fluidframework/fluid-telemetry#IFluidTelemetry} by transforming raw system events emitted by the specified container\n * into said telemetry and passing it onto to the specified {@link ITelemetryConsumer}\n *\n * @beta\n */\nexport const startTelemetry = (config: TelemetryConfig): void => {\n\tconst telemetryProducer = new ContainerEventTelemetryProducer(config.containerId);\n\tnew ContainerTelemetryManager(config.container, telemetryProducer, config.consumers);\n};\n"]}

package/lib/legacy.d.ts

@@ -10,19 +10,5 @@
 
 export {
 	// @public APIs
-	ICriticalContainerError,
- 
-	// @beta APIs
-	AppInsightsTelemetryConsumer, 
-	ContainerConnectedTelemetry, 
-	ContainerDisconnectedTelemetry, 
-	ContainerDisposedTelemetry, 
-	ContainerTelemetryEventName, 
-	ContainerTelemetryEventNames, 
-	FluidTelemetryEventName, 
-	IContainerTelemetry, 
-	IFluidTelemetry, 
-	ITelemetryConsumer, 
-	TelemetryConfig, 
-	startTelemetry
+	ICriticalContainerError
 } from "./index.js";

package/lib/test/containerTelemetry.spec.js

@@ -2,13 +2,13 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { spy } from "sinon";
-import { expect } from "chai";
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { ApplicationInsights } from "@microsoft/applicationinsights-web";
+import { expect } from "chai";
+import { spy } from "sinon";
+import { IFluidContainerSystemEventNames, } from "../container/index.js";
 import { startTelemetry } from "../factory/index.js";
-import { IFluidContainerSystemEventNames } from "../container/index.js";
-import { ContainerTelemetryEventNames, } from "../index.js";
+import { AppInsightsTelemetryConsumer, ContainerTelemetryEventNames, } from "../index.js";
 /**
  * For these unit tests, we are just interested in the event emitter part of the Fluid container.
  * The rest of the functionality of IFluidContainer is irrelevant.
@@ -40,17 +40,6 @@ describe("container telemetry via", () => {
         });
         trackEventSpy = spy(appInsightsClient, "trackEvent");
         mockFluidContainer = new MockFluidContainer();
-        class AppInsightsTelemetryConsumer {
-            constructor(client) {
-                this.client = client;
-            }
-            consume(event) {
-                this.client.trackEvent({
-                    name: event.eventName,
-                    properties: event,
-                });
-            }
-        }
         telemetryConfig = {
             container: mockFluidContainer,
             containerId: mockContainerId,
@@ -74,7 +63,9 @@ describe("container telemetry via", () => {
         };
         expect(expectedAppInsightsTelemetry).to.deep.equal(actualAppInsightsTelemetry);
         // We won't know what the container containerInstanceId will be but we can still check that it is defined.
-        expect(actualContainerTelemetry.containerInstanceId).to.be.a("string").with.length.above(0);
+        expect(actualContainerTelemetry.containerInstanceId)
+            .to.be.a("string")
+            .with.length.above(0);
     });
     it("Emitting 'disconnected' container system event produces expected ContainerDisconnectedTelemetry using Azure App Insights", () => {
         startTelemetry(telemetryConfig);
@@ -93,7 +84,9 @@ describe("container telemetry via", () => {
         };
         expect(expectedAppInsightsTelemetry).to.deep.equal(actualAppInsightsTelemetry);
         // We won't know what the container containerInstanceId will be but we can still check that it is defined.
-        expect(actualContainerTelemetry.containerInstanceId).to.be.a("string").with.length.above(0);
+        expect(actualContainerTelemetry.containerInstanceId)
+            .to.be.a("string")
+            .with.length.above(0);
     });
     it("Emitting 'disposed' system event produces expected ContainerDisposedTelemetry using Azure App Insights", () => {
         startTelemetry(telemetryConfig);
@@ -112,7 +105,9 @@ describe("container telemetry via", () => {
         };
         expect(expectedAppInsightsTelemetry).to.deep.equal(actualAppInsightsTelemetry);
         // We won't know what the container containerInstanceId will be but we can still check that it is defined.
-        expect(actualContainerTelemetry.containerInstanceId).to.be.a("string").with.length.above(0);
+        expect(actualContainerTelemetry.containerInstanceId)
+            .to.be.a("string")
+            .with.length.above(0);
     });
     it("Emitting 'disposed' system event with an error produces expected ContainerDisposedTelemetry using Azure App Insights", () => {
         startTelemetry(telemetryConfig);
@@ -136,7 +131,9 @@ describe("container telemetry via", () => {
         };
         expect(expectedAppInsightsTelemetry).to.deep.equal(actualAppInsightsTelemetry);
         // We won't know what the container containerInstanceId will be but we can still check that it is defined.
-        expect(actualContainerTelemetry.containerInstanceId).to.be.a("string").with.length.above(0);
+        expect(actualContainerTelemetry.containerInstanceId)
+            .to.be.a("string")
+            .with.length.above(0);
     });
 });
 //# sourceMappingURL=containerTelemetry.spec.js.map

package/lib/test/containerTelemetry.spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"containerTelemetry.spec.js","sourceRoot":"","sources":["../../src/test/containerTelemetry.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAEjE,OAAO,EAAE,mBAAmB,EAAwB,MAAM,oCAAoC,CAAC;AAE/F,OAAO,EAAE,cAAc,EAAwB,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAE,+BAA+B,EAA4B,MAAM,uBAAuB,CAAC;AAClG,OAAO,EACN,4BAA4B,GAM5B,MAAM,aAAa,CAAC;AAErB;;;GAGG;AACH,MAAM,kBAAmB,SAAQ,iBAAwC;IACjE,OAAO;QACb,IAAI,CAAC,IAAI,CAAC,+BAA+B,CAAC,SAAS,CAAC,CAAC;IACtD,CAAC;IAEM,UAAU;QAChB,IAAI,CAAC,IAAI,CAAC,+BAA+B,CAAC,YAAY,CAAC,CAAC;IACzD,CAAC;IAEM,OAAO,CAAC,KAA+B;QAC7C,IAAI,CAAC,IAAI,CAAC,+BAA+B,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC5D,CAAC;CACD;AAED,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACxC,IAAI,kBAAsC,CAAC;IAC3C,MAAM,eAAe,GAAG,iBAAiB,CAAC;IAC1C,IAAI,iBAAsC,CAAC;IAC3C,IAAI,aAA6B,CAAC;IAClC,IAAI,eAAgC,CAAC;IAErC,UAAU,CAAC,GAAG,EAAE;QACf,iBAAiB,GAAG,IAAI,mBAAmB,CAAC;YAC3C,MAAM,EAAE;gBACP,gBAAgB;gBACf,8BAA8B;gBAC9B,+LAA+L;aAChM;SACD,CAAC,CAAC;QAEH,aAAa,GAAG,GAAG,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;QACrD,kBAAkB,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAE9C,MAAM,4BAA4B;YACjC,YAAoC,MAA2B;gBAA3B,WAAM,GAAN,MAAM,CAAqB;YAAG,CAAC;YAE5D,OAAO,CAAC,KAAsB;gBACpC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;oBACtB,IAAI,EAAE,KAAK,CAAC,SAAS;oBACrB,UAAU,EAAE,KAAK;iBACjB,CAAC,CAAC;YACJ,CAAC;SACD;QAED,eAAe,GAAG;YACjB,SAAS,EAAE,kBAAgD;YAC3D,WAAW,EAAE,eAAe;YAC5B,SAAS,EAAE,CAAC,IAAI,4BAA4B,CAAC,iBAAiB,CAAC,CAAC;SAChE,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oHAAoH,EAAE,GAAG,EAAE;QAC7H,cAAc,CAAC,eAAe,CAAC,CAAC;QAEhC,kBAAkB,CAAC,OAAO,EAAE,CAAC;QAE7B,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAE5C,iEAAiE;QACjE,MAAM,0BAA0B,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAoB,CAAC;QACvF,MAAM,wBAAwB,GAC7B,0BAA0B,CAAC,UAAiC,CAAC;QAE9D,MAAM,4BAA4B,GAAoB;YACrD,IAAI,EAAE,4BAA4B,CAAC,SAAS;YAC5C,UAAU,EAAE;gBACX,SAAS,EAAE,4BAA4B,CAAC,SAAS;gBACjD,WAAW,EAAE,eAAe;gBAC5B,mBAAmB,EAAE,wBAAwB,CAAC,mBAAmB;aAC3B;SACvC,CAAC;QAEF,MAAM,CAAC,4BAA4B,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC/E,0GAA0G;QAC1G,MAAM,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC7F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0HAA0H,EAAE,GAAG,EAAE;QACnI,cAAc,CAAC,eAAe,CAAC,CAAC;QAEhC,kBAAkB,CAAC,UAAU,EAAE,CAAC;QAEhC,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAE5C,iEAAiE;QACjE,MAAM,0BAA0B,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAoB,CAAC;QACvF,MAAM,wBAAwB,GAC7B,0BAA0B,CAAC,UAAiC,CAAC;QAE9D,MAAM,4BAA4B,GAAoB;YACrD,IAAI,EAAE,4BAA4B,CAAC,YAAY;YAC/C,UAAU,EAAE;gBACX,SAAS,EAAE,4BAA4B,CAAC,YAAY;gBACpD,WAAW,EAAE,eAAe;gBAC5B,mBAAmB,EAAE,wBAAwB,CAAC,mBAAmB;aACxB;SAC1C,CAAC;QAEF,MAAM,CAAC,4BAA4B,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC/E,0GAA0G;QAC1G,MAAM,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC7F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wGAAwG,EAAE,GAAG,EAAE;QACjH,cAAc,CAAC,eAAe,CAAC,CAAC;QAEhC,kBAAkB,CAAC,OAAO,EAAE,CAAC;QAE7B,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAE5C,iEAAiE;QACjE,MAAM,0BAA0B,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAoB,CAAC;QACvF,MAAM,wBAAwB,GAC7B,0BAA0B,CAAC,UAAiC,CAAC;QAE9D,MAAM,4BAA4B,GAAoB;YACrD,IAAI,EAAE,4BAA4B,CAAC,QAAQ;YAC3C,UAAU,EAAE;gBACX,SAAS,EAAE,4BAA4B,CAAC,QAAQ;gBAChD,WAAW,EAAE,eAAe;gBAC5B,mBAAmB,EAAE,wBAAwB,CAAC,mBAAmB;aAC5B;SACtC,CAAC;QAEF,MAAM,CAAC,4BAA4B,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC/E,0GAA0G;QAC1G,MAAM,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC7F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sHAAsH,EAAE,GAAG,EAAE;QAC/H,cAAc,CAAC,eAAe,CAAC,CAAC;QAEhC,MAAM,cAAc,GAA4B;YAC/C,SAAS,EAAE,eAAe;YAC1B,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,gDAAgD;SACvD,CAAC;QAEF,kBAAkB,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAE3C,iEAAiE;QACjE,MAAM,0BAA0B,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAoB,CAAC;QACvF,MAAM,wBAAwB,GAC7B,0BAA0B,CAAC,UAAiC,CAAC;QAE9D,MAAM,4BAA4B,GAAoB;YACrD,IAAI,EAAE,4BAA4B,CAAC,QAAQ;YAC3C,UAAU,EAAE;gBACX,SAAS,EAAE,4BAA4B,CAAC,QAAQ;gBAChD,WAAW,EAAE,eAAe;gBAC5B,mBAAmB,EAAE,wBAAwB,CAAC,mBAAmB;gBACjE,KAAK,EAAE,cAAc;aACgB;SACtC,CAAC;QAEF,MAAM,CAAC,4BAA4B,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC/E,0GAA0G;QAC1G,MAAM,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC7F,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type Sinon from \"sinon\";\nimport { spy } from \"sinon\";\nimport { expect } from \"chai\";\nimport { TypedEventEmitter } from \"@fluid-internal/client-utils\";\nimport type { ICriticalContainerError } from \"@fluidframework/container-definitions\";\nimport { ApplicationInsights, type IEventTelemetry } from \"@microsoft/applicationinsights-web\";\nimport type { IFluidContainer, IFluidContainerEvents } from \"@fluidframework/fluid-static\";\nimport { startTelemetry, type TelemetryConfig } from \"../factory/index.js\";\nimport { IFluidContainerSystemEventNames, type IContainerTelemetry } from \"../container/index.js\";\nimport {\n\tContainerTelemetryEventNames,\n\ttype ContainerConnectedTelemetry,\n\ttype ContainerDisconnectedTelemetry,\n\ttype ContainerDisposedTelemetry,\n\ttype IFluidTelemetry,\n\ttype ITelemetryConsumer,\n} from \"../index.js\";\n\n/**\n * For these unit tests, we are just interested in the event emitter part of the Fluid container.\n * The rest of the functionality of IFluidContainer is irrelevant.\n */\nclass MockFluidContainer extends TypedEventEmitter<IFluidContainerEvents> {\n\tpublic connect(): void {\n\t\tthis.emit(IFluidContainerSystemEventNames.CONNECTED);\n\t}\n\n\tpublic disconnect(): void {\n\t\tthis.emit(IFluidContainerSystemEventNames.DISCONNECTED);\n\t}\n\n\tpublic dispose(error?: ICriticalContainerError): void {\n\t\tthis.emit(IFluidContainerSystemEventNames.DISPOSED, error);\n\t}\n}\n\ndescribe(\"container telemetry via\", () => {\n\tlet mockFluidContainer: MockFluidContainer;\n\tconst mockContainerId = \"mockContainerId\";\n\tlet appInsightsClient: ApplicationInsights;\n\tlet trackEventSpy: Sinon.SinonSpy;\n\tlet telemetryConfig: TelemetryConfig;\n\n\tbeforeEach(() => {\n\t\tappInsightsClient = new ApplicationInsights({\n\t\t\tconfig: {\n\t\t\t\tconnectionString:\n\t\t\t\t\t// (this is an example string)\n\t\t\t\t\t\"InstrumentationKey=abcdefgh-ijkl-mnop-qrst-uvwxyz6ffd9c;IngestionEndpoint=https://westus2-2.in.applicationinsights.azure.com/;LiveEndpoint=https://westus2.livediagnostics.monitor.azure.com/\",\n\t\t\t},\n\t\t});\n\n\t\ttrackEventSpy = spy(appInsightsClient, \"trackEvent\");\n\t\tmockFluidContainer = new MockFluidContainer();\n\n\t\tclass AppInsightsTelemetryConsumer implements ITelemetryConsumer {\n\t\t\tpublic constructor(private readonly client: ApplicationInsights) {}\n\n\t\t\tpublic consume(event: IFluidTelemetry): void {\n\t\t\t\tthis.client.trackEvent({\n\t\t\t\t\tname: event.eventName,\n\t\t\t\t\tproperties: event,\n\t\t\t\t});\n\t\t\t}\n\t\t}\n\n\t\ttelemetryConfig = {\n\t\t\tcontainer: mockFluidContainer as unknown as IFluidContainer,\n\t\t\tcontainerId: mockContainerId,\n\t\t\tconsumers: [new AppInsightsTelemetryConsumer(appInsightsClient)],\n\t\t};\n\t});\n\n\tit(\"Emitting 'connected' container system event produces expected ContainerConnectedTelemetry using Azure App Insights\", () => {\n\t\tstartTelemetry(telemetryConfig);\n\n\t\tmockFluidContainer.connect();\n\n\t\texpect(trackEventSpy.callCount).to.equal(1);\n\n\t\t// Obtain the events from the method that the spy was called with\n\t\tconst actualAppInsightsTelemetry = trackEventSpy.getCall(0).args[0] as IEventTelemetry;\n\t\tconst actualContainerTelemetry =\n\t\t\tactualAppInsightsTelemetry.properties as IContainerTelemetry;\n\n\t\tconst expectedAppInsightsTelemetry: IEventTelemetry = {\n\t\t\tname: ContainerTelemetryEventNames.CONNECTED,\n\t\t\tproperties: {\n\t\t\t\teventName: ContainerTelemetryEventNames.CONNECTED,\n\t\t\t\tcontainerId: mockContainerId,\n\t\t\t\tcontainerInstanceId: actualContainerTelemetry.containerInstanceId,\n\t\t\t} satisfies ContainerConnectedTelemetry,\n\t\t};\n\n\t\texpect(expectedAppInsightsTelemetry).to.deep.equal(actualAppInsightsTelemetry);\n\t\t// We won't know what the container containerInstanceId will be but we can still check that it is defined.\n\t\texpect(actualContainerTelemetry.containerInstanceId).to.be.a(\"string\").with.length.above(0);\n\t});\n\n\tit(\"Emitting 'disconnected' container system event produces expected ContainerDisconnectedTelemetry using Azure App Insights\", () => {\n\t\tstartTelemetry(telemetryConfig);\n\n\t\tmockFluidContainer.disconnect();\n\n\t\texpect(trackEventSpy.callCount).to.equal(1);\n\n\t\t// Obtain the events from the method that the spy was called with\n\t\tconst actualAppInsightsTelemetry = trackEventSpy.getCall(0).args[0] as IEventTelemetry;\n\t\tconst actualContainerTelemetry =\n\t\t\tactualAppInsightsTelemetry.properties as IContainerTelemetry;\n\n\t\tconst expectedAppInsightsTelemetry: IEventTelemetry = {\n\t\t\tname: ContainerTelemetryEventNames.DISCONNECTED,\n\t\t\tproperties: {\n\t\t\t\teventName: ContainerTelemetryEventNames.DISCONNECTED,\n\t\t\t\tcontainerId: mockContainerId,\n\t\t\t\tcontainerInstanceId: actualContainerTelemetry.containerInstanceId,\n\t\t\t} satisfies ContainerDisconnectedTelemetry,\n\t\t};\n\n\t\texpect(expectedAppInsightsTelemetry).to.deep.equal(actualAppInsightsTelemetry);\n\t\t// We won't know what the container containerInstanceId will be but we can still check that it is defined.\n\t\texpect(actualContainerTelemetry.containerInstanceId).to.be.a(\"string\").with.length.above(0);\n\t});\n\n\tit(\"Emitting 'disposed' system event produces expected ContainerDisposedTelemetry using Azure App Insights\", () => {\n\t\tstartTelemetry(telemetryConfig);\n\n\t\tmockFluidContainer.dispose();\n\n\t\texpect(trackEventSpy.callCount).to.equal(1);\n\n\t\t// Obtain the events from the method that the spy was called with\n\t\tconst actualAppInsightsTelemetry = trackEventSpy.getCall(0).args[0] as IEventTelemetry;\n\t\tconst actualContainerTelemetry =\n\t\t\tactualAppInsightsTelemetry.properties as IContainerTelemetry;\n\n\t\tconst expectedAppInsightsTelemetry: IEventTelemetry = {\n\t\t\tname: ContainerTelemetryEventNames.DISPOSED,\n\t\t\tproperties: {\n\t\t\t\teventName: ContainerTelemetryEventNames.DISPOSED,\n\t\t\t\tcontainerId: mockContainerId,\n\t\t\t\tcontainerInstanceId: actualContainerTelemetry.containerInstanceId,\n\t\t\t} satisfies ContainerDisposedTelemetry,\n\t\t};\n\n\t\texpect(expectedAppInsightsTelemetry).to.deep.equal(actualAppInsightsTelemetry);\n\t\t// We won't know what the container containerInstanceId will be but we can still check that it is defined.\n\t\texpect(actualContainerTelemetry.containerInstanceId).to.be.a(\"string\").with.length.above(0);\n\t});\n\n\tit(\"Emitting 'disposed' system event with an error produces expected ContainerDisposedTelemetry using Azure App Insights\", () => {\n\t\tstartTelemetry(telemetryConfig);\n\n\t\tconst containerError: ICriticalContainerError = {\n\t\t\terrorType: \"unknown error\",\n\t\t\tmessage: \"An unknown error occured\",\n\t\t\tstack: \"example stack error at line 52 of Container.ts\",\n\t\t};\n\n\t\tmockFluidContainer.dispose(containerError);\n\n\t\t// Obtain the events from the method that the spy was called with\n\t\tconst actualAppInsightsTelemetry = trackEventSpy.getCall(0).args[0] as IEventTelemetry;\n\t\tconst actualContainerTelemetry =\n\t\t\tactualAppInsightsTelemetry.properties as IContainerTelemetry;\n\n\t\tconst expectedAppInsightsTelemetry: IEventTelemetry = {\n\t\t\tname: ContainerTelemetryEventNames.DISPOSED,\n\t\t\tproperties: {\n\t\t\t\teventName: ContainerTelemetryEventNames.DISPOSED,\n\t\t\t\tcontainerId: mockContainerId,\n\t\t\t\tcontainerInstanceId: actualContainerTelemetry.containerInstanceId,\n\t\t\t\terror: containerError,\n\t\t\t} satisfies ContainerDisposedTelemetry,\n\t\t};\n\n\t\texpect(expectedAppInsightsTelemetry).to.deep.equal(actualAppInsightsTelemetry);\n\t\t// We won't know what the container containerInstanceId will be but we can still check that it is defined.\n\t\texpect(actualContainerTelemetry.containerInstanceId).to.be.a(\"string\").with.length.above(0);\n\t});\n});\n"]}
+{"version":3,"file":"containerTelemetry.spec.js","sourceRoot":"","sources":["../../src/test/containerTelemetry.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGjE,OAAO,EAAE,mBAAmB,EAAwB,MAAM,oCAAoC,CAAC;AAC/F,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAG5B,OAAO,EACN,+BAA+B,GAE/B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAwB,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EACN,4BAA4B,EAC5B,4BAA4B,GAI5B,MAAM,aAAa,CAAC;AAErB;;;GAGG;AACH,MAAM,kBAAmB,SAAQ,iBAAwC;IACjE,OAAO;QACb,IAAI,CAAC,IAAI,CAAC,+BAA+B,CAAC,SAAS,CAAC,CAAC;IACtD,CAAC;IAEM,UAAU;QAChB,IAAI,CAAC,IAAI,CAAC,+BAA+B,CAAC,YAAY,CAAC,CAAC;IACzD,CAAC;IAEM,OAAO,CAAC,KAA+B;QAC7C,IAAI,CAAC,IAAI,CAAC,+BAA+B,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC5D,CAAC;CACD;AAED,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACxC,IAAI,kBAAsC,CAAC;IAC3C,MAAM,eAAe,GAAG,iBAAiB,CAAC;IAC1C,IAAI,iBAAsC,CAAC;IAC3C,IAAI,aAA6B,CAAC;IAClC,IAAI,eAAgC,CAAC;IAErC,UAAU,CAAC,GAAG,EAAE;QACf,iBAAiB,GAAG,IAAI,mBAAmB,CAAC;YAC3C,MAAM,EAAE;gBACP,gBAAgB;gBACf,8BAA8B;gBAC9B,+LAA+L;aAChM;SACD,CAAC,CAAC;QAEH,aAAa,GAAG,GAAG,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;QACrD,kBAAkB,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAE9C,eAAe,GAAG;YACjB,SAAS,EAAE,kBAAgD;YAC3D,WAAW,EAAE,eAAe;YAC5B,SAAS,EAAE,CAAC,IAAI,4BAA4B,CAAC,iBAAiB,CAAC,CAAC;SAChE,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oHAAoH,EAAE,GAAG,EAAE;QAC7H,cAAc,CAAC,eAAe,CAAC,CAAC;QAEhC,kBAAkB,CAAC,OAAO,EAAE,CAAC;QAE7B,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAE5C,iEAAiE;QACjE,MAAM,0BAA0B,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAoB,CAAC;QACvF,MAAM,wBAAwB,GAC7B,0BAA0B,CAAC,UAAiC,CAAC;QAE9D,MAAM,4BAA4B,GAAoB;YACrD,IAAI,EAAE,4BAA4B,CAAC,SAAS;YAC5C,UAAU,EAAE;gBACX,SAAS,EAAE,4BAA4B,CAAC,SAAS;gBACjD,WAAW,EAAE,eAAe;gBAC5B,mBAAmB,EAAE,wBAAwB,CAAC,mBAAmB;aAC3B;SACvC,CAAC;QAEF,MAAM,CAAC,4BAA4B,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC/E,0GAA0G;QAC1G,MAAM,CAAC,wBAAwB,CAAC,mBAAmB,CAAC;aAClD,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;aACjB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0HAA0H,EAAE,GAAG,EAAE;QACnI,cAAc,CAAC,eAAe,CAAC,CAAC;QAEhC,kBAAkB,CAAC,UAAU,EAAE,CAAC;QAEhC,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAE5C,iEAAiE;QACjE,MAAM,0BAA0B,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAoB,CAAC;QACvF,MAAM,wBAAwB,GAC7B,0BAA0B,CAAC,UAAiC,CAAC;QAE9D,MAAM,4BAA4B,GAAoB;YACrD,IAAI,EAAE,4BAA4B,CAAC,YAAY;YAC/C,UAAU,EAAE;gBACX,SAAS,EAAE,4BAA4B,CAAC,YAAY;gBACpD,WAAW,EAAE,eAAe;gBAC5B,mBAAmB,EAAE,wBAAwB,CAAC,mBAAmB;aACxB;SAC1C,CAAC;QAEF,MAAM,CAAC,4BAA4B,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC/E,0GAA0G;QAC1G,MAAM,CAAC,wBAAwB,CAAC,mBAAmB,CAAC;aAClD,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;aACjB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wGAAwG,EAAE,GAAG,EAAE;QACjH,cAAc,CAAC,eAAe,CAAC,CAAC;QAEhC,kBAAkB,CAAC,OAAO,EAAE,CAAC;QAE7B,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAE5C,iEAAiE;QACjE,MAAM,0BAA0B,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAoB,CAAC;QACvF,MAAM,wBAAwB,GAC7B,0BAA0B,CAAC,UAAiC,CAAC;QAE9D,MAAM,4BAA4B,GAAoB;YACrD,IAAI,EAAE,4BAA4B,CAAC,QAAQ;YAC3C,UAAU,EAAE;gBACX,SAAS,EAAE,4BAA4B,CAAC,QAAQ;gBAChD,WAAW,EAAE,eAAe;gBAC5B,mBAAmB,EAAE,wBAAwB,CAAC,mBAAmB;aAC5B;SACtC,CAAC;QAEF,MAAM,CAAC,4BAA4B,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC/E,0GAA0G;QAC1G,MAAM,CAAC,wBAAwB,CAAC,mBAAmB,CAAC;aAClD,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;aACjB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sHAAsH,EAAE,GAAG,EAAE;QAC/H,cAAc,CAAC,eAAe,CAAC,CAAC;QAEhC,MAAM,cAAc,GAA4B;YAC/C,SAAS,EAAE,eAAe;YAC1B,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,gDAAgD;SACvD,CAAC;QAEF,kBAAkB,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAE3C,iEAAiE;QACjE,MAAM,0BAA0B,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAoB,CAAC;QACvF,MAAM,wBAAwB,GAC7B,0BAA0B,CAAC,UAAiC,CAAC;QAE9D,MAAM,4BAA4B,GAAoB;YACrD,IAAI,EAAE,4BAA4B,CAAC,QAAQ;YAC3C,UAAU,EAAE;gBACX,SAAS,EAAE,4BAA4B,CAAC,QAAQ;gBAChD,WAAW,EAAE,eAAe;gBAC5B,mBAAmB,EAAE,wBAAwB,CAAC,mBAAmB;gBACjE,KAAK,EAAE,cAAc;aACgB;SACtC,CAAC;QAEF,MAAM,CAAC,4BAA4B,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC/E,0GAA0G;QAC1G,MAAM,CAAC,wBAAwB,CAAC,mBAAmB,CAAC;aAClD,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;aACjB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { TypedEventEmitter } from \"@fluid-internal/client-utils\";\nimport type { ICriticalContainerError } from \"@fluidframework/container-definitions\";\nimport type { IFluidContainer, IFluidContainerEvents } from \"@fluidframework/fluid-static\";\nimport { ApplicationInsights, type IEventTelemetry } from \"@microsoft/applicationinsights-web\";\nimport { expect } from \"chai\";\nimport { spy } from \"sinon\";\nimport type Sinon from \"sinon\";\n\nimport {\n\tIFluidContainerSystemEventNames,\n\ttype IContainerTelemetry,\n} from \"../container/index.js\";\nimport { startTelemetry, type TelemetryConfig } from \"../factory/index.js\";\nimport {\n\tAppInsightsTelemetryConsumer,\n\tContainerTelemetryEventNames,\n\ttype ContainerConnectedTelemetry,\n\ttype ContainerDisconnectedTelemetry,\n\ttype ContainerDisposedTelemetry,\n} from \"../index.js\";\n\n/**\n * For these unit tests, we are just interested in the event emitter part of the Fluid container.\n * The rest of the functionality of IFluidContainer is irrelevant.\n */\nclass MockFluidContainer extends TypedEventEmitter<IFluidContainerEvents> {\n\tpublic connect(): void {\n\t\tthis.emit(IFluidContainerSystemEventNames.CONNECTED);\n\t}\n\n\tpublic disconnect(): void {\n\t\tthis.emit(IFluidContainerSystemEventNames.DISCONNECTED);\n\t}\n\n\tpublic dispose(error?: ICriticalContainerError): void {\n\t\tthis.emit(IFluidContainerSystemEventNames.DISPOSED, error);\n\t}\n}\n\ndescribe(\"container telemetry via\", () => {\n\tlet mockFluidContainer: MockFluidContainer;\n\tconst mockContainerId = \"mockContainerId\";\n\tlet appInsightsClient: ApplicationInsights;\n\tlet trackEventSpy: Sinon.SinonSpy;\n\tlet telemetryConfig: TelemetryConfig;\n\n\tbeforeEach(() => {\n\t\tappInsightsClient = new ApplicationInsights({\n\t\t\tconfig: {\n\t\t\t\tconnectionString:\n\t\t\t\t\t// (this is an example string)\n\t\t\t\t\t\"InstrumentationKey=abcdefgh-ijkl-mnop-qrst-uvwxyz6ffd9c;IngestionEndpoint=https://westus2-2.in.applicationinsights.azure.com/;LiveEndpoint=https://westus2.livediagnostics.monitor.azure.com/\",\n\t\t\t},\n\t\t});\n\n\t\ttrackEventSpy = spy(appInsightsClient, \"trackEvent\");\n\t\tmockFluidContainer = new MockFluidContainer();\n\n\t\ttelemetryConfig = {\n\t\t\tcontainer: mockFluidContainer as unknown as IFluidContainer,\n\t\t\tcontainerId: mockContainerId,\n\t\t\tconsumers: [new AppInsightsTelemetryConsumer(appInsightsClient)],\n\t\t};\n\t});\n\n\tit(\"Emitting 'connected' container system event produces expected ContainerConnectedTelemetry using Azure App Insights\", () => {\n\t\tstartTelemetry(telemetryConfig);\n\n\t\tmockFluidContainer.connect();\n\n\t\texpect(trackEventSpy.callCount).to.equal(1);\n\n\t\t// Obtain the events from the method that the spy was called with\n\t\tconst actualAppInsightsTelemetry = trackEventSpy.getCall(0).args[0] as IEventTelemetry;\n\t\tconst actualContainerTelemetry =\n\t\t\tactualAppInsightsTelemetry.properties as IContainerTelemetry;\n\n\t\tconst expectedAppInsightsTelemetry: IEventTelemetry = {\n\t\t\tname: ContainerTelemetryEventNames.CONNECTED,\n\t\t\tproperties: {\n\t\t\t\teventName: ContainerTelemetryEventNames.CONNECTED,\n\t\t\t\tcontainerId: mockContainerId,\n\t\t\t\tcontainerInstanceId: actualContainerTelemetry.containerInstanceId,\n\t\t\t} satisfies ContainerConnectedTelemetry,\n\t\t};\n\n\t\texpect(expectedAppInsightsTelemetry).to.deep.equal(actualAppInsightsTelemetry);\n\t\t// We won't know what the container containerInstanceId will be but we can still check that it is defined.\n\t\texpect(actualContainerTelemetry.containerInstanceId)\n\t\t\t.to.be.a(\"string\")\n\t\t\t.with.length.above(0);\n\t});\n\n\tit(\"Emitting 'disconnected' container system event produces expected ContainerDisconnectedTelemetry using Azure App Insights\", () => {\n\t\tstartTelemetry(telemetryConfig);\n\n\t\tmockFluidContainer.disconnect();\n\n\t\texpect(trackEventSpy.callCount).to.equal(1);\n\n\t\t// Obtain the events from the method that the spy was called with\n\t\tconst actualAppInsightsTelemetry = trackEventSpy.getCall(0).args[0] as IEventTelemetry;\n\t\tconst actualContainerTelemetry =\n\t\t\tactualAppInsightsTelemetry.properties as IContainerTelemetry;\n\n\t\tconst expectedAppInsightsTelemetry: IEventTelemetry = {\n\t\t\tname: ContainerTelemetryEventNames.DISCONNECTED,\n\t\t\tproperties: {\n\t\t\t\teventName: ContainerTelemetryEventNames.DISCONNECTED,\n\t\t\t\tcontainerId: mockContainerId,\n\t\t\t\tcontainerInstanceId: actualContainerTelemetry.containerInstanceId,\n\t\t\t} satisfies ContainerDisconnectedTelemetry,\n\t\t};\n\n\t\texpect(expectedAppInsightsTelemetry).to.deep.equal(actualAppInsightsTelemetry);\n\t\t// We won't know what the container containerInstanceId will be but we can still check that it is defined.\n\t\texpect(actualContainerTelemetry.containerInstanceId)\n\t\t\t.to.be.a(\"string\")\n\t\t\t.with.length.above(0);\n\t});\n\n\tit(\"Emitting 'disposed' system event produces expected ContainerDisposedTelemetry using Azure App Insights\", () => {\n\t\tstartTelemetry(telemetryConfig);\n\n\t\tmockFluidContainer.dispose();\n\n\t\texpect(trackEventSpy.callCount).to.equal(1);\n\n\t\t// Obtain the events from the method that the spy was called with\n\t\tconst actualAppInsightsTelemetry = trackEventSpy.getCall(0).args[0] as IEventTelemetry;\n\t\tconst actualContainerTelemetry =\n\t\t\tactualAppInsightsTelemetry.properties as IContainerTelemetry;\n\n\t\tconst expectedAppInsightsTelemetry: IEventTelemetry = {\n\t\t\tname: ContainerTelemetryEventNames.DISPOSED,\n\t\t\tproperties: {\n\t\t\t\teventName: ContainerTelemetryEventNames.DISPOSED,\n\t\t\t\tcontainerId: mockContainerId,\n\t\t\t\tcontainerInstanceId: actualContainerTelemetry.containerInstanceId,\n\t\t\t} satisfies ContainerDisposedTelemetry,\n\t\t};\n\n\t\texpect(expectedAppInsightsTelemetry).to.deep.equal(actualAppInsightsTelemetry);\n\t\t// We won't know what the container containerInstanceId will be but we can still check that it is defined.\n\t\texpect(actualContainerTelemetry.containerInstanceId)\n\t\t\t.to.be.a(\"string\")\n\t\t\t.with.length.above(0);\n\t});\n\n\tit(\"Emitting 'disposed' system event with an error produces expected ContainerDisposedTelemetry using Azure App Insights\", () => {\n\t\tstartTelemetry(telemetryConfig);\n\n\t\tconst containerError: ICriticalContainerError = {\n\t\t\terrorType: \"unknown error\",\n\t\t\tmessage: \"An unknown error occured\",\n\t\t\tstack: \"example stack error at line 52 of Container.ts\",\n\t\t};\n\n\t\tmockFluidContainer.dispose(containerError);\n\n\t\t// Obtain the events from the method that the spy was called with\n\t\tconst actualAppInsightsTelemetry = trackEventSpy.getCall(0).args[0] as IEventTelemetry;\n\t\tconst actualContainerTelemetry =\n\t\t\tactualAppInsightsTelemetry.properties as IContainerTelemetry;\n\n\t\tconst expectedAppInsightsTelemetry: IEventTelemetry = {\n\t\t\tname: ContainerTelemetryEventNames.DISPOSED,\n\t\t\tproperties: {\n\t\t\t\teventName: ContainerTelemetryEventNames.DISPOSED,\n\t\t\t\tcontainerId: mockContainerId,\n\t\t\t\tcontainerInstanceId: actualContainerTelemetry.containerInstanceId,\n\t\t\t\terror: containerError,\n\t\t\t} satisfies ContainerDisposedTelemetry,\n\t\t};\n\n\t\texpect(expectedAppInsightsTelemetry).to.deep.equal(actualAppInsightsTelemetry);\n\t\t// We won't know what the container containerInstanceId will be but we can still check that it is defined.\n\t\texpect(actualContainerTelemetry.containerInstanceId)\n\t\t\t.to.be.a(\"string\")\n\t\t\t.with.length.above(0);\n\t});\n});\n"]}

package/lib/test/containerTelemetryEndToEnd.spec.realsvc.d.ts

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

package/lib/test/containerTelemetryEndToEnd.spec.realsvc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"containerTelemetryEndToEnd.spec.realsvc.d.ts","sourceRoot":"","sources":["../../src/test/containerTelemetryEndToEnd.spec.realsvc.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/lib/test/containerTelemetryEndToEnd.spec.realsvc.js

@@ -0,0 +1,160 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { timeoutPromise } from "@fluidframework/test-utils/internal";
+import { TinyliciousClient } from "@fluidframework/tinylicious-client/internal";
+import { SharedTree } from "@fluidframework/tree/internal";
+import { expect } from "chai";
+import { spy } from "sinon";
+import { startTelemetry } from "../factory/index.js";
+import { ContainerTelemetryEventNames, } from "../index.js";
+// This test suite creates an actual IFluidContainer and confirms events are fired with the expected names during the expected events
+describe("container telemetry E2E", () => {
+    let schema;
+    let tinyliciousClient;
+    let telemetryConsumerConsumeSpy;
+    let testTelemetryConsumer;
+    // Simple test class that will be used as the telemetry consumer.
+    class TestTelemetryConsumer {
+        consume(event) {
+            return;
+        }
+    }
+    before(() => {
+        tinyliciousClient = new TinyliciousClient({ connection: { port: 7070 } });
+        schema = {
+            initialObjects: {
+                sharedTree1: SharedTree,
+            },
+        };
+        testTelemetryConsumer = new TestTelemetryConsumer();
+        telemetryConsumerConsumeSpy = spy(testTelemetryConsumer, "consume");
+    });
+    beforeEach(() => {
+        // We need to reset the telemetry consumer spy for each test so the trackEvent calls
+        // from the last test don't bleed into the next one.
+        telemetryConsumerConsumeSpy.resetHistory();
+    });
+    it("IFluid container's 'connected' system event produces expected ContainerConnectedTelemetry using ITelemetryConsumer", async () => {
+        const { container } = await tinyliciousClient.createContainer(schema, "2");
+        const containerId = await container.attach();
+        startTelemetry({
+            container,
+            containerId,
+            consumers: [testTelemetryConsumer],
+        });
+        // We don't know exactly when the given container events that we're looking for will fire so we have to
+        // wrap the container.on(...) event handler within a promise that will be awaited at the end of the test.
+        const { actualContainerTelemetry, expectedContainerTelemetry } = await timeoutPromise((resolve) => {
+            container.on("connected", () => {
+                // We are making an assumption here that the 'connected' event is the first and only event sent to the ITelemetryConsumer.
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                const containerTelemetryFromSpy = telemetryConsumerConsumeSpy.getCalls()[0]
+                    .args[0];
+                resolve({
+                    actualContainerTelemetry: containerTelemetryFromSpy,
+                    expectedContainerTelemetry: {
+                        eventName: ContainerTelemetryEventNames.CONNECTED,
+                        containerId,
+                        // containerInstanceId is a uniquely generated UUID by the fluid-telemetry's ContainerEventTelemetryProducer class.
+                        // We can't use the underlying container's id because it is not exposed by IFluidContainer.
+                        containerInstanceId: containerTelemetryFromSpy.containerInstanceId,
+                    },
+                });
+            });
+        }, { durationMs: 5000, errorMsg: "timeout while waiting for container 'connected' event" });
+        expect(expectedContainerTelemetry).to.deep.equal(actualContainerTelemetry);
+        // We won't know what the container containerInstanceId will be but we can still check that it is defined.
+        expect(actualContainerTelemetry.containerInstanceId)
+            .to.be.a("string")
+            .with.length.above(0);
+    });
+    it("IFluid container's 'disconnected' system event produces expected ContainerDisconnectedTelemetry using ITelemetryConsumer", async () => {
+        const { container } = await tinyliciousClient.createContainer(schema, "2");
+        const containerId = await container.attach();
+        startTelemetry({
+            container,
+            containerId,
+            consumers: [testTelemetryConsumer],
+        });
+        // We don't know exactly when the given container events that we're looking for will fire so we have to
+        // wrap the container.on(...) event handler within a promise that will be awaited at the end of the test.
+        const { actualContainerTelemetry, expectedContainerTelemetry } = await timeoutPromise((resolve) => {
+            // Event handler 1: As soon as the container connects, we're ready to initiate a disconnect.
+            container.on("connected", () => {
+                container.disconnect();
+            });
+            container.on("disconnected", () => {
+                // We are making an assumption here that the 'disconnected' event is the second sent to the ITelemetryConsumer.
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                const containerTelemetryFromSpy = telemetryConsumerConsumeSpy.getCalls()[1]
+                    .args[0];
+                resolve({
+                    actualContainerTelemetry: containerTelemetryFromSpy,
+                    expectedContainerTelemetry: {
+                        eventName: ContainerTelemetryEventNames.DISCONNECTED,
+                        containerId,
+                        // containerInstanceId is a uniquely generated UUID by the fluid-telemetry's ContainerEventTelemetryProducer class.
+                        // We can't use the underlying container's id because it is not exposed by IFluidContainer.
+                        containerInstanceId: containerTelemetryFromSpy.containerInstanceId,
+                    },
+                });
+            });
+        }, {
+            durationMs: 5000,
+            errorMsg: "timeout while waiting for container 'connected' and/or 'disconnected' event",
+        });
+        expect(expectedContainerTelemetry).to.deep.equal(actualContainerTelemetry);
+        // We won't know what the container containerInstanceId will be but we can still check that it is defined.
+        expect(actualContainerTelemetry.containerInstanceId)
+            .to.be.a("string")
+            .with.length.above(0);
+    });
+    it("IFluid container's 'disposed' system event produces expected ContainerDisposedTelemetry using ITelemetryConsumer", async () => {
+        const { container } = await tinyliciousClient.createContainer(schema, "2");
+        const containerId = await container.attach();
+        startTelemetry({
+            container,
+            containerId,
+            consumers: [testTelemetryConsumer],
+        });
+        // We don't know exactly when the given container events that we're looking for will fire so we have to
+        // wrap the container.on(...) event handler within a promise that will be awaited at the end of the test.
+        const { actualContainerTelemetry, expectedContainerTelemetry } = await timeoutPromise((resolve, reject) => {
+            // Event handler 1: As soon as the container connects, we're ready to initiate a disconnect.
+            container.on("connected", () => {
+                container.disconnect();
+            });
+            // Event handler 2: As soon as the container disconnects, we're ready to initiate a dispose.
+            container.on("disconnected", () => {
+                container.dispose();
+            });
+            container.on("disposed", () => {
+                // We are making an assumption here that the 'disposed' event is the third sent to the ITelemetryConsumer.
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                const containerTelemetryFromSpy = telemetryConsumerConsumeSpy.getCalls()[2]
+                    .args[0];
+                resolve({
+                    actualContainerTelemetry: containerTelemetryFromSpy,
+                    expectedContainerTelemetry: {
+                        eventName: ContainerTelemetryEventNames.DISPOSED,
+                        containerId,
+                        // containerInstanceId is a uniquely generated UUID by the fluid-telemetry's ContainerEventTelemetryProducer class.
+                        // We can't use the underlying container's id because it is not exposed by IFluidContainer.
+                        containerInstanceId: containerTelemetryFromSpy.containerInstanceId,
+                    },
+                });
+            });
+        }, {
+            durationMs: 5000,
+            errorMsg: "timeout while waiting for container 'connected' and/or 'disconnected' event",
+        });
+        expect(expectedContainerTelemetry).to.deep.equal(actualContainerTelemetry);
+        // We won't know what the container containerInstanceId will be but we can still check that it is defined.
+        expect(actualContainerTelemetry.containerInstanceId)
+            .to.be.a("string")
+            .with.length.above(0);
+    });
+});
+//# sourceMappingURL=containerTelemetryEndToEnd.spec.realsvc.js.map

package/lib/test/containerTelemetryEndToEnd.spec.realsvc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"containerTelemetryEndToEnd.spec.realsvc.js","sourceRoot":"","sources":["../../src/test/containerTelemetryEndToEnd.spec.realsvc.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,6CAA6C,CAAC;AAChF,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAE5B,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EACN,4BAA4B,GAM5B,MAAM,aAAa,CAAC;AAErB,qIAAqI;AAErI,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACxC,IAAI,MAAuB,CAAC;IAC5B,IAAI,iBAAoC,CAAC;IACzC,IAAI,2BAA2C,CAAC;IAChD,IAAI,qBAAyC,CAAC;IAE9C,iEAAiE;IACjE,MAAM,qBAAqB;QACnB,OAAO,CAAC,KAAsB;YACpC,OAAO;QACR,CAAC;KACD;IAED,MAAM,CAAC,GAAG,EAAE;QACX,iBAAiB,GAAG,IAAI,iBAAiB,CAAC,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QAC1E,MAAM,GAAG;YACR,cAAc,EAAE;gBACf,WAAW,EAAE,UAAU;aACvB;SACD,CAAC;QAEF,qBAAqB,GAAG,IAAI,qBAAqB,EAAE,CAAC;QACpD,2BAA2B,GAAG,GAAG,CAAC,qBAAqB,EAAE,SAAS,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,GAAG,EAAE;QACf,oFAAoF;QACpF,oDAAoD;QACpD,2BAA2B,CAAC,YAAY,EAAE,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oHAAoH,EAAE,KAAK,IAAI,EAAE;QACnI,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,iBAAiB,CAAC,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAE3E,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,CAAC;QAC7C,cAAc,CAAC;YACd,SAAS;YACT,WAAW;YACX,SAAS,EAAE,CAAC,qBAAqB,CAAC;SAClC,CAAC,CAAC;QAEH,uGAAuG;QACvG,yGAAyG;QACzG,MAAM,EAAE,wBAAwB,EAAE,0BAA0B,EAAE,GAAG,MAAM,cAAc,CAIpF,CAAC,OAAO,EAAE,EAAE;YACX,SAAS,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE;gBAC9B,0HAA0H;gBAC1H,oEAAoE;gBACpE,MAAM,yBAAyB,GAAG,2BAA2B,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAE;qBAC1E,IAAI,CAAC,CAAC,CAAgC,CAAC;gBAEzC,OAAO,CAAC;oBACP,wBAAwB,EAAE,yBAAyB;oBACnD,0BAA0B,EAAE;wBAC3B,SAAS,EAAE,4BAA4B,CAAC,SAAS;wBACjD,WAAW;wBACX,mHAAmH;wBACnH,2FAA2F;wBAC3F,mBAAmB,EAAE,yBAAyB,CAAC,mBAAmB;qBAClE;iBACD,CAAC,CAAC;YACJ,CAAC,CAAC,CAAC;QACJ,CAAC,EACD,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,uDAAuD,EAAE,CACvF,CAAC;QAEF,MAAM,CAAC,0BAA0B,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC3E,0GAA0G;QAC1G,MAAM,CAAC,wBAAwB,CAAC,mBAAmB,CAAC;aAClD,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;aACjB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0HAA0H,EAAE,KAAK,IAAI,EAAE;QACzI,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,iBAAiB,CAAC,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAE3E,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,CAAC;QAC7C,cAAc,CAAC;YACd,SAAS;YACT,WAAW;YACX,SAAS,EAAE,CAAC,qBAAqB,CAAC;SAClC,CAAC,CAAC;QAEH,uGAAuG;QACvG,yGAAyG;QACzG,MAAM,EAAE,wBAAwB,EAAE,0BAA0B,EAAE,GAAG,MAAM,cAAc,CAIpF,CAAC,OAAO,EAAE,EAAE;YACX,4FAA4F;YAC5F,SAAS,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE;gBAC9B,SAAS,CAAC,UAAU,EAAE,CAAC;YACxB,CAAC,CAAC,CAAC;YAEH,SAAS,CAAC,EAAE,CAAC,cAAc,EAAE,GAAG,EAAE;gBACjC,+GAA+G;gBAC/G,oEAAoE;gBACpE,MAAM,yBAAyB,GAAG,2BAA2B,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAE;qBAC1E,IAAI,CAAC,CAAC,CAAmC,CAAC;gBAE5C,OAAO,CAAC;oBACP,wBAAwB,EAAE,yBAAyB;oBACnD,0BAA0B,EAAE;wBAC3B,SAAS,EAAE,4BAA4B,CAAC,YAAY;wBACpD,WAAW;wBACX,mHAAmH;wBACnH,2FAA2F;wBAC3F,mBAAmB,EAAE,yBAAyB,CAAC,mBAAmB;qBAClE;iBACD,CAAC,CAAC;YACJ,CAAC,CAAC,CAAC;QACJ,CAAC,EACD;YACC,UAAU,EAAE,IAAI;YAChB,QAAQ,EACP,6EAA6E;SAC9E,CACD,CAAC;QAEF,MAAM,CAAC,0BAA0B,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC3E,0GAA0G;QAC1G,MAAM,CAAC,wBAAwB,CAAC,mBAAmB,CAAC;aAClD,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;aACjB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kHAAkH,EAAE,KAAK,IAAI,EAAE;QACjI,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,iBAAiB,CAAC,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAE3E,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,CAAC;QAC7C,cAAc,CAAC;YACd,SAAS;YACT,WAAW;YACX,SAAS,EAAE,CAAC,qBAAqB,CAAC;SAClC,CAAC,CAAC;QAEH,uGAAuG;QACvG,yGAAyG;QACzG,MAAM,EAAE,wBAAwB,EAAE,0BAA0B,EAAE,GAAG,MAAM,cAAc,CAIpF,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnB,4FAA4F;YAC5F,SAAS,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE;gBAC9B,SAAS,CAAC,UAAU,EAAE,CAAC;YACxB,CAAC,CAAC,CAAC;YAEH,4FAA4F;YAC5F,SAAS,CAAC,EAAE,CAAC,cAAc,EAAE,GAAG,EAAE;gBACjC,SAAS,CAAC,OAAO,EAAE,CAAC;YACrB,CAAC,CAAC,CAAC;YAEH,SAAS,CAAC,EAAE,CAAC,UAAU,EAAE,GAAG,EAAE;gBAC7B,0GAA0G;gBAC1G,oEAAoE;gBACpE,MAAM,yBAAyB,GAAG,2BAA2B,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAE;qBAC1E,IAAI,CAAC,CAAC,CAA+B,CAAC;gBAExC,OAAO,CAAC;oBACP,wBAAwB,EAAE,yBAAyB;oBACnD,0BAA0B,EAAE;wBAC3B,SAAS,EAAE,4BAA4B,CAAC,QAAQ;wBAChD,WAAW;wBACX,mHAAmH;wBACnH,2FAA2F;wBAC3F,mBAAmB,EAAE,yBAAyB,CAAC,mBAAmB;qBAClE;iBACD,CAAC,CAAC;YACJ,CAAC,CAAC,CAAC;QACJ,CAAC,EACD;YACC,UAAU,EAAE,IAAI;YAChB,QAAQ,EACP,6EAA6E;SAC9E,CACD,CAAC;QAEF,MAAM,CAAC,0BAA0B,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC3E,0GAA0G;QAC1G,MAAM,CAAC,wBAAwB,CAAC,mBAAmB,CAAC;aAClD,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;aACjB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ContainerSchema } from \"@fluidframework/fluid-static\";\nimport { timeoutPromise } from \"@fluidframework/test-utils/internal\";\nimport { TinyliciousClient } from \"@fluidframework/tinylicious-client/internal\";\nimport { SharedTree } from \"@fluidframework/tree/internal\";\nimport { expect } from \"chai\";\nimport type Sinon from \"sinon\";\nimport { spy } from \"sinon\";\n\nimport { startTelemetry } from \"../factory/index.js\";\nimport {\n\tContainerTelemetryEventNames,\n\ttype ContainerConnectedTelemetry,\n\ttype ContainerDisconnectedTelemetry,\n\ttype ContainerDisposedTelemetry,\n\ttype IFluidTelemetry,\n\ttype ITelemetryConsumer,\n} from \"../index.js\";\n\n// This test suite creates an actual IFluidContainer and confirms events are fired with the expected names during the expected events\n\ndescribe(\"container telemetry E2E\", () => {\n\tlet schema: ContainerSchema;\n\tlet tinyliciousClient: TinyliciousClient;\n\tlet telemetryConsumerConsumeSpy: Sinon.SinonSpy;\n\tlet testTelemetryConsumer: ITelemetryConsumer;\n\n\t// Simple test class that will be used as the telemetry consumer.\n\tclass TestTelemetryConsumer implements ITelemetryConsumer {\n\t\tpublic consume(event: IFluidTelemetry): void {\n\t\t\treturn;\n\t\t}\n\t}\n\n\tbefore(() => {\n\t\ttinyliciousClient = new TinyliciousClient({ connection: { port: 7070 } });\n\t\tschema = {\n\t\t\tinitialObjects: {\n\t\t\t\tsharedTree1: SharedTree,\n\t\t\t},\n\t\t};\n\n\t\ttestTelemetryConsumer = new TestTelemetryConsumer();\n\t\ttelemetryConsumerConsumeSpy = spy(testTelemetryConsumer, \"consume\");\n\t});\n\n\tbeforeEach(() => {\n\t\t// We need to reset the telemetry consumer spy for each test so the trackEvent calls\n\t\t// from the last test don't bleed into the next one.\n\t\ttelemetryConsumerConsumeSpy.resetHistory();\n\t});\n\n\tit(\"IFluid container's 'connected' system event produces expected ContainerConnectedTelemetry using ITelemetryConsumer\", async () => {\n\t\tconst { container } = await tinyliciousClient.createContainer(schema, \"2\");\n\n\t\tconst containerId = await container.attach();\n\t\tstartTelemetry({\n\t\t\tcontainer,\n\t\t\tcontainerId,\n\t\t\tconsumers: [testTelemetryConsumer],\n\t\t});\n\n\t\t// We don't know exactly when the given container events that we're looking for will fire so we have to\n\t\t// wrap the container.on(...) event handler within a promise that will be awaited at the end of the test.\n\t\tconst { actualContainerTelemetry, expectedContainerTelemetry } = await timeoutPromise<{\n\t\t\tactualContainerTelemetry: ContainerConnectedTelemetry;\n\t\t\texpectedContainerTelemetry: ContainerConnectedTelemetry;\n\t\t}>(\n\t\t\t(resolve) => {\n\t\t\t\tcontainer.on(\"connected\", () => {\n\t\t\t\t\t// We are making an assumption here that the 'connected' event is the first and only event sent to the ITelemetryConsumer.\n\t\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\t\t\tconst containerTelemetryFromSpy = telemetryConsumerConsumeSpy.getCalls()[0]!\n\t\t\t\t\t\t.args[0] as ContainerConnectedTelemetry;\n\n\t\t\t\t\tresolve({\n\t\t\t\t\t\tactualContainerTelemetry: containerTelemetryFromSpy,\n\t\t\t\t\t\texpectedContainerTelemetry: {\n\t\t\t\t\t\t\teventName: ContainerTelemetryEventNames.CONNECTED,\n\t\t\t\t\t\t\tcontainerId,\n\t\t\t\t\t\t\t// containerInstanceId is a uniquely generated UUID by the fluid-telemetry's ContainerEventTelemetryProducer class.\n\t\t\t\t\t\t\t// We can't use the underlying container's id because it is not exposed by IFluidContainer.\n\t\t\t\t\t\t\tcontainerInstanceId: containerTelemetryFromSpy.containerInstanceId,\n\t\t\t\t\t\t},\n\t\t\t\t\t});\n\t\t\t\t});\n\t\t\t},\n\t\t\t{ durationMs: 5000, errorMsg: \"timeout while waiting for container 'connected' event\" },\n\t\t);\n\n\t\texpect(expectedContainerTelemetry).to.deep.equal(actualContainerTelemetry);\n\t\t// We won't know what the container containerInstanceId will be but we can still check that it is defined.\n\t\texpect(actualContainerTelemetry.containerInstanceId)\n\t\t\t.to.be.a(\"string\")\n\t\t\t.with.length.above(0);\n\t});\n\n\tit(\"IFluid container's 'disconnected' system event produces expected ContainerDisconnectedTelemetry using ITelemetryConsumer\", async () => {\n\t\tconst { container } = await tinyliciousClient.createContainer(schema, \"2\");\n\n\t\tconst containerId = await container.attach();\n\t\tstartTelemetry({\n\t\t\tcontainer,\n\t\t\tcontainerId,\n\t\t\tconsumers: [testTelemetryConsumer],\n\t\t});\n\n\t\t// We don't know exactly when the given container events that we're looking for will fire so we have to\n\t\t// wrap the container.on(...) event handler within a promise that will be awaited at the end of the test.\n\t\tconst { actualContainerTelemetry, expectedContainerTelemetry } = await timeoutPromise<{\n\t\t\tactualContainerTelemetry: ContainerDisconnectedTelemetry;\n\t\t\texpectedContainerTelemetry: ContainerDisconnectedTelemetry;\n\t\t}>(\n\t\t\t(resolve) => {\n\t\t\t\t// Event handler 1: As soon as the container connects, we're ready to initiate a disconnect.\n\t\t\t\tcontainer.on(\"connected\", () => {\n\t\t\t\t\tcontainer.disconnect();\n\t\t\t\t});\n\n\t\t\t\tcontainer.on(\"disconnected\", () => {\n\t\t\t\t\t// We are making an assumption here that the 'disconnected' event is the second sent to the ITelemetryConsumer.\n\t\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\t\t\tconst containerTelemetryFromSpy = telemetryConsumerConsumeSpy.getCalls()[1]!\n\t\t\t\t\t\t.args[0] as ContainerDisconnectedTelemetry;\n\n\t\t\t\t\tresolve({\n\t\t\t\t\t\tactualContainerTelemetry: containerTelemetryFromSpy,\n\t\t\t\t\t\texpectedContainerTelemetry: {\n\t\t\t\t\t\t\teventName: ContainerTelemetryEventNames.DISCONNECTED,\n\t\t\t\t\t\t\tcontainerId,\n\t\t\t\t\t\t\t// containerInstanceId is a uniquely generated UUID by the fluid-telemetry's ContainerEventTelemetryProducer class.\n\t\t\t\t\t\t\t// We can't use the underlying container's id because it is not exposed by IFluidContainer.\n\t\t\t\t\t\t\tcontainerInstanceId: containerTelemetryFromSpy.containerInstanceId,\n\t\t\t\t\t\t},\n\t\t\t\t\t});\n\t\t\t\t});\n\t\t\t},\n\t\t\t{\n\t\t\t\tdurationMs: 5000,\n\t\t\t\terrorMsg:\n\t\t\t\t\t\"timeout while waiting for container 'connected' and/or 'disconnected' event\",\n\t\t\t},\n\t\t);\n\n\t\texpect(expectedContainerTelemetry).to.deep.equal(actualContainerTelemetry);\n\t\t// We won't know what the container containerInstanceId will be but we can still check that it is defined.\n\t\texpect(actualContainerTelemetry.containerInstanceId)\n\t\t\t.to.be.a(\"string\")\n\t\t\t.with.length.above(0);\n\t});\n\n\tit(\"IFluid container's 'disposed' system event produces expected ContainerDisposedTelemetry using ITelemetryConsumer\", async () => {\n\t\tconst { container } = await tinyliciousClient.createContainer(schema, \"2\");\n\n\t\tconst containerId = await container.attach();\n\t\tstartTelemetry({\n\t\t\tcontainer,\n\t\t\tcontainerId,\n\t\t\tconsumers: [testTelemetryConsumer],\n\t\t});\n\n\t\t// We don't know exactly when the given container events that we're looking for will fire so we have to\n\t\t// wrap the container.on(...) event handler within a promise that will be awaited at the end of the test.\n\t\tconst { actualContainerTelemetry, expectedContainerTelemetry } = await timeoutPromise<{\n\t\t\tactualContainerTelemetry: ContainerDisposedTelemetry;\n\t\t\texpectedContainerTelemetry: ContainerDisposedTelemetry;\n\t\t}>(\n\t\t\t(resolve, reject) => {\n\t\t\t\t// Event handler 1: As soon as the container connects, we're ready to initiate a disconnect.\n\t\t\t\tcontainer.on(\"connected\", () => {\n\t\t\t\t\tcontainer.disconnect();\n\t\t\t\t});\n\n\t\t\t\t// Event handler 2: As soon as the container disconnects, we're ready to initiate a dispose.\n\t\t\t\tcontainer.on(\"disconnected\", () => {\n\t\t\t\t\tcontainer.dispose();\n\t\t\t\t});\n\n\t\t\t\tcontainer.on(\"disposed\", () => {\n\t\t\t\t\t// We are making an assumption here that the 'disposed' event is the third sent to the ITelemetryConsumer.\n\t\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\t\t\tconst containerTelemetryFromSpy = telemetryConsumerConsumeSpy.getCalls()[2]!\n\t\t\t\t\t\t.args[0] as ContainerDisposedTelemetry;\n\n\t\t\t\t\tresolve({\n\t\t\t\t\t\tactualContainerTelemetry: containerTelemetryFromSpy,\n\t\t\t\t\t\texpectedContainerTelemetry: {\n\t\t\t\t\t\t\teventName: ContainerTelemetryEventNames.DISPOSED,\n\t\t\t\t\t\t\tcontainerId,\n\t\t\t\t\t\t\t// containerInstanceId is a uniquely generated UUID by the fluid-telemetry's ContainerEventTelemetryProducer class.\n\t\t\t\t\t\t\t// We can't use the underlying container's id because it is not exposed by IFluidContainer.\n\t\t\t\t\t\t\tcontainerInstanceId: containerTelemetryFromSpy.containerInstanceId,\n\t\t\t\t\t\t},\n\t\t\t\t\t});\n\t\t\t\t});\n\t\t\t},\n\t\t\t{\n\t\t\t\tdurationMs: 5000,\n\t\t\t\terrorMsg:\n\t\t\t\t\t\"timeout while waiting for container 'connected' and/or 'disconnected' event\",\n\t\t\t},\n\t\t);\n\n\t\texpect(expectedContainerTelemetry).to.deep.equal(actualContainerTelemetry);\n\t\t// We won't know what the container containerInstanceId will be but we can still check that it is defined.\n\t\texpect(actualContainerTelemetry.containerInstanceId)\n\t\t\t.to.be.a(\"string\")\n\t\t\t.with.length.above(0);\n\t});\n});\n"]}

package/lib/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.43.1"
+      "packageVersion": "7.45.1"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/fluid-telemetry",
-  "version": "2.0.0-rc.4.0.6",
+  "version": "2.0.0-rc.5.0.1",
   "description": "Customer facing Fluid telemetry types and classes for both producing and consuming said telemetry",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -57,32 +57,39 @@
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "dependencies": {
-    "@fluidframework/container-definitions": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
-    "@fluidframework/container-loader": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
-    "@fluidframework/fluid-static": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
+    "@fluidframework/container-definitions": ">=2.0.0-rc.5.0.1 <2.0.0-rc.5.1.0",
+    "@fluidframework/container-loader": ">=2.0.0-rc.5.0.1 <2.0.0-rc.5.1.0",
+    "@fluidframework/fluid-static": ">=2.0.0-rc.5.0.1 <2.0.0-rc.5.1.0",
     "@microsoft/applicationinsights-web": "^2.8.11",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
-    "@fluid-internal/client-utils": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
-    "@fluid-internal/mocha-test-setup": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
-    "@fluid-tools/build-cli": "^0.38.0",
-    "@fluidframework/build-tools": "^0.38.0",
-    "@microsoft/api-extractor": "^7.43.1",
+    "@biomejs/biome": "^1.7.3",
+    "@fluid-internal/client-utils": ">=2.0.0-rc.5.0.1 <2.0.0-rc.5.1.0",
+    "@fluid-internal/mocha-test-setup": ">=2.0.0-rc.5.0.1 <2.0.0-rc.5.1.0",
+    "@fluid-tools/build-cli": "^0.39.0",
+    "@fluidframework/build-tools": "^0.39.0",
+    "@fluidframework/test-utils": ">=2.0.0-rc.5.0.1 <2.0.0-rc.5.1.0",
+    "@fluidframework/tinylicious-client": ">=2.0.0-rc.5.0.1 <2.0.0-rc.5.1.0",
+    "@fluidframework/tree": ">=2.0.0-rc.5.0.1 <2.0.0-rc.5.1.0",
+    "@microsoft/api-extractor": "^7.45.1",
     "@types/chai": "^4.0.0",
     "@types/mocha": "^9.1.1",
     "@types/sinon": "^17.0.3",
     "@types/uuid": "^9.0.2",
     "chai": "^4.2.0",
+    "concurrently": "^8.2.1",
     "copyfiles": "^2.4.1",
     "eslint": "~8.55.0",
     "mocha": "^10.2.0",
     "prettier": "~3.0.3",
     "rimraf": "^4.4.0",
     "sinon": "^17.0.1",
+    "start-server-and-test": "^2.0.3",
+    "tinylicious": "^5.0.0",
     "tslib": "^1.10.0",
-    "typescript": "~5.1.6"
+    "typescript": "~5.4.5"
   },
   "fluidBuild": {
     "tasks": {
@@ -105,21 +112,42 @@
     "build:docs": "api-extractor run --local",
     "build:esnext": "tsc --project ./tsconfig.json",
     "check:are-the-types-wrong": "attw --pack .",
-    "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
+    "check:biome": "biome check . --formatter-enabled=true",
+    "check:exports": "concurrently \"npm:check:exports:*\"",
+    "check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
+    "check:exports:cjs:beta": "api-extractor run --config api-extractor/api-extractor-lint-beta.cjs.json",
+    "check:exports:cjs:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.cjs.json",
+    "check:exports:cjs:public": "api-extractor run --config api-extractor/api-extractor-lint-public.cjs.json",
+    "check:exports:esm:beta": "api-extractor run --config api-extractor/api-extractor-lint-beta.esm.json",
+    "check:exports:esm:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.esm.json",
+    "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
+    "check:format": "npm run check:biome",
+    "check:prettier": "prettier --check . --cache --ignore-path ../../../../.prettierignore",
     "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob _api-extractor-temp coverage dist lib \"*.d.ts\" nyc \"**/*.tsbuildinfo\" \"**/*.build.log\"",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
-    "format": "fluid-build --task format .",
+    "format": "npm run format:biome",
     "format-and-build": "npm run format && npm run build",
     "format-and-compile": "npm run format && npm run build:compile",
+    "format:biome": "biome check . --formatter-enabled=true --apply",
     "format:prettier": "prettier --write . --cache --ignore-path ../../../../.prettierignore",
     "lint": "fluid-build . --task lint",
     "lint:fix": "fluid-build . --task eslint:fix --task format",
-    "test": "npm run test:mocha",
-    "test:mocha": "npm run test:mocha:esm && echo skipping cjs to avoid overhead - npm run test:mocha:cjs",
-    "test:mocha:cjs": "mocha --recursive \"dist/test/**/*.spec.*js\" --exit",
-    "test:mocha:esm": "mocha --recursive \"lib/test/**/*.spec.*js\" --exit",
+    "start:tinylicious:test": "tinylicious > tinylicious.log 2>&1",
+    "test": "start-server-and-test start:tinylicious:test 7070 test:mocha:all",
+    "test:mocha": "npm run test:mocha:esm:unit && echo skipping cjs to avoid overhead - npm run test:mocha:cjs:unit",
+    "test:mocha:all": "npm run test:mocha:esm:all && echo skipping cjs to avoid overhead - npm run test:mocha:cjs:all",
+    "test:mocha:cjs:all": "mocha --recursive \"dist/test/**/*.spec*.js\" --exit",
+    "test:mocha:cjs:end-to-end": "mocha --recursive \"dist/test/**/*.spec.realsvc.js\" --exit",
+    "test:mocha:cjs:unit": "mocha --recursive \"dist/test/**/*.spec.js\" --exit",
+    "test:mocha:end-to-end": "npm run test:mocha:esm:end-to-end && echo skipping cjs to avoid overhead - npm run test:mocha:cjs:end-to-end",
+    "test:mocha:esm:all": "mocha --recursive \"lib/test/**/*.spec*.js\" --exit",
+    "test:mocha:esm:end-to-end": "mocha --recursive \"lib/test/**/*.spec.realsvc.js\" --exit",
+    "test:mocha:esm:unit": "mocha --recursive \"lib/test/**/*.spec.js\" --exit",
+    "test:realsvc": "npm run test:realsvc:tinylicious",
+    "test:realsvc:tinylicious": "start-server-and-test start:tinylicious:test 7070 test:realsvc:tinylicious:run",
+    "test:realsvc:tinylicious:run": "npm run test:mocha:end-to-end",
     "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../../common/build/build-common/src/cjs/package.json ./dist",
     "typetests:gen": "flub generate typetests --dir . -v --publicFallback",
     "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"

package/src/app-insights/appInsightsTelemetryConsumer.ts

@@ -3,7 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import { type ApplicationInsights } from "@microsoft/applicationinsights-web";
+import type { ApplicationInsights } from "@microsoft/applicationinsights-web";
+
 import type { IFluidTelemetry, ITelemetryConsumer } from "../common/index.js";
 
 /**

package/src/container/containerTelemetry.ts

@@ -3,8 +3,9 @@
  * Licensed under the MIT License.
  */
 
-import { type ICriticalContainerError } from "@fluidframework/container-definitions";
-import { type IFluidTelemetry } from "../common/index.js";
+import type { ICriticalContainerError } from "@fluidframework/container-definitions";
+
+import type { IFluidTelemetry } from "../common/index.js";
 
 /**
  * This file contains the types for container telemetry that can be produced.

package/src/container/telemetryManager.ts

@@ -3,16 +3,18 @@
  * Licensed under the MIT License.
  */
 
-import { type ICriticalContainerError } from "@fluidframework/container-definitions";
-import type { IFluidContainer } from "@fluidframework/fluid-static";
+import type { ICriticalContainerError } from "@fluidframework/container-definitions";
 import { ConnectionState } from "@fluidframework/container-loader";
-import { type ITelemetryConsumer } from "../common/index.js";
-import { type IContainerTelemetry } from "./containerTelemetry.js";
-import type { ContainerEventTelemetryProducer } from "./telemetryProducer.js";
+import type { IFluidContainer } from "@fluidframework/fluid-static";
+
+import type { ITelemetryConsumer } from "../common/index.js";
+
 import {
 	type IFluidContainerSystemEventName,
 	IFluidContainerSystemEventNames,
 } from "./containerSystemEvents.js";
+import type { IContainerTelemetry } from "./containerTelemetry.js";
+import type { ContainerEventTelemetryProducer } from "./telemetryProducer.js";
 
 /**
  * This class manages container telemetry intended for customers to consume by wiring together the provided container system events, telemetry producers and consumers together.