Implement User ID from Auth Handling

[keitwb]

This was kind of halfway done before but this should get it closer.

Type of change

• Refactor
• New feature
• Bug fix
• CVE fix
• Optimization
• Documentation Update
• Configuration Update
• Bump-up service version
• Bump-up dependent library
• Bump-up library or tool used for development (does not change the final image)
• CI configuration change
• Konflux configuration change
• Unit tests improvement
• Integration tests improvement
• End to end tests improvement

Checklist before requesting a review

• [ X] I have performed a self-review of my code.
• PR has passed all pre-merge test jobs.
• If it is a core feature, I have added thorough tests.

Summary by CodeRabbit

• Refactor

  • Improved type safety and clarity in authentication handling across feedback, query, and streaming query endpoints.
  • Streamlined user ID extraction by directly unpacking authentication tuples.
  • Introduced descriptive type aliases for authentication data.

• Tests

  • Updated endpoint tests to align with new authentication handling, removing unnecessary mocks and adapting to direct tuple unpacking.
  • Removed obsolete test for user ID retrieval utility.

[coderabbitai]

Walkthrough

The changes refactor authentication handling across several endpoint modules by introducing explicit type aliases (UserID, UserName, Token, and AuthTuple) and updating function signatures to use these types. The pattern for extracting user IDs is standardized by unpacking the AuthTuple directly, eliminating the retrieve_user_id utility function. Corresponding updates are made in unit tests to align with the new authentication handling.

Changes

Cohort / File(s)	Change Summary
Endpoint Authentication Refactor src/app/endpoints/feedback.py, src/app/endpoints/query.py, src/app/endpoints/streaming_query.py	Updated endpoint handler signatures to use Annotated[AuthTuple, Depends(auth_dependency)] for the auth parameter. User ID extraction now directly unpacks from auth tuple. Imports updated accordingly.
Auth Type Aliases src/auth/interface.py	Added type aliases UserID, UserName, Token, and AuthTuple. Updated AuthInterface.__call__ return type to AuthTuple.
User ID Utility Removal src/utils/common.py, tests/unit/utils/test_common.py	Removed the retrieve_user_id function and its associated test. Cleaned up imports.
Feedback Endpoint Tests Update tests/unit/app/endpoints/test_feedback.py	Removed mocking of retrieve_user_id. Tests now pass explicit auth tuple to handlers.
Query Endpoint Tests Update tests/unit/app/endpoints/test_query.py	Updated tests to pass explicit auth tuple and expect the correct user ID in mocks.
Streaming Query Endpoint Tests Update tests/unit/app/endpoints/test_streaming_query.py	Removed all mocking of retrieve_user_id and updated assertions to match new direct user ID handling.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Endpoint
    participant AuthDependency
    participant Service

    Client->>Endpoint: Send request (with auth)
    Endpoint->>AuthDependency: Resolve auth (returns AuthTuple)
    Endpoint->>Endpoint: Unpack (user_id, _, _) = auth
    Endpoint->>Service: Call business logic with user_id
    Service-->>Endpoint: Return result
    Endpoint-->>Client: Return response

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• Unpack auth tuple to get token #220: Related changes in handling the auth tuple in endpoint handlers, focusing on unpacking and token extraction downstream.

Suggested reviewers

• tisnik

Poem

A tuple of auth, so tidy and neat,
No more old functions, no tricks to repeat.
Type aliases dancing, tests in a row,
User IDs unpacked—let clarity flow!
With paws on the keyboard, this rabbit’s delight:
Refactored authentication, now shining bright.
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 388b3b5 and 8a6466d.

📒 Files selected for processing (9)

• src/app/endpoints/feedback.py (3 hunks)
• src/app/endpoints/query.py (5 hunks)
• src/app/endpoints/streaming_query.py (5 hunks)
• src/auth/interface.py (1 hunks)
• src/utils/common.py (1 hunks)
• tests/unit/app/endpoints/test_feedback.py (2 hunks)
• tests/unit/app/endpoints/test_query.py (2 hunks)
• tests/unit/app/endpoints/test_streaming_query.py (1 hunks)
• tests/unit/utils/test_common.py (0 hunks)

💤 Files with no reviewable changes (1)

• tests/unit/utils/test_common.py

🚧 Files skipped from review as they are similar to previous changes (8)

• src/auth/interface.py
• src/utils/common.py
• tests/unit/app/endpoints/test_feedback.py
• tests/unit/app/endpoints/test_query.py
• src/app/endpoints/feedback.py
• src/app/endpoints/streaming_query.py
• src/app/endpoints/query.py
• tests/unit/app/endpoints/test_streaming_query.py

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[eranco74]

/cc @omertuc

[eranco74]

/lgtm

[umago]

LGTM!

[tisnik]

LGTM

[tisnik]

@keitwb please resolve conflict, then we are ok to merge. Thank you in advance

[keitwb]

@tisnik ok, should be good now.