Skip to content

[Website] fs-journal: replace recursion with a loop to stop exceeding the call stack #2912

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

Merged
merged 7 commits into from
Nov 18, 2025
Merged

[Website] fs-journal: replace recursion with a loop to stop exceeding the call stack #2912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
52f1dad
Reproduce max call stack in fs journal
adamziel Nov 17, 2025
ebbac39
Failing test for normalizeFilesystemOperations
adamziel Nov 17, 2025
18d1fa6
Find the problematic recursive case
adamziel Nov 17, 2025
7b94f5a
[Website] Limit the callstack size in filesystem journal
adamziel Nov 18, 2025
00b965f
Add an E2E test to confirm Woo can be installed on an OPFS site
adamziel Nov 18, 2025
29ca3e9
Merge branch 'trunk' into fix-filesystem-max-call-stack
adamziel Nov 18, 2025
74854a4
Remove WooCommerce installation test from e2e specs
adamziel Nov 18, 2025
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
208 changes: 107 additions & 101 deletions packages/php-wasm/fs-journal/src/lib/fs-journal.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,118 +362,124 @@ function normalizePath(path: string) {
* @returns The normalized journal.
*/
export function normalizeFilesystemOperations(
journal: FilesystemOperation[]
input: FilesystemOperation[]
): FilesystemOperation[] {
const substitutions: Record<number, any> = {};
for (let i = journal.length - 1; i >= 0; i--) {
for (let j = i - 1; j >= 0; j--) {
const formerType = checkRelationship(journal[i], journal[j]);
if (formerType === 'none') {
continue;
}
let journal = input;
while (true) {
const substitutions: Record<number, any> = {};
for (let i = journal.length - 1; i >= 0; i--) {
for (let j = i - 1; j >= 0; j--) {
const formerType = checkRelationship(journal[i], journal[j]);
if (formerType === 'none') {
continue;
}

const latter = journal[i];
const former = journal[j];
if (
latter.operation === 'RENAME' &&
former.operation === 'RENAME'
) {
// Normalizing a double rename is a complex scenario so let's just give
// up. There's just too many possible scenarios to handle.
//
// For example, the following scenario may not be possible to normalize:
// RENAME /dir_a /dir_b
// RENAME /dir_b/subdir /dir_c
// RENAME /dir_b /dir_d
//
// Similarly, how should we normalize the following list?
// CREATE_FILE /file
// CREATE_DIR /dir_a
// RENAME /file /dir_a/file
// RENAME /dir_a /dir_b
// RENAME /dir_b/file /dir_b/file_2
//
// The shortest way to recreate the same structure would be this:
// CREATE_DIR /dir_b
// CREATE_FILE /dir_b/file_2
//
// But that's not a straightforward transformation so let's just not
// handle it for now.
logger.warn(
'[FS Journal] Normalizing a double rename is not yet supported:',
{
current: latter,
last: former,
}
);
continue;
}
const latter = journal[i];
const former = journal[j];
if (
latter.operation === 'RENAME' &&
former.operation === 'RENAME'
) {
// Normalizing a double rename is a complex scenario so let's just give
// up. There's just too many possible scenarios to handle.
//
// For example, the following scenario may not be possible to normalize:
// RENAME /dir_a /dir_b
// RENAME /dir_b/subdir /dir_c
// RENAME /dir_b /dir_d
//
// Similarly, how should we normalize the following list?
// CREATE_FILE /file
// CREATE_DIR /dir_a
// RENAME /file /dir_a/file
// RENAME /dir_a /dir_b
// RENAME /dir_b/file /dir_b/file_2
//
// The shortest way to recreate the same structure would be this:
// CREATE_DIR /dir_b
// CREATE_FILE /dir_b/file_2
//
// But that's not a straightforward transformation so let's just not
// handle it for now.
logger.warn(
'[FS Journal] Normalizing a double rename is not yet supported:',
{
current: latter,
last: former,
}
);
continue;
}

if (former.operation === 'CREATE' || former.operation === 'WRITE') {
if (latter.operation === 'RENAME') {
if (formerType === 'same_node') {
// Creating a node and then renaming it is equivalent to creating
// it in the new location.
if (
former.operation === 'CREATE' ||
former.operation === 'WRITE'
) {
if (latter.operation === 'RENAME') {
if (formerType === 'same_node') {
// Creating a node and then renaming it is equivalent to creating
// it in the new location.
substitutions[j] = [];
substitutions[i] = [
{
...former,
path: latter.toPath,
},
...(substitutions[i] || []),
];
} else if (formerType === 'descendant') {
// Creating a node and then renaming its parent directory is
// equivalent to creating it in the new location.
substitutions[j] = [];
substitutions[i] = [
{
...former,
path: joinPaths(
latter.toPath,
former.path.substring(
latter.path.length
)
),
},
...(substitutions[i] || []),
];
}
} else if (
latter.operation === 'WRITE' &&
formerType === 'same_node'
) {
// Updating the same node twice is equivalent to updating it once
// at the later time.
substitutions[j] = [];
substitutions[i] = [
{
...former,
path: latter.toPath,
},
...(substitutions[i] || []),
];
} else if (formerType === 'descendant') {
// Creating a node and then renaming its parent directory is
// equivalent to creating it in the new location.
} else if (
latter.operation === 'DELETE' &&
formerType === 'same_node'
) {
// A CREATE/WRITE followed by a DELETE on the same node.
// The CREATE/WRITE is redundant.
substitutions[j] = [];
substitutions[i] = [
{
...former,
path: joinPaths(
latter.toPath,
former.path.substring(latter.path.length)
),
},
...(substitutions[i] || []),
];
}
} else if (
latter.operation === 'WRITE' &&
formerType === 'same_node'
) {
// Updating the same node twice is equivalent to updating it once
// at the later time.
substitutions[j] = [];
} else if (
latter.operation === 'DELETE' &&
formerType === 'same_node'
) {
// A CREATE/WRITE followed by a DELETE on the same node.
// The CREATE/WRITE is redundant.
substitutions[j] = [];

// The DELETE is redundant only if the node was created
// in this journal.
if (former.operation === 'CREATE') {
substitutions[i] = [];

// The DELETE is redundant only if the node was created
// in this journal.
if (former.operation === 'CREATE') {
substitutions[i] = [];
}
}
}
}
}
// Any substitutions? Apply them and start over.
// We can't just continue as the current operation may
// have been replaced.
if (Object.entries(substitutions).length > 0) {
const updated = journal.flatMap((op, index) => {
if (!(index in substitutions)) {
return [op];
}
return substitutions[index];
});
return normalizeFilesystemOperations(updated);

if (Object.keys(substitutions).length === 0) {
return journal;
}

journal = journal.flatMap((op, index) => {
if (!(index in substitutions)) {
return [op];
}
return substitutions[index];
});
}
return journal;
}

type RelatedOperationInfo = 'same_node' | 'ancestor' | 'descendant' | 'none';
Expand Down
50 changes: 50 additions & 0 deletions packages/php-wasm/fs-journal/src/test/fs-journal.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -453,4 +453,54 @@ describe('normalizeFilesystemOperations()', () => {
])
).toEqual([]);
});
it('Normalizes long rename sequences without overflowing the stack', () => {
const renameCount = 350;
const journal: FilesystemOperation[] = [];
for (let i = 0; i < renameCount; i++) {
journal.push({
operation: 'CREATE',
path: `/file-${i}`,
nodeType: 'file',
});
journal.push({
operation: 'RENAME',
path: `/file-${i}`,
toPath: `/renamed-${i}`,
nodeType: 'file',
});
}
const normalized = normalizeFilesystemOperations(journal);
expect(normalized).toEqual(
Array.from({ length: renameCount }, (_, i) => ({
operation: 'CREATE',
path: `/renamed-${i}`,
nodeType: 'file',
}))
);
});
it('Normalizes even a handful of recursive rewrites', () => {
const journal: FilesystemOperation[] = [
{ operation: 'CREATE', path: '/dir', nodeType: 'directory' },
{ operation: 'CREATE', path: '/dir/a', nodeType: 'directory' },
{
operation: 'RENAME',
path: '/dir',
toPath: '/dir/a',
nodeType: 'directory',
},
{ operation: 'DELETE', path: '/dir/a', nodeType: 'directory' },
{
operation: 'RENAME',
path: '/dir/a',
toPath: '/dir/a/b',
nodeType: 'directory',
},
{ operation: 'DELETE', path: '/dir/a/b', nodeType: 'directory' },
];
const normalized = normalizeFilesystemOperations([...journal]);
expect(normalized).toEqual([
{ operation: 'CREATE', path: '/dir/a', nodeType: 'directory' },
{ operation: 'CREATE', path: '/dir/a/a', nodeType: 'directory' },
]);
});
});