[WEB-3133] fix: admin login when the user is not present

[pablohashescobar]

Description

fix: admin user login when the user is not present throwing 500 error.

Type of Change

• Bug fix (non-breaking change which fixes an issue)

Summary by CodeRabbit

• Bug Fixes
  • Improved authentication error handling for admin sign-in process
  • Enhanced user existence and activation status validation
  • Clarified error messages for non-existent or deactivated admin users

[coderabbitai]

Walkthrough

The pull request modifies the error handling logic in the InstanceAdminSignInEndpoint class within the admin sign-in process. The key change involves reordering the validation checks for user existence and active status. Previously, the code checked user activation before existence, but now it first verifies if the user exists. If the user does not exist, an AuthenticationException is raised with a specific error code. If the user exists but is not active, another AuthenticationException is raised with a different error code.

Changes

File	Change Summary
apiserver/plane/license/api/views/admin.py	Refactored user authentication error handling in InstanceAdminSignInEndpoint

Suggested reviewers

• sriramveeraghanta

Possibly related PRs

• fix: project join for admin and members #6097: Modifications to error handling and permission checks in user validation and status checks

Poem

🐰 A Rabbit's Ode to Error Flow 🔍

Existence first, then active state,
Authentication's logical gait,
Exceptions raised with crystal clear,
No user? No entry, that's sincere!
A dance of checks, precise and neat,
Where logic and security meet 🛡️

Finishing Touches

• 📝 Generate Docstrings (Beta)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @coderabbitai modularize this function.
• 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 generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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. (Beta)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

apiserver/plane/license/api/views/admin.py (1)

Line range hint 306-314: LGTM! Consider including email in error payload.

The reordering of validation checks is correct, and the error message is now specific to the deactivated state. However, for consistency with other error responses in this endpoint, consider including the email in the error payload.

 if not user.is_active:
     exc = AuthenticationException(
         error_code=AUTHENTICATION_ERROR_CODES["ADMIN_USER_DEACTIVATED"],
         error_message="ADMIN_USER_DEACTIVATED",
+        payload={"email": email},
     )

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0eb97e3 and 3fbef7e.

📒 Files selected for processing (1)

• apiserver/plane/license/api/views/admin.py (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: lint-apiserver
• GitHub Check: Analyze (javascript)
• GitHub Check: Analyze (python)

🔇 Additional comments (1)

apiserver/plane/license/api/views/admin.py (1)

293-305: LGTM! Improved error handling for non-existent users.

The code now explicitly checks for user existence first and returns a clear error message, which aligns with the PR objective to fix the 500 error when the user is not present.

[makeplane]

Pull Request Linked with Plane Issues

Comment Automatically Generated by Plane