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 ban check for existing users #169

Merged
merged 1 commit into from
Sep 9, 2024

Conversation

warcooft
Copy link
Contributor

@warcooft warcooft commented Sep 9, 2024

follow up: #167

Since we don't use allow_register, I haven't had a chance to test its functionality.
As a result, the isBanned() check fails if allow_register config is set to true. This PR ensures that the check applies only to existing users.

Summary by CodeRabbit

  • Bug Fixes
    • Improved error handling in the OAuth callback process to prevent potential null reference errors when checking user status.

Copy link

coderabbitai bot commented Sep 9, 2024

Walkthrough

The pull request modifies the conditional logic in the callBack method of the OAuthController class. It adds a safeguard to check if the $this->userExist object is truthy before invoking the isBanned() method. This change aims to prevent potential null reference errors, ensuring the application can handle cases where the user existence check fails without altering the overall control flow.

Changes

Files Change Summary
src/Controllers/OAuthController.php Updated the conditional logic in the callBack method to check if $this->userExist is truthy before calling isBanned().

Possibly related PRs

Suggested labels

bug

Poem

🐰 In the code where logic flows,
A check was added, as everyone knows.
For users banned, the path is clear,
No more nulls to bring us fear!
With each small change, we hop along,
Making our code robust and strong! 🌟

Tip

New features

Walkthrough comment now includes:

  • Possibly related PRs: A list of potentially related PRs to help you recall past context.
  • Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file.

Notes:

  • Please share any feedback in the discussion post on our Discord.
  • Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

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 de7f4c3 and 1698421.

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

114-114: Good safeguard added to prevent null reference errors.

The addition of the check for $this->userExist before invoking isBanned() is a prudent change that prevents potential null reference errors and ensures that the ban check is only applied to existing users, aligning with the PR's objectives.

Please verify that $this->userExist is correctly assigned in all relevant parts of the code to ensure that this change functions as intended.

Verification successful

Verification successful: $this->userExist is correctly assigned.

The assignment of $this->userExist is confirmed in the OAuthController.php file, ensuring that the null check and subsequent isBanned() call are valid and will function as intended. The change is correctly implemented.

  • $this->userExist is assigned with $findUser, ensuring it is set before use.
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the assignment of `$this->userExist` in the codebase.

# Test: Search for the assignment of `$this->userExist`. Expect: Assignments are correct and consistent.
rg --type php '$this->userExist ='

Length of output: 36


Script:

#!/bin/bash
# Description: Search for any references to `$this->userExist` to understand its usage and assignment.

# Test: Search for all occurrences of `$this->userExist` in the codebase.
rg --type php '\$this->userExist'

Length of output: 391

@datamweb datamweb added the bug Something isn't working label Sep 9, 2024
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.

Thank you for fixing this issue. I’ve been occupied with another project recently, so I haven’t had a chance to review the previous PR myself. I appreciate the fix.

If there’s anything else that needs attention or if further review is required, please let me know.

@datamweb datamweb merged commit 2b1672e into datamweb:develop Sep 9, 2024
11 checks passed
@warcooft warcooft deleted the patch-oauth branch September 9, 2024 06:50
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants