feat(transactions): Add afterCommit hooks for transactions #9287

dylanlingelbach · 2018-04-10T18:41:41Z

Pull Request check-list

Please make sure to review and check all of these items:

Does npm run test or npm run test-DIALECT pass with this change (including linting)?
Does the description below contain a link to an existing issue (Closes #[issue]) or a description of the issue you are solving?
Have you added new tests to prevent regressions?
Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
Did you follow the commit message conventions explained in CONTRIBUTING.md?

Description of change

Add afterCommit hooks for transactions that allows deferring work to
after a transaction has been committed, regardless of if you have
access to the promise chain that created the transaction

Closes: #2805

dylanlingelbach · 2018-04-10T18:41:54Z

cc @gabegorelick

codecov · 2018-04-10T18:48:50Z

Codecov Report

Merging #9287 into master will increase coverage by <.01%.
The diff coverage is 100%.

sushantdhiman

Some changes, otherwise looks like a good addition

sushantdhiman · 2018-04-14T07:39:56Z

lib/transaction.js

@@ -22,6 +22,7 @@ class Transaction {
  constructor(sequelize, options) {
    this.sequelize = sequelize;
    this.savepoints = [];
+    this.afterCommitHooks = [];


_afterCommitHooks

sushantdhiman · 2018-04-14T07:40:16Z

lib/transaction.js

-      });
+      }).tap(
+        () => this.sequelize.Promise.each(
+          this.afterCommitHooks,


Use const Promise = require('./promise');

sushantdhiman · 2018-04-14T07:40:38Z

lib/transaction.js

+  * @name afterCommit
+  * @memberOf Sequelize.Transaction
+  */
+  afterCommit(fn) {


assert for fn being a function + test

sushantdhiman · 2018-04-14T07:41:28Z

test/integration/transaction.test.js

@@ -79,6 +79,32 @@ if (current.dialect.supports.transactions) {
        });
      });

+      it('supports running hooks when a transaction is commited', function() {
+        const self = this;


No self = this

sushantdhiman · 2018-04-14T07:43:28Z

test/integration/transaction.test.js

+      it('supports running hooks when a transaction is commited', function() {
+        const self = this;
+        const hook = sinon.spy();
+        let t;


let transaction;

sushantdhiman · 2018-04-14T07:43:42Z

test/integration/transaction.test.js

+        const self = this;
+        const hook = sinon.spy();
+        let t;
+        return expect(this.sequelize.transaction(transaction => {


Call this t

sushantdhiman · 2018-04-14T07:45:02Z

test/integration/transaction.test.js

+        return expect(this.sequelize.transaction(transaction => {
+          t = transaction;
+          transaction.afterCommit(hook);
+          return self.sequelize.query('SELECT 1+1', {transaction, raw: true});


No need to pass { raw: true }, its not required. Instead pass type: QueryType.SELECT

dylanlingelbach · 2018-04-16T22:04:52Z

@sushantdhiman thanks for the feedback! Just updated - let me know if you see anything else

dylanlingelbach · 2018-04-17T13:50:45Z

Actually just updated now - my push failed yesterday

sushantdhiman · 2018-04-17T14:07:43Z

Linting errors

/home/travis/build/sequelize/sequelize/lib/transaction.js
  200:23  error  Strings must use singlequote  quotes
/home/travis/build/sequelize/sequelize/test/integration/transaction.test.js
  274:39  error  Strings must use singlequote  quotes
  295:39  error  Strings must use singlequote  quotes
  316:39  error  Strings must use singlequote  quotes
✖ 4 problems (4 errors, 0 warnings)
  4 errors, 0 warnings potentially fixable with the `--fix` option.

sushantdhiman

LGTM, just remove self = this approach from extra tests you have added

sushantdhiman · 2018-04-18T04:56:40Z

test/integration/transaction.test.js

@@ -189,6 +215,107 @@ if (current.dialect.supports.transactions) {
      ).to.be.rejectedWith('Transaction cannot be committed because it has been finished with state: commit');
    });

+    it('should run hooks if a non-auto callback transaction is committed', function() {
+      const self = this;


This test is still using self, next one too

eseliger

other than the self in the tests, as mentioned by @sushantdhiman , looks good

mickhansen

Please add documentation covering the fact that you cannot modify the return value of a transaction inside afterCommit (most other hooks allow modification)

dylanlingelbach · 2018-04-18T18:06:15Z

@sushantdhiman fixed, sorry for missing that again

@mickhansen added

eseliger · 2018-04-18T18:15:26Z

There's still lint issues😕

Add `afterCommit` hooks for transactions that allows deferring work to after a transaction has been committed, regardless of if you have access to the promise chain that created the transaction Fixes: sequelize#2805

dylanlingelbach · 2018-04-18T18:51:03Z

@eseliger 🤦‍♂️ whoops. Fixed now

Arwid · 2018-04-26T18:43:34Z

+1

Strate · 2018-08-20T14:28:52Z

I think there is a bug in this feature: if transaction is a child (transaction.parent is set), then afterCommit hooks should not be invoked right after this transaction committed, because parent transaction is not committed yet, and is not guaranteed to be committed at all.

The easiest way to fix this is change the way how hooks are added:

afterCommit(fn) {
  if (this.parent) {
    this.parent.afterCommit(fn)
  } else {
    this._afterCommitHooks.push(fn);
  }
}

jedwards1211 · 2018-09-05T18:51:36Z

could you guys port this back to v4? Pretty please? I am basically going to have to monkeypatch support for it into my codebase...

esalter · 2018-12-12T18:37:30Z

Seconded for asking for a backport to v4, if possible. It would be very much appreciated!

jedwards1211 · 2018-12-12T20:14:22Z

@esalter I just made a PR to backport, hopefully they will merge and release it!

sushantdhiman reviewed Apr 14, 2018

View reviewed changes

dylanlingelbach force-pushed the feat/transaction-commit-hooks branch from 7b43f41 to e6bdc82 Compare April 17, 2018 13:50

dylanlingelbach force-pushed the feat/transaction-commit-hooks branch from e6bdc82 to 8f6aa84 Compare April 17, 2018 14:09

sushantdhiman reviewed Apr 18, 2018

View reviewed changes

sushantdhiman requested a review from a team April 18, 2018 04:59

eseliger approved these changes Apr 18, 2018

View reviewed changes

mickhansen reviewed Apr 18, 2018

View reviewed changes

dylanlingelbach force-pushed the feat/transaction-commit-hooks branch from 8f6aa84 to 7de7551 Compare April 18, 2018 18:05

feat(transactions): Add afterCommit hooks for transactions

ca3025a

Add `afterCommit` hooks for transactions that allows deferring work to after a transaction has been committed, regardless of if you have access to the promise chain that created the transaction Fixes: sequelize#2805

dylanlingelbach force-pushed the feat/transaction-commit-hooks branch from 7de7551 to ca3025a Compare April 18, 2018 18:44

eseliger requested a review from mickhansen April 18, 2018 22:01

eseliger added the pr:final review label Apr 18, 2018

sushantdhiman approved these changes Apr 19, 2018

View reviewed changes

sushantdhiman merged commit f92a7e7 into sequelize:master Apr 29, 2018

jedwards1211 mentioned this pull request Dec 12, 2018

feat(Transaction): port afterCommit hooks from v5 back to v4 #10260

Merged

5 tasks

feat(transactions): Add afterCommit hooks for transactions #9287

feat(transactions): Add afterCommit hooks for transactions #9287

dylanlingelbach commented Apr 10, 2018

dylanlingelbach commented Apr 10, 2018

codecov bot commented Apr 10, 2018 •

edited

sushantdhiman left a comment

sushantdhiman Apr 14, 2018

sushantdhiman Apr 14, 2018

sushantdhiman Apr 14, 2018 •

edited

sushantdhiman Apr 14, 2018

sushantdhiman Apr 14, 2018

sushantdhiman Apr 14, 2018

sushantdhiman Apr 14, 2018

dylanlingelbach commented Apr 16, 2018

dylanlingelbach commented Apr 17, 2018

sushantdhiman commented Apr 17, 2018

sushantdhiman left a comment

sushantdhiman Apr 18, 2018

eseliger left a comment

mickhansen left a comment •

edited

dylanlingelbach commented Apr 18, 2018

eseliger commented Apr 18, 2018

dylanlingelbach commented Apr 18, 2018

Arwid commented Apr 26, 2018

Strate commented Aug 20, 2018 •

edited

jedwards1211 commented Sep 5, 2018 •

edited

esalter commented Dec 12, 2018

jedwards1211 commented Dec 12, 2018

feat(transactions): Add afterCommit hooks for transactions #9287

feat(transactions): Add afterCommit hooks for transactions #9287

Conversation

dylanlingelbach commented Apr 10, 2018

Pull Request check-list

Description of change

dylanlingelbach commented Apr 10, 2018

codecov bot commented Apr 10, 2018 • edited

Codecov Report

sushantdhiman left a comment

Choose a reason for hiding this comment

sushantdhiman Apr 14, 2018

Choose a reason for hiding this comment

sushantdhiman Apr 14, 2018

Choose a reason for hiding this comment

sushantdhiman Apr 14, 2018 • edited

Choose a reason for hiding this comment

sushantdhiman Apr 14, 2018

Choose a reason for hiding this comment

sushantdhiman Apr 14, 2018

Choose a reason for hiding this comment

sushantdhiman Apr 14, 2018

Choose a reason for hiding this comment

sushantdhiman Apr 14, 2018

Choose a reason for hiding this comment

dylanlingelbach commented Apr 16, 2018

dylanlingelbach commented Apr 17, 2018

sushantdhiman commented Apr 17, 2018

sushantdhiman left a comment

Choose a reason for hiding this comment

sushantdhiman Apr 18, 2018

Choose a reason for hiding this comment

eseliger left a comment

Choose a reason for hiding this comment

mickhansen left a comment • edited

Choose a reason for hiding this comment

dylanlingelbach commented Apr 18, 2018

eseliger commented Apr 18, 2018

dylanlingelbach commented Apr 18, 2018

Arwid commented Apr 26, 2018

Strate commented Aug 20, 2018 • edited

jedwards1211 commented Sep 5, 2018 • edited

esalter commented Dec 12, 2018

jedwards1211 commented Dec 12, 2018

codecov bot commented Apr 10, 2018 •

edited

sushantdhiman Apr 14, 2018 •

edited

mickhansen left a comment •

edited

Strate commented Aug 20, 2018 •

edited

jedwards1211 commented Sep 5, 2018 •

edited