microsandbox-rb 0.9.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69a06d8d3c54bdd0339a3149904ac906377ddcc3aa295725548ceac20001b1ae
-  data.tar.gz: ca7b9c5ed1ca3d35bec0b2229db7f1f229b58964f89c48e386e187d8d7bb0dd4
+  metadata.gz: 05d5b2e1200b6aff7dc7801259558a202064a01cac529ea55f2390790b7f84bb
+  data.tar.gz: d4d357393a51e2b642dd9d6fc6e899a6a92a3895bf98495a01714fbdbb76c0ed
 SHA512:
-  metadata.gz: 4d11c9b6a98de5c66b4d0fda89d7b8efe3610d68408e96664707f150cb358bb3ca9e6550acf684e12e9989cf70211a79a45b7dc5603f4d6b0861be41c4528690
-  data.tar.gz: dfe032911a9207ba074a47bc9065c0e78f45537b4b3fd9d8059f9e08def6211c35e6a5fcfd93ebc26fe9f7dda818924d298274c7d99d91ee00cfc63b61c44865
+  metadata.gz: 994d487f8a606de2664566519ba28964fcc1053e9277b768945472dfac105d34a48479b1677d8598fde596b4d5c9f37a31970d2cf3e3a2065f98a12fdfe85322
+  data.tar.gz: c0d57191ef9fc97845c773216dd19194dbad4dd0c58f3525989d16df0c37088749fe880ccd89b53d71f9f9454c149429886de208b36cda2de4210f23b4bc05f8

data/CHANGELOG.md

@@ -6,6 +6,182 @@ All notable changes to this gem are documented here. The format is based on
 microsandbox runtime it embeds; each release notes the upstream runtime tag it
 wraps, and the README's Versioning section keeps the full gem→runtime map.
 
+## [0.11.0] - 2026-07-27
+
+Adopts upstream runtime **`v0.6.6` → `v0.6.7`** and mirrors its breaking SDK
+surface, keeping parity with the Python/Node SDKs (which ship the same renames
+without compatibility aliases). The bundled runtime also carries the fix for
+**GHSA-4vq3-cjpp-v7fg** (`msb copy` symlink traversal: a sandboxed workload
+could make a later CLI copy-out overwrite an arbitrary host file — the SDK
+`fs`/`copy_to_host` paths were not affected).
+
+### Breaking
+
+- **Network presets `public_only`/`non_local` are removed** (upstream #1198),
+  replaced by composable **profiles** `:public` / `:private` / `:host`:
+  `network: [:public, :private]`, single-profile sugar `network: :public`, or
+  `NetworkPolicy.from_profiles(:public, :host)`. Any non-empty profile set
+  automatically allows gateway DNS. The replacements are rule-for-rule
+  equivalent (`public_only` ≡ `[:public]`, which is still the default policy;
+  `non_local` ≡ `[:public, :private]`); the removed spellings (and
+  `NetworkPolicy.public_only`/`.non_local`) now raise an `ArgumentError` with
+  that migration guidance. `network: :none`/`:allow_all` (and their aliases)
+  and `network: :default` keep working unchanged. In the Hash form,
+  `profiles:` composes with `rules:`/`default_egress:`/`default_ingress:`/deny
+  lists; explicit `rules:` are evaluated **before** the profile expansion
+  (matching the upstream CLI), so a narrower override such as
+  `Rule.deny_dns` wins over a profile's allows under first-match-wins.
+- **`Snapshot.create` is re-keyed by the snapshot's own name** (upstream
+  #1118): `Snapshot.create(name, from_sandbox:, dest_dir:, labels:, force:,
+  record_integrity:, resumable:)` — the positional argument is now the
+  snapshot name (was: the source sandbox), `from_sandbox:` is required, and
+  `path:` is replaced by `dest_dir:`, a **parent directory** (the artifact
+  always lands at `dest_dir/<name>`). `record_integrity:` is now a no-op
+  (schema-1 descriptors always record integrity); `resumable:` is accepted and
+  raises `UnsupportedError` until VM pause/resume lands upstream.
+- **`Snapshot.export`/`Snapshot.import` are renamed `Snapshot.save`/
+  `Snapshot.load`** (same parameters), matching the Python/Node rename.
+- **`SandboxHandle#snapshot_to` is removed** (deleted upstream). Use
+  `Snapshot.create(name, from_sandbox: handle_name, dest_dir: dir)` for
+  explicit placement.
+- **`SnapshotVerifyReport#not_recorded?` is removed** and `#status` is always
+  `:verified`: integrity is now mandatory at snapshot-create time, so the
+  "not recorded" outcome no longer exists (a mismatch raises
+  `SnapshotIntegrityError` as before).
+- **`SnapshotInfo#size_bytes`/`#format`/`#fstype` are now nilable** — nil for
+  the new checkpoint-state snapshots (file-state snapshots, the only kind
+  producible today, still populate all three).
+
+### Added
+
+- **Structured root disk** (upstream #1165) — `Sandbox.create(root_disk:)`
+  configures the OCI sandbox's writable layer: an Integer (managed ext4 upper
+  size cap in MiB, the old `oci_upper_size:` meaning), or a `RootDisk` factory
+  Hash: `RootDisk.managed(8192)`, `RootDisk.tmpfs(2048)` (RAM-backed, pristine
+  rootfs on every boot; size ≤ sandbox memory; not snapshot/patchable), or
+  `RootDisk.disk("./scratch.img", format:, fstype:)` (user-supplied image
+  attached writable; never created/resized/deleted by the runtime).
+  `oci_upper_size:` remains as a deprecated alias (warns; conflicts with
+  `root_disk:`).
+- **`Image.load` / `Image.save`** (upstream #1151/#1174) — move OCI images in
+  and out of the local cache as `docker save`-style or OCI Image Layout
+  archives: `Image.load("./app.tar", tag: "app:dev")` (pass `"-"` to read
+  stdin; returns the loaded `ImageInfo`s) and
+  `Image.save("alpine:latest", output_path: "./alpine.tar", format: :docker)`.
+- **`Rule.allow_dns` / `Rule.deny_dns`** — the gateway-DNS rule pair the
+  profiles expand to (egress → group `:host`, udp+tcp, port 53), for use in
+  custom policies (`deny_dns` upstream #1198).
+- **Snapshot descriptor metadata** on `SnapshotInfo`: `#scope` (`:disk` /
+  `:resumable`), `#state_kind` (`"file"`/`"checkpoint"`), `#checkpoint_id`,
+  `#checkpoint_manifest_digest`, and the index columns `#locality`,
+  `#availability`, `#migration_state`, `#migration_error_code`.
+- **`SnapshotMigrationError`** — raised when the automatic v0.6.6→v0.6.7
+  snapshot-descriptor migration is blocked and needs repair (new core
+  `SnapshotMigration` variant, upstream #1200).
+- **`follow_root_symlinks:` volume flag** — per-mount opt-out of the runtime's
+  new default-on mount-root symlink protection (upstream #1149; bind/named
+  mounts only). The Rust SDK exposes the same switch; Python/Node defer it.
+
+### Changed
+
+- **Snapshot artifacts migrate on first use** (upstream #1200): the runtime
+  rewrites each v0.6.6 `manifest.json` descriptor to the v0.6.7
+  `snapshot.json` (keeping the old file as `.manifest.json.legacy`) at backend
+  connect, after which gems ≤ 0.10.x can no longer read those artifacts —
+  rolling back requires the upstream `msb self downgrade` tooling.
+- **Bind/named mount roots refuse symlinked roots by default** (upstream
+  #1149) — opt out per mount with `follow_root_symlinks: true`.
+- **DNS rebind protection is fail-closed for unspecified addresses** (upstream
+  #1198): `0.0.0.0`/`::` no longer classify as `public`, so a `public`-profile
+  sandbox can't be steered to them via DNS answers.
+- `ModificationPlan` change/conflict entries for the managed upper now report
+  `field: "root_disk_size"` (was `"oci_upper_size"`) — the runtime's canonical
+  field name, passed through verbatim as always.
+- Duplicate secret placeholders across secret entries are now allowed
+  (upstream #1178); snapshotting a tmpfs or disk-image root disk fails with a
+  purposeful `InvalidConfigError` (upstream #1169).
+
+## [0.10.0] - 2026-07-09
+
+Ruby bindings for the additive `v0.6.6` SDK surface (upstream #1099 / #1128),
+bringing the gem to parity with the Python and Node SDKs, which already ship
+this API. The embedded runtime tag is unchanged (`v0.6.6`); this is a pure
+binding addition with no breaking change.
+
+### Added
+
+- **Live sandbox modification** — `Sandbox#modify` and `SandboxHandle#modify`
+  plan or apply a change to a running (or stopped) sandbox without recreating
+  it: resize CPU/memory (`cpus:`, `max_cpus:`, `memory:`, `max_memory:`, MiB),
+  adjust `env:`/`remove_env:`, `labels:`/`remove_labels:`, and `workdir:`, and
+  rotate/remove secrets (`secrets:` keyed by name with mutually-exclusive
+  `env:`/`store:`/`value:` plus `placeholder:`/`allowed_hosts:`,
+  `remove_secrets:`). `policy:` selects `:no_restart` (default), `:next_start`,
+  or `:restart`; `dry_run: true` computes the plan without applying it. Returns
+  a typed `ModificationPlan` (`#sandbox`, `#status`, `#applied?`, `#policy`,
+  `#changes`, `#conflicts`, `#warnings`, `#resize_status`) whose nested entries
+  are frozen, symbol-keyed Hashes carrying the runtime's canonical snake_case
+  fields verbatim.
+- **Health checks** — `Sandbox#ping` / `SandboxHandle#ping` return a
+  `PingResult` (`#name`, `#latency` in seconds, `#latency_ms`) confirming the
+  guest agent is reachable **without** refreshing the idle timer; `#touch`
+  returns a `TouchResult` (`#name`, `#activity_seq`) that explicitly refreshes
+  the idle-activity timer. On the handle, both raise `SandboxNotRunningError`
+  for a stopped sandbox (it is not started implicitly).
+- **Create-time resource ceilings** — `Sandbox.create` accepts `max_cpus:` and
+  `max_memory:` (MiB), the boot-time maxima a later live `modify` can grow up
+  to (each defaults to its `cpus:`/`memory:` value and must be >= it).
+- **`SandboxNotRunningError`** is now raised by the runtime's not-running guard
+  (the class already existed; the new core `SandboxNotRunning` variant is now
+  mapped to it instead of falling back to the base `Error`).
+
+Deliberately **not** exposed, matching the Python and Node SDKs (both surface
+these only through the CLI): `modify`'s `oci_upper_size` overlay-grow field, and
+the `SandboxMetricsReport` / per-sandbox metrics-report helpers.
+
+## [0.9.3] - 2026-07-09
+
+Adopts upstream runtime **`v0.6.3` → `v0.6.6`** (spanning upstream `v0.6.4` and
+`v0.6.6`; `v0.6.5` was yanked upstream — its GitHub release was pulled and the
+type-model refactor it shipped, #1014, was reverted in `v0.6.6`, #1143). The
+upstream SDK crate's public API grew only *additive* surface (live
+modify/resize, ping/touch — Ruby bindings for these land in the next minor),
+so this is a pure runtime bump with no Ruby API change.
+
+### Fixed
+
+- **Snapshot restore survives upstream tag republishes** (upstream #1130):
+  restore now pulls the OCI image by its pinned manifest digest
+  (`<repo>@sha256:…`) instead of re-resolving the mutable tag, fixing a fatal
+  `v0.6.3` regression where a republished base-image tag made existing
+  snapshots unrestorable.
+- **Fragmented UDP and PMTU relay traffic is forwarded correctly** (upstream
+  #1086) by the sandbox network relay.
+- **`exec` termination kills the whole process group, not just the direct
+  child** (upstream #1104): guest commands that spawn children (e.g. shell
+  pipelines) no longer leave orphaned grandchildren running after a kill.
+- **Stop waits tolerate ephemeral cleanup** (upstream #1087, inherited in
+  `Sandbox#stop`/`SandboxHandle#wait_until_stopped`): if an ephemeral
+  sandbox's persisted state is cleaned up while a stop wait is in flight, the
+  wait now resolves to a synthetic `stopped` result instead of raising
+  `SandboxNotFoundError`. Persistent sandboxes are unaffected.
+- **Filesystem snapshot `readdir` streams entries** (upstream #1133), fixing
+  unbounded memory growth (RSS leak) when listing very large directories.
+
+### Changed
+
+- **Embedded runtime is now `v0.6.6`** (`Microsandbox::RUNTIME_VERSION` /
+  `Microsandbox.runtime_version`). Also inherited:
+  - `Sandbox.create`/`.start` persist an active-config snapshot of the booted
+    sandbox in the runtime database (upstream SDK behavior; groundwork for
+    live modification).
+  - The runtime's shutdown flush timeout can be overridden via the
+    `MSB_SHUTDOWN_FLUSH_TIMEOUT_MS` environment variable (upstream #1088).
+  - The prebuilt `msb` binary gains `modify`/`ping`/`restart`/`touch`
+    subcommands and `metrics --watch`; these are CLI-level for now — the
+    corresponding Ruby APIs (`#modify`, `#ping`, `#touch`) ship in the next
+    minor release.
+
 ## [0.9.2] - 2026-07-08
 
 Adopts upstream runtime **`v0.6.2` → `v0.6.3`**. No Ruby API change; the