beam.com 0.1.0-rc.2 → 0.1.0-rc.4

package/README.md

@@ -119,7 +119,9 @@ cd hello && ../mix.com deps.get && ../mix.com ecto.migrate
 ```
 
 One file runs natively and in the WebAssembly runtime. Each executable of
-`-o` also has its edge part, of 40 to 180 KB (`--no-edge` leaves it out).
+`-o` also has its edge part, of 40 to 180 KB (`--no-edge` leaves it out,
+and `--target wasm32 -o FILE.com` writes only the edge part, with no native
+program).
 A release directory of `mix release` is an input too:
 
 ```sh
@@ -217,7 +219,7 @@ jobs:
 
 Then turn on Pages one time: Settings, Pages, Source "GitHub Actions". The
 `GITHUB_TOKEN` cannot do this step. Until the release `v0.1.0`, use the
-release candidate `@v0.1.0-rc.2` in place of `@v0.1.0`. With `@main`, the
+release candidate `@v0.1.0-rc.4` in place of `@v0.1.0`. With `@main`, the
 workflow uses the `edge` build of `beam.com`.
 
 The workflow ([`pages-app.yml`](.github/workflows/pages-app.yml)) builds
@@ -284,7 +286,7 @@ Each GitHub release from 0.1.0-rc.2 also holds the package, the same
 file as on npm. npm installs it with no registry:
 
 ```sh
-npm install https://github.com/sntran/BEAM.com/releases/download/v0.1.0-rc.2/beam.com-0.1.0-rc.2.tgz
+npm install https://github.com/sntran/BEAM.com/releases/download/v0.1.0-rc.4/beam.com-0.1.0-rc.4.tgz
 ```
 
 - `BEAM_COM`: the path of a `beam.com` to use. Then nothing is

package/js/beam.com.mjs

@@ -3,11 +3,15 @@
 // (download.mjs). For example: npx beam.com app.erl -o app.com
 //
 // npx beam.com --snapshot APP.com [-o FILE] [--full] [--warm PATH]...
-// [--env NAME=VALUE]...: the snapshot of the build of APP.com for
-// serve(app, { snapshot }) of a Worker (snapshot() of node.mjs), in FILE
-// (default APP.snapshot). It runs here, with no download of beam.com.
+// [--env NAME=VALUE]... [--no-compress]: the snapshot of the build of
+// APP.com for serve(app, { snapshot }) of a Worker (snapshot() of
+// node.mjs), in FILE (default APP.snapshot), with its pages in gzip (not
+// with --full: the global scope of a Worker cannot inflate). Give
+// the BEAM_ERL_FLAGS of the Worker with --env, or in the vars of
+// wrangler.jsonc of this directory: a Worker with other flags boots in
+// place of the snapshot. It runs here, with no download of beam.com.
 import { spawn } from 'node:child_process';
-import { readFileSync, writeFileSync } from 'node:fs';
+import { closeSync, openSync, readFileSync, readSync, statSync, writeFileSync } from 'node:fs';
 import { constants } from 'node:os';
 import { command, ensure } from './download.mjs';
 
@@ -32,6 +36,7 @@ async function snapshotCommand(args) {
     };
     if (a === '-o') out = value();
     else if (a === '--full') opts.kind = 'full';
+    else if (a === '--no-compress') opts.compress = false;
     else if (a === '--warm') opts.warm.push(value());
     else if (a === '--env') {
       const v = value(), at = v.indexOf('=');
@@ -40,14 +45,40 @@ async function snapshotCommand(args) {
     } else if (!a.startsWith('-') && !app) app = a;
     else throw new Error(`--snapshot: unknown argument ${a}`);
   }
-  if (!app) throw new Error('usage: npx beam.com --snapshot APP.com [-o FILE] [--full] [--warm PATH]... [--env NAME=VALUE]...');
+  if (!app) throw new Error('usage: npx beam.com --snapshot APP.com [-o FILE] [--full] [--warm PATH]... [--env NAME=VALUE]... [--no-compress]');
   if (opts.warm.length && opts.kind !== 'full') throw new Error('--warm is for a full snapshot (--full)');
   out ??= app.replace(/\.com$/, '') + '.snapshot';
+  // The flags of the Worker, when --env does not give them: the vars of
+  // its wrangler.jsonc. A Worker with other flags boots in place of the
+  // snapshot.
+  let source = '--env';
+  if (opts.env.BEAM_ERL_FLAGS === undefined) {
+    const { wranglerVars } = await import('./wrangler.mjs');
+    const w = wranglerVars('.');
+    if (typeof w?.vars.BEAM_ERL_FLAGS === 'string') {
+      opts.env.BEAM_ERL_FLAGS = w.vars.BEAM_ERL_FLAGS;
+      source = w.file;
+    }
+  }
   const { snapshot } = await import('./node.mjs');
   const t0 = performance.now();
   const bytes = await snapshot(app, opts);
   writeFileSync(out, bytes);
-  console.error(`beam.com: wrote ${out} (${(bytes.length / 1048576).toFixed(1)} MB, ${opts.kind}, in ${Math.round(performance.now() - t0)} ms)`);
+  const flags = (opts.env.BEAM_ERL_FLAGS ?? '').split(/\s+/).filter(Boolean).join(' ');
+  console.error(`beam.com: wrote ${out} (${(bytes.length / 1048576).toFixed(1)} MB, ${opts.kind}, `
+    + `BEAM_ERL_FLAGS "${flags}"${flags ? ` of ${source}` : ''}, in ${Math.round(performance.now() - t0)} ms)`);
+  if (!flags) console.error('beam.com: a Worker with BEAM_ERL_FLAGS boots in place of this snapshot: give its flags with --env BEAM_ERL_FLAGS=..., or in the vars of wrangler.jsonc');
+  // A Worker can be at most 64 MiB, with all its modules (gzip does not
+  // count): the app file and the snapshot are most of it.
+  const total = statSync(app).size + bytes.length;
+  if (total > 56 * 1048576) {
+    // An APE file starts with "MZ"; a file of --target wasm32 is a zip.
+    const head = Buffer.alloc(2), fd = openSync(app, 'r');
+    try { readSync(fd, head, 0, 2, 0); } finally { closeSync(fd); }
+    const native = head.toString() === 'MZ';
+    console.error(`beam.com: warning: ${app} and ${out} are ${(total / 1048576).toFixed(1)} MiB, and a Worker can be at most 64 MiB`
+      + (native ? `. Build the app with -o FILE.com --target wasm32: a file with no native program, about 25 MB smaller` : ''));
+  }
 }
 
 let release = null;

package/js/download.mjs

@@ -14,6 +14,9 @@ import path from 'node:path';
 
 export const REPOSITORY = 'sntran/BEAM.com';
 
+// The time with no bytes that stops a download (ms).
+const IDLE = 60000;
+
 // The cache directory of beam.com (beam_com:cache_dir/0).
 export function cacheDir(env = process.env) {
   if (env.BEAM_COM_CACHE) return env.BEAM_COM_CACHE;
@@ -37,7 +40,8 @@ export function downloadUrl({ version }, env = process.env) {
 
 // The path of a beam.com that runs. The file in the cache was checked when
 // it was downloaded: a file is in the cache only after the check.
-export async function ensure(release, { env = process.env, platform = process.platform, fetch = globalThis.fetch, log = () => {} } = {}) {
+// idle: the download stops when no bytes come in this time (ms).
+export async function ensure(release, { env = process.env, platform = process.platform, fetch = globalThis.fetch, log = () => {}, idle = IDLE } = {}) {
   if (env.BEAM_COM) return env.BEAM_COM;
   if (!release?.version || !/^[0-9a-f]{64}$/.test(release?.sha256 ?? '')) {
     throw new Error('this package has no release of beam.com (runtime/release.json): set BEAM_COM to the path of a beam.com');
@@ -46,16 +50,36 @@ export async function ensure(release, { env = process.env, platform = process.pl
   if (fs.existsSync(file)) return file;
   const url = downloadUrl(release, env);
   log(`beam.com: downloading ${url}`);
-  const response = await fetch(url);
-  if (!response.ok) throw new Error(`beam.com: ${url}: status ${response.status}`);
+  const ac = new AbortController();
+  let timer;
+  const wait = () => {
+    clearTimeout(timer);
+    timer = setTimeout(() => ac.abort(new Error(`beam.com: ${url}: no bytes in ${idle / 1000} s`)), idle);
+  };
+  wait();
+  let response;
+  try {
+    response = await fetch(url, { signal: ac.signal });
+  } catch (e) {
+    clearTimeout(timer);
+    throw ac.signal.aborted ? ac.signal.reason : e;
+  }
+  if (!response.ok) {
+    clearTimeout(timer);
+    throw new Error(`beam.com: ${url}: status ${response.status}`);
+  }
   fs.mkdirSync(path.dirname(file), { recursive: true });
   const part = `${file}.${process.pid}.part`;
   const out = fs.createWriteStream(part, { mode: 0o755 });
+  // An error of the file (a full disk): no drain comes after it.
+  const failed = new Promise((_, reject) => out.once('error', reject));
+  failed.catch(() => {});
   const hash = createHash('sha256');
   try {
     for await (const chunk of response.body) {
+      wait();
       hash.update(chunk);
-      if (!out.write(chunk)) await new Promise((r) => out.once('drain', r));
+      if (!out.write(chunk)) await Promise.race([new Promise((r) => out.once('drain', r)), failed]);
     }
     await new Promise((resolve, reject) => out.end((e) => (e ? reject(e) : resolve())));
     const got = hash.digest('hex');
@@ -64,7 +88,10 @@ export async function ensure(release, { env = process.env, platform = process.pl
     }
     fs.chmodSync(part, 0o755);
     fs.renameSync(part, file);
+  } catch (e) {
+    throw ac.signal.aborted ? ac.signal.reason : e;
   } finally {
+    clearTimeout(timer);
     out.destroy();
     fs.rmSync(part, { force: true });
   }

package/js/node.mjs

@@ -86,11 +86,16 @@ export async function boot(app, { env = {}, statics = true } = {}) {
 //   It holds the variables of env and the state of the program. A Phoenix
 //   app must give SECRET_KEY_BASE and PHX_HOST, and an app with Ecto
 //   SQLite cannot use it (its boot changes the database).
+// The header of the snapshot keeps BEAM_ERL_FLAGS of env: a Worker with
+// other flags boots in place of the snapshot. compress gives the pages in
+// gzip (BEAMSNZ1, about a quarter of the size). It is the default at the
+// boot point. A full snapshot has no gzip by default: a stateless Worker
+// restores it in the global scope, which cannot inflate.
 // Gives the bytes of the snapshot.
-export async function snapshot(app, { env = {}, warm = [], kind = 'boot-point' } = {}) {
+export async function snapshot(app, { env = {}, warm = [], kind = 'boot-point', compress = kind !== 'full' } = {}) {
   if (kind !== 'boot-point' && kind !== 'full') throw new Error(`the kind of snapshot is boot-point or full, not ${kind}`);
   const bin = await readApp(app, appFiles);
-  const { Vm, releaseMeta } = await import(new URL('worker.js', runtimeUrl).href);
+  const { Vm, releaseMeta, packSnapshot } = await import(new URL('worker.js', runtimeUrl).href);
   const meta = releaseMeta(bin);
   if (kind === 'full') {
     if (meta.sql) throw new Error(`${app}: the app has Ecto SQLite: use a snapshot at the boot point`);
@@ -122,5 +127,5 @@ export async function snapshot(app, { env = {}, warm = [], kind = 'boot-point' }
     bytes = await vm.snapshot(false);
   }
   if (!(bytes instanceof Uint8Array)) throw new Error(`${app}: no snapshot (${bytes}): the VM was not quiet`);
-  return bytes;
+  return compress ? packSnapshot(bytes) : bytes;
 }

package/js/wrangler.mjs

@@ -0,0 +1,47 @@
+// The vars of the Wrangler file of a project (wrangler.jsonc, else
+// wrangler.json), for npx beam.com --snapshot: the snapshot gets the
+// BEAM_ERL_FLAGS of the Worker. Wrangler reads JSONC: comments (// and
+// /* */) and a comma before } or ]. wrangler.toml is not read.
+import { readFileSync } from 'node:fs';
+import { join } from 'node:path';
+
+// {file, vars} of the first Wrangler file of dir, or null.
+export function wranglerVars(dir = '.') {
+  for (const name of ['wrangler.jsonc', 'wrangler.json']) {
+    let text;
+    try {
+      text = readFileSync(join(dir, name), 'utf8');
+    } catch {
+      continue;
+    }
+    const vars = jsonc(text).vars;
+    return { file: name, vars: vars && typeof vars === 'object' ? vars : {} };
+  }
+  return null;
+}
+
+// The value of a JSONC text.
+export function jsonc(text) {
+  let out = '';
+  for (let i = 0; i < text.length; i++) {
+    const c = text[i];
+    if (c === '"') {
+      // A string, with its escapes, as it is.
+      let j = i + 1;
+      while (j < text.length && text[j] !== '"') j += text[j] === '\\' ? 2 : 1;
+      out += text.slice(i, j + 1);
+      i = j;
+    } else if (c === '/' && text[i + 1] === '/') {
+      while (i < text.length && text[i] !== '\n') i++;
+      out += '\n';
+    } else if (c === '/' && text[i + 1] === '*') {
+      const end = text.indexOf('*/', i + 2);
+      i = end < 0 ? text.length : end + 1;
+      out += ' ';
+    } else {
+      out += c;
+    }
+  }
+  // A comma before } or ] (outside the strings, which have no newline).
+  return JSON.parse(out.replace(/,(\s*[}\]])/g, '$1'));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "beam.com",
-  "version": "0.1.0-rc.2",
+  "version": "0.1.0-rc.4",
   "description": "Erlang/OTP and Elixir in one executable file: npx beam.com, and the WebAssembly runtime for a native app.com",
   "license": "Apache-2.0",
   "repository": {