]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/initializers/database.ts
Merge branch 'release/4.2.0' into develop
[github/Chocobozzz/PeerTube.git] / server / initializers / database.ts
index 5c757694e8ff606787d88b7eb4f1a66abcde6135..3576f444cf761b5e20296a422ec8d11b302fa33b 100644 (file)
-import { join } from 'path'
-import { flattenDepth } from 'lodash'
-require('pg').defaults.parseInt8 = true // Avoid BIGINT to be converted to string
-import * as Sequelize from 'sequelize'
-
-import { CONFIG } from './constants'
-// Do not use barrel, we need to load database first
+import { QueryTypes, Transaction } from 'sequelize'
+import { Sequelize as SequelizeTypescript } from 'sequelize-typescript'
+import { ActorCustomPageModel } from '@server/models/account/actor-custom-page'
+import { TrackerModel } from '@server/models/server/tracker'
+import { VideoTrackerModel } from '@server/models/server/video-tracker'
+import { UserModel } from '@server/models/user/user'
+import { UserNotificationModel } from '@server/models/user/user-notification'
+import { UserVideoHistoryModel } from '@server/models/user/user-video-history'
+import { VideoJobInfoModel } from '@server/models/video/video-job-info'
+import { VideoLiveSessionModel } from '@server/models/video/video-live-session'
+import { LocalVideoViewerModel } from '@server/models/view/local-video-viewer'
+import { LocalVideoViewerWatchSectionModel } from '@server/models/view/local-video-viewer-watch-section'
+import { isTestInstance } from '../helpers/core-utils'
 import { logger } from '../helpers/logger'
-import { isTestInstance, readdirPromise } from '../helpers/core-utils'
-
-import { VideoModel } from './../models/video/video-interface'
-import { VideoTagModel } from './../models/video/video-tag-interface'
-import { BlacklistedVideoModel } from './../models/video/video-blacklist-interface'
-import { VideoFileModel } from './../models/video/video-file-interface'
-import { VideoAbuseModel } from './../models/video/video-abuse-interface'
-import { VideoChannelModel } from './../models/video/video-channel-interface'
-import { UserModel } from '../models/account/user-interface'
-import { AccountVideoRateModel } from '../models/account/account-video-rate-interface'
-import { AccountFollowModel } from '../models/account/account-follow-interface'
-import { TagModel } from './../models/video/tag-interface'
-import { ServerModel } from '../models/server/server-interface'
-import { OAuthTokenModel } from './../models/oauth/oauth-token-interface'
-import { OAuthClientModel } from './../models/oauth/oauth-client-interface'
-import { JobModel } from './../models/job/job-interface'
-import { AccountModel } from './../models/account/account-interface'
-import { ApplicationModel } from './../models/application/application-interface'
-import { VideoChannelShareModel } from '../models/video/video-channel-share-interface'
-import { VideoShareModel } from '../models/video/video-share-interface'
+import { AbuseModel } from '../models/abuse/abuse'
+import { AbuseMessageModel } from '../models/abuse/abuse-message'
+import { VideoAbuseModel } from '../models/abuse/video-abuse'
+import { VideoCommentAbuseModel } from '../models/abuse/video-comment-abuse'
+import { AccountModel } from '../models/account/account'
+import { AccountBlocklistModel } from '../models/account/account-blocklist'
+import { AccountVideoRateModel } from '../models/account/account-video-rate'
+import { ActorModel } from '../models/actor/actor'
+import { ActorFollowModel } from '../models/actor/actor-follow'
+import { ActorImageModel } from '../models/actor/actor-image'
+import { ApplicationModel } from '../models/application/application'
+import { OAuthClientModel } from '../models/oauth/oauth-client'
+import { OAuthTokenModel } from '../models/oauth/oauth-token'
+import { VideoRedundancyModel } from '../models/redundancy/video-redundancy'
+import { PluginModel } from '../models/server/plugin'
+import { ServerModel } from '../models/server/server'
+import { ServerBlocklistModel } from '../models/server/server-blocklist'
+import { UserNotificationSettingModel } from '../models/user/user-notification-setting'
+import { ScheduleVideoUpdateModel } from '../models/video/schedule-video-update'
+import { TagModel } from '../models/video/tag'
+import { ThumbnailModel } from '../models/video/thumbnail'
+import { VideoModel } from '../models/video/video'
+import { VideoBlacklistModel } from '../models/video/video-blacklist'
+import { VideoCaptionModel } from '../models/video/video-caption'
+import { VideoChangeOwnershipModel } from '../models/video/video-change-ownership'
+import { VideoChannelModel } from '../models/video/video-channel'
+import { VideoCommentModel } from '../models/video/video-comment'
+import { VideoFileModel } from '../models/video/video-file'
+import { VideoImportModel } from '../models/video/video-import'
+import { VideoLiveModel } from '../models/video/video-live'
+import { VideoPlaylistModel } from '../models/video/video-playlist'
+import { VideoPlaylistElementModel } from '../models/video/video-playlist-element'
+import { VideoShareModel } from '../models/video/video-share'
+import { VideoStreamingPlaylistModel } from '../models/video/video-streaming-playlist'
+import { VideoTagModel } from '../models/video/video-tag'
+import { VideoViewModel } from '../models/view/video-view'
+import { CONFIG } from './config'
+
+require('pg').defaults.parseInt8 = true // Avoid BIGINT to be converted to string
 
 const dbname = CONFIG.DATABASE.DBNAME
 const username = CONFIG.DATABASE.USERNAME
 const password = CONFIG.DATABASE.PASSWORD
+const host = CONFIG.DATABASE.HOSTNAME
+const port = CONFIG.DATABASE.PORT
+const poolMax = CONFIG.DATABASE.POOL.MAX
+
+let dialectOptions: any = {}
+
+if (CONFIG.DATABASE.SSL) {
+  dialectOptions = {
+    ssl: {
+      rejectUnauthorized: false
+    }
+  }
+}
 
-const database: {
-  sequelize?: Sequelize.Sequelize,
-  init?: (silent: boolean) => Promise<void>,
-
-  Application?: ApplicationModel,
-  Account?: AccountModel,
-  Job?: JobModel,
-  OAuthClient?: OAuthClientModel,
-  OAuthToken?: OAuthTokenModel,
-  Server?: ServerModel,
-  Tag?: TagModel,
-  AccountVideoRate?: AccountVideoRateModel,
-  AccountFollow?: AccountFollowModel,
-  User?: UserModel,
-  VideoAbuse?: VideoAbuseModel,
-  VideoChannel?: VideoChannelModel,
-  VideoChannelShare?: VideoChannelShareModel,
-  VideoShare?: VideoShareModel,
-  VideoFile?: VideoFileModel,
-  BlacklistedVideo?: BlacklistedVideoModel,
-  VideoTag?: VideoTagModel,
-  Video?: VideoModel
-} = {}
-
-const sequelize = new Sequelize(dbname, username, password, {
+const sequelizeTypescript = new SequelizeTypescript({
+  database: dbname,
   dialect: 'postgres',
-  host: CONFIG.DATABASE.HOSTNAME,
-  port: CONFIG.DATABASE.PORT,
+  dialectOptions,
+  host,
+  port,
+  username,
+  password,
+  pool: {
+    max: poolMax
+  },
   benchmark: isTestInstance(),
-  isolationLevel: Sequelize.Transaction.ISOLATION_LEVELS.SERIALIZABLE,
-  operatorsAliases: false,
-
+  isolationLevel: Transaction.ISOLATION_LEVELS.SERIALIZABLE,
   logging: (message: string, benchmark: number) => {
-    let newMessage = message
+    if (process.env.NODE_DB_LOG === 'false') return
+
+    let newMessage = 'Executed SQL request'
     if (isTestInstance() === true && benchmark !== undefined) {
-      newMessage += ' | ' + benchmark + 'ms'
+      newMessage += ' in ' + benchmark + 'ms'
     }
 
-    logger.debug(newMessage)
+    logger.debug(newMessage, { sql: message, tags: [ 'sql' ] })
   }
 })
 
-database.sequelize = sequelize
-
-database.init = async (silent: boolean) => {
-  const modelDirectory = join(__dirname, '..', 'models')
+function checkDatabaseConnectionOrDie () {
+  sequelizeTypescript.authenticate()
+    .then(() => logger.debug('Connection to PostgreSQL has been established successfully.'))
+    .catch(err => {
 
-  const filePaths = await getModelFiles(modelDirectory)
-
-  for (const filePath of filePaths) {
-    try {
-      const model = sequelize.import(filePath)
-
-      database[model['name']] = model
-    } catch (err) {
-      logger.error('Cannot import database model %s.', filePath, err)
-      process.exit(0)
-    }
-  }
+      logger.error('Unable to connect to PostgreSQL database.', { err })
+      process.exit(-1)
+    })
+}
 
-  for (const modelName of Object.keys(database)) {
-    if ('associate' in database[modelName]) {
-      try {
-        database[modelName].associate(database)
-      } catch (err) {
-        logger.error('Cannot associate model %s.', modelName, err)
-        process.exit(0)
-      }
-    }
-  }
+async function initDatabaseModels (silent: boolean) {
+  sequelizeTypescript.addModels([
+    ApplicationModel,
+    ActorModel,
+    ActorFollowModel,
+    ActorImageModel,
+    AccountModel,
+    OAuthClientModel,
+    OAuthTokenModel,
+    ServerModel,
+    TagModel,
+    AccountVideoRateModel,
+    UserModel,
+    AbuseMessageModel,
+    AbuseModel,
+    VideoCommentAbuseModel,
+    VideoAbuseModel,
+    VideoModel,
+    VideoChangeOwnershipModel,
+    VideoChannelModel,
+    VideoShareModel,
+    VideoFileModel,
+    VideoCaptionModel,
+    VideoBlacklistModel,
+    VideoTagModel,
+    VideoCommentModel,
+    ScheduleVideoUpdateModel,
+    VideoImportModel,
+    VideoViewModel,
+    VideoRedundancyModel,
+    UserVideoHistoryModel,
+    VideoLiveModel,
+    VideoLiveSessionModel,
+    AccountBlocklistModel,
+    ServerBlocklistModel,
+    UserNotificationModel,
+    UserNotificationSettingModel,
+    VideoStreamingPlaylistModel,
+    VideoPlaylistModel,
+    VideoPlaylistElementModel,
+    LocalVideoViewerModel,
+    LocalVideoViewerWatchSectionModel,
+    ThumbnailModel,
+    TrackerModel,
+    VideoTrackerModel,
+    PluginModel,
+    ActorCustomPageModel,
+    VideoJobInfoModel
+  ])
+
+  // Check extensions exist in the database
+  await checkPostgresExtensions()
+
+  // Create custom PostgreSQL functions
+  await createFunctions()
 
   if (!silent) logger.info('Database %s is ready.', dbname)
-
-  return
 }
 
 // ---------------------------------------------------------------------------
 
 export {
-  database
+  initDatabaseModels,
+  checkDatabaseConnectionOrDie,
+  sequelizeTypescript
 }
 
 // ---------------------------------------------------------------------------
 
-async function getModelFiles (modelDirectory: string) {
-  const files = await readdirPromise(modelDirectory)
-  const directories = files.filter(directory => {
-    // Find directories
-    if (
-      directory.endsWith('.js.map') ||
-      directory === 'index.js' || directory === 'index.ts' ||
-      directory === 'utils.js' || directory === 'utils.ts'
-    ) return false
-
-    return true
-  })
-
-  const tasks: Promise<any>[] = []
-
-  // For each directory we read it and append model in the modelFilePaths array
-  for (const directory of directories) {
-    const modelDirectoryPath = join(modelDirectory, directory)
-
-    const promise = readdirPromise(modelDirectoryPath)
-      .then(files => {
-        const filteredFiles = files
-          .filter(file => {
-            if (
-              file === 'index.js' || file === 'index.ts' ||
-              file === 'utils.js' || file === 'utils.ts' ||
-              file.endsWith('-interface.js') || file.endsWith('-interface.ts') ||
-              file.endsWith('.js.map')
-            ) return false
-
-            return true
-          })
-          .map(file => join(modelDirectoryPath, file))
-
-        return filteredFiles
-      })
-
-    tasks.push(promise)
+async function checkPostgresExtensions () {
+  const promises = [
+    checkPostgresExtension('pg_trgm'),
+    checkPostgresExtension('unaccent')
+  ]
+
+  return Promise.all(promises)
+}
+
+async function checkPostgresExtension (extension: string) {
+  const query = `SELECT 1 FROM pg_available_extensions WHERE name = '${extension}' AND installed_version IS NOT NULL;`
+  const options = {
+    type: QueryTypes.SELECT as QueryTypes.SELECT,
+    raw: true
   }
 
-  const filteredFilesArray: string[][] = await Promise.all(tasks)
-  return flattenDepth<string>(filteredFilesArray, 1)
+  const res = await sequelizeTypescript.query<object>(query, options)
+
+  if (!res || res.length === 0) {
+    // Try to create the extension ourselves
+    try {
+      await sequelizeTypescript.query(`CREATE EXTENSION ${extension};`, { raw: true })
+
+    } catch {
+      const errorMessage = `You need to enable ${extension} extension in PostgreSQL. ` +
+        `You can do so by running 'CREATE EXTENSION ${extension};' as a PostgreSQL super user in ${CONFIG.DATABASE.DBNAME} database.`
+      throw new Error(errorMessage)
+    }
+  }
+}
+
+function createFunctions () {
+  const query = `CREATE OR REPLACE FUNCTION immutable_unaccent(text)
+  RETURNS text AS
+$func$
+SELECT public.unaccent('public.unaccent', $1::text)
+$func$  LANGUAGE sql IMMUTABLE;`
+
+  return sequelizeTypescript.query(query, { raw: true })
 }