@freestyle-sh/with-dev-server 0.1.4 → 0.1.5

package/README.md

@@ -13,6 +13,7 @@ npm install @freestyle-sh/with-nodejs freestyle-sandboxes
 ```typescript
 import { freestyle, VmSpec } from "freestyle-sandboxes";
 import { VmDevServer } from "../src/index";
+import { VmPtySession } from "@freestyle-sh/with-pty";
 
 const TEMPLATE_REPO = "https://github.com/freestyle-sh/freestyle-next";
 
@@ -23,14 +24,17 @@ const { repoId } = await freestyle.git.repos.create({
 });
 
 const domain = `${repoId}.style.dev`;
+const devPty = new VmPtySession({ sessionId: "dev-server" });
 
 const { vm } = await freestyle.vms.create({
   snapshot: new VmSpec({
     with: {
+      devPty,
       devServer: new VmDevServer({
         workdir: "/repo",
         templateRepo: TEMPLATE_REPO,
         devCommand: "npm run dev",
+        devCommandPty: devPty,
       }),
     },
   }),

package/dist/index.d.ts

@@ -1,12 +1,15 @@
+import { VmPtySessionLike } from '@freestyle-sh/with-pty';
 import { VmSpec, VmWithInstance, VmWith } from 'freestyle-sandboxes';
 
-declare const createSnapshotSpec: (templateRepo: string, workdir: string, devCommand?: string) => VmSpec;
+declare const createSnapshotSpec: (templateRepo: string, workdir: string, devCommand?: string, devCommandPty?: VmPtySessionLike) => VmSpec;
 declare class VmDevServerInstance extends VmWithInstance {
     options: {
         workdir: string;
+        devCommandPty?: VmPtySessionLike;
     };
     constructor(options: {
         workdir: string;
+        devCommandPty?: VmPtySessionLike;
     });
     private shellEscape;
     private buildJournalctlCommand;
@@ -37,12 +40,14 @@ declare class VmDevServer extends VmWith<VmDevServerInstance> {
     repo?: string;
     workdir: string;
     devCommand?: string;
+    devCommandPty?: VmPtySessionLike;
     createInstance(): VmDevServerInstance;
     constructor(options: {
         templateRepo?: string;
         repo?: string;
         workdir?: string;
         devCommand?: string;
+        devCommandPty?: VmPtySessionLike;
     });
     configureSnapshotSpec(spec: VmSpec): VmSpec | Promise<VmSpec>;
     configureSpec(spec: VmSpec): VmSpec | Promise<VmSpec>;

package/dist/index.js

@@ -1,8 +1,9 @@
 import { VmNodeJs } from '@freestyle-sh/with-nodejs';
 import { VmSpec, VmWithInstance, VmWith } from 'freestyle-sandboxes';
 
-const createSnapshotSpec = (templateRepo, workdir, devCommand) => {
-  const newSpec = new VmSpec({
+const createSnapshotSpec = (templateRepo, workdir, devCommand, devCommandPty) => {
+  const resolvedDevCommand = devCommandPty ? devCommandPty.wrapServiceCommand(devCommand ?? "npm run dev", workdir) : devCommand ?? "npm run dev";
+  let newSpec = new VmSpec({
     with: {
       nodejs: new VmNodeJs({})
     },
@@ -24,7 +25,7 @@ const createSnapshotSpec = (templateRepo, workdir, devCommand) => {
         },
         {
           name: "npm-dev",
-          bash: devCommand ?? "npm run dev",
+          bash: resolvedDevCommand,
           after: ["npm-install"],
           requires: ["npm-install"],
           workdir
@@ -47,6 +48,9 @@ done'
       ]
     }
   });
+  if (devCommandPty) {
+    newSpec = devCommandPty.applyToSpec(newSpec);
+  }
   return newSpec;
 };
 class VmDevServerInstance extends VmWithInstance {
@@ -79,6 +83,16 @@ class VmDevServerInstance extends VmWithInstance {
     return parts.join(" ");
   }
   async getLogs(options) {
+    const pty = this.options.devCommandPty;
+    const shouldUsePtyLogs = pty && (options?.unit === void 0 || options.unit === "npm-dev");
+    if (shouldUsePtyLogs) {
+      return await this.vm.exec({
+        command: pty.captureOutputCommand({
+          lines: options?.lines ?? 200,
+          includeEscape: true
+        })
+      });
+    }
     const command = this.buildJournalctlCommand({
       unit: options?.unit,
       lines: options?.lines ?? 200,
@@ -87,6 +101,38 @@ class VmDevServerInstance extends VmWithInstance {
     return await this.vm.exec({ command });
   }
   async *streamLogs(options) {
+    const pty = this.options.devCommandPty;
+    const shouldUsePtyLogs = pty && (options?.unit === void 0 || options.unit === "npm-dev");
+    if (shouldUsePtyLogs) {
+      const pollIntervalMs2 = options?.pollIntervalMs ?? 1e3;
+      let previousOutput = "";
+      const sleep2 = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+      while (true) {
+        if (options?.signal?.aborted) {
+          return;
+        }
+        const result = await this.vm.exec({
+          command: pty.captureOutputCommand({
+            lines: options?.lines ?? 200,
+            includeEscape: true
+          })
+        });
+        if (result.statusCode && result.statusCode !== 0) {
+          const error = result.stderr ?? "Failed to read PTY logs";
+          throw new Error(error);
+        }
+        const output = result.stdout ?? "";
+        const delta = output.startsWith(previousOutput) ? output.slice(previousOutput.length) : output;
+        for (const line of delta.split(/\r?\n/)) {
+          if (!line) {
+            continue;
+          }
+          yield line;
+        }
+        previousOutput = output;
+        await sleep2(pollIntervalMs2);
+      }
+    }
     const pollIntervalMs = options?.pollIntervalMs ?? 1e3;
     let cursor = void 0;
     let first = true;
@@ -138,9 +184,11 @@ class VmDevServer extends VmWith {
   repo;
   workdir;
   devCommand;
+  devCommandPty;
   createInstance() {
     return new VmDevServerInstance({
-      workdir: this.workdir
+      workdir: this.workdir,
+      devCommandPty: this.devCommandPty
     });
   }
   constructor(options) {
@@ -149,12 +197,18 @@ class VmDevServer extends VmWith {
     this.repo = options.repo;
     this.workdir = options.workdir ?? "/repo";
     this.devCommand = options.devCommand;
+    this.devCommandPty = options.devCommandPty;
   }
   configureSnapshotSpec(spec) {
     if (this.templateRepo) {
       const composed = this.composeSpecs(
         spec,
-        createSnapshotSpec(this.templateRepo, this.workdir, this.devCommand)
+        createSnapshotSpec(
+          this.templateRepo,
+          this.workdir,
+          this.devCommand,
+          this.devCommandPty
+        )
       );
       return composed;
     }

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@freestyle-sh/with-dev-server",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "private": false,
   "dependencies": {
-    "freestyle-sandboxes": "^0.1.27",
-    "@freestyle-sh/with-nodejs": "^0.2.6"
+    "freestyle-sandboxes": "^0.1.28",
+    "@freestyle-sh/with-nodejs": "^0.2.7",
+    "@freestyle-sh/with-pty": "^0.0.2"
   },
   "type": "module",
   "main": "./dist/index.js",