[Comlink] Throw the original error in the error handler #2407
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation for the change, related issues
The new Comlink error handler rewired the logic around passing errors from web workers to the Playground web app. Specifically, it enriched the error with additional stack trace before rethrowing it:
Unfortunately, this also put the original error at the bottom of the
error.causechain, making error handling confusing for the API consumers.This PR ensures the thrown error the original one. This way a simple
try {} catch(e) {}is enough to log the error details without having to reason aboute.cause.causeetc. The additional stack trace information is now attached at the bottom of the cause chain for when the developer needs to inspect it.Testing Instructions (or ideally a Blueprint)
Run Playground with this Blueprint and confirm the top-level error message speaks about PHP failure. Specifically, it should not say "Comlink method call failed":
{ "steps": [ { "step": "mkdir", "path": "/wordpress/wp-content/mu-plugins" }, { "step": "writeFile", "path": "/wordpress/wp-content/mu-plugins/test.php", "data": "<?php undefined_function();" } ] }