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

package/dist/lite/index.node.mjs

@@ -6,7 +6,7 @@ import { FirebaseError, getDefaultEmulatorHostnameAndPort, createMockUserToken,
 import nodeFetch from 'node-fetch';
 import { randomBytes as randomBytes$1 } from 'crypto';
 
-const version$1 = "3.8.3-canary.d5d78cbcf";
+const version$1 = "3.8.3-canary.e2bf2eca2";
 
 /**
  * @license
@@ -59,7 +59,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
@@ -1177,6 +1177,66 @@ function validatePositiveNumber(functionName, n) {
     }
 }
 
+/**
+ * @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 2020 Google LLC
@@ -1233,15 +1293,16 @@ class RestConnection {
         return false;
     }
     invokeRPC(rpcName, path, req, authToken, appCheckToken) {
+        const streamId = generateUniqueDebugId();
         const url = this.makeUrl(rpcName, path);
-        logDebug(LOG_TAG$3, 'Sending: ', url, req);
+        logDebug(LOG_TAG$3, `Sending RPC '${rpcName}' ${streamId}:`, url, req);
         const headers = {};
         this.modifyHeadersForRequest(headers, authToken, appCheckToken);
         return this.performRPCRequest(rpcName, url, headers, req).then(response => {
-            logDebug(LOG_TAG$3, 'Received: ', response);
+            logDebug(LOG_TAG$3, `Received RPC '${rpcName}' ${streamId}: `, response);
             return response;
         }, (err) => {
-            logWarn(LOG_TAG$3, `${rpcName} failed with error: `, err, 'url: ', url, 'request:', req);
+            logWarn(LOG_TAG$3, `RPC '${rpcName}' ${streamId} failed with error: `, err, 'url: ', url, 'request:', req);
             throw err;
         });
     }