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

Jump to bottom

grpc-js: Add a timer that holds the event loop open while there are pending calls #1580

Merged
merged 3 commits into from Sep 17, 2020
Merged

grpc-js: Add a timer that holds the event loop open while there are pending calls #1580

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2791dbb
grpc-js: Add a timer that holds the event loop open while there are p…
murgatroid99 Sep 17, 2020
6a32c00
Bump grpc-js to 1.1.7
murgatroid99 Sep 17, 2020
a160081
Move timer initialization to the beginning of channel construction
murgatroid99 Sep 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/grpc-js/package.json
View file
Open in desktop
@@ -1,6 +1,6 @@
{
"name": "@grpc/grpc-js",
"version": "1.1.6",
"version": "1.1.7",
"description": "gRPC Library for Node - pure JS implementation",
"homepage": "https://grpc.io/",
"repository": "https://github.com/grpc/grpc-node/tree/master/packages/grpc-js",
Expand Down
24 changes: 21 additions & 3 deletions packages/grpc-js/src/channel.ts
View file
Open in desktop
Expand Up @@ -137,6 +137,14 @@ export class ChannelImplementation implements Channel {
private defaultAuthority: string;
private filterStackFactory: FilterStackFactory;
private target: GrpcUri;
/**
* This timer does not do anything on its own. Its purpose is to hold the
* event loop open while there are any pending calls for the channel that
* have not yet been assigned to specific subchannels. In other words,
* the invariant is that callRefTimer is reffed if and only if pickQueue
* is non-empty.
*/
private callRefTimer: NodeJS.Timer;
constructor(
target: string,
private readonly credentials: ChannelCredentials,
Expand Down Expand Up @@ -206,6 +214,7 @@ export class ChannelImplementation implements Channel {
updateState: (connectivityState: ConnectivityState, picker: Picker) => {
this.currentPicker = picker;
const queueCopy = this.pickQueue.slice();
this.callRefTimer.unref?.();
this.pickQueue = [];
for (const { callStream, callMetadata } of queueCopy) {
this.tryPick(callStream, callMetadata);
Expand All @@ -230,6 +239,14 @@ export class ChannelImplementation implements Channel {
new MaxMessageSizeFilterFactory(this.options),
new CompressionFilterFactory(this),
]);

this.callRefTimer = setInterval(() => {}, 1 << 31 - 1);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't there a maxint constant?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is Number.MAX_SAFE_INTEGER, but it's larger than that, and Number.MAX_VALUE, which is even larger.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, https://www.npmjs.com/package/node-noop :-P

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sadly, that's not even the only package that provides a noop function. We used to depend on one of them.

this.callRefTimer.unref?.();
}

private pushPick(callStream: Http2CallStream, callMetadata: Metadata) {
this.callRefTimer.ref?.();
this.pickQueue.push({ callStream, callMetadata });
}

/**
Expand Down Expand Up @@ -276,7 +293,7 @@ export class ChannelImplementation implements Channel {
' has state ' +
ConnectivityState[pickResult.subchannel!.getConnectivityState()]
);
this.pickQueue.push({ callStream, callMetadata });
this.pushPick(callStream, callMetadata);
break;
}
/* We need to clone the callMetadata here because the transparent
Expand Down Expand Up @@ -367,11 +384,11 @@ export class ChannelImplementation implements Channel {
}
break;
case PickResultType.QUEUE:
this.pickQueue.push({ callStream, callMetadata });
this.pushPick(callStream, callMetadata);
break;
case PickResultType.TRANSIENT_FAILURE:
if (callMetadata.getOptions().waitForReady) {
this.pickQueue.push({ callStream, callMetadata });
this.pushPick(callStream, callMetadata);
} else {
callStream.cancelWithStatus(
pickResult.status!.code,
Expand Down Expand Up @@ -433,6 +450,7 @@ export class ChannelImplementation implements Channel {
close() {
this.resolvingLoadBalancer.destroy();
this.updateState(ConnectivityState.SHUTDOWN);
clearInterval(this.callRefTimer);

this.subchannelPool.unrefUnusedSubchannels();
}
Expand Down