open-design/tools/pack/AGENTS.md

tools/pack

Follow the root AGENTS.md and tools/AGENTS.md first. This tool owns the repo-external packaged build/start/stop/logs command surface.

Owns

• Local packaging orchestration for packaged Open Design artifacts.
• mac build/install/start/stop/logs/uninstall/cleanup smoke commands.
• Windows NSIS build/install/start/stop/logs/uninstall/cleanup/list/reset smoke commands.
• Windows registry observation/cleanup must go through reg.exe and stay scoped to entries matching the namespace install/uninstaller paths.
• Windows lifecycle logs must expose NSIS automation logs/markers/timings in addition to app runtime logs.
• Linux AppImage build/install/start/stop/logs/uninstall/cleanup smoke commands.
• Linux headless (no-Electron) install/start/stop via --headless flag on install, start, and stop.
• Linux containerized builds via electronuserland/builder Docker image for distro-agnostic glibc compat.
• Consuming sidecar/process/path primitives from @open-design/sidecar-proto, @open-design/sidecar, and @open-design/platform.

Does not own

• Product business logic.
• Sidecar protocol definitions.
• A second process identity model.
• Product/business update runtime integration.

Rules

• Do not hand-build --od-stamp-* args; use createProcessStampArgs with OPEN_DESIGN_SIDECAR_CONTRACT.
• Do not use port numbers in data/log/runtime/cache path decisions. Namespace decides paths; ports are only transient transports.
• Public release artifacts must use channel-specific app identity: stable uses Open Design, beta uses Open Design Beta, and preview uses Open Design Preview. Local tools-pack installs may still use namespace-scoped install paths only as a developer multi-instance validation convention.
• Do not let namespace-named .app installs change data/log/runtime/cache path conventions.
• Use --portable for public/release artifacts so packaged config does not bake local tools-pack runtime roots from the build machine.
• Pack resource files used by electron-builder belong under tools/pack/resources/; do not point pack logic at Downloads, web public assets, docs assets, or other app-owned resource paths.
• For ordinary Windows NSIS smoke tests, use short namespaces such as rg, smoke, or nsis-a. NSIS extracts deeply nested Next.js standalone files under the namespace-scoped install directory; long namespaces can push installed paths past the traditional Windows 260-character limit even when builder win-unpacked output is correct. During merge regression, namespace regression-merge-nsis produced an installed path length of 264 characters and missed next/dist/server/route-matcher-providers/helpers/cached-route-matcher-provider.js in the installed directory, while the same NSIS smoke passed with namespace rg. Use long namespaces only when intentionally testing installer path-length behavior.

Packaged auto-update architecture and harness

Read this section before changing packaged auto-update behavior. The updater crosses package, desktop, web UI, release-feed, and installer surfaces, so bugs often hide between otherwise-green package tests.

Architecture map

• apps/desktop/src/main/updater.ts owns updater state, release metadata parsing, artifact selection, checksum verification, download-store ownership, progress events, and opening the downloaded installer. It is pure main-process logic and is tested under apps/desktop/tests/main/updater.test.ts.
• apps/desktop/src/main/runtime.ts exposes updater IPC to the renderer through od:update:status|check|download|install|quit and emits od:update:status-changed. Keep installer launch separate from process shutdown; quit is an explicit post-installer action.
• apps/desktop/src/main/index.ts wires the scheduler. Native menu update actions are intentionally not the user-facing surface; the web updater UI owns discovery and action prompts.
• apps/web/src/lib/updater.ts normalizes host updater snapshots into UI-ready state.
• apps/web/src/components/UpdaterPopup.tsx is the visible updater surface in the left rail. All visible copy must go through apps/web/src/i18n.
• apps/packaged/src/index.ts passes packaged appVersion and namespace-scoped updateRoot into desktop main.
• tools/serve owns deterministic local updater fixtures only. It must not contain product updater runtime logic.
• tools/pack owns packaged build/install/start/inspect/logs/uninstall/cleanup and the platform installer harness, including Windows NSIS registry observation and cleanup.

Release metadata shape

The runtime updater reads https://releases.open-design.ai/<channel>/latest/metadata.json unless OD_UPDATE_METADATA_URL overrides it. For package-launcher updates:

• mac selects platforms.mac.artifacts.dmg.
• Windows selects platforms.win.artifacts.installer.
• The artifact must have a checksum, preferably sha256Url; the updater verifies bytes before exposing an install action.
• OD_UPDATE_CURRENT_VERSION may override the packaged version for tests, but user-flow package validation should prefer building the package with the intended --app-version.

Channel identity rules

Channel identity must be stable across install, update install, shortcuts, registry entries, and app data:

• Stable: Open Design, namespace default or stable release namespace.
• Beta Windows: Open Design Beta, namespace release-beta-win, uninstall key Open Design-release-beta-win.
• Preview Windows: Open Design Preview, namespace release-preview-win, uninstall key Open Design-release-preview-win.
• Beta-like ad hoc namespaces such as beta-local-flow are test namespaces, not the beta channel. They must not be used for user-flow beta validation because they create a different registry key while sharing a confusing display name/path.

If a local beta package is meant to be updated by the real beta feed, build it with --namespace release-beta-win and an older beta --app-version. Otherwise the installed beta.5 package and the downloaded beta.6 package can appear as separate registry entries even though they target the same display name.

Deterministic fixture harness

Use tools-serve start updater for fast, deterministic tests and e2e automation where network release state is not the thing under test. Fixture flow:

pnpm tools-serve start updater --json --channel beta --version 99.0.0-beta.1 --platform win

Then launch packaged desktop with:

OD_UPDATE_ENABLED=1
OD_UPDATE_METADATA_URL=<fixture metadataUrl>
OD_UPDATE_CURRENT_VERSION=99.0.0-beta.0
OD_UPDATE_OPEN_DRY_RUN=1
OD_UPDATE_AUTO_CHECK=1

This harness is appropriate for asserting IPC, popup rendering, progress, checksum/download-store behavior, and dry-run installer opening. It is not a full user-view validation because it replaces the public release feed and uses synthetic artifact bytes.

High-confidence local user-flow acceptance

Use this when validating release-channel behavior before handing a Windows beta build to a human tester. This path intentionally avoids mock services and exercises the real public beta feed.

1. Confirm the latest beta metadata first:

curl.exe --ssl-no-revoke -fsSL https://releases.open-design.ai/beta/latest/metadata.json

2. Build a non-portable Windows beta package with the real beta namespace and a version lower than latest:

pnpm tools-pack win build --dir C:\odtp-beta-release-fixed --namespace release-beta-win --to nsis --app-version 0.8.0-beta.5 --json

3. Give the tester the generated installer:

C:\odtp-beta-release-fixed\out\win\namespaces\release-beta-win\builder\Open Design-release-beta-win-setup.exe

4. Expected user flow:

• User installs 0.8.0-beta.5 through the NSIS UI.
• User launches Open Design Beta.
• App auto-checks the real beta feed, downloads the latest platforms.win.artifacts.installer, verifies sha256, and shows the web updater popup.
• The native File menu must not expose update actions.
• The updater popup uses i18n strings and download progress must not flash to 100% before real bytes arrive.
• Clicking Open installer opens the real downloaded beta installer. Installing it should overwrite the same Open Design-release-beta-win registry key, not create a second beta key.

5. Registry sanity check after beta.6 install:

Get-ItemProperty 'HKCU:\Software\Microsoft\Windows\CurrentVersion\Uninstall\*' -ErrorAction SilentlyContinue |
  Where-Object { $_.DisplayName -like 'Open Design*' } |
  Select-Object PSChildName,DisplayName,DisplayVersion,InstallLocation

For a clean beta channel result, expect one beta entry with PSChildName Open Design-release-beta-win and the latest DisplayVersion. Windows Settings > Apps may cache uninstall metadata within the current view. If Settings still shows the previous beta version after the registry query is correct, switch away from the Apps view and back, or reopen Settings, before treating it as an installer failure. The registry query above is the source of truth for this harness.

6. Avoid leaving validation residue. Stop running app processes first, then use tools-pack uninstall/cleanup for tool-managed namespaces. Only delete explicit temp roots after verifying the resolved path is exactly the intended directory.

pnpm tools-pack win stop --dir C:\odtp-beta-release-fixed --namespace release-beta-win --json
pnpm tools-pack win uninstall --dir C:\odtp-beta-release-fixed --namespace release-beta-win --remove-product-user-data --remove-data --remove-logs --remove-sidecars --json
pnpm tools-pack win cleanup --dir C:\odtp-beta-release-fixed --namespace release-beta-win --remove-product-user-data --remove-data --remove-logs --remove-sidecars --json

Validation matrix for updater changes

Run the narrow tests that match the surface you touched, then the repo checks:

pnpm --filter @open-design/desktop test -- tests/main/updater.test.ts tests/main/updater-host-boundary.test.ts tests/main/preload-host-boundary.test.ts
pnpm --filter @open-design/web test -- tests/components/UpdaterPopup.test.tsx tests/lib/updater.test.ts
pnpm --filter @open-design/tools-serve test
pnpm --filter @open-design/tools-pack test -- tests/win-identity.test.ts tests/win-app.test.ts tests/win-builder.test.ts
pnpm --filter @open-design/desktop typecheck
pnpm --filter @open-design/web typecheck
pnpm --filter @open-design/tools-pack typecheck
pnpm --filter @open-design/tools-serve typecheck
git diff --check
pnpm guard
pnpm typecheck

Run the high-confidence local user-flow acceptance whenever a change touches real release feed selection, channel identity, Windows registry/install behavior, installer opening, or visible updater UI behavior.