Skip to content

Harden browser Playground request transport #582

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
chubes4 merged 1 commit into from
Jun 4, 2026
Merged

Harden browser Playground request transport #582

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
60 changes: 47 additions & 13 deletions packages/wordpress-plugin/assets/browser-runtime.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,21 +131,49 @@
data: error?.data ?? null,
} );

const normalizePlaygroundAttempt = ( attempt, index, method ) => {
if ( typeof attempt === 'function' ) {
return {
label: `${ method }-${ index + 1 }`,
run: attempt,
};
}

return {
label: String( attempt?.label || `${ method }-${ index + 1 }` ),
run: attempt?.run,
shape: attempt?.shape || null,
};
};

const invokePlaygroundMethod = async ( phase, method, attempts ) => {
let lastError = null;
for ( const attempt of attempts ) {
const failedAttempts = [];
for ( const [ index, rawAttempt ] of attempts.entries() ) {
const attempt = normalizePlaygroundAttempt( rawAttempt, index, method );
try {
return await attempt();
if ( typeof attempt.run !== 'function' ) {
throw runtimeError( phase, `playground_${ method }_attempt_invalid`, `Playground ${ method } attempt is not callable.` );
}
return await attempt.run();
} catch ( error ) {
lastError = error;
failedAttempts.push( {
label: attempt.label,
shape: attempt.shape,
error: errorDetails( error ),
} );
}
}

throw runtimeError(
phase,
`playground_${ method }_failed`,
`Playground ${ method } failed during ${ phase }.`,
lastError ? errorDetails( lastError ) : null
{
last_error: lastError ? errorDetails( lastError ) : null,
attempts: failedAttempts,
}
);
};

Expand Down Expand Up @@ -691,14 +719,6 @@ try {
`;

const playgroundRequestTarget = ( client ) => {
if ( client?.requestHandler && typeof client.requestHandler.request === 'function' ) {
return {
target: client.requestHandler,
method: client.requestHandler.request,
shape: 'request-handler',
};
}

if ( client && typeof client.request === 'function' ) {
return {
target: client,
Expand All @@ -707,6 +727,14 @@ try {
};
}

if ( client?.requestHandler && typeof client.requestHandler.request === 'function' ) {
return {
target: client.requestHandler,
method: client.requestHandler.request,
shape: 'request-handler',
};
}

return null;
};

Expand Down Expand Up @@ -742,8 +770,14 @@ try {

const invoke = ( body ) => requestTarget.method.call( requestTarget.target, body );
const attempts = requestTarget.shape === 'request-handler'
? [ () => invoke( { request } ), () => invoke( request ) ]
: [ () => invoke( request ), () => invoke( { request } ) ];
? [
{ label: 'request-handler-envelope', shape: 'request-handler', run: () => invoke( { request } ) },
{ label: 'request-handler-plain', shape: 'request-handler', run: () => invoke( request ) },
]
: [
{ label: 'client-plain', shape: 'client', run: () => invoke( request ) },
{ label: 'client-envelope', shape: 'client', run: () => invoke( { request } ) },
];

return await invokePlaygroundMethod( 'request', 'request', attempts );
};
Expand Down
39 changes: 39 additions & 0 deletions scripts/browser-runtime-operation-smoke.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,14 +85,23 @@ assert.match(successClient.files[0]?.contents ?? "", /wp-load\.php/)
assert.match(successClient.files[0]?.contents ?? "", /case 'ensureDirectory':/)
assert.match(successClient.requests[0]?.url ?? "", /\/wp-content\/uploads\/wp-codebox\/runner\/codebox-ensuredirectory-/)

const dualTransportClient = createClient("prefix {\"success\":true,\"data\":{\"runner\":\"client\"},\"error\":null} suffix", false, true)
const dualTransportResult = await runtime.runPhpRequest(dualTransportClient, { code: "<?php echo 'ok';", expectJson: true })
assert.deepEqual(sameRealm(dualTransportResult), { success: true, data: { runner: "client" }, error: null })
assert.equal(dualTransportClient.requests.length, 1)
assert.equal(dualTransportClient.handlerRequests.length, 0)
assert.match(dualTransportClient.requests[0]?.url ?? "", /\/wp-content\/uploads\/wp-codebox\/runner\/task-/)

const handlerClient = createClient("prefix {\"success\":true,\"data\":{\"runner\":\"handler\"},\"error\":null} suffix", false, true)
delete (handlerClient as { request?: unknown }).request
const handlerResult = await runtime.runPhpRequest(handlerClient, { code: "<?php echo 'ok';", expectJson: true })
assert.deepEqual(sameRealm(handlerResult), { success: true, data: { runner: "handler" }, error: null })
assert.equal(handlerClient.handlerRequests.length, 1)
assert.equal(handlerClient.requests.length, 0)
assert.match(handlerClient.handlerRequests[0]?.url ?? "", /\/wp-content\/uploads\/wp-codebox\/runner\/task-/)

const workerEndpointClient = createClient("prefix {\"success\":true,\"data\":{\"runner\":\"worker-endpoint\"},\"error\":null} suffix", false, true)
delete (workerEndpointClient as { request?: unknown }).request
workerEndpointClient.requestHandler = {
request: async (body: { request?: { method: string; url: string } }) => {
if (!body.request) {
Expand All @@ -106,6 +115,36 @@ const workerEndpointResult = await runtime.runPhpRequest(workerEndpointClient, {
assert.deepEqual(sameRealm(workerEndpointResult), { success: true, data: { runner: "worker-endpoint" }, error: null })
assert.equal(workerEndpointClient.handlerRequests.length, 1)

const failingRequestClient = createClient("", false, true)
delete (failingRequestClient as { request?: unknown }).request
failingRequestClient.requestHandler = {
request: async () => {
throw new Error("Playground worker rejected request")
},
}
const failedRequestError = await runtime.runPhpRequest(failingRequestClient, { code: "<?php echo 'ok';", expectJson: true }).catch((error: unknown) => error)
assert.equal(failedRequestError.code, "playground_request_failed")
assert.equal(failedRequestError.phase, "request")
assert.deepEqual(
sameRealm(failedRequestError.data?.attempts?.map((attempt: { label?: string; shape?: string; error?: { message?: string } }) => ({
label: attempt.label,
shape: attempt.shape,
message: attempt.error?.message,
}))),
[
{
label: "request-handler-envelope",
shape: "request-handler",
message: "Playground worker rejected request",
},
{
label: "request-handler-plain",
shape: "request-handler",
message: "Playground worker rejected request",
},
]
)

const objectShapeFileClient = createClient("prefix {\"success\":true,\"data\":{\"runner\":\"object-file\"},\"error\":null} suffix")
objectShapeFileClient.writeFile = async function writeFile(body: string | { path?: string; data?: string }) {
if (typeof body === "string") {
Expand Down