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 store contexts in lease pool structs #4733

Merged
merged 1 commit into from
Sep 9, 2024

Conversation

twz123
Copy link
Member

@twz123 twz123 commented Jul 9, 2024

Description

The context shouldn't be stored in structs, but passed as the first argument to functions and methods. Remove the context storage from the lease pool and pass it to the methods where it's actually needed.

See:

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

@twz123 twz123 added the chore label Jul 9, 2024
@twz123
Copy link
Member Author

twz123 commented Jul 10, 2024

This revealed and depends on #4744.

Copy link
Contributor

This pull request has merge conflicts that need to be resolved.

The context shouldn't be stored in structs, but passed as the first
argument to functions and methods. Remove the context storage from the
lease pool and pass it to the methods where it's actually needed.

Signed-off-by: Tom Wieczorek <twieczorek@mirantis.com>
@twz123 twz123 marked this pull request as ready for review August 21, 2024 11:58
@twz123 twz123 requested a review from a team as a code owner August 21, 2024 11:58
if err != nil {
return err
}
events, cancel, err := leasePool.Watch()

ctx, cancel := context.WithCancel(context.Background())
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't understand this change.
Why shouldn't the context.WithCancel be based on the one Startgets as an argument? If that context is Done I think this should be done too.

Copy link
Member Author

@twz123 twz123 Sep 4, 2024

Choose a reason for hiding this comment

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

This is one of the big issues that exists with the component model in k0s. See #4357 and its predecessor #1844.

So from my point of view, the context passed to Start should be used to cancel any async/blocking operations that are performed during startup. Any asynchronous operations that happen as a result of the component being started should be handled by Stop.

if err != nil {
return err
}
events, cancel, err := leasePool.Watch()
ctx, cancel := context.WithCancel(context.Background())
Copy link
Contributor

Choose a reason for hiding this comment

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

Same thing here.

@twz123 twz123 merged commit 0532ccb into k0sproject:main Sep 9, 2024
80 checks passed
@twz123 twz123 deleted the lease-pool-ctx branch September 9, 2024 18:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants