Skip to content

Fix auth with GitHub #288

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

Merged
merged 3 commits into from
Apr 30, 2025
Merged

Fix auth with GitHub #288

merged 3 commits into from
Apr 30, 2025

Conversation

brendan-kellam
Copy link
Contributor

@brendan-kellam brendan-kellam commented Apr 30, 2025

This PR fixes a regression causing auth errors with GitHub. Also cleans up the code a bit for repo credential fetching.

Fixes #286

Summary by CodeRabbit

  • Bug Fixes

    • Resolved authentication errors with GitHub when cloning repositories, addressing a regression from version 3.1.0.
  • Documentation

    • Updated the changelog to include details about the GitHub authentication fix.

Copy link

coderabbitai bot commented Apr 30, 2025

Walkthrough

The changes refactor the authentication logic for cloning Git repositories in the backend. The method responsible for obtaining credentials was renamed and its implementation reworked to immediately return credentials upon finding a valid token for supported providers (GitHub, GitLab, Gitea, Bitbucket). The logic now handles username and password assignment per provider requirements. In the repository synchronization process, the new credentials method is used, and a workaround is added to correctly format the clone URL when only a password is present, addressing issues with malformed URLs for GitHub tokens.

Changes

File(s) Change Summary
packages/backend/src/repoManager.ts Refactored and renamed getAuthForRepo to getCloneCredentialsForRepo, updated credential logic per provider, and adjusted syncGitRepository to use the new method and handle username-less tokens in clone URLs.
CHANGELOG.md Added a "Fixes" section documenting the fix for GitHub authentication regression introduced in v3.1.0, referencing PR #288.

Assessment against linked issues

Objective Addressed Explanation
Fix GitHub token cloning so that the clone URL is correctly formatted without an empty username (286)

Poem

In the warren where code bunnies dwell,
We patched a token bug that gave us hell—
Now GitHub clones with hop and cheer,
No more colons lost, the path is clear!
With usernames tucked, and passwords neat,
Our repo sync is now complete.
🐇✨

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 09894a5 and 45f99dc.

📒 Files selected for processing (1)
  • packages/backend/src/repoManager.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build
🔇 Additional comments (2)
packages/backend/src/repoManager.ts (2)

173-221: Improved credential handling by provider type

This refactored implementation correctly handles authentication credentials for different Git providers. The method now immediately returns upon finding valid credentials and properly formats username/password combinations according to each provider's requirements:

  • GitHub and Gitea: only password (token)
  • GitLab: username "oauth2" with password
  • Bitbucket: configured username or default "x-token-auth" with password

The optional username in the return type signature is an important improvement that enables the URL handling fix later in the code.


251-265: Fixed GitHub authentication with proper URL encoding

This change addresses the core issue with GitHub authentication by detecting when only a password is present and properly formatting the URL. The workaround correctly handles the edge case where URL.toString() would produce a malformed URL with an empty username followed by : (like https://:password@example.com).

This fix is essential because GitHub's API requires the token to be passed as the username when basic auth is used with personal access tokens.

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 (1)
CHANGELOG.md (1)

13-14: Use imperative mood for the changelog bullet
For consistency with other entries under “### Fixes” (which use “Fix …” rather than “Fixes …”), update the bullet to start with “Fix”.

Apply this diff:

- - Fixes regression introduced in v3.1.0 that causes auth errors with GitHub. [#288](https://github.com/sourcebot-dev/sourcebot/pull/288)
+ - Fix regression introduced in v3.1.0 that causes auth errors with GitHub. [#288](https://github.com/sourcebot-dev/sourcebot/pull/288)
🧰 Tools
🪛 LanguageTool

[grammar] ~13-~13: Possible agreement error. You should probably use: “Fix Fixes” or “Fixes fix”.
Context: ...//pull/280) ### Fixes - Fixes regression introduced in v3.1.0 that ca...

(AGREEMENT_SENT_START)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 45f99dc and 0c8026e.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • packages/backend/src/repoManager.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/backend/src/repoManager.ts
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md

[grammar] ~13-~13: Possible agreement error. You should probably use: “Fix Fixes” or “Fixes fix”.
Context: ...//pull/280) ### Fixes - Fixes regression introduced in v3.1.0 that ca...

(AGREEMENT_SENT_START)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build

@brendan-kellam brendan-kellam merged commit 68265ac into main Apr 30, 2025
5 checks passed
@brendan-kellam brendan-kellam deleted the bkellam/fix_286 branch April 30, 2025 21:22
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.

[bug] GitHub token broken with 3.1.x
1 participant