Skip to content

Correctly build URLs to file paths containing spaces #364

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 24, 2025

Conversation

NasaGeek
Copy link
Contributor

@NasaGeek NasaGeek commented Jun 23, 2025

Previously, such paths would have their spaces replaced with /s, breaking external links to the file.

Fixes #249

I haven't tested this yet.

Summary by CodeRabbit

  • Bug Fixes
    • Fixed broken external source code links when paths contain spaces, improving link reliability in search results.

Copy link

coderabbitai bot commented Jun 23, 2025

Walkthrough

The update changes the logic in the getFileWebUrl function within the search feature. Instead of performing global string replacements for .Version and .Path, the code now checks each part of the template individually and replaces these variables conditionally during the mapping process.

Changes

File(s) Change Summary
packages/web/src/features/search/searchApi.ts Refactored variable replacement in getFileWebUrl to perform conditional replacement per part.
CHANGELOG.md Added an "Unreleased" section noting a fix for broken external source code links with spaces.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SearchAPI

    User->>SearchAPI: Call getFileWebUrl(branch, fileName)
    SearchAPI->>SearchAPI: Split template string
    loop For each part in split template
        SearchAPI->>SearchAPI: If part == .Version, replace with branch
        SearchAPI->>SearchAPI: If part == .Path, replace with fileName
        SearchAPI->>SearchAPI: Otherwise, keep part as is
    end
    SearchAPI->>User: Return constructed URL
Loading

Assessment against linked issues

Objective Addressed Explanation
Fix URL construction so spaces in file names do not break links (#249)

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Poem

In the warren of code, a bug hopped by,
Spaces in file paths made URLs awry.
Now each part’s replaced with careful delight,
So links to our code host are perfectly right.
🐇✨

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

@brendan-kellam brendan-kellam self-assigned this Jun 24, 2025
Copy link
Contributor

@brendan-kellam brendan-kellam left a comment

Choose a reason for hiding this comment

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

Nice LGTM, thanks for the fix 👍 Just tested it and works.

Mind adding a entry to the Changelog?

Previously, such paths would have their spaces replaced with `/`s,
breaking external links to the file.

Fixes sourcebot-dev#249
@NasaGeek NasaGeek force-pushed the weburl-file-spaces branch from 6e9735b to f164469 Compare June 24, 2025 17:36
@NasaGeek
Copy link
Contributor Author

Done and rebased.

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)

8-12: Include the related issue number for full traceability

The new entry mentions the fixing PR (#364) but omits the underlying issue (#249) called out in the PR description. Other entries typically reference both the issue and the PR, so adding it keeps the changelog consistent and easier to follow.

- - Fixed issue with external source code links being broken for paths with spaces. [#364](https://github.com/sourcebot-dev/sourcebot/pull/364)
+ - Fixed issue with external source code links being broken for paths with spaces. [#249](https://github.com/sourcebot-dev/sourcebot/issues/249) [#364](https://github.com/sourcebot-dev/sourcebot/pull/364)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6e9735b and f164469.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • packages/web/src/features/search/searchApi.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/web/src/features/search/searchApi.ts
🧰 Additional context used
📓 Path-based instructions (1)
`**/*`: Filenames should always be camelCase. Exception: if there are filenames in the same directory with a format other than camelCase, use that format to keep things consistent.

**/*: Filenames should always be camelCase. Exception: if there are filenames in the same directory with a format other than camelCase, use that format to keep things consistent.

  • CHANGELOG.md
🪛 LanguageTool
CHANGELOG.md

[duplication] ~10-~10: Possible typo: you repeated a word.
Context: ...pec/v2.0.0.html). ## [Unreleased] ### Fixed - Fixed issue with external source code links b...

(ENGLISH_WORD_REPEAT_RULE)

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

@brendan-kellam brendan-kellam merged commit ebf6721 into sourcebot-dev:main Jun 24, 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.

Spaces in file names break links to code host
2 participants