@freestyle-sh/with-dev-server 0.1.1

package/README.md

@@ -0,0 +1,49 @@
+# @freestyle-sh/with-nodejs
+
+Node.js runtime via [NVM](https://github.com/nvm-sh/nvm) for [Freestyle](https://freestyle.sh) VMs.
+
+## Installation
+
+```bash
+npm install @freestyle-sh/with-nodejs freestyle-sandboxes
+```
+
+## Usage
+
+```typescript
+import { freestyle, VmSpec } from "freestyle-sandboxes";
+import { VmDevServer } from "../src/index";
+
+const TEMPLATE_REPO = "https://github.com/freestyle-sh/freestyle-next";
+
+const { repoId } = await freestyle.git.repos.create({
+  source: {
+    url: TEMPLATE_REPO,
+  },
+});
+
+const domain = `${repoId}.style.dev`;
+
+const { vm } = await freestyle.vms.create({
+  snapshot: new VmSpec({
+    with: {
+      devServer: new VmDevServer({
+        workdir: "/repo",
+        templateRepo: TEMPLATE_REPO,
+      }),
+    },
+  }),
+  with: {
+    devServer: new VmDevServer({
+      repo: repoId,
+    }),
+  },
+  domains: [
+    {
+      domain: domain,
+      vmPort: 3000,
+    },
+  ],
+});
+
+```

package/dist/index.d.ts

@@ -0,0 +1,49 @@
+import { VmSpec, VmWithInstance, VmWith } from 'freestyle-sandboxes';
+
+declare const createSnapshotSpec: (templateRepo: string) => VmSpec;
+declare class VmDevServerInstance extends VmWithInstance {
+    options: {
+        workdir: string;
+    };
+    constructor(options: {
+        workdir: string;
+    });
+    private shellEscape;
+    private buildJournalctlCommand;
+    getLogs(options?: {
+        unit?: string;
+        lines?: number;
+        since?: string;
+    }): Promise<{
+        statusCode?: number | undefined | null;
+        stdout?: string | undefined | null;
+        stderr?: string | undefined | null;
+    }>;
+    streamLogs(options?: {
+        unit?: string;
+        lines?: number;
+        since?: string;
+        pollIntervalMs?: number;
+        signal?: AbortSignal;
+    }): AsyncGenerator<string>;
+    restart(): Promise<{
+        statusCode?: number | undefined | null;
+        stdout?: string | undefined | null;
+        stderr?: string | undefined | null;
+    }>;
+}
+declare class VmDevServer extends VmWith<VmDevServerInstance> {
+    templateRepo?: string;
+    repo?: string;
+    workdir: string;
+    createInstance(): VmDevServerInstance;
+    constructor(options: {
+        templateRepo?: string;
+        repo?: string;
+        workdir?: string;
+    });
+    configureSnapshotSpec(spec: VmSpec): VmSpec | Promise<VmSpec>;
+    configureSpec(spec: VmSpec): VmSpec | Promise<VmSpec>;
+}
+
+export { VmDevServer, VmDevServerInstance, createSnapshotSpec };

package/dist/index.js

@@ -0,0 +1,179 @@
+import { VmNodeJs } from '@freestyle-sh/with-nodejs';
+import { VmSpec, VmWithInstance, VmWith } from 'freestyle-sandboxes';
+
+const createSnapshotSpec = (templateRepo) => {
+  const newSpec = new VmSpec({
+    with: {
+      nodejs: new VmNodeJs({})
+    },
+    git: {
+      repos: [
+        {
+          repo: templateRepo,
+          path: "/repo"
+        }
+      ]
+    },
+    systemd: {
+      services: [
+        {
+          name: "npm-install",
+          bash: "npm install",
+          mode: "oneshot",
+          workdir: "/repo"
+        },
+        {
+          name: "npm-dev",
+          bash: "npm run dev",
+          after: ["npm-install"],
+          requires: ["npm-install"],
+          workdir: "/repo"
+        },
+        {
+          name: "curl-test",
+          bash: `
+set -e
+timeout 10 bash -c 'while ! curl http://localhost:3000; do
+  echo "Retrying..."
+  sleep 1
+done'
+`,
+          mode: "oneshot",
+          after: ["npm-dev"],
+          requires: ["npm-dev"],
+          workdir: "/repo",
+          timeoutSec: 10
+        }
+      ]
+    }
+  });
+  return newSpec;
+};
+class VmDevServerInstance extends VmWithInstance {
+  constructor(options) {
+    super();
+    this.options = options;
+  }
+  shellEscape(value) {
+    return `'${value.replace(/'/g, "'\\''")}'`;
+  }
+  buildJournalctlCommand(options) {
+    const unit = options.unit ?? "npm-dev";
+    const parts = ["journalctl", "-u", this.shellEscape(unit), "--no-pager"];
+    if (options.output) {
+      parts.push("-o", this.shellEscape(options.output));
+    }
+    if (options.lines !== void 0) {
+      parts.push("-n", String(options.lines));
+    }
+    if (options.since) {
+      parts.push("--since", this.shellEscape(options.since));
+    }
+    if (options.afterCursor) {
+      parts.push("--after-cursor", this.shellEscape(options.afterCursor));
+    }
+    if (options.showCursor) {
+      parts.push("--show-cursor");
+    }
+    return parts.join(" ");
+  }
+  async getLogs(options) {
+    const command = this.buildJournalctlCommand({
+      unit: options?.unit,
+      lines: options?.lines ?? 200,
+      since: options?.since
+    });
+    return await this.vm.exec({ command });
+  }
+  async *streamLogs(options) {
+    const pollIntervalMs = options?.pollIntervalMs ?? 1e3;
+    let cursor = void 0;
+    let first = true;
+    const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+    while (true) {
+      if (options?.signal?.aborted) {
+        return;
+      }
+      const command = this.buildJournalctlCommand({
+        unit: options?.unit,
+        lines: first ? options?.lines ?? 200 : void 0,
+        since: first ? options?.since : void 0,
+        afterCursor: first ? void 0 : cursor,
+        showCursor: true,
+        output: "cat"
+      });
+      const result = await this.vm.exec({ command });
+      if (result.statusCode && result.statusCode !== 0) {
+        const error = result.stderr ?? "Failed to read logs";
+        throw new Error(error);
+      }
+      const output = result.stdout ?? "";
+      let nextCursor = cursor;
+      for (const line of output.split(/\r?\n/)) {
+        if (!line) {
+          continue;
+        }
+        const cursorMatch = line.match(/^-- cursor: (.+)$/);
+        if (cursorMatch) {
+          nextCursor = cursorMatch[1].trim();
+          continue;
+        }
+        if (line.startsWith("-- No entries")) {
+          continue;
+        }
+        yield line;
+      }
+      cursor = nextCursor;
+      first = false;
+      await sleep(pollIntervalMs);
+    }
+  }
+  async restart() {
+    return await this.vm.exec("systemctl restart npm-dev");
+  }
+}
+class VmDevServer extends VmWith {
+  templateRepo;
+  repo;
+  workdir = "/repo";
+  createInstance() {
+    return new VmDevServerInstance({
+      workdir: this.workdir
+    });
+  }
+  constructor(options) {
+    super();
+    this.templateRepo = options.templateRepo;
+    this.repo = options.repo;
+    this.workdir = options.workdir ?? "/repo";
+  }
+  configureSnapshotSpec(spec) {
+    if (this.templateRepo) {
+      const composed = this.composeSpecs(
+        spec,
+        createSnapshotSpec(this.templateRepo)
+      );
+      return composed;
+    }
+    return spec;
+  }
+  configureSpec(spec) {
+    if (this.repo) {
+      const newSpec = new VmSpec({
+        git: {
+          repos: [
+            {
+              repo: this.repo,
+              path: this.workdir
+            }
+          ]
+        }
+      });
+      return this.composeSpecs(spec, newSpec);
+    } else {
+      return spec;
+    }
+  }
+}
+
+export { VmDevServer, VmDevServerInstance, createSnapshotSpec };

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@freestyle-sh/with-dev-server",
+  "version": "0.1.1",
+  "private": false,
+  "dependencies": {
+    "freestyle-sandboxes": "^0.1.24",
+    "@freestyle-sh/with-nodejs": "^0.2.3"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "source": "./src/index.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "pkgroll"
+  }
+}