@kiyasov/platform-hono 1.0.0 → 1.0.2

package/index.ts

@@ -1,2 +1,3 @@
 export * from "./src/adapters";
 export * from "./src/interfaces";
+export * from "./src/drivers";

package/package.json

@@ -1,22 +1,32 @@
 {
   "name": "@kiyasov/platform-hono",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Nest adapter for Hono",
   "author": "Islam Kiiasov",
   "license": "MIT",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "exports": {
+    ".": {
+      "require": "./dist/cjs/index.js",
+      "import": "./dist/esm/index.js"
+    }
+  },
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
+    "@hono/graphql-server": "^0.4.3",
     "@hono/node-server": "^1.11.2",
     "hono": "^4.4.3"
   },
   "devDependencies": {
+    "@apollo/server": "^4.10.4",
+    "@nestjs/apollo": "^12.1.0",
     "@nestjs/cli": "^10.3.2",
     "@nestjs/common": "^10.3.8",
     "@nestjs/core": "^10.3.8",
+    "@nestjs/graphql": "^12.1.1",
     "@swc/cli": "^0.3.12",
     "@swc/core": "^1.5.24",
     "reflect-metadata": "^0.2.2",

package/src/adapters/hono-adapter.ts

@@ -0,0 +1,293 @@
+import { Server } from "node:net";
+import { HttpBindings, createAdaptorServer } from "@hono/node-server";
+import { RESPONSE_ALREADY_SENT } from "@hono/node-server/utils/response";
+import { RequestMethod } from "@nestjs/common";
+import { HttpStatus, Logger } from "@nestjs/common";
+import { bodyLimit } from "hono/body-limit";
+import {
+  ErrorHandler,
+  NestApplicationOptions,
+  RequestHandler,
+} from "@nestjs/common/interfaces";
+import {
+  ServeStaticOptions,
+  serveStatic,
+} from "@hono/node-server/serve-static";
+import { AbstractHttpAdapter } from "@nestjs/core/adapters/http-adapter";
+import { Context, HonoRequest, Next } from "hono";
+import { Hono } from "hono";
+import { cors } from "hono/cors";
+import { RedirectStatusCode, StatusCode } from "hono/utils/http-status";
+import * as http from "http";
+import { Http2SecureServer, Http2Server } from "http2";
+import * as https from "https";
+import { TypeBodyParser } from "../interfaces";
+
+type HonoHandler = RequestHandler<HonoRequest, Context>;
+
+type ServerType = Server | Http2Server | Http2SecureServer;
+
+/**
+ * Adapter for using Hono with NestJS.
+ */
+export class HonoAdapter extends AbstractHttpAdapter<
+  ServerType,
+  HonoRequest,
+  Context
+> {
+  protected readonly instance: Hono<{ Bindings: HttpBindings }>;
+
+  constructor() {
+    super(new Hono());
+  }
+
+  private getRouteAndHandler(
+    pathOrHandler: string | HonoHandler,
+    handler?: HonoHandler
+  ): [string, HonoHandler] {
+    let path = typeof pathOrHandler === "function" ? "" : pathOrHandler;
+    handler = typeof pathOrHandler === "function" ? pathOrHandler : handler;
+    return [path, handler];
+  }
+
+  private createRouteHandler(routeHandler: HonoHandler) {
+    return async (ctx: Context, next: Next) => {
+      await routeHandler(ctx.req, ctx, next);
+      return this.send(ctx);
+    };
+  }
+
+  private send(ctx: Context) {
+    const body = ctx.get("body");
+    return typeof body === "string" ? ctx.text(body) : ctx.json(body);
+  }
+
+  public get(pathOrHandler: string | HonoHandler, handler?: HonoHandler) {
+    const [routePath, routeHandler] = this.getRouteAndHandler(
+      pathOrHandler,
+      handler
+    );
+    this.instance.get(routePath, this.createRouteHandler(routeHandler));
+  }
+
+  public post(pathOrHandler: string | HonoHandler, handler?: HonoHandler) {
+    const [routePath, routeHandler] = this.getRouteAndHandler(
+      pathOrHandler,
+      handler
+    );
+    this.instance.post(routePath, this.createRouteHandler(routeHandler));
+  }
+
+  public put(pathOrHandler: string | HonoHandler, handler?: HonoHandler) {
+    const [routePath, routeHandler] = this.getRouteAndHandler(
+      pathOrHandler,
+      handler
+    );
+    this.instance.put(routePath, this.createRouteHandler(routeHandler));
+  }
+
+  public delete(pathOrHandler: string | HonoHandler, handler?: HonoHandler) {
+    const [routePath, routeHandler] = this.getRouteAndHandler(
+      pathOrHandler,
+      handler
+    );
+    this.instance.delete(routePath, this.createRouteHandler(routeHandler));
+  }
+
+  public use(pathOrHandler: string | HonoHandler, handler?: HonoHandler) {
+    const [routePath, routeHandler] = this.getRouteAndHandler(
+      pathOrHandler,
+      handler
+    );
+    this.instance.use(routePath, this.createRouteHandler(routeHandler));
+  }
+
+  public patch(pathOrHandler: string | HonoHandler, handler?: HonoHandler) {
+    const [routePath, routeHandler] = this.getRouteAndHandler(
+      pathOrHandler,
+      handler
+    );
+    this.instance.patch(routePath, this.createRouteHandler(routeHandler));
+  }
+
+  public options(pathOrHandler: string | HonoHandler, handler?: HonoHandler) {
+    const [routePath, routeHandler] = this.getRouteAndHandler(
+      pathOrHandler,
+      handler
+    );
+    this.instance.options(routePath, this.createRouteHandler(routeHandler));
+  }
+
+  public async reply(ctx: Context, body: any, statusCode?: StatusCode) {
+    if (statusCode) ctx.status(statusCode);
+    const responseContentType = this.getHeader(ctx, "Content-Type");
+    if (
+      !responseContentType?.startsWith("application/json") &&
+      body?.statusCode >= HttpStatus.BAD_REQUEST
+    ) {
+      Logger.warn(
+        "Content-Type doesn't match Reply body, you might need a custom ExceptionFilter for non-JSON responses"
+      );
+      this.setHeader(ctx, "Content-Type", "application/json");
+    }
+    ctx.set("body", body);
+  }
+
+  public status(ctx: Context, statusCode: StatusCode) {
+    ctx.status(statusCode);
+  }
+
+  public async end() {
+    return RESPONSE_ALREADY_SENT;
+  }
+
+  public render(response: any, view: string, options: any) {
+    throw new Error("Method not implemented.");
+  }
+
+  public redirect(ctx: Context, statusCode: RedirectStatusCode, url: string) {
+    ctx.redirect(url, statusCode);
+  }
+
+  public setErrorHandler(handler: ErrorHandler) {
+    this.instance.onError(async (err: Error, ctx: Context) => {
+      await handler(err, ctx.req, ctx);
+      return this.send(ctx);
+    });
+  }
+
+  public setNotFoundHandler(handler: RequestHandler) {
+    this.instance.notFound(async (ctx: Context) => {
+      await handler(ctx.req, ctx);
+      return this.send(ctx);
+    });
+  }
+
+  public useStaticAssets(path: string, options: ServeStaticOptions) {
+    Logger.log("Registering static assets middleware");
+    this.instance.use(path, serveStatic(options));
+  }
+
+  public setViewEngine(options: any | string) {
+    throw new Error("Method not implemented.");
+  }
+
+  public isHeadersSent(ctx: Context): boolean {
+    return true;
+  }
+
+  public getHeader?(ctx: Context, name: string) {
+    return ctx.req.header(name);
+  }
+
+  public setHeader(ctx: Context, name: string, value: string) {
+    ctx.header(name, value);
+  }
+
+  public appendHeader?(ctx: Context, name: string, value: string) {
+    ctx.res.headers.append(name, value);
+  }
+
+  public getRequestHostname(ctx: Context): string {
+    return ctx.req.header().host;
+  }
+
+  public getRequestMethod(request: HonoRequest): string {
+    return request.method;
+  }
+
+  public getRequestUrl(request: HonoRequest): string {
+    return request.url;
+  }
+
+  public enableCors(options: any) {
+    this.instance.use(cors(options));
+  }
+
+  public useBodyParser(type: TypeBodyParser, bodyLimit: number = 1e6) {
+    Logger.log("Registering body parser middleware");
+    this.instance.use(this.bodyLimit(bodyLimit), async (ctx, next) => {
+      const contentType = ctx.req.header("content-type");
+      switch (type) {
+        case "application/json":
+          if (contentType === "application/json")
+            (ctx.req as any).body = await ctx.req.json();
+          break;
+        case "text/plain":
+          if (contentType === "text/plain") {
+            (ctx.req as any).rawBody = Buffer.from(await ctx.req.text());
+            (ctx.req as any).body = await ctx.req.json();
+          }
+          break;
+        default:
+          (ctx.req as any).body = await ctx.req.parseBody({ all: true });
+          break;
+      }
+      await next();
+    });
+  }
+
+  public close(): Promise<void> {
+    return new Promise((resolve) => this.httpServer.close(() => resolve()));
+  }
+
+  public initHttpServer(options: NestApplicationOptions) {
+    const isHttpsEnabled = options?.httpsOptions;
+    const createServer = isHttpsEnabled
+      ? https.createServer
+      : http.createServer;
+    this.httpServer = createAdaptorServer({
+      fetch: this.instance.fetch,
+      createServer,
+      overrideGlobalObjects: false,
+    });
+  }
+
+  public getType(): string {
+    return "hono";
+  }
+
+  public registerParserMiddleware(prefix?: string, rawBody?: boolean) {
+    Logger.log("Registering parser middleware");
+    this.useBodyParser("application/x-www-form-urlencoded");
+    this.useBodyParser("application/json");
+    this.useBodyParser("text/plain");
+  }
+
+  public async createMiddlewareFactory(requestMethod: RequestMethod) {
+    return (path: string, callback: Function) => {
+      const routeMethodsMap = {
+        [RequestMethod.ALL]: this.instance.all,
+        [RequestMethod.DELETE]: this.instance.delete,
+        [RequestMethod.GET]: this.instance.get,
+        [RequestMethod.OPTIONS]: this.instance.options,
+        [RequestMethod.PATCH]: this.instance.patch,
+        [RequestMethod.POST]: this.instance.post,
+        [RequestMethod.PUT]: this.instance.put,
+      };
+      const routeMethod = (
+        routeMethodsMap[requestMethod] || this.instance.get
+      ).bind(this.instance);
+      routeMethod(path, async (ctx: Context, next: Function) => {
+        await callback(ctx.req, ctx, next);
+      });
+    };
+  }
+
+  public applyVersionFilter(): () => () => any {
+    throw new Error("Versioning not yet supported in Hono");
+  }
+
+  public listen(port: string | number, ...args: any[]): ServerType {
+    return this.httpServer.listen(port, ...args);
+  }
+
+  public bodyLimit(maxSize: number) {
+    return bodyLimit({
+      maxSize,
+      onError: () => {
+        throw new Error("Body too large");
+      },
+    });
+  }
+}

package/src/adapters/index.ts

@@ -0,0 +1 @@
+export * from "./hono-adapter";

package/src/drivers/graphql.driver.ts

@@ -0,0 +1,126 @@
+import { ApolloServer, BaseContext, HeaderMap } from '@apollo/server';
+import { AbstractGraphQLDriver } from '@nestjs/graphql';
+import { ApolloServerPluginDrainHttpServer } from '@apollo/server/plugin/drainHttpServer';
+import { ApolloDriverConfig } from '@nestjs/apollo';
+import { Context, HonoRequest } from 'hono';
+import { StatusCode } from 'hono/utils/http-status';
+import { Logger } from '@nestjs/common';
+
+export class HonoGraphQLDriver<
+  T extends Record<string, any> = ApolloDriverConfig,
+> extends AbstractGraphQLDriver {
+  protected apolloServer: ApolloServer<BaseContext>;
+
+  get instance(): ApolloServer<BaseContext> {
+    return this.apolloServer;
+  }
+
+  async start(options: T): Promise<void> {
+    const { httpAdapter } = this.httpAdapterHost;
+    const platformName = httpAdapter.getType();
+
+    if (platformName !== 'hono') {
+      throw new Error('This driver is only compatible with the Hono platform');
+    }
+
+    return this.registerHono(options);
+  }
+
+  protected async registerHono(
+    options: T,
+    { preStartHook }: { preStartHook?: () => void } = {},
+  ) {
+    const { path, typeDefs, resolvers, schema } = options;
+    const { httpAdapter } = this.httpAdapterHost;
+    const app = httpAdapter.getInstance();
+    const drainHttpServerPlugin = ApolloServerPluginDrainHttpServer({
+      httpServer: httpAdapter.getHttpServer(),
+    });
+
+    preStartHook?.();
+
+    const server = new ApolloServer({
+      typeDefs,
+      resolvers,
+      schema,
+      ...options,
+      plugins: (options.plugins || []).concat(drainHttpServerPlugin),
+    });
+
+    await server.start();
+
+    app.use(path, async (ctx: Context) => {
+      const bodyData = await this.parseBody(ctx.req);
+
+      const httpGraphQLResponse = await server.executeHTTPGraphQLRequest({
+        httpGraphQLRequest: {
+          body: bodyData,
+          method: ctx.req.method,
+          headers: this.httpHeadersToMap(ctx.req.raw.headers),
+          search: new URL(ctx.req.url).search,
+        },
+        context: options?.context ?? (() => Promise.resolve({} as BaseContext)),
+      });
+
+      const { headers, body, status } = httpGraphQLResponse;
+
+      for (const [headerKey, headerValue] of headers) {
+        ctx.header(headerKey, headerValue);
+      }
+
+      ctx.status(status === undefined ? 200 : (status as StatusCode));
+
+      if (body.kind === 'complete') {
+        return ctx.body(body.string);
+      }
+
+      const readableStream = new ReadableStream({
+        async start(controller) {
+          for await (const chunk of body.asyncIterator) {
+            controller.enqueue(new TextEncoder().encode(chunk));
+          }
+          controller.close();
+        },
+      });
+
+      return new Response(readableStream, {
+        headers: { 'Content-Type': 'application/octet-stream' },
+      });
+    });
+
+    this.apolloServer = server;
+  }
+
+  public stop() {
+    return this.apolloServer?.stop();
+  }
+
+  private httpHeadersToMap(headers: Headers) {
+    const map = new HeaderMap();
+    headers.forEach((value, key) => map.set(key, value));
+    return map;
+  }
+
+  private async parseBody(req: HonoRequest): Promise<Record<string, unknown>> {
+    const contentType = req.header('content-type');
+    if (contentType === 'application/graphql')
+      return { query: await req.text() };
+    if (contentType === 'application/json')
+      return req.json().catch(this.logError);
+    if (contentType === 'application/x-www-form-urlencoded')
+      return this.parseFormURL(req);
+    return {};
+  }
+
+  private logError(e: unknown): void {
+    if (e instanceof Error) {
+      Logger.error(e.stack || e.message);
+    }
+    throw new Error(`POST body sent invalid JSON: ${e}`);
+  }
+
+  private async parseFormURL(req: HonoRequest) {
+    const searchParams = new URLSearchParams(await req.text());
+    return Object.fromEntries(searchParams.entries());
+  }
+}

package/src/drivers/index.ts

@@ -0,0 +1 @@
+export * from "./graphql.driver";

package/src/interfaces/index.ts

@@ -0,0 +1 @@
+export * from './nest-hono-application.interface';

package/src/interfaces/nest-hono-application.interface.ts

@@ -0,0 +1,72 @@
+import { ServeStaticOptions } from "@hono/node-server/serve-static";
+import { HttpServer, INestApplication } from "@nestjs/common";
+import { Context, Hono, MiddlewareHandler } from "hono";
+
+export type TypeBodyParser =
+  | "application/json"
+  | "text/plain"
+  | "application/x-www-form-urlencoded";
+
+interface HonoViewOptions {
+  engine: string;
+  templates: string;
+}
+
+/**
+ * @publicApi
+ */
+export interface NestHonoApplication<TServer extends Hono = Hono>
+  extends INestApplication<TServer> {
+  /**
+   * Returns the underlying HTTP adapter bounded to a Hono app.
+   *
+   * @returns {HttpServer}
+   */
+  getHttpAdapter(): HttpServer<Context, MiddlewareHandler, Hono>;
+
+  /**
+   * Register Hono body parsers on the fly.
+   *
+   * @example
+   * // enable the json parser with a parser limit of 50mb
+   * app.useBodyParser('application/json', 50 * 1024 * 1024);
+   *
+   * @returns {this}
+   */
+  useBodyParser(type: TypeBodyParser, bodyLimit?: number): this;
+
+  /**
+   * Sets a base directory for public assets.
+   * Example `app.useStaticAssets('public', { root: '/' })`
+   * @returns {this}
+   */
+  useStaticAssets(path: string, options: ServeStaticOptions): this;
+
+  /**
+   * Sets a view engine for templates (views), for example: `pug`, `handlebars`, or `ejs`.
+   *
+   * Don't pass in a string. The string type in the argument is for compatibility reason and will cause an exception.
+   * @returns {this}
+   */
+  setViewEngine(options: HonoViewOptions | string): this;
+
+  /**
+   * Starts the application.
+   * @returns A Promise that, when resolved, is a reference to the underlying HttpServer.
+   */
+  listen(
+    port: number | string,
+    callback?: (err: Error, address: string) => void
+  ): Promise<TServer>;
+  listen(
+    port: number | string,
+    address: string,
+    callback?: (err: Error, address: string) => void
+  ): Promise<TServer>;
+  listen(
+    port: number | string,
+    address: string,
+    backlog: number,
+    callback?: (err: Error, address: string) => void
+  ): Promise<TServer>;
+}