Pass app module context through to registration's activeVersion if it exists

[jamieguerrero]

Add support for extension context in app module versions

TL;DR

Fixes https://github.com/shop/issues-develop/issues/17833

Added support for the target field in app module versions to enhance extension configuration capabilities.

What changed?

• Added the target field to the GraphQL query for released app modules
• Updated the AppModuleVersion interface to include the optional target property
• Modified the appExtensionRegistrations method to include the context field in the activeVersion object when both config and target are present
• Added comprehensive tests to verify the behavior with various combinations of config and context values

How to test?

1. Run the test suite to verify the new functionality:

   npm test packages/app/src/cli/utilities/developer-platform-client/app-management-client.test.ts
   

2. Test the CLI with an app that uses extensions with context values:
   • Create an app with extensions that include target data
   • Verify that the target data is properly included as context in the extension registrations
   • Check that the context is correctly passed to the UI when viewing extensions

Why make this change?

This change enables extensions to store and retrieve contextual information alongside their configuration. The target field (mapped to context in the client) provides a way for extensions to maintain state or metadata that isn't part of the user-configurable settings but is necessary for proper extension functionality. This enhancement improves the flexibility of the extension system and allows for more sophisticated extension behaviors.

[jamieguerrero]

• Query for app module id and use as registration id #6229
• Pass app module context through to registration's activeVersion if it exists #6212 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[github-actions]

We detected some changes at packages/*/src and there are no updates in the .changeset.
If the changes are user-facing, run pnpm changeset add to track your changes and include them in the next release CHANGELOG.

Caution

DO NOT create changesets for features which you do not wish to be included in the public changelog of the next CLI release.

[jamieguerrero]

/snapit

[github-actions]

Coverage report

St.❔	Category	Percentage	Covered / Total
🟡	Statements	78.33% (+0.03% 🔼)	13176/16822
🟡	Branches	72.4% (+0.1% 🔼)	6434/8887
🟡	Functions	78.4% (+0.02% 🔼)	3419/4361
🟡	Lines	78.7% (+0.03% 🔼)	12467/15842

Show new covered files 🐣

St.❔	File	Statements	Branches	Functions	Lines
🟢	... / url_prepender.ts	100%	100%	100%	100%

Show files with reduced coverage 🔻

St.❔	File	Statements	Branches	Functions	Lines
🟢	... / app_config_webhook_subscription.ts	100%	50% (-16.67% 🔻)	100%	100%
🟡	... / identifiers-extensions.ts	75.78% (+0.38% 🔼)	68.12% (-0.54% 🔻)	100%	77.39% (+0.4% 🔼)

Test suite run success

3126 tests passing in 1324 suites.

Report generated by 🧪jest coverage report action from 1afbe62

[github-actions]

🫰✨ Thanks @jamieguerrero! Your snapshot has been published to npm.

Test the snapshot by installing your package globally:

pnpm i -g @shopify/[email protected]

Tip

If you get an ETARGET error, install it with NPM and the flag --@shopify:registry=https://registry.npmjs.org

Caution

After installing, validate the version by running just shopify in your terminal.
If the versions don't match, you might have multiple global instances installed.
Use which shopify to find out which one you are running and uninstall it.

[jamieguerrero]

This is the main change. Currently, some dashboard managed extensions are failing at importing because we are not passing the app module's context along here and it is causing things to fail here.