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.

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

Fix early event loop exit on nodejs when H2 sessions are in the verify state #861

Merged
merged 4 commits into from
Oct 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions packages/connect-node/.npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
/*.json
/dist/*/**/*.spec.js
/dist/*/**/*.spec.d.ts
/dist/*/testdata/
Copy link
Member

Choose a reason for hiding this comment

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

🙏

19 changes: 19 additions & 0 deletions packages/connect-node/src/http2-session-manager.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import { useNodeServer } from "./use-node-server-helper.spec.js";
import * as http2 from "http2";
import { Http2SessionManager } from "./http2-session-manager.js";
import { ConnectError } from "@connectrpc/connect";
import { Worker } from "worker_threads";

describe("Http2SessionManager", function () {
const serverSessions: http2.ServerHttp2Session[] = [];
Expand Down Expand Up @@ -167,6 +168,24 @@ describe("Http2SessionManager", function () {
sm.abort();
expect(sm.state()).toBe("closed");
});
it("verify should keep the process alive", async function () {
const worker = new Worker(
Comment on lines +171 to +172
Copy link
Member

Choose a reason for hiding this comment

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

Great idea to use a worker instead of a child process. I don't see an alternative to test the actual outcome, and I think it's worth it.

"./dist/cjs/testdata/http2-session-manager-verify-ping.js",
{
workerData: server.getUrl(),
},
);
worker.once("error", (err) => {
fail(err);
});
await expectAsync(
new Promise<string>((resolve) => {
worker.once("message", (message) => {
resolve(message as string);
});
}),
).toBeResolvedTo("done");
});
it("should open a new connection if verification for the old one fails", async function () {
const sm = new Http2SessionManager(server.getUrl(), {
pingTimeoutMs: 0, // intentionally unsatisfiable
Expand Down
6 changes: 5 additions & 1 deletion packages/connect-node/src/http2-session-manager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -647,8 +647,12 @@ function ready(
resetPingInterval();
},
ping() {
conn.ref();
return new Promise<boolean>((resolve) => {
commonPing(() => resolve(true));
commonPing(() => {
if (streamCount == 0) conn.unref();
resolve(true);
});
conn.once("error", () => resolve(false));
});
},
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// Copyright 2021-2023 The Connect Authors
//
// 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.

/* eslint-disable @typescript-eslint/no-unsafe-argument,@typescript-eslint/no-floating-promises */

import { Http2SessionManager } from "../http2-session-manager.js";
import * as http2 from "http2";
import { parentPort, workerData } from "worker_threads";

const sm = new Http2SessionManager(workerData, {
pingIntervalMs: 5, // intentionally short for faster tests
});
sm.request("POST", "/", {}, {}).then((req) => {
req.close(http2.constants.NGHTTP2_NO_ERROR, () =>
setTimeout(() => {
sm.request("POST", "/", {}, {}).then((req) => {
req.close(http2.constants.NGHTTP2_NO_ERROR, () => {
parentPort!.postMessage("done");
});
});
}, 10),
);
});
2 changes: 1 addition & 1 deletion packages/connect-node/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"files": ["src/index.ts"],
"include": ["src/**/*.spec.ts"],
"include": ["src/**/*.spec.ts", "src/testdata/*.ts"],
"extends": "../../tsconfig.base.json"
}