Skip to content

PHP.wasm: Report both the source and target path on failure #896

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 1 commit into from
Dec 22, 2023
Merged

PHP.wasm: Report both the source and target path on failure #896

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
4 changes: 2 additions & 2 deletions packages/php-wasm/node/src/test/php.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ describe.each(SupportedPHPVersions)('PHP %s', (phpVersion) => {
expect(() => {
php.mv(file1, file2);
}).toThrowError(
`Could not move "${testDirPath}/1.txt": There is no such file or directory OR the parent directory does not exist.`
`Could not move ${testDirPath}/1.txt to ${testDirPath}/2.txt: There is no such file or directory OR the parent directory does not exist.`
);
});

Expand All @@ -320,7 +320,7 @@ describe.each(SupportedPHPVersions)('PHP %s', (phpVersion) => {
expect(() => {
php.mv(file1, file2);
}).toThrowError(
`Could not move "${testDirPath}/1.txt": There is no such file or directory OR the parent directory does not exist.`
`Could not move ${testDirPath}/1.txt to ${testDirPath}/nowhere/2.txt: There is no such file or directory OR the parent directory does not exist.`
);
});

Expand Down
21 changes: 18 additions & 3 deletions packages/php-wasm/universal/src/lib/base-php.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ import {
PHPRequestHandlerConfiguration,
} from './php-request-handler';
import { PHPResponse } from './php-response';
import { rethrowFileSystemError } from './rethrow-file-system-error';
import {
getEmscriptenFsError,
rethrowFileSystemError,
} from './rethrow-file-system-error';
import { getLoadedRuntime } from './load-php-runtime';
import type { PHPRuntimeId } from './load-php-runtime';
import {
Expand Down Expand Up @@ -611,9 +614,21 @@ export abstract class BasePHP implements IsomorphicLocalPHP {
}

/** @inheritDoc */
@rethrowFileSystemError('Could not move "{path}"')
mv(fromPath: string, toPath: string) {
this[__private__dont__use].FS.rename(fromPath, toPath);
try {
this[__private__dont__use].FS.rename(fromPath, toPath);
} catch (e) {
const errmsg = getEmscriptenFsError(e);
if (!errmsg) {
throw e;
}
throw new Error(
`Could not move ${fromPath} to ${toPath}: ${errmsg}`,
{
cause: e,
}
);
}
}

/** @inheritDoc */
Expand Down
10 changes: 9 additions & 1 deletion packages/php-wasm/universal/src/lib/rethrow-file-system-error.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export interface ErrnoError extends Error {
/**
* @see https://github.com/emscripten-core/emscripten/blob/38eedc630f17094b3202fd48ac0c2c585dbea31e/system/include/wasi/api.h#L336
*/
const FileErrorCodes = {
export const FileErrorCodes = {
0: 'No error occurred. System call completed successfully.',
1: 'Argument list too long.',
2: 'Permission denied.',
Expand Down Expand Up @@ -93,6 +93,14 @@ const FileErrorCodes = {
75: 'Cross-device link.',
76: 'Extension: Capabilities insufficient.',
} as any;

export function getEmscriptenFsError(e: any) {
const errno = typeof e === 'object' ? ((e as any)?.errno as any) : null;
if (errno in FileErrorCodes) {
return FileErrorCodes[errno];
}
}

export function rethrowFileSystemError(messagePrefix = '') {
return function catchFileSystemError(
target: any,
Expand Down