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 txContext auto-cancellation of context #4012

Merged
merged 2 commits into from
May 20, 2024
Merged

fix txContext auto-cancellation of context #4012

merged 2 commits into from
May 20, 2024

Conversation

wdbaruni
Copy link
Member

Currently we auto cancel the context when the transaction is committed, which means any operation using that context can fail if it depends on the context's done state. This is causing flakiness in TestBeginMultipleTransactions_Sequential test in windows as the second transaction is created from the previous context, which will also be cancelled and rolled-back when the first one is committed and then cancelled.

This PR fixes the issue by no longer cancelling the context of tx commit or rollback

Copy link
Contributor

coderabbitai bot commented May 20, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@wdbaruni wdbaruni self-assigned this May 20, 2024
@wdbaruni wdbaruni requested a review from frrist May 20, 2024 15:57
Copy link
Member

@frrist frrist left a comment

Choose a reason for hiding this comment

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

Can you provide a link to the CI failure that motivates this change?

Comment on lines +48 to 57
defer func() {
// Attempt to rollback the transaction, which is a no-op if already committed or rolled back.
if err := txCtx.doRollback(); err != nil {
log.Ctx(txCtx).Error().Err(err).Msg("failed to rollback transaction on tx cleanup")
}
}()
select {
case <-innerCtx.Done():
case <-txCtx.closeCh:
}
Copy link
Member

Choose a reason for hiding this comment

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

We can simplify this by extracting the logic of this deferred function to below the select statement and removing the defer statement.

pkg/jobstore/boltdb/context.go Outdated Show resolved Hide resolved
Comment on lines +95 to +103
// close closes the transactional context.
// already called with the mutex held.
func (b *txContext) close() {
if !b.closed {
close(b.closeCh)
b.closed = true
}
}

Copy link
Member

Choose a reason for hiding this comment

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

since this logic should not be called without locking my preference would be to inline the logic of this function into the various places it's used and drop the function.

pkg/jobstore/boltdb/context.go Show resolved Hide resolved
Copy link
Member

@frrist frrist left a comment

Choose a reason for hiding this comment

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

please consider addressing remaining comments. then lgtm

@wdbaruni wdbaruni merged commit 41170d3 into main May 20, 2024
12 checks passed
@wdbaruni wdbaruni deleted the queue-tx-fix branch May 20, 2024 17:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants