refactor: user tokens expiring route. #1806
Open
Conversation
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
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideRefactors the Sequence diagram for refactored GET /token/get/expiring routesequenceDiagram
actor Client
participant UserRouter
participant Logger
participant Database
participant Response
Client->>UserRouter: GET /token/get/expiring?expires_in&client
Note over UserRouter: Build desc = "User access tokens expiring in {expires_in} seconds"
UserRouter->>Logger: logRequestStarted(client=req.queryParams.client, correlationId, httpVerb=GET, routePath=/token/get/expiring, status=Started, description=desc)
alt Successful query
UserRouter->>Database: _query(exp = now_in_seconds + expires_in)
Database-->>UserRouter: results (cursor)
UserRouter->>UserRouter: extra_log_info = results.toArray()
UserRouter-->>Response: send(results)
UserRouter->>Logger: logRequestSuccess(client=req.queryParams.client, correlationId, httpVerb=GET, routePath=/token/get/expiring, status=Success, description=desc, extra={expiring_token_count: extra_log_info.length})
else Query or processing error
UserRouter->>Logger: logRequestFailure(client=req.queryParams.client, correlationId, httpVerb=GET, routePath=/token/get/expiring, status=Failure, description=desc, extra={expiring_token_count: extra_log_info.length}, error=e)
UserRouter-->>Response: handleException(e)
end
File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- Calling
results.toArray()for logging afterres.send(results)may consume the cursor and change what the client receives; consider either sending the array (and logging its length) or using a cheap count-only query/log field instead. - If
expires_inis required for this route, it would be safer to validate and coercereq.queryParams.expires_into a number up front and fail fast on missing/invalid values rather than interpolating it directly into the description and query parameter.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Calling `results.toArray()` for logging after `res.send(results)` may consume the cursor and change what the client receives; consider either sending the array (and logging its length) or using a cheap count-only query/log field instead.
- If `expires_in` is required for this route, it would be safer to validate and coerce `req.queryParams.expires_in` to a number up front and fail fast on missing/invalid values rather than interpolating it directly into the description and query parameter.
## Individual Comments
### Comment 1
<location> `core/database/foxx/api/user_router.js:1163-1170` </location>
<code_context>
});
- results = g_db._query(
+ const results = g_db._query(
"for i in u filter i.expiration != Null && i.expiration < @exp return {id:i._id,access:i.access,refresh:i.refresh,expiration:i.expiration}",
{
exp: Math.floor(Date.now() / 1000) + req.queryParams.expires_in,
},
);
res.send(results);
+ extra_log_info = results.toArray();
logger.logRequestSuccess({
- client: client?._id,
</code_context>
<issue_to_address>
**issue (bug_risk):** Avoid consuming the query cursor twice; materialize once before sending the response.
The handler sends the cursor directly with `res.send(results);` and then calls `results.toArray();`. If Foxx consumes the cursor during serialization, `toArray()` may fail or return an empty array, causing `expiring_token_count` logs to diverge from the actual response. To avoid this, materialize once and reuse:
```js
const cursor = g_db._query(/* ... */);
const results = cursor.toArray();
res.send(results);
extra_log_info = results;
```
This keeps the response and logging consistent and avoids double-consuming the cursor.
</issue_to_address>
### Comment 2
<location> `core/database/foxx/api/user_router.js:1155` </location>
<code_context>
try {
logger.logRequestStarted({
- client: user?._id,
+ client: req.queryParams.client,
correlationId: req.headers["x-correlation-id"],
httpVerb: "GET",
</code_context>
<issue_to_address>
**🚨 issue (security):** Logging `client` from a request query param may allow spoofed client identifiers.
Using `req.queryParams.client` lets any caller spoof the logged client id, which can corrupt audit trails. If `client` should reflect an authenticated user or trusted client, use an identifier from the auth context (e.g., user id, token subject, validated client id) or validate/normalize the query param before logging it.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
+1163
to
+1170
| const results = g_db._query( | ||
| "for i in u filter i.expiration != Null && i.expiration < @exp return {id:i._id,access:i.access,refresh:i.refresh,expiration:i.expiration}", | ||
| { | ||
| exp: Math.floor(Date.now() / 1000) + req.queryParams.expires_in, | ||
| }, | ||
| ); | ||
| res.send(results); | ||
| extra_log_info = results.toArray(); |
Contributor
There was a problem hiding this comment.
issue (bug_risk): Avoid consuming the query cursor twice; materialize once before sending the response.
The handler sends the cursor directly with res.send(results); and then calls results.toArray();. If Foxx consumes the cursor during serialization, toArray() may fail or return an empty array, causing expiring_token_count logs to diverge from the actual response. To avoid this, materialize once and reuse:
const cursor = g_db._query(/* ... */);
const results = cursor.toArray();
res.send(results);
extra_log_info = results;This keeps the response and logging consistent and avoids double-consuming the cursor.
| try { | ||
| logger.logRequestStarted({ | ||
| client: user?._id, | ||
| client: req.queryParams.client, |
Contributor
There was a problem hiding this comment.
🚨 issue (security): Logging client from a request query param may allow spoofed client identifiers.
Using req.queryParams.client lets any caller spoof the logged client id, which can corrupt audit trails. If client should reflect an authenticated user or trusted client, use an identifier from the auth context (e.g., user id, token subject, validated client id) or validate/normalize the query param before logging it.
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.
Ticket
Description
How Has This Been Tested?
Artifacts (if appropriate):
Tasks
Summary by Sourcery
Refine the user token expiring lookup endpoint logging and response handling.
Enhancements: