@firebase/firestore 3.8.3-canary.d5d78cbcf → 3.8.3-canary.e2bf2eca2

package/dist/index.node.mjs

@@ -8,7 +8,7 @@ import * as grpc from '@grpc/grpc-js';
 import * as protoLoader from '@grpc/proto-loader';
 
 const name = "@firebase/firestore";
-const version$1 = "3.8.3-canary.d5d78cbcf";
+const version$1 = "3.8.3-canary.e2bf2eca2";
 
 /**
  * @license
@@ -61,7 +61,7 @@ User.GOOGLE_CREDENTIALS = new User('google-credentials-uid');
 User.FIRST_PARTY = new User('first-party-uid');
 User.MOCK_USER = new User('mock-user');
 
-const version = "9.17.1-canary.d5d78cbcf";
+const version = "9.17.1-canary.e2bf2eca2";
 
 /**
  * @license
@@ -17912,6 +17912,66 @@ class StreamBridge {
     }
 }
 
+/**
+ * @license
+ * Copyright 2023 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * The value returned from the most recent invocation of
+ * `generateUniqueDebugId()`, or null if it has never been invoked.
+ */
+let lastUniqueDebugId = null;
+/**
+ * Generates and returns an initial value for `lastUniqueDebugId`.
+ *
+ * The returned value is randomly selected from a range of integers that are
+ * represented as 8 hexadecimal digits. This means that (within reason) any
+ * numbers generated by incrementing the returned number by 1 will also be
+ * represented by 8 hexadecimal digits. This leads to all "IDs" having the same
+ * length when converted to a hexadecimal string, making reading logs containing
+ * these IDs easier to follow. And since the return value is randomly selected
+ * it will help to differentiate between logs from different executions.
+ */
+function generateInitialUniqueDebugId() {
+    const minResult = 0x10000000;
+    const maxResult = 0x90000000;
+    const resultRange = maxResult - minResult;
+    const resultOffset = Math.round(resultRange * Math.random());
+    return minResult + resultOffset;
+}
+/**
+ * Generates and returns a unique ID as a hexadecimal string.
+ *
+ * The returned ID is intended to be used in debug logging messages to help
+ * correlate log messages that may be spatially separated in the logs, but
+ * logically related. For example, a network connection could include the same
+ * "debug ID" string in all of its log messages to help trace a specific
+ * connection over time.
+ *
+ * @return the 10-character generated ID (e.g. "0xa1b2c3d4").
+ */
+function generateUniqueDebugId() {
+    if (lastUniqueDebugId === null) {
+        lastUniqueDebugId = generateInitialUniqueDebugId();
+    }
+    else {
+        lastUniqueDebugId++;
+    }
+    return '0x' + lastUniqueDebugId.toString(16);
+}
+
 /**
  * @license
  * Copyright 2017 Google LLC
@@ -17998,7 +18058,7 @@ function nodePromise(action) {
 // TODO: Fetch runtime version from grpc-js/package.json instead
 // when there's a cleaner way to dynamic require JSON in both Node ESM and CJS
 const grpcVersion = '1.7.3';
-const LOG_TAG$9 = 'Connection';
+const LOG_TAG$9 = 'GrpcConnection';
 const X_GOOG_API_CLIENT_VALUE = `gl-node/${process.versions.node} fire/${SDK_VERSION} grpc/${grpcVersion}`;
 function createMetadata(databasePath, authToken, appCheckToken, appId) {
     hardAssert(authToken === null || authToken.type === 'OAuth');
@@ -18050,34 +18110,36 @@ class GrpcConnection {
         return this.cachedStub;
     }
     invokeRPC(rpcName, path, request, authToken, appCheckToken) {
+        const streamId = generateUniqueDebugId();
         const stub = this.ensureActiveStub();
         const metadata = createMetadata(this.databasePath, authToken, appCheckToken, this.databaseInfo.appId);
         const jsonRequest = Object.assign({ database: this.databasePath }, request);
         return nodePromise((callback) => {
-            logDebug(LOG_TAG$9, `RPC '${rpcName}' invoked with request:`, request);
+            logDebug(LOG_TAG$9, `RPC '${rpcName}' ${streamId} invoked with request:`, request);
             return stub[rpcName](jsonRequest, metadata, (grpcError, value) => {
                 if (grpcError) {
-                    logDebug(LOG_TAG$9, `RPC '${rpcName}' failed with error:`, grpcError);
+                    logDebug(LOG_TAG$9, `RPC '${rpcName}' ${streamId} failed with error:`, grpcError);
                     callback(new FirestoreError(mapCodeFromRpcCode(grpcError.code), grpcError.message));
                 }
                 else {
-                    logDebug(LOG_TAG$9, `RPC '${rpcName}' completed with response:`, value);
+                    logDebug(LOG_TAG$9, `RPC '${rpcName}' ${streamId} completed with response:`, value);
                     callback(undefined, value);
                 }
             });
         });
     }
     invokeStreamingRPC(rpcName, path, request, authToken, appCheckToken, expectedResponseCount) {
+        const streamId = generateUniqueDebugId();
         const results = [];
         const responseDeferred = new Deferred();
-        logDebug(LOG_TAG$9, `RPC '${rpcName}' invoked (streaming) with request:`, request);
+        logDebug(LOG_TAG$9, `RPC '${rpcName}' ${streamId} invoked (streaming) with request:`, request);
         const stub = this.ensureActiveStub();
         const metadata = createMetadata(this.databasePath, authToken, appCheckToken, this.databaseInfo.appId);
         const jsonRequest = Object.assign(Object.assign({}, request), { database: this.databasePath });
         const stream = stub[rpcName](jsonRequest, metadata);
         let callbackFired = false;
         stream.on('data', (response) => {
-            logDebug(LOG_TAG$9, `RPC ${rpcName} received result:`, response);
+            logDebug(LOG_TAG$9, `RPC ${rpcName} ${streamId} received result:`, response);
             results.push(response);
             if (expectedResponseCount !== undefined &&
                 results.length === expectedResponseCount) {
@@ -18086,14 +18148,14 @@ class GrpcConnection {
             }
         });
         stream.on('end', () => {
-            logDebug(LOG_TAG$9, `RPC '${rpcName}' completed.`);
+            logDebug(LOG_TAG$9, `RPC '${rpcName}' ${streamId} completed.`);
             if (!callbackFired) {
                 callbackFired = true;
                 responseDeferred.resolve(results);
             }
         });
         stream.on('error', (grpcError) => {
-            logDebug(LOG_TAG$9, `RPC '${rpcName}' failed with error:`, grpcError);
+            logDebug(LOG_TAG$9, `RPC '${rpcName}' ${streamId} failed with error:`, grpcError);
             const code = mapCodeFromRpcCode(grpcError.code);
             responseDeferred.reject(new FirestoreError(code, grpcError.message));
         });
@@ -18101,6 +18163,7 @@ class GrpcConnection {
     }
     // TODO(mikelehen): This "method" is a monster. Should be refactored.
     openStream(rpcName, authToken, appCheckToken) {
+        const streamId = generateUniqueDebugId();
         const stub = this.ensureActiveStub();
         const metadata = createMetadata(this.databasePath, authToken, appCheckToken, this.databaseInfo.appId);
         const grpcStream = stub[rpcName](metadata);
@@ -18115,7 +18178,7 @@ class GrpcConnection {
         const stream = new StreamBridge({
             sendFn: (msg) => {
                 if (!closed) {
-                    logDebug(LOG_TAG$9, 'GRPC stream sending:', msg);
+                    logDebug(LOG_TAG$9, `RPC '${rpcName}' stream ${streamId} sending:`, msg);
                     try {
                         grpcStream.write(msg);
                     }
@@ -18128,32 +18191,34 @@ class GrpcConnection {
                     }
                 }
                 else {
-                    logDebug(LOG_TAG$9, 'Not sending because gRPC stream is closed:', msg);
+                    logDebug(LOG_TAG$9, `RPC '${rpcName}' stream ${streamId} ` +
+                        'not sending because gRPC stream is closed:', msg);
                 }
             },
             closeFn: () => {
-                logDebug(LOG_TAG$9, 'GRPC stream closed locally via close().');
+                logDebug(LOG_TAG$9, `RPC '${rpcName}' stream ${streamId} closed locally via close().`);
                 close();
             }
         });
         grpcStream.on('data', (msg) => {
             if (!closed) {
-                logDebug(LOG_TAG$9, 'GRPC stream received:', msg);
+                logDebug(LOG_TAG$9, `RPC '${rpcName}' stream ${streamId} received:`, msg);
                 stream.callOnMessage(msg);
             }
         });
         grpcStream.on('end', () => {
-            logDebug(LOG_TAG$9, 'GRPC stream ended.');
+            logDebug(LOG_TAG$9, `RPC '${rpcName}' stream ${streamId} ended.`);
             close();
         });
         grpcStream.on('error', (grpcError) => {
             if (!closed) {
-                logWarn(LOG_TAG$9, 'GRPC stream error. Code:', grpcError.code, 'Message:', grpcError.message);
+                logWarn(LOG_TAG$9, `RPC '${rpcName}' stream ${streamId} error. Code:`, grpcError.code, 'Message:', grpcError.message);
                 const code = mapCodeFromRpcCode(grpcError.code);
                 close(new FirestoreError(code, grpcError.message));
             }
         });
-        logDebug(LOG_TAG$9, 'Opening GRPC stream');
+        logDebug(LOG_TAG$9, `Opening RPC '${rpcName}' stream ${streamId} ` +
+            `to ${this.databaseInfo.host}`);
         // TODO(dimond): Since grpc has no explicit open status (or does it?) we
         // simulate an onOpen in the next loop after the stream had it's listeners
         // registered