|
| 1 | +/** |
| 2 | + * @license |
| 3 | + * Copyright 2023 Google LLC |
| 4 | + * |
| 5 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | + * you may not use this file except in compliance with the License. |
| 7 | + * You may obtain a copy of the License at |
| 8 | + * |
| 9 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | + * |
| 11 | + * Unless required by applicable law or agreed to in writing, software |
| 12 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | + * See the License for the specific language governing permissions and |
| 15 | + * limitations under the License. |
| 16 | + */ |
| 17 | + |
| 18 | +/** |
| 19 | + * Manages "testing hooks", hooks into the internals of the SDK to verify |
| 20 | + * internal state and events during integration tests. Do not use this class |
| 21 | + * except for testing purposes. |
| 22 | + * |
| 23 | + * There are two ways to retrieve the global singleton instance of this class: |
| 24 | + * 1. The `instance` property, which returns null if the global singleton |
| 25 | + * instance has not been created. Use this property if the caller should |
| 26 | + * "do nothing" if there are no testing hooks registered, such as when |
| 27 | + * delivering an event to notify registered callbacks. |
| 28 | + * 2. The `getOrCreateInstance()` method, which creates the global singleton |
| 29 | + * instance if it has not been created. Use this method if the instance is |
| 30 | + * needed to, for example, register a callback. |
| 31 | + * |
| 32 | + * @internal |
| 33 | + */ |
| 34 | +export class TestingHooks { |
| 35 | + private readonly onExistenceFilterMismatchCallbacks = new Map< |
| 36 | + Symbol, |
| 37 | + ExistenceFilterMismatchCallback |
| 38 | + >(); |
| 39 | + |
| 40 | + private constructor() {} |
| 41 | + |
| 42 | + /** |
| 43 | + * Returns the singleton instance of this class, or null if it has not been |
| 44 | + * initialized. |
| 45 | + */ |
| 46 | + static get instance(): TestingHooks | null { |
| 47 | + return gTestingHooksSingletonInstance; |
| 48 | + } |
| 49 | + |
| 50 | + /** |
| 51 | + * Returns the singleton instance of this class, creating it if is has never |
| 52 | + * been created before. |
| 53 | + */ |
| 54 | + static getOrCreateInstance(): TestingHooks { |
| 55 | + if (gTestingHooksSingletonInstance === null) { |
| 56 | + gTestingHooksSingletonInstance = new TestingHooks(); |
| 57 | + } |
| 58 | + return gTestingHooksSingletonInstance; |
| 59 | + } |
| 60 | + |
| 61 | + /** |
| 62 | + * Registers a callback to be notified when an existence filter mismatch |
| 63 | + * occurs in the Watch listen stream. |
| 64 | + * |
| 65 | + * The relative order in which callbacks are notified is unspecified; do not |
| 66 | + * rely on any particular ordering. If a given callback is registered multiple |
| 67 | + * times then it will be notified multiple times, once per registration. |
| 68 | + * |
| 69 | + * @param callback the callback to invoke upon existence filter mismatch. |
| 70 | + * |
| 71 | + * @return a function that, when called, unregisters the given callback; only |
| 72 | + * the first invocation of the returned function does anything; all subsequent |
| 73 | + * invocations do nothing. |
| 74 | + */ |
| 75 | + onExistenceFilterMismatch( |
| 76 | + callback: ExistenceFilterMismatchCallback |
| 77 | + ): () => void { |
| 78 | + const key = Symbol(); |
| 79 | + this.onExistenceFilterMismatchCallbacks.set(key, callback); |
| 80 | + return () => this.onExistenceFilterMismatchCallbacks.delete(key); |
| 81 | + } |
| 82 | + |
| 83 | + /** |
| 84 | + * Invokes all currently-registered `onExistenceFilterMismatch` callbacks. |
| 85 | + * @param info Information about the existence filter mismatch. |
| 86 | + */ |
| 87 | + notifyOnExistenceFilterMismatch(info: ExistenceFilterMismatchInfo): void { |
| 88 | + this.onExistenceFilterMismatchCallbacks.forEach(callback => callback(info)); |
| 89 | + } |
| 90 | +} |
| 91 | + |
| 92 | +/** |
| 93 | + * Information about an existence filter mismatch, as specified to callbacks |
| 94 | + * registered with `TestingUtils.onExistenceFilterMismatch()`. |
| 95 | + */ |
| 96 | +export interface ExistenceFilterMismatchInfo { |
| 97 | + /** The number of documents that matched the query in the local cache. */ |
| 98 | + localCacheCount: number; |
| 99 | + |
| 100 | + /** |
| 101 | + * The number of documents that matched the query on the server, as specified |
| 102 | + * in the ExistenceFilter message's `count` field. |
| 103 | + */ |
| 104 | + existenceFilterCount: number; |
| 105 | +} |
| 106 | + |
| 107 | +/** |
| 108 | + * The signature of callbacks registered with |
| 109 | + * `TestingUtils.onExistenceFilterMismatch()`. |
| 110 | + */ |
| 111 | +export type ExistenceFilterMismatchCallback = ( |
| 112 | + info: ExistenceFilterMismatchInfo |
| 113 | +) => void; |
| 114 | + |
| 115 | +/** The global singleton instance of `TestingHooks`. */ |
| 116 | +let gTestingHooksSingletonInstance: TestingHooks | null = null; |
0 commit comments