Skip to content

fix(gitlab): Properly handle auth for Gitlab project avatars #345

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 1 commit into from
Jun 11, 2025

Conversation

GabDug
Copy link
Contributor

@GabDug GabDug commented Jun 11, 2025

Hey 👋

Context

We've noticed that our Gitlab project avatars were not loading properly, even in 4.2.0.

Proposed fix

I believe it's because the URL in project.avatarUrl does not accept Gitlab tokens anymore.

Gitlab provides a ~new API to get a project's avatar, supporting the same authentication modes as other APIs. This API does not require authentication for public projects.

I've also removed gitlab.com from the list of domains never needing auth - to properly support private projects on Gitlab.com.

Validation

I've only tested this change on an internal Gitlab with public/private projects and on gitlab.com with public/private projects.

Have a great day!

Summary by CodeRabbit

  • Bug Fixes
    • Improved handling of GitLab repository avatar images to ensure consistent image display.
    • Updated logic so that images from gitlab.com are now loaded through a proxy, enhancing reliability for private or protected repositories.

Copy link

coderabbitai bot commented Jun 11, 2025

Walkthrough

The changes update how GitLab repository avatar URLs are constructed and handled in both backend and frontend utilities. The backend now computes the avatar URL based on the repository's ID and self-link, while the frontend removes 'gitlab.com' from its list of public hostnames, altering how image URLs are proxied.

Changes

File(s) Change Summary
packages/backend/src/repoCompileUtils.ts Modified avatar URL handling in compileGitlabConfig to compute image URL from project ID and host.
packages/web/src/lib/utils.ts Removed 'gitlab.com' from public hostnames in getRepoImageSrc, changing image proxying behavior.

Poem

In the warren of code, a tweak to the link,
GitLab’s avatar now fresher than you think!
No longer public, the bunny decrees,
Images hop through proxies with ease.
With clever URLs and a backend fix,
The repo’s new face is shown in the mix!
🐰✨


📜 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 870e48c and baba319.

📒 Files selected for processing (2)
  • packages/backend/src/repoCompileUtils.ts (2 hunks)
  • packages/web/src/lib/utils.ts (0 hunks)
💤 Files with no reviewable changes (1)
  • packages/web/src/lib/utils.ts
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/backend/src/repoCompileUtils.ts
✨ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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 1ea377e and 870e48c.

📒 Files selected for processing (2)
  • packages/backend/src/repoCompileUtils.ts (2 hunks)
  • packages/web/src/lib/utils.ts (0 hunks)
💤 Files with no reviewable changes (1)
  • packages/web/src/lib/utils.ts
🔇 Additional comments (1)
packages/backend/src/repoCompileUtils.ts (1)

138-138: Confirm schema supports null avatar values

imageUrl can now be null. Verify the Prisma model & DB column allow NULL
to prevent insertion failures.

@GabDug GabDug force-pushed the fix/gitlab-avatars branch from 870e48c to baba319 Compare June 11, 2025 09:41
@msukkari
Copy link
Contributor

Thanks for the fix Gabriel!

@msukkari msukkari merged commit e423b56 into sourcebot-dev:main Jun 11, 2025
4 checks passed
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