Add ability to schedule video publication

7 files changed, 97 insertions, 26 deletions

diff --git a/server/initializers/constants.ts b/server/initializers/constants.ts
index 164378505..53902071c 100644
--- a/server/initializers/constants.ts
+++ b/server/initializers/constants.ts
@@ -8,8 +8,6 @@ import { VideoPrivacy } from '../../shared/models/videos'
 import { buildPath, isTestInstance, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
 import { invert } from 'lodash'
-import { RemoveOldJobsScheduler } from '../lib/schedulers/remove-old-jobs-scheduler'
-import { UpdateVideosScheduler } from '../lib/schedulers/update-videos-scheduler'
 
 // Use a variable to reload the configuration if we need
 let config: IConfig = require('config')
@@ -98,8 +96,8 @@ const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
 // 1 hour
 let SCHEDULER_INTERVALS_MS = {
   badActorFollow: 60000 * 60, // 1 hour
-  removeOldJobs: 60000 * 60, // 1 jour
-  updateVideos: 60000 * 1, // 1 minute
+  removeOldJobs: 60000 * 60, // 1 hour
+  updateVideos: 60000 // 1 minute
 }
 
 // ---------------------------------------------------------------------------
diff --git a/server/lib/schedulers/update-videos-scheduler.ts b/server/lib/schedulers/update-videos-scheduler.ts
index d123c3ceb..a964648fd 100644
--- a/server/lib/schedulers/update-videos-scheduler.ts
+++ b/server/lib/schedulers/update-videos-scheduler.ts
@@ -33,7 +33,9 @@ export class UpdateVideosScheduler extends AbstractScheduler {
     }
   }
 
-  private updateVideos () {
+  private async updateVideos () {
+    if (!await ScheduleVideoUpdateModel.areVideosToUpdate()) return undefined
+
     return sequelizeTypescript.transaction(async t => {
       const schedules = await ScheduleVideoUpdateModel.listVideosToUpdate(t)
 
diff --git a/server/middlewares/validators/videos.ts b/server/middlewares/validators/videos.ts
index 9fe5a253b..da17b4a68 100644
--- a/server/middlewares/validators/videos.ts
+++ b/server/middlewares/validators/videos.ts
@@ -223,7 +223,7 @@ const videosUpdateValidator = [
 
     if (video.privacy !== VideoPrivacy.PRIVATE && req.body.privacy === VideoPrivacy.PRIVATE) {
       return res.status(409)
-        .json({ error: 'Cannot set "private" a video that was not private anymore.' })
+        .json({ error: 'Cannot set "private" a video that was not private.' })
         .end()
     }
 
diff --git a/server/models/video/schedule-video-update.ts b/server/models/video/schedule-video-update.ts
index d4e37beb5..3cf5f6c99 100644
--- a/server/models/video/schedule-video-update.ts
+++ b/server/models/video/schedule-video-update.ts
@@ -25,7 +25,7 @@ export class ScheduleVideoUpdateModel extends Model<ScheduleVideoUpdateModel> {
   @AllowNull(true)
   @Default(null)
   @Column
-  privacy: VideoPrivacy
+  privacy: VideoPrivacy.PUBLIC | VideoPrivacy.UNLISTED
 
   @CreatedAt
   createdAt: Date
@@ -45,6 +45,21 @@ export class ScheduleVideoUpdateModel extends Model<ScheduleVideoUpdateModel> {
   })
   Video: VideoModel
 
+  static areVideosToUpdate () {
+    const query = {
+      logging: false,
+      attributes: [ 'id' ],
+      where: {
+        updateAt: {
+          [Sequelize.Op.lte]: new Date()
+        }
+      }
+    }
+
+    return ScheduleVideoUpdateModel.findOne(query)
+      .then(res => !!res)
+  }
+
   static listVideosToUpdate (t: Transaction) {
     const query = {
       where: {
@@ -68,4 +83,10 @@ export class ScheduleVideoUpdateModel extends Model<ScheduleVideoUpdateModel> {
     return ScheduleVideoUpdateModel.findAll(query)
   }
 
+  toFormattedJSON () {
+    return {
+      updateAt: this.updateAt,
+      privacy: this.privacy || undefined
+    }
+  }
 }
diff --git a/server/models/video/video.ts b/server/models/video/video.ts
index 440f4d171..0041e4d38 100644
--- a/server/models/video/video.ts
+++ b/server/models/video/video.ts
@@ -97,7 +97,8 @@ export enum ScopeNames {
   AVAILABLE_FOR_LIST = 'AVAILABLE_FOR_LIST',
   WITH_ACCOUNT_DETAILS = 'WITH_ACCOUNT_DETAILS',
   WITH_TAGS = 'WITH_TAGS',
-  WITH_FILES = 'WITH_FILES'
+  WITH_FILES = 'WITH_FILES',
+  WITH_SCHEDULED_UPDATE = 'WITH_SCHEDULED_UPDATE'
 }
 
 @Scopes({
@@ -286,6 +287,14 @@ export enum ScopeNames {
         required: true
       }
     ]
+  },
+  [ScopeNames.WITH_SCHEDULED_UPDATE]: {
+    include: [
+      {
+        model: () => ScheduleVideoUpdateModel.unscoped(),
+        required: false
+      }
+    ]
   }
 })
 @Table({
@@ -843,7 +852,7 @@ export class VideoModel extends Model<VideoModel> {
     }
 
     return VideoModel
-      .scope([ ScopeNames.WITH_TAGS, ScopeNames.WITH_FILES, ScopeNames.WITH_ACCOUNT_DETAILS ])
+      .scope([ ScopeNames.WITH_TAGS, ScopeNames.WITH_FILES, ScopeNames.WITH_ACCOUNT_DETAILS, ScopeNames.WITH_SCHEDULED_UPDATE ])
       .findById(id, options)
   }
 
@@ -869,7 +878,7 @@ export class VideoModel extends Model<VideoModel> {
     }
 
     return VideoModel
-      .scope([ ScopeNames.WITH_TAGS, ScopeNames.WITH_FILES, ScopeNames.WITH_ACCOUNT_DETAILS ])
+      .scope([ ScopeNames.WITH_TAGS, ScopeNames.WITH_FILES, ScopeNames.WITH_ACCOUNT_DETAILS, ScopeNames.WITH_SCHEDULED_UPDATE ])
       .findOne(options)
   }
 
@@ -1022,9 +1031,9 @@ export class VideoModel extends Model<VideoModel> {
 
   toFormattedJSON (options?: {
     additionalAttributes: {
-      state: boolean,
-      waitTranscoding: boolean,
-      scheduledUpdate: boolean
+      state?: boolean,
+      waitTranscoding?: boolean,
+      scheduledUpdate?: boolean
     }
   }): Video {
     const formattedAccount = this.VideoChannel.Account.toFormattedJSON()
@@ -1084,18 +1093,18 @@ export class VideoModel extends Model<VideoModel> {
     }
 
     if (options) {
-      if (options.additionalAttributes.state) {
+      if (options.additionalAttributes.state === true) {
         videoObject.state = {
           id: this.state,
           label: VideoModel.getStateLabel(this.state)
         }
       }
 
-      if (options.additionalAttributes.waitTranscoding) {
+      if (options.additionalAttributes.waitTranscoding === true) {
         videoObject.waitTranscoding = this.waitTranscoding
       }
 
-      if (options.additionalAttributes.scheduledUpdate && this.ScheduleVideoUpdate) {
+      if (options.additionalAttributes.scheduledUpdate === true && this.ScheduleVideoUpdate) {
         videoObject.scheduledUpdate = {
           updateAt: this.ScheduleVideoUpdate.updateAt,
           privacy: this.ScheduleVideoUpdate.privacy || undefined
@@ -1107,7 +1116,11 @@ export class VideoModel extends Model<VideoModel> {
   }
 
   toFormattedDetailsJSON (): VideoDetails {
-    const formattedJson = this.toFormattedJSON()
+    const formattedJson = this.toFormattedJSON({
+      additionalAttributes: {
+        scheduledUpdate: true
+      }
+    })
 
     const detailsJson = {
       support: this.support,
diff --git a/server/tests/api/check-params/videos.ts b/server/tests/api/check-params/videos.ts
index 04bed3b44..abbea6ba3 100644
--- a/server/tests/api/check-params/videos.ts
+++ b/server/tests/api/check-params/videos.ts
@@ -291,6 +291,23 @@ describe('Test videos API validator', function () {
       await makeUploadRequest({ url: server.url, path: path + '/upload', token: server.accessToken, fields, attaches })
     })
 
+    it('Should fail with a bad schedule update (miss updateAt)', async function () {
+      const fields = immutableAssign(baseCorrectParams, { 'scheduleUpdate[privacy]': VideoPrivacy.PUBLIC })
+      const attaches = baseCorrectAttaches
+
+      await makeUploadRequest({ url: server.url, path: path + '/upload', token: server.accessToken, fields, attaches })
+    })
+
+    it('Should fail with a bad schedule update (wrong updateAt)', async function () {
+      const fields = immutableAssign(baseCorrectParams, {
+        'scheduleUpdate[privacy]': VideoPrivacy.PUBLIC,
+        'scheduleUpdate[updateAt]': 'toto'
+      })
+      const attaches = baseCorrectAttaches
+
+      await makeUploadRequest({ url: server.url, path: path + '/upload', token: server.accessToken, fields, attaches })
+    })
+
     it('Should fail without an input file', async function () {
       const fields = baseCorrectParams
       const attaches = {}
@@ -494,6 +511,18 @@ describe('Test videos API validator', function () {
       await makePutBodyRequest({ url: server.url, path: path + videoId, token: server.accessToken, fields })
     })
 
+    it('Should fail with a bad schedule update (miss updateAt)', async function () {
+      const fields = immutableAssign(baseCorrectParams, { scheduleUpdate: { privacy: VideoPrivacy.PUBLIC } })
+
+      await makePutBodyRequest({ url: server.url, path: path + videoId, token: server.accessToken, fields })
+    })
+
+    it('Should fail with a bad schedule update (wrong updateAt)', async function () {
+      const fields = immutableAssign(baseCorrectParams, { scheduleUpdate: { updateAt: 'toto', privacy: VideoPrivacy.PUBLIC } })
+
+      await makePutBodyRequest({ url: server.url, path: path + videoId, token: server.accessToken, fields })
+    })
+
     it('Should fail with an incorrect thumbnail file', async function () {
       const fields = baseCorrectParams
       const attaches = {
diff --git a/server/tests/api/videos/video-schedule-update.ts b/server/tests/api/videos/video-schedule-update.ts
index 8b87ea855..a260fa4da 100644
--- a/server/tests/api/videos/video-schedule-update.ts
+++ b/server/tests/api/videos/video-schedule-update.ts
@@ -5,11 +5,14 @@ import 'mocha'
 import { VideoPrivacy } from '../../../../shared/models/videos'
 import {
   doubleFollow,
-  flushAndRunMultipleServers, getMyVideos,
+  flushAndRunMultipleServers,
+  getMyVideos,
   getVideosList,
+  getVideoWithToken,
   killallServers,
   ServerInfo,
-  setAccessTokensToServers, updateVideo,
+  setAccessTokensToServers,
+  updateVideo,
   uploadVideo,
   wait
 } from '../../utils'
@@ -69,17 +72,22 @@ describe('Test video update scheduler', function () {
     const res = await getMyVideos(servers[0].url, servers[0].accessToken, 0, 5)
     expect(res.body.total).to.equal(1)
 
-    const video = res.body.data[0]
-    expect(video.name).to.equal('video 1')
-    expect(video.privacy.id).to.equal(VideoPrivacy.PRIVATE)
-    expect(new Date(video.scheduledUpdate.updateAt)).to.be.above(new Date())
-    expect(video.scheduledUpdate.privacy).to.equal(VideoPrivacy.PUBLIC)
+    const videoFromList = res.body.data[0]
+    const res2 = await getVideoWithToken(servers[0].url, servers[0].accessToken, videoFromList.uuid)
+    const videoFromGet = res2.body
+
+    for (const video of [ videoFromList, videoFromGet ]) {
+      expect(video.name).to.equal('video 1')
+      expect(video.privacy.id).to.equal(VideoPrivacy.PRIVATE)
+      expect(new Date(video.scheduledUpdate.updateAt)).to.be.above(new Date())
+      expect(video.scheduledUpdate.privacy).to.equal(VideoPrivacy.PUBLIC)
+    }
   })
 
   it('Should wait some seconds and have the video in public privacy', async function () {
     this.timeout(20000)
 
-    await wait(10000)
+    await wait(15000)
     await waitJobs(servers)
 
     for (const server of servers) {
@@ -144,7 +152,7 @@ describe('Test video update scheduler', function () {
   it('Should wait some seconds and have the updated video in public privacy', async function () {
     this.timeout(20000)
 
-    await wait(10000)
+    await wait(15000)
     await waitJobs(servers)
 
     for (const server of servers) {