Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: Speaker name in Talk is overwritten #279

Merged

Conversation

hongquan
Copy link
Member

@hongquan hongquan commented Feb 24, 2025

Fixes #278

Check if user name has a value, before update it with the value from JWT when logging in.

How has this been tested?

Before logging out, speaker name is "Quan Outlook"
image

Logging out
image

Logging in again: The name is still as before.
image

Checklist

  • I have added tests to cover my changes.

Copy link

sourcery-ai bot commented Feb 24, 2025

Reviewer's Guide by Sourcery

This pull request fixes an issue where the speaker name was being overwritten with the value from the JWT upon login, even if the user already had a name set. The fix ensures that the user's name is only updated if it is not already set. Logging was added to track the JWT payload and when user data is saved.

Sequence diagram for user login with name update

sequenceDiagram
    participant User
    participant JWT

    User->>JWT: Logs in
    JWT-->>User: Returns payload (email, name, etc.)
    User->>User: Checks if user exists with email
    alt User exists
        User->>User: Checks if user.name is set
        alt user.name is not set and JWT name is present
            User->>User: Updates user.name with JWT name
        end
    else User does not exist
        User->>User: Creates new user
        User->>User: Sets user.name with JWT name
    end
    User->>User: Sets user attributes (is_active, is_staff, locale, timezone, code)
    User->>User: Saves user data
    User->>User: Logs in user
Loading

File-Level Changes

Change Details Files
Prevent overwriting the speaker name with the value from the JWT upon login if the user already has a name set.
  • Added a check to see if the user's name is already set before updating it with the name from the JWT payload.
  • Added logging to track the JWT payload and when user data is saved.
src/pretalx/common/middleware/event.py

Possibly linked issues


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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

Copy link

@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 @hongquan - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider extracting the user update logic into a separate function for better readability.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟡 Security: 1 issue found
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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.

Copy link
Member

@norbusan norbusan left a comment

Choose a reason for hiding this comment

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

Besides the comment about logging, looks fine

@mariobehling mariobehling merged commit 15a400f into fossasia:development Feb 26, 2025
6 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Ensure public profile name in speaker profile is consistent
3 participants