]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/helpers/database-utils.ts
Try to speed up AP update transaction
[github/Chocobozzz/PeerTube.git] / server / helpers / database-utils.ts
index 987e42eb074a0441fab5f2c43aa6d646ea0054c6..240b18033717f7faa44eed36466d499cf5f0c290 100644 (file)
-// TODO: import from ES6 when retry typing file will include errorFilter function
 import * as retry from 'async/retry'
-import * as Promise from 'bluebird'
-
+import * as Bluebird from 'bluebird'
+import { QueryTypes, Transaction } from 'sequelize'
+import { Model } from 'sequelize-typescript'
+import { sequelizeTypescript } from '@server/initializers/database'
 import { logger } from './logger'
 
-type RetryTransactionWrapperOptions = { errorMessage: string, arguments?: any[] }
-function retryTransactionWrapper (functionToRetry: (... args) => Promise<any>, options: RetryTransactionWrapperOptions) {
-  const args = options.arguments ? options.arguments : []
+function retryTransactionWrapper <T, A, B, C, D> (
+  functionToRetry: (arg1: A, arg2: B, arg3: C, arg4: D) => Promise<T> | Bluebird<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> | Bluebird<T>,
+  arg1: A,
+  arg2: B,
+  arg3: C
+): Promise<T>
+
+function retryTransactionWrapper <T, A, B> (
+  functionToRetry: (arg1: A, arg2: B) => Promise<T> | Bluebird<T>,
+  arg1: A,
+  arg2: B
+): Promise<T>
 
-  return transactionRetryer(callback => {
-    functionToRetry.apply(this, args)
-        .then(result => callback(null, result))
+function retryTransactionWrapper <T, A> (
+  functionToRetry: (arg1: A) => Promise<T> | Bluebird<T>,
+  arg1: A
+): Promise<T>
+
+function retryTransactionWrapper <T> (
+  functionToRetry: () => Promise<T> | Bluebird<T>
+): Promise<T>
+
+function retryTransactionWrapper <T> (
+  functionToRetry: (...args: any[]) => Promise<T> | Bluebird<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 => {
-    // Do not throw the error, continue the process
-    logger.error(options.errorMessage, err)
+    logger.error(`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 transactionRetryer (func: Function) {
-  return new Promise((res, rej) => {
-    retry({
-      times: 5,
+// ---------------------------------------------------------------------------
+
+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]
+  }
+}
 
-      errorFilter: err => {
-        const willRetry = (err.name === 'SequelizeDatabaseError')
-        logger.debug('Maybe retrying the transaction function.', { willRetry })
-        return willRetry
-      }
-    }, func, err => err ? rej(err) : res())
+function resetSequelizeInstance (instance: Model<any>, savedFields: object) {
+  Object.keys(savedFields).forEach(key => {
+    instance[key] = savedFields[key]
   })
 }
 
+function deleteNonExistingModels <T extends { hasSameUniqueKeysThan (other: T): boolean } & Pick<Model, 'destroy'>> (
+  fromDatabase: T[],
+  newModels: T[],
+  t: Transaction
+) {
+  return fromDatabase.filter(f => !newModels.find(newModel => newModel.hasSameUniqueKeysThan(f)))
+              .map(f => f.destroy({ transaction: t }))
+}
+
+// Sequelize always skip the update if we only update updatedAt field
+function setAsUpdated (table: string, id: number, transaction?: Transaction) {
+  return sequelizeTypescript.query(
+    `UPDATE "${table}" SET "updatedAt" = :updatedAt WHERE id = :id`,
+    {
+      replacements: { table, id, updatedAt: new Date() },
+      type: QueryTypes.UPDATE,
+      transaction
+    }
+  )
+}
+
+// ---------------------------------------------------------------------------
+
+function runInReadCommittedTransaction <T> (fn: (t: Transaction) => Promise<T>) {
+  return sequelizeTypescript.transaction(t => fn(t))
+}
+
+function afterCommitIfTransaction (t: Transaction, fn: Function) {
+  if (t) return t.afterCommit(() => fn())
+
+  return fn()
+}
+
 // ---------------------------------------------------------------------------
 
 export {
+  resetSequelizeInstance,
   retryTransactionWrapper,
-  transactionRetryer
+  transactionRetryer,
+  updateInstanceWithAnother,
+  afterCommitIfTransaction,
+  deleteNonExistingModels,
+  setAsUpdated,
+  runInReadCommittedTransaction
 }