Validate `@shopify/shopify_function` version on build #5153

andrewhassan · 2025-01-03T21:12:40Z

WHY are these changes introduced?

Closes https://github.com/Shopify/shopify-functions/issues/519

The @shopify/shopify_function NPM package for JavaScript Functions is implicitly tied to the version of Javy used by the CLI. However, we don't validate that the NPM package is compatible today, which means it's possible to use an older version of the NPM package that isn't compatible with a newer version of Javy.

WHAT is this pull request doing?

To guarantee compatibility, this PR validates that the installed @shopify/shopify_function package's major version is what the CLI expects.

This PR also ensures that we're using the latest patch version in our recommendations and when generating a function.

How to test your changes?

Run app function build for a JS function using shopify_function version 1.x.y.
Run app function build for a JS function using shopify_function version 0.x.y.
Run app dev for a JS function (both scenarios above)
Run app function build for a Rust function (should not be affected by these changes)

Measuring impact

How do we know this change was effective? Please choose one:

n/a - this doesn't need measurement, e.g. a linting rule or a bug-fix
Existing analytics will cater for this addition
PR includes analytics changes to measure impact

Checklist

I've considered possible cross-platform impacts (Mac, Linux, Windows)
I've considered possible documentation changes

packages/app/src/cli/services/function/build.ts

github-actions · 2025-01-06T16:28:57Z

Coverage report

St.^❔	Category	Percentage	Covered / Total
🟡	Statements	75.33% (+0.02% 🔼)	8852/11751
🟡	Branches	70.58% (+0.02% 🔼)	4294/6084
🟡	Functions	75.23% (+0.02% 🔼)	2317/3080
🟡	Lines	75.87% (+0.03% 🔼)	8369/11030

Show files with reduced coverage 🔻

St.^❔	File	Statements	Branches	Functions	Lines
🟢	`...` / app-event-watcher.ts	93.83% (-1.23% 🔻)	86.49% (-2.7% 🔻)	90.48%	98.61%

Test suite run success

1995 tests passing in 902 suites.

Report generated by 🧪jest coverage report action from f4c7577

isaacroldan · 2025-01-07T14:40:46Z

packages/app/src/cli/services/function/build.ts

@@ -139,11 +147,32 @@
  return entryPoint
 }

+async function validateShopifyFunctionPackageVersion(fun: ExtensionInstance<FunctionConfigType>) {
+  const packageJsonPath = await findPathUp('node_modules/@shopify/shopify_function/package.json', {


have you tried this path with different package managers? I know that pnpm sometimes uses a different folder structure for modules.

I have not, but I was following the implementation here and assumed they validated this.

lopert

LGTM, spent a bit of time messing with the various package files and node_modules folders to 🎩 this.

lopert · 2025-01-07T18:37:07Z

packages/app/src/cli/services/function/build.ts

+      outputContent`Make sure you have a compatible version of the ${outputToken.yellow(
+        '@shopify/shopify_function',
+      )} library installed.`,
+      [
+        outputContent`Add ${outputToken.green(
+          `"@shopify/shopify_function": "~${SHOPIFY_FUNCTION_NPM_PACKAGE_MAJOR_VERSION}.0.0"`,
+        )} to the dependencies section of the package.json file in your function's directory, if not already present.`
+          .value,
+        `Run your package manager's install command to update dependencies.`,


Should I be able to see these messages in the console when I encounter this error?

I do see the passed in message: Could not find the Shopify Functions JavaScript library.

I know in this PR you refactored things into an AbortError subclass so this is just a mov, but still got me thinking... where does all this outputContent end up? Even running the build command with --verbose doesn't show it.

I noticed that too when testing. It appears that the error is caught and rethrown here. I didn't want to tackle that as part of this PR though, since it's more related to the general error handling.

Are you going to fix that in a follow-up PR? there's no reason to have a custom Error if doesn't work as expected :)

I can take a look. I'm not actually sure why we rethrow the error like this 😅 It looks like you added it about a month ago. Do you have context on it?

Ah, I added that try/catch because we were leaking some errors, and we want to properly Abort if there is an issue in any step of the build process.

But the rethrow keeps the message, why isn't it preserved in this case?

packages/app/src/cli/services/function/build.ts

saga-dasgupta

This change makes sense to me and I was able to verify the expected error message is displayed for function build and app dev for a function with shopify-functions version 0.1.0.

andrewhassan force-pushed the ah.validate-shopify-function-package-version branch from 10e6428 to e121a59 Compare January 3, 2025 21:46

nickwesselman reviewed Jan 3, 2025

View reviewed changes

packages/app/src/cli/services/function/build.ts Outdated Show resolved Hide resolved

andrewhassan changed the title ~~Validate shopify_function version on build~~ Validate @shopify/shopify_function version on build Jan 3, 2025

andrewhassan force-pushed the ah.validate-shopify-function-package-version branch 3 times, most recently from c980c84 to e57adca Compare January 3, 2025 22:04

andrewhassan mentioned this pull request Jan 3, 2025

Default to using the latest patch version of shopify_function #5045

Closed

andrewhassan marked this pull request as ready for review January 3, 2025 22:11

andrewhassan requested a review from a team as a code owner January 3, 2025 22:11

This comment has been minimized.

Sign in to view

andrewhassan requested a review from a team as a code owner January 6, 2025 15:55

andrewhassan added 3 commits January 6, 2025 11:24

Validate shopify_function version on build

b60dff9

Use the latest patch version when generating function

f64195e

Add changeset

f4c7577

andrewhassan force-pushed the ah.validate-shopify-function-package-version branch from 7cc70c4 to f4c7577 Compare January 6, 2025 16:24

andrewhassan requested review from a team, lopert and saga-dasgupta and removed request for a team January 6, 2025 21:41

isaacroldan reviewed Jan 7, 2025

View reviewed changes

lopert approved these changes Jan 7, 2025

View reviewed changes

saga-dasgupta approved these changes Jan 8, 2025

View reviewed changes

andrewhassan enabled auto-merge January 9, 2025 22:15

andrewhassan disabled auto-merge January 9, 2025 22:26

andrewhassan requested a review from isaacroldan January 9, 2025 22:26

isaacroldan approved these changes Jan 13, 2025

View reviewed changes

andrewhassan added this pull request to the merge queue Jan 13, 2025

Merged via the queue into main with commit 3b4a49f Jan 13, 2025
27 checks passed

andrewhassan deleted the ah.validate-shopify-function-package-version branch January 13, 2025 13:59

shopify-shipit bot temporarily deployed to experimental January 13, 2025 14:41 Inactive

shopify-shipit bot temporarily deployed to nightly January 14, 2025 10:58 Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Validate `@shopify/shopify_function` version on build #5153

Validate `@shopify/shopify_function` version on build #5153

andrewhassan commented Jan 3, 2025 •

edited

Loading

This comment has been minimized.

github-actions bot commented Jan 6, 2025

isaacroldan Jan 7, 2025

andrewhassan Jan 7, 2025

lopert left a comment

lopert Jan 7, 2025

andrewhassan Jan 8, 2025

isaacroldan Jan 13, 2025

andrewhassan Jan 13, 2025

isaacroldan Jan 13, 2025

saga-dasgupta left a comment

Validate @shopify/shopify_function version on build #5153

Validate @shopify/shopify_function version on build #5153

Conversation

andrewhassan commented Jan 3, 2025 • edited Loading

WHY are these changes introduced?

WHAT is this pull request doing?

How to test your changes?

Measuring impact

Checklist

This comment has been minimized.

github-actions bot commented Jan 6, 2025

Coverage report

Test suite run success

isaacroldan Jan 7, 2025

Choose a reason for hiding this comment

andrewhassan Jan 7, 2025

Choose a reason for hiding this comment

lopert left a comment

Choose a reason for hiding this comment

lopert Jan 7, 2025

Choose a reason for hiding this comment

andrewhassan Jan 8, 2025

Choose a reason for hiding this comment

isaacroldan Jan 13, 2025

Choose a reason for hiding this comment

andrewhassan Jan 13, 2025

Choose a reason for hiding this comment

isaacroldan Jan 13, 2025

Choose a reason for hiding this comment

saga-dasgupta left a comment

Choose a reason for hiding this comment

Validate `@shopify/shopify_function` version on build #5153

Validate `@shopify/shopify_function` version on build #5153

andrewhassan commented Jan 3, 2025 •

edited

Loading