Only make one call to GetPackageInfoJson #8152
Merged
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
JimSuplizio
requested review from
benbp,
konrad-jamrozik and
weshaggard
as code owners
weshaggard
approved these changes
Apr 23, 2024
danieljurek
approved these changes
Apr 23, 2024
Collaborator
|
The following pipelines have been queued for testing: |
Collaborator
|
The following pipelines have been queued for testing: |
This was referenced Apr 23, 2024
JimSuplizio
added a commit
to Azure/azure-sdk-for-js
that referenced
this pull request
Apr 23, 2024
Sync eng/common directory with azure-sdk-tools for PR Azure/azure-sdk-tools#8152 See [eng/common workflow](https://github.com/Azure/azure-sdk-tools/blob/main/eng/common/README.md#workflow) --------- Co-authored-by: James Suplizio <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Update-DocsMsMetadata.ps1 is the entry point for MS Docs updates in our pipelines.
Hoist the
$packageInfo = GetPackageInfoJson $packageInfoLocationout of theif ($ValidateDocsMsPackagesFn...if check and pass the packageInfo into the UpdateDocsMsMetadataForPackage call. The reason for this is that UpdateDocsMsMetadataForPackage also calls GetPackageInfo and if the $GetDocsMsDevLanguageSpecificPackageInfoFn function pointer is defined, like it is for Java, JavaScript and Python, it ends up making calls across the network to get pieces to add to the packageInfo Json. In the cases of Java and Python, it's pulling the javadoc or .whl to crack open to get the namespaces. For JavaScript, it's invoking a rest method. Hoisting the call out of the if statement and passing in the structure to UpdateDocsMsMetadataForPackage prevents a second set of network calls to get information that we literally just got.