Federate entire description

Introduce an explicit field truncatedDescription
description in video list is deprecated
description in video get will contain the entire description

client/src/app/+videos/+video-watch/shared/metadata/video-description.component.html

@@ -1,7 +1,7 @@
 <div class="video-info-description">
   <div
     class="video-info-description-html"
-    [innerHTML]="videoHTMLDescription"
+    [innerHTML]="getHTMLDescription()"
     (timestampClicked)="onTimestampClicked($event)"
     myTimestampRouteTransformer
   ></div>

client/src/app/+videos/+video-watch/shared/metadata/video-description.component.ts

@@ -15,8 +15,10 @@ export class VideoDescriptionComponent implements OnChanges {
 
   descriptionLoading = false
   completeDescriptionShown = false
-  completeVideoDescription: string
+
-  shortVideoDescription: string
+  completeVideoDescriptionLoaded = false
+
+  videoHTMLTruncatedDescription = ''
   videoHTMLDescription = ''
 
   constructor (
@@ -28,22 +30,19 @@ export class VideoDescriptionComponent implements OnChanges {
   ngOnChanges () {
     this.descriptionLoading = false
     this.completeDescriptionShown = false
-    this.completeVideoDescription = undefined
 
     this.setVideoDescriptionHTML()
   }
 
   showMoreDescription () {
-    if (this.completeVideoDescription === undefined) {
+    if (!this.completeVideoDescriptionLoaded) {
       return this.loadCompleteDescription()
     }
 
-    this.updateVideoDescription(this.completeVideoDescription)
     this.completeDescriptionShown = true
   }
 
   showLessDescription () {
-    this.updateVideoDescription(this.shortVideoDescription)
     this.completeDescriptionShown = false
   }
 
@@ -56,10 +55,10 @@ export class VideoDescriptionComponent implements OnChanges {
             this.completeDescriptionShown = true
             this.descriptionLoading = false
 
-            this.shortVideoDescription = this.video.description
+            this.video.description = description
-            this.completeVideoDescription = description
 
-            this.updateVideoDescription(this.completeVideoDescription)
+            this.setVideoDescriptionHTML()
+              .catch(err => logger.error(err))
           },
 
           error: err => {
@@ -73,15 +72,25 @@ export class VideoDescriptionComponent implements OnChanges {
     this.timestampClicked.emit(timestamp)
   }
 
-  private updateVideoDescription (description: string) {
+  getHTMLDescription () {
-    this.video.description = description
+    if (this.completeDescriptionShown) {
-    this.setVideoDescriptionHTML()
+      return this.videoHTMLDescription
-      .catch(err => logger.error(err))
+    }
+
+    return this.videoHTMLTruncatedDescription
   }
 
   private async setVideoDescriptionHTML () {
+    {
       const html = await this.markdownService.textMarkdownToHTML({ markdown: this.video.description })
 
       this.videoHTMLDescription = this.markdownService.processVideoTimestamps(this.video.shortUUID, html)
     }
+
+    {
+      const html = await this.markdownService.textMarkdownToHTML({ markdown: this.video.truncatedDescription })
+
+      this.videoHTMLTruncatedDescription = this.markdownService.processVideoTimestamps(this.video.shortUUID, html)
+    }
+  }
 }

client/src/app/shared/shared-main/video/video.model.ts

@@ -34,6 +34,7 @@ export class Video implements VideoServerModel {
   language: VideoConstant<string>
   privacy: VideoConstant<VideoPrivacy>
 
+  truncatedDescription: string
   description: string
 
   duration: number
@@ -134,6 +135,8 @@ export class Video implements VideoServerModel {
     this.privacy = hash.privacy
     this.waitTranscoding = hash.waitTranscoding
     this.state = hash.state
+
+    this.truncatedDescription = hash.truncatedDescription
     this.description = hash.description
 
     this.isLive = hash.isLive

server/helpers/custom-validators/activitypub/videos.ts

@@ -7,11 +7,11 @@ import { peertubeTruncate } from '../../core-utils'
 import { isArray, isBooleanValid, isDateValid, isUUIDValid } from '../misc'
 import { isLiveLatencyModeValid } from '../video-lives'
 import {
+  isVideoDescriptionValid,
   isVideoDurationValid,
   isVideoNameValid,
   isVideoStateValid,
   isVideoTagValid,
-  isVideoTruncatedDescriptionValid,
   isVideoViewsValid
 } from '../videos'
 import { isActivityPubUrlValid, isActivityPubVideoDurationValid, isBaseActivityValid, setValidAttributedTo } from './misc'
@@ -32,7 +32,7 @@ function sanitizeAndCheckVideoTorrentObject (video: any) {
     logger.debug('Video has invalid urls', { video })
     return false
   }
-  if (!setRemoteVideoTruncatedContent(video)) {
+  if (!setRemoteVideoContent(video)) {
     logger.debug('Video has invalid content', { video })
     return false
   }
@@ -168,7 +168,7 @@ function isRemoteStringIdentifierValid (data: any) {
 }
 
 function isRemoteVideoContentValid (mediaType: string, content: string) {
-  return mediaType === 'text/markdown' && isVideoTruncatedDescriptionValid(content)
+  return mediaType === 'text/markdown' && isVideoDescriptionValid(content)
 }
 
 function setValidRemoteIcon (video: any) {
@@ -194,9 +194,9 @@ function setValidRemoteVideoUrls (video: any) {
   return true
 }
 
-function setRemoteVideoTruncatedContent (video: any) {
+function setRemoteVideoContent (video: any) {
   if (video.content) {
-    video.content = peertubeTruncate(video.content, { length: CONSTRAINTS_FIELDS.VIDEOS.TRUNCATED_DESCRIPTION.max })
+    video.content = peertubeTruncate(video.content, { length: CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max })
   }
 
   return true

server/helpers/custom-validators/videos.ts

@@ -45,10 +45,6 @@ function isVideoDurationValid (value: string) {
   return exists(value) && validator.isInt(value + '', VIDEOS_CONSTRAINTS_FIELDS.DURATION)
 }
 
-function isVideoTruncatedDescriptionValid (value: string) {
-  return exists(value) && validator.isLength(value, VIDEOS_CONSTRAINTS_FIELDS.TRUNCATED_DESCRIPTION)
-}
-
 function isVideoDescriptionValid (value: string) {
   return value === null || (exists(value) && validator.isLength(value, VIDEOS_CONSTRAINTS_FIELDS.DESCRIPTION))
 }
@@ -151,7 +147,6 @@ export {
   isVideoCategoryValid,
   isVideoLicenceValid,
   isVideoLanguageValid,
-  isVideoTruncatedDescriptionValid,
   isVideoDescriptionValid,
   isVideoFileInfoHashValid,
   isVideoNameValid,

server/models/video/formatter/video-format-utils.ts

@@ -103,6 +103,7 @@ function videoModelToFormattedJSON (video: MVideoFormattable, options: VideoForm
     },
     nsfw: video.nsfw,
 
+    truncatedDescription: video.getTruncatedDescription(),
     description: options && options.completeDescription === true
       ? video.description
       : video.getTruncatedDescription(),
@@ -181,6 +182,7 @@ function videoModelToFormattedDetailsJSON (video: MVideoFormattableDetails): Vid
   const span = tracer.startSpan('peertube.VideoModel.toFormattedDetailsJSON')
 
   const videoJSON = video.toFormattedJSON({
+    completeDescription: true,
     additionalAttributes: {
       scheduledUpdate: true,
       blacklistInfo: true,

server/tests/api/videos/video-description.ts

@@ -14,8 +14,12 @@ describe('Test video description', function () {
   let servers: PeerTubeServer[] = []
   let videoUUID = ''
   let videoId: number
+
   const longDescription = 'my super description for server 1'.repeat(50)
 
+  // 30 characters * 6 -> 240 characters
+  const truncatedDescription = 'my super description for server 1'.repeat(7) + 'my super descrip...'
+
   before(async function () {
     this.timeout(40000)
 
@@ -45,15 +49,22 @@ describe('Test video description', function () {
     videoUUID = data[0].uuid
   })
 
-  it('Should have a truncated description on each server', async function () {
+  it('Should have a truncated description on each server when listing videos', async function () {
+    for (const server of servers) {
+      const { data } = await server.videos.list()
+      const video = data.find(v => v.uuid === videoUUID)
+
+      expect(video.description).to.equal(truncatedDescription)
+      expect(video.truncatedDescription).to.equal(truncatedDescription)
+    }
+  })
+
+  it('Should not have a truncated description on each server when getting videos', async function () {
     for (const server of servers) {
       const video = await server.videos.get({ id: videoUUID })
 
-      // 30 characters * 6 -> 240 characters
+      expect(video.description).to.equal(longDescription)
-      const truncatedDescription = 'my super description for server 1'.repeat(7) +
+      expect(video.truncatedDescription).to.equal(truncatedDescription)
-        'my super descrip...'
-
-      expect(video.description).to.equal(truncatedDescription)
     }
   })
 

shared/models/videos/video.model.ts

@@ -20,7 +20,11 @@ export interface Video {
   licence: VideoConstant<number>
   language: VideoConstant<string>
   privacy: VideoConstant<VideoPrivacy>
+
+  // Deprecated in 5.0 in favour of truncatedDescription
   description: string
+  truncatedDescription: string
+
   duration: number
   isLocal: boolean
   name: string
@@ -70,7 +74,9 @@ export interface Video {
 }
 
 export interface VideoDetails extends Video {
+  // Deprecated in 5.0
   descriptionPath: string
+
   support: string
   channel: VideoChannel
   account: Account