feat(serve-static): "206 Partial Content" support

runtime-tests/bun/index.test.tsx

@@ -167,6 +167,77 @@ describe('Serve Static Middleware', () => {
  expect(await res.text()).toBe('Bun!')
  expect(onNotFound).not.toHaveBeenCalled()
  })
+
+ describe('Range Request', () => {
+ it('Should support a single range request', async () => {
+ const res = await app.request(
+ new Request('http://localhost/favicon.ico', { headers: { Range: 'bytes=0-4' } })
+ )
+ expect(await res.text()).toBe('\u0000\u0000\u0001\u0000\u0003')
+ expect(res.status).toBe(206)
+ expect(res.headers.get('Content-Type')).toBe('image/x-icon')
+ expect(res.headers.get('Content-Length')).toBe('5')
+ expect(res.headers.get('Content-Range')).toBe('bytes 0-4/15406')
+ })
+
+ it('Should support a single range where its end is larger than the actual size', async () => {
+ const res = await app.request(
+ new Request('http://localhost/favicon.ico', { headers: { Range: 'bytes=15400-20000' } })
+ )
+ expect(await res.text()).toBe('\u0000\u0000\u0000\u0000\u0000\u0000')
+ expect(res.status).toBe(206)
+ expect(res.headers.get('Content-Type')).toBe('image/x-icon')
+ expect(res.headers.get('Content-Length')).toBe('6')
+ expect(res.headers.get('Content-Range')).toBe('bytes 15400-15405/15406')
+ })
+
+ it('Should support omitted end', async () => {
+ const res = await app.request(
+ new Request('http://localhost/favicon.ico', { headers: { Range: 'bytes=15400-' } })
+ )
+ expect(await res.text()).toBe('\u0000\u0000\u0000\u0000\u0000\u0000')
+ expect(res.status).toBe(206)
+ expect(res.headers.get('Content-Type')).toBe('image/x-icon')
+ expect(res.headers.get('Content-Length')).toBe('6')
+ expect(res.headers.get('Content-Range')).toBe('bytes 15400-15405/15406')
+ })
+
+ it('Should support the last N bytes request', async () => {
+ const res = await app.request(
+ new Request('http://localhost/favicon.ico', { headers: { Range: 'bytes=-10' } })
+ )
+ expect(await res.text()).toBe('\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000')
+ expect(res.status).toBe(206)
+ expect(res.headers.get('Content-Type')).toBe('image/x-icon')
+ expect(res.headers.get('Content-Length')).toBe('10')
+ expect(res.headers.get('Content-Range')).toBe('bytes 15396-15405/15406')
+ })
+
+ it('Should support multiple ranges', async () => {
+ const res = await app.request(
+ new Request('http://localhost/favicon.ico', {
+ headers: { Range: 'bytes=151-200,351-400,15401-15500' },
+ })
+ )
+ await res.arrayBuffer()
+ expect(res.status).toBe(206)
+ expect(res.headers.get('Content-Type')).toBe(
+ 'multipart/byteranges; boundary=PARTIAL_CONTENT_BOUNDARY'
+ )
+ expect(res.headers.get('Content-Length')).toBe('105')
+ expect(res.headers.get('Content-Range')).toBeNull()
+ })
+
+ it('Should return 404 if file no found', async () => {
+ const res = await app.request(
+ new Request('http://localhost/static/no-such-image.png', {
+ headers: { Range: 'bytes=151-200,351-400,15401-15500' },
+ })
+ )
+ await res.arrayBuffer()
+ expect(res.status).toBe(404)
+ })
+ })
 })
 
 // Bun support WebCrypto since v0.2.2

runtime-tests/deno/middleware.test.tsx

@@ -147,6 +147,70 @@ Deno.test('Serve Static middleware', async () => {
  res = await app.request('http://localhost/static-absolute-root/plain.txt')
  assertEquals(res.status, 200)
  assertEquals(await res.text(), 'Deno!')
+
+ // Should support a single range request
+ res = await app.request(
+ new Request('http://localhost/favicon.ico', { headers: { Range: 'bytes=0-4' } })
+ )
+ assertEquals(await res.text(), '\u0000\u0000\u0001\u0000\u0003')
+ assertEquals(res.status, 206)
+ assertEquals(res.headers.get('Content-Type'), 'image/x-icon')
+ assertEquals(res.headers.get('Content-Length'), '5')
+ assertEquals(res.headers.get('Content-Range'), 'bytes 0-4/15406')
+
+ // Should support a single range where its end is larger than the actual size
+ res = await app.request(
+ new Request('http://localhost/favicon.ico', { headers: { Range: 'bytes=15400-20000' } })
+ )
+ assertEquals(await res.text(), '\u0000\u0000\u0000\u0000\u0000\u0000')
+ assertEquals(res.status, 206)
+ assertEquals(res.headers.get('Content-Type'), 'image/x-icon')
+ assertEquals(res.headers.get('Content-Length'), '6')
+ assertEquals(res.headers.get('Content-Range'), 'bytes 15400-15405/15406')
+
+ // Should support omitted end
+ res = await app.request(
+ new Request('http://localhost/favicon.ico', { headers: { Range: 'bytes=15400-' } })
+ )
+ assertEquals(await res.text(), '\u0000\u0000\u0000\u0000\u0000\u0000')
+ assertEquals(res.status, 206)
+ assertEquals(res.headers.get('Content-Type'), 'image/x-icon')
+ assertEquals(res.headers.get('Content-Length'), '6')
+ assertEquals(res.headers.get('Content-Range'), 'bytes 15400-15405/15406')
+
+ // Should support the last N bytes request
+ res = await app.request(
+ new Request('http://localhost/favicon.ico', { headers: { Range: 'bytes=-10' } })
+ )
+ assertEquals(await res.text(), '\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000')
+ assertEquals(res.status, 206)
+ assertEquals(res.headers.get('Content-Type'), 'image/x-icon')
+ assertEquals(res.headers.get('Content-Length'), '10')
+ assertEquals(res.headers.get('Content-Range'), 'bytes 15396-15405/15406')
+
+ // Should support multiple ranges
+ res = await app.request(
+ new Request('http://localhost/favicon.ico', {
+ headers: { Range: 'bytes=151-200,351-400,15401-15500' },
+ })
+ )
+ await res.arrayBuffer()
+ assertEquals(res.status, 206)
+ assertEquals(
+ res.headers.get('Content-Type'),
+ 'multipart/byteranges; boundary=PARTIAL_CONTENT_BOUNDARY'
+ )
+ assertEquals(res.headers.get('Content-Length'), '105')
+ assertEquals(res.headers.get('Content-Range'), null)
+
+ // Should return 404 if file no found'
+ res = await app.request(
+ new Request('http://localhost/static/no-such-image.png', {
+ headers: { Range: 'bytes=151-200,351-400,15401-15500' },
+ })
+ )
+ await res.arrayBuffer()
+ assertEquals(res.status, 404)
 })
 
 Deno.test('JWT Authentication middleware', async () => {

src/adapter/bun/serve-static.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/ban-ts-comment */
-import { stat } from 'node:fs/promises'
+import { open, stat } from 'node:fs/promises'
 import { serveStatic as baseServeStatic } from '../../middleware/serve-static'
 import type { ServeStaticOptions } from '../../middleware/serve-static'
 import type { Env, MiddlewareHandler } from '../../types'
@@ -30,6 +30,38 @@
  getContent,
  pathResolve,
  isDir,
+ partialContentSupport: async (path: string) => {
+ path = path.startsWith('/') ? path : `./${path}`
+ const handle = await open(path)
+ const size = (await handle.stat()).size
+ return {
+ size,
+ getPartialContent: function getPartialContent(start: number, end: number) {
+ const readStream = handle.createReadStream({ start, end })
+ const data = new ReadableStream({
+ start(controller) {
+ readStream.on('data', (chunk) => {
+ controller.enqueue(chunk)
+ })
+ readStream.on('end', () => {
+ controller.close()
+ })
+ readStream.on('error', (e) => {
+ controller.error(e)
+ })
+ },
+ })
+ return {
+ start,
+ end,
+ data,
+ }
+ },
+ close: () => {
+ handle.close()
+ },
+ }
+ },
  })(c, next)
  }
 }

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

@@ -31,6 +31,7 @@ export const serveStatic = <E extends Env = Env>(
  : undefined,
  })
  }
+ // partialContentSupport is not implemented since this middleware is deprecated
  return baseServeStatic({
  ...options,
  getContent,

src/adapter/deno/deno.d.ts

@@ -8,6 +8,11 @@ declare namespace Deno {
  */
  export function mkdir(path: string, options?: { recursive?: boolean }): Promise<void>
 
+ export function lstatSync(path: string): {
+ isDirectory: boolean
+ size: number
+ }
+
  /**
  * Write a new file, with the specified path and data.
  *
@@ -25,4 +30,19 @@ declare namespace Deno {
  response: Response
  socket: WebSocket
  }
+
+ export function open(path: string): Promise<FsFile>
+
+ export enum SeekMode {
+ Start = 0,
+ }
+
+ export function seekSync(rid: number, offset: number, whence: SeekMode): number
+ export function readSync(rid: number, buffer: Uint8Array): number
+
+ export type FsFile = {
+ rid: number
+ readable: ReadableStream<Uint8Array>
+ close(): void
+ }
 }

src/adapter/deno/serve-static.ts

@@ -2,9 +2,7 @@
 import { serveStatic as baseServeStatic } from '../../middleware/serve-static'
 import type { Env, MiddlewareHandler } from '../../types'
 
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-const { open, lstatSync } = Deno
+const { open, lstatSync, seekSync, readSync, SeekMode } = Deno
 
 export const serveStatic = <E extends Env = Env>(
  options: ServeStaticOptions<E>
@@ -13,10 +11,10 @@
  const getContent = async (path: string) => {
  try {
  const file = await open(path)
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- return file ? (file.readable as any) : null
+ return file?.readable ?? null
  } catch (e) {
  console.warn(`${e}`)
+ return null
  }
  }
  const pathResolve = (path: string) => {
@@ -35,6 +33,27 @@
  getContent,
  pathResolve,
  isDir,
+ partialContentSupport: async (path: string) => {
+ path = path.startsWith('/') ? path : `./${path}`
+ const handle = await open(path)
+ const size = lstatSync(path).size
+ return {
+ size,
+ getPartialContent: function getPartialContent(start: number, end: number) {
+ seekSync(handle.rid, start, SeekMode.Start)
+ const data = new Uint8Array(end - start + 1)
+ readSync(handle.rid, data)
+ return {
+ start,
+ end,
+ data,
+ }
+ },
+ close: () => {
+ handle.close()
+ },
+ }
+ },
  })(c, next)
  }
 }