chore(api): Changed the search api to return raw source (instead of base64 encoding) #356
Conversation
WalkthroughThe changes remove the usage and implementation of the Changes
Sequence Diagram(s)sequenceDiagram
participant Backend
participant Frontend
Note over Backend,Frontend: Previous Flow (most locations)
Backend->>Frontend: Sends base64-encoded content
Frontend->>Frontend: Decodes content with base64Decode
Frontend->>User: Renders decoded content
Note over Backend,Frontend: New Flow (most locations)
Backend->>Frontend: Sends plain text content
Frontend->>User: Renders content directly
Note over Backend,Frontend: Exception (searchApi.ts)
Backend->>Frontend: Sends base64-encoded search results
Frontend->>Frontend: Decodes content with base64Decode
Frontend->>User: Renders decoded search result
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (6)
packages/web/src/app/[domain]/search/components/codePreviewPanel/index.tsx (1)
54-60: UX: spinner never centred in SafariMinor: the flex container sets
h-fullbut the parent of the panel isn’t guaranteed to provide an explicit height, causing the spinner to hug the top in Safari.
Addmin-h-full(or ensure the parent isflex-1) to keep it vertically centred for all browsers.packages/web/src/features/agents/review-agent/nodes/fetchFileContent.ts (1)
20-27: Large-file memory / log safety
fileContentcan now be arbitrary plain text and may reach MBs.
Before passing it upstream:
- Guard against > N KB to avoid blowing out token limits of the agent caller.
- Never log the raw content – the current code only logs the request, but double-check that no upstream logger prints
context.-const fileContent = fileSourceResponse.source; +const raw = fileSourceResponse.source; +if (raw.length > 200_000) { + logger.warn(`Truncating oversized file (${raw.length} bytes): ${filename}`); +} +const fileContent = raw.slice(0, 200_000);Adjust the threshold to whatever your agent can safely digest.
packages/web/src/ee/features/codeNav/components/exploreMenu/referenceList.tsx (1)
172-173: Preserve trailing newline for accurate highlightingReact will collapse a trailing
\nat the end of{lineContent}which may shift highlight offsets by one line.
Wrap the string in<>{lineContent || '\u200B'}</>or append a ZERO-WIDTH-SPACE whenlineContent.endsWith('\n')to keep the visual line count correct.packages/web/src/app/[domain]/search/components/searchResultsPanel/fileMatch.tsx (1)
20-25: Use platform-agnostic newline splitting
split('\n')misses Windows\r\nendings and can off-by-one the computedendLineNumber.
Tiny tweak:- const endLineNumber = match.content.trimEnd().split('\n').length + startLineNumber - 1; + const endLineNumber = + match.content.trimEnd().split(/\r?\n/).length + startLineNumber - 1;packages/mcp/src/index.ts (2)
116-119: Include language identifier in fenced code blocksMarkdown renderers highlight syntax when a language is provided. Inserting the repo’s language makes snippets easier to read:
- return `\`\`\`\n${chunk.content}\n\`\`\``; + return `\`\`\`${file.language?.toLowerCase() || ''}\n${chunk.content}\n\`\`\``;Also consider escaping embedded triple-backticks to avoid fence breaking.
201-205: Same improvement for full-file source output-text: `file: ${fileName}\nrepository: ${repoId}\nlanguage: ${response.language}\nsource:\n${response.source}`, +text: `file: ${fileName}\nrepository: ${repoId}\nlanguage: ${response.language}\nsource:\n\`\`\`${response.language?.toLowerCase() || ''}\n${response.source}\n\`\`\``,Provides consistent formatting and syntax highlighting.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
packages/mcp/src/index.ts(3 hunks)packages/mcp/src/utils.ts(0 hunks)packages/web/src/app/[domain]/browse/[...path]/components/codePreviewPanel.tsx(2 hunks)packages/web/src/app/[domain]/search/components/codePreviewPanel/index.tsx(1 hunks)packages/web/src/app/[domain]/search/components/searchResultsPanel/fileMatch.tsx(3 hunks)packages/web/src/ee/features/codeNav/components/exploreMenu/referenceList.tsx(1 hunks)packages/web/src/ee/features/codeNav/components/symbolHoverPopup/symbolDefinitionPreview.tsx(1 hunks)packages/web/src/features/agents/review-agent/nodes/fetchFileContent.ts(1 hunks)packages/web/src/features/search/searchApi.ts(3 hunks)packages/web/src/lib/utils.ts(0 hunks)
💤 Files with no reviewable changes (2)
- packages/mcp/src/utils.ts
- packages/web/src/lib/utils.ts
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: build
- GitHub Check: build
- GitHub Check: build
🔇 Additional comments (2)
packages/web/src/ee/features/codeNav/components/symbolHoverPopup/symbolDefinitionPreview.tsx (1)
53-54: Potential HTML injection path – confirmLightweightCodeHighlighterescapesSince raw
lineContentis rendered directly, ensure the highlighter internally escapes</&etc.
Previously we implicitly trustedbase64Decodeto give us raw bytes, so no new risk is introduced, but it’s worth confirming the component usesdangerouslySetInnerHTMLonly with escaped output.packages/web/src/features/search/searchApi.ts (1)
268-270: To verify howbase64Decodebehaves on invalid input and examine its implementation alongside the exact call sites, let’s pull in the relevant snippets:#!/bin/bash set -e echo "1) Implementation of base64Decode in shared utils:" rg --color=never -n -A5 "export const base64Decode" packages/shared/src/utils.ts echo echo "2) Surrounding code in searchApi.ts around line 268:" sed -n '260,300p' packages/web/src/features/search/searchApi.ts
packages/web/src/app/[domain]/browse/[...path]/components/codePreviewPanel.tsx
Show resolved
Hide resolved
packages/web/src/app/[domain]/search/components/codePreviewPanel/index.tsx
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
CHANGELOG.md (1)
15-15: Refine changelog entry wording
Avoid repeating “Changed” (heading + verb), add the missing article, and hyphenate “base64-encoded.” For example:- ### Changed - Changed search api (and all apis that depend on it) to return raw source code instead of base64 encoded string. ([356](https://github.com/sourcebot-dev/sourcebot/pull/356)) + ### Changed + [**Breaking Change**] Search API and all dependent APIs now return raw source code instead of a base64-encoded string. ([#356](https://github.com/sourcebot-dev/sourcebot/pull/356))
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
CHANGELOG.md(1 hunks)packages/mcp/CHANGELOG.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- packages/mcp/CHANGELOG.md
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md
[duplication] ~14-~14: Possible typo: you repeated a word.
Context: ...//pull/354) ### Changed - Changed search api (and all apis that depend on...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~15-~15: Possible missing article found.
Context: ...t) to return raw source code instead of base64 encoded string. ([356](https://github.c...
(AI_HYDRA_LEO_MISSING_A)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: build
- GitHub Check: build
- GitHub Check: build
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
CHANGELOG.md (1)
16-17: Breaking Change label required
This update is a backward-incompatible change to the API surface. Please explicitly mark it as a Breaking Change under Unreleased > Changed to alert consumers.### [Unreleased] - ### Changed - - Changed search api (and all apis that depend on it) to return raw source code instead of base64 encoded string. ([356](https://github.com/sourcebot-dev/sourcebot/pull/356)). + ### Changed + - **Breaking Change**: Search API (and all APIs that depend on it) now returns raw source code directly instead of a base64-encoded string. ([#356](https://github.com/sourcebot-dev/sourcebot/pull/356))
🧹 Nitpick comments (1)
CHANGELOG.md (1)
10-10: Grammar: use "an" before "API"
The note reads "a API change," but it should be "an API change" for correct English.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CHANGELOG.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md
[style] ~13-~13: The noun “invitation” is usually used instead of ‘invite’ in formal writing.
Context: ... account join request when redeeming an invite. [#352](https://github.com/sourcebot-de...
(AN_INVITE)
[duplication] ~16-~16: Possible typo: you repeated a word.
Context: ...//pull/354) ### Changed - Changed search api (and all apis that depend on...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~17-~17: Possible missing article found.
Context: ...t) to return raw source code instead of base64 encoded string. ([356](https://github.c...
(AI_HYDRA_LEO_MISSING_A)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: build
- GitHub Check: build
- GitHub Check: build
This PR alters the behaviour of the search api (and all apis that depend on it) to return raw source code instead of a base64 encoding. Reasoning: we are decoding it on the client in multiple different places, so it would be beneficial to decode it in a single spot.
Note: This is a breaking change to the API surface. However, since the API surface is still unofficial/unsupported, I will roll this as a patch version change. See #101
Summary by CodeRabbit