Add a more helpful error message when Javy.JSON is missing #22
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -14,6 +14,9 @@ declare global { | |||
| } | |||
|
|
|||
| export default function <I extends {}, O extends {}>(userfunction: ShopifyFunction<I, O>) { | |||
| if (!Javy.JSON) { | |||
| throw new Error('Javy.JSON is not defined. Please rebuild your function using the latest version of Shopify CLI.'); | |||
There was a problem hiding this comment.
Does it make sense to put the exact command you'd need to run?
There was a problem hiding this comment.
The command will depend on if you are using global or local install of the CLI, and your package manager of choice.
There was a problem hiding this comment.
We could link to docs, but i worry about that link becoming stale --
davejcameron
approved these changes
Dec 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
If you use the latest
@shopify/shopify_functionwithout the latest Shopify CLI, you get an unhelpful error message:Several partners have encountered this. This PR makes the output error more helpful.
In the non-error case, this adds 1727 instructions, which is only 0.0157% of the overall budget. Tested cases with the OOTB checkout validation function are below.
CLI 3.66 with shopify_function 1.0.2
npx @shopify/[email protected] app buildecho '{ "cart": { "lines":[] } }' | npx @shopify/[email protected] app function runInstructions: 165.997K
Error:3:31 cannot read property 'fromStdin' of undefined at run_default (function.mjs:3:31) at run2 (function.mjs:21:10) at <anonymous> (eval_script:1:37) error while executing at wasm backtrace: 0: 0x10611b - javy_quickjs_provider.wasm!abort 1: 0x3e3e8 - javy_quickjs_provider.wasm!std::sys::pal::wasi::helpers::abort_internal::hfbe314d302b73e09 2: 0x30847 - javy_quickjs_provider.wasm!std::process::abort::hc61a197fac268dc4 3: 0x30efe - javy_quickjs_provider.wasm!invoke 4: 0x110ba1 - javy_quickjs_provider.wasm!invoke.command_export 5: 0x11f - <unknown>!<wasm function 3>CLI 3.66 with shopify_function changes
npx @shopify/[email protected] app buildecho '{ "cart": { "lines":[] } }' | npx @shopify/[email protected] app function runInstructions: 165.963K
Error:4:11 Javy.JSON is not defined. Please rebuild your function using the latest version of Shopify CLI. at run_default (function.mjs:4:11) at run2 (function.mjs:24:10) at <anonymous> (eval_script:1:37) error while executing at wasm backtrace: 0: 0x10611b - javy_quickjs_provider.wasm!abort 1: 0x3e3e8 - javy_quickjs_provider.wasm!std::sys::pal::wasi::helpers::abort_internal::hfbe314d302b73e09 2: 0x30847 - javy_quickjs_provider.wasm!std::process::abort::hc61a197fac268dc4 3: 0x30efe - javy_quickjs_provider.wasm!invoke 4: 0x110ba1 - javy_quickjs_provider.wasm!invoke.command_export 5: 0x11f - <unknown>!<wasm function 3>CLI 3.70 with shopify_function 1.0.2
npx @shopify/cli@latest app buildecho '{ "cart": { "lines":[] } }' | npx @shopify/cli@latest app function runInstructions: 161.376K
{ "errors": [] }CLI 3.70 with shopify_function changes
npx @shopify/cli@latest app buildecho '{ "cart": { "lines":[] } }' | npx @shopify/cli@latest app function runInstructions: 163.103K (+1727)
{ "errors": [] }