[Storage] Replace isomorphic-git submodule with local adapter by adamziel · Pull Request #3841 · WordPress/wordpress-playground

adamziel · 2026-06-27T22:15:56Z

What it does

Replaces the checked-in isomorphic-git submodule with a local adapter in @wp-playground/storage for the private Git internals Playground already uses.

This does not remove isomorphic-git as an npm dependency. It removes the repository-level submodule checkout and the direct imports from private isomorphic-git/src/... files.

Git behavior is intended to stay the same: fetching refs, sparse checkout, pack parsing, authentication errors, and .git materialization should produce the same results. This PR also does not add URL redaction or change how remote URLs are persisted.

Rationale

The previous setup depended on implementation files inside an isomorphic-git submodule. Those files are not part of the public package API, and the submodule added extra setup, source-package, and dependabot plumbing.

Keeping the adapter in storage makes the private-code boundary explicit while continuing to use public isomorphic-git npm APIs such as indexPack and readObject.

Implementation

Adds packages/playground/storage/src/lib/isomorphic-git-internals.ts with the Git parsing/rendering pieces storage depends on: GitPktLine, parseUploadPackResponse, GitPackIndex, GitTree, GitCommit, GitAnnotatedTag, and GitIndex.

Updates storage Git code to import those symbols from the local adapter instead of isomorphic-git/src/..., then removes the old declaration shim for private imports.

Removes submodule-only plumbing from .gitmodules, the isomorphic-git gitlink, tools/scripts/package-source.sh, .github/dependabot.yml, and AGENTS.md.

Adds Vite aliases and dependency optimizer settings so remote, Personal WP, and client builds consistently use the ESM isomorphic-git npm package entrypoint.

The review pass also tightens the local adapter by making MemoryFs represent symlinks explicitly, using an offsetToOid map for pack slice lookups, and replacing the compact string comparator with an explicit one.

Testing instructions

npx nx test playground-storage --testFile=git-sparse-checkout.spec.ts
npx nx lint php-wasm-util
npx nx lint playground-storage
npx nx build:bundle php-wasm-util
npx nx build:bundle playground-storage
bash -n tools/scripts/package-source.sh

Copilot

Pull request overview

Note

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

Foundation changes for the storage/git stack: introduces URL redaction utilities, moves off isomorphic-git private imports by vendoring required internals, and hardens git auth/sparse-checkout behavior (with tests).

Changes:

Add URL redaction + Git repo URL heuristics to @php-wasm/util with new test coverage
Introduce storage-owned isomorphic-git internals and update storage git code to use them
Add/standardize Git authentication error handling and ensure diagnostics redact sensitive URLs

Reviewed changes

Copilot reviewed 12 out of 14 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
packages/playground/storage/src/test/git-sparse-checkout.spec.ts	Adds a regression test ensuring auth errors redact credentials/tokens
packages/playground/storage/src/lib/isomorphic-git-internals.ts	Adds a storage-owned subset of git internals (pkt-line, pack index, tree/commit/tag parsing, in-memory FS)
packages/playground/storage/src/lib/git-sparse-checkout.ts	Switches to local internals + redacts sensitive URLs in thrown error messages
packages/playground/storage/src/lib/git-create-dotgit-directory.ts	Switches `GitIndex` import to local internals and minor formatting
packages/playground/storage/src/lib/git-authentication-error.ts	Introduces a dedicated auth error that redacts repo URLs
packages/playground/storage/package.json	Adds `isomorphic-git` + `sha.js` deps needed by the new internals
packages/php-wasm/util/src/test/redact-sensitive-url.spec.ts	Adds tests for URL/text redaction behavior
packages/php-wasm/util/src/test/is-git-repo-url.spec.ts	Adds tests for Git repo URL heuristic + compatibility alias
packages/php-wasm/util/src/lib/redact-sensitive-url.ts	Adds URL/text redaction + “contains sensitive data” helpers
packages/php-wasm/util/src/lib/is-git-repo-url.ts	Adds `seemsLikeGitRepoUrl` heuristic + deprecated alias
packages/php-wasm/util/src/lib/index.ts	Exports new util helpers from the package entrypoint
package.json	Adds `@types/sha.js` for TypeScript typing support

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

adamziel · 2026-06-30T09:55:56Z

+		optimizeDeps: {
+			include: [
+				'async-lock',
+				'buffer',
+				'clean-git-ref',
+				'crc-32',
+				'diff3',
+				'ignore',
+				'ini',
+				'pako',
+				'pify',
+				'sha.js',
+				'sha.js/sha1.js',
+			],
+			exclude: ['isomorphic-git'],
+		},
+		resolve: {
+			alias: [
+				{
+					find: /^isomorphic-git$/,
+					replacement: isomorphicGitEsmEntry,
+				},
+			],
+		},


@akirk is this fine?

I've run it on my own staging and tested:

My WordPress boots fine from scratch,

Blueprints still install fine to the current My WordPress

akirk

From the personal-wp perspective everything works fine!

akirk · 2026-06-30T10:15:20Z

+		optimizeDeps: {
+			include: [
+				'async-lock',
+				'buffer',
+				'clean-git-ref',
+				'crc-32',
+				'diff3',
+				'ignore',
+				'ini',
+				'pako',
+				'pify',
+				'sha.js',
+				'sha.js/sha1.js',
+			],
+			exclude: ['isomorphic-git'],
+		},
+		resolve: {
+			alias: [
+				{
+					find: /^isomorphic-git$/,
+					replacement: isomorphicGitEsmEntry,
+				},
+			],
+		},


I've run it on my own staging and tested:

My WordPress boots fine from scratch,

Blueprints still install fine to the current My WordPress

…erver-restart Conflict resolutions: - blueprints-v2/worker-thread-v2.ts: trunk deduplicated mountResources into the shared ../mounts module. Adopted trunk's version and ported this branch's root-cause mount-error message (f65ea7c) into the shared mountResources so that improvement isn't lost. - run-cli.spec.ts imports: kept both Worker (worker-dispose test) and ChildProcess (trunk) imports. - run-cli.spec.ts getConstants: took trunk's --workers=1 but dropped the now-inert process.exit spy, since this branch removed process.exit. Also reconciled six trunk-added tests that asserted the old process.exit(1) behavior to this branch's process.exit-free model: five now expect the thrown validation error; the `start --mode` test expects a clean CLIExitResult (exit 1). Ran npm install for trunk's new isomorphic-git / sha.js deps (submodule replaced by a local adapter in WordPress#3841).

adamziel requested review from a team, brandonpayton and Copilot June 27, 2026 22:15

github-actions Bot added [Package][@php-wasm] Util [Package][@wp-playground] Storage labels Jun 27, 2026

Copilot AI reviewed Jun 27, 2026

View reviewed changes

adamziel force-pushed the stack/pr3725-05-storage-git-foundation branch from d4fccce to ae19ca3 Compare June 27, 2026 22:37

adamziel changed the base branch from trunk to stack/pr3725-04-clear-vite-cache June 27, 2026 22:37

github-actions Bot added [Package][@wp-playground] Remote [Aspect] Browser [Aspect] Service Worker and removed [Package][@wp-playground] Remote labels Jun 27, 2026

adamziel added 9 commits June 28, 2026 23:35

Exclude Vite optimizer cache from CI cache

66aee89

Build storage git foundation for stack

77360f1

Pre-bundle git deps for remote dev server

abf7806

Use ESM isomorphic-git in remote dev build

e4112b6

Stabilize remote dev dependency optimizer

8e2c5d7

Prebundle ini in remote dev optimizer

aeb1d09

Narrow remote service worker relay import

c9c551e

Narrow remote worker runtime imports

88d400f

Use ESM isomorphic-git in client builds

fd79786

adamziel force-pushed the stack/pr3725-05-storage-git-foundation branch from 4f47ebe to fd79786 Compare June 28, 2026 21:39

adamziel force-pushed the stack/pr3725-04-clear-vite-cache branch from 36b14e2 to 66aee89 Compare June 28, 2026 21:39

Base automatically changed from stack/pr3725-04-clear-vite-cache to trunk June 28, 2026 21:57

Address storage git review comments

4aa94c2

adamziel changed the title ~~Build storage git foundation~~ Jun 28, 2026

Remove URL redaction from storage git foundation

551857c

adamziel changed the title ~~[Storage] Build Git foundation for Blueprints v2~~ Jun 29, 2026

Remove isomorphic-git submodule

a1587fb

adamziel changed the title ~~[Storage] Stop importing private isomorphic-git internals~~ Jun 29, 2026

github-actions Bot added the [Type] Documentation Improvements or additions to documentation label Jun 29, 2026

adamziel changed the title ~~[Storage] Remove private isomorphic-git internals checkout~~ Jun 29, 2026

Trim nonessential storage git changes

c9d02ef

github-actions Bot added the [Package][@wp-playground] Client label Jun 29, 2026

adamziel changed the title ~~[Storage] Replace isomorphic-git submodule with package adapter~~ Jun 29, 2026

adamziel commented Jun 30, 2026

View reviewed changes

adamziel added 2 commits June 30, 2026 11:58

Add isomorphic-git internals license notice

6d1f264

Stabilize Personal WP dev optimizer

ac26286

akirk approved these changes Jun 30, 2026

View reviewed changes

Restore Vite dependency discovery

5db2ac2

adamziel merged commit 0c75d41 into trunk Jun 30, 2026
53 checks passed

adamziel deleted the stack/pr3725-05-storage-git-foundation branch June 30, 2026 11:27

dknauss mentioned this pull request Jul 2, 2026

git:directory installs fail in browser Playground with "createHash is not a function" (isomorphic-git Node variant reaching browser bundle after #3841) #3875

Closed

adamziel mentioned this pull request Jul 3, 2026

[Website] Keep git:directory installs on browser isomorphic-git #3879

Closed

ashfame mentioned this pull request Jul 3, 2026

[codex] Fix isomorphic-git browser bundle #3882

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Storage] Replace isomorphic-git submodule with local adapter - #3841

[Storage] Replace isomorphic-git submodule with local adapter#3841
adamziel merged 16 commits into
trunkfrom
stack/pr3725-05-storage-git-foundation

adamziel commented Jun 27, 2026 •

edited

Loading

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adamziel Jun 30, 2026

akirk Jun 30, 2026

akirk left a comment

akirk Jun 30, 2026

Uh oh!

Labels

3 participants

Uh oh!

Conversation

adamziel commented Jun 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What it does

Rationale

Implementation

Testing instructions

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adamziel Jun 30, 2026

Choose a reason for hiding this comment

akirk Jun 30, 2026

Choose a reason for hiding this comment

akirk left a comment

Choose a reason for hiding this comment

akirk Jun 30, 2026

Choose a reason for hiding this comment

Uh oh!

Labels

3 participants

adamziel commented Jun 27, 2026 •

edited

Loading