middleware
middleware copied to clipboard
feature: Added FGTs support in github integration
Linked Issue(s)
fixed #643
Acceptance Criteria fulfillment
Added FGT support for GIthub Integration while retaining the PAT usage.
Proposed changes (including videos or screenshots)
Integration using FGT
Screencast from 2025-04-22 18-48-15.webm
Integration using PAT
Screencast from 2025-04-22 18-49-07.webm
Further comments
Renamed getMissingPATScopes to getMissingTokenScopes for handling FGTs and PATs both.
Updated the UI text to mention both PATs and FGTs and modified handleSubmission function.
Summary by CodeRabbit
- New Features
- Improved support for both GitHub Personal Access Tokens (PAT) and Fine-Grained Tokens (FGT), including detection and validation of token type.
- Enhanced error messages now specify whether missing requirements are "scopes" or "permissions" based on token type.
- UI Improvements
- Updated token input labels and instructions to reference both PAT and FGT.
- Changed link text to "Generate new token" and standardized capitalization of "GitHub".
- Bug Fixes
- More accurate detection and messaging for missing GitHub token permissions or scopes.
"""
Walkthrough
The changes introduce support for GitHub Fine-Grained Tokens (FGT) in addition to Personal Access Tokens (PAT) for integration within the application. The token validation, permission checking, and linking logic have been refactored to handle both token types. The user interface and instructional text have been updated to reflect support for FGTs. Internal utility functions now distinguish between PAT and FGT, adapting permission checks accordingly, and the linking process records the token type. No changes were made to exported component signatures or GitLab-related logic.
Changes
| File(s) | Change Summary |
|---|---|
web-server/src/content/Dashboards/ConfigureGithubModalBody.tsx |
Refactored token validation and linking logic to async/await pattern; updated to support both PAT and FGT, including dynamic error messages and success notifications. Updated UI text and labels to reference both token types and clarified instructions. Minor style and whitespace adjustments. |
web-server/src/utils/auth.ts |
Updated checkGitHubValidity to return both validity and token type by inspecting API headers. Generalized and renamed getMissingPATScopes to getMissingTokenScopes, adding logic to check FGT permissions. Modified linkProvider to always include tokenType in meta_data. No changes to GitLab logic. |
Sequence Diagram(s)
sequenceDiagram
participant User
participant ConfigureGithubModalBody
participant authUtils as Auth Utils (auth.ts)
participant GitHubAPI
User->>ConfigureGithubModalBody: Submit GitHub token
ConfigureGithubModalBody->>authUtils: checkGitHubValidity(token)
authUtils->>GitHubAPI: Validate token
GitHubAPI-->>authUtils: Response with headers
authUtils-->>ConfigureGithubModalBody: { isValid, tokenType }
alt Token invalid
ConfigureGithubModalBody-->>User: Show error
else Token valid
ConfigureGithubModalBody->>authUtils: getMissingTokenScopes(token, tokenType)
alt Missing scopes/permissions
ConfigureGithubModalBody-->>User: Show missing scopes/permissions error
else All required permissions present
ConfigureGithubModalBody->>authUtils: linkProvider(token, orgId, 'github', { tokenType })
authUtils->>GitHubAPI: Link provider
GitHubAPI-->>authUtils: Success
authUtils-->>ConfigureGithubModalBody: Success
ConfigureGithubModalBody-->>User: Show success message with token type
end
end
Assessment against linked issues
| Objective | Addressed | Explanation |
|---|---|---|
| Support use of GitHub fine-grained tokens in the GitHub integration (#643) | ✅ | |
| Update permission checking and validation logic to handle both PAT and FGT (#643) | ✅ | |
| Update UI and instructional text to reference both token types (#643) | ✅ |
Poem
A rabbit hopped to GitHub’s gate,
“PATs and FGTs, now both are great!”
With tokens checked and scopes in view,
The linking’s smooth—permissions too!
So hop along, integrations grow,
Fine-grained or classic—just let us know!
🐇✨ """
✨ 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.
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.