@fluidframework/telemetry-utils 0.47.0-36699 → 0.48.0-38142

package/dist/index.d.ts

@@ -8,6 +8,7 @@ export * from "./eventEmitterWithErrorHandling";
 export * from "./events";
 export * from "./fluidErrorBase";
 export * from "./logger";
+export * from "./mockLogger";
 export * from "./thresholdCounter";
 export * from "./utils";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iCAAiC,CAAC;AAChD,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iCAAiC,CAAC;AAChD,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -20,6 +20,7 @@ __exportStar(require("./eventEmitterWithErrorHandling"), exports);
 __exportStar(require("./events"), exports);
 __exportStar(require("./fluidErrorBase"), exports);
 __exportStar(require("./logger"), exports);
+__exportStar(require("./mockLogger"), exports);
 __exportStar(require("./thresholdCounter"), exports);
 __exportStar(require("./utils"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA;;;GAGG;AACH,gDAA8B;AAC9B,iDAA+B;AAC/B,kEAAgD;AAChD,2CAAyB;AACzB,mDAAiC;AACjC,2CAAyB;AACzB,qDAAmC;AACnC,0CAAwB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nexport * from \"./debugLogger\";\nexport * from \"./errorLogging\";\nexport * from \"./eventEmitterWithErrorHandling\";\nexport * from \"./events\";\nexport * from \"./fluidErrorBase\";\nexport * from \"./logger\";\nexport * from \"./thresholdCounter\";\nexport * from \"./utils\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA;;;GAGG;AACH,gDAA8B;AAC9B,iDAA+B;AAC/B,kEAAgD;AAChD,2CAAyB;AACzB,mDAAiC;AACjC,2CAAyB;AACzB,+CAA6B;AAC7B,qDAAmC;AACnC,0CAAwB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nexport * from \"./debugLogger\";\nexport * from \"./errorLogging\";\nexport * from \"./eventEmitterWithErrorHandling\";\nexport * from \"./events\";\nexport * from \"./fluidErrorBase\";\nexport * from \"./logger\";\nexport * from \"./mockLogger\";\nexport * from \"./thresholdCounter\";\nexport * from \"./utils\";\n"]}

package/dist/mockLogger.d.ts

@@ -0,0 +1,38 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ITelemetryLogger, ITelemetryBaseEvent } from "@fluidframework/common-definitions";
+import { TelemetryLogger } from "./logger";
+/**
+ * The MockLogger records events sent to it, and then can walk back over those events
+ * searching for a set of expected events to match against the logged events.
+ */
+export declare class MockLogger extends TelemetryLogger implements ITelemetryLogger {
+    events: ITelemetryBaseEvent[];
+    constructor();
+    send(event: ITelemetryBaseEvent): void;
+    /**
+     * Search events logged since the last time matchEvents was called, looking for the given expected
+     * events in order.
+     * @param expectedEvents - events in order that are expected to appear in the recorded log.
+     * These event objects may be subsets of the logged events.
+     * Note: category is ommitted from the type because it's usually uninteresting and tedious to type.
+     */
+    matchEvents(expectedEvents: Omit<ITelemetryBaseEvent, "category">[]): boolean;
+    /**
+     * Search events logged since the last time matchEvents was called, looking for any of the given
+     * expected events.
+     * @param expectedEvents - events that are expected to appear in the recorded log.
+     * These event objects may be subsets of the logged events.
+     * Note: category is ommitted from the type because it's usually uninteresting and tedious to type.
+     * @returns if any of the expected events is found.
+     */
+    matchAnyEvent(expectedEvents: Omit<ITelemetryBaseEvent, "category">[]): boolean;
+    private getMatchedEventsCount;
+    /**
+     * Ensure the expected event is a strict subset of the actual event
+     */
+    private static eventsMatch;
+}
+//# sourceMappingURL=mockLogger.d.ts.map

package/dist/mockLogger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mockLogger.d.ts","sourceRoot":"","sources":["../src/mockLogger.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAC3F,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE3C;;;GAGG;AACH,qBAAa,UAAW,SAAQ,eAAgB,YAAW,gBAAgB;IACvE,MAAM,EAAE,mBAAmB,EAAE,CAAM;;IAInC,IAAI,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;IAItC;;;;;;OAMG;IACH,WAAW,CAAC,cAAc,EAAE,IAAI,CAAC,mBAAmB,EAAE,UAAU,CAAC,EAAE,GAAG,OAAO;IAO7E;;;;;;;OAOG;IACH,aAAa,CAAC,cAAc,EAAE,IAAI,CAAC,mBAAmB,EAAE,UAAU,CAAC,EAAE,GAAG,OAAO;IAK/E,OAAO,CAAC,qBAAqB;IAkB7B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;CAI7B"}

package/dist/mockLogger.js

@@ -0,0 +1,69 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MockLogger = void 0;
+const logger_1 = require("./logger");
+/**
+ * The MockLogger records events sent to it, and then can walk back over those events
+ * searching for a set of expected events to match against the logged events.
+ */
+class MockLogger extends logger_1.TelemetryLogger {
+    constructor() {
+        super();
+        this.events = [];
+    }
+    send(event) {
+        this.events.push(event);
+    }
+    /**
+     * Search events logged since the last time matchEvents was called, looking for the given expected
+     * events in order.
+     * @param expectedEvents - events in order that are expected to appear in the recorded log.
+     * These event objects may be subsets of the logged events.
+     * Note: category is ommitted from the type because it's usually uninteresting and tedious to type.
+     */
+    matchEvents(expectedEvents) {
+        const matchedExpectedEventCount = this.getMatchedEventsCount(expectedEvents);
+        // How many expected events were left over? Hopefully none.
+        const unmatchedExpectedEventCount = expectedEvents.length - matchedExpectedEventCount;
+        return unmatchedExpectedEventCount === 0;
+    }
+    /**
+     * Search events logged since the last time matchEvents was called, looking for any of the given
+     * expected events.
+     * @param expectedEvents - events that are expected to appear in the recorded log.
+     * These event objects may be subsets of the logged events.
+     * Note: category is ommitted from the type because it's usually uninteresting and tedious to type.
+     * @returns if any of the expected events is found.
+     */
+    matchAnyEvent(expectedEvents) {
+        const matchedExpectedEventCount = this.getMatchedEventsCount(expectedEvents);
+        return matchedExpectedEventCount > 0;
+    }
+    getMatchedEventsCount(expectedEvents) {
+        let iExpectedEvent = 0;
+        this.events.forEach((event) => {
+            if (iExpectedEvent < expectedEvents.length &&
+                MockLogger.eventsMatch(event, expectedEvents[iExpectedEvent])) {
+                // We found the next expected event; increment
+                ++iExpectedEvent;
+            }
+        });
+        // Remove the events so far; next call will just compare subsequent events from here
+        this.events = [];
+        // Return the count of matched events.
+        return iExpectedEvent;
+    }
+    /**
+     * Ensure the expected event is a strict subset of the actual event
+     */
+    static eventsMatch(actual, expected) {
+        const masked = Object.assign(Object.assign({}, actual), expected);
+        return JSON.stringify(masked) === JSON.stringify(actual);
+    }
+}
+exports.MockLogger = MockLogger;
+//# sourceMappingURL=mockLogger.js.map

package/dist/mockLogger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mockLogger.js","sourceRoot":"","sources":["../src/mockLogger.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,qCAA2C;AAE3C;;;GAGG;AACH,MAAa,UAAW,SAAQ,wBAAe;IAG3C;QAAgB,KAAK,EAAE,CAAC;QAFxB,WAAM,GAA0B,EAAE,CAAC;IAEV,CAAC;IAE1B,IAAI,CAAC,KAA0B;QAC3B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,cAAuD;QAC/D,MAAM,yBAAyB,GAAG,IAAI,CAAC,qBAAqB,CAAC,cAAc,CAAC,CAAC;QAC7E,2DAA2D;QAC3D,MAAM,2BAA2B,GAAG,cAAc,CAAC,MAAM,GAAG,yBAAyB,CAAC;QACtF,OAAO,2BAA2B,KAAK,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;OAOG;IACH,aAAa,CAAC,cAAuD;QACjE,MAAM,yBAAyB,GAAG,IAAI,CAAC,qBAAqB,CAAC,cAAc,CAAC,CAAC;QAC7E,OAAO,yBAAyB,GAAG,CAAC,CAAC;IACzC,CAAC;IAEO,qBAAqB,CAAC,cAAuD;QACjF,IAAI,cAAc,GAAG,CAAC,CAAC;QACvB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC1B,IAAI,cAAc,GAAG,cAAc,CAAC,MAAM;gBACtC,UAAU,CAAC,WAAW,CAAC,KAAK,EAAE,cAAc,CAAC,cAAc,CAAC,CAAC,EAC/D;gBACE,8CAA8C;gBAC9C,EAAE,cAAc,CAAC;aACpB;QACL,CAAC,CAAC,CAAC;QAEH,oFAAoF;QACpF,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QAEjB,sCAAsC;QACtC,OAAO,cAAc,CAAC;IAC1B,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,WAAW,CAAC,MAA2B,EAAE,QAA+C;QACnG,MAAM,MAAM,mCAAQ,MAAM,GAAK,QAAQ,CAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC;CACJ;AA7DD,gCA6DC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger, ITelemetryBaseEvent } from \"@fluidframework/common-definitions\";\nimport { TelemetryLogger } from \"./logger\";\n\n/**\n * The MockLogger records events sent to it, and then can walk back over those events\n * searching for a set of expected events to match against the logged events.\n */\nexport class MockLogger extends TelemetryLogger implements ITelemetryLogger {\n    events: ITelemetryBaseEvent[] = [];\n\n    constructor() { super(); }\n\n    send(event: ITelemetryBaseEvent): void {\n        this.events.push(event);\n    }\n\n    /**\n     * Search events logged since the last time matchEvents was called, looking for the given expected\n     * events in order.\n     * @param expectedEvents - events in order that are expected to appear in the recorded log.\n     * These event objects may be subsets of the logged events.\n     * Note: category is ommitted from the type because it's usually uninteresting and tedious to type.\n     */\n    matchEvents(expectedEvents: Omit<ITelemetryBaseEvent, \"category\">[]): boolean {\n        const matchedExpectedEventCount = this.getMatchedEventsCount(expectedEvents);\n        // How many expected events were left over? Hopefully none.\n        const unmatchedExpectedEventCount = expectedEvents.length - matchedExpectedEventCount;\n        return unmatchedExpectedEventCount === 0;\n    }\n\n    /**\n     * Search events logged since the last time matchEvents was called, looking for any of the given\n     * expected events.\n     * @param expectedEvents - events that are expected to appear in the recorded log.\n     * These event objects may be subsets of the logged events.\n     * Note: category is ommitted from the type because it's usually uninteresting and tedious to type.\n     * @returns if any of the expected events is found.\n     */\n    matchAnyEvent(expectedEvents: Omit<ITelemetryBaseEvent, \"category\">[]): boolean {\n        const matchedExpectedEventCount = this.getMatchedEventsCount(expectedEvents);\n        return matchedExpectedEventCount > 0;\n    }\n\n    private getMatchedEventsCount(expectedEvents: Omit<ITelemetryBaseEvent, \"category\">[]): number {\n        let iExpectedEvent = 0;\n        this.events.forEach((event) => {\n            if (iExpectedEvent < expectedEvents.length &&\n                MockLogger.eventsMatch(event, expectedEvents[iExpectedEvent])\n            ) {\n                // We found the next expected event; increment\n                ++iExpectedEvent;\n            }\n        });\n\n        // Remove the events so far; next call will just compare subsequent events from here\n        this.events = [];\n\n        // Return the count of matched events.\n        return iExpectedEvent;\n    }\n\n    /**\n     * Ensure the expected event is a strict subset of the actual event\n     */\n    private static eventsMatch(actual: ITelemetryBaseEvent, expected: Omit<ITelemetryBaseEvent, \"category\">): boolean {\n        const masked = { ...actual, ...expected };\n        return JSON.stringify(masked) === JSON.stringify(actual);\n    }\n}\n"]}

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/telemetry-utils";
-export declare const pkgVersion = "0.47.0-36699";
+export declare const pkgVersion = "0.48.0-38142";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/telemetry-utils";
-exports.pkgVersion = "0.47.0-36699";
+exports.pkgVersion = "0.48.0-38142";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,iCAAiC,CAAC;AAC5C,QAAA,UAAU,GAAG,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/telemetry-utils\";\nexport const pkgVersion = \"0.47.0-36699\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,iCAAiC,CAAC;AAC5C,QAAA,UAAU,GAAG,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/telemetry-utils\";\nexport const pkgVersion = \"0.48.0-38142\";\n"]}

package/lib/index.d.ts

@@ -8,6 +8,7 @@ export * from "./eventEmitterWithErrorHandling";
 export * from "./events";
 export * from "./fluidErrorBase";
 export * from "./logger";
+export * from "./mockLogger";
 export * from "./thresholdCounter";
 export * from "./utils";
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iCAAiC,CAAC;AAChD,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iCAAiC,CAAC;AAChD,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC"}

package/lib/index.js

@@ -8,6 +8,7 @@ export * from "./eventEmitterWithErrorHandling";
 export * from "./events";
 export * from "./fluidErrorBase";
 export * from "./logger";
+export * from "./mockLogger";
 export * from "./thresholdCounter";
 export * from "./utils";
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iCAAiC,CAAC;AAChD,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nexport * from \"./debugLogger\";\nexport * from \"./errorLogging\";\nexport * from \"./eventEmitterWithErrorHandling\";\nexport * from \"./events\";\nexport * from \"./fluidErrorBase\";\nexport * from \"./logger\";\nexport * from \"./thresholdCounter\";\nexport * from \"./utils\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iCAAiC,CAAC;AAChD,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nexport * from \"./debugLogger\";\nexport * from \"./errorLogging\";\nexport * from \"./eventEmitterWithErrorHandling\";\nexport * from \"./events\";\nexport * from \"./fluidErrorBase\";\nexport * from \"./logger\";\nexport * from \"./mockLogger\";\nexport * from \"./thresholdCounter\";\nexport * from \"./utils\";\n"]}

package/lib/mockLogger.d.ts

@@ -0,0 +1,38 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ITelemetryLogger, ITelemetryBaseEvent } from "@fluidframework/common-definitions";
+import { TelemetryLogger } from "./logger";
+/**
+ * The MockLogger records events sent to it, and then can walk back over those events
+ * searching for a set of expected events to match against the logged events.
+ */
+export declare class MockLogger extends TelemetryLogger implements ITelemetryLogger {
+    events: ITelemetryBaseEvent[];
+    constructor();
+    send(event: ITelemetryBaseEvent): void;
+    /**
+     * Search events logged since the last time matchEvents was called, looking for the given expected
+     * events in order.
+     * @param expectedEvents - events in order that are expected to appear in the recorded log.
+     * These event objects may be subsets of the logged events.
+     * Note: category is ommitted from the type because it's usually uninteresting and tedious to type.
+     */
+    matchEvents(expectedEvents: Omit<ITelemetryBaseEvent, "category">[]): boolean;
+    /**
+     * Search events logged since the last time matchEvents was called, looking for any of the given
+     * expected events.
+     * @param expectedEvents - events that are expected to appear in the recorded log.
+     * These event objects may be subsets of the logged events.
+     * Note: category is ommitted from the type because it's usually uninteresting and tedious to type.
+     * @returns if any of the expected events is found.
+     */
+    matchAnyEvent(expectedEvents: Omit<ITelemetryBaseEvent, "category">[]): boolean;
+    private getMatchedEventsCount;
+    /**
+     * Ensure the expected event is a strict subset of the actual event
+     */
+    private static eventsMatch;
+}
+//# sourceMappingURL=mockLogger.d.ts.map

package/lib/mockLogger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mockLogger.d.ts","sourceRoot":"","sources":["../src/mockLogger.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAC3F,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE3C;;;GAGG;AACH,qBAAa,UAAW,SAAQ,eAAgB,YAAW,gBAAgB;IACvE,MAAM,EAAE,mBAAmB,EAAE,CAAM;;IAInC,IAAI,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;IAItC;;;;;;OAMG;IACH,WAAW,CAAC,cAAc,EAAE,IAAI,CAAC,mBAAmB,EAAE,UAAU,CAAC,EAAE,GAAG,OAAO;IAO7E;;;;;;;OAOG;IACH,aAAa,CAAC,cAAc,EAAE,IAAI,CAAC,mBAAmB,EAAE,UAAU,CAAC,EAAE,GAAG,OAAO;IAK/E,OAAO,CAAC,qBAAqB;IAkB7B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;CAI7B"}

package/lib/mockLogger.js

@@ -0,0 +1,65 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { TelemetryLogger } from "./logger";
+/**
+ * The MockLogger records events sent to it, and then can walk back over those events
+ * searching for a set of expected events to match against the logged events.
+ */
+export class MockLogger extends TelemetryLogger {
+    constructor() {
+        super();
+        this.events = [];
+    }
+    send(event) {
+        this.events.push(event);
+    }
+    /**
+     * Search events logged since the last time matchEvents was called, looking for the given expected
+     * events in order.
+     * @param expectedEvents - events in order that are expected to appear in the recorded log.
+     * These event objects may be subsets of the logged events.
+     * Note: category is ommitted from the type because it's usually uninteresting and tedious to type.
+     */
+    matchEvents(expectedEvents) {
+        const matchedExpectedEventCount = this.getMatchedEventsCount(expectedEvents);
+        // How many expected events were left over? Hopefully none.
+        const unmatchedExpectedEventCount = expectedEvents.length - matchedExpectedEventCount;
+        return unmatchedExpectedEventCount === 0;
+    }
+    /**
+     * Search events logged since the last time matchEvents was called, looking for any of the given
+     * expected events.
+     * @param expectedEvents - events that are expected to appear in the recorded log.
+     * These event objects may be subsets of the logged events.
+     * Note: category is ommitted from the type because it's usually uninteresting and tedious to type.
+     * @returns if any of the expected events is found.
+     */
+    matchAnyEvent(expectedEvents) {
+        const matchedExpectedEventCount = this.getMatchedEventsCount(expectedEvents);
+        return matchedExpectedEventCount > 0;
+    }
+    getMatchedEventsCount(expectedEvents) {
+        let iExpectedEvent = 0;
+        this.events.forEach((event) => {
+            if (iExpectedEvent < expectedEvents.length &&
+                MockLogger.eventsMatch(event, expectedEvents[iExpectedEvent])) {
+                // We found the next expected event; increment
+                ++iExpectedEvent;
+            }
+        });
+        // Remove the events so far; next call will just compare subsequent events from here
+        this.events = [];
+        // Return the count of matched events.
+        return iExpectedEvent;
+    }
+    /**
+     * Ensure the expected event is a strict subset of the actual event
+     */
+    static eventsMatch(actual, expected) {
+        const masked = Object.assign(Object.assign({}, actual), expected);
+        return JSON.stringify(masked) === JSON.stringify(actual);
+    }
+}
+//# sourceMappingURL=mockLogger.js.map

package/lib/mockLogger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mockLogger.js","sourceRoot":"","sources":["../src/mockLogger.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE3C;;;GAGG;AACH,MAAM,OAAO,UAAW,SAAQ,eAAe;IAG3C;QAAgB,KAAK,EAAE,CAAC;QAFxB,WAAM,GAA0B,EAAE,CAAC;IAEV,CAAC;IAE1B,IAAI,CAAC,KAA0B;QAC3B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,cAAuD;QAC/D,MAAM,yBAAyB,GAAG,IAAI,CAAC,qBAAqB,CAAC,cAAc,CAAC,CAAC;QAC7E,2DAA2D;QAC3D,MAAM,2BAA2B,GAAG,cAAc,CAAC,MAAM,GAAG,yBAAyB,CAAC;QACtF,OAAO,2BAA2B,KAAK,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;OAOG;IACH,aAAa,CAAC,cAAuD;QACjE,MAAM,yBAAyB,GAAG,IAAI,CAAC,qBAAqB,CAAC,cAAc,CAAC,CAAC;QAC7E,OAAO,yBAAyB,GAAG,CAAC,CAAC;IACzC,CAAC;IAEO,qBAAqB,CAAC,cAAuD;QACjF,IAAI,cAAc,GAAG,CAAC,CAAC;QACvB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC1B,IAAI,cAAc,GAAG,cAAc,CAAC,MAAM;gBACtC,UAAU,CAAC,WAAW,CAAC,KAAK,EAAE,cAAc,CAAC,cAAc,CAAC,CAAC,EAC/D;gBACE,8CAA8C;gBAC9C,EAAE,cAAc,CAAC;aACpB;QACL,CAAC,CAAC,CAAC;QAEH,oFAAoF;QACpF,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QAEjB,sCAAsC;QACtC,OAAO,cAAc,CAAC;IAC1B,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,WAAW,CAAC,MAA2B,EAAE,QAA+C;QACnG,MAAM,MAAM,mCAAQ,MAAM,GAAK,QAAQ,CAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger, ITelemetryBaseEvent } from \"@fluidframework/common-definitions\";\nimport { TelemetryLogger } from \"./logger\";\n\n/**\n * The MockLogger records events sent to it, and then can walk back over those events\n * searching for a set of expected events to match against the logged events.\n */\nexport class MockLogger extends TelemetryLogger implements ITelemetryLogger {\n    events: ITelemetryBaseEvent[] = [];\n\n    constructor() { super(); }\n\n    send(event: ITelemetryBaseEvent): void {\n        this.events.push(event);\n    }\n\n    /**\n     * Search events logged since the last time matchEvents was called, looking for the given expected\n     * events in order.\n     * @param expectedEvents - events in order that are expected to appear in the recorded log.\n     * These event objects may be subsets of the logged events.\n     * Note: category is ommitted from the type because it's usually uninteresting and tedious to type.\n     */\n    matchEvents(expectedEvents: Omit<ITelemetryBaseEvent, \"category\">[]): boolean {\n        const matchedExpectedEventCount = this.getMatchedEventsCount(expectedEvents);\n        // How many expected events were left over? Hopefully none.\n        const unmatchedExpectedEventCount = expectedEvents.length - matchedExpectedEventCount;\n        return unmatchedExpectedEventCount === 0;\n    }\n\n    /**\n     * Search events logged since the last time matchEvents was called, looking for any of the given\n     * expected events.\n     * @param expectedEvents - events that are expected to appear in the recorded log.\n     * These event objects may be subsets of the logged events.\n     * Note: category is ommitted from the type because it's usually uninteresting and tedious to type.\n     * @returns if any of the expected events is found.\n     */\n    matchAnyEvent(expectedEvents: Omit<ITelemetryBaseEvent, \"category\">[]): boolean {\n        const matchedExpectedEventCount = this.getMatchedEventsCount(expectedEvents);\n        return matchedExpectedEventCount > 0;\n    }\n\n    private getMatchedEventsCount(expectedEvents: Omit<ITelemetryBaseEvent, \"category\">[]): number {\n        let iExpectedEvent = 0;\n        this.events.forEach((event) => {\n            if (iExpectedEvent < expectedEvents.length &&\n                MockLogger.eventsMatch(event, expectedEvents[iExpectedEvent])\n            ) {\n                // We found the next expected event; increment\n                ++iExpectedEvent;\n            }\n        });\n\n        // Remove the events so far; next call will just compare subsequent events from here\n        this.events = [];\n\n        // Return the count of matched events.\n        return iExpectedEvent;\n    }\n\n    /**\n     * Ensure the expected event is a strict subset of the actual event\n     */\n    private static eventsMatch(actual: ITelemetryBaseEvent, expected: Omit<ITelemetryBaseEvent, \"category\">): boolean {\n        const masked = { ...actual, ...expected };\n        return JSON.stringify(masked) === JSON.stringify(actual);\n    }\n}\n"]}

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/telemetry-utils";
-export declare const pkgVersion = "0.47.0-36699";
+export declare const pkgVersion = "0.48.0-38142";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/telemetry-utils";
-export const pkgVersion = "0.47.0-36699";
+export const pkgVersion = "0.48.0-38142";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,iCAAiC,CAAC;AACzD,MAAM,CAAC,MAAM,UAAU,GAAG,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/telemetry-utils\";\nexport const pkgVersion = \"0.47.0-36699\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,iCAAiC,CAAC;AACzD,MAAM,CAAC,MAAM,UAAU,GAAG,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/telemetry-utils\";\nexport const pkgVersion = \"0.48.0-38142\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/telemetry-utils",
-  "version": "0.47.0-36699",
+  "version": "0.48.0-38142",
   "description": "Collection of telemetry relates utilities for Fluid",
   "homepage": "https://fluidframework.com",
   "repository": "https://github.com/microsoft/FluidFramework",
@@ -68,7 +68,7 @@
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0-0",
     "@fluidframework/eslint-config-fluid": "^0.23.0",
-    "@fluidframework/mocha-test-setup": "0.47.0-36699",
+    "@fluidframework/mocha-test-setup": "0.48.0-38142",
     "@microsoft/api-extractor": "^7.16.1",
     "@types/debug": "^4.1.5",
     "@types/events": "^3.0.0",

package/src/index.ts

@@ -8,5 +8,6 @@ export * from "./eventEmitterWithErrorHandling";
 export * from "./events";
 export * from "./fluidErrorBase";
 export * from "./logger";
+export * from "./mockLogger";
 export * from "./thresholdCounter";
 export * from "./utils";

package/src/mockLogger.ts

@@ -0,0 +1,74 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ITelemetryLogger, ITelemetryBaseEvent } from "@fluidframework/common-definitions";
+import { TelemetryLogger } from "./logger";
+
+/**
+ * The MockLogger records events sent to it, and then can walk back over those events
+ * searching for a set of expected events to match against the logged events.
+ */
+export class MockLogger extends TelemetryLogger implements ITelemetryLogger {
+    events: ITelemetryBaseEvent[] = [];
+
+    constructor() { super(); }
+
+    send(event: ITelemetryBaseEvent): void {
+        this.events.push(event);
+    }
+
+    /**
+     * Search events logged since the last time matchEvents was called, looking for the given expected
+     * events in order.
+     * @param expectedEvents - events in order that are expected to appear in the recorded log.
+     * These event objects may be subsets of the logged events.
+     * Note: category is ommitted from the type because it's usually uninteresting and tedious to type.
+     */
+    matchEvents(expectedEvents: Omit<ITelemetryBaseEvent, "category">[]): boolean {
+        const matchedExpectedEventCount = this.getMatchedEventsCount(expectedEvents);
+        // How many expected events were left over? Hopefully none.
+        const unmatchedExpectedEventCount = expectedEvents.length - matchedExpectedEventCount;
+        return unmatchedExpectedEventCount === 0;
+    }
+
+    /**
+     * Search events logged since the last time matchEvents was called, looking for any of the given
+     * expected events.
+     * @param expectedEvents - events that are expected to appear in the recorded log.
+     * These event objects may be subsets of the logged events.
+     * Note: category is ommitted from the type because it's usually uninteresting and tedious to type.
+     * @returns if any of the expected events is found.
+     */
+    matchAnyEvent(expectedEvents: Omit<ITelemetryBaseEvent, "category">[]): boolean {
+        const matchedExpectedEventCount = this.getMatchedEventsCount(expectedEvents);
+        return matchedExpectedEventCount > 0;
+    }
+
+    private getMatchedEventsCount(expectedEvents: Omit<ITelemetryBaseEvent, "category">[]): number {
+        let iExpectedEvent = 0;
+        this.events.forEach((event) => {
+            if (iExpectedEvent < expectedEvents.length &&
+                MockLogger.eventsMatch(event, expectedEvents[iExpectedEvent])
+            ) {
+                // We found the next expected event; increment
+                ++iExpectedEvent;
+            }
+        });
+
+        // Remove the events so far; next call will just compare subsequent events from here
+        this.events = [];
+
+        // Return the count of matched events.
+        return iExpectedEvent;
+    }
+
+    /**
+     * Ensure the expected event is a strict subset of the actual event
+     */
+    private static eventsMatch(actual: ITelemetryBaseEvent, expected: Omit<ITelemetryBaseEvent, "category">): boolean {
+        const masked = { ...actual, ...expected };
+        return JSON.stringify(masked) === JSON.stringify(actual);
+    }
+}

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/telemetry-utils";
-export const pkgVersion = "0.47.0-36699";
+export const pkgVersion = "0.48.0-38142";