feat(react-start-api-routes): Write the matched route path as unenumerable to request object

[lforst]

This comes a bit out of nowhere but I am currently building the official Sentry SDK for TSStart and one thing that is really important for tracing/spans/opentelemetry is being able to group stuff by the parameterized route.

I haven't found a nice way in the public API yet to allow reading the parameterized route in a central location that doesn't require users to wrap every single route they create.

This is probably a bit of a hack but it seemed unintrusive enough for me (since it is unenumerable) and is getting the job done wonderfully.

[birkskyum]

@lforst , just an FYI there will likely be tanstack start for multiple frameworks, in case the sentry sdk is react-specific you might want to add react- somehwere in the package name. See i.e. early work here on a solid version.

[schiller-manuel]

for API route I hope we have a single package in the future.

w.r.t. to the sentry integration: I think it would make sense to offer a generic customization point where sentry could hook in. then this request tag would solely live in e.g. sentry

[lforst]

@lforst , just an FYI there will likely be tanstack start for multiple frameworks, in case the sentry sdk is react-specific you might want to add react- somehwere in the package name. See i.e. early work here on a solid version.

That's a great point. I somehow missed that tss will be generic. I'll publish a package with an updated name. Thanks!

[lforst]

for API route I hope we have a single package in the future.

That's dope 👌

w.r.t. to the sentry integration: I think it would make sense to offer a generic customization point where sentry could hook in. then this request tag would solely live in e.g. sentry

Just gauging interest in this change in general, would it make sense to add this interim until there is a proper public API? I would be like 0% mad if you all decide to break this change when you switch over to a generic customization.

I am also happy to add a hook somewhere if you give me some guidance on how you would want it to look like 😄 This is kinda super duper mission critical for Sentry so I am happy to sacrifice some time on this.

[birkskyum]

for API route I hope we have a single package in the future.

That's dope 👌

@lforst the future is now.

https://npmjs.com/@tanstack/start-api-routes

[lforst]

Noice. How shall we proceed here?

[birkskyum]

This PR would have to be rebased, so the change is applied instead to the shared start-api-routes package

[lforst]

This PR would have to be rebased, so the change is applied instead to the shared start-api-routes package

rebased 👍

[nx-cloud]

View your CI Pipeline Execution ↗ for commit 43ad644.

Command	Status	Duration	Result
nx affected --targets=test:eslint,test:unit,tes...	✅ Succeeded	1m	View ↗

---

☁️ Nx Cloud last updated this comment at 2025-03-11 10:38:18 UTC

[schiller-manuel]

we'll be adding middleware support for API routes which should cover this use case

[lforst]

we'll be adding middleware support for API routes which should cover this use case

Is there a timeline for that?

[lforst]

Discussed on Discord w/ @schiller-manuel that this change will likely become obsolete with global api middlewares.