feat(vercel-sandbox): fix bug with resuming sandbox during file read (#102)

Fix bug with resuming sandboxes when reading a file. I have also added
an integration tests to detect if this behavior is broken in the future,
as it follows a different path from the other commands (it is a stream).

TL;DR: we were missing the `parseOrThrow` in this method, and
`withResume()` wrapper checks for an error before resuming (we were
returning the error as string)

Author: marc-vercel

.changeset/pre.json

@@ -19,6 +19,7 @@
     "common-corners-leave",
     "cyan-bats-clap",
     "dirty-cows-talk",
+    "easy-geckos-grab",
     "fair-pears-dream",
     "fresh-rings-rescue",
     "legal-rings-work",

packages/sandbox/CHANGELOG.md

@@ -1,5 +1,12 @@
 # sandbox
 
+## 3.0.0-beta.8
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @vercel/sandbox@2.0.0-beta.8
+
 ## 3.0.0-beta.7
 
 ### Patch Changes

packages/sandbox/docs/index.md

@@ -1,7 +1,7 @@
 ## `sandbox --help`
 
 ```
-sandbox 3.0.0-beta.7
+sandbox 3.0.0-beta.8
 
 ▲ sandbox [options] <command>
 

packages/sandbox/package.json

@@ -1,7 +1,7 @@
 {
   "name": "sandbox",
   "description": "Command line interface for Vercel Sandbox",
-  "version": "3.0.0-beta.7",
+  "version": "3.0.0-beta.8",
   "scripts": {
     "clean": "rm -rf node_modules dist",
     "sandbox": "ts-node ./src/sandbox.ts",

packages/vercel-sandbox/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @vercel/sandbox
 
+## 2.0.0-beta.8
+
+### Patch Changes
+
+- Fix an error with resuming while reading a file
+
 ## 2.0.0-beta.7
 
 ### Patch Changes

packages/vercel-sandbox/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/sandbox",
-  "version": "2.0.0-beta.7",
+  "version": "2.0.0-beta.8",
   "description": "Software Development Kit for Vercel Sandbox",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

packages/vercel-sandbox/src/api-client/api-client.ts

@@ -518,6 +518,10 @@ export class APIClient extends BaseClient {
       return null;
     }
 
+    if (!response.ok) {
+      await parseOrThrow(z.any(), response);
+    }
+
     if (response.body === null) {
       return null;
     }

packages/vercel-sandbox/src/sandbox.test.ts

@@ -347,6 +347,16 @@ for (const port of ports) {
     expect(await result.stdout()).toContain("resumed!");
   });
 
+  it("auto-resumes a stopped session when reading a file", async () => {
+    await sandbox.writeFiles([
+      { path: "persist.txt", content: Buffer.from("persisted content") },
+    ]);
+    await sandbox.stop({ blocking: true });
+
+    const content = await sandbox.readFileToBuffer({ path: "persist.txt" });
+    expect(content?.toString()).toBe("persisted content");
+  });
+
   it("raises an error when the timeout cannot be updated", async () => {
     try {
       await sandbox.extendTimeout(ms("5d"));

packages/vercel-sandbox/src/version.ts

@@ -1,2 +1,2 @@
 // Autogenerated by inject-version.ts
-export const VERSION = "2.0.0-beta.7";
+export const VERSION = "2.0.0-beta.8";