Skip to content

feat(client): serve conversation workspace static files #244

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
VascoSch92 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(client): serve conversation workspace static files #244

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
28 changes: 28 additions & 0 deletions src/__tests__/api-clients.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2104,4 +2104,32 @@ describe('Auxiliary API clients', () => {
expect.objectContaining({ method: 'GET' })
);
});

it('ConversationClient workspace methods serve the static file routes as blobs', async () => {
global.fetch = jest.fn().mockImplementation(() =>
Promise.resolve(
new Response('<html>workspace</html>', {
status: 200,
headers: { 'content-type': 'text/html' },
})
)
) as typeof fetch;

const client = new ConversationClient({ host: 'http://example.com' });
const root = await client.getWorkspaceRoot('c1');
const file = await client.getWorkspaceFile('c1', 'sub/dir/page.html');

expect(root).toBeInstanceOf(Blob);
expect(await file.text()).toBe('<html>workspace</html>');
expect(global.fetch).toHaveBeenNthCalledWith(
1,
'http://example.com/api/conversations/c1/workspace',
expect.objectContaining({ method: 'GET' })
);
expect(global.fetch).toHaveBeenNthCalledWith(
2,
'http://example.com/api/conversations/c1/workspace/sub/dir/page.html',
expect.objectContaining({ method: 'GET' })
);
});
});
47 changes: 47 additions & 0 deletions src/__tests__/integration/deterministic-api.integration.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
uniqueDirName,
uniqueFileName,
workspaceFileExists,
writeWorkspaceFile,
} from './test-utils';

const config = getServerTestConfig();
Expand Down Expand Up @@ -391,4 +392,50 @@ describe('Deterministic API Integration Tests', () => {
},
config.testTimeout
);

it(
'serves conversation workspace files over the static workspace routes',
async () => {
// Exercises GET /api/conversations/{id}/workspace (root index.html) and
// GET /api/conversations/{id}/workspace/{file_path}. The conversation's
// working dir is the mounted workspace, so files written there are served
// back verbatim through the static routes.
const client = new ConversationClient({ host: config.agentServerUrl });
const conversation = await manager.createConversation(createDummyAgent(), {
workingDir: config.agentWorkspaceDir,
});
const rootIndex = 'index.html';
const nestedDir = uniqueDirName('ws-serve');
const nestedFile = `${nestedDir}/page.html`;
const rootContent = '<html><body>workspace root</body></html>';
const nestedContent = '<html><body>nested workspace page</body></html>';
try {
writeWorkspaceFile(rootIndex, rootContent);
writeWorkspaceFile(nestedFile, nestedContent);
await sleep(300);

const servedRoot = await client.getWorkspaceRoot(conversation.id);
const servedFile = await client.getWorkspaceFile(conversation.id, nestedFile);
expect(servedRoot).toBeInstanceOf(Blob);
expect(await servedRoot.text()).toBe(rootContent);
expect(await servedFile.text()).toBe(nestedContent);

// A file the workspace does not contain yields 404.
let missingStatus: number | undefined;
try {
await client.getWorkspaceFile(conversation.id, `${nestedDir}/missing.html`);
} catch (error) {
expect(error).toBeInstanceOf(HttpError);
missingStatus = (error as HttpError).status;
}
expect(missingStatus).toBe(404);
} finally {
deleteWorkspaceFile(rootIndex);
await workspace.executeCommand(`rm -rf ${config.agentWorkspaceDir}/${nestedDir}`);
await manager.deleteConversation(conversation.id).catch(() => undefined);
client.close();
}
},
config.testTimeout
);
});
33 changes: 33 additions & 0 deletions src/client/conversation-client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,39 @@ export class ConversationClient {
return response.data;
}

/**
* Fetch the conversation workspace root (`index.html`) served as a static
* file by `GET /api/conversations/{id}/workspace`.
*
* The agent-server only serves *local* workspaces; non-local workspaces, a
* missing directory, or the absence of an `index.html` all yield 404. The
* raw bytes are returned as a {@link Blob} so binary artifacts survive intact
* (call `.text()` for HTML/text).
*/
async getWorkspaceRoot(conversationId: string): Promise<Blob> {
const response = await this.client.get<Blob>(`/api/conversations/${conversationId}/workspace`, {
responseType: 'blob',
});
return response.data;
}

/**
* Fetch a single file (or a directory's `index.html`) from the conversation
* workspace via `GET /api/conversations/{id}/workspace/{filePath}`.
*
* `filePath` is a workspace-relative path; nested paths are supported. Paths
* that escape the workspace are rejected by the server with 400, and a
* missing file/conversation yields 404. The raw bytes are returned as a
* {@link Blob} so binary artifacts survive intact (call `.text()` for text).
*/
async getWorkspaceFile(conversationId: string, filePath: string): Promise<Blob> {
const response = await this.client.get<Blob>(
`/api/conversations/${conversationId}/workspace/${filePath}`,

@all-hands-bot all-hands-bot Aug 15, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

filePath is interpolated raw into the URL. The HttpClient builds the final URL with new URL(relativePath, baseUrl + '/'), so any # or ? in a filename is interpreted as a fragment/query separator and the path is silently truncated (e.g. weird#name.txt becomes weird). Consider encoding each segment and joining on /, e.g. filePath.split('/').map(encodeURIComponent).join('/'), so nested paths and unusual filenames are preserved. The rest of this client (e.g. FileClient.downloadTrajectory) uses encodeURIComponent for path components; applying the same here keeps the encoding contract consistent across the SDK.

{ responseType: 'blob' }
);
return response.data;
}

close(): void {
this.client.close();
}
Expand Down
Loading