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

support/db: Remove ctx param from Begin/BeginTx/Rollback #3630

Merged
merged 9 commits into from
May 25, 2021

Conversation

bartekn
Copy link
Contributor

@bartekn bartekn commented May 25, 2021

PR Checklist

PR Structure

  • This PR has reasonably narrow scope (if not, break it down into smaller PRs).
  • This PR avoids mixing refactoring changes with feature changes (split into two PRs
    otherwise).
  • This PR's title starts with name of package that is most changed in the PR, ex.
    services/friendbot, or all or doc if the changes are broad or impact many
    packages.

Thoroughness

  • This PR adds tests for the most critical parts of the new functionality or fixes.
  • I've updated any docs (developer docs, .md
    files, etc... affected by this change). Take a look in the docs folder for a given service,
    like this one.

Release planning

  • I've updated the relevant CHANGELOG (here for Horizon) if
    needed with deprecations, added features, breaking changes, and DB schema changes.
  • I've decided if this PR requires a new major/minor version according to
    semver, or if it's mainly a patch change. The PR is targeted at the next
    release branch if it's not a patch change.

What

This commit removes ctx param from Begin, BeginTx and Rollback methods of support/db.Session. It also updates Horizon to use the new method params.

Why

As described in the standard database/sql.DB.BeginTxx(ctx context.Context, opts *sql.TxOptions) method:

The provided context is used until the transaction is committed or rolled back. If the context is canceled, the sql package will roll back the transaction.

This behaviour interferes with defered Rollback calls because in such situation ROLLBACK query is sent twice (in the internal database/sql goroutine started in BeginTxx and in support/db.Session.Rollback. This can break the DB connection and make the DB to close the connection. This can be unexpected when the app doesn't want idle DB connections to be closed.

Known limitations

Other apps using support/db need to update the code. I couldn't find any other usages than the Horizon.

@bartekn bartekn marked this pull request as ready for review May 25, 2021 15:34
@bartekn bartekn requested a review from a team May 25, 2021 15:34
@bartekn bartekn changed the base branch from master to release-horizon-v2.4.0 May 25, 2021 16:45
@paulbellamy paulbellamy force-pushed the release-horizon-v2.4.0 branch from faffa13 to 1783c70 Compare May 25, 2021 17:28
@bartekn bartekn merged commit ef4b281 into release-horizon-v2.4.0 May 25, 2021
@bartekn bartekn deleted the stream-handler-begin-no-context branch May 26, 2021 13:22
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