@webda/grpc 4.0.0-beta.5 → 4.0.0-beta.7

package/src/connect.e2e.spec.ts

@@ -0,0 +1,114 @@
+import { suite, test } from "@webda/test";
+import * as assert from "assert";
+import { mkdtempSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+import * as grpc from "@grpc/grpc-js";
+import * as protoLoader from "@grpc/proto-loader";
+import WebSocket from "ws";
+import { useInstanceStorage, useService } from "@webda/core";
+import { HttpServer } from "@webda/core/lib/services/httpserver.service.js";
+import { WebdaApplicationTest } from "@webda/core/lib/test/application.js";
+import { TestApplication } from "@webda/core/lib/test/objects.js";
+import { GRPC_FIXTURE_SERVICES, GrpcFixtureService, fixtureState, registerGrpcFixture } from "../test/fixture.js";
+import { GrpcService } from "./grpcservice.service.js";
+
+const protoFile = join(mkdtempSync(join(tmpdir(), "connect-e2e-")), "app.proto");
+
+/**
+ * @param check - condition
+ */
+async function until(check: () => boolean): Promise<void> {
+  for (let i = 0; i < 500 && !check(); i++) await new Promise(r => setTimeout(r, 10));
+  if (!check()) throw new Error("timed out");
+}
+
+/** The same `async *connect(frames)` served as a gRPC bidi stream (h2c) and as a WebSocket (HTTP/1.1). */
+@suite
+class ConnectEndToEndTest extends WebdaApplicationTest {
+  getTestConfiguration(): any {
+    return {
+      services: {
+        ...GRPC_FIXTURE_SERVICES,
+        HttpServer: { type: "Webda/HttpServer", port: 0 },
+        GrpcServer: { type: "Webda/HttpServer", port: 0, h2c: true },
+        RESTService: { type: "Webda/RESTOperationsTransport" },
+        Grpc: { type: "Webda/GrpcService", protoFile, operations: ["Fixture.*"] }
+      }
+    };
+  }
+
+  async tweakApp(app: TestApplication): Promise<void> {
+    await super.tweakApp(app);
+    app.addModda("Webda/GrpcFixtureService", GrpcFixtureService);
+    app.addModda("Webda/HttpServer", HttpServer);
+    app.addModda("Webda/GrpcService", GrpcService);
+  }
+
+  @test
+  async sameOperationOnBothTransports() {
+    registerGrpcFixture();
+    const grpcService = useService("Grpc" as any) as unknown as GrpcService;
+    await grpcService.build();
+    grpcService.loadDefinitions();
+    (useService("RESTService" as any) as any).exposeServiceOperations({
+      "Fixture.Connect": useInstanceStorage().operations["Fixture.Connect"]
+    });
+    const http = useService("HttpServer" as any) as any;
+    const h2c = useService("GrpcServer" as any) as any;
+    await http.start("127.0.0.1", 0);
+    await h2c.start("127.0.0.1", 0);
+    let client: any;
+    let ws: WebSocket | undefined;
+    try {
+      await until(() => http.server?.listening && h2c.server?.listening);
+
+      // gRPC
+      fixtureState.connectClosed = false;
+      const definition = protoLoader.loadSync(protoFile, { keepCase: true, defaults: true, oneofs: true });
+      const pkg: any = grpc.loadPackageDefinition(definition).webda;
+      client = new pkg.FixtureService(`127.0.0.1:${h2c.server.address().port}`, grpc.credentials.createInsecure());
+      const metadata = new grpc.Metadata();
+      metadata.set("authorization", "Bearer e2e");
+      const call = client.Connect(metadata);
+      const overGrpc: string[] = [];
+      let grpcStatus: any;
+      call.on("data", (m: any) => overGrpc.push(m.frame));
+      call.on("status", (s: any) => (grpcStatus = s));
+      call.on("error", () => {});
+      await until(() => overGrpc.length === 1);
+      call.write({ frame: "x" });
+      await until(() => overGrpc.length === 2);
+      call.end();
+      await until(() => grpcStatus !== undefined);
+      assert.strictEqual(grpcStatus.code, grpc.status.OK);
+      await until(() => fixtureState.connectClosed);
+
+      // WebSocket
+      fixtureState.connectClosed = false;
+      ws = new WebSocket(`ws://127.0.0.1:${http.server.address().port}/fixture/connect`, {
+        headers: { authorization: "Bearer e2e" }
+      });
+      const overWs: string[] = [];
+      ws.on("message", data => overWs.push(JSON.parse(String(data)).frame));
+      let wsClose: number | undefined;
+      ws.on("close", code => (wsClose = code));
+      await new Promise(r => ws!.on("open", r));
+      await until(() => overWs.length === 1);
+      ws.send(JSON.stringify({ frame: "x" }));
+      await until(() => overWs.length === 2);
+      ws.close(1000);
+      await until(() => wsClose !== undefined);
+      assert.strictEqual(wsClose, 1000);
+      await until(() => fixtureState.connectClosed);
+
+      assert.deepStrictEqual(overGrpc, ["hello Bearer e2e", "echo x Bearer e2e"]);
+      assert.deepStrictEqual(overWs, overGrpc);
+    } finally {
+      client?.close();
+      ws?.terminate();
+      await http.stop();
+      await h2c.stop();
+    }
+  }
+}

package/src/grpc-context.ts

@@ -0,0 +1,93 @@
+import { once } from "node:events";
+import type { ServerResponse } from "node:http";
+import { HttpContext, StreamingOperationContext, toPublicChunk } from "@webda/core";
+import type { GrpcStream } from "./grpc-stream.js";
+
+/**
+ * A gRPC message for a value: objects as they are, anything else as `{ value }`, `__` keys removed
+ * @param value - an operation result or streamed chunk
+ * @returns the message
+ */
+export function toGrpcMessage(value: unknown): Record<string, unknown> {
+  const plain = toPublicChunk(value);
+  return typeof plain === "object" && plain !== null && !Array.isArray(plain)
+    ? (plain as Record<string, unknown>)
+    : { value: plain };
+}
+
+/**
+ * The context of one gRPC call: request metadata as HTTP headers (so useContext().getHttpContext() works and the
+ * session loads), the unary request message as input, and streamed output sent message by message.
+ */
+export class GrpcOperationContext extends StreamingOperationContext {
+  private message?: Buffer;
+
+  /**
+   * @param httpContext - request line and metadata
+   * @param stream - the gRPC stream of the call
+   * @param response - the HTTP/2 response (drain/close events)
+   */
+  constructor(
+    httpContext: HttpContext,
+    private readonly stream: GrpcStream,
+    private readonly response: ServerResponse
+  ) {
+    super(httpContext);
+  }
+
+  /**
+   * The single request message of a unary or server-streaming call
+   * @param message - decoded message
+   * @returns this
+   */
+  setMessage(message: unknown): this {
+    this.message = Buffer.from(JSON.stringify(message ?? {}));
+    return this;
+  }
+
+  /**
+   * @override
+   */
+  async getRawInput(limit: number = 10 * 1024 * 1024): Promise<Buffer> {
+    return (this.message ?? Buffer.from("{}")).subarray(0, limit);
+  }
+
+  /**
+   * `getInput()` reads the body through this method, not through `getRawInput()`
+   * @override
+   */
+  async getRawInputAsString(limit?: number): Promise<string> {
+    return (await this.getRawInput(limit)).toString();
+  }
+
+  /**
+   * The response is over
+   * @override
+   */
+  protected get connectionEnded(): boolean {
+    const response = this.response as { writableEnded?: boolean; destroyed?: boolean };
+    return Boolean(response.writableEnded || response.destroyed);
+  }
+
+  /**
+   * One gRPC message per chunk
+   * @override
+   */
+  protected sendChunk(chunk: any): boolean {
+    return this.stream.send(toGrpcMessage(chunk));
+  }
+
+  /**
+   * Wait for the response buffer to empty, or the response to close or fail
+   * @override
+   */
+  protected async waitForDrain(signal: AbortSignal): Promise<void> {
+    await Promise.race([
+      once(this.response, "drain", { signal }),
+      once(this.response, "close", { signal }),
+      once(this.response, "error", { signal }).then(([error]) => {
+        throw error;
+      })
+    ]);
+  }
+}

package/src/grpc-live.spec.ts

@@ -0,0 +1,377 @@
+import { suite, test } from "@webda/test";
+import * as assert from "assert";
+import { EventEmitter } from "node:events";
+import { connect } from "node:http2";
+import { mkdtempSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+import * as grpc from "@grpc/grpc-js";
+import * as protoLoader from "@grpc/proto-loader";
+import { HttpContext, WebdaError, useRouter, useService } from "@webda/core";
+import { HttpServer } from "@webda/core/lib/services/httpserver.service.js";
+import { WebdaApplicationTest } from "@webda/core/lib/test/application.js";
+import { TestApplication } from "@webda/core/lib/test/objects.js";
+import { GRPC_FIXTURE_SERVICES, GrpcFixtureService, fixtureState, registerGrpcFixture } from "../test/fixture.js";
+import { GrpcOperationContext, toGrpcMessage } from "./grpc-context.js";
+import { GrpcService } from "./grpcservice.service.js";
+
+const protoFile = join(mkdtempSync(join(tmpdir(), "grpc-live-")), "app.proto");
+
+/**
+ * Polls until a condition holds
+ * @param check - the condition
+ * @param ms - timeout
+ */
+async function until(check: () => boolean, ms = 5000): Promise<void> {
+  const end = Date.now() + ms;
+  while (!check()) {
+    if (Date.now() > end) throw new Error("timed out");
+    await new Promise(r => setTimeout(r, 10));
+  }
+}
+
+@suite
+class GrpcLiveTest extends WebdaApplicationTest {
+  client: any;
+
+  getTestConfiguration(): any {
+    return {
+      services: {
+        ...GRPC_FIXTURE_SERVICES,
+        HttpServer: { type: "Webda/HttpServer", port: 0, h2c: true },
+        Grpc: {
+          type: "Webda/GrpcService",
+          protoFile,
+          operations: ["Fixture.*"],
+          maxQueuedMessages: 5,
+          maxQueuedBytes: 1000
+        }
+      }
+    };
+  }
+
+  async tweakApp(app: TestApplication): Promise<void> {
+    await super.tweakApp(app);
+    app.addModda("Webda/GrpcFixtureService", GrpcFixtureService);
+    app.addModda("Webda/HttpServer", HttpServer);
+    app.addModda("Webda/GrpcService", GrpcService);
+  }
+
+  /** Registers the fixture, writes and loads its proto, starts the h2c server once, and connects a client. */
+  async connect(): Promise<any> {
+    if (this.client) return this.client;
+    registerGrpcFixture();
+    const service = useService("Grpc" as any) as unknown as GrpcService;
+    await service.build();
+    service.loadDefinitions();
+    const http = useService("HttpServer" as any) as any;
+    await http.start("127.0.0.1", 0);
+    await until(() => http.server?.listening);
+    const definition = protoLoader.loadSync(protoFile, {
+      keepCase: true,
+      longs: String,
+      enums: String,
+      defaults: true,
+      oneofs: false // the client would add `_field` markers for proto3 optional fields
+    });
+    const pkg: any = grpc.loadPackageDefinition(definition).webda;
+    this.client = new pkg.FixtureService(`127.0.0.1:${http.server.address().port}`, grpc.credentials.createInsecure());
+    return this.client;
+  }
+
+  async afterAll() {
+    this.client?.close();
+    await super.afterAll?.();
+  }
+
+  @test
+  async unaryCallsSeeTheMetadata() {
+    const client = await this.connect();
+    const metadata = new grpc.Metadata();
+    metadata.set("authorization", "Bearer u1");
+    const out = await new Promise<any>((resolve, reject) =>
+      client.Echo({ text: "hi" }, metadata, (err: Error, res: any) => (err ? reject(err) : resolve(res)))
+    );
+    assert.deepStrictEqual(out, { text: "hi", authorization: "Bearer u1" });
+  }
+
+  @test
+  async unaryErrorsBeforeAnyMessageAreStatuses() {
+    const client = await this.connect();
+    const err: any = await new Promise(resolve => client.Echo({ text: "boom" }, (e: Error) => resolve(e)));
+    assert.strictEqual(err.code, grpc.status.NOT_FOUND);
+    assert.match(err.details, /Nothing to echo/);
+  }
+
+  @test
+  async aFailedStreamIsNotCalledOrWrittenTo() {
+    await this.connect();
+    const http = useService("HttpServer" as any) as any;
+    const session = connect(`http://127.0.0.1:${http.server.address().port}`);
+    const request = session.request({
+      ":method": "POST",
+      ":path": "/webda.FixtureService/Echo",
+      "content-type": "application/grpc"
+    });
+    const trailers = new Promise<any>(resolve => request.on("trailers", resolve));
+    const headers = new Promise<any>(resolve => request.on("response", resolve));
+    request.on("data", () => {});
+    // A compressed frame: the stream fails with UNIMPLEMENTED and then sees the end of the request
+    request.end(Buffer.from([1, 0, 0, 0, 2, 123, 125]));
+    const received = { ...(await headers), ...(await Promise.race([trailers, new Promise(r => setTimeout(r, 200))])) };
+    session.close();
+    assert.strictEqual(received["grpc-status"], String(grpc.status.UNIMPLEMENTED));
+  }
+
+  @test
+  async serverStreamingIsLive() {
+    const client = await this.connect();
+    fixtureState.ticksClosed = false;
+    const got: number[] = [];
+    const call = client.Ticks({ n: 3 });
+    call.on("data", (m: any) => got.push(m.index));
+    const ended = new Promise(resolve => call.on("status", resolve));
+    await until(() => got.length === 1);
+    await new Promise(r => setTimeout(r, 50));
+    assert.deepStrictEqual(got, [1]); // the generator is still waiting at its gate
+    fixtureState.open();
+    const status: any = await ended;
+    assert.strictEqual(status.code, grpc.status.OK);
+    assert.deepStrictEqual(got, [1, 2, 3]);
+    assert.strictEqual(fixtureState.ticksClosed, true);
+  }
+
+  @test
+  async clientStreamingSums() {
+    const client = await this.connect();
+    const total = await new Promise<number>((resolve, reject) => {
+      const call = client.Sum((err: Error, res: any) => (err ? reject(err) : resolve(res.total)));
+      call.write({ value: 2 });
+      call.write({ value: 3 });
+      call.end();
+    });
+    assert.strictEqual(total, 5);
+  }
+
+  @test
+  async bidiIsLongLivedAndSeesTheMetadata() {
+    const client = await this.connect();
+    fixtureState.connectClosed = false;
+    const metadata = new grpc.Metadata();
+    metadata.set("authorization", "Bearer t1");
+    const call = client.Connect(metadata);
+    const got: string[] = [];
+    call.on("data", (m: any) => got.push(m.frame));
+    const status = new Promise<any>(resolve => call.on("status", resolve));
+    await until(() => got.length === 1);
+    call.write({ frame: "a" });
+    await until(() => got.length === 2);
+    call.write({ frame: "b" });
+    await until(() => got.length === 3);
+    assert.deepStrictEqual(got, ["hello Bearer t1", "echo a Bearer t1", "echo b Bearer t1"]);
+    call.end(); // half-close: the input stream ends, the generator finishes
+    assert.strictEqual((await status).code, grpc.status.OK);
+    assert.strictEqual(fixtureState.connectClosed, true);
+  }
+
+  @test
+  async cancelClosesTheGenerator() {
+    const client = await this.connect();
+    fixtureState.connectClosed = false;
+    const call = client.Connect(new grpc.Metadata());
+    const got: string[] = [];
+    call.on("data", (m: any) => got.push(m.frame));
+    call.on("error", () => {}); // CANCELLED, expected
+    await until(() => got.length === 1);
+    call.cancel();
+    await until(() => fixtureState.connectClosed);
+  }
+
+  @test
+  async errorsBecomeStatuses() {
+    const client = await this.connect();
+    const call = client.Connect(new grpc.Metadata());
+    const error = new Promise<any>(resolve => call.on("error", resolve));
+    call.on("data", () => {});
+    call.write({ frame: "fail" });
+    const err = await error;
+    assert.strictEqual(err.code, grpc.status.NOT_FOUND);
+    assert.match(err.details, /No such frame/);
+  }
+
+  @test
+  async internalErrorMessagesAreHidden() {
+    const client = await this.connect();
+    const err: any = await new Promise(resolve => client.Leak({ text: "x" }, (e: Error) => resolve(e)));
+    assert.strictEqual(err.code, grpc.status.INTERNAL);
+    assert.ok(!/secret/.test(err.details), err.details);
+    assert.match(err.details, /Internal server error/);
+    // A client error keeps its message
+    const notFound: any = await new Promise(resolve => client.Echo({ text: "boom" }, (e: Error) => resolve(e)));
+    assert.strictEqual(notFound.code, grpc.status.NOT_FOUND);
+    assert.match(notFound.details, /Nothing to echo/);
+  }
+
+  @test
+  async requestFiltersApplyToCalls() {
+    const client = await this.connect();
+    useRouter().registerRequestFilter({
+      checkRequest: async ctx => ctx.getHttpContext().getUniqueHeader("x-block") !== "yes"
+    });
+    fixtureState.echoCalls = 0;
+    const blocked = new grpc.Metadata();
+    blocked.set("x-block", "yes");
+    const err: any = await new Promise(resolve => client.Echo({ text: "hi" }, blocked, (e: Error) => resolve(e)));
+    assert.strictEqual(err.code, grpc.status.PERMISSION_DENIED);
+    assert.strictEqual(fixtureState.echoCalls, 0, "the operation must not run");
+    const out = await new Promise<any>((resolve, reject) =>
+      client.Echo({ text: "hi" }, (e: Error, res: any) => (e ? reject(e) : resolve(res)))
+    );
+    assert.strictEqual(out.text, "hi");
+    assert.strictEqual(fixtureState.echoCalls, 1);
+  }
+
+  @test
+  async floodingAnOperationThatDoesNotReadFailsWithResourceExhausted() {
+    const client = await this.connect();
+    fixtureState.floodClosed = false;
+    const call = client.Flood(new grpc.Metadata());
+    call.on("data", () => {});
+    const error = new Promise<any>(resolve => call.on("error", resolve));
+    for (let i = 0; i < 50; i++) call.write({ frame: `f${i}` });
+    const err = await error;
+    assert.strictEqual(err.code, grpc.status.RESOURCE_EXHAUSTED);
+    await until(() => fixtureState.floodClosed);
+  }
+
+  @test
+  async floodingBytesUnderTheMessageCapFailsWithResourceExhausted() {
+    const client = await this.connect();
+    fixtureState.floodClosed = false;
+    const call = client.Flood(new grpc.Metadata());
+    call.on("data", () => {});
+    const error = new Promise<any>(resolve => call.on("error", resolve));
+    // 3 messages of 600 bytes: under the 5 messages cap, over the 1000 bytes one
+    for (let i = 0; i < 3; i++) call.write({ frame: "x".repeat(600) });
+    const err = await error;
+    assert.strictEqual(err.code, grpc.status.RESOURCE_EXHAUSTED);
+    assert.match(err.details, /queued bytes/);
+    await until(() => fixtureState.floodClosed);
+  }
+
+  @test
+  async contextWaitsForDrainAndStopsOnCancel() {
+    const response = new EventEmitter() as any;
+    const sent: unknown[] = [];
+    const stream = { send: (m: unknown) => (sent.push(m), false) } as any;
+    const ctx = new GrpcOperationContext(new HttpContext("localhost", "POST", "/x"), stream, response);
+    ctx.setExtension("operationStreaming", true);
+    assert.strictEqual(ctx.write({ a: 1, __hidden: 2 }), false);
+    assert.deepStrictEqual(sent, [{ a: 1 }]);
+    const drained = ctx.drained();
+    response.emit("drain");
+    await drained;
+    ctx.cancel();
+    assert.throws(() => ctx.write({ a: 2 }), WebdaError.OperationCancelledError);
+    await assert.rejects(() => ctx.drained(), WebdaError.OperationCancelledError);
+  }
+
+  @test
+  async anOperationCancellationWithAConnectedClientEndsWithCancelled() {
+    const client = await this.connect();
+    const err: any = await new Promise(resolve => client.Abort({ text: "x" }, (e: Error) => resolve(e)));
+    assert.strictEqual(err.code, grpc.status.CANCELLED);
+  }
+
+  @test
+  async aStreamFailingMidCallEndsTheOperation() {
+    await this.connect();
+    fixtureState.connectClosed = false;
+    const http = useService("HttpServer" as any) as any;
+    const session = connect(`http://127.0.0.1:${http.server.address().port}`);
+    const request = session.request({
+      ":method": "POST",
+      ":path": "/webda.FixtureService/Connect",
+      "content-type": "application/grpc"
+    });
+    const received: Record<string, any> = {};
+    request.on("response", headers => Object.assign(received, headers));
+    request.on("trailers", trailers => Object.assign(received, trailers));
+    request.on("data", () => {});
+    const closed = new Promise(resolve => request.on("end", resolve)); // the response is over; the request side stays open
+    request.write(Buffer.from([0, 0, 0, 0, 3, 0x0a, 0x01, 0x61])); // { frame: "a" }
+    await new Promise(r => setTimeout(r, 100));
+    request.write(Buffer.from([1, 0, 0, 0, 0])); // compressed: the stream fails
+    await closed;
+    session.close();
+    assert.strictEqual(received["grpc-status"], String(grpc.status.UNIMPLEMENTED));
+    await until(() => fixtureState.connectClosed);
+  }
+
+  @test
+  async drainedLeavesNoListenerAndStopsWhenTheResponseIsOver() {
+    const response = new EventEmitter() as any;
+    const ctx = new GrpcOperationContext(
+      new HttpContext("localhost", "POST", "/x"),
+      { send: () => true } as any,
+      response
+    );
+    const baseline = ["drain", "close", "error"].map(name => response.listenerCount(name));
+    for (let i = 0; i < 25; i++) {
+      const wait = ctx.drained();
+      response.emit("drain");
+      await wait;
+    }
+    assert.deepStrictEqual(
+      ["drain", "close", "error"].map(name => response.listenerCount(name)),
+      baseline
+    );
+    const closing = ctx.drained();
+    response.destroyed = true;
+    response.emit("close");
+    await assert.rejects(() => closing, WebdaError.OperationCancelledError);
+    await assert.rejects(() => ctx.drained(), WebdaError.OperationCancelledError);
+    ctx.setExtension("operationStreaming", true);
+    assert.throws(() => ctx.write({ a: 1 }), WebdaError.OperationCancelledError);
+  }
+
+  @test
+  async drainedRejectsWithACancellationOnResponseError() {
+    const response = new EventEmitter() as any;
+    const ctx = new GrpcOperationContext(
+      new HttpContext("localhost", "POST", "/x"),
+      { send: () => true } as any,
+      response
+    );
+    const wait = ctx.drained();
+    response.emit("error", new Error("boom"));
+    await assert.rejects(() => wait, WebdaError.OperationCancelledError);
+  }
+
+  @test
+  messagesAreObjectsWithoutHiddenKeys() {
+    assert.deepStrictEqual(toGrpcMessage(3), { value: 3 });
+    assert.deepStrictEqual(toGrpcMessage("a"), { value: "a" });
+    assert.deepStrictEqual(toGrpcMessage([1]), { value: [1] });
+    assert.deepStrictEqual(toGrpcMessage({ a: 1, __b: 2, c: { __d: 1, e: 2 } }), { a: 1, c: { e: 2 } });
+    const sent: unknown[] = [];
+    const ctx = new GrpcOperationContext(
+      new HttpContext("localhost", "POST", "/x"),
+      { send: (m: unknown) => (sent.push(m), true) } as any,
+      new EventEmitter() as any
+    );
+    ctx.setExtension("operationStreaming", true);
+    ctx.write(7);
+    assert.deepStrictEqual(sent, [{ value: 7 }]);
+  }
+
+  @test
+  unaryResponsesAreWrapped() {
+    const service: any = Object.create(GrpcService.prototype);
+    assert.deepStrictEqual(service.unaryResponse(undefined), {});
+    assert.deepStrictEqual(service.unaryResponse(""), {});
+    assert.deepStrictEqual(service.unaryResponse('{"a":1,"__h":2}'), { a: 1 });
+    assert.deepStrictEqual(service.unaryResponse("12"), { value: 12 });
+    assert.deepStrictEqual(service.unaryResponse("not json"), { value: "not json" });
+  }
+}