fix mangling of the property names of the argument to 'onExistenceFilterMismatch()' callbacks

Author: dconeybe

packages/firestore/src/api.ts

@@ -196,4 +196,7 @@ export type { ByteString as _ByteString } from './util/byte_string';
 export { logWarn as _logWarn } from './util/log';
 export { EmptyAuthCredentialsProvider as _EmptyAuthCredentialsProvider } from './api/credentials';
 export { EmptyAppCheckTokenProvider as _EmptyAppCheckTokenProvider } from './api/credentials';
-export { TestingHooks as _TestingHooks } from './util/testing_hooks';
+export {
+  TestingHooks as _TestingHooks,
+  ExistenceFilterMismatchInfo as _TestingUtilsExistenceFilterMismatchInfo
+} from './util/testing_hooks';

packages/firestore/src/util/testing_hooks.ts

@@ -34,7 +34,7 @@
 export class TestingHooks {
   private readonly onExistenceFilterMismatchCallbacks = new Map<
     Symbol,
-    (arg: unknown) => void
+    (info: ExistenceFilterMismatchInfo) => void
   >();
 
   private constructor() {}
@@ -65,31 +65,50 @@ export class TestingHooks {
    * The relative order in which callbacks are notified is unspecified; do not
    * rely on any particular ordering.
    *
-   * @param callback the callback to invoke upon existence filter mismatch. The
-   * type of the argument to this callback is intentionally declared as
-   * `unknown`, rather than something more specific, to discourage its use
-   * unless you really, really know what you are doing. If you know what you are
-   * doing then you know the type and how to interpret it.
+   * @param callback the callback to invoke upon existence filter mismatch.
    *
    * @return a function that, when called, unregisters the given callback; only
    * the first invocation of the returned function does anything; all subsequent
    * invocations do nothing.
    */
-  onExistenceFilterMismatch(callback: (arg: unknown) => void): () => void {
+  onExistenceFilterMismatch(
+    callback: (info: ExistenceFilterMismatchInfo) => void
+  ): () => void {
     const key = Symbol();
     this.onExistenceFilterMismatchCallbacks.set(key, callback);
     return () => this.onExistenceFilterMismatchCallbacks.delete(key);
   }
 
   /**
    * Invokes all currently-registered `onExistenceFilterMismatch` callbacks.
-   * @param arg the argument to specify to the callbacks; see the documentation
-   * for `onExistenceFilterMismatch()` for details.
+   * @param info the argument to specify to the callbacks.
    */
-  notifyOnExistenceFilterMismatch(arg: unknown): void {
-    this.onExistenceFilterMismatchCallbacks.forEach(callback => callback(arg));
+  notifyOnExistenceFilterMismatch(info: ExistenceFilterMismatchInfo): void {
+    this.onExistenceFilterMismatchCallbacks.forEach(callback => callback(info));
   }
 }
 
+/**
+ * The shape of the object specified to
+ * `TestingUtils.onExistenceFilterMismatch()` callbacks.
+ */
+export interface ExistenceFilterMismatchInfo {
+  actualCount: number;
+  bloomFilterApplied: boolean;
+  change: {
+    targetId: number;
+    existenceFilter: {
+      count: number;
+      unchangedNames?: {
+        bits?: {
+          bitmap?: string | Uint8Array;
+          padding?: number;
+        };
+        hashCount?: number;
+      };
+    };
+  };
+}
+
 /** The global singleton instance of `TestingHooks`. */
 let gTestingHooksSingletonInstance: TestingHooks | null = null;

packages/firestore/test/integration/util/testing_hooks_util.ts

@@ -15,7 +15,11 @@
  * limitations under the License.
  */
 
-import { _TestingHooks as TestingHooks, _logWarn } from './firebase_export';
+import {
+  _TestingHooks as TestingHooks,
+  _TestingUtilsExistenceFilterMismatchInfo as RawExistenceFilterMismatchInfo,
+  _logWarn
+} from './firebase_export';
 
 /**
  * Captures all existence filter mismatches in the Watch 'Listen' stream that
@@ -49,28 +53,6 @@ export async function captureExistenceFilterMismatches(
   return results;
 }
 
-/**
- * The shape of the object specified to
- * `TestingUtils.onExistenceFilterMismatch()` callbacks.
- */
-interface RawExistenceFilterMismatchInfo {
-  actualCount: number;
-  bloomFilterApplied: boolean;
-  change: {
-    targetId: number;
-    existenceFilter: {
-      count: number;
-      unchangedNames?: {
-        bits?: {
-          bitmap?: string | Uint8Array;
-          padding?: number;
-        };
-        hashCount?: number;
-      };
-    };
-  };
-}
-
 /**
  * Information about an existence filter mismatch, capturing during an
  * invocation of `captureExistenceFilterMismatches()`.
@@ -88,7 +70,7 @@ export interface ExistenceFilterMismatchInfo {
  * Information about a bloom filter in an existence filter.
  */
 export interface ExistenceFilterBloomFilter {
-  /** Whether the bloom filter was able to be used to avert a full requery. */
+  /** Whether the bloom filter was used to avert a full requery. */
   applied: boolean;
   /** The number of hash functions used in the bloom filter. */
   hashCount: number;
@@ -118,7 +100,7 @@ function existenceFilterMismatchInfoFromRaw(
 
 /**
  * Creates an `ExistenceFilterBloomFilter` object from the raw object given
- * by `TestingUtils`, returning null if the given object does not defined a
+ * by `TestingUtils`, returning null if the given object does not define a
  * bloom filter.
  */
 function bloomFilterFromRawExistenceFilterMismatchInfo(