Skip to content

[Website] Skip incomplete OPFS site directories during startup listing #4200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adamziel wants to merge 1 commit into
base: trunk
Choose a base branch
from
+18 −0
Open

[Website] Skip incomplete OPFS site directories during startup listing #4200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions packages/playground/website/src/lib/state/opfs/opfs-site-storage.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ describe('opfsSiteStorage', () => {
let storage: NonNullable<typeof exportedOpfsSiteStorage>;
let loadPersistedBlueprintBundle: ReturnType<typeof vi.fn>;
let loadPersistedBlueprintBundleFromPath: ReturnType<typeof vi.fn>;
let loggerError: ReturnType<typeof vi.fn>;

beforeEach(async () => {
vi.resetModules();
loadPersistedBlueprintBundle = vi.fn();
loadPersistedBlueprintBundleFromPath = vi.fn();
loggerError = vi.fn();
const activeWorkerWrites = new Set<string>();
opfsRoot = new MemoryDirectoryHandle('');
vi.stubGlobal('navigator', {
Expand Down Expand Up @@ -73,6 +75,9 @@ describe('opfsSiteStorage', () => {
vi.doMock('@wp-playground/blueprints', () => ({
getBlueprintDeclaration: vi.fn(async (blueprint) => blueprint),
}));
vi.doMock('@php-wasm/logger', () => ({
logger: { error: loggerError },
}));
Comment thread
adamziel marked this conversation as resolved.

const module = await import('./opfs-site-storage');
storage = module.opfsSiteStorage!;
Expand Down Expand Up @@ -107,6 +112,14 @@ describe('opfsSiteStorage', () => {
).rejects.toThrow("Site with slug 'a/b' already exists.");
});

it('silently skips directories left by interrupted first saves', async () => {
const sitesRoot = await getSitesRoot(opfsRoot);
await sitesRoot.getDirectoryHandle('site-incomplete', { create: true });
Comment thread
adamziel marked this conversation as resolved.

await expect(storage.list()).resolves.toEqual([]);
expect(loggerError).not.toHaveBeenCalled();
});

it('stores setup URL params alongside site metadata', async () => {
const originalUrlParams = {
searchParams: {
Expand Down
5 changes: 5 additions & 0 deletions packages/playground/website/src/lib/state/opfs/opfs-site-storage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,11 @@ class OpfsSiteStorage {
sites.push(site);
}
} catch (e) {
if (isMissingOpfsEntry(e)) {
// An interrupted first save can leave the directory behind
// before its metadata file is written.
continue;
}
// @TODO: Still return this site's info, just in an error state.
logger.error(`Error reading site ${entry.name}:`, e);
// @TODO: Handle per-site errors somehow.
Expand Down
Loading