-import * as fs from 'fs'
-import { join } from 'path'
-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 { RunnerModel } from '@server/models/runner/runner'
+import { RunnerJobModel } from '@server/models/runner/runner-job'
+import { RunnerRegistrationTokenModel } from '@server/models/runner/runner-registration-token'
+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 { UserRegistrationModel } from '@server/models/user/user-registration'
+import { UserVideoHistoryModel } from '@server/models/user/user-video-history'
+import { VideoChannelSyncModel } from '@server/models/video/video-channel-sync'
+import { VideoJobInfoModel } from '@server/models/video/video-job-info'
+import { VideoLiveReplaySettingModel } from '@server/models/video/video-live-replay-setting'
+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 { isTestInstance } from '../helpers/core-utils'
-import {
- ApplicationModel,
- AuthorModel,
- JobModel,
- OAuthClientModel,
- OAuthTokenModel,
- PodModel,
- RequestModel,
- RequestToPodModel,
- RequestVideoEventModel,
- RequestVideoQaduModel,
- TagModel,
- UserModel,
- UserVideoRateModel,
- VideoAbuseModel,
- BlacklistedVideoModel,
- VideoTagModel,
- VideoModel
-} from '../models'
+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 = {}
-const database: {
- sequelize?: Sequelize.Sequelize,
- init?: (silent: any, callback: any) => void,
-
- Application?: ApplicationModel,
- Author?: AuthorModel,
- Job?: JobModel,
- OAuthClient?: OAuthClientModel,
- OAuthToken?: OAuthTokenModel,
- Pod?: PodModel,
- RequestToPod?: RequestToPodModel,
- RequestVideoEvent?: RequestVideoEventModel,
- RequestVideoQadu?: RequestVideoQaduModel,
- Request?: RequestModel,
- Tag?: TagModel,
- UserVideoRate?: UserVideoRateModel,
- User?: UserModel,
- VideoAbuse?: VideoAbuseModel,
- BlacklistedVideo?: BlacklistedVideoModel,
- VideoTag?: VideoTagModel,
- Video?: VideoModel
-} = {}
-
-const sequelize = new Sequelize(dbname, username, password, {
+if (CONFIG.DATABASE.SSL) {
+ dialectOptions = {
+ ssl: {
+ rejectUnauthorized: false
+ }
+ }
+}
+
+const sequelizeTypescript = new SequelizeTypescript({
+ database: dbname,
dialect: 'postgres',
- host: CONFIG.DATABASE.HOSTNAME,
- port: CONFIG.DATABASE.PORT,
- benchmark: isTestInstance(),
-
- logging: function (message: string, benchmark: number) {
- let newMessage = message
- if (benchmark !== undefined) {
- newMessage += ' | ' + benchmark + 'ms'
+ dialectOptions,
+ host,
+ port,
+ username,
+ password,
+ 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 = 'Executed SQL request'
+ if (isTestOrDevInstance() === true && benchmark !== undefined) {
+ newMessage += ' in ' + benchmark + 'ms'
}
- logger.debug(newMessage)
+ logger.debug(newMessage, { sql: message, tags: [ 'sql' ] })
}
})
-database.sequelize = sequelize
+function checkDatabaseConnectionOrDie () {
+ sequelizeTypescript.authenticate()
+ .then(() => logger.debug('Connection to PostgreSQL has been established successfully.'))
+ .catch(err => {
-database.init = function (silent: boolean, callback: (err: Error) => void) {
+ logger.error('Unable to connect to PostgreSQL database.', { err })
+ process.exit(-1)
+ })
+}
- const modelDirectory = join(__dirname, '..', 'models')
- fs.readdir(modelDirectory, function (err, files) {
- if (err) throw err
+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,
+ VideoSourceModel,
+ VideoCaptionModel,
+ VideoBlacklistModel,
+ VideoTagModel,
+ VideoCommentModel,
+ ScheduleVideoUpdateModel,
+ VideoImportModel,
+ VideoViewModel,
+ VideoRedundancyModel,
+ UserVideoHistoryModel,
+ VideoLiveModel,
+ VideoLiveSessionModel,
+ VideoLiveReplaySettingModel,
+ AccountBlocklistModel,
+ ServerBlocklistModel,
+ UserNotificationModel,
+ UserNotificationSettingModel,
+ VideoStreamingPlaylistModel,
+ VideoPlaylistModel,
+ VideoPlaylistElementModel,
+ LocalVideoViewerModel,
+ LocalVideoViewerWatchSectionModel,
+ ThumbnailModel,
+ TrackerModel,
+ VideoTrackerModel,
+ PluginModel,
+ ActorCustomPageModel,
+ VideoJobInfoModel,
+ VideoChannelSyncModel,
+ UserRegistrationModel,
+ RunnerRegistrationTokenModel,
+ RunnerModel,
+ RunnerJobModel
+ ])
+
+ // Check extensions exist in the database
+ await checkPostgresExtensions()
+
+ // Create custom PostgreSQL functions
+ await createFunctions()
+
+ if (!silent) logger.info('Database %s is ready.', dbname)
+}
- files.filter(function (file) {
- // For all models but not utils.js
- 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
- })
- .forEach(function (file) {
- const model = sequelize.import(join(modelDirectory, file))
+export {
+ initDatabaseModels,
+ checkDatabaseConnectionOrDie,
+ sequelizeTypescript
+}
- database[model['name']] = model
- })
+// ---------------------------------------------------------------------------
- Object.keys(database).forEach(function (modelName) {
- if ('associate' in database[modelName]) {
- database[modelName].associate(database)
- }
- })
+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 (!silent) logger.info('Database %s is ready.', dbname)
+ if (!res || res.length === 0) {
+ // Try to create the extension ourselves
+ try {
+ await sequelizeTypescript.query(`CREATE EXTENSION ${extension};`, { raw: true })
- return callback(null)
- })
+ } 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;`
-export {
- database
+ return sequelizeTypescript.query(query, { raw: true })
}