]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/initializers/database.ts
Add ability for client to create server logs
[github/Chocobozzz/PeerTube.git] / server / initializers / database.ts
index 85d205cdcc071561ff8b38976812396e690f1244..91286241bd475ff3603ed59f4f54798708e61eaa 100644 (file)
@@ -1,27 +1,55 @@
+import { QueryTypes, Transaction } from 'sequelize'
 import { Sequelize as SequelizeTypescript } from 'sequelize-typescript'
-import { isTestInstance } from '../helpers/core-utils'
+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 { VideoSourceModel } from '@server/models/video/video-source'
+import { LocalVideoViewerModel } from '@server/models/view/local-video-viewer'
+import { LocalVideoViewerWatchSectionModel } from '@server/models/view/local-video-viewer-watch-section'
+import { isTestOrDevInstance } from '../helpers/core-utils'
 import { logger } from '../helpers/logger'
-
+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 { AccountFollowModel } from '../models/account/account-follow'
+import { AccountBlocklistModel } from '../models/account/account-blocklist'
 import { AccountVideoRateModel } from '../models/account/account-video-rate'
-import { UserModel } from '../models/account/user'
+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 { AvatarModel } from '../models/avatar/avatar'
-import { JobModel } from '../models/job/job'
 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 { VideoAbuseModel } from '../models/video/video-abuse'
 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 { VideoChannelShareModel } from '../models/video/video-channel-share'
+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 { CONFIG } from './constants'
+import { VideoViewModel } from '../models/view/video-view'
+import { CONFIG } from './config'
 
 require('pg').defaults.parseInt8 = true // Avoid BIGINT to be converted to string
 
@@ -30,60 +58,160 @@ 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 sequelizeTypescript = new SequelizeTypescript({
   database: dbname,
   dialect: 'postgres',
+  dialectOptions,
   host,
   port,
   username,
   password,
-  benchmark: isTestInstance(),
-  isolationLevel: SequelizeTypescript.Transaction.ISOLATION_LEVELS.SERIALIZABLE,
-  operatorsAliases: false,
+  pool: {
+    max: poolMax
+  },
+  benchmark: isTestOrDevInstance(),
+  isolationLevel: Transaction.ISOLATION_LEVELS.SERIALIZABLE,
   logging: (message: string, benchmark: number) => {
     if (process.env.NODE_DB_LOG === 'false') return
 
-    let newMessage = message
-    if (isTestInstance() === true && benchmark !== undefined) {
-      newMessage += ' | ' + benchmark + 'ms'
+    let newMessage = 'Executed SQL request'
+    if (isTestOrDevInstance() === true && benchmark !== undefined) {
+      newMessage += ' in ' + benchmark + 'ms'
     }
 
-    logger.debug(newMessage)
+    logger.debug(newMessage, { sql: message, tags: [ 'sql' ] })
   }
 })
 
+function checkDatabaseConnectionOrDie () {
+  sequelizeTypescript.authenticate()
+    .then(() => logger.debug('Connection to PostgreSQL has been established successfully.'))
+    .catch(err => {
+
+      logger.error('Unable to connect to PostgreSQL database.', { err })
+      process.exit(-1)
+    })
+}
+
 async function initDatabaseModels (silent: boolean) {
   sequelizeTypescript.addModels([
     ApplicationModel,
-    AvatarModel,
+    ActorModel,
+    ActorFollowModel,
+    ActorImageModel,
     AccountModel,
-    JobModel,
     OAuthClientModel,
     OAuthTokenModel,
     ServerModel,
     TagModel,
     AccountVideoRateModel,
-    AccountFollowModel,
     UserModel,
+    AbuseMessageModel,
+    AbuseModel,
+    VideoCommentAbuseModel,
     VideoAbuseModel,
+    VideoModel,
+    VideoChangeOwnershipModel,
     VideoChannelModel,
-    VideoChannelShareModel,
     VideoShareModel,
     VideoFileModel,
+    VideoSourceModel,
+    VideoCaptionModel,
     VideoBlacklistModel,
     VideoTagModel,
-    VideoModel
+    VideoCommentModel,
+    ScheduleVideoUpdateModel,
+    VideoImportModel,
+    VideoViewModel,
+    VideoRedundancyModel,
+    UserVideoHistoryModel,
+    VideoLiveModel,
+    VideoLiveSessionModel,
+    AccountBlocklistModel,
+    ServerBlocklistModel,
+    UserNotificationModel,
+    UserNotificationSettingModel,
+    VideoStreamingPlaylistModel,
+    VideoPlaylistModel,
+    VideoPlaylistElementModel,
+    LocalVideoViewerModel,
+    LocalVideoViewerWatchSectionModel,
+    ThumbnailModel,
+    TrackerModel,
+    VideoTrackerModel,
+    PluginModel,
+    ActorCustomPageModel,
+    VideoJobInfoModel
   ])
 
-  if (!silent) logger.info('Database %s is ready.', dbname)
+  // Check extensions exist in the database
+  await checkPostgresExtensions()
+
+  // Create custom PostgreSQL functions
+  await createFunctions()
 
-  return
+  if (!silent) logger.info('Database %s is ready.', dbname)
 }
 
 // ---------------------------------------------------------------------------
 
 export {
   initDatabaseModels,
+  checkDatabaseConnectionOrDie,
   sequelizeTypescript
 }
+
+// ---------------------------------------------------------------------------
+
+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 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 })
+}