Skip to content

[Blueprints] Import versioned ZIP user content while retaining legacy defaults - #4130

Merged
adamziel merged 2 commits into
adamziel/separate-runtime-wp-content-pathsfrom
adamziel/complete-zip-exports
Jul 21, 2026
Merged

[Blueprints] Import versioned ZIP user content while retaining legacy defaults#4130
adamziel merged 2 commits into
adamziel/separate-runtime-wp-content-pathsfrom
adamziel/complete-zip-exports

Conversation

@adamziel

@adamziel adamziel commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator

A version-2 Playground ZIP now defines user-owned wp-content: archived files replace the boot defaults, and a missing user file means it was deleted. Legacy runtime artifacts remain owned by the importing Playground through #4141.

Pre-versioned exports remain partial. When one omits a stock plugin, theme, or database directory, import retains the fresh installation's copy. An archived copy still wins when present.

This preserves customized default themes such as BrewCommerce's purple Twenty Twenty-Five background through export, import, and reload without treating stock themes as runtime files.

Testing

Browser coverage imports a pre-versioned partial export, then separately customizes Twenty Twenty-Five, exports it, imports it into a new Playground, reloads, and checks both the theme file and rendered background. The full stack passes 488 Blueprint tests, 347 website tests, both packages' lint and typecheck, and 10 Chromium ZIP-import scenarios.

Stack

  1. #4139 — Export complete versioned Playground ZIP snapshots
  2. #4141 — Exclude legacy runtime artifacts from site snapshots
  3. #4130 — Import versioned ZIP user content while retaining legacy defaults
  4. #4131 — Import ZIP contents before initial browser persistence
  5. #4132 — Keep ZIP preparation visible until the imported site is ready
  6. #4121 — Accept ZIP drops across the page

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Makes versioned Playground ZIP exports “complete” by exporting full user-owned wp-content plus wp-config.php, and updates imports to treat versioned exports as authoritative while preserving Playground runtime-managed files and maintaining legacy behavior for older partial exports.

Changes:

  • Replace wpContentFilesExcludedFromExport with playgroundRuntimeWpContentPaths and update export/import call sites.
  • Make zipWpContent() always produce a versioned (v2) complete export including wp-config.php and playground-export.json.
  • Add/extend automated tests (unit + Playwright) to validate legacy restore behavior and round-trip preservation of default-theme customizations.

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
packages/playground/website/src/github/import-from-github.ts Switch to runtime-path list and adjust restore behavior for runtime-managed wp-content paths.
packages/playground/website/src/github/github-export-form/form.tsx Update GitHub export exclusions to use runtime-path list.
packages/playground/website/src/github/github-export-form/form.spec.tsx Update mocks for renamed exported constant.
packages/playground/website/src/components/toolbar-buttons/download-as-zip.tsx Update ZIP download to new zipWpContent() signature (always complete).
packages/playground/website/playwright/e2e/opfs.spec.ts Add e2e coverage for legacy partial import restore and versioned export/import theme customization persistence.
packages/playground/remote-access/src/remote-access-direct-tunnel.ts Update ZIP export call to new zipWpContent() signature.
packages/playground/personal-wp/src/lib/hooks/use-backup.ts Update backup ZIP export call to new zipWpContent() signature.
packages/playground/blueprints/src/tests/steps/import-wordpress-files.spec.ts Add tests asserting format v2 manifest, complete exports, runtime-file retention, and legacy restore behavior.
packages/playground/blueprints/src/lib/utils/wp-content-paths.ts Introduce runtime-managed path list + legacy omitted-path list.
packages/playground/blueprints/src/lib/utils/wp-content-files-excluded-from-exports.ts Remove deprecated combined exclusion list.
packages/playground/blueprints/src/lib/steps/zip-wp-content.ts Make ZIP exports versioned and complete; include wp-config.php; remove exclude-path handling.
packages/playground/blueprints/src/lib/steps/index.ts Re-export renamed constant from new utility module.
packages/playground/blueprints/src/lib/steps/import-wordpress-files.ts Preserve runtime-managed paths on import; restore omitted stock paths only for legacy exports.
packages/playground/blueprints/src/index.ts Re-export renamed constant from new utility module.
packages/playground/blueprints/public/blueprint-v2-schema-validator.js Regenerate schema validator artifacts.
packages/playground/blueprints/public/blueprint-schema.json Regenerate schema JSON artifacts.
Comments suppressed due to low confidence (1)

packages/playground/blueprints/src/lib/steps/zip-wp-content.ts:43

  • zipWpContent() now zips the entire wp-content tree, which will also include Playground runtime-managed paths (e.g., SQLite integration drop-ins) even though imports explicitly preserve the target runtime’s versions. If those runtime-managed paths are intentionally non-authoritative, consider excluding playgroundRuntimeWpContentPaths during ZIP creation to reduce archive size and avoid shipping potentially incompatible runtime artifacts.
	await runPhpWithZipFunctions(
		playground,
		`zipDir(${js.wpContentPath}, ${js.zipPath}, array(
			'zip_root'      => ${js.documentRoot},
			'additional_paths' => ${js.additionalPaths}
		));`
	);

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread packages/playground/website/src/github/import-from-github.ts Outdated
Comment thread packages/playground/blueprints/src/lib/steps/zip-wp-content.ts
@adamziel adamziel changed the title [Blueprints] Make versioned ZIP exports complete Jul 21, 2026
@adamziel
adamziel changed the base branch from trunk to adamziel/complete-versioned-zip-exports July 21, 2026 10:12
@adamziel
adamziel force-pushed the adamziel/complete-zip-exports branch from 1f90c71 to e80a0c5 Compare July 21, 2026 10:33
@adamziel
adamziel force-pushed the adamziel/complete-versioned-zip-exports branch from 0d59a23 to 0f14b54 Compare July 21, 2026 10:33
@adamziel
adamziel force-pushed the adamziel/complete-zip-exports branch from e80a0c5 to f45551b Compare July 21, 2026 10:50
@adamziel
adamziel changed the base branch from adamziel/complete-versioned-zip-exports to adamziel/separate-runtime-wp-content-paths July 21, 2026 10:52
adamziel added a commit that referenced this pull request Jul 21, 2026
Playground ZIP exports now contain every file under `wp-content`, plus
`wp-config.php`. The manifest records `formatVersion: 2` so the importer
work in #4130 can distinguish these archives from pre-versioned partial
exports.

This removes the `selfContained` option from the public `zipWpContent()`
API. Every caller now receives a complete archive.

## Testing

Export a Playground with a custom file inside a default theme. Inspect
the ZIP and confirm it contains that file, `wp-config.php`, and a
`playground-export.json` manifest with `formatVersion: 2`.


## Stack

1. [#4139 — Export complete versioned Playground ZIP
snapshots](#4139)
2. [#4141 — Separate runtime-managed paths from legacy ZIP
omissions](#4141)
3. [#4130 — Import versioned ZIP content while retaining legacy
defaults](#4130)
4. [#4131 — Import ZIP contents before initial browser
persistence](#4131)
5. [#4132 — Keep ZIP preparation visible until the imported site is
ready](#4132)
6. [#4121 — Accept ZIP drops across the
page](#4121)
@adamziel
adamziel force-pushed the adamziel/separate-runtime-wp-content-paths branch from 62f365a to 2e1942f Compare July 21, 2026 11:13
@adamziel
adamziel force-pushed the adamziel/complete-zip-exports branch from f45551b to 6458905 Compare July 21, 2026 11:13
@adamziel
adamziel force-pushed the adamziel/separate-runtime-wp-content-paths branch from 2e1942f to 4b71fa1 Compare July 21, 2026 11:16
@adamziel
adamziel force-pushed the adamziel/complete-zip-exports branch from 6458905 to 7e0bdc4 Compare July 21, 2026 11:16
@adamziel
adamziel force-pushed the adamziel/separate-runtime-wp-content-paths branch from 4b71fa1 to 4235938 Compare July 21, 2026 12:20
@adamziel
adamziel force-pushed the adamziel/complete-zip-exports branch from 7e0bdc4 to c660eb6 Compare July 21, 2026 12:20
@adamziel adamziel changed the title [Blueprints] Import versioned ZIP content while retaining legacy defaults Jul 21, 2026
@adamziel
adamziel force-pushed the adamziel/separate-runtime-wp-content-paths branch from 4235938 to f1277cf Compare July 21, 2026 12:28
@adamziel
adamziel force-pushed the adamziel/complete-zip-exports branch 2 times, most recently from 6fe2bea to 5ddd4b1 Compare July 21, 2026 12:40
@adamziel
adamziel force-pushed the adamziel/separate-runtime-wp-content-paths branch from 8c47bf3 to 274fb50 Compare July 21, 2026 12:50
@adamziel
adamziel force-pushed the adamziel/complete-zip-exports branch from 5ddd4b1 to d79f14b Compare July 21, 2026 12:50
@adamziel
adamziel merged commit 534b3c5 into adamziel/separate-runtime-wp-content-paths Jul 21, 2026
106 checks passed
@adamziel
adamziel deleted the adamziel/complete-zip-exports branch July 21, 2026 13:33
adamziel added a commit that referenced this pull request Jul 21, 2026
… defaults (#4130)

A version-2 Playground ZIP now defines user-owned `wp-content`: archived
files replace the boot defaults, and a missing user file means it was
deleted. Legacy runtime artifacts remain owned by the importing
Playground through #4141.

Pre-versioned exports remain partial. When one omits a stock plugin,
theme, or database directory, import retains the fresh installation's
copy. An archived copy still wins when present.

This preserves customized default themes such as BrewCommerce's purple
Twenty Twenty-Five background through export, import, and reload without
treating stock themes as runtime files.

## Testing

Browser coverage imports a pre-versioned partial export, then separately
customizes Twenty Twenty-Five, exports it, imports it into a new
Playground, reloads, and checks both the theme file and rendered
background. The full stack passes 488 Blueprint tests, 347 website
tests, both packages' lint and typecheck, and 10 Chromium ZIP-import
scenarios.

## Stack

1. [#4139 — Export complete versioned Playground ZIP
snapshots](#4139)
2. [#4141 — Exclude legacy runtime artifacts from site
snapshots](#4141)
3. [#4130 — Import versioned ZIP user content while retaining legacy
defaults](#4130)
4. [#4131 — Import ZIP contents before initial browser
persistence](#4131)
5. [#4132 — Keep ZIP preparation visible until the imported site is
ready](#4132)
6. [#4121 — Accept ZIP drops across the
page](#4121)
adamziel added a commit that referenced this pull request Jul 21, 2026
…me files (#4141)

Make new ZIP exports preserve the site’s plugins, themes, uploads, and
database exactly. Make imports remove any pre-bundled Playground's
runtime files (such as `0-playground.php` mu-plugin) and lean on their
latest versions shipped in the `/internal` directory.

## Backwards compatibility

Playground's ZIP export format evolved over time. Here's how each
version is handled after this PR:

| ZIP | Site files in `wp-content` | Playground runtime artifacts | If a
theme or plugin is missing |
| --- | --- | --- | --- |
| Before this PR | Custom plugins, themes, and uploads. Default
`themes/twenty*` directories were included only by the self-contained
export. `database/` may be absent. | Some January–May 2024 ZIPs contain
the old SQLite MU plugin. | Backfill well-known paths from the site
loaded right before the import: Akismet, Hello Dolly, WordPress
Importer, default themes, and `database/`. This is a best-effort
heuristic. We can't distinguish a deleted theme from a missing theme. |
| `formatVersion: 2` after this PR | Every site path then on disk:
plugins, themes, uploads, `database/`, and a custom `db.php` if the user
specifically created one. | None. | Leave it missing. |

On every import, archived Playground files are removed. The new
Playground supplies them.

## Playground runtime files

These four old paths are always treated as Playground-provided runtime
files:

- `mu-plugins/sqlite-database-integration`
- `mu-plugins/playground-includes`
- `mu-plugins/0-playground.php`
- `mu-plugins/0-sqlite.php`

From January 29 through May 8, 2024, the self-contained exporter
included `mu-plugins/sqlite-database-integration`. It also included
`mu-plugins/0-sqlite.php` when present. It already omitted
`mu-plugins/0-playground.php` and `mu-plugins/playground-includes`;
those entries handle stale sites, GitHub trees, and hand-built ZIPs.

`db.php` needs a separate rule because it can be a custom WordPress
drop-in. During legacy WordPress boot, `writeLegacyDbPhp()` creates
Playground's copy through `generateDbPhpContent()`. That function writes
`@playground-managed` into the file header. Only a `db.php` with that
marker is treated as a Playground file. An unmarked `db.php` stays with
the site.

Before January 29, 2024, SQLite used
`plugins/sqlite-database-integration`. This PR leaves that path as site
content because it is also a valid user-installed plugin path.

**Breaking change:** `wpContentFilesExcludedFromExport` is no longer
public. `getLegacyPlaygroundRuntimeWpContentPaths()` exposes the smaller
runtime rule.

## Testing

Tests cover a modified Twenty Twenty-Five theme, a deleted v2 theme, a
theme omitted by a pre-v2 ZIP, archived runtime files, marked and custom
`db.php` files, failed runtime staging, and archives without
`wp-content`. The full stack passes 488 Blueprint tests, 347 website
tests, package lint and typecheck, and 10 Chromium ZIP-import scenarios.

## Stack

1. [#4139 — Export complete versioned Playground ZIP
snapshots](#4139)
— merged
2. [#4141 — Exclude legacy runtime artifacts from site
snapshots](#4141)
— includes #4130
3. [#4131 — Import ZIP contents before initial browser
persistence](#4131)
4. [#4132 — Keep ZIP preparation visible until the imported site is
ready](#4132)
5. [#4121 — Accept ZIP drops across the
page](#4121)
adamziel added a commit that referenced this pull request Jul 21, 2026
ZIP imports used to persist a fresh WordPress installation before
applying the
archive. The archive then rewrote that stored filesystem:

1. Boot fresh WordPress in MEMFS.
2. Copy the fresh site to browser storage.
3. Apply the ZIP to the running site.
4. Flush the rewritten site to browser storage again.

This PR applies the ZIP during the new site's first boot, before its
initial
browser-storage copy:

1. Boot fresh WordPress in MEMFS.
2. Apply the ZIP in MEMFS.
3. Copy the finished filesystem to browser storage once.

`createNewSiteFromZip()` registers the import as first-boot work. The
boot path
runs that work before the initial MEMFS-to-OPFS copy, and the call
reports
success only after that copy finishes.

If ZIP initialization or the first OPFS copy fails, the newly created
stored
site is removed and the previously active Playground is selected again.
When
OPFS is unavailable, the import uses a fresh temporary Playground. Its
new slug
forces React to boot a new iframe instead of reusing the previous
runtime.

The ZIP picker now delegates this lifecycle to `createNewSiteFromZip()`
instead
of coordinating site creation, client boot, import, and persistence
through
component effects.

This PR does not change which files a ZIP contains or how versioned and
legacy
ZIP contents are interpreted. Those rules are handled by #4141 and
#4130. This
PR changes when the imported filesystem is written to browser storage.

## Testing

1. Import a ZIP from both temporary and saved Playgrounds and confirm
the new
   site persists after reload.
2. Import a malformed ZIP and confirm no incomplete stored site remains.
3. Confirm the previously active Playground remains selected after a
failed
   stored-site import.

Unit coverage checks that ZIP initialization runs before the initial
OPFS copy
and that failed-import cleanup selects the requested previous site once.
Browser
coverage checks that a failed import leaves the stored-site list
unchanged,
including after reload.

## Stack

1. [#4139 — Export complete versioned Playground ZIP
snapshots](#4139)
— merged
2. [#4141 — Export and import all site files except Playground runtime
files](#4141) —
merged
3. [#4130 — Import versioned ZIP user content while retaining legacy
defaults](#4130) —
merged
4. [#4131 — Import ZIP contents before initial browser
persistence](#4131)
5. [#4132 — Keep ZIP preparation visible until the imported site is
ready](#4132)
6. [#4121 — Accept ZIP drops across the
page](#4121)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment