Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Fix multiple parallelization issues #5432

Merged
merged 3 commits into from
Aug 22, 2024

Conversation

PeterSchafer
Copy link
Collaborator

Pull Request Submission

Please check the boxes once done.

The pull request must:

  • Reviewer Documentation
    • follow CONTRIBUTING rules
    • be accompanied by a detailed description of the changes
    • contain a risk assessment of the change (Low | Medium | High) with regards to breaking existing functionality. A change e.g. of an underlying language plugin can completely break the functionality for that language, but appearing as only a version change in the dependencies.
    • highlight breaking API if applicable
    • contain a link to the automatic tests that cover the updated functionality.
    • contain testing instructions in case that the reviewer wants to manual verify as well, to add to the manual testing done by the author.
    • link to the link to the PR for the User-facing documentation
  • User facing Documentation
    • update any relevant documentation in gitbook by submitting a gitbook PR, and including the PR link here
    • ensure that the message of the final single commit is descriptive and prefixed with either feat: or fix: , others might be used in rare occasions as well, if there is no need to document the changes in the release notes. The changes or fixes should be described in detail in the commit message for the changelog & release notes.
  • Testing
    • Changes, removals and additions to functionality must be covered by acceptance / integration tests or smoke tests - either already existing ones, or new ones, created by the author of the PR.

Pull Request Review

All pull requests must undergo a thorough review process before being merged.
The review process of the code PR should include code review, testing, and any necessary feedback or revisions.
Pull request reviews of functionality developed in other teams only review the given documentation and test reports.

Manual testing will not be performed by the reviewing team, and is the responsibility of the author of the PR.

For Node projects: It’s important to make sure changes in package.json are also affecting package-lock.json correctly.

If a dependency is not necessary, don’t add it.

When adding a new package as a dependency, make sure that the change is absolutely necessary. We would like to refrain from adding new dependencies when possible.
Documentation PRs in gitbook are reviewed by Snyk's content team. They will also advise on the best phrasing and structuring if needed.

Pull Request Approval

Once a pull request has been reviewed and all necessary revisions have been made, it is approved for merging into
the main codebase. The merging of the code PR is performed by the code owners, the merging of the documentation PR
by our content writers.

What does this PR do?

This PR addresses multiple issues related to parallel execution of the CLI as a standalone executable on Windows OS as well as through the language-server command on any OS. The following changes are combined since they are strongly coupled.

  • Replace singleton usage for the internal proxy by a singleton for the internal certificate authority, which showed to be the actual shared instance that required this.
  • Replace implicit cleanup of temporary directories by an explicit removal, which can be triggered through the workflow engine.

Risk:

  • For CLI standalone execution, the risk should be low as the main change here is less cleanup.
  • For the language-server command, the risk is that in some edge cases, like crashes, temporary files are not cleaned up. Which is in a lot of cases acceptable.

Where should the reviewer start?

How should this be manually tested?

Any background context you want to provide?

What are the relevant tickets?

Screenshots

Additional questions

@PeterSchafer PeterSchafer changed the title fix: Fix parallelization multiple issues fix: Fix multiple parallelization issues Aug 20, 2024
@PeterSchafer PeterSchafer force-pushed the fix/CLI-456_ca_singleton branch from ed57492 to 9fa49db Compare August 20, 2024 16:24
@PeterSchafer PeterSchafer marked this pull request as ready for review August 20, 2024 16:36
@PeterSchafer PeterSchafer requested a review from a team as a code owner August 20, 2024 16:36
Copy link
Contributor

@cmars cmars left a comment

Choose a reason for hiding this comment

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

I have concerns with the acceptance tests -- we won't get a clear enough signal out of them to test race conditions properly.

I'd prefer to improve the Go tests to the point that we're confident in the primitives we've built upon.

test/jest/acceptance/language-server-extension.spec.ts Outdated Show resolved Hide resolved
cliv2/pkg/basic_workflows/globalresources.go Outdated Show resolved Hide resolved
cliv2/pkg/basic_workflows/legacycli.go Outdated Show resolved Hide resolved
chore: rollback test

chore: add test and update gaf
@PeterSchafer PeterSchafer force-pushed the fix/CLI-456_ca_singleton branch from dcd8c9c to 313d94f Compare August 22, 2024 16:19
@PeterSchafer PeterSchafer enabled auto-merge August 22, 2024 16:21
Upgrade linter to support Go 1.22 language features.
@cmars cmars force-pushed the fix/CLI-456_ca_singleton branch from 453fe42 to c0b1461 Compare August 22, 2024 17:07
The additional assertion fails on non-Windows platforms.

Rolling this back as it's a pre-existing condition, though we should follow up.
@PeterSchafer PeterSchafer merged commit b011ea4 into release-candidate Aug 22, 2024
7 checks passed
@PeterSchafer PeterSchafer deleted the fix/CLI-456_ca_singleton branch August 22, 2024 20:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants