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

Don't use the wrong PID in error strings #4530

Merged
merged 1 commit into from
Jun 4, 2024

Conversation

twz123
Copy link
Member

@twz123 twz123 commented May 31, 2024

Description

Instead of using the PID in the argument, the error strings were constructed using the PID of the currently running process. This would have caused a panic because the PID file cleanup is called before the supervised process is started. So the s.cmd would have been nil.

Don't put the PID in the errors at this level at all, but wrap the error once with the actual PID read from the PID file in maybeKillPidFile.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

How Has This Been Tested?

  • Manual test
  • Auto test added

Checklist:

  • My code follows the style guidelines of this project
  • My commit messages are signed-off
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

Instead of using the PID in the argument, the error strings were
constructed using the PID of the currently running process. This would
have caused a panic because the PID file cleanup is called before the
supervised process is started. So the s.cmd would have been nil.

Don't put the PID in the errors at this level at all, but wrap the error
once with the actual PID read from the PID file in maybeKillPidFile.

Signed-off-by: Tom Wieczorek <[email protected]>
@twz123 twz123 added bug Something isn't working backport/release-1.30 PR that needs to be backported/cherrypicked to the release-1.30 branch labels May 31, 2024
@twz123 twz123 marked this pull request as ready for review May 31, 2024 18:32
@twz123 twz123 requested a review from a team as a code owner May 31, 2024 18:32
@twz123 twz123 requested review from kke and jnummelin May 31, 2024 18:32
@twz123 twz123 merged commit b41ea09 into k0sproject:main Jun 4, 2024
80 checks passed
@twz123 twz123 deleted the pid-in-error-strings branch June 4, 2024 14:18
@k0s-bot
Copy link

k0s-bot commented Jun 4, 2024

Successfully created backport PR for release-1.30:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/release-1.30 PR that needs to be backported/cherrypicked to the release-1.30 branch bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants