feat(opentelemetry): create otel instrumentation for typed-express-router #1044

starfy84 · 2025-06-25T20:46:52Z

This PR implements opentelemetry instrumentation for the decode and sendEncoded calls in wrapRouter.

Changes:

typed-express-wrapper
- @opentelemetry/api@^1.0.0 added as an optional peer dependency
- @opentelemetry/[email protected] , @opentelemetry/[email protected], and @opentelemetry/[email protected] added as dev dependencies
- wrapRouter modified to create decode and encode spans if @opentelemetry/api is installed
  - if @opentelemetry/api is not installed, spans are not created
- onDecodeError option removed. Please use decodeErrorFormatter and getDecodeErrorStatusCode
  - decodeErrorFormatter takes in an array of ValidationErrors and a WrappedRequest, returning a Json object.
  - getDecodeErrorStatusCode takes in an array of ValidationErrors and a WrappedRequest, returning a number.
- onEncodeError option removed. Please use encodeErrorFormatter and getEncodeErrorStatusCode
  - encodeErrorFormatter takes in an error and a WrappedRequest, returning a Json object.
  - getEncodeErrorStatusCode takes in an error and a WrappedRequest, returning a number.
- typed-express-router now handles the sending of the http response when there is a decode or encode error
express-wrapper
- routerForApiSpec modified to pass in new parameters decodeErrorFormatter, getDecodeErrorStatusCode, encodeErrorFormatter, and getEncodeErrorStatusCode
  - These new parameters can also be customized by modifying the props passed into the function (see CreateRouterProps)

BREAKING CHANGE: onDecodeError and onEncodeError have been removed. Please use decodeErrorFormatter, getDecodeErrorStatusCode, encodeErrorFormatter, and getEncodeErrorStatusCode

packages/opentelemetry-instrumentation-typed-express-router/test/instrumentation.test.ts

packages/opentelemetry-instrumentation-typed-express-router/test/integration.test.ts

packages/opentelemetry-instrumentation-typed-express-router/src/version.ts

packages/opentelemetry-instrumentation-typed-express-router/src/utils.ts

packages/opentelemetry-instrumentation-typed-express-router/test/integration.test.ts

packages/opentelemetry-instrumentation-express/src/terinstrumentation.ts

packages/opentelemetry-instrumentation-express/test/fixtures/use-express.mjs

packages/opentelemetry-instrumentation-express/test/utils.ts

packages/opentelemetry-instrumentation-typed-express-router/src/instrumentation.ts

packages/typed-express-router/src/index.ts

packages/typed-express-router/src/telemetry.ts

packages/typed-express-router/test/telemetry.test.ts

packages/express-wrapper/src/request.ts

packages/typed-express-router/src/errors.ts

packages/typed-express-router/src/types.ts

ericcrosson-bitgo

Apparently this text box can't be empty.

packages/express-wrapper/src/request.ts

packages/typed-express-router/src/errors.ts

ericcrosson-bitgo · 2025-07-17T19:37:58Z

packages/typed-express-router/test/server.test.ts

-    onEncodeError: (_err, _req, res) => {
-      res.status(500).json('Custom encode error').end();
+    encodeErrorFormatter: (_err, _req) => {
+      return 'Custom encode error';


praise: Look at all that data instead of state! 😍

packages/typed-express-router/test/telemetry.test.ts

ericcrosson-bitgo · 2025-07-17T19:43:10Z

packages/typed-express-router/test/telemetry.test.ts

+  body?: any,
+): Promise<{ statusCode: number; data: string }> => {
+  return new Promise((resolve, reject) => {
+    const url = `http://localhost:${(server.address() as any).port}${path}`;


question: LSP says server.address() is of type string | AddressInfo | null -- how do you always know it is of type AddressInfo here? I wonder if there's a way to clean up the type cast.

According to the documentation: https://github.com/nodejs/node/blob/main/doc/api/net.md#serveraddress

For a server listening on a pipe or Unix domain socket, the name is returned

and

server.address() returns null before the 'listening' event has been emitted or after calling server.close().

Since we're listening on a port instead of a pipe or a Unix domain socket, we can at least be sure that it'll at least be of type AddressInfo | null

IDEALLY, makeRequest should only be called when the server is listening. The server starts listening before every test (as defined in beforeEach).

So I think the best option here would just be to reject the promise if it's a string or null. (This would be an impossible case for the test)

Something like:

const address = server.address(); if (typeof address === 'string' || address === null) { reject('Unexpected address value'); return; } const url = `http://localhost:${address.port}${path}`;

packages/typed-express-router/test/telemetry.test.ts

…uter This commit implements `opentelemetry` instrumentation for the `decode` and `sendEncoded` calls in `wrapRouter`. Changes: - `typed-express-wrapper` - `@opentelemetry/api@^1.0.0` added as an optional peer dependency - `@opentelemetry/[email protected]` , `@opentelemetry/[email protected]`, and `@opentelemetry/[email protected]` added as dev dependencies - `wrapRouter` modified to create decode and encode spans if `@opentelemetry/api` is installed - if `@opentelemetry/api` is not installed, spans are not created - `onDecodeError` option removed. Please use `decodeErrorFormatter` and `getDecodeErrorStatusCode` - `decodeErrorFormatter` takes in an array of `ValidationError`s and a `WrappedRequest`, returning a `Json` object. - `getDecodeErrorStatusCode` takes in an array of `ValidationError`s and a `WrappedRequest`, returning a number. - `onEncodeError` option removed. Please use `encodeErrorFormatter` and `getEncodeErrorStatusCode` - `encodeErrorFormatter` takes in an error and a `WrappedRequest`, returning a `Json` object. - `getEncodeErrorStatusCode` takes in an error and a `WrappedRequest`, returning a number. - `typed-express-router` now handles the sending of the http response when there is a decode or encode error - `express-wrapper` - `routerForApiSpec` modified to pass in new parameters `decodeErrorFormatter`, `getDecodeErrorStatusCode`, `encodeErrorFormatter`, and `getEncodeErrorStatusCode` - These new parameters can also be customized by modifying the props passed into the function (see `CreateRouterProps`) BREAKING CHANGE: `onDecodeError` and `onEncodeError` have been removed. Please use `decodeErrorFormatter`, `getDecodeErrorStatusCode`, `encodeErrorFormatter`, and `getEncodeErrorStatusCode`

ericcrosson-bitgo

Adds opentelemetry support for typed-express-router

Exemplary work, @starfy84!! 🚀

ericcrosson-bitgo · 2025-07-18T17:21:52Z

Double-checked that beta and master still point to the same commit:

$ git log
*   a203328 (HEAD -> beta, origin/master, origin/beta, origin/HEAD, master) Merge pull request #1043 from ericcrosson-bitgo/DX-1472-chore-transfer-code-ownership-to-devex - Eric Crosson, 4 weeks ago

github-actions · 2025-07-18T17:23:33Z

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@beta dist-tag)

Your semantic-release bot 📦🚀

github-actions · 2025-07-18T17:25:15Z

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@beta dist-tag)

Your semantic-release bot 📦🚀

kaustubhbitgo · 2025-07-31T07:07:39Z

@starfy84 Can we update README.md on deprecation of onDecodeError methods. I was adding typed routes to express but didn't realize they are deprecated when I was following README?

starfy84 · 2025-07-31T13:49:07Z

@starfy84 Can we update README.md on deprecation of onDecodeError methods. I was adding typed routes to express but didn't realize they are deprecated when I was following README?

Will do! Thanks for letting me know.

github-actions · 2025-08-01T18:57:59Z

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

github-actions · 2025-08-01T18:58:23Z

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

github-actions · 2025-09-24T18:29:04Z

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

starfy84 self-assigned this Jun 25, 2025

starfy84 force-pushed the DX-1473-create-otel-wrapper-for-typed-express-router branch 2 times, most recently from 9c177cd to 0bff27e Compare June 26, 2025 15:07

starfy84 marked this pull request as ready for review June 26, 2025 15:15

starfy84 requested a review from a team as a code owner June 26, 2025 15:15

ericcrosson-bitgo requested changes Jun 27, 2025

View reviewed changes

github-advanced-security bot found potential problems Jun 30, 2025

View reviewed changes

starfy84 force-pushed the DX-1473-create-otel-wrapper-for-typed-express-router branch from 43daf20 to 3781856 Compare June 30, 2025 15:38

github-advanced-security bot found potential problems Jun 30, 2025

View reviewed changes

packages/opentelemetry-instrumentation-typed-express-router/test/integration.test.ts Fixed Show fixed Hide fixed

packages/opentelemetry-instrumentation-typed-express-router/test/integration.test.ts Fixed Show fixed Hide fixed

ericcrosson-bitgo marked this pull request as draft June 30, 2025 20:15

github-advanced-security bot found potential problems Jul 2, 2025

View reviewed changes

github-advanced-security bot found potential problems Jul 7, 2025

View reviewed changes

packages/opentelemetry-instrumentation-typed-express-router/src/instrumentation.ts Fixed Show fixed Hide fixed

starfy84 force-pushed the DX-1473-create-otel-wrapper-for-typed-express-router branch 4 times, most recently from 6cd264b to 11fc7f0 Compare July 9, 2025 16:24

starfy84 commented Jul 9, 2025

View reviewed changes

starfy84 force-pushed the DX-1473-create-otel-wrapper-for-typed-express-router branch from f804fb4 to 0158ca3 Compare July 9, 2025 16:28

starfy84 marked this pull request as ready for review July 9, 2025 16:30

starfy84 requested a review from ericcrosson-bitgo July 9, 2025 16:30

starfy84 changed the base branch from master to beta July 9, 2025 19:55

ericcrosson-bitgo marked this pull request as draft July 10, 2025 21:38

starfy84 force-pushed the DX-1473-create-otel-wrapper-for-typed-express-router branch from a224511 to ab8a123 Compare July 15, 2025 15:19

starfy84 commented Jul 15, 2025

View reviewed changes

packages/express-wrapper/src/request.ts Outdated Show resolved Hide resolved

ericcrosson-bitgo reviewed Jul 15, 2025

View reviewed changes

packages/typed-express-router/src/errors.ts Outdated Show resolved Hide resolved

ericcrosson-bitgo reviewed Jul 17, 2025

View reviewed changes

packages/typed-express-router/src/types.ts Outdated Show resolved Hide resolved

starfy84 force-pushed the DX-1473-create-otel-wrapper-for-typed-express-router branch 2 times, most recently from 3cfad4e to 4248ffd Compare July 17, 2025 18:52

starfy84 marked this pull request as ready for review July 17, 2025 18:59

ericcrosson-bitgo reviewed Jul 17, 2025

View reviewed changes

packages/typed-express-router/test/telemetry.test.ts Outdated Show resolved Hide resolved

starfy84 force-pushed the DX-1473-create-otel-wrapper-for-typed-express-router branch from 090eaed to 08e1817 Compare July 18, 2025 16:20

starfy84 force-pushed the DX-1473-create-otel-wrapper-for-typed-express-router branch from 08e1817 to 296a92e Compare July 18, 2025 16:44

ericcrosson-bitgo approved these changes Jul 18, 2025

View reviewed changes

ericcrosson-bitgo merged commit 872e93c into beta Jul 18, 2025
4 checks passed

ericcrosson-bitgo deleted the DX-1473-create-otel-wrapper-for-typed-express-router branch July 18, 2025 17:21

github-actions bot added the released on @beta label Jul 18, 2025

starfy84 mentioned this pull request Jul 31, 2025

docs: update README.md with information regarding new error formatters #1053

Merged

github-actions bot added the released label Aug 1, 2025

feat(opentelemetry): create otel instrumentation for typed-express-router #1044

feat(opentelemetry): create otel instrumentation for typed-express-router #1044

Uh oh!

Conversation

starfy84 commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ericcrosson-bitgo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ericcrosson-bitgo Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ericcrosson-bitgo Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

starfy84 Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ericcrosson-bitgo left a comment

Choose a reason for hiding this comment

Uh oh!

ericcrosson-bitgo commented Jul 18, 2025

Uh oh!

Uh oh!

github-actions bot commented Jul 18, 2025

Uh oh!

github-actions bot commented Jul 18, 2025

Uh oh!

kaustubhbitgo commented Jul 31, 2025

Uh oh!

starfy84 commented Jul 31, 2025

Uh oh!

github-actions bot commented Aug 1, 2025

Uh oh!

github-actions bot commented Aug 1, 2025

Uh oh!

github-actions bot commented Sep 24, 2025

Uh oh!

Reviewers

starfy84 commented Jun 25, 2025 •

edited

Loading

ericcrosson-bitgo Jul 17, 2025 •

edited

Loading