Encode URL in `add_link`
This PR includes URL encoding/quoting before adding a link to a finding.
The original motivation for this PR is a problem I've encountered with Slack links (which I'll describe promptly), but I guess non-encoded URLs may cause an issue with other sinks as well, so a general solution is preferred.
The mentioned Slack problem is as follows: Robusta produces a "View Graph" button with a URL including unescaped braces, but these characters don't behave nicely with Slack. Specifically, on the Slack android app, clicking the "View Graph" button will do nothing. (But it works just fine from a browser.)
Here are Slack blocks to demonstrate the problem
{
"blocks": [
{
"type": "actions",
"elements": [
{
"type": "button",
"text": {
"type": "plain_text",
"text": "Won't work from Android app"
},
"url": "https://google.com?q={",
"action_id": "actionId-0"
}
]
},
{
"type": "actions",
"elements": [
{
"type": "button",
"text": {
"type": "plain_text",
"text": "Works from Android app"
},
"url": "https://google.com?q=",
"action_id": "actionId-1"
}
]
}
]
}
As mentioned above, the specific Slack problem is not the main point (you could even say it's an issue in Slack), but it would be good practice to encode the URL before sending it to a sink.
Walkthrough
Adds a reusable encode_url utility and applies it to link insertion and GitHub markdown transformation so URLs are consistently encoded at source and during rendering.
Changes
| Cohort / File(s) | Summary |
|---|---|
URL encoding utilitysrc/robusta/utils/common.py |
Added encode_url(url: str) -> str that parses a URL, encodes path/query/fragment, reconstructs and returns it; returns "" for empty input. |
Reporting link insertion encodingsrc/robusta/core/reporting/base.py |
Imported encode_url. Finding.add_link now assigns link.url = encode_url(link.url) before appending the link; no other logic changes. |
Transformer GitHub markdown URL encodingsrc/robusta/core/sinks/transformer.py |
Replaced manual urllib.parse-based URL re-quoting with encode_url(splits[0]); removed direct urllib.parse usage; behavior otherwise unchanged. |
Sequence Diagram(s)
sequenceDiagram
autonumber
participant Reporter as Finding.add_link
participant Transformer as Transformer.to_github_markdown
participant Util as encode_url
Reporter->>Util: encode_url(link.url)
Util-->>Reporter: encoded_url
Reporter->>Reporter: append link with encoded_url
Transformer->>Util: encode_url(parsed_url)
Util-->>Transformer: encoded_url
Transformer->>Transformer: replace and render markdown
Estimated code review effort
๐ฏ 2 (Simple) | โฑ๏ธ ~10 minutes
[!TIP]
๐ Remote MCP (Model Context Protocol) integration is now available!
Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.
๐ Recent review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
๐ก Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
๐ฅ Commits
Reviewing files that changed from the base of the PR and between e5a8dfe08c2f467d8390a884ba371d5b1feb51b7 and da32e5002dbf120f4fa8208a2529fbb7c0a5d81e.
๐ Files selected for processing (1)
-
src/robusta/utils/common.py(2 hunks)
๐ง Files skipped from review as they are similar to previous changes (1)
- src/robusta/utils/common.py
โจ Finishing Touches
- [ ] ๐ Generate Docstrings
๐งช Generate unit tests
- [ ] Create PR with unit tests
- [ ] Post copyable unit tests in a comment
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. -
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. - 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
-
Support
Need help? Create a ticket on our support page for assistance with any issues or questions.
CodeRabbit Commands (Invoked using PR/Issue comments)
Type @coderabbitai help to get the list of available commands.
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
Status, Documentation and Community
- Visit our Status Page to check the current availability of CodeRabbit.
- 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.