Add server support for Connect HTTP GET requests

packages/connect-express/src/express-connect-middleware.ts

@@ -74,7 +74,8 @@ export function expressConnectMiddleware(
     res: express.Response,
     next: express.NextFunction
   ) {
-    const uHandler = paths.get(req.url);
+    // Strip the query parameter when matching paths.
+    const uHandler = paths.get(req.url.split("?", 2)[0]);
     if (!uHandler) {
       return next();
     }

packages/connect-next/src/connect-nextjs-adapter.ts

@@ -73,7 +73,8 @@ export function nextJsApiRouter(options: NextJsApiRouterOptions): ApiRoute {
   }
 
   async function handler(req: NextApiRequest, res: NextApiResponse) {
-    const requestPath = req.url ?? "";
+    // Strip the query parameter when matching paths.
+    const requestPath = req.url?.split("?", 2)[0] ?? "";
     const uHandler = paths.get(requestPath);
     if (!uHandler) {
       res.writeHead(404);

packages/connect-node-test/src/crosstest/cacheable_unary.spec.ts

@@ -28,83 +28,37 @@ describe("cacheable_unary", function () {
   const servers = createTestServers();
   beforeAll(async () => await servers.start());
 
-  servers.describeTransportsExcluding(
-    // connect-node servers currently do not support HTTP GET.
-    [
-      "@bufbuild/connect-node (Connect, binary, http, gzip) against @bufbuild/connect-express (h1)",
-      "@bufbuild/connect-node (Connect, binary, http, gzip) against @bufbuild/connect-fastify (h2c)",
-      "@bufbuild/connect-node (Connect, binary, http, gzip) against @bufbuild/connect-node (h1)",
-      "@bufbuild/connect-node (Connect, binary, http) against @bufbuild/connect-node (h1)",
-      "@bufbuild/connect-node (Connect, binary, http2, gzip) against @bufbuild/connect-node (h2c)",
-      "@bufbuild/connect-node (Connect, binary, https) against @bufbuild/connect-node (h1 + tls)",
-      "@bufbuild/connect-node (Connect, JSON, http, gzip) against @bufbuild/connect-express (h1)",
-      "@bufbuild/connect-node (Connect, JSON, http, gzip) against @bufbuild/connect-fastify (h2c)",
-      "@bufbuild/connect-node (Connect, JSON, http, gzip) against @bufbuild/connect-node (h1)",
-      "@bufbuild/connect-node (Connect, JSON, http) against @bufbuild/connect-node (h1)",
-      "@bufbuild/connect-node (Connect, JSON, http2, gzip) against @bufbuild/connect-node (h2c)",
-      "@bufbuild/connect-node (Connect, JSON, https) against @bufbuild/connect-node (h1 + tls)",
-      "@bufbuild/connect-node (gRPC-web, binary, http, gzip against @bufbuild/connect-fastify (h2c)",
-      "@bufbuild/connect-node (gRPC-web, binary, http, gzip) against @bufbuild/connect-express (h1)",
-      "@bufbuild/connect-node (gRPC-web, binary, http, gzip) against @bufbuild/connect-node (h1)",
-      "@bufbuild/connect-node (gRPC-web, binary, http) against @bufbuild/connect-node (h1)",
-      "@bufbuild/connect-node (gRPC-web, binary, http2, gzip) against @bufbuild/connect-node (h2c)",
-      "@bufbuild/connect-node (gRPC-web, binary, http2) against @bufbuild/connect-node (h2c)",
-      "@bufbuild/connect-node (gRPC-web, binary, https) against @bufbuild/connect-node (h1 + tls)",
-      "@bufbuild/connect-node (gRPC-web, JSON, http, gzip) against @bufbuild/connect-express (h1)",
-      "@bufbuild/connect-node (gRPC-web, JSON, http, gzip) against @bufbuild/connect-fastify (h2c)",
-      "@bufbuild/connect-node (gRPC-web, JSON, http, gzip) against @bufbuild/connect-node (h1)",
-      "@bufbuild/connect-node (gRPC-web, JSON, http) against @bufbuild/connect-node (h1)",
-      "@bufbuild/connect-node (gRPC-web, JSON, http2, gzip) against @bufbuild/connect-node (h2c)",
-      "@bufbuild/connect-node (gRPC-web, JSON, http2) against @bufbuild/connect-node (h2c)",
-      "@bufbuild/connect-node (gRPC-web, JSON, https) against @bufbuild/connect-node (h1 + tls)",
-      "@bufbuild/connect-node (gRPC, binary, http, gzip) against @bufbuild/connect-express (h1)",
-      "@bufbuild/connect-node (gRPC, binary, http, gzip) against @bufbuild/connect-fastify (h2c)",
-      "@bufbuild/connect-node (gRPC, binary, http, gzip) against @bufbuild/connect-node (h1)",
-      "@bufbuild/connect-node (gRPC, binary, http) against @bufbuild/connect-node (h1)",
-      "@bufbuild/connect-node (gRPC, binary, http2, gzip) against @bufbuild/connect-node (h2c)",
-      "@bufbuild/connect-node (gRPC, binary, http2) against @bufbuild/connect-node (h2)",
-      "@bufbuild/connect-node (gRPC, binary, http2) against @bufbuild/connect-node (h2c)",
-      "@bufbuild/connect-node (gRPC, binary, https) against @bufbuild/connect-node (h1 + tls)",
-      "@bufbuild/connect-node (gRPC, JSON, http, gzip) against @bufbuild/connect-express (h1)",
-      "@bufbuild/connect-node (gRPC, JSON, http, gzip) against @bufbuild/connect-fastify (h2c)",
-      "@bufbuild/connect-node (gRPC, JSON, http, gzip) against @bufbuild/connect-node (h1)",
-      "@bufbuild/connect-node (gRPC, JSON, http) against @bufbuild/connect-node (h1)",
-      "@bufbuild/connect-node (gRPC, JSON, http2, gzip) against @bufbuild/connect-node (h2c)",
-      "@bufbuild/connect-node (gRPC, JSON, http2) against @bufbuild/connect-node (h2c)",
-      "@bufbuild/connect-node (gRPC, JSON, https) against @bufbuild/connect-node (h1 + tls)",
-    ],
-    (transportFactory) => {
-      const request = new SimpleRequest({
-        responseSize: 1024,
-        payload: {
-          body: new Uint8Array(1024).fill(0),
-        },
-      });
-      it("with promise client", async function () {
-        const transport = transportFactory({ useHttpGet: true });
-        const client = createPromiseClient(TestService, transport);
-        const response = await client.cacheableUnaryCall(request, {
-          onHeader: ensureGetRequest,
-        });
-        expect(response.payload).toBeDefined();
-        expect(response.payload?.body.length).toEqual(request.responseSize);
+  servers.describeTransports((transportFactory) => {
+    const request = new SimpleRequest({
+      responseSize: 1024,
+      payload: {
+        body: new Uint8Array(1024).fill(0),
+      },
+    });
+    it("with promise client", async function () {
+      const transport = transportFactory({ useHttpGet: true });
+      const client = createPromiseClient(TestService, transport);
+      const response = await client.cacheableUnaryCall(request, {
+        onHeader: ensureGetRequest,
       });
-      it("with callback client", function (done) {
-        const transport = transportFactory({ useHttpGet: true });
-        const client = createCallbackClient(TestService, transport);
-        client.cacheableUnaryCall(
-          request,
-          (err, response) => {
-            expect(err).toBeUndefined();
-            expect(response.payload).toBeDefined();
-            expect(response.payload?.body.length).toEqual(request.responseSize);
-            done();
-          },
-          { onHeader: ensureGetRequest }
-        );
-      });
-    }
-  );
+      expect(response.payload).toBeDefined();
+      expect(response.payload?.body.length).toEqual(request.responseSize);
+    });
+    it("with callback client", function (done) {
+      const transport = transportFactory({ useHttpGet: true });
+      const client = createCallbackClient(TestService, transport);
+      client.cacheableUnaryCall(
+        request,
+        (err, response) => {
+          expect(err).toBeUndefined();
+          expect(response.payload).toBeDefined();
+          expect(response.payload?.body.length).toEqual(request.responseSize);
+          done();
+        },
+        { onHeader: ensureGetRequest }
+      );
+    });
+  });
 
   afterAll(async () => await servers.stop());
 });

packages/connect-node-test/src/extra/protocol-name.spec.ts

@@ -0,0 +1,87 @@
+// Copyright 2021-2023 Buf Technologies, Inc.
+//
+// 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.
+
+import { createCallbackClient, createPromiseClient } from "@bufbuild/connect";
+import type { Transport } from "@bufbuild/connect";
+import { TestService } from "../gen/grpc/testing/test_connect.js";
+import { SimpleRequest } from "../gen/grpc/testing/messages_pb.js";
+import { createTestServers } from "../helpers/testserver.js";
+
+function ensureProtocolName(expectedName: string) {
+  return (header: Headers) => {
+    expect(header.get("request-protocol")).toEqual(expectedName);
+  };
+}
+
+function testForProtocol(expectedProtocolName: string) {
+  return (transportFactory: () => Transport) => {
+    const request = new SimpleRequest({
+      responseSize: 1024,
+      payload: {
+        body: new Uint8Array(1024).fill(0),
+      },
+    });
+    it("with promise client", async function () {
+      const transport = transportFactory();
+      const client = createPromiseClient(TestService, transport);
+      const response = await client.unaryCall(request, {
+        onHeader: ensureProtocolName(expectedProtocolName),
+      });
+      expect(response.payload).toBeDefined();
+      expect(response.payload?.body.length).toEqual(request.responseSize);
+    });
+    it("with callback client", function (done) {
+      const transport = transportFactory();
+      const client = createCallbackClient(TestService, transport);
+      client.unaryCall(
+        request,
+        (err, response) => {
+          expect(err).toBeUndefined();
+          expect(response.payload).toBeDefined();
+          expect(response.payload?.body.length).toEqual(request.responseSize);
+          done();
+        },
+        { onHeader: ensureProtocolName(expectedProtocolName) }
+      );
+    });
+  };
+}
+
+describe("protocolName", function () {
+  const servers = createTestServers();
+  beforeAll(async () => await servers.start());
+
+  servers.describeTransportsOnly(
+    [
+      "@bufbuild/connect-node (gRPC, binary, http2) against @bufbuild/connect-node (h2)",
+    ],
+    testForProtocol("grpc")
+  );
+
+  servers.describeTransportsOnly(
+    [
+      "@bufbuild/connect-node (gRPC-web, binary, http2) against @bufbuild/connect-node (h2c)",
+    ],
+    testForProtocol("grpc-web")
+  );
+
+  servers.describeTransportsOnly(
+    [
+      "@bufbuild/connect-node (Connect, binary, http2, gzip) against @bufbuild/connect-node (h2c)",
+    ],
+    testForProtocol("connect")
+  );
+
+  afterAll(async () => await servers.stop());
+});

packages/connect-node-test/src/helpers/test-routes.ts

@@ -42,6 +42,7 @@ const testService: ServiceImpl<typeof TestService> = {
       context.responseHeader,
       context.responseTrailer
     );
+    context.responseHeader.set("request-protocol", context.protocolName);
     maybeRaiseError(request.responseStatus);
     return {
       payload: interop.makeServerPayload(
@@ -57,8 +58,11 @@ const testService: ServiceImpl<typeof TestService> = {
     ]);
   },
 
-  cacheableUnaryCall(/*request*/) {
-    throw new ConnectError("TODO", Code.Unimplemented);
+  cacheableUnaryCall(request, context) {
+    if (context.requestMethod == "GET") {
+      context.responseHeader.set("get-request", "true");
+    }
+    return this.unaryCall(request, context);
   },
 
   async *streamingOutputCall(request, context) {

packages/connect-node/src/connect-node-adapter.ts

@@ -83,7 +83,8 @@ export function connectNodeAdapter(
     req: NodeServerRequest,
     res: NodeServerResponse
   ): void {
-    const uHandler = paths.get(req.url ?? "");
+    // Strip the query parameter when matching paths.
+    const uHandler = paths.get(req.url?.split("?", 2)[0] ?? "");
     if (!uHandler) {
       (options.fallback ?? fallback)(req, res);
       return;

packages/connect-web-test/src/crosstest/cacheable_unary.spec.ts

@@ -14,7 +14,7 @@
 
 import { createCallbackClient, createPromiseClient } from "@bufbuild/connect";
 import { TestService } from "../gen/grpc/testing/test_connect.js";
-import { describeTransportsExcluding } from "../helpers/crosstestserver.js";
+import { describeTransports } from "../helpers/crosstestserver.js";
 import { SimpleRequest } from "../gen/grpc/testing/messages_pb.js";
 
 function ensureGetRequest(header: Headers) {
@@ -25,44 +25,35 @@ function ensureGetRequest(header: Headers) {
 }
 
 describe("cacheable_unary", function () {
-  describeTransportsExcluding(
-    // connect-node servers currently do not support HTTP GET.
-    [
-      "@bufbuild/connect-web (gRPC-web, binary) gRPC-web against @bufbuild/connect-node (h1)",
-      "@bufbuild/connect-web (gRPC-web, JSON) gRPC-web against @bufbuild/connect-node (h1)",
-      "@bufbuild/connect-web (Connect, binary) against @bufbuild/connect-node (h1)",
-      "@bufbuild/connect-web (Connect, JSON) against @bufbuild/connect-node (h1)",
-    ],
-    (transportFactory) => {
-      const request = new SimpleRequest({
-        responseSize: 1,
-        payload: {
-          body: new Uint8Array(1).fill(0),
-        },
-      });
-      it("with promise client", async function () {
-        const transport = transportFactory({ useHttpGet: true });
-        const client = createPromiseClient(TestService, transport);
-        const response = await client.cacheableUnaryCall(request, {
-          onHeader: ensureGetRequest,
-        });
-        expect(response.payload).toBeDefined();
-        expect(response.payload?.body.length).toEqual(request.responseSize);
+  describeTransports((transportFactory) => {
+    const request = new SimpleRequest({
+      responseSize: 1,
+      payload: {
+        body: new Uint8Array(1).fill(0),
+      },
+    });
+    it("with promise client", async function () {
+      const transport = transportFactory({ useHttpGet: true });
+      const client = createPromiseClient(TestService, transport);
+      const response = await client.cacheableUnaryCall(request, {
+        onHeader: ensureGetRequest,
       });
-      it("with callback client", function (done) {
-        const transport = transportFactory({ useHttpGet: true });
-        const client = createCallbackClient(TestService, transport);
-        client.cacheableUnaryCall(
-          request,
-          (err, response) => {
-            expect(err).toBeUndefined();
-            expect(response.payload).toBeDefined();
-            expect(response.payload?.body.length).toEqual(request.responseSize);
-            done();
-          },
-          { onHeader: ensureGetRequest }
-        );
-      });
-    }
-  );
+      expect(response.payload).toBeDefined();
+      expect(response.payload?.body.length).toEqual(request.responseSize);
+    });
+    it("with callback client", function (done) {
+      const transport = transportFactory({ useHttpGet: true });
+      const client = createCallbackClient(TestService, transport);
+      client.cacheableUnaryCall(
+        request,
+        (err, response) => {
+          expect(err).toBeUndefined();
+          expect(response.payload).toBeDefined();
+          expect(response.payload?.body.length).toEqual(request.responseSize);
+          done();
+        },
+        { onHeader: ensureGetRequest }
+      );
+    });
+  });
 });

packages/connect/src/implementation.ts

@@ -78,6 +78,12 @@ export interface HandlerContext {
    */
   readonly signal: AbortSignal;
 
+  /**
+   * HTTP method of incoming request, usually "POST", but "GET" in the case of
+   * Connect Get.
+   */
+  readonly requestMethod: string;
+
   /**
    * Incoming request headers.
    */
@@ -95,6 +101,11 @@ export interface HandlerContext {
    * Outgoing response trailers.
    */
   readonly responseTrailer: Headers;
+
+  /**
+   * Name of the RPC protocol in use; one of "connect", "grpc" or "grpc-web".
+   */
+  readonly protocolName: string;
 }
 
 /**
@@ -104,17 +115,21 @@ export function createHandlerContext(
   spec: { service: ServiceType; method: MethodInfo },
   deadline: AbortSignal | undefined, // TODO
   signal: AbortSignal,
+  requestMethod: string,
   requestHeader: HeadersInit,
   responseHeader: HeadersInit,
-  responseTrailer: HeadersInit
+  responseTrailer: HeadersInit,
+  protocolName: string
 ): HandlerContext {
   return {
     method: spec.method,
     service: spec.service,
     signal: createLinkedAbortController(deadline, signal).signal,
+    requestMethod,
     requestHeader: new Headers(requestHeader),
     responseHeader: new Headers(responseHeader),
     responseTrailer: new Headers(responseTrailer),
+    protocolName,
   };
 }