@sirena-lwm2m/coap 0.8.0

package/examples/slice-7-otel.ts

@@ -0,0 +1,123 @@
+// Slice 7b — OpenTelemetry metrics example
+//
+// Demonstrates a CoAP server with OTel metrics wired to a console exporter.
+// The metrics module uses lazy import() so there is zero cost when
+// @opentelemetry/api is not installed.
+//
+// To run with real OTel metrics you need the SDK packages:
+//   npm install @opentelemetry/api @opentelemetry/sdk-metrics
+//
+// Run without SDK (no-op metrics, zero allocation):
+//   node --experimental-strip-types examples/slice-7-otel.ts
+//
+// Run with SDK (console exporter):
+//   OTEL_ENABLED=1 node --experimental-strip-types examples/slice-7-otel.ts
+
+import dgram from 'node:dgram';
+import { createServer, Response, encodeMessage, decodeMessage, stringToCode } from '@sirena-lwm2m/coap';
+import { bindOtel, tryBindOtel } from '@sirena-lwm2m/coap/observability';
+import type { CoapMetrics } from '@sirena-lwm2m/coap/observability';
+
+// ── Metrics setup ─────────────────────────────────────────────────────────────
+//
+// tryBindOtel() lazy-imports @opentelemetry/api at runtime.
+// If the package is absent it silently returns no-op instruments.
+
+let metrics: CoapMetrics;
+
+if (process.env.OTEL_ENABLED === '1') {
+  try {
+    // Attempt to wire up a real SDK with a console exporter.
+    // This block is only reached when OTEL_ENABLED=1 and the SDK is installed.
+    const { MeterProvider, PeriodicExportingMetricReader } = await import('@opentelemetry/sdk-metrics' as never as '@opentelemetry/sdk-metrics');
+    const { ConsoleMetricExporter } = await import('@opentelemetry/sdk-metrics' as never as '@opentelemetry/sdk-metrics');
+
+    const provider = new MeterProvider();
+    provider.addMetricReader(
+      new PeriodicExportingMetricReader({
+        exporter: new ConsoleMetricExporter(),
+        exportIntervalMillis: 2000,
+      }),
+    );
+
+    const meter = provider.getMeter('@sirena-lwm2m/coap');
+    metrics = bindOtel(meter as never);
+
+    console.log('OTel metrics: SDK wired with console exporter (export every 2s)');
+  } catch {
+    console.warn('OTel SDK not installed — falling back to no-op metrics');
+    metrics = await tryBindOtel('@sirena-lwm2m/coap');
+  }
+} else {
+  // Default path: lazy import falls back to no-ops when @opentelemetry/api absent
+  metrics = await tryBindOtel('@sirena-lwm2m/coap');
+  console.log('OTel metrics: no-op (set OTEL_ENABLED=1 to enable console exporter)');
+}
+
+// ── Server ────────────────────────────────────────────────────────────────────
+
+const server = createServer({
+  listen: ['coap://127.0.0.1:5691'],
+  metrics,
+});
+
+let requestCount = 0;
+
+server.on('request', async (_req, ctx) => {
+  requestCount++;
+  console.log(`[server] request #${requestCount} from ${ctx.remote}`);
+  await ctx.respond(Response.ok(new TextEncoder().encode(`hello #${requestCount}`)));
+});
+
+server.on('exchange-error', (err) => {
+  console.error('[server] exchange-error:', err.message);
+});
+
+await server.start();
+console.log('Server started:', server.listenerSummary());
+
+// ── Client: send same CON twice (dedup demo, verifies dedupHits counter) ──────
+
+const sock = dgram.createSocket('udp4');
+await new Promise<void>((resolve) => sock.bind(0, '127.0.0.1', resolve));
+
+const TOKEN = new Uint8Array([0xca, 0xfe, 0xba, 0xbe]);
+const MID = 0x4321;
+
+const request = encodeMessage({
+  version: 1,
+  type: 'CON',
+  token: TOKEN,
+  code: stringToCode('0.01'), // GET
+  messageId: MID,
+  options: [],
+  payload: new Uint8Array(0),
+});
+
+const responses: string[] = [];
+sock.on('message', (msg) => {
+  const decoded = decodeMessage(msg);
+  responses.push(new TextDecoder().decode(decoded.payload));
+  console.log(`[client] received: ${responses[responses.length - 1]}`);
+});
+
+// First transmission — should create a new exchange and increment requestRate
+sock.send(request, 5691, '127.0.0.1');
+console.log('[client] sent CON request (first)');
+await new Promise(r => setTimeout(r, 60));
+
+// Retransmission of same MID — server should dedup (increments dedupHits)
+sock.send(request, 5691, '127.0.0.1');
+console.log('[client] retransmitted same CON (should be deduped)');
+await new Promise(r => setTimeout(r, 60));
+
+console.log(`\nResult: ${requestCount} handler invocation(s) for 2 transmissions`);
+console.log(requestCount === 1
+  ? '✓ CON retransmission correctly deduped'
+  : '✗ Dedup failed — handler was invoked more than once');
+
+// ── Cleanup ───────────────────────────────────────────────────────────────────
+
+sock.close();
+await server.stop();
+console.log('\nDone.');

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@sirena-lwm2m/coap",
+  "version": "0.8.0",
+  "type": "module",
+  "license": "MIT",
+  "engines": {
+    "node": ">=24"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "node --experimental-strip-types --test 'test/*.test.ts' 'test/eclipse-td/**/*.test.ts' 'test/wire/**/*.test.ts'",
+    "test:interop": "node --experimental-strip-types --test 'test/interop/**/*.test.ts'",
+    "test:mutate": "node --experimental-strip-types scripts/mutation-runner.ts",
+    "prepublishOnly": "npm run build"
+  },
+  "files": [
+    "dist",
+    "docs",
+    "examples",
+    "LICENSE"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./router": {
+      "import": "./dist/router.js",
+      "types": "./dist/router.d.ts"
+    },
+    "./store": {
+      "import": "./dist/store.js",
+      "types": "./dist/store.d.ts"
+    },
+    "./transport": {
+      "import": "./dist/transport.js",
+      "types": "./dist/transport.d.ts"
+    },
+    "./security": {
+      "import": "./dist/security.js",
+      "types": "./dist/security.d.ts"
+    },
+    "./observability": {
+      "import": "./dist/observability.js",
+      "types": "./dist/observability.d.ts"
+    },
+    "./blockwise": {
+      "import": "./dist/blockwise/index.js",
+      "types": "./dist/blockwise/index.d.ts"
+    },
+    "./internal/*": null
+  },
+  "peerDependencies": {
+    "@opentelemetry/api": "*",
+    "better-sqlite3": "*"
+  },
+  "peerDependenciesMeta": {
+    "better-sqlite3": {
+      "optional": true
+    },
+    "@opentelemetry/api": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/better-sqlite3": "^7.6.13",
+    "@types/node": "^25.9.1",
+    "better-sqlite3": "^12.10.0",
+    "fast-check": "^4.8.0",
+    "testcontainers": "^12.0.1",
+    "typescript": "^6.0.3"
+  }
+}