Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves observability of the ongoing Hawk → Bearer FxA-token migration by adding a bounded-cardinality path tag (templated route path) to the auth.strategy.used StatsD counter, enabling per-endpoint adoption tracking.
Changes:
- Tag
auth.strategy.usedwithpath:${req.route?.path ?? 'unknown'}in both Hawk and Bearer FxA-token auth schemes. - Update Hawk and Bearer auth-scheme unit tests to assert the new
pathtag is included in the emitted metric.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| packages/fxa-auth-server/lib/routes/auth-schemes/hawk-fxa-token.js | Adds path tag to the auth.strategy.used increment for Hawk auth. |
| packages/fxa-auth-server/lib/routes/auth-schemes/bearer-fxa-token.js | Adds path tag to the auth.strategy.used increment for Bearer auth. |
| packages/fxa-auth-server/lib/routes/auth-schemes/hawk-fxa-token.spec.ts | Extends metric assertion to include the new path tag. |
| packages/fxa-auth-server/lib/routes/auth-schemes/bearer-fxa-token.spec.ts | Extends metric assertion to include the new path tag. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
188
to
192
| expect(statsd.increment).toHaveBeenCalledWith('auth.strategy.used', [ | ||
| 'scheme:hawk', | ||
| 'kind:sessionToken', | ||
| 'path:/v1/account/devices', | ||
| ]); |
Comment on lines
331
to
335
| expect(statsd.increment).toHaveBeenCalledWith('auth.strategy.used', [ | ||
| 'scheme:bearer', | ||
| 'kind:sessionToken', | ||
| 'path:/v1/account/devices', | ||
| ]); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Because
auth.strategy.usedcounter carried onlyschemeandkind, so adoption couldn't be broken down by route.This pull request
pathtag toauth.strategy.usedin the Hawk and Bearer FxA-token schemes (hawk-fxa-token.js,bearer-fxa-token.js).req.route.path(templated route, never the raw URL) so cardinality stays bounded at ~2 schemes × authed routes.path:unknownwhen the route is unavailable.hawk-fxa-token.spec.tsandbearer-fxa-token.spec.tsto assert the new tag.Issue that this pull request solves
Closes: https://mozilla-hub.atlassian.net/browse/FXA-13948
Checklist
Other information