@hono/node-server 2.1.0: getConnInfo

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify @hono/node-server.getConnInfo in pkg:npm/%40hono/node-server@2.1.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/%40hono/node-server@2.1.0
Demonstrate these symbols/APIs:
  - @hono/node-server.getConnInfo

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:b1c04663cc872c422d05b404ee2ac56c0c7680f199ffb434194ce44e1ba264f8","contract":["getConnInfo is exported as a function from @hono/node-server/conninfo","getConnInfo extracts IPv4 remote address, port, and IPv4 addressType from context env incoming socket","getConnInfo extracts IPv6 remote address, port, and IPv6 addressType from context env incoming socket","getConnInfo sets addressType to undefined when socket remoteFamily is unrecognized or omitted","getConnInfo retrieves socket bindings from c.env.server when present","getConnInfo captures live connection details from incoming HTTP request handled by getRequestListener"],"goal":"verify @hono/node-server.getConnInfo in pkg:npm/%40hono/node-server@2.1.0","kind":"HOW","packages":["pkg:npm/%40hono/node-server@2.1.0"],"schemaVersion":1,"symbols":["@hono/node-server.getConnInfo"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"npm","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/%40hono/node-server@2.1.0"],"schemaVersion":1,"subject":"pkg:npm/%40hono/node-server@2.1.0","symbols":["@hono/node-server.getConnInfo"],"verifierAdapter":"node-typescript@1"}

import { getConnInfo } from '@hono/node-server/conninfo';

/**
 * Retrieve remote connection information from a Hono request context.
 * @param {object} c - Hono context object containing env bindings
 * @returns {{ remote: { address?: string, port?: number, addressType?: 'IPv4' | 'IPv6' } }}
 */
export function extractConnInfo(c) {
  return getConnInfo(c);
}

export { getConnInfo };

{
  "name": "sample-hono-node-server-conninfo",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-hono-node-server-conninfo",
      "version": "1.0.0",
      "dependencies": {
        "@hono/node-server": "2.1.0"
      }
    },
    "node_modules/@hono/node-server": {
      "version": "2.1.0",
      "resolved": "https://registry.npmjs.org/@hono/node-server/-/node-server-2.1.0.tgz",
      "integrity": "sha512-XovyyCCnBzW+zKu+z/zq8hwNs4KOR5rEMAOxo2f40Q5xoOI37IMm6MIg2COOUtUApo0i6850MTBKH2u4QLGIqg==",
      "license": "MIT",
      "engines": {
        "node": ">=20"
      },
      "peerDependencies": {
        "hono": "^4"
      }
    },
    "node_modules/hono": {
      "version": "4.13.5",
      "resolved": "https://registry.npmjs.org/hono/-/hono-4.13.5.tgz",
      "integrity": "sha512-O6+/eCYRkzzzy0rPWwKLiGBR1nFuUPZynnwjxN1MBA62NNqbT0wQEzQyK2gSO5yDIDB336sXQleAhOHrzlYyKw==",
      "license": "MIT",
      "peer": true,
      "engines": {
        "node": ">=16.9.0"
      }
    }
  }
}

{
  "name": "sample-hono-node-server-conninfo",
  "version": "1.0.0",
  "type": "module",
  "private": true,
  "dependencies": {
    "@hono/node-server": "2.1.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify @hono/node-server.getConnInfo in pkg:npm/%40hono/node-server@2.1.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/%40hono/node-server@2.1.0"
  ],
  "symbols": [
    "@hono/node-server.getConnInfo"
  ]
}

import assert from 'node:assert/strict';
import { createServer } from 'node:http';
import { getConnInfo, extractConnInfo } from '../index.mjs';
import { getRequestListener } from '@hono/node-server';

// 1. getConnInfo is exported as a function from @hono/node-server/conninfo
assert.equal(typeof getConnInfo, 'function');
assert.equal(typeof extractConnInfo, 'function');

// 2. getConnInfo extracts IPv4 remote address, port, and IPv4 addressType from context env incoming socket
{
  const c = {
    env: {
      incoming: {
        socket: {
          remoteAddress: '127.0.0.1',
          remotePort: 8080,
          remoteFamily: 'IPv4',
        },
      },
    },
  };
  const info = getConnInfo(c);
  assert.deepEqual(info, {
    remote: {
      address: '127.0.0.1',
      port: 8080,
      addressType: 'IPv4',
    },
  });
}

// 3. getConnInfo extracts IPv6 remote address, port, and IPv6 addressType from context env incoming socket
{
  const c = {
    env: {
      incoming: {
        socket: {
          remoteAddress: '::1',
          remotePort: 54321,
          remoteFamily: 'IPv6',
        },
      },
    },
  };
  const info = getConnInfo(c);
  assert.deepEqual(info, {
    remote: {
      address: '::1',
      port: 54321,
      addressType: 'IPv6',
    },
  });
}

// 4. getConnInfo sets addressType to undefined when socket remoteFamily is unrecognized or omitted
{
  const c = {
    env: {
      incoming: {
        socket: {
          remoteAddress: 'localhost',
          remotePort: undefined,
          remoteFamily: undefined,
        },
      },
    },
  };
  const info = getConnInfo(c);
  assert.deepEqual(info, {
    remote: {
      address: 'localhost',
      port: undefined,
      addressType: undefined,
    },
  });
}

// 5. getConnInfo retrieves socket bindings from c.env.server when present
{
  const c = {
    env: {
      server: {
        incoming: {
          socket: {
            remoteAddress: '10.0.0.1',
            remotePort: 443,
            remoteFamily: 'IPv4',
          },
        },
      },
    },
  };
  const info = getConnInfo(c);
  assert.deepEqual(info, {
    remote: {
      address: '10.0.0.1',
      port: 443,
      addressType: 'IPv4',
    },
  });
}

// 6. getConnInfo captures live connection details from incoming HTTP request handled by getRequestListener
{
  let capturedInfo = null;
  const listener = getRequestListener((req, env) => {
    capturedInfo = getConnInfo({ env });
    return new Response('OK');
  });

  const server = createServer(listener);
  await new Promise((resolve) => server.listen(0, '127.0.0.1', resolve));
  const { port } = server.address();

  try {
    const res = await fetch(`http://127.0.0.1:${port}/`);
    assert.equal(res.status, 200);
    assert.ok(capturedInfo);
    assert.equal(capturedInfo.remote.address, '127.0.0.1');
    assert.equal(typeof capturedInfo.remote.port, 'number');
    assert.equal(capturedInfo.remote.addressType, 'IPv4');
  } finally {
    await new Promise((resolve) => server.close(resolve));
  }
}

console.log('All contract tests passed.');