Skip to content

feat(devboxes): use optimistic create endpoint #825

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
adam-rl wants to merge 1 commit into
base: next
Choose a base branch
from
+24 −6
Open

feat(devboxes): use optimistic create endpoint #825

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
8 changes: 7 additions & 1 deletion src/resources/devboxes/devboxes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,13 @@ export class Devboxes extends APIResource {
options?: LongPollRequestOptions<DevboxView>,
): Promise<DevboxView> {
const { longPoll, polling, ...requestOptions } = options ?? {};
const devbox = await this.create(body, requestOptions);
const devbox = (await this._client.post('/v1/devboxes/create_and_await_running', {
body: body ?? {},
...requestOptions,
})) as DevboxView;
if (devbox.status === 'running') {
return devbox;
}
return this.awaitRunning(devbox.id, { ...requestOptions, longPoll, polling });
}
/**
Expand Down
22 changes: 17 additions & 5 deletions tests/api-resources/devboxes/devboxes.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -716,7 +716,7 @@ describe('resource devboxes', () => {
expect(mockPost).toHaveBeenCalledTimes(2);

// Check create call
expect(mockPost).toHaveBeenNthCalledWith(1, '/v1/devboxes', {
expect(mockPost).toHaveBeenNthCalledWith(1, '/v1/devboxes/create_and_await_running', {
body: { name: 'test-devbox' },
});

Expand All @@ -731,16 +731,28 @@ describe('resource devboxes', () => {
mockPost.mockRestore();
});

test('createAndAwaitRunning: returns an optimistic running response without polling', async () => {
const mockPost = jest.spyOn(client.devboxes['_client'], 'post');
mockPost.mockResolvedValueOnce({ id: 'new-devbox-id', status: 'running' });

const result = await client.devboxes.createAndAwaitRunning({ name: 'test-devbox' });

expect(result).toEqual({ id: 'new-devbox-id', status: 'running' });
expect(mockPost).toHaveBeenCalledTimes(1);
expect(mockPost).toHaveBeenCalledWith('/v1/devboxes/create_and_await_running', {
body: { name: 'test-devbox' },
});
});

test('createAndAwaitRunning: handles creation failure', async () => {
const mockPost = jest.spyOn(client.devboxes['_client'], 'post');

const createError = new Error('Creation failed');
mockPost.mockRejectedValueOnce(createError);
const createError = new APIError(400, undefined, 'Creation failed', {});
mockPost.mockRejectedValue(createError);

await expect(client.devboxes.createAndAwaitRunning()).rejects.toThrow('Creation failed');

expect(mockPost).toHaveBeenCalledTimes(1);
expect(mockPost).toHaveBeenCalledWith('/v1/devboxes', { body: {} });
expect(mockPost).toHaveBeenCalledWith('/v1/devboxes/create_and_await_running', { body: {} });

mockPost.mockRestore();
});
Expand Down