Skip to content

[Feature] Extend ExtensionInstance.deployConfig to include app config info#7697

Open
EliasJRH wants to merge 1 commit into
mainfrom
extend_deploy_config
Open

[Feature] Extend ExtensionInstance.deployConfig to include app config info#7697
EliasJRH wants to merge 1 commit into
mainfrom
extend_deploy_config

Conversation

@EliasJRH
Copy link
Copy Markdown
Contributor

@EliasJRH EliasJRH commented Jun 2, 2026

WHY are these changes introduced?

Part of https://github.com/Shopify/flow/issues/21604, allows app extensions, such as Flow actions, to access application configuration data such as the application url.

WHAT is this pull request doing?

This PR extends the ExtensionInstance.deployConfig method to allow it to accept an optional context object (currently only contains appConfiguration) which is obtained from the callsite in extension-instance.ts. Extensions can now extend their implementation of deployConfig in their createExtensionSpecification functions to use the properties of this new context object.

How to test your changes?

This PR is an enabling change and is not currently used by any app extension. I added unit coverage in extension-instance.test.ts verifying that ExtensionInstance.deployConfig passes {appConfiguration} to specification-level deployConfig. The Flow action consumer change is in #7715 .

Post-release steps

None

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes
  • I've considered analytics changes to measure impact
  • The change is user-facing — I've identified the correct bump type (patch for bug fixes · minor for new features · major for breaking changes) and added a changeset with pnpm changeset add

@EliasJRH EliasJRH marked this pull request as ready for review June 2, 2026 18:45
@EliasJRH EliasJRH requested a review from a team as a code owner June 2, 2026 18:45
Copilot AI review requested due to automatic review settings June 2, 2026 18:45
@EliasJRH EliasJRH marked this pull request as draft June 2, 2026 18:45
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR extends the extension deployment configuration hook so extension specifications can access the app’s configuration (e.g., app URLs) when building their deployConfig payload.

Changes:

  • Extends ExtensionSpecification.deployConfig signature to accept an optional context containing appConfiguration.
  • Updates ExtensionInstance.deployConfig to pass appConfiguration into the specification’s deployConfig call.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
packages/app/src/cli/models/extensions/specification.ts Extends the deployConfig function type to accept a context that can carry appConfiguration.
packages/app/src/cli/models/extensions/extension-instance.ts Passes appConfiguration from the callsite into specification.deployConfig via the new context argument.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@EliasJRH EliasJRH force-pushed the extend_deploy_config branch from 94302f0 to d945cec Compare June 2, 2026 18:50
@github-actions github-actions Bot added the no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users. label Jun 2, 2026
@EliasJRH EliasJRH self-assigned this Jun 2, 2026
@EliasJRH EliasJRH force-pushed the extend_deploy_config branch 3 times, most recently from d16a40b to 9261131 Compare June 3, 2026 17:45
@EliasJRH EliasJRH marked this pull request as ready for review June 3, 2026 17:45
@EliasJRH EliasJRH force-pushed the extend_deploy_config branch from 9261131 to 7fb04c4 Compare June 3, 2026 18:13
@steve-low steve-low requested a review from ryanische June 4, 2026 20:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants