Initital Hono grafserv adapter

grafast/grafserv/__tests__/hono-adapter.test.ts

@@ -0,0 +1,184 @@
+/* eslint-disable graphile-export/export-methods */
+import type { ServerType } from "@hono/node-server";
+import { serve } from "@hono/node-server";
+import { createNodeWebSocket } from "@hono/node-ws";
+import { error } from "console";
+import { constant, makeGrafastSchema } from "grafast";
+import { serverAudits } from "graphql-http";
+import { createClient } from "graphql-ws";
+import { Hono } from "hono";
+import { WebSocket } from "ws";
+
+import type { GrafservConfig } from "../src/interfaces.js";
+import { grafserv } from "../src/servers/hono/v4/index.js";
+
+const PORT = 7777;
+
+const schema = makeGrafastSchema({
+  typeDefs: /* GraphQL */ `
+    type Query {
+      hello: String!
+      throwAnError: String
+    }
+
+    type Subscription {
+      subscriptionTest: String!
+    }
+  `,
+  plans: {
+    Query: {
+      hello() {
+        return constant("world");
+      },
+      throwAnError() {
+        return error(new Error("You asked for an error... Here it is."));
+      },
+    },
+    Subscription: {
+      subscriptionTest: {
+        subscribe: async function* () {
+          yield { subscriptionTest: "test1" };
+          yield { subscriptionTest: "test2" };
+        },
+      },
+    },
+  },
+});
+
+describe("Hono Adapter", () => {
+  let server: ServerType | null = null;
+  beforeEach(() => {
+    // setup test server
+    const app = new Hono();
+    const config: GrafservConfig = {
+      schema, // Mock schema for testing
+      preset: {
+        grafserv: {
+          graphqlOverGET: true,
+          graphqlPath: "/graphql",
+          dangerouslyAllowAllCORSRequests: true,
+        },
+      },
+    };
+    const honoGrafserv = grafserv(config);
+    honoGrafserv.addTo(app);
+
+    server = serve({
+      fetch: app.fetch,
+      port: PORT,
+    });
+  });
+
+  afterEach(() => {
+    server?.close();
+    server = null;
+  });
+
+  const url = `http://0.0.0.0:${PORT}/graphql`;
+
+  it("SHOULD work for a simple request", async () => {
+    const res = await fetch(url, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        Accept: "application/json",
+      },
+      body: JSON.stringify({ query: "{ __typename }" }),
+    });
+
+    const responseBody = await res.json();
+    expect(responseBody.data).toEqual({
+      __typename: "Query",
+    });
+  });
+
+  // run standard audits
+  const audits = serverAudits({
+    url,
+    fetchFn: fetch,
+  });
+  for (const audit of audits) {
+    it(audit.name, async () => {
+      const result = await audit.fn();
+      if (audit.name.startsWith("MUST") || result.status === "ok") {
+        expect({
+          ...result,
+          response: "<omitted for brevity>",
+        }).toEqual(
+          expect.objectContaining({
+            status: "ok",
+          }),
+        );
+      } else {
+        console.warn(`Allowing failed test: ${audit.name}`);
+      }
+    });
+  }
+});
+
+describe("Hono Adapter with websockets", () => {
+  let server: ServerType | null = null;
+  let app!: Hono;
+  beforeEach(() => {
+    // setup test server
+    app = new Hono();
+    const config: GrafservConfig = {
+      schema, // Mock schema for testing
+      preset: {
+        grafserv: {
+          graphqlOverGET: true,
+          websockets: true,
+        },
+      },
+    };
+    const { injectWebSocket, upgradeWebSocket } = createNodeWebSocket({ app });
+
+    const honoGrafserv = grafserv(config, upgradeWebSocket);
+    honoGrafserv.addTo(app);
+
+    server = serve({
+      fetch: app.fetch,
+      port: PORT,
+    });
+    injectWebSocket(server);
+  });
+
+  afterEach(() => {
+    server?.close();
+    server = null;
+  });
+
+  const url = `ws://0.0.0.0:${PORT}/graphql`;
+
+  it("SHOULD work for a simple subscription", async () => {
+    // make a graphql subscription
+    const client = createClient({
+      url,
+      webSocketImpl: WebSocket,
+    });
+
+    const query = client.iterate({
+      query: "subscription { subscriptionTest }",
+    });
+
+    const { value } = await query.next();
+    expect(value).toEqual({ data: { subscriptionTest: "test1" } });
+    const { value: value2 } = await query.next();
+    expect(value2).toEqual({ data: { subscriptionTest: "test2" } });
+  });
+
+  it("SHOULD throw an error is websocket is enabled but no upgradeWebSocket was provided", async () => {
+    const config: GrafservConfig = {
+      schema, // Mock schema for testing
+      preset: {
+        grafserv: {
+          websockets: true,
+        },
+      },
+    };
+    const honoGrafserv = grafserv(config);
+    expect(async () => {
+      await honoGrafserv.addTo(app);
+    }).rejects.toThrow();
+  });
+});

grafast/grafserv/examples/example-hono.mjs

@@ -0,0 +1,23 @@
+import { serve } from "@hono/node-server";
+import { grafserv } from "grafserv/hono";
+import { Hono } from "hono";
+
+import preset from "./graphile.config.mjs";
+import schema from "./schema.mjs";
+
+// Create a Node HTTP server
+const app = new Hono();
+
+// Create a Grafserv instance
+// the second argument is an optional websocket upgrade handler
+// see https://hono.dev/docs/helpers/websocket
+const serv = grafserv({ schema, preset });
+
+// Mount the request handler into a new HTTP server
+serv.addTo(app).catch((e) => {
+  console.error(e);
+  process.exit(1);
+});
+
+// Start the server with the chosen Hono adapter - here Node.js
+serve(app);

grafast/grafserv/package.json

@@ -38,6 +38,10 @@
       "types": "./dist/servers/h3/v1/index.d.ts",
       "default": "./dist/servers/h3/v1/index.js"
     },
+    "./hono/v4": {
+      "types": "./dist/servers/hono/v4/index.d.ts",
+      "default": "./dist/servers/hono/v4/index.js"
+    },
     "./ruru": {
       "types": "./fwd/ruru/index.d.ts",
       "node": "./fwd/ruru/index.js",
@@ -94,6 +98,7 @@
     "graphile-config": "workspace:^",
     "graphql": "^16.1.0-experimental-stream-defer.6",
     "h3": "^1.13.0",
+    "hono": "^4.6.15",
     "ws": "^8.12.1"
   },
   "peerDependenciesMeta": {
@@ -103,13 +108,17 @@
     "h3": {
       "optional": true
     },
+    "hono": {
+      "optional": true
+    },
     "ws": {
       "optional": true
     }
   },
   "devDependencies": {
     "@envelop/core": "^5.0.0",
     "@fastify/websocket": "^8.2.0",
+    "@hono/node-server": "^1.13.7",
     "@types/aws-lambda": "^8.10.123",
     "@types/express": "^4.17.17",
     "@types/koa": "^2.13.8",
@@ -120,13 +129,15 @@
     "grafast": "workspace:^",
     "graphql-http": "^1.22.0",
     "h3": "^1.13.0",
+    "hono": "^4.6.15",
     "jest": "^29.6.4",
     "jest-serializer-graphql-schema": "workspace:^",
     "koa": "^2.15.4",
     "koa-bodyparser": "^4.4.1",
     "nodemon": "^3.0.1",
     "ts-node": "^10.9.1",
-    "typescript": "^5.2.2"
+    "typescript": "^5.2.2",
+    "ws": "^8.12.1"
   },
   "files": [
     "dist",