Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Firestore: Improve debug logging of GrpcConnection and WebChannelConnection #7076

Merged
merged 3 commits into from
Mar 2, 2023
Merged

Firestore: Improve debug logging of GrpcConnection and WebChannelConnection #7076

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5f3f864
Improve logging in RestConnection, GrpcConnection, and WebChannelConn…
dconeybe Mar 1, 2023
352bbf3
yarn changeset
dconeybe Mar 1, 2023
b53446c
grpc_connection.ts: fix import order to make lint happy
dconeybe Mar 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/blue-eels-warn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@firebase/firestore': patch
'firebase': patch
---

Improved debug logging of networking abstractions
86 changes: 66 additions & 20 deletions packages/firestore/src/platform/browser/webchannel_connection.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,13 @@ import {
} from '../../remote/rpc_error';
import { StreamBridge } from '../../remote/stream_bridge';
import { fail, hardAssert } from '../../util/assert';
import { generateUniqueDebugId } from '../../util/debug_uid';
import { Code, FirestoreError } from '../../util/error';
import { logDebug, logWarn } from '../../util/log';
import { Rejecter, Resolver } from '../../util/promise';
import { StringMap } from '../../util/types';

const LOG_TAG = 'Connection';
const LOG_TAG = 'WebChannelConnection';

const RPC_STREAM_SERVICE = 'google.firestore.v1.Firestore';

Expand All @@ -70,6 +71,7 @@ export class WebChannelConnection extends RestConnection {
headers: StringMap,
body: Req
): Promise<Resp> {
const streamId = generateUniqueDebugId();
return new Promise((resolve: Resolver<Resp>, reject: Rejecter) => {
const xhr = new XhrIo();
xhr.setWithCredentials(true);
Expand All @@ -78,11 +80,15 @@ export class WebChannelConnection extends RestConnection {
switch (xhr.getLastErrorCode()) {
case ErrorCode.NO_ERROR:
const json = xhr.getResponseJson() as Resp;
logDebug(LOG_TAG, 'XHR received:', JSON.stringify(json));
logDebug(
LOG_TAG,
`XHR for RPC '${rpcName}' ${streamId} received:`,
JSON.stringify(json)
);
resolve(json);
break;
case ErrorCode.TIMEOUT:
logDebug(LOG_TAG, 'RPC "' + rpcName + '" timed out');
logDebug(LOG_TAG, `RPC '${rpcName}' ${streamId} timed out`);
reject(
new FirestoreError(Code.DEADLINE_EXCEEDED, 'Request time out')
);
Expand All @@ -91,7 +97,7 @@ export class WebChannelConnection extends RestConnection {
const status = xhr.getStatus();
logDebug(
LOG_TAG,
'RPC "' + rpcName + '" failed with status:',
`RPC '${rpcName}' ${streamId} failed with status:`,
status,
'response text:',
xhr.getResponseText()
Expand Down Expand Up @@ -134,22 +140,21 @@ export class WebChannelConnection extends RestConnection {
break;
default:
fail(
'RPC "' +
rpcName +
'" failed with unanticipated ' +
'webchannel error ' +
`RPC '${rpcName}' ${streamId} ` +
'failed with unanticipated webchannel error: ' +
xhr.getLastErrorCode() +
': ' +
xhr.getLastError() +
', giving up.'
);
}
} finally {
logDebug(LOG_TAG, 'RPC "' + rpcName + '" completed.');
logDebug(LOG_TAG, `RPC '${rpcName}' ${streamId} completed.`);
}
});

const requestString = JSON.stringify(body);
logDebug(LOG_TAG, `RPC '${rpcName}' ${streamId} sending request:`, body);
dconeybe marked this conversation as resolved.
Show resolved Hide resolved
xhr.send(url, 'POST', requestString, headers, XHR_TIMEOUT_SECS);
});
}
Expand All @@ -159,6 +164,7 @@ export class WebChannelConnection extends RestConnection {
authToken: Token | null,
appCheckToken: Token | null
): Stream<Req, Resp> {
const streamId = generateUniqueDebugId();
const urlParts = [
this.baseUrl,
'/',
Expand Down Expand Up @@ -217,7 +223,11 @@ export class WebChannelConnection extends RestConnection {
request.encodeInitMessageHeaders = true;

const url = urlParts.join('');
logDebug(LOG_TAG, 'Creating WebChannel: ' + url, request);
logDebug(
LOG_TAG,
`Creating RPC '${rpcName}' stream ${streamId}: ${url}`,
request
);
const channel = webchannelTransport.createWebChannel(url, request);

// WebChannel supports sending the first message with the handshake - saving
Expand All @@ -236,14 +246,26 @@ export class WebChannelConnection extends RestConnection {
sendFn: (msg: Req) => {
if (!closed) {
if (!opened) {
logDebug(LOG_TAG, 'Opening WebChannel transport.');
logDebug(
LOG_TAG,
`Opening RPC '${rpcName}' stream ${streamId} transport.`
);
channel.open();
opened = true;
}
logDebug(LOG_TAG, 'WebChannel sending:', msg);
logDebug(
LOG_TAG,
`RPC '${rpcName}' stream ${streamId} sending:`,
msg
);
channel.send(msg);
} else {
logDebug(LOG_TAG, 'Not sending because WebChannel is closed:', msg);
logDebug(
LOG_TAG,
`Not sending because RPC '${rpcName}' stream ${streamId} ` +
'is closed:',
msg
);
}
},
closeFn: () => channel.close()
Expand Down Expand Up @@ -273,22 +295,32 @@ export class WebChannelConnection extends RestConnection {

unguardedEventListen(channel, WebChannel.EventType.OPEN, () => {
if (!closed) {
logDebug(LOG_TAG, 'WebChannel transport opened.');
logDebug(
LOG_TAG,
`RPC '${rpcName}' stream ${streamId} transport opened.`
);
}
});

unguardedEventListen(channel, WebChannel.EventType.CLOSE, () => {
if (!closed) {
closed = true;
logDebug(LOG_TAG, 'WebChannel transport closed');
logDebug(
LOG_TAG,
`RPC '${rpcName}' stream ${streamId} transport closed`
);
streamBridge.callOnClose();
}
});

unguardedEventListen<Error>(channel, WebChannel.EventType.ERROR, err => {
if (!closed) {
closed = true;
logWarn(LOG_TAG, 'WebChannel transport errored:', err);
logWarn(
LOG_TAG,
`RPC '${rpcName}' stream ${streamId} transport errored:`,
err
);
streamBridge.callOnClose(
new FirestoreError(
Code.UNAVAILABLE,
Expand Down Expand Up @@ -322,7 +354,11 @@ export class WebChannelConnection extends RestConnection {
msgDataOrError.error ||
(msgDataOrError as WebChannelError[])[0]?.error;
if (error) {
logDebug(LOG_TAG, 'WebChannel received error:', error);
logDebug(
LOG_TAG,
`RPC '${rpcName}' stream ${streamId} received error:`,
error
);
// error.status will be a string like 'OK' or 'NOT_FOUND'.
const status: string = error.status;
let code = mapCodeFromRpcStatus(status);
Expand All @@ -340,7 +376,11 @@ export class WebChannelConnection extends RestConnection {
streamBridge.callOnClose(new FirestoreError(code, message));
channel.close();
} else {
logDebug(LOG_TAG, 'WebChannel received:', msgData);
logDebug(
LOG_TAG,
`RPC '${rpcName}' stream ${streamId} received:`,
msgData
);
streamBridge.callOnMessage(msgData);
}
}
Expand All @@ -349,9 +389,15 @@ export class WebChannelConnection extends RestConnection {

unguardedEventListen<StatEvent>(requestStats, Event.STAT_EVENT, event => {
if (event.stat === Stat.PROXY) {
logDebug(LOG_TAG, 'Detected buffering proxy');
logDebug(
LOG_TAG,
`RPC '${rpcName}' stream ${streamId} detected buffering proxy`
);
} else if (event.stat === Stat.NOPROXY) {
logDebug(LOG_TAG, 'Detected no buffering proxy');
logDebug(
LOG_TAG,
`RPC '${rpcName}' stream ${streamId} detected no buffering proxy`
);
}
});

Expand Down
Loading