🩹 [Patch]: Optimize Connect-GitHubApp and use parallel processing of access tokens #519
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
…s and improve examples
- Created TEMPLATE.ps1 for Pester tests with a template structure. - Added Teams.Tests.ps1 to test GitHub Teams API functionalities including team creation, retrieval, updating, and deletion. - Introduced Users.Tests.ps1 to validate user-related API calls, including user retrieval and updates. - Implemented Variables.Tests.ps1 to manage GitHub repository variables, including setting, updating, and removing variables.
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the Connect-GitHubApp function to support parallel processing of GitHub App installation connections, significantly improving performance when connecting to multiple installations. The changes introduce new parameter sets for handling pipeline input and parallel execution controls.
- Added parallel processing capabilities using
ForEach-Object -Parallelwith configurable throttle limits - Introduced new parameter set for accepting installation objects from pipeline input
- Added retry logic for context creation to improve reliability
Reviewed Changes
Copilot reviewed 2 out of 17 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| src/functions/public/Auth/Connect-GitHubApp.ps1 | Major refactoring to support parallel processing, new parameter sets, and recursive connections to installations |
| .github/PSModule.yml | Configuration updates to skip various test components in CI workflows |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
…e and improve parallel processing
Co-authored-by: Copilot <[email protected]>
MariusStorhaug
force-pushed
the
parallelConnect
branch
from
0a4ce89 to
7212939
Compare
…reation and removing unnecessary Write-Host statements in Connect-GitHubApp
…missionDefinition class
…gic for module import in Connect-GitHubApp
…GitHubPermission class with equality and hash code methods
…ion comparison logic in GitHubAppInstallation class
…d adjusting property names
…n GitHubAppContext and GitHubAppInstallationContext
…ppContext and streamline app property initialization
…rEnterpriseOrganization function
…t-GitHubAppInstallationForAuthenticatedAppAsList function
…nstallationForAuthenticatedAppByID function
…pInstallation function for clarity
…ostName parameter for URL generation
…prove error handling
…ug parameter instead of Name
…ing for properties
… AppContext.App directly
…le for property assignment; enhance GitHubAppContext to handle null permissions and app objects; improve parameter sets in Get-GitHubAppInstallation function for clarity.
MariusStorhaug
force-pushed
the
parallelConnect
branch
from
968e822 to
3b31737
Compare
…nect-GitHubApp functions for consistency; enhance verbosity handling in Connect-GitHubApp; add logging for GitHub app details in Apps.Tests.
… of GitHub context in the 'Context' log group.
…al method in log group name for clarity.
…each loop with Compare-Object for improved performance and readability.
…ct for improved performance; remove redundant equality check in GitHubPermission class.
…nalities in Apps.Tests; improve logging for better visibility of app details and webhook configurations.
…on tests; improve test coverage for context properties.
…rmissionDefinition function and associated completers for improved clarity and maintainability.
…mission.NewList for consistency and improved clarity.
…s.Tests; replace deprecated methods with new implementations for improved clarity and maintainability.
…d clarity in Apps.Tests
- Created TEMPLATE.ps1 for standardized test structure. - Implemented Teams.Tests.ps1 to validate GitHub Teams API functionality, including team creation, retrieval, updating, and deletion. - Developed Users.Tests.ps1 to test user-related API calls, such as fetching user details and managing user emails. - Established Variables.Tests.ps1 to cover GitHub variable management, including organization and repository variables. - Ensured all tests utilize proper authentication and context management for reliable execution. - Added logging for better visibility during test runs.
… test coverage visibility
…ion IDs and improve pipeline handling; update Apps.Tests for better coverage and clarity.
…erty to organization objects and updating constructors for consistency across classes.
… context in installation objects for improved data handling.
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.
Description
This pull request enhances the
Connect-GitHubAppfunction to support parallel and recursive creation of connections to multiple GitHub App installations, improving scalability and performance. It also updates the documentation and parameter handling to reflect these new capabilities. The changes are grouped below by theme:Parallel Processing & Scalability Improvements:
-ThrottleLimitparameter and PowerShell's parallel execution features (ForEach-Object -Parallel). This applies to all installations, filtered targets, and piped installation objects. [1] [2]Documentation & Usability Updates:
-ThrottleLimitparameter. [1] [2] [3]Robustness Enhancements:
Configuration File Updates:
.github/PSModule.ymlto enable skipping of test results, source code, module builds, and documentation in CI workflows, aligning with the new parallel processing capabilities.Type of change
Checklist