@pixwel/pixwel-sdk 1.1.7 → 1.1.9

package/test/Filename.spec.js

@@ -1,8 +1,8 @@
 import Filename from "../src/Filename";
 let mocks = require("./mocks/mocks");
 
-describe("Filename", function() {
-	describe("render", function() {
+describe("Filename", () => {
+	describe("render", () => {
 		it("renders tags as an underscore-separated string", function() {
 			let asset = {
 				name: "Test Asset A",
@@ -30,7 +30,61 @@ describe("Filename", function() {
 			);
 		});
 
-		it("displays resolution for images", function () {
+		it("renders language and country", function() {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				type: "trailer.intl",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "ENG",
+				country: "US",
+				tags: {
+					Text: "txtd",
+					Extra: ["COMING-SOON", "HOJE"],
+					Codec: "PRORES",
+					Resolution: "640x480",
+					Framerate: "23.98",
+					"Frame Mode": "progressive"
+				}
+			};
+			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+				"TESTPROJECT_ITR-TEST-ASSET-A_ENG-US_TXTD_COMING-SOON_HOJE_PRORES_480p2398"
+			);
+		});
+
+		it("renders language only for dual-language codes", function () {
+			let asset = {
+				name: "Test Asset A",
+				slug: "test-asset-a",
+				type: "trailer.intl",
+				mediaType: "video",
+				project: {
+					filePrefix: "TESTPROJECT"
+				}
+			};
+			let options = {
+				language: "PFR-FLE",
+				country: "US",
+				tags: {
+					Text: "txtd",
+					Extra: ["COMING-SOON", "HOJE"],
+					Codec: "PRORES",
+					Resolution: "640x480",
+					Framerate: "23.98",
+					"Frame Mode": "progressive"
+				}
+			};
+			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+				"TESTPROJECT_ITR-TEST-ASSET-A_PFR-FLE_TXTD_COMING-SOON_HOJE_PRORES_480p2398"
+			);
+		});
+
+		it("displays resolution for images", function() {
 			let asset = {
 				name: "Test Asset A",
 				slug: "test-asset-a",
@@ -44,13 +98,13 @@ describe("Filename", function() {
 				language: "ENG",
 				country: "WW",
 				tags: {
-					Text: 'txtd',
+					Text: "txtd",
 					Resolution: "640x480"
 				}
 			};
-			expect(Filename.render(mocks.tags, mocks.types, asset, options, 'image')).toBe(
-				"TESTPROJECT_ITR-TEST-ASSET-A_ENG_TXTD_640x480"
-			);
+			expect(
+				Filename.render(mocks.tags, mocks.types, asset, options, "image")
+			).toBe("TESTPROJECT_ITR-TEST-ASSET-A_ENG_TXTD_640x480");
 		});
 
 		it("renders asset names with contractions correctly", function() {
@@ -122,7 +176,7 @@ describe("Filename", function() {
 			}).toThrow("missing asset.project");
 		});
 
-		it("throws exception if missing asset.length (film-clip)", function() {
+		xit("throws exception if missing asset.length (film-clip)", function() {
 			let asset = {
 				name: "Test Asset A",
 				slug: "test-asset-a",
@@ -133,7 +187,10 @@ describe("Filename", function() {
 				}
 			};
 			let options = {
-				language: "ENG"
+				language: "ENG",
+				tags: {
+					Text: "txtd"
+				}
 			};
 			expect(() => {
 				Filename.render(mocks.tags, mocks.types, asset, options);
@@ -168,30 +225,6 @@ describe("Filename", function() {
 		//     }).toThrow('conflicting options supplied: SubDub and Text');
 		// });
 
-		it("throws exception if both SubDub and Text is not supplied", function() {
-			let asset = {
-				name: "Test Asset A",
-				slug: "test-asset-a",
-				type: "trailer.intl",
-				mediaType: "video",
-				project: {
-					filePrefix: "TESTPROJECT"
-				}
-			};
-			let options = {
-				language: "ENG",
-				tags: {
-					Codec: "prores",
-					Resolution: "640x480",
-					Framerate: "23.98",
-					"Frame Mode": "progressive"
-				}
-			};
-			expect(() => {
-				Filename.render(mocks.tags, mocks.types, asset, options);
-			}).toThrow("missing options.tags.Text or options.tags.SubDub");
-		});
-
 		// it("throws exception if mediaType=video is missing Codec", function() {
 		// 	let asset = {
 		// 		name: "Test Asset A",
@@ -238,7 +271,7 @@ describe("Filename", function() {
 				}
 			};
 			expect(() => {
-				Filename.render(mocks.tags, mocks.types, asset, options, 'video');
+				Filename.render(mocks.tags, mocks.types, asset, options, "video");
 			}).toThrow("missing options.tags.Resolution");
 		});
 
@@ -263,7 +296,7 @@ describe("Filename", function() {
 				}
 			};
 			expect(() => {
-				Filename.render(mocks.tags, mocks.types, asset, options, 'video');
+				Filename.render(mocks.tags, mocks.types, asset, options, "video");
 			}).toThrow("missing options.tags.Framerate");
 		});
 
@@ -288,11 +321,11 @@ describe("Filename", function() {
 				}
 			};
 			expect(() => {
-				Filename.render(mocks.tags, mocks.types, asset, options, 'video');
+				Filename.render(mocks.tags, mocks.types, asset, options, "video");
 			}).toThrow("missing options.tags[Frame Mode]");
 		});
 
-		it("throws exception if missing asset.length (featurette)", function() {
+		xit("throws exception if missing asset.length (featurette)", function() {
 			let asset = {
 				name: "Test Asset A",
 				slug: "test-asset-a",
@@ -303,7 +336,10 @@ describe("Filename", function() {
 				}
 			};
 			let options = {
-				language: "ENG"
+				language: "ENG",
+				tags: {
+					Text: "txtd"
+				}
 			};
 			expect(() => {
 				Filename.render(mocks.tags, mocks.types, asset, options);

package/test/Ingest.spec.js

@@ -1,112 +1,350 @@
 import Ingest from "../src/Ingest";
+import Order from "../src/Order";
 
 import mock from "./mocks/mediainfo.mock";
 import proresMock from "./mocks/prores.mock";
 import pngMock from "./mocks/mediainfo.png.mock";
 import mxfMock from "./mocks/mediainfo.mxf.mock";
+import mocks from "./mocks/mocks";
 
 describe("Ingest", () => {
-	describe("mapMetaToTags", () => {
+	describe("assemble", () => {
+		it("should set country and language from filename if not found in order", () => {
+			let original = {
+				context: {}
+			};
+			let filename = {
+				selected: {
+					download: {
+						language: "ENG",
+						country: "US"
+					}
+				}
+			};
+			let mediainfo = {};
+			let order = new Order();
+			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			expect(ingest.selected.download.language).toBe("ENG");
+			expect(ingest.selected.download.country).toBe("US");
+		});
+		it("should use asset from filename when there is no context", () => {
+			let original = {
+				context: {}
+			};
+			let filename = {
+				asset: { _id: "a1b2c3" },
+			};
+			let mediainfo = {};
+			let order = new Order();
+			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			expect(ingest.selected.asset).toBe("a1b2c3");
+		});
+		it("should use all context when coming from an order", () => {
+			let original = {
+				selected: {
+					download: {
+						tags: {
+							Extra: ['A', 'B']
+						}
+					}
+				},
+				context: {
+					"workRequest": "5c90dd39ab0e003b358b456d",
+					"asset": "5c804776bb65ce2e008b4568",
+					"assetType": "social",
+					"project": "5ada6930679eef010c8b45fc",
+					"group": 1553693108697,
+					"tag": "FRIDAY"
+				}
+			};
+			let filename = {
+				project: { _id: "a1b2c3"},
+				asset: { _id: "a1b2c3" }
+			};
+			let mediainfo = {};
+			let order = new Order({ _id: "5c90dd39ab0e003b358b456d" });
+			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			expect(ingest.selected.download.tags.Extra).toEqual(['FRIDAY']);
+			expect(ingest.selected.project).toBe("5ada6930679eef010c8b45fc");
+			expect(ingest.selected.asset).toBe("5c804776bb65ce2e008b4568");
+			expect(ingest.selected.assetType).toBe("social");
+		});
+		it("should set preview revision=Unfinished for creative assets", () => {
+			let original = {
+				asset: {
+					creative: true
+				},
+				context: {}
+			};
+			let filename = {
+				selected: {
+					download: {
+						language: "ENG",
+						country: "US"
+					}
+				}
+			};
+			let mediainfo = {};
+			let order = new Order();
+			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			expect(ingest.selected.preview.revision).toBe("Unfinished");
+		});
+		it("should keep tags from parsed filename when order is empty", () => {
+			let original = { asset: { creative: true }, context: {} };
+			let filename = {
+				selected: {
+					download: {
+						language: "ENG",
+						country: "US",
+						tags: {
+							Extra: ["coming-soon"],
+							SubDub: {
+								sub: true
+							}
+						}
+					}
+				}
+			};
+			let mediainfo = {};
+			let order = new Order();
+			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			expect(ingest.selected.download.tags).toEqual({
+				Extra: ["coming-soon"],
+				SubDub: { sub: true }
+			});
+		});
+		it("should set preview revision=Final for finished assets", () => {
+			let original = { asset: { creative: false }, context: {} };
+			let filename = {
+				selected: { download: { language: "ENG", country: "US" } }
+			};
+			let mediainfo = {};
+			let order = new Order();
+			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			expect(ingest.selected.preview.revision).toBe("Final");
+		});
+		it("should enable preview if file is prores 1080p 23.98/25", () => {
+			let original = { context: {} };
+			let filename = {
+				selected: { download: { language: "ENG", country: "US" } }
+			};
+			let mediainfo = {
+				selected: {
+					download: {
+						tags: {
+							Codec: "prores",
+							Resolution: "720x1080",
+							Framerate: "23.98"
+						}
+					}
+				}
+			};
+			let order = new Order();
+			let watermarks = [1];
+			let ingest = Ingest.assemble(
+				original,
+				filename,
+				mediainfo,
+				order,
+				watermarks
+			);
+			expect(ingest.selected.preview.enabled).toBe(true);
+		});
+		it("should prefer language and country from order over filename", () => {
+			let original = { context: {} };
+			let filename = {
+				selected: { download: { language: "ENG", country: "US" } }
+			};
+			let mediainfo = {};
+			let order = new Order({
+				territory: "FI",
+				language: "FIN"
+			});
+			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			expect(ingest.selected.download.language).toBe("FIN");
+			expect(ingest.selected.download.country).toBe("FI");
+		});
+		it("should correctly merge tags from mediainfo over filename", () => {
+			let original = { context: {} };
+			let filename = {
+				selected: { download: { tags: { Codec: "prores", Aspect: "4X3" } } }
+			};
+			let mediainfo = {
+				selected: { download: { tags: { Codec: "h264", Aspect: "16:9" } } }
+			};
+			let order = new Order();
+			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			expect(ingest.selected.download.tags.Codec).toBe("h264");
+			expect(ingest.selected.download.tags.Aspect).toBe("16:9");
+		});
+		it("should set preview.type=sub if order.isSub", () => {
+			let original = { context: {} };
+			let filename = {};
+			let mediainfo = {};
+			let order = {
+				isSub: jest.fn().mockReturnValue(true),
+				isDub: jest.fn().mockReturnValue(null)
+			};
+			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			expect(ingest.selected.preview.type).toBe("sub");
+		});
+		it("should set preview.type=dub if order.isDub", () => {
+			let original = { context: {} };
+			let filename = {};
+			let mediainfo = {};
+			let order = {
+				isSub: jest.fn().mockReturnValue(null),
+				isDub: jest.fn().mockReturnValue(true)
+			};
+			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			expect(ingest.selected.preview.type).toBe("dub");
+		});
+		it("should set preview.type=both if order.isDub and order.isDub", () => {
+			let original = { context: {} };
+			let filename = {};
+			let mediainfo = {};
+			let order = {
+				isSub: jest.fn().mockReturnValue(true),
+				isDub: jest.fn().mockReturnValue(true)
+			};
+			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			expect(ingest.selected.preview.type).toBe("both");
+		});
+		it("should retain Extra tags from order over filename", () => {
+			let original = { context: { tag: "coming-soon" } };
+			let filename = {
+				selected: {
+					download: {
+						tags: ["friday"]
+					}
+				}
+			};
+			let mediainfo = {};
+			let order = {
+				isSub: jest.fn().mockReturnValue(true),
+				isDub: jest.fn().mockReturnValue(true)
+			};
+			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			expect(ingest.selected.download.tags.Extra).toEqual(["coming-soon"]);
+		});
+	});
+	describe("mapFromMediainfo", () => {
 		it("should throw exception if missing File object", () => {
 			let meta = {};
 			expect(() => {
-				let ingest = Ingest.mapMetaToTags(meta, "video");
+				let ingest = Ingest.mapFromMediainfo(meta, "video");
 			}).toThrow("missing info.File");
 		});
 		it("should throw exception if missing File.track object", () => {
-			let meta = {
-				File: {}
-			};
+			let meta = { File: {} };
 			expect(() => {
-				let ingest = Ingest.mapMetaToTags(meta, "video");
+				let ingest = Ingest.mapFromMediainfo(meta, "video");
 			}).toThrow("missing info.File.track");
 		});
 		it("should return empty object of tags if no metadata supplied", () => {
-			let meta = {
-				File: {
-					track: {}
-				}
-			};
-			let ingest = Ingest.mapMetaToTags(meta, "video");
-			expect(ingest).toEqual({
-				Aspect: "",
-				Standard: "",
-				Resolution: "",
-				Codec: "",
-				"Frame Mode": "",
-				Text: "",
-				Usage: "",
-				Extra: [],
-				Framerate: "",
-				Duration: ""
-			});
+			let meta = { File: { track: {} } };
+			let ingest = Ingest.mapFromMediainfo(meta, "video");
+			expect(ingest).toEqual({ selected: { download: { tags: {} } } });
 		});
 		it("should set usage to broadcast for mxf files", () => {
 			let meta = mxfMock;
-			let ingest = Ingest.mapMetaToTags(meta, "");
+			let ingest = Ingest.mapFromMediainfo(meta, "");
 			expect(ingest).toEqual({
-				Aspect: "",
-				Standard: "",
-				Resolution: "",
-				Codec: "",
-				"Frame Mode": "",
-				Text: "",
-				Usage: "broadcast",
-				Extra: [],
-				Framerate: "",
-				Duration: ""
+				Usage: "broadcast"
 			});
 		});
 		it("should correctly map h264 metadata to tags", () => {
 			let meta = mock;
-			let ingest = Ingest.mapMetaToTags(meta, "video");
+			let ingest = Ingest.mapFromMediainfo(meta, "video");
 			let expected = {
-				Aspect: "16:9",
-				Codec: "h264",
-				Duration: "",
-				Extra: [],
-				"Frame Mode": "progressive",
-				Framerate: "23.98",
-				Resolution: "640x360",
-				Standard: "ntsc",
-				Text: "",
-				Usage: "online"
+				selected: {
+					download: {
+						tags: {
+							Aspect: "16:9",
+							Codec: "h264",
+							"Frame Mode": "progressive",
+							Framerate: "23.98",
+							Resolution: "640x360",
+							Standard: "ntsc",
+							Usage: "online"
+						}
+					}
+				}
 			};
 			expect(ingest).toEqual(expected);
 		});
 		it("should correctly map prores metadata to tags", () => {
 			let meta = proresMock;
-			let ingest = Ingest.mapMetaToTags(meta, "video");
+			let ingest = Ingest.mapFromMediainfo(meta, "video");
 			let expected = {
-				Aspect: "16:9",
-				Codec: "prores",
-				Duration: "",
-				Extra: [],
-				"Frame Mode": "progressive",
-				Framerate: "23.98",
-				Resolution: "1920x1080",
-				Standard: "ntsc",
-				Text: "",
-				Usage: "broadcast"
+				selected: {
+					download: {
+						tags: {
+							Aspect: "16:9",
+							Codec: "prores",
+							"Frame Mode": "progressive",
+							Framerate: "23.98",
+							Resolution: "1920x1080",
+							Standard: "ntsc",
+							Usage: "broadcast"
+						}
+					}
+				}
 			};
 			expect(ingest).toEqual(expected);
 		});
 		it("should correctly map png metadata to tags", () => {
 			let meta = pngMock;
-			let ingest = Ingest.mapMetaToTags(meta, "image");
+			let ingest = Ingest.mapFromMediainfo(meta, "image");
 			let expected = {
-				Aspect: "",
-				Codec: "",
-				Duration: "",
-				Extra: [],
-				"Frame Mode": "",
-				Framerate: "",
-				Resolution: "1240x859",
-				Standard: "",
-				Text: "",
-				Usage: ""
+				selected: { download: { tags: { Resolution: "1240x859" } } }
 			};
 			expect(ingest).toEqual(expected);
 		});
 	});
+	describe("mapFromFilename", () => {
+		it("should map filename data to ingest format", () => {
+			let filename = {
+				extra: ["coming-soon"],
+				file: { language: "ENG", country: "US", tags: ["sub", "dub", "txtd"] }
+			};
+			let allTags = mocks.tags;
+			let ingest = Ingest.mapFromFilename(filename, allTags);
+			expect(ingest).toEqual({
+				selected: {
+					download: {
+						tags: {
+							SubDub: {
+								dub: true,
+								sub: true
+							},
+							Extra: ["coming-soon"],
+							Text: "txtd"
+						},
+						language: "ENG",
+						country: "US"
+					},
+					preview: { language: "ENG", type: "both" }
+				}
+			});
+		});
+		it("should set preview type=sub based on filename", () => {
+			let filename = {
+				extra: ["coming-soon"],
+				file: { language: "ENG", country: "US", tags: ["sub", "txtd"] }
+			};
+			let allTags = mocks.tags;
+			let ingest = Ingest.mapFromFilename(filename, allTags);
+			expect(ingest.selected.preview.type).toEqual("sub");
+		});
+		it("should set preview type=dub based on filename", () => {
+			let filename = {
+				extra: ["coming-soon"],
+				file: { language: "ENG", country: "US", tags: ["dub", "txtd"] }
+			};
+			let allTags = mocks.tags;
+			let ingest = Ingest.mapFromFilename(filename, allTags);
+			expect(ingest.selected.preview.type).toEqual("dub");
+		});
+	});
 });