Skip to content

Conversation

@JoshuaSBrown
Copy link
Collaborator

@JoshuaSBrown JoshuaSBrown commented Dec 5, 2025

Summary by Sourcery

Enhancements:

  • Capture only selected user fields for request logging instead of logging the full updated user object.

@JoshuaSBrown JoshuaSBrown self-assigned this Dec 5, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 5, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Refactors the user update route logging so that only a selected subset of non-sensitive user fields is included in the log metadata instead of the full updated user object.

Sequence diagram for updated user update route logging

sequenceDiagram
    actor Client
    participant UserRouter
    participant Database
    participant Logger

    Client->>UserRouter: GET /update
    UserRouter->>Database: _executeTransaction(update user)
    Database-->>UserRouter: user.new (updated user)
    UserRouter->>UserRouter: delete sensitive fields from user.new
    UserRouter->>UserRouter: build extra_log_info
    UserRouter-->>Client: 200 OK with result [user.new]
    UserRouter->>Logger: logRequestSuccess(extra_log_info)

    Note over UserRouter,Logger: On error path
    Client->>UserRouter: GET /update
    UserRouter->>Database: _executeTransaction(update user)
    Database--xUserRouter: error
    UserRouter->>UserRouter: extra_log_info may be null or partial
    UserRouter->>Logger: logRequestFailure(extra_log_info, error)
    UserRouter->>Client: error response
Loading

File-Level Changes

Change Details Files
Limit logged user data in the update route to a small, explicitly defined subset of fields.
  • Introduce an extra_log_info variable alongside the existing result variable in the update handler
  • After a successful user update, construct an object containing only is_admin, max_coll, max_proj, and max_sav_qry from the updated user
  • Pass extra_log_info instead of the full result object to logger.logRequestSuccess and logger.logRequestFailure
core/database/foxx/api/user_router.js

Possibly linked issues

  • #[Refactor] - user update logs are leaking sensitive information: PR changes user update logging to only log specific allowed fields, addressing sensitive information leakage.

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@JoshuaSBrown JoshuaSBrown added Component: Foxx Foxx Arango micro services. Priority: High Highest priority labels Dec 5, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@JoshuaSBrown JoshuaSBrown linked an issue Dec 5, 2025 that may be closed by this pull request
@nedvedba nedvedba merged commit dde50e6 into staging Dec 8, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: Foxx Foxx Arango micro services. Priority: High Highest priority

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Refactor] - user update logs are leaking sensitive information

3 participants