server/initializers/database.ts

   1 import { Sequelize as SequelizeTypescript } from 'sequelize-typescript'
   2 import { isTestInstance } from '../helpers/core-utils'
   3 import { logger } from '../helpers/logger'
   4
   5 import { AccountModel } from '../models/account/account'
   6 import { AccountVideoRateModel } from '../models/account/account-video-rate'
   7 import { UserModel } from '../models/account/user'
   8 import { ActorModel } from '../models/activitypub/actor'
   9 import { ActorFollowModel } from '../models/activitypub/actor-follow'
  10 import { ApplicationModel } from '../models/application/application'
  11 import { AvatarModel } from '../models/avatar/avatar'
  12 import { OAuthClientModel } from '../models/oauth/oauth-client'
  13 import { OAuthTokenModel } from '../models/oauth/oauth-token'
  14 import { ServerModel } from '../models/server/server'
  15 import { TagModel } from '../models/video/tag'
  16 import { VideoModel } from '../models/video/video'
  17 import { VideoAbuseModel } from '../models/video/video-abuse'
  18 import { VideoBlacklistModel } from '../models/video/video-blacklist'
  19 import { VideoChannelModel } from '../models/video/video-channel'
  20 import { VideoCommentModel } from '../models/video/video-comment'
  21 import { VideoFileModel } from '../models/video/video-file'
  22 import { VideoShareModel } from '../models/video/video-share'
  23 import { VideoTagModel } from '../models/video/video-tag'
  24 import { CONFIG } from './constants'
  25 import { ScheduleVideoUpdateModel } from '../models/video/schedule-video-update'
  26 import { VideoCaptionModel } from '../models/video/video-caption'
  27 import { VideoImportModel } from '../models/video/video-import'
  28 import { VideoViewModel } from '../models/video/video-views'
  29 import { VideoChangeOwnershipModel } from '../models/video/video-change-ownership'
  30 import { VideoRedundancyModel } from '../models/redundancy/video-redundancy'
  31 import { UserVideoHistoryModel } from '../models/account/user-video-history'
  32 import { AccountBlocklistModel } from '../models/account/account-blocklist'
  33 import { ServerBlocklistModel } from '../models/server/server-blocklist'
  34 import { UserNotificationModel } from '../models/account/user-notification'
  35 import { UserNotificationSettingModel } from '../models/account/user-notification-setting'
  36 import { VideoStreamingPlaylistModel } from '../models/video/video-streaming-playlist'
  37
  38 require('pg').defaults.parseInt8 = true // Avoid BIGINT to be converted to string
  39
  40 const dbname = CONFIG.DATABASE.DBNAME
  41 const username = CONFIG.DATABASE.USERNAME
  42 const password = CONFIG.DATABASE.PASSWORD
  43 const host = CONFIG.DATABASE.HOSTNAME
  44 const port = CONFIG.DATABASE.PORT
  45 const poolMax = CONFIG.DATABASE.POOL.MAX
  46
  47 const sequelizeTypescript = new SequelizeTypescript({
  48   database: dbname,
  49   dialect: 'postgres',
  50   host,
  51   port,
  52   username,
  53   password,
  54   pool: {
  55     max: poolMax
  56   },
  57   benchmark: isTestInstance(),
  58   isolationLevel: SequelizeTypescript.Transaction.ISOLATION_LEVELS.SERIALIZABLE,
  59   operatorsAliases: false,
  60   logging: (message: string, benchmark: number) => {
  61     if (process.env.NODE_DB_LOG === 'false') return
  62
  63     let newMessage = message
  64     if (isTestInstance() === true && benchmark !== undefined) {
  65       newMessage += ' | ' + benchmark + 'ms'
  66     }
  67
  68     logger.debug(newMessage)
  69   }
  70 })
  71
  72 async function initDatabaseModels (silent: boolean) {
  73   sequelizeTypescript.addModels([
  74     ApplicationModel,
  75     ActorModel,
  76     ActorFollowModel,
  77     AvatarModel,
  78     AccountModel,
  79     OAuthClientModel,
  80     OAuthTokenModel,
  81     ServerModel,
  82     TagModel,
  83     AccountVideoRateModel,
  84     UserModel,
  85     VideoAbuseModel,
  86     VideoChangeOwnershipModel,
  87     VideoChannelModel,
  88     VideoShareModel,
  89     VideoFileModel,
  90     VideoCaptionModel,
  91     VideoBlacklistModel,
  92     VideoTagModel,
  93     VideoModel,
  94     VideoCommentModel,
  95     ScheduleVideoUpdateModel,
  96     VideoImportModel,
  97     VideoViewModel,
  98     VideoRedundancyModel,
  99     UserVideoHistoryModel,
 100     AccountBlocklistModel,
 101     ServerBlocklistModel,
 102     UserNotificationModel,
 103     UserNotificationSettingModel,
 104     VideoStreamingPlaylistModel
 105   ])
 106
 107   // Check extensions exist in the database
 108   await checkPostgresExtensions()
 109
 110   // Create custom PostgreSQL functions
 111   await createFunctions()
 112
 113   if (!silent) logger.info('Database %s is ready.', dbname)
 114
 115   return
 116 }
 117
 118 // ---------------------------------------------------------------------------
 119
 120 export {
 121   initDatabaseModels,
 122   sequelizeTypescript
 123 }
 124
 125 // ---------------------------------------------------------------------------
 126
 127 async function checkPostgresExtensions () {
 128   const promises = [
 129     checkPostgresExtension('pg_trgm'),
 130     checkPostgresExtension('unaccent')
 131   ]
 132
 133   return Promise.all(promises)
 134 }
 135
 136 async function checkPostgresExtension (extension: string) {
 137   const query = `SELECT true AS enabled FROM pg_available_extensions WHERE name = '${extension}' AND installed_version IS NOT NULL;`
 138   const [ res ] = await sequelizeTypescript.query(query, { raw: true })
 139
 140   if (!res || res.length === 0 || res[ 0 ][ 'enabled' ] !== true) {
 141     // Try to create the extension ourself
 142     try {
 143       await sequelizeTypescript.query(`CREATE EXTENSION ${extension};`, { raw: true })
 144
 145     } catch {
 146       const errorMessage = `You need to enable ${extension} extension in PostgreSQL. ` +
 147         `You can do so by running 'CREATE EXTENSION ${extension};' as a PostgreSQL super user in ${CONFIG.DATABASE.DBNAME} database.`
 148       throw new Error(errorMessage)
 149     }
 150   }
 151 }
 152
 153 async function createFunctions () {
 154   const query = `CREATE OR REPLACE FUNCTION immutable_unaccent(text)
 155   RETURNS text AS
 156 $func$
 157 SELECT public.unaccent('public.unaccent', $1::text)
 158 $func$  LANGUAGE sql IMMUTABLE;`
 159
 160   return sequelizeTypescript.query(query, { raw: true })
 161 }