server/helpers/database-utils.ts

   1 import * as Sequelize from 'sequelize'
   2 // TODO: import from ES6 when retry typing file will include errorFilter function
   3 import * as retry from 'async/retry'
   4
   5 import { database as db } from '../initializers/database'
   6 import { logger } from './logger'
   7
   8 function commitTransaction (t: Sequelize.Transaction, callback: (err: Error) => void) {
   9   return t.commit().asCallback(callback)
  10 }
  11
  12 function rollbackTransaction (err: Error, t: Sequelize.Transaction, callback: (err: Error) => void) {
  13   // Try to rollback transaction
  14   if (t) {
  15     // Do not catch err, report the original one
  16     t.rollback().asCallback(function () {
  17       return callback(err)
  18     })
  19   } else {
  20     return callback(err)
  21   }
  22 }
  23
  24 type RetryTransactionWrapperOptions = { errorMessage: string, arguments?: any[] }
  25 function retryTransactionWrapper (functionToRetry: Function, options: RetryTransactionWrapperOptions, finalCallback: Function) {
  26   const args = options.arguments ? options.arguments : []
  27
  28   transactionRetryer(
  29     function (callback) {
  30       return functionToRetry.apply(this, args.concat([ callback ]))
  31     },
  32     function (err) {
  33       if (err) {
  34         logger.error(options.errorMessage, { error: err })
  35       }
  36
  37       // Do not return the error, continue the process
  38       return finalCallback(null)
  39     }
  40   )
  41 }
  42
  43 function transactionRetryer (func: Function, callback: (err: Error) => void) {
  44   retry({
  45     times: 5,
  46
  47     errorFilter: function (err) {
  48       const willRetry = (err.name === 'SequelizeDatabaseError')
  49       logger.debug('Maybe retrying the transaction function.', { willRetry })
  50       return willRetry
  51     }
  52   }, func, callback)
  53 }
  54
  55 function startSerializableTransaction (callback: (err: Error, t: Sequelize.Transaction) => void) {
  56   db.sequelize.transaction(/* { isolationLevel: 'SERIALIZABLE' } */).asCallback(function (err, t) {
  57     // We force to return only two parameters
  58     return callback(err, t)
  59   })
  60 }
  61
  62 // ---------------------------------------------------------------------------
  63
  64 export {
  65   commitTransaction,
  66   retryTransactionWrapper,
  67   rollbackTransaction,
  68   startSerializableTransaction,
  69   transactionRetryer
  70 }