Skip to content

fix(url): Decode filePath before resolving into an absolute path (fixes #109). #295

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
May 22, 2025

Conversation

junhaoliao
Copy link
Member

@junhaoliao junhaoliao commented May 22, 2025

Description

Call decodeURIComponent() to decode a potentially URL-encoded filePath before resolving the parameter value into an absolute path relative to the current host.

Checklist

Validation performed

  1. URL-encoded the demo file link https://yscope.s3.us-east-2.amazonaws.com/sample-logs/yarn-ubuntu-resourcemanager-ip-172-31-17-135.log.1.clp.zst -> https%3A%2F%2Fyscope.s3.us-east-2.amazonaws.com%2Fsample-logs%2Fyarn-ubuntu-resourcemanager-ip-172-31-17-135.log.1.clp.zst.
  2. Launched debug server and open the app in a browser. Use the URL-encoded link as the filePath. i.e., http://localhost:3010/?filePath=https%3A%2F%2Fyscope.s3.us-east-2.amazonaws.com%2Fsample-logs%2Fyarn-ubuntu-resourcemanager-ip-172-31-17-135.log.1.clp.zst#logEventNum=375558
  3. Observed the file was loaded successfully.

Summary by CodeRabbit

  • Bug Fixes
    • Improved handling of file paths in URLs to correctly interpret special characters by decoding them before processing. This ensures more reliable access to files with URL-encoded characters in their names.

@junhaoliao junhaoliao requested a review from a team as a code owner May 22, 2025 05:03
Copy link

coderabbitai bot commented May 22, 2025

Walkthrough

The change updates the extraction of the filePath parameter from the URL in UrlContextProvider.tsx. Now, the filePath is decoded using decodeURIComponent before being passed to the getAbsoluteUrl function, ensuring proper handling of URL-encoded characters.

Changes

File(s) Change Summary
src/contexts/UrlContextProvider.tsx Updated to decode the filePath URL parameter before resolving its absolute path.

Possibly related PRs

Suggested reviewers

  • Henry8192

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm warn config production Use --omit=dev instead.
npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-05-22T05_04_42_159Z-debug-0.log

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between af6c219 and d8e0c6b.

📒 Files selected for processing (1)
  • src/contexts/UrlContextProvider.tsx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.{cpp,hpp,java,js,jsx,tpp,ts,tsx}`: - Prefer `false == ` rather than `!`.

**/*.{cpp,hpp,java,js,jsx,tpp,ts,tsx}: - Prefer false == <expression> rather than !<expression>.

  • src/contexts/UrlContextProvider.tsx
🧬 Code Graph Analysis (1)
src/contexts/UrlContextProvider.tsx (1)
src/utils/url.ts (1)
  • getAbsoluteUrl (57-57)
🔇 Additional comments (1)
src/contexts/UrlContextProvider.tsx (1)

190-192: Good fix for URL-encoded file paths!

The addition of decodeURIComponent correctly handles URL-encoded characters in the filePath parameter before passing it to getAbsoluteUrl. This will fix issue #109 where file paths containing special characters weren't working properly.

The change is minimal and focused, with the existing error handling appropriately catching any potential issues during URL resolution.

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

@junhaoliao junhaoliao requested a review from Henry8192 May 22, 2025 05:07
@junhaoliao
Copy link
Member Author

cc @zzxthehappiest working on #286 for awareness / comments, since this PR modifies the URL utilities

Copy link
Collaborator

@Henry8192 Henry8192 left a comment

Choose a reason for hiding this comment

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

LGTM.

@junhaoliao junhaoliao merged commit afc318b into y-scope:main May 22, 2025
6 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