Add DeployExtensionResult type and export - #1838
Open
arushisinhaa wants to merge 1 commit into
Open
arushisinhaa wants to merge 1 commit into
arushisinhaa wants to merge 1 commit into
Conversation
|
Thanks for the contribution! Unfortunately we can't verify the commit author(s): Arushi Sinha <a***@s***.com>. One possible solution is to add that email to your GitHub account. Alternatively you can change your commits to another email and force push the change. After getting your commits associated with your GitHub account, refresh the status of this Pull Request. |
This was referenced Sep 28, 2026
This branch has not been deployed
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
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.
What does this PR do?
Export a
DeployExtensionResulttype and hang it onMetadataApiDeployStatus.deployExtensionResults, so SDR (and the CLI plugin) can read post-deploy extension status from MetadatacheckDeployStatus.Depends on jsforce parsing the field: jsforce#1832. Surfaced in CLI by plugin-deploy-retrieve#1647.
Design
A Metadata Deploy (API 67+, Core 262) can start a deploy extension after the zip save succeeds. Datakit automated deploy is one of those: the main MDAPI deploy is already
Succeededwhile the kit job is stillInProgress.Core already returns this on SOAP
checkDeployStatus. Workbench shows it. SDR had no type for it, so library consumers (including the deploy plugin) could not use the field even after jsforce started parsing it.How MDAPI looks (SOAP
checkDeployStatus)DeployResultincludes an optional repeating child (API 67+):typestringDeployExtensionTypeAPI value, e.g.DataKitPostDeployFlowstatusstringNew/InProgress/Succeeded/Failedmessagestring(optional)Example SOAP fragment:
jsforce may return one object or an array; the SDR field is typed as
DeployExtensionResult | DeployExtensionResult[]to match that.Component deploy status and extension status are independent. The zip can be
Succeededwhile the extension is stillInProgress.How CLI looked before vs after
Before:
sf project deploy reportnever showed extensions.After this stack: jsforce keeps the array; this PR types it; the plugin adds a report row
deployextension.{type}whose value is{"status":"InProgress"}(and includesmessagewhen status isFailed).Screenshots: Workbench
checkDeployStatus(MDAPI) and CLI deploy report after the change.