Skip to content

Conversation

@evansharp
Copy link

@evansharp evansharp commented Apr 12, 2025

A quick edit to the library class to use the correct google library property name so that only the first name is populated into the users table field for first name.

Addresses #177.

Summary by CodeRabbit

  • Bug Fixes
    • Improved the retrieval of first name data during Google login to ensure accurate display of user details.

@coderabbitai
Copy link

coderabbitai bot commented Apr 12, 2025

Walkthrough

This pull request updates the setColumnsName method within the GoogleOAuth class. The change involves modifying how the first name is extracted from the user information. Instead of retrieving the first name from $userInfo->name, the method now assigns it from $userInfo->given_name. All other parts of the method, including the handling for last name, avatar fields, and subsequent processes, remain unchanged.

Changes

File Summary
src/Libraries/GoogleOAuth.php Changed the first name assignment in the setColumnsName method from $userInfo->name to $userInfo->given_name.

Poem

I’m a hopping rabbit with a coder’s cheer,
Skipping 'name' for 'given_name' is now crystal clear.
In the realm of OAuth, my steps are light,
New data flows shining bright like a light.
With each change, I dance in the fields of code,
Celebrating small steps on this joyful road!

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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

🧹 Nitpick comments (2)
src/Libraries/GoogleOAuth.php (2)

95-119: Consider handling missing properties in the user info response.

While the property name correction is good, I notice the method doesn't validate if the expected properties exist in the $userInfo object before trying to access them. Only family_name is handled with the null coalescing operator.

protected function setColumnsName(string $nameOfProcess, $userInfo): array
{
    if ($nameOfProcess === 'syncingUserInfo') {
        return [
-           $this->config->usersColumnsName['first_name'] => $userInfo->given_name,
-           $this->config->usersColumnsName['last_name']  => $userInfo->family_name ?? null,
-           $this->config->usersColumnsName['avatar']     => $userInfo->picture,
+           $this->config->usersColumnsName['first_name'] => $userInfo->given_name ?? null,
+           $this->config->usersColumnsName['last_name']  => $userInfo->family_name ?? null,
+           $this->config->usersColumnsName['avatar']     => $userInfo->picture ?? null,
        ];
    }

    if ($nameOfProcess === 'newUser') {
        return [
            // users tbl                                    // OAuth
            'username'                                    => $userInfo->email,
            'email'                                       => $userInfo->email,
            'password'                                    => random_string('crypto', 32),
            'active'                                      => $userInfo->email_verified,
-           $this->config->usersColumnsName['first_name'] => $userInfo->given_name,
-           $this->config->usersColumnsName['last_name']  => $userInfo->family_name ?? null,
-           $this->config->usersColumnsName['avatar']     => $userInfo->picture,
+           $this->config->usersColumnsName['first_name'] => $userInfo->given_name ?? null,
+           $this->config->usersColumnsName['last_name']  => $userInfo->family_name ?? null,
+           $this->config->usersColumnsName['avatar']     => $userInfo->picture ?? null,
        ];
    }

    return [];
}

68-70: Consider better error handling for exceptions.

The current approach of using exit($e->getMessage()) immediately terminates the script and may expose sensitive error information to end users. Consider implementing more robust error handling, such as logging the error and providing a user-friendly message.

} catch (Exception $e) {
-   exit($e->getMessage());
+   log_message('error', 'Google OAuth error: ' . $e->getMessage());
+   throw new Exception('Failed to connect to Google OAuth service. Please try again later.');
}

Also applies to: 88-90

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 82f07b6 and 3f7d56d.

📒 Files selected for processing (1)
  • src/Libraries/GoogleOAuth.php (1 hunks)
🔇 Additional comments (1)
src/Libraries/GoogleOAuth.php (1)

99-99: Good fix: Using the correct property for first name data.

The change from using $userInfo->name to $userInfo->given_name correctly aligns with Google's OAuth2 user info response format. This ensures that only the first name is stored in the corresponding database field, fixing issue #177. The approach is consistent with line 112 which was already using given_name for the 'newUser' process.

@evansharp evansharp closed this Apr 12, 2025
@evansharp evansharp deleted the fix-for-177 branch April 12, 2025 16:43
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.

1 participant