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: Ensure banned users are not allowed to log in. #167

Merged
merged 2 commits into from
Sep 9, 2024

Conversation

warcooft
Copy link
Contributor

@warcooft warcooft commented Sep 8, 2024

I'm curious, why banned users still can log in.

Summary by CodeRabbit

  • New Features

    • Enhanced user authentication process to check for banned users before login attempts.
    • Improved logic to prevent self-registration for existing users.
  • Bug Fixes

    • Resolved issues related to user existence checks during login, ensuring a smoother user experience.

Copy link

coderabbitai bot commented Sep 8, 2024

Walkthrough

The changes in the OAuthController class enhance the user authentication process by introducing a new private property to track user existence. The callBack method now checks if a user is banned and redirects accordingly. Additionally, the logic for creating new users has been refined to prevent self-registration if the user already exists, ensuring a more streamlined control flow during the login attempt.

Changes

File Change Summary
src/Controllers/OAuthController.php Added a private nullable User property $userExist and modified the callBack method to handle user existence and banned status checks.

Possibly related PRs

  • feat: Returns the user's email if the account is not found.  #133: This PR modifies the callBack method in the OAuthController class to enhance error messages related to account not found scenarios, which is directly relevant to the changes made in the main PR that also involves modifications to the callBack method in the same class.
  • feat: Handles deauthentication actions by users. #134: This PR introduces a new constant and modifies the callBack method in the OAuthController class to handle access denial scenarios, which is related to the overall error handling improvements made in the main PR.

Suggested labels

enhancement

Poem

In the meadow where bunnies play,
A change was made to brighten the day.
With checks for users, both lost and found,
A safer login now hops around! 🐰✨
Banned or free, all will see,
A joyful dance in harmony!


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
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 30fbd3d and 3c3b702.

Files selected for processing (1)
  • src/Controllers/OAuthController.php (4 hunks)
Additional comments not posted (3)
src/Controllers/OAuthController.php (3)

25-25: Property declaration is correct.

The declaration of the new private property $userExist as a nullable User type is appropriate for its intended use.


148-149: Correct implementation of user existence check.

The method checkExistenceUser correctly checks for the user's existence and sets the $userExist property accordingly.


113-115: Ensure proper handling of banned users.

The logic to check if a user is banned and redirect them is correctly implemented. However, it's important to ensure that $userExist is properly set before this check to avoid null reference errors.

Run the following script to verify that $userExist is always set before being accessed:

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3c3b702 and 8b331e5.

Files selected for processing (1)
  • src/Controllers/OAuthController.php (4 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/Controllers/OAuthController.php

@warcooft warcooft changed the title feat: Ensure banned users are not allowed to log in. fix: Ensure banned users are not allowed to log in. Sep 9, 2024
@datamweb datamweb added the new feature PRs for new features label Sep 9, 2024
@datamweb
Copy link
Owner

datamweb commented Sep 9, 2024

I'm curious, why banned users still can log in.

Hi @warcooft,

The user banning feature was added in Shield v1.0.0-beta.4. However, I believe that Shield OAuth was released before version v1.0.0-beta.4.

Copy link
Owner

@datamweb datamweb left a comment

Choose a reason for hiding this comment

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

LGTM!
Thank you for submitting this PR and for your good communication.

@datamweb datamweb merged commit 69f4687 into datamweb:develop Sep 9, 2024
11 checks passed
@warcooft warcooft deleted the feat-check_user_banned branch September 9, 2024 05:52
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new feature PRs for new features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants