feat: pass context to onNotFound callback in serveStatic

deno_dist/adapter/deno/serve-static.ts

@@ -1,23 +1,25 @@
 import type { Context } from '../../context.ts'
-import type { Next } from '../../types.ts'
+import type { Env, MiddlewareHandler } from '../../types.ts'
 import { getFilePath } from '../../utils/filepath.ts'
 import { getMimeType } from '../../utils/mime.ts'
 
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
 const { open } = Deno
 
-export type ServeStaticOptions = {
+export type ServeStaticOptions<E extends Env = Env> = {
   root?: string
   path?: string
   rewriteRequestPath?: (path: string) => string
-  onNotFound?: (path: string) => void | Promise<void>
+  onNotFound?: (path: string, c: Context<E>) => void | Promise<void>
 }
 
 const DEFAULT_DOCUMENT = 'index.html'
 
-export const serveStatic = (options: ServeStaticOptions = { root: '' }) => {
-  return async (c: Context, next: Next) => {
+export const serveStatic = <E extends Env = Env>(
+  options: ServeStaticOptions<E> = { root: '' }
+): MiddlewareHandler => {
+  return async (c, next) => {
     // Do nothing if Response is already set
     if (c.finalized) {
       await next()
@@ -53,7 +55,7 @@ export const serveStatic = (options: ServeStaticOptions = { root: '' }) => {
       return c.body(file.readable)
     }
 
-    await options.onNotFound?.(path)
+    await options.onNotFound?.(path, c)
     await next()
     return
   }

runtime_tests/bun/index.test.tsx

@@ -114,7 +114,10 @@ describe('Serve Static Middleware', () => {
     const res = await app.request(new Request('http://localhost/favicon-notfound.ico'))
     expect(res.status).toBe(404)
     expect(res.headers.get('X-Custom')).toBe('Bun')
-    expect(onNotFound).toHaveBeenCalledWith('./runtime_tests/bun/favicon-notfound.ico')
+    expect(onNotFound).toHaveBeenCalledWith(
+      './runtime_tests/bun/favicon-notfound.ico',
+      expect.anything()
+    )
   })
 
   it('Should return 200 response - /static/plain.txt', async () => {

runtime_tests/deno/middleware.test.tsx

@@ -102,9 +102,7 @@ Deno.test('Serve Static middleware', async () => {
   assertEquals(res.status, 404)
   assertMatch(res.headers.get('Content-Type') || '', /^text\/plain/)
   assertEquals(res.headers.get('X-Custom'), 'Deno')
-  assertSpyCall(onNotFound, 0, {
-    args: ['./runtime_tests/deno/favicon-notfound.ico'],
-  })
+  assertSpyCall(onNotFound, 0)
 
   res = await app.request('http://localhost/static/plain.txt')
   assertEquals(res.status, 200)

src/adapter/bun/serve-static.ts

@@ -2,24 +2,26 @@
 /* eslint-disable @typescript-eslint/ban-ts-comment */
 import { existsSync } from 'fs'
 import type { Context } from '../../context'
-import type { Next } from '../../types'
+import type { Env, MiddlewareHandler } from '../../types'
 import { getFilePath } from '../../utils/filepath'
 import { getMimeType } from '../../utils/mime'
 
 // @ts-ignore
 const { file } = Bun
 
-export type ServeStaticOptions = {
+export type ServeStaticOptions<E extends Env = Env> = {
   root?: string
   path?: string
   rewriteRequestPath?: (path: string) => string
-  onNotFound?: (path: string) => void | Promise<void>
+  onNotFound?: (path: string, c: Context<E>) => void | Promise<void>
 }
 
 const DEFAULT_DOCUMENT = 'index.html'
 
-export const serveStatic = (options: ServeStaticOptions = { root: '' }) => {
-  return async (c: Context, next: Next) => {
+export const serveStatic = <E extends Env = Env>(
+  options: ServeStaticOptions<E> = { root: '' }
+): MiddlewareHandler => {
+  return async (c, next) => {
     // Do nothing if Response is already set
     if (c.finalized) {
       await next()
@@ -50,7 +52,7 @@ export const serveStatic = (options: ServeStaticOptions = { root: '' }) => {
       }
     }
 
-    await options.onNotFound?.(path)
+    await options.onNotFound?.(path, c)
     await next()
     return
   }

src/adapter/cloudflare-workers/serve-static.test.ts

@@ -63,7 +63,7 @@ describe('ServeStatic Middleware', () => {
   it('Should return 404 response', async () => {
     const res = await app.request('http://localhost/static/not-found.html')
     expect(res.status).toBe(404)
-    expect(onNotFound).toHaveBeenCalledWith('assets/static/not-found.html')
+    expect(onNotFound).toHaveBeenCalledWith('assets/static/not-found.html', expect.anything())
   })
 
   it('Should return plan.txt', async () => {
@@ -155,3 +155,23 @@ describe('With middleware', () => {
     expect(await res.text()).toBe('bar')
   })
 })
+
+describe('Types of middleware', () => {
+  it('Should pass env type from generics of serveStatic', async () => {
+    type Env = {
+      Bindings: {
+        HOGE: string
+      }
+    }
+    const app = new Hono<Env>()
+    app.use(
+      '/static/*',
+      serveStatic<Env>({
+        root: './assets',
+        onNotFound: (_, c) => {
+          expectTypeOf(c.env).toEqualTypeOf<Env['Bindings']>()
+        },
+      })
+    )
+  })
+})

src/adapter/cloudflare-workers/serve-static.ts

@@ -1,23 +1,26 @@
 // @denoify-ignore
 import type { KVNamespace } from '@cloudflare/workers-types'
-import type { MiddlewareHandler } from '../../types'
+import type { Context } from '../../context'
+import type { Env, MiddlewareHandler } from '../../types'
 import { getFilePath } from '../../utils/filepath'
 import { getMimeType } from '../../utils/mime'
 import { getContentFromKVAsset } from './utils'
 
-export type ServeStaticOptions = {
+export type ServeStaticOptions<E extends Env = Env> = {
   root?: string
   path?: string
   manifest?: object | string
   namespace?: KVNamespace
   rewriteRequestPath?: (path: string) => string
-  onNotFound?: (path: string) => void | Promise<void>
+  onNotFound?: (path: string, c: Context<E>) => void | Promise<void>
 }
 
 const DEFAULT_DOCUMENT = 'index.html'
 
 // This middleware is available only on Cloudflare Workers.
-export const serveStatic = (options: ServeStaticOptions = { root: '' }): MiddlewareHandler => {
+export const serveStatic = <E extends Env = Env>(
+  options: ServeStaticOptions<E> = { root: '' }
+): MiddlewareHandler => {
   return async (c, next) => {
     // Do nothing if Response is already set
     if (c.finalized) {
@@ -51,7 +54,7 @@ export const serveStatic = (options: ServeStaticOptions = { root: '' }): Middlew
       return c.body(content)
     }
 
-    await options.onNotFound?.(path)
+    await options.onNotFound?.(path, c)
     await next()
     return
   }

src/adapter/cloudflare-workers/server-static-module.ts

@@ -3,11 +3,12 @@
 // @ts-ignore
 // For ES module mode
 import manifest from '__STATIC_CONTENT_MANIFEST'
+import type { Env } from '../../types'
 import type { ServeStaticOptions } from './serve-static'
 import { serveStatic } from './serve-static'
 
-const module = (options: ServeStaticOptions = { root: '' }) => {
-  return serveStatic({
+const module = <E extends Env = Env>(options: ServeStaticOptions<E> = { root: '' }) => {
+  return serveStatic<E>({
     root: options.root,
     path: options.path,
     manifest: options.manifest ? options.manifest : manifest,

src/adapter/deno/serve-static.ts

@@ -1,23 +1,25 @@
 import type { Context } from '../../context'
-import type { Next } from '../../types'
+import type { Env, MiddlewareHandler } from '../../types'
 import { getFilePath } from '../../utils/filepath'
 import { getMimeType } from '../../utils/mime'
 
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
 const { open } = Deno
 
-export type ServeStaticOptions = {
+export type ServeStaticOptions<E extends Env = Env> = {
   root?: string
   path?: string
   rewriteRequestPath?: (path: string) => string
-  onNotFound?: (path: string) => void | Promise<void>
+  onNotFound?: (path: string, c: Context<E>) => void | Promise<void>
 }
 
 const DEFAULT_DOCUMENT = 'index.html'
 
-export const serveStatic = (options: ServeStaticOptions = { root: '' }) => {
-  return async (c: Context, next: Next) => {
+export const serveStatic = <E extends Env = Env>(
+  options: ServeStaticOptions<E> = { root: '' }
+): MiddlewareHandler => {
+  return async (c, next) => {
     // Do nothing if Response is already set
     if (c.finalized) {
       await next()
@@ -53,7 +55,7 @@ export const serveStatic = (options: ServeStaticOptions = { root: '' }) => {
       return c.body(file.readable)
     }
 
-    await options.onNotFound?.(path)
+    await options.onNotFound?.(path, c)
     await next()
     return
   }