@fluid-experimental/tree 1.2.6 → 2.0.0-dev.1.3.0.96595

package/lib/test/utilities/SharedTreeTests.js

@@ -685,12 +685,23 @@ export function runSharedTreeOperationsTests(title, writeFormat, setUpTestShared
             });
         });
         describe('telemetry', () => {
+            class LoggerThatOnlySeesSharedTreeEvents {
+                constructor(additionalFilter = (e) => true) {
+                    this.additionalFilter = additionalFilter;
+                    this.events = [];
+                }
+                send(event) {
+                    if (isSharedTreeEvent(event) && this.additionalFilter(event)) {
+                        this.events.push(event);
+                    }
+                }
+            }
             describe('useFailedSequencedEditTelemetry', () => {
                 it('decorates events with the correct properties', async () => {
                     // Test that a handle can wrap a node and retrieve that node's properties
-                    const events = [];
+                    const logger = new LoggerThatOnlySeesSharedTreeEvents();
                     const { sharedTree, testTree, containerRuntimeFactory } = createSimpleTestTree({
-                        logger: { send: (event) => events.push(event) },
+                        logger,
                         allowInvalid: true,
                     });
                     useFailedSequencedEditTelemetry(sharedTree);
@@ -699,68 +710,66 @@ export function runSharedTreeOperationsTests(title, writeFormat, setUpTestShared
                     containerRuntimeFactory.processAllMessages();
                     // Force demand, which will cause a telemetry event for the invalid edit to be emitted
                     await sharedTree.logViewer.getRevisionView(Number.POSITIVE_INFINITY);
-                    expect(events.length).is.greaterThan(0);
-                    events.forEach((event) => {
+                    expect(logger.events.length).is.greaterThan(0);
+                    logger.events.forEach((event) => {
                         expect(isSharedTreeEvent(event)).is.true;
                     });
                 });
                 it('is logged for invalid locally generated edits when those edits are sequenced', async () => {
-                    const events = [];
+                    const logger = new LoggerThatOnlySeesSharedTreeEvents((event) => !event.eventName.includes('IdCompressor'));
                     const { sharedTree, testTree, containerRuntimeFactory } = createSimpleTestTree({
-                        logger: { send: (event) => !event.eventName.includes('IdCompressor') && events.push(event) },
+                        logger,
                         allowInvalid: true,
                     });
                     useFailedSequencedEditTelemetry(sharedTree);
                     // Invalid edit
                     sharedTree.applyEdit(...Change.insertTree([testTree.buildLeaf()], StablePlace.after(testTree.buildLeaf(testTree.generateNodeId()))));
-                    expect(events.length).equals(0);
+                    expect(logger.events.length).equals(0);
                     containerRuntimeFactory.processAllMessages();
                     // Force demand, which will cause a telemetry event for the invalid edit to be emitted
                     await sharedTree.logViewer.getRevisionView(Number.POSITIVE_INFINITY);
-                    expect(events.length).equals(1);
-                    expect(events[0].category).equals('generic');
-                    expect(events[0].eventName).equals('SharedTree:SequencedEditApplied:InvalidSharedTreeEdit');
+                    expect(logger.events.length).equals(1);
+                    expect(logger.events[0].category).equals('generic');
+                    expect(logger.events[0].eventName).equals('SharedTree:SequencedEditApplied:InvalidSharedTreeEdit');
                 });
                 it('can be disabled and re-enabled', async () => {
-                    const events = [];
+                    const logger = new LoggerThatOnlySeesSharedTreeEvents((event) => !event.eventName.includes('IdCompressor'));
                     const { sharedTree, testTree, containerRuntimeFactory } = createSimpleTestTree({
-                        logger: { send: (event) => !event.eventName.includes('IdCompressor') && events.push(event) },
+                        logger,
                         allowInvalid: true,
                     });
                     const { disable } = useFailedSequencedEditTelemetry(sharedTree);
                     sharedTree.applyEdit(...Change.insertTree([testTree.buildLeaf()], StablePlace.after(testTree.buildLeaf(testTree.generateNodeId()))));
-                    expect(events.length).equals(0);
+                    expect(logger.events.length).equals(0);
                     containerRuntimeFactory.processAllMessages();
                     await sharedTree.logViewer.getRevisionView(Number.POSITIVE_INFINITY);
-                    expect(events.length).equals(1);
-                    expect(events[0].eventName).equals('SharedTree:SequencedEditApplied:InvalidSharedTreeEdit');
+                    expect(logger.events.length).equals(1);
+                    expect(logger.events[0].eventName).equals('SharedTree:SequencedEditApplied:InvalidSharedTreeEdit');
                     disable();
                     sharedTree.applyEdit(...Change.insertTree([testTree.buildLeaf()], StablePlace.after(testTree.buildLeaf(testTree.generateNodeId()))));
                     containerRuntimeFactory.processAllMessages();
                     await sharedTree.logViewer.getRevisionView(Number.POSITIVE_INFINITY);
-                    expect(events.length).equals(1);
+                    expect(logger.events.length).equals(1);
                     useFailedSequencedEditTelemetry(sharedTree);
                     sharedTree.applyEdit(...Change.insertTree([testTree.buildLeaf()], StablePlace.after(testTree.buildLeaf(testTree.generateNodeId()))));
                     containerRuntimeFactory.processAllMessages();
                     await sharedTree.logViewer.getRevisionView(Number.POSITIVE_INFINITY);
-                    expect(events.length).equals(2);
-                    expect(events[1].eventName).equals('SharedTree:SequencedEditApplied:InvalidSharedTreeEdit');
+                    expect(logger.events.length).equals(2);
+                    expect(logger.events[1].eventName).equals('SharedTree:SequencedEditApplied:InvalidSharedTreeEdit');
                 });
                 it('is not logged for valid edits', async () => {
-                    const events = [];
-                    const { sharedTree, testTree, containerRuntimeFactory } = createSimpleTestTree({
-                        logger: { send: (event) => !event.eventName.includes('IdCompressor') && events.push(event) },
-                    });
+                    const logger = new LoggerThatOnlySeesSharedTreeEvents((event) => !event.eventName.includes('IdCompressor'));
+                    const { sharedTree, testTree, containerRuntimeFactory } = createSimpleTestTree({ logger });
                     useFailedSequencedEditTelemetry(sharedTree);
                     sharedTree.applyEdit(...Change.insertTree(testTree.buildLeaf(), StablePlace.after(testTree.left)));
                     containerRuntimeFactory.processAllMessages();
                     await sharedTree.logViewer.getRevisionView(Number.POSITIVE_INFINITY);
-                    expect(events.length).equals(0);
+                    expect(logger.events.length).equals(0);
                 });
                 it('is not logged for remote edits', async () => {
-                    const events = [];
+                    const logger = new LoggerThatOnlySeesSharedTreeEvents((event) => !event.eventName.includes('IdCompressor'));
                     const { sharedTree: sharedTree1, containerRuntimeFactory } = createSimpleTestTree({
-                        logger: { send: (event) => !event.eventName.includes('IdCompressor') && events.push(event) },
+                        logger,
                         allowInvalid: true,
                         localMode: false,
                     });
@@ -773,7 +782,7 @@ export function runSharedTreeOperationsTests(title, writeFormat, setUpTestShared
                     sharedTree2.applyEdit(...Change.insertTree([testTree2.buildLeaf()], StablePlace.after(testTree2.buildLeaf(testTree2.generateNodeId()))));
                     containerRuntimeFactory.processAllMessages();
                     await sharedTree1.logViewer.getRevisionView(Number.POSITIVE_INFINITY);
-                    expect(events.length).equals(0);
+                    expect(logger.events.length).equals(0);
                 });
             });
         });