feat: implement ConnInfo helper (#180)

* feat: implement ConnInfo helper

* chore: change package.json to export ConnInfo helper

* fix: lint

* remove `bun.lockb`

---------

Co-authored-by: Yusuke Wada <yusuke@kamawada.com>

package.json

@@ -27,6 +27,11 @@
       "types": "./dist/utils/*.d.ts",
       "require": "./dist/utils/*.js",
       "import": "./dist/utils/*.mjs"
+    },
+    "./conninfo": {
+      "types": "./dist/conninfo.d.ts",
+      "require": "./dist/conninfo.js",
+      "import": "./dist/conninfo.mjs"
     }
   },
   "typesVersions": {
@@ -42,6 +47,9 @@
       ],
       "utils/*": [
         "./dist/utils/*.d.ts"
+      ],
+      "conninfo": [
+        "./dist/conninfo.d.ts"
       ]
     }
   },

src/conninfo.ts

@@ -0,0 +1,29 @@
+import type { AddressInfo } from 'net'
+import type { GetConnInfo } from 'hono/conninfo'
+import type { HttpBindings } from './types'
+
+/**
+ * ConnInfo Helper for Node.js
+ * @param c Context
+ * @returns ConnInfo
+ */
+export const getConnInfo: GetConnInfo = (c) => {
+  const bindings = (c.env.server ? c.env.server : c.env) as HttpBindings
+
+  const address = bindings.incoming.socket.address() as AddressInfo
+
+  if (!('address' in address)) {
+    return {
+      remote: {},
+    }
+  }
+
+  return {
+    remote: {
+      address: address.address,
+      addressType:
+        address.family === 'IPv4' ? 'IPv4' : address.family === 'IPv6' ? 'IPv6' : 'unknown',
+      port: address.port,
+    },
+  }
+}

test/conninfo.test.ts

@@ -0,0 +1,37 @@
+import type { AddressInfo } from 'net'
+import { Hono } from 'hono'
+import type { AddressType, ConnInfo } from 'hono/conninfo'
+import { getConnInfo } from '../src/conninfo'
+
+describe('ConnInfo', () => {
+  it('Should works', async () => {
+    const app = new Hono().get('/', (c) => c.json(getConnInfo(c)))
+
+    const address: AddressInfo = {
+      address: '0.0.0.0',
+      family: 'IPv4',
+      port: 3030,
+    }
+    expect(
+      await (
+        await app.request(
+          '/',
+          {},
+          {
+            incoming: {
+              socket: {
+                address: () => address,
+              },
+            },
+          }
+        )
+      ).json()
+    ).toEqual({
+      remote: {
+        address: address.address,
+        addressType: address.family as AddressType,
+        port: address.port,
+      },
+    } satisfies ConnInfo)
+  })
+})