Fix retrying update on sql serialization conflict

[github/Chocobozzz/PeerTube.git] / server / helpers / database-utils.ts

diff --git a/server/helpers/database-utils.ts b/server/helpers/database-utils.ts
index b842ab9ece3d5eed0085cf2a426c67d7644c00ac..0e6b3550371e721624652166ea03d2435538b5c6 100644 (file)
--- a/server/helpers/database-utils.ts
+++ b/server/helpers/database-utils.ts
@@ -1,69 +1,121 @@
-// TODO: import from ES6 when retry typing file will include errorFilter function
-import retry = require('async/retry')
-
-const db = require('../initializers/database')
+import retry from 'async/retry'
+import Bluebird from 'bluebird'
+import { Transaction } from 'sequelize'
+import { Model } from 'sequelize-typescript'
+import { sequelizeTypescript } from '@server/initializers/database'
 import { logger } from './logger'
 
-function commitTransaction (t, callback) {
-  return t.commit().asCallback(callback)
+function retryTransactionWrapper <T, A, B, C, D> (
+  functionToRetry: (arg1: A, arg2: B, arg3: C, arg4: D) => Promise<T>,
+  arg1: A,
+  arg2: B,
+  arg3: C,
+  arg4: D,
+): Promise<T>
+
+function retryTransactionWrapper <T, A, B, C> (
+  functionToRetry: (arg1: A, arg2: B, arg3: C) => Promise<T>,
+  arg1: A,
+  arg2: B,
+  arg3: C
+): Promise<T>
+
+function retryTransactionWrapper <T, A, B> (
+  functionToRetry: (arg1: A, arg2: B) => Promise<T>,
+  arg1: A,
+  arg2: B
+): Promise<T>
+
+function retryTransactionWrapper <T, A> (
+  functionToRetry: (arg1: A) => Promise<T>,
+  arg1: A
+): Promise<T>
+
+function retryTransactionWrapper <T> (
+  functionToRetry: () => Promise<T> | Bluebird<T>
+): Promise<T>
+
+function retryTransactionWrapper <T> (
+  functionToRetry: (...args: any[]) => Promise<T>,
+  ...args: any[]
+): Promise<T> {
+  return transactionRetryer<T>(callback => {
+    functionToRetry.apply(null, args)
+        .then((result: T) => callback(null, result))
+        .catch(err => callback(err))
+  })
+  .catch(err => {
+    logger.warn(`Cannot execute ${functionToRetry.name} with many retries.`, { err })
+    throw err
+  })
+}
+
+function transactionRetryer <T> (func: (err: any, data: T) => any) {
+  return new Promise<T>((res, rej) => {
+    retry(
+      {
+        times: 5,
+
+        errorFilter: err => {
+          const willRetry = (err.name === 'SequelizeDatabaseError')
+          logger.debug('Maybe retrying the transaction function.', { willRetry, err, tags: [ 'sql', 'retry' ] })
+          return willRetry
+        }
+      },
+      func,
+      (err, data) => err ? rej(err) : res(data)
+    )
+  })
 }
 
-function rollbackTransaction (err, t, callback) {
-  // Try to rollback transaction
-  if (t) {
-    // Do not catch err, report the original one
-    t.rollback().asCallback(function () {
-      return callback(err)
-    })
-  } else {
-    return callback(err)
+// ---------------------------------------------------------------------------
+
+function updateInstanceWithAnother <M, T extends U, U extends Model<M>> (instanceToUpdate: T, baseInstance: U) {
+  const obj = baseInstance.toJSON()
+
+  for (const key of Object.keys(obj)) {
+    instanceToUpdate[key] = obj[key]
   }
 }
 
-// { arguments, errorMessage }
-function retryTransactionWrapper (functionToRetry, options, finalCallback) {
-  const args = options.arguments ? options.arguments : []
-
-  transactionRetryer(
-    function (callback) {
-      return functionToRetry.apply(this, args.concat([ callback ]))
-    },
-    function (err) {
-      if (err) {
-        logger.error(options.errorMessage, { error: err })
-      }
-
-      // Do not return the error, continue the process
-      return finalCallback(null)
-    }
-  )
+function resetSequelizeInstance <T> (instance: Model<T>) {
+  instance.set(instance.previous())
 }
 
-function transactionRetryer (func, callback) {
-  retry({
-    times: 5,
+function filterNonExistingModels <T extends { hasSameUniqueKeysThan (other: T): boolean }> (
+  fromDatabase: T[],
+  newModels: T[]
+) {
+  return fromDatabase.filter(f => !newModels.find(newModel => newModel.hasSameUniqueKeysThan(f)))
+}
 
-    errorFilter: function (err) {
-      const willRetry = (err.name === 'SequelizeDatabaseError')
-      logger.debug('Maybe retrying the transaction function.', { willRetry })
-      return willRetry
-    }
-  }, func, callback)
+function deleteAllModels <T extends Pick<Model, 'destroy'>> (models: T[], transaction: Transaction) {
+  return Promise.all(models.map(f => f.destroy({ transaction })))
 }
 
-function startSerializableTransaction (callback) {
-  db.sequelize.transaction({ isolationLevel: 'SERIALIZABLE' }).asCallback(function (err, t) {
-    // We force to return only two parameters
-    return callback(err, t)
-  })
+// ---------------------------------------------------------------------------
+
+function runInReadCommittedTransaction <T> (fn: (t: Transaction) => Promise<T>) {
+  const options = { isolationLevel: Transaction.ISOLATION_LEVELS.READ_COMMITTED }
+
+  return sequelizeTypescript.transaction(options, t => fn(t))
+}
+
+function afterCommitIfTransaction (t: Transaction, fn: Function) {
+  if (t) return t.afterCommit(() => fn())
+
+  return fn()
 }
 
 // ---------------------------------------------------------------------------
 
 export {
-  commitTransaction,
+  resetSequelizeInstance,
   retryTransactionWrapper,
-  rollbackTransaction,
-  startSerializableTransaction,
-  transactionRetryer
+  transactionRetryer,
+  updateInstanceWithAnother,
+  afterCommitIfTransaction,
+  filterNonExistingModels,
+  deleteAllModels,
+  runInReadCommittedTransaction
 }