feat(FEC-13507): support doc sources (#233)

* feat(FEC-13507): keep doc entries * feat(FEC-13507): add doc source support * feat(FEC-13507): upd tests * feat(FEC-13507): address PR comments
kaltura · Jan 23, 2024 · bb5f4a7 · bb5f4a7
1 parent ece6a0e
commit bb5f4a7
Show file tree

Hide file tree

Showing 14 changed files with 78 additions and 11 deletions.
diff --git a/src/entities/document-source.ts b/src/entities/document-source.ts
@@ -0,0 +1,31 @@
+export default class DocumentSource {
+  /**
+   * @member - media source id
+   * @type {string}
+   */
+  public id: string;
+  /**
+   * @member - media source url
+   * @type {string}
+   */
+  public url: string;
+  /**
+   * @member - thumbnail url
+   * @type {string}
+   */
+  public thumbnailUrl: string;
+  /**
+   * @member - media source mimetype
+   * @type {string}
+   */
+  public mimetype: string;
+
+  constructor(entry: any) {
+    this.id = entry.id;
+    this.url = entry.downloadUrl;
+    this.thumbnailUrl = entry.poster;
+    this.mimetype = '';
+  }
+}
+
+export {DocumentSource}
diff --git a/src/entities/media-entry.ts b/src/entities/media-entry.ts
@@ -8,7 +8,8 @@ export default class MediaEntry {
     LIVE: 'Live',
     IMAGE: 'Image',
     AUDIO: 'Audio',
-    UNKNOWN: 'Unknown'
+    UNKNOWN: 'Unknown',
+    DOCUMENT: 'Document'
   };
   public static DvrStatus: {[type: string]: number} = {
     ON: 1,

diff --git a/src/entities/media-sources.ts b/src/entities/media-sources.ts
@@ -1,6 +1,7 @@
 import MediaSource from './media-source';
 import {MediaFormat} from './media-format';
 import {ImageSource} from './image-source';
+import {DocumentSource} from './document-source';
 import {PKExternalCaptionObject, ProviderMediaFormatType, ProviderMediaSourcesObject} from '../types';
 
 export default class MediaSources {
@@ -23,6 +24,7 @@ export default class MediaSources {
    */
   public hls: Array<MediaSource>;
   public image: Array<ImageSource>;
+  public document: Array<DocumentSource>;
   public captions?: Array<PKExternalCaptionObject>;
 
   /**
@@ -33,6 +35,7 @@ export default class MediaSources {
     this.dash = [];
     this.hls = [];
     this.image = [];
+    this.document = [];
   }
 
   /**
@@ -68,12 +71,14 @@ export default class MediaSources {
       progressive: [],
       dash: [],
       hls: [],
-      image: []
+      image: [],
+      document: []
     };
     this.progressive.forEach(p => response.progressive.push(p.toJSON()));
     this.hls.forEach(h => response.hls.push(h.toJSON()));
     this.dash.forEach(d => response.dash.push(d.toJSON()));
     response.image = this.image;
+    response.document = this.document;
     return response;
   }
 }
diff --git a/src/k-provider/common/base-provider.ts b/src/k-provider/common/base-provider.ts
@@ -88,7 +88,7 @@ export default class BaseProvider<MI> {
   }
 
   protected _verifyHasSources(sources: ProviderMediaConfigSourcesObject): void {
-    if (sources.hls.concat(sources.dash, sources.progressive, sources.image).length === 0) {
+    if (sources.hls.concat(sources.dash, sources.progressive, sources.image, sources.document).length === 0) {
       throw new Error(Error.Severity.CRITICAL, Error.Category.SERVICE, Error.Code.MISSING_PLAY_SOURCE, {
         action: '',
         messages: `No play source for entry id: ${sources.id}`

diff --git a/src/k-provider/ott/provider.ts b/src/k-provider/ott/provider.ts
@@ -213,6 +213,7 @@ export default class OTTProvider extends BaseProvider<OTTProviderMediaInfoObject
       dash: [],
       progressive: [],
       image: [],
+      document: [],
       id: '',
       duration: 0,
       type: MediaEntry.Type.UNKNOWN,

diff --git a/src/k-provider/ovp/provider-parser.ts b/src/k-provider/ovp/provider-parser.ts
@@ -21,6 +21,7 @@ import {KalturaAccessControlMessage} from '../common/response-types/kaltura-acce
 import type {OVPMediaEntryLoaderResponse} from './loaders/media-entry-loader';
 import {ExternalCaptionsBuilder} from './external-captions-builder';
 import {ImageSource} from '../../entities/image-source';
+import {DocumentSource} from '../../entities/document-source';
 
 class OVPProviderParser {
   private static _logger = getLogger('OVPProviderParser');
@@ -194,6 +195,9 @@ class OVPProviderParser {
       case KalturaMediaEntry.EntryType.LIVE_CHANNEL.value:
         type = MediaEntry.Type.LIVE;
         break;
+      case KalturaMediaEntry.EntryType.DOCUMENT.value:
+        type = MediaEntry.Type.DOCUMENT;
+        break;
       default:
         type = MediaEntry.Type.UNKNOWN;
       }
@@ -246,6 +250,10 @@ class OVPProviderParser {
       sources.image.push(new ImageSource(entry));
     };
 
+    const parseDocumentSources = (): void => {
+      sources.document.push(new DocumentSource(entry));
+    };
+
     const parseExternalMedia = (): void => {
       const mediaSource = new MediaSource();
       mediaSource.mimetype = 'video/youtube';
@@ -258,6 +266,8 @@ class OVPProviderParser {
       parseExternalMedia();
     } else if (entry.entryType === KalturaMediaEntry.MediaType.IMAGE.value) {
       parseImageSources();
+    } else if (entry.type === KalturaMediaEntry.EntryType.DOCUMENT.value) {
+      parseDocumentSources();
     } else if (kalturaSources && kalturaSources.length > 0) {
       parseAdaptiveSources();
       parseProgressiveSources();

diff --git a/src/k-provider/ovp/provider.ts b/src/k-provider/ovp/provider.ts
@@ -319,6 +319,7 @@ export default class OVPProvider extends BaseProvider<OVPProviderMediaInfoObject
       dash: [],
       progressive: [],
       image: [],
+      document: [],
       id: '',
       duration: 0,
       type: MediaEntry.Type.UNKNOWN,
@@ -340,6 +341,7 @@ export default class OVPProvider extends BaseProvider<OVPProviderMediaInfoObject
     sourcesObject.dash = mediaSources.dash;
     sourcesObject.progressive = mediaSources.progressive;
     sourcesObject.image = mediaSources.image;
+    sourcesObject.document = mediaSources.document;
     sourcesObject.id = mediaEntry.id;
     sourcesObject.duration = mediaEntry.duration;
     sourcesObject.type = mediaEntry.type;

diff --git a/src/k-provider/ovp/response-types/kaltura-media-entries.ts b/src/k-provider/ovp/response-types/kaltura-media-entries.ts
@@ -16,13 +16,7 @@ export class KalturaMediaEntries extends ServiceResult {
     super(responseObj);
     if (!this.hasError) {
       this.entries = [];
-      responseObj.map(entry => {
-        const kalturaMediaEntry = new KalturaMediaEntry(entry);
-        if (kalturaMediaEntry.type !== KalturaMediaEntry.EntryType.DOCUMENT.value) {
-          // filter out documents
-          this.entries.push(kalturaMediaEntry);
-        }
-      });
+      responseObj.map(entry => this.entries.push(new KalturaMediaEntry(entry)));
     }
   }
 }
diff --git a/src/types/media-config-sources.ts b/src/types/media-config-sources.ts
@@ -1,4 +1,5 @@
 import {ImageSource} from '../entities/image-source';
+import {DocumentSource} from '../entities/document-source';
 import {ProviderMediaConfigMetadataObject} from './media-config-metadata';
 import {PKExternalCaptionObject} from './external-caption-object';
 import {ProviderMediaSourceObject} from './media-source';
@@ -8,6 +9,7 @@ export type ProviderMediaConfigSourcesObject = {
   hls: Array<ProviderMediaSourceObject>;
   progressive: Array<ProviderMediaSourceObject>;
   image: Array<ImageSource>;
+  document: Array<DocumentSource>;
   duration?: number;
   type: string;
   id?: string;

diff --git a/src/types/media-sources.ts b/src/types/media-sources.ts
@@ -1,4 +1,5 @@
 import {ImageSource} from '../entities/image-source';
+import {DocumentSource} from '../entities/document-source';
 import {ProviderMediaSourceObject} from './media-source';
 import {PKExternalCaptionObject} from './external-caption-object';
 
@@ -7,5 +8,6 @@ export type ProviderMediaSourcesObject = {
   dash: Array<ProviderMediaSourceObject>;
   hls: Array<ProviderMediaSourceObject>;
   image: Array<ImageSource>;
+  document: Array<DocumentSource>;
   captions?: Array<PKExternalCaptionObject>;
 };
diff --git a/test/src/k-provider/ott/media-config-data.js b/test/src/k-provider/ott/media-config-data.js
@@ -13,6 +13,7 @@ const NoPluginsWithDrm = {
   sources: {
     progressive: [],
     image: [],
+    document: [],
     dash: [
       {
         id: '728180,mpegdash',
@@ -457,6 +458,7 @@ const FilteredSourcesByDeviceType = {
     progressive: [],
     dash: [],
     image: [],
+    document: [],
     hls: [
       {
         id: '728182,applehttp',
@@ -703,6 +705,7 @@ const LiveEntryNoDrm = {
       }
     ],
     image: [],
+    document: [],
     progressive: [],
     dash: [],
     hls: [
@@ -774,6 +777,7 @@ const EntryWithBumper = {
     ],
     progressive: [],
     image: [],
+    document: [],
     id: 324284,
     duration: 60,
     type: 'Vod',

diff --git a/test/src/k-provider/ovp/media-config-data.js b/test/src/k-provider/ovp/media-config-data.js
@@ -137,6 +137,7 @@ const NoPluginsNoDrm = {
       }
     ],
     image: [],
+    document: [],
     downloadUrl: ''
   }
 };
@@ -187,6 +188,7 @@ const RegexAppliedPlayManifestSources = {
       }
     ],
     image: [],
+    document: [],
     progressive: [
       {
         id: '1_ha0nqwz810081,url',
@@ -330,6 +332,7 @@ const RegexAppliedAllSources = {
       }
     ],
     image: [],
+    document: [],
     progressive: [
       {
         id: '1_ha0nqwz810081,url',
@@ -505,6 +508,7 @@ const NoPluginsWithDrm = {
       }
     ],
     image: [],
+    document: [],
     downloadUrl: ''
   }
 };
@@ -648,6 +652,7 @@ const WithPluginsNoDrm = {
       }
     ],
     image: [],
+    document: [],
     downloadUrl: ''
   }
 };
@@ -712,6 +717,7 @@ const WithPluginsWithDrm = {
       }
     ],
     image: [],
+    document: [],
     downloadUrl: ''
   }
 };
@@ -774,6 +780,7 @@ const AudioEntryWithoutPlugins = {
       }
     ],
     image: [],
+    document: [],
     downloadUrl: ''
   }
 };
@@ -1157,6 +1164,7 @@ const EntryWithBumper = {
       }
     ],
     image: [],
+    document: [],
     id: '0_wifqaipd',
     duration: 741,
     type: 'Vod',
@@ -1274,6 +1282,7 @@ const EntryWithBumperWithKs = {
       }
     ],
     image: [],
+    document: [],
     id: '0_wifqaipd',
     duration: 741,
     type: 'Vod',
@@ -1394,6 +1403,7 @@ const EntryWithNoBumper = {
       }
     ],
     image: [],
+    document: [],
     id: '0_wifqaipd',
     duration: 741,
     type: 'Vod',
@@ -1486,6 +1496,7 @@ const EntryOfPartner0 = {
       }
     ],
     image: [],
+    document: [],
     id: '0_pi55vv3r',
     duration: 11,
     type: 'Vod',

diff --git a/test/src/k-provider/ovp/provider-parser-data.js b/test/src/k-provider/ovp/provider-parser-data.js
@@ -70,7 +70,8 @@ const youtubeMediaEntryResult = {
     ],
     dash: [],
     hls: [],
-    image: []
+    image: [],
+    document: []
   },
   duration: 0,
   metadata: {

diff --git a/test/src/k-provider/ovp/regex-action-handler-data.js b/test/src/k-provider/ovp/regex-action-handler-data.js
@@ -103,6 +103,7 @@ const mediaConfig = {
       }
     ],
     image: [],
+    document: [],
     id: '1_5w23wdlc',
     duration: 206,
     type: 'Vod',
@@ -632,6 +633,7 @@ const finalMediaConfigAllSourcesModified = {
       }
     ],
     image: [],
+    document: [],
     id: '1_5w23wdlc',
     duration: 206,
     type: 'Vod',
@@ -764,6 +766,7 @@ const finalMediaConfigPlayManifestSourcesModified = {
       }
     ],
     image: [],
+    document: [],
     id: '1_5w23wdlc',
     duration: 206,
     type: 'Vod',