Skip to content

Enhance APIRequestBuilder: Add JSON escaping for system and user promt #557

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.

Sign up for GitHub

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

Open
longshuicy wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Enhance APIRequestBuilder: Add JSON escaping for system and user promt #557

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,6 @@ tests_output/

# IDE
.idea

# Cursor workspace files
*.code-workspace
15 changes: 9 additions & 6 deletions src/components/UIUC-Components/APIRequestBuilder.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,9 @@ export default function APIRequestBuilder({
setTimeout(() => setCopiedCodeSnippet(false), 2000)
}

/** Escape string for safe embedding inside JSON string value (newlines → \\n, quotes escaped). */
const escapeForJson = (s: string) => JSON.stringify(s).slice(1, -1)

const baseUrl = process.env.VERCEL_URL || window.location.origin

const codeSnippets = {
Expand All @@ -102,11 +105,11 @@ export default function APIRequestBuilder({
"messages": [
{
"role": "system",
"content": "${systemPrompt}"
"content": "${escapeForJson(systemPrompt)}"
},
{
"role": "user",
"content": "${userQuery}"
"content": "${escapeForJson(userQuery)}"
}
],
"api_key": "${apiKey || 'YOUR-API-KEY'}",
Expand All @@ -126,11 +129,11 @@ data = {
"messages": [
{
"role": "system",
"content": "${systemPrompt}"
"content": "${escapeForJson(systemPrompt)}"
},
{
"role": "user",
"content": "${userQuery}"
"content": "${escapeForJson(userQuery)}"
}
],
"api_key": "${apiKey || 'YOUR-API-KEY'}",
Expand All @@ -157,11 +160,11 @@ print(response.json().get('message'))
"messages": [
{
"role": "system",
"content": "${systemPrompt}"
"content": "${escapeForJson(systemPrompt)}"
},
{
"role": "user",
"content": "${userQuery}"
"content": "${escapeForJson(userQuery)}"
}
],
"api_key": "${apiKey || 'YOUR-API-KEY'}",
Expand Down
15 changes: 15 additions & 0 deletions src/components/UIUC-Components/__tests__/APIRequestBuilder.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,19 @@ describe('APIRequestBuilder', () => {
'/api/chat-api/chat',
)
})

it('escapes multi-line system prompt as \\n in generated snippet so JSON is valid', async () => {
const multiLinePrompt = 'line1\nline2'
renderWithProviders(
<APIRequestBuilder
course_name="CS101"
apiKey="test-key"
courseMetadata={{ system_prompt: multiLinePrompt }}
/>,
)
const snippet = await screen.findByDisplayValue(/curl -X POST/i)
const value = String((snippet as HTMLTextAreaElement).value)
// Snippet must contain escaped newline (backslash + n), not a literal newline that would break JSON/shell
expect(value).toContain('line1\\nline2')
})
})