feat: validate github organization during OAuth login

[SamuelTR20]

Description

A new functionality has been added to the existing OAuth2 authentication system. In addition to validating GitHub credentials, a new field for entering the Organization ID has been introduced. This field allows the system to verify whether the user belongs to the specified organization before granting access. If the user does not belong to the organization, access will be denied. If the Organization ID field is left empty, the behavior will remain the same as before, allowing access to any user with a valid GitHub account.

Type of Change

• [ ] Bug fix (non-breaking change which fixes an issue)
• [x] Feature (non-breaking change which adds functionality)
• [ ] Improvement (change that would cause existing functionality to not work as expected)
• [ ] Code refactoring
• [ ] Performance improvements
• [ ] Documentation update

Screenshots and Media (if applicable)

Before

After

Unauthorized

Test Scenarios

1. Case 1: User enters valid GitHub credentials and a valid Organization ID they belong to.

   • Expected Result: The user can log in successfully.

2. Case 2: User enters valid GitHub credentials but an Organization ID they do not belong to.

   • Expected Result: Access is denied.

3. Case 3: User enters valid GitHub credentials but does not provide an Organization ID.

   • Expected Result: The user can log in as before, without organization restrictions.

4. Case 4: User enters invalid GitHub credentials.

   • Expected Result: Access is denied, regardless of the Organization ID.

Summary by CodeRabbit

• New Features
  • Added a GitHub organization input in the authentication configuration.
  • Integrated organization membership validation into the GitHub OAuth flow with enhanced error messaging.
  • Enhanced configuration options by including an environment-based GitHub organization identifier.

[coderabbitai[bot]]

Walkthrough

The changes enhance GitHub authentication by integrating organization membership verification. A new configuration field, GITHUB_ORGANIZATION_ID, has been added to the authentication form (including default values, field definitions, and reset logic) and to the instance configuration. In the backend, a new error code "GITHUB_USER_NOT_IN_ORG": 5122 is introduced for handling organization membership issues. The GitHub OAuth provider now includes new variables, scope adjustments, and a method (is_user_in_organization) to verify if a user belongs to the specified organization, raising an exception if the check fails.

Changes

File(s)	Change Summary
admin/app/.../github/form.tsx apiserver/plane/license/…/configure_instance.py	Added new GitHub organization configuration using GITHUB_ORGANIZATION_ID: introduced in form default values, field definitions, reset logic, and as a config key sourced from environment variables.
apiserver/plane/authentication/adapter/error.py apiserver/plane/authentication/provider/oauth/github.py	Included organizational verification changes: added error code "GITHUB_USER_NOT_IN_ORG": 5122 and enhanced GitHubOAuthProvider with new variables, scope extension, and a method to check user organization membership, raising an exception on failure.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant OAuthProvider as GitHubOAuthProvider
    participant GitHubAPI as OrgMembershipEndpoint
    User->>OAuthProvider: Initiate OAuth login
    OAuthProvider->>GitHubAPI: GET /orgs/{org}/members/{username}
    alt Membership confirmed (200 OK)
        GitHubAPI-->>OAuthProvider: Membership verified
        OAuthProvider->>User: Authentication Success
    else Membership not confirmed
        GitHubAPI-->>OAuthProvider: Membership denied
        OAuthProvider->>User: Raise AuthenticationException (5122)
    end

Poem

Hopping in code with joyful glee,
I’ve added fields for orgs, you see.
API calls dance and errors flee,
With GitHub checks, we’re bug-free!
Carrots and commits — a rabbit’s jubilee!

✨ Finishing Touches

• [ ] 📝 Generate Docstrings

---

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.
• @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.

[sriramveeraghanta]

Hey @SamuelTR20

Your changes looks good to us, we will be testing it internally. We will merging these changes as a part of the next minor release.