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

package/dist/index.d.ts

@@ -1,7 +1,31 @@
 import { VmPtySessionLike } from '@freestyle-sh/with-pty';
-import { VmSpec, VmWithInstance, VmWith } from 'freestyle-sandboxes';
+import { VmWith, VmWithInstance, VmSpec } from 'freestyle-sandboxes';
 
-declare const createSnapshotSpec: (templateRepo: string, workdir: string, devCommand?: string, devCommandPty?: VmPtySessionLike) => VmSpec;
+type DevServerOptions = {
+    templateRepo?: string;
+    repo?: string;
+    workdir?: string;
+    port?: number;
+    installCommand?: string;
+    devCommand?: string;
+    runtime?: VmWith<VmWithInstance> & {
+        installServiceName(): string;
+    };
+    devCommandPty?: VmPtySessionLike;
+};
+type DevServerResolvedOptions = {
+    templateRepo?: string;
+    repo?: string;
+    workdir: string;
+    port: number;
+    installCommand: string;
+    devCommand: string;
+    runtime: VmWith<VmWithInstance> & {
+        installServiceName(): string;
+    };
+    devCommandPty?: VmPtySessionLike;
+};
+declare const createSnapshotSpec: (options: DevServerResolvedOptions) => VmSpec;
 declare class VmDevServerInstance extends VmWithInstance {
     options: {
         workdir: string;
@@ -36,21 +60,12 @@ declare class VmDevServerInstance extends VmWithInstance {
     }>;
 }
 declare class VmDevServer extends VmWith<VmDevServerInstance> {
-    templateRepo?: string;
-    repo?: string;
-    workdir: string;
-    devCommand?: string;
-    devCommandPty?: VmPtySessionLike;
+    options: DevServerResolvedOptions;
     createInstance(): VmDevServerInstance;
-    constructor(options: {
-        templateRepo?: string;
-        repo?: string;
-        workdir?: string;
-        devCommand?: string;
-        devCommandPty?: VmPtySessionLike;
-    });
+    constructor(options: DevServerOptions);
     configureSnapshotSpec(spec: VmSpec): VmSpec | Promise<VmSpec>;
     configureSpec(spec: VmSpec): VmSpec | Promise<VmSpec>;
 }
 
 export { VmDevServer, VmDevServerInstance, createSnapshotSpec };
+export type { DevServerOptions };

package/dist/index.js

@@ -1,55 +1,57 @@
 import { VmNodeJs } from '@freestyle-sh/with-nodejs';
 import { VmSpec, VmWithInstance, VmWith } from 'freestyle-sandboxes';
 
-const createSnapshotSpec = (templateRepo, workdir, devCommand, devCommandPty) => {
-  const resolvedDevCommand = devCommandPty ? devCommandPty.wrapServiceCommand(devCommand ?? "npm run dev", workdir) : devCommand ?? "npm run dev";
+const createSnapshotSpec = (options) => {
+  const resolvedDevCommand = options.devCommandPty ? options.devCommandPty.wrapServiceCommand(options.devCommand, options.workdir) : options.devCommand;
   let newSpec = new VmSpec({
     with: {
-      nodejs: new VmNodeJs({})
+      runtime: options.runtime
     },
     git: {
       repos: [
         {
-          repo: templateRepo,
-          path: workdir
+          repo: options.templateRepo,
+          path: options.workdir
         }
       ]
     },
     systemd: {
       services: [
         {
-          name: "npm-install",
-          bash: "npm install",
+          name: "dev-server-install",
+          bash: options.installCommand,
           mode: "oneshot",
-          workdir
+          workdir: options.workdir,
+          after: [options.runtime.installServiceName()],
+          requires: [options.runtime.installServiceName()]
         },
         {
-          name: "npm-dev",
+          name: "dev-server",
           bash: resolvedDevCommand,
-          after: ["npm-install"],
-          requires: ["npm-install"],
-          workdir
+          after: ["dev-server-install"],
+          requires: ["dev-server-install"],
+          workdir: options.workdir
         },
         {
-          name: "curl-test",
+          name: "dev-server-health",
           bash: `
 set -e
-timeout 10 bash -c 'while ! curl http://localhost:3000; do
+timeout 10 bash -c 'while ! curl http://localhost:${options.port}; do
   echo "Retrying..."
   sleep 1
 done'
 `,
           mode: "oneshot",
-          after: ["npm-dev"],
-          requires: ["npm-dev"],
-          workdir,
+          after: ["dev-server"],
+          requires: ["dev-server"],
+          workdir: options.workdir,
           timeoutSec: 10
         }
       ]
     }
   });
-  if (devCommandPty) {
-    newSpec = devCommandPty.applyToSpec(newSpec);
+  if (options.devCommandPty) {
+    newSpec = options.devCommandPty.applyToSpec(newSpec);
   }
   return newSpec;
 };
@@ -63,7 +65,7 @@ class VmDevServerInstance extends VmWithInstance {
     return `'${value.replace(/'/g, "'\\''")}'`;
   }
   buildJournalctlCommand(options) {
-    const unit = options.unit ?? "npm-dev";
+    const unit = options.unit ?? "dev-server";
     const parts = ["journalctl", "-u", this.shellEscape(unit), "--no-pager"];
     if (options.output) {
       parts.push("-o", this.shellEscape(options.output));
@@ -84,7 +86,7 @@ class VmDevServerInstance extends VmWithInstance {
   }
   async getLogs(options) {
     const pty = this.options.devCommandPty;
-    const shouldUsePtyLogs = pty && (options?.unit === void 0 || options.unit === "npm-dev");
+    const shouldUsePtyLogs = pty && (options?.unit === void 0 || options.unit === "dev-server");
     if (shouldUsePtyLogs) {
       return await this.vm.exec({
         command: pty.captureOutputCommand({
@@ -102,7 +104,7 @@ class VmDevServerInstance extends VmWithInstance {
   }
   async *streamLogs(options) {
     const pty = this.options.devCommandPty;
-    const shouldUsePtyLogs = pty && (options?.unit === void 0 || options.unit === "npm-dev");
+    const shouldUsePtyLogs = pty && (options?.unit === void 0 || options.unit === "dev-server");
     if (shouldUsePtyLogs) {
       const pollIntervalMs2 = options?.pollIntervalMs ?? 1e3;
       let previousOutput = "";
@@ -176,52 +178,46 @@ class VmDevServerInstance extends VmWithInstance {
     }
   }
   async restart() {
-    return await this.vm.exec("systemctl restart npm-dev");
+    return await this.vm.exec("systemctl restart dev-server");
   }
 }
 class VmDevServer extends VmWith {
-  templateRepo;
-  repo;
-  workdir;
-  devCommand;
-  devCommandPty;
+  options;
   createInstance() {
     return new VmDevServerInstance({
-      workdir: this.workdir,
-      devCommandPty: this.devCommandPty
+      workdir: this.options.workdir,
+      devCommandPty: this.options.devCommandPty
     });
   }
   constructor(options) {
     super();
-    this.templateRepo = options.templateRepo;
-    this.repo = options.repo;
-    this.workdir = options.workdir ?? "/repo";
-    this.devCommand = options.devCommand;
-    this.devCommandPty = options.devCommandPty;
+    this.options = {
+      ...options,
+      workdir: options.workdir ?? "/repo",
+      port: options.port ?? 3e3,
+      installCommand: options.installCommand ?? "npm install",
+      devCommand: options.devCommand ?? "npm run dev",
+      runtime: options.runtime ?? new VmNodeJs({})
+    };
   }
   configureSnapshotSpec(spec) {
-    if (this.templateRepo) {
+    if (this.options.templateRepo) {
       const composed = this.composeSpecs(
         spec,
-        createSnapshotSpec(
-          this.templateRepo,
-          this.workdir,
-          this.devCommand,
-          this.devCommandPty
-        )
+        createSnapshotSpec(this.options)
       );
       return composed;
     }
     return spec;
   }
   configureSpec(spec) {
-    if (this.repo) {
+    if (this.options.repo) {
       const newSpec = new VmSpec({
         git: {
           repos: [
             {
-              repo: this.repo,
-              path: this.workdir
+              repo: this.options.repo,
+              path: this.options.workdir
             }
           ]
         }

package/package.json

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