[pull] main from honojs:main

docs/CODE_OF_CONDUCT.md

@@ -14,8 +14,8 @@ diverse, inclusive, and healthy community.
 
 ## Our Standards
 
-Examples of behavior that contribute to a positive environment for our
-community includes:
+Examples of behavior that contributes to a positive environment for our
+community include:
 
 - Demonstrating empathy and kindness toward other people
 - Being respectful of differing opinions, viewpoints, and experiences

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hono",
-  "version": "4.11.5",
+  "version": "4.11.6",
   "description": "Web framework built on Web Standards",
   "main": "dist/cjs/index.js",
   "type": "module",

src/adapter/bun/conninfo.ts

@@ -8,7 +8,13 @@ import { getBunServer } from './server'
  * @returns ConnInfo
  */
 export const getConnInfo: GetConnInfo = (c: Context) => {
-  const server = getBunServer(c)
+  const server = getBunServer<{
+    requestIP?: (req: Request) => {
+      address: string
+      family: string
+      port: number
+    } | null
+  }>(c)
 
   if (!server) {
     throw new TypeError('env has to include the 2nd argument of fetch.')

src/adapter/bun/index.ts

@@ -8,3 +8,4 @@ export { bunFileSystemModule, toSSG } from './ssg'
 export { createBunWebSocket, upgradeWebSocket, websocket } from './websocket'
 export type { BunWebSocketData, BunWebSocketHandler } from './websocket'
 export { getConnInfo } from './conninfo'
+export { getBunServer } from './server'

src/adapter/bun/server.test.ts

@@ -1,10 +1,9 @@
 import { Context } from '../../context'
 import { getBunServer } from './server'
-import type { BunServer } from './server'
 
 describe('getBunServer', () => {
   it('Should success to pick Server', () => {
-    const server = {} as BunServer
+    const server = {}
 
     expect(getBunServer(new Context(new Request('http://localhost/'), { env: server }))).toBe(
       server

src/adapter/bun/server.ts

@@ -4,27 +4,11 @@
  */
 import type { Context } from '../../context'
 
-/**
- * Bun Server Object
- */
-export interface BunServer {
-  requestIP?: (req: Request) => {
-    address: string
-    family: string
-    port: number
-  } | null
-  upgrade<T>(
-    req: Request,
-    options?: {
-      data: T
-    }
-  ): boolean
-}
-
 /**
  * Get Bun Server Object from Context
+ * @template T - The type of Bun Server
  * @param c Context
  * @returns Bun Server
  */
-export const getBunServer = (c: Context): BunServer | undefined =>
-  ('server' in c.env ? c.env.server : c.env) as BunServer | undefined
+export const getBunServer = <T>(c: Context): T | undefined =>
+  ('server' in c.env ? c.env.server : c.env) as T | undefined

src/adapter/bun/websocket.ts

@@ -46,7 +46,15 @@ export const createWSContext = (ws: BunServerWebSocket<BunWebSocketData>): WSCon
 }
 
 export const upgradeWebSocket: UpgradeWebSocket<any> = defineWebSocketHelper((c, events) => {
-  const server = getBunServer(c)
+  const server = getBunServer<{
+    upgrade<T>(
+      req: Request,
+      options?: {
+        data: T
+      }
+    ): boolean
+  }>(c)
+
   if (!server) {
     throw new TypeError('env has to include the 2nd argument of fetch.')
   }

src/helper/streaming/sse.test.tsx

@@ -238,4 +238,81 @@ describe('SSE Streaming helper', () => {
     const decodedValue = decoder.decode(value)
     expect(decodedValue).toBe('data: <div>Error</div>\n\n')
   })
+
+  it('Check streamSSE handles \\r (CR) line ending correctly', async () => {
+    const res = streamSSE(c, async (stream) => {
+      await stream.writeSSE({
+        data: 'Line1\rLine2',
+        event: 'test-cr',
+      })
+    })
+
+    if (!res.body) {
+      throw new Error('Body is null')
+    }
+    const reader = res.body.getReader()
+    const decoder = new TextDecoder()
+    const { value } = await reader.read()
+    const decodedValue = decoder.decode(value)
+
+    expect(decodedValue).toBe('event: test-cr\ndata: Line1\ndata: Line2\n\n')
+  })
+
+  it('Check streamSSE handles \\r\\n (CRLF) line ending correctly', async () => {
+    const res = streamSSE(c, async (stream) => {
+      await stream.writeSSE({
+        data: 'Line1\r\nLine2',
+        event: 'test-crlf',
+      })
+    })
+
+    if (!res.body) {
+      throw new Error('Body is null')
+    }
+    const reader = res.body.getReader()
+    const decoder = new TextDecoder()
+    const { value } = await reader.read()
+    const decodedValue = decoder.decode(value)
+
+    expect(decodedValue).toBe('event: test-crlf\ndata: Line1\ndata: Line2\n\n')
+  })
+
+  it('Check streamSSE handles mixed line endings correctly', async () => {
+    const res = streamSSE(c, async (stream) => {
+      await stream.writeSSE({
+        data: 'A\nB\rC\r\nD',
+        event: 'test-mixed',
+      })
+    })
+
+    if (!res.body) {
+      throw new Error('Body is null')
+    }
+    const reader = res.body.getReader()
+    const decoder = new TextDecoder()
+    const { value } = await reader.read()
+    const decodedValue = decoder.decode(value)
+
+    expect(decodedValue).toBe('event: test-mixed\ndata: A\ndata: B\ndata: C\ndata: D\n\n')
+  })
+
+  it('Check streamSSE handles consecutive \\r correctly', async () => {
+    const res = streamSSE(c, async (stream) => {
+      await stream.writeSSE({
+        data: 'Left\r\rRight',
+        event: 'test-double-cr',
+      })
+    })
+
+    if (!res.body) {
+      throw new Error('Body is null')
+    }
+    const reader = res.body.getReader()
+    const decoder = new TextDecoder()
+    const { value } = await reader.read()
+    const decodedValue = decoder.decode(value)
+
+    // Two \r should produce an empty line in between
+    expect(decodedValue).toBe('event: test-double-cr\ndata: Left\ndata: \ndata: Right\n\n')
+  })
 })

src/helper/streaming/sse.ts

@@ -18,7 +18,7 @@ export class SSEStreamingApi extends StreamingApi {
   async writeSSE(message: SSEMessage) {
     const data = await resolveCallback(message.data, HtmlEscapedCallbackPhase.Stringify, false, {})
     const dataLines = (data as string)
-      .split('\n')
+      .split(/\r\n|\r|\n/)
       .map((line) => {
         return `data: ${line}`
       })

src/request/constants.ts

@@ -1 +1 @@
-export const GET_MATCH_RESULT: symbol = Symbol()
+export const GET_MATCH_RESULT: unique symbol = Symbol()