feat(serve-static): mimes option for serve-static (#2094)

* feat(serve-static): `mime` option for serve-static * undo getExtension() * add mime and serve-static tests * reaname mimes to baseMime * rename mime to mimes and add getMimeType() callback Co-Authored-By: Yusuke Wada <yusuke@kamawada.com> * update test description --------- Co-authored-by: Yusuke Wada <yusuke@kamawada.com>
honojs · Jan 29, 2024 · d74d95d · d74d95d
1 parent b24f9e3
commit d74d95d
Show file tree

Hide file tree

Showing 8 changed files with 67 additions and 8 deletions.
diff --git a/deno_dist/adapter/deno/serve-static.ts b/deno_dist/adapter/deno/serve-static.ts
@@ -10,6 +10,7 @@ const { open } = Deno
 export type ServeStaticOptions<E extends Env = Env> = {
   root?: string
   path?: string
+  mimes?: Record<string, string>
   rewriteRequestPath?: (path: string) => string
   onNotFound?: (path: string, c: Context<E>) => void | Promise<void>
 }

diff --git a/deno_dist/utils/mime.ts b/deno_dist/utils/mime.ts
@@ -1,4 +1,4 @@
-export const getMimeType = (filename: string): string | undefined => {
+export const getMimeType = (filename: string, mimes = baseMimes): string | undefined => {
   const regexp = /\.([a-zA-Z0-9]+?)$/
   const match = filename.match(regexp)
   if (!match) {
@@ -12,10 +12,10 @@ export const getMimeType = (filename: string): string | undefined => {
 }
 
 export const getExtension = (mimeType: string): string | undefined => {
-  return Object.keys(mimes).find((ext) => mimes[ext] === mimeType)
+  return Object.keys(baseMimes).find((ext) => baseMimes[ext] === mimeType)
 }
 
-const mimes: Record<string, string> = {
+const baseMimes: Record<string, string> = {
   aac: 'audio/aac',
   abw: 'application/x-abiword',
   arc: 'application/x-freearc',

diff --git a/src/adapter/bun/serve-static.ts b/src/adapter/bun/serve-static.ts
@@ -12,6 +12,7 @@ const { file } = Bun
 export type ServeStaticOptions<E extends Env = Env> = {
   root?: string
   path?: string
+  mimes?: Record<string, string>
   rewriteRequestPath?: (path: string) => string
   onNotFound?: (path: string, c: Context<E>) => void | Promise<void>
 }
@@ -45,7 +46,12 @@ export const serveStatic = <E extends Env = Env>(
     if (existsSync(path)) {
       const content = file(path)
       if (content) {
-        const mimeType = getMimeType(path)
+        let mimeType: string | undefined = undefined
+        if (options.mimes) {
+          mimeType = getMimeType(path, options.mimes) ?? getMimeType(path)
+        } else {
+          mimeType = getMimeType(path)
+        }
         if (mimeType) {
           c.header('Content-Type', mimeType)
         }

diff --git a/src/adapter/cloudflare-workers/serve-static.test.ts b/src/adapter/cloudflare-workers/serve-static.test.ts
@@ -11,6 +11,9 @@ const store: Record<string, string> = {
   'static-no-root/plain.abcdef.txt': 'That is plain.txt',
   'assets/static/options/foo.abcdef.txt': 'With options',
   'assets/.static/plain.abcdef.txt': 'In the dot',
+  'assets/static/video/morning-routine.abcdef.m3u8': 'Good morning',
+  'assets/static/video/morning-routine1.abcdef.ts': 'Good',
+  'assets/static/video/introduction.abcdef.mp4': 'Let me introduce myself',
 }
 const manifest = JSON.stringify({
   'assets/static/plain.txt': 'assets/static/plain.abcdef.txt',
@@ -123,6 +126,37 @@ describe('With `file` options', () => {
   })
 })
 
+describe('With `mimes` options', () => {
+  const mimes = {
+    m3u8: 'application/vnd.apple.mpegurl',
+    ts: 'video/mp2t',
+  }
+  const manifest = {
+    'assets/static/video/morning-routine.m3u8': 'assets/static/video/morning-routine.abcdef.m3u8',
+    'assets/static/video/morning-routine1.ts': 'assets/static/video/morning-routine1.abcdef.ts',
+    'assets/static/video/introduction.mp4': 'assets/static/video/introduction.abcdef.mp4',
+  }
+
+  const app = new Hono()
+  app.use('/static/*', serveStatic({ root: './assets', mimes, manifest }))
+
+  it('Should return content-type of m3u8', async () => {
+    const res = await app.request('http://localhost/static/video/morning-routine.m3u8')
+    expect(res.status).toBe(200)
+    expect(res.headers.get('Content-Type')).toBe('application/vnd.apple.mpegurl')
+  })
+  it('Should return content-type of ts', async () => {
+    const res = await app.request('http://localhost/static/video/morning-routine1.ts')
+    expect(res.status).toBe(200)
+    expect(res.headers.get('Content-Type')).toBe('video/mp2t')
+  })
+  it('Should return content-type of default on Hono', async () => {
+    const res = await app.request('http://localhost/static/video/introduction.mp4')
+    expect(res.status).toBe(200)
+    expect(res.headers.get('Content-Type')).toBe('video/mp4')
+  })
+})
+
 describe('With middleware', () => {
   const app = new Hono()
   const md1 = async (c: Context, next: Next) => {

diff --git a/src/adapter/cloudflare-workers/serve-static.ts b/src/adapter/cloudflare-workers/serve-static.ts
@@ -9,6 +9,7 @@ import { getContentFromKVAsset } from './utils'
 export type ServeStaticOptions<E extends Env = Env> = {
   root?: string
   path?: string
+  mimes?: Record<string, string>
   manifest: object | string
   namespace?: KVNamespace
   rewriteRequestPath?: (path: string) => string
@@ -48,7 +49,12 @@ export const serveStatic = <E extends Env = Env>(
     })
 
     if (content) {
-      const mimeType = getMimeType(path)
+      let mimeType: string | undefined = undefined
+      if (options.mimes) {
+        mimeType = getMimeType(path, options.mimes) ?? getMimeType(path)
+      } else {
+        mimeType = getMimeType(path)
+      }
       if (mimeType) {
         c.header('Content-Type', mimeType)
       }

diff --git a/src/adapter/deno/serve-static.ts b/src/adapter/deno/serve-static.ts
@@ -10,6 +10,7 @@ const { open } = Deno
 export type ServeStaticOptions<E extends Env = Env> = {
   root?: string
   path?: string
+  mimes?: Record<string, string>
   rewriteRequestPath?: (path: string) => string
   onNotFound?: (path: string, c: Context<E>) => void | Promise<void>
 }

diff --git a/src/utils/mime.test.ts b/src/utils/mime.test.ts
@@ -1,5 +1,10 @@
 import { getMimeType, getExtension } from './mime'
 
+const mime = {
+  m3u8: 'application/vnd.apple.mpegurl',
+  ts: 'video/mp2t',
+}
+
 describe('mime', () => {
   it('getMimeType', () => {
     expect(getMimeType('hello.txt')).toBe('text/plain; charset=utf-8')
@@ -11,6 +16,12 @@ describe('mime', () => {
     expect(getMimeType('indexjs.abcd')).toBeUndefined()
   })
 
+  it('getMimeType with custom mime', () => {
+    expect(getMimeType('morning-routine.m3u8', mime)).toBe('application/vnd.apple.mpegurl')
+    expect(getMimeType('morning-routine1.ts', mime)).toBe('video/mp2t')
+    expect(getMimeType('readme.txt', mime)).toBeUndefined()
+  })
+
   it('getExtension', () => {
     expect(getExtension('audio/aac')).toBe('aac')
     expect(getExtension('application/x-abiword')).toBe('abw')

diff --git a/src/utils/mime.ts b/src/utils/mime.ts
@@ -1,4 +1,4 @@
-export const getMimeType = (filename: string): string | undefined => {
+export const getMimeType = (filename: string, mimes = baseMimes): string | undefined => {
   const regexp = /\.([a-zA-Z0-9]+?)$/
   const match = filename.match(regexp)
   if (!match) {
@@ -12,10 +12,10 @@ export const getMimeType = (filename: string): string | undefined => {
 }
 
 export const getExtension = (mimeType: string): string | undefined => {
-  return Object.keys(mimes).find((ext) => mimes[ext] === mimeType)
+  return Object.keys(baseMimes).find((ext) => baseMimes[ext] === mimeType)
 }
 
-const mimes: Record<string, string> = {
+const baseMimes: Record<string, string> = {
   aac: 'audio/aac',
   abw: 'application/x-abiword',
   arc: 'application/x-freearc',