Skip to content

chore: use persistent sandbox by name instead of id #15

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

Draft
styfle wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

chore: use persistent sandbox by name instead of id #15

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: 4 additions & 4 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
"version": "0.2.1",
"type": "module",
"bin": {
"vgrok": "./dist/src/vgrok.js"
"vgrok": "./dist/vgrok.js"
},
"main": "./dist/src/client.js",
"main": "./dist/client.js",
"files": [
"dist"
],
Expand All @@ -22,11 +22,11 @@
},
"packageManager": "pnpm@10.14.0",
"dependencies": {
"@vercel/sandbox": "^0.0.16"
"@vercel/sandbox": "2.0.0-beta.9"
},
"devDependencies": {
"@types/node": "^24.1.0",
"@types/ws": "^8.18.1",
"@typescript/native-preview": "7.0.0-dev.20260124.1"
"@typescript/native-preview": "7.0.0-dev.20260329.1"
}
}
122 changes: 79 additions & 43 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

63 changes: 21 additions & 42 deletions src/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
import { CommandFinished, Sandbox } from '@vercel/sandbox';
import { readFile, writeFile } from 'node:fs/promises';
import { readFile } from 'node:fs/promises';
import http from 'node:http';
import { join } from 'node:path';
import { tmpdir } from 'node:os';
import { hostname } from 'node:os';
import type { TunnelRequest, TunnelResponse } from './server.js';
import { vercelCliAuth } from './vercel-cli-auth.js';

type VgrokConfig = { localPortToSandbox: Record<string, { id: string, createdAt: number}> };

const SANDBOX_PORT = 3000;
const WS_PATH = '/_vgrok_ws';
const VGROK_CONFIG_PATH = join(tmpdir(), './vgrok-config.json');
let shuttingDown = false;

async function shutdown(sandbox: Sandbox | null) {
Expand All @@ -34,34 +31,19 @@ async function writeLogs(cmd: CommandFinished) {

export async function client({ port, timeout }: { port: number, timeout: number }) {
const localPort = port;
const config = await readFile(VGROK_CONFIG_PATH, 'utf8')
.then(str => JSON.parse(str) as VgrokConfig)
.catch(() => null);
const localPortToSandbox = config ? config.localPortToSandbox : {};
const name = `vgrok-${hostname().replaceAll(/[^\w-]/g, '_')}-${localPort}`;
const { token, teamId, projectId } = vercelCliAuth();
let sandbox: Sandbox | null = null;

if (localPortToSandbox[localPort]) {
const { id, createdAt } = localPortToSandbox[localPort];
console.log(`Reusing existing sandbox for port ${localPort} with ID ${id}`);
sandbox = await Sandbox.get({ teamId, projectId, token, sandboxId: id }).catch(() => null);
if (sandbox && sandbox.status !== 'running') {
console.log(`Sandbox with ID ${id} is not running`);
sandbox = null;
}
if (Date.now() - createdAt > timeout) {
// assume sandbox is gone now since it's expired
sandbox = null;
}
}

console.log(`Checking existence of sandbox for port ${localPort}`);
let sandbox = await Sandbox.get({ teamId, projectId, token, name }).catch(() => null);
let sandboxUrl: string;

if (sandbox) {
console.log(`Found sandbox ${sandbox.name} but it is not running. Current status: ${sandbox.status}`);
sandboxUrl = sandbox.domain(SANDBOX_PORT);
} else {
console.log(`Creating new sandbox for port ${localPort}`);
sandbox = await Sandbox.create({
name,
teamId,
projectId,
token,
Expand All @@ -73,15 +55,11 @@ export async function client({ port, timeout }: { port: number, timeout: number
timeout,
});
sandboxUrl = sandbox.domain(SANDBOX_PORT);
localPortToSandbox[localPort] = { id: sandbox.sandboxId, createdAt: Date.now() };
await writeFile(
VGROK_CONFIG_PATH,
JSON.stringify({ localPortToSandbox } satisfies VgrokConfig)
);
// TODO: can we spawn a new sandbox automatically when timeout reached?
// setTimeout(async () => { newSandbox() }, timeout);
// Alternatively we can kill the ngrok process to avoid confusion.

console.log(`Writing files...`);
await sandbox.writeFiles([
{
content: Buffer.from(JSON.stringify({
Expand All @@ -103,20 +81,21 @@ export async function client({ port, timeout }: { port: number, timeout: number
env: { NPM_CONFIG_UPDATE_NOTIFIER: 'false' }
});
await writeLogs(pnpm);

await sandbox.runCommand({
cmd: 'node',
args: ['server.js'],
detached: true,
env: {
SANDBOX_PORT: String(SANDBOX_PORT),
WS_PATH: WS_PATH,
},
//stderr: process.stderr, // TODO: hide
//stdout: process.stdout, // TODO: hide
});
}

console.log('Starting server in sandbox...');
await sandbox.runCommand({
cmd: 'node',
args: ['server.js'],
detached: true,
env: {
SANDBOX_PORT: String(SANDBOX_PORT),
WS_PATH: WS_PATH,
},
//stderr: process.stderr, // TODO: hide
//stdout: process.stdout, // TODO: hide
});

console.log('Starting local client...');
const socket = new WebSocket(sandboxUrl + WS_PATH);
const connected = Promise.withResolvers<void>();
Expand Down
1 change: 1 addition & 0 deletions tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
// Visit https://aka.ms/tsconfig to read more about this file
"compilerOptions": {
"rootDir": "src",
"outDir": "dist",
"module": "nodenext",
"target": "esnext",
Expand Down