@swmansion/popcorn 0.4.0-next.3 → 0.4.0-next.5

package/README.md

@@ -4,7 +4,7 @@ Run Elixir in a browser with OTP/BEAM compiled to WebAssembly.
 This prerelease replaces the AtomVM runtime used by Popcorn 0.3.x.
 
 Start with the
-[versioned Popcorn guide](https://popcorn.hexdocs.pm/0.4.0-next.3/introduction.html).
+[versioned Popcorn guide](https://popcorn.hexdocs.pm/0.4.0-next.5/introduction.html).
 It includes a complete Mix and Vite tutorial.
 
 ## Install
@@ -13,12 +13,12 @@ It includes a complete Mix and Vite tutorial.
 npm install @swmansion/popcorn@next
 ```
 
-Add `{:popcorn, "0.4.0-next.3"}` to your Elixir application's dependencies.
+Add `{:popcorn, "0.4.0-next.5"}` to your Elixir application's dependencies.
 Run `mix deps.get` before building the JavaScript application. The bundler
 plugins invoke Mix locally to compile and package application and
 standard-library code.
 
-Use the toolchain pinned in [mise.toml](https://github.com/software-mansion/popcorn/blob/v0.4.0-next.3/mise.toml).
+Use the toolchain pinned in [mise.toml](https://github.com/software-mansion/popcorn/blob/v0.4.0-next.5/mise.toml).
 The packager checks host OTP compatibility against the selected runtime's manifest.
 
 ## Configure Vite
@@ -71,6 +71,15 @@ vm.deinit();
 `popcorn.genserver.call()` to call a supervised GenServer from JavaScript.
 Use `popcorn.onEvent()` to receive events from BEAM processes.
 
+Each VM starts with 64 MiB of Wasm linear memory and can grow to 256 MiB on
+phones/tablets or 2 GiB on desktop. Device detection uses the browser's user
+agent and touch support. Configure the limits with
+`Popcorn.init({ beam: { maxMemory: { mobile: "256M", desktop: "2G" } } })`.
+Omit `maxMemory` to keep these defaults, or override either key separately.
+Only `M` and `G` suffixes are supported; they mean MiB and GiB.
+The limit must be a multiple of 64 KiB between 64 MiB and 2 GiB; JavaScript and
+filesystem memory are additional.
+
 ## Serve in production
 
 Serve over HTTPS or localhost. Set these headers on the application and runtime responses:
@@ -85,4 +94,4 @@ Serve `.wasm` as `application/wasm`. Serve compressed `.tar.gz` files with `Cont
 The package also emits uncompressed tar files and Brotli variants. Brotli uses standard effort by default. Set `brotliEffort: "max"` for maximum compression in release builds.
 
 The JavaScript bridge currently requires a Content Security Policy that permits `unsafe-eval`.
-See the [versioned Elixir API](https://popcorn.hexdocs.pm/0.4.0-next.3/) for interoperability details.
+See the [versioned Elixir API](https://popcorn.hexdocs.pm/0.4.0-next.5/) for interoperability details.

package/dist/events.d.ts

@@ -3,7 +3,7 @@ import { type Mapper } from "./etf";
 import type { AnyValue, BeamBootOptions, BeamEvent, BeamSendPayload, BeamTarget } from "./types";
 type BootEvent = {
     type: "popcorn:boot";
-    payload: Pick<BeamBootOptions, "emulatorArgs" | "extraArgs" | "env" | "ttySize" | "noshell"> & {
+    payload: Pick<BeamBootOptions, "emulatorArgs" | "extraArgs" | "env" | "maxMemoryBytes" | "ttySize" | "noshell"> & {
         otpAssetsRoot?: string;
     };
 };

package/dist/index.mjs

@@ -547,6 +547,7 @@ class Popcorn {
     vmWorker;
     state = { status: "created" };
     opts;
+    maxMemoryBytes;
     ttySize;
     output;
     requestSeq = 0;
@@ -624,16 +625,19 @@ class Popcorn {
         check(isValidTtySize(ttySize));
         check(opts.beam?.otpAssetsRoot === undefined ||
             opts.beam.otpAssetsRoot.endsWith("/"), "otpAssetsRoot must end with a slash");
+        const { maxMemory, ...beam } = opts.beam ?? {};
+        this.maxMemoryBytes = resolveMaxMemory(maxMemory);
         this.opts = {
             ...opts,
             beam: {
-                ...opts.beam,
-                emulatorArgs: opts.beam?.emulatorArgs ??
-                    schedulers({ base: 1, dirtyCpu: 1, dirtyIo: 1 }),
+                ...beam,
+                emulatorArgs: beam.emulatorArgs ?? schedulers({ base: 1, dirtyCpu: 1, dirtyIo: 1 }),
             },
         };
         this.ttySize = { ...ttySize };
         this.output = resolveOutputHandlers(opts);
+        if (opts.onEvent)
+            this.onEvent(opts.onEvent);
         this.spawnWorker();
     }
     spawnWorker() {
@@ -648,7 +652,7 @@ class Popcorn {
     /**
      * Creates an instance and waits for {@link boot}.
      *
-     * For startup messages, use the constructor and register {@link onEvent} before boot.
+     * Use `opts.onEvent` to receive messages sent during startup.
      *
      * @returns Ok tuple or `runtime:eval-unavailable` if the page blocks JavaScript evaluation.
      */
@@ -749,6 +753,7 @@ class Popcorn {
                 type: "popcorn:boot",
                 payload: {
                     ...this.opts.beam,
+                    maxMemoryBytes: this.maxMemoryBytes,
                     ttySize: this.ttySize,
                     noshell: this.opts.tty === undefined,
                 },
@@ -1191,6 +1196,23 @@ class Popcorn {
         this.deinit(exitReason(payload));
     }
 }
+function resolveMaxMemory(limits) {
+    const mobileLimit = parseMemorySize(limits?.mobile ?? "256M");
+    const desktopLimit = parseMemorySize(limits?.desktop ?? "2G");
+    const mobile = /Android|Mobile|iPad|iPhone|iPod/.test(navigator.userAgent);
+    const ipad = /Macintosh/.test(navigator.userAgent) && navigator.maxTouchPoints > 1;
+    return mobile || ipad ? mobileLimit : desktopLimit;
+}
+function parseMemorySize(size) {
+    const match = /^(\d+(?:\.\d+)?)([MG])$/.exec(size);
+    check(match !== null, 'maxMemory must use M or G, such as "256M" or "2G"');
+    const bytes = Number(match[1]) * (match[2] === "M" ? 1024 ** 2 : 1024 ** 3);
+    check(Number.isSafeInteger(bytes) &&
+        bytes >= 64 * 1024 * 1024 &&
+        bytes <= 2 * 1024 * 1024 * 1024 &&
+        bytes % 65536 === 0, "maxMemory must be a multiple of 64 KiB between 64 MiB and 2 GiB");
+    return bytes;
+}
 /**
  * Builds `beam.emulatorArgs` for scheduler counts.
  *

package/dist/plugins/vite.mjs

@@ -43,6 +43,7 @@ function popcorn(options) {
     let dirty = false;
     let outDir;
     let assetsDir = "assets";
+    let workerDerivedOtpRoot = `/@fs${distDir}/otp/`;
     // Dev/preview: pack once at server startup, then re-pack lazily after the
     // app's compiled beams change. A single in-flight promise dedupes concurrent
     // requests; a change during a re-pack re-sets `dirty` so it isn't lost.
@@ -78,7 +79,7 @@ function popcorn(options) {
             return;
         }
         const requestPath = decodeURIComponent(new URL(url, "http://localhost").pathname);
-        const requestRoot = [`/${assetsDir}/otp/`, `/@fs${distDir}/otp/`].find((root) => requestPath.startsWith(root));
+        const requestRoot = [`/${assetsDir}/otp/`, workerDerivedOtpRoot].find((root) => requestPath.startsWith(root));
         if (requestRoot === undefined) {
             next();
             return;
@@ -146,6 +147,10 @@ function popcorn(options) {
             config.server.fs.allow.push(distDir);
             outDir = resolve(config.root, config.build.outDir);
             assetsDir = config.build.assetsDir;
+            const servedDistDir = isUnder(config.root, distDir)
+                ? `/${relative(config.root, distDir)}`
+                : `/@fs${distDir}`;
+            workerDerivedOtpRoot = `${servedDistDir}/otp/`;
         },
         async configureServer(server) {
             const rootDir = resolve(options.rootDir);

package/dist/popcorn.d.ts

@@ -1,12 +1,22 @@
 import { type Result } from "./errors";
 import { type PopcornEvent } from "./events";
 import type { AnyValue, BeamBootOptions, OtpErrorPayload, Pid, TtySize } from "./types";
+type MemoryLimits = {
+    mobile?: `${number}${"M" | "G"}`;
+    desktop?: `${number}${"M" | "G"}`;
+};
 /** Output type for a terminal. */
 type TtyOutput = "text" | "bytes";
 type OutputChunk<Output extends TtyOutput> = Output extends "bytes" ? Uint8Array : string;
 /** Browser VM configuration. */
 export type PopcornOpts<Output extends TtyOutput = "text"> = {
     beam?: Pick<BeamBootOptions, "emulatorArgs" | "extraArgs" | "env"> & {
+        /**
+         * Maximum Wasm linear memory by platform. Omitted keys default to
+         * mobile: "256M", desktop: "2G". M and G mean MiB and GiB.
+         * Limits must be in 64 KiB increments between 64 MiB and 2 GiB.
+         */
+        maxMemory?: MemoryLimits;
         /**
          * Asset directory URL.
          *
@@ -60,6 +70,8 @@ export type PopcornOpts<Output extends TtyOutput = "text"> = {
      * Defaults to console output.
      */
     onError?: (event: OtpErrorPayload) => void;
+    /** Receives BEAM message payloads, including messages sent during startup. */
+    onEvent?: (event: PopcornEvent) => void;
     /**
      * Module worker URL.
      *
@@ -87,9 +99,7 @@ export type GenServer = {
     /**
      * Calls a GenServer by registered name or {@link Pid} and waits for its reply.
      *
-     * Requires a running `Popcorn.Proxy`, registered as `popcorn_proxy` by default.
-     *
-     * @param opts - `timeoutMs` defaults to 5 000 ms. `proxy` allows to select another registered proxy.
+     * @param opts - `timeoutMs` defaults to 5 000 ms. `proxy` allows to select another registered proxy (see `Popcorn.Proxy`).
      * @returns A {@link Result} with the reply or a bridge, VM, timeout, or GenServer error.
      *
      * GenServer failures use `genserver:noproc`, `genserver:exit`, or `genserver:unserializable`.
@@ -116,6 +126,7 @@ export declare class Popcorn<Output extends TtyOutput = "text"> {
     private vmWorker;
     private state;
     private readonly opts;
+    private readonly maxMemoryBytes;
     private readonly ttySize;
     private output;
     private requestSeq;
@@ -143,7 +154,7 @@ export declare class Popcorn<Output extends TtyOutput = "text"> {
     /**
      * Creates an instance and waits for {@link boot}.
      *
-     * For startup messages, use the constructor and register {@link onEvent} before boot.
+     * Use `opts.onEvent` to receive messages sent during startup.
      *
      * @returns Ok tuple or `runtime:eval-unavailable` if the page blocks JavaScript evaluation.
      */