From 642592b9dd73d1e1018726859b6baa6926d678b8 Mon Sep 17 00:00:00 2001 From: Durran Jordan Date: Mon, 23 Jun 2025 18:04:25 +0200 Subject: [PATCH] chore(NODE-6783): document keeping UTR loop and events as entities --- test/tools/unified-spec-runner/operations.ts | 4 ++++ test/tools/unified-spec-runner/schema.ts | 1 + 2 files changed, 5 insertions(+) diff --git a/test/tools/unified-spec-runner/operations.ts b/test/tools/unified-spec-runner/operations.ts index 2270cc3fed..19c31c743d 100644 --- a/test/tools/unified-spec-runner/operations.ts +++ b/test/tools/unified-spec-runner/operations.ts @@ -456,6 +456,10 @@ operations.set('listIndexNames', async ({ entities, operation }) => { return indexes.map(index => index.name); }); +/** + * This function was scheduled to be removed in NODE-6783, but we've decideded to keep it + * as the removal is optional and has utility for testing and debugging. + */ operations.set('loop', async ({ entities, operation, client, testConfig }) => { const controller = new AbortController(); // We always want the process to exit on SIGINT last, so all other diff --git a/test/tools/unified-spec-runner/schema.ts b/test/tools/unified-spec-runner/schema.ts index c8f433aba1..d52192e645 100644 --- a/test/tools/unified-spec-runner/schema.ts +++ b/test/tools/unified-spec-runner/schema.ts @@ -150,6 +150,7 @@ export interface ClientEntity { ignoreCommandMonitoringEvents?: string[]; serverApi?: ServerApi; observeSensitiveCommands?: boolean; + // Was optionally scheduled for removal in NODE-6783, but opted to keep it for potential future use. storeEventsAsEntities?: StoreEventsAsEntity[]; } export interface DatabaseEntity {