Skip to content

Commit db682a9

Browse files
authored
chore(sdk): update removeTunnel() oo sdk method and add smoketest (#756)
1 parent 7cdb7eb commit db682a9

3 files changed

Lines changed: 8 additions & 7 deletions

File tree

src/sdk/devbox.ts

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -130,19 +130,15 @@ export class DevboxNetOps {
130130
}
131131

132132
/**
133-
* @deprecated Only works with legacy tunnels created via {@link createTunnel}.
134-
* V2 tunnels (from {@link enableTunnel}) remain active until devbox shutdown and cannot be removed.
135-
*
136-
* Remove a legacy tunnel from the devbox.
133+
* Remove an existing V2 tunnel from the devbox.
137134
*
138135
* @example
139136
* ```typescript
140-
* // Deprecated - only for legacy tunnels
141137
* await devbox.net.removeTunnel();
142138
* ```
143139
*
144140
* @param {Core.RequestOptions} [options] - Request options
145-
* @returns {Promise<DevboxRemoveTunnelResponse>} Tunnel removal result
141+
* @returns {Promise<void>}
146142
*/
147143
async removeTunnel(options?: Core.RequestOptions) {
148144
return this.client.devboxes.removeTunnel(this.devboxId, options);

tests/objects/devbox.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -378,7 +378,7 @@ describe('Devbox (New API)', () => {
378378
expect(result).toEqual(mockTunnel);
379379
});
380380

381-
it('should remove legacy tunnel', async () => {
381+
it('should remove tunnel', async () => {
382382
mockClient.devboxes.removeTunnel.mockResolvedValue(undefined);
383383

384384
const result = await devbox.net.removeTunnel();

tests/smoketests/object-oriented/devbox.test.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,11 @@ describe('smoketest: object-oriented devbox', () => {
282282
const info = await devbox.getInfo();
283283
expect(info.tunnel).toBeDefined();
284284
expect(info.tunnel?.tunnel_key).toBe(tunnel.tunnel_key);
285+
286+
await devbox.net.removeTunnel();
287+
288+
const tunnelAfterRemoval = await devbox.getTunnel();
289+
expect(tunnelAfterRemoval).toBeNull();
285290
} finally {
286291
await devbox.shutdown();
287292
}

0 commit comments

Comments
 (0)