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 user info link to user info #1899

Merged
merged 1 commit into from
Jan 2, 2025
Merged

Conversation

lovelgeorge99
Copy link
Contributor

@lovelgeorge99 lovelgeorge99 commented Jan 2, 2025

Issue: Giveth/giveth-dapps-v2#4493 (comment)

the profileUrl is changed to https://api.linkedin.com/v2/userinfo from https://api.linkedin.com/v2/me and also the response type is changed

https://learn.microsoft.com/en-us/linkedin/consumer/integrations/self-serve/sign-in-with-linkedin-v2?context=linkedin%2Fconsumer%2Fcontext#api-request-to-retreive-member-details

Summary by CodeRabbit

  • New Features

    • Updated LinkedIn OAuth2 authentication to request expanded permissions
    • Improved user information retrieval with updated LinkedIn API endpoint
  • Bug Fixes

    • Adjusted user information extraction to match new LinkedIn API response format

@lovelgeorge99 lovelgeorge99 requested a review from kkatusic January 2, 2025 01:38
Copy link
Contributor

coderabbitai bot commented Jan 2, 2025

Walkthrough

The pull request updates the LinkedIn OAuth2 adapter to align with the latest LinkedIn API specifications. The changes primarily focus on modifying the authentication scope and user information retrieval process. The getAuthUrl method now requests broader permissions by expanding the scope, and the getUserInfoByOauth2Code method has been updated to use a new endpoint and handle a revised user information response format.

Changes

File Change Summary
src/adapters/oauth2/linkedinAdapter.ts - Updated OAuth2 scope from 'profile' to 'openid profile email'
- Changed user info endpoint from /v2/me to /v2/userinfo
- Modified user information extraction logic
- Updated username extraction to use sub instead of id
- Simplified name construction with fallback mechanism

Sequence Diagram

sequenceDiagram
    participant Client
    participant LinkedinAdapter
    participant LinkedinAPI
    
    Client->>LinkedinAdapter: Request Auth URL
    LinkedinAdapter-->>Client: Generate URL with expanded scope
    
    Client->>LinkedinAPI: Authorize with new scope
    LinkedinAPI-->>Client: Return OAuth2 Code
    
    Client->>LinkedinAdapter: Get User Info with Code
    LinkedinAdapter->>LinkedinAPI: Fetch User Info from new endpoint
    LinkedinAPI-->>LinkedinAdapter: Return User Details
    LinkedinAdapter-->>Client: Processed User Information
Loading

Possibly related PRs

Suggested reviewers

  • kkatusic

Poem

🐰 OAuth dance with LinkedIn's grace,
Scopes expanded, a broader embrace!
From profile to email, we now explore,
A rabbit's leap through the API's door 🚀
New endpoints sing, user data unfurled! 🌟


📜 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 b930c80 and 3e62ce6.

📒 Files selected for processing (1)
  • src/adapters/oauth2/linkedinAdapter.ts (2 hunks)
🔇 Additional comments (5)
src/adapters/oauth2/linkedinAdapter.ts (5)

22-22: Confirm scope necessity and user consent.

Changing the scope from a basic 'profile' to 'openid profile email' significantly increases the permissions requested. Make sure this aligns with LinkedIn's updated guidelines and that users are made aware of the data being requested.


60-62: Endpoint update aligns with new LinkedIn API requirements.

Switching from https://api.linkedin.com/v2/me to https://api.linkedin.com/v2/userinfo accurately follows LinkedIn's updated documentation. Good job keeping the code in sync with the official guidelines.


69-79: Helpful in-code documentation.

Including the sample response structure in comments is excellent for future reference and maintainability.


81-82: OpenID standard username field.

Using meResult.data.sub for the username aligns with OpenID specifications. This looks correct for an OpenID-based flow.


83-85: Proper fallback logic for name fields.

The fallback to given_name and family_name is well-implemented, ensuring the name field is always populated. This is a good approach to handle partial or missing fields from external APIs.


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>, 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.

Copy link
Collaborator

@CarlosQ96 CarlosQ96 left a comment

Choose a reason for hiding this comment

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

LGTM thanks Lovel

@lovelgeorge99 lovelgeorge99 merged commit c74dc3b into staging Jan 2, 2025
5 checks passed
@lovelgeorge99 lovelgeorge99 deleted the fix-linkedin-scope branch January 2, 2025 14:37
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.

2 participants