rx-player/src/parsers/texttracks/webvtt/__tests__/parse_cue_block.test.ts

Canal+ HTML5 Video Player

import { describe, beforeEach, it, expect, vi, afterEach } from "vitest";
import parseCueBlock from "../parse_cue_block";
import type parseTimestamp from "../parse_timestamp";

const mocks = vi.hoisted(() => {
  return {
    parseTimestamp: vi.fn(),
  };
});

vi.mock("../parse_timestamp", () => ({
  default: mocks.parseTimestamp,
}));

const cueBlock1 = [
  "112",
  "00:00:31.080 --> 00:07:32.200",
  "Je suis le petit chevalier",
  "Avec le ciel dessus mes yeux",
  "Je ne peux pas me effroyer",
];

const cueBlock2 = ["00:17:55.520 --> 00:17:57.640", "Je suis le petit chevalier"];

const cueBlock3 = ["00:18:01 --> 00:18:09"];

const cueBlock4 = ["116", "00:18:31.080 --> 00:18:32.200"];

const cueBlock5 = [
  "00:00:00.000 --> 00:00:04.000 position:10%,line-left align:left size:35%",
  "Where did he go?",
];

const notCueBlock1 = ["TOTO"];

const notCueBlock2 = ["TOTO", "TATA"];

const notCueBlock3 = ["TOTO", "TATA", "00:18:31.080 --> 00:18:32.200"];

const notCueBlock4 = ["--> 00:18:32.200", "TATA"];

const notCueBlock5 = ["00:18:32.200 -->", "TATA"];

const notCueBlock6 = ["aa:18:31.080 --> 00:18:32.200", "TOTO", "TATA"];

const notCueBlock7 = ["00:18:31.080 --> bb:18:32.200", "TOTO", "TATA"];

describe("parsers - srt - parseCueBlocks", () => {
  beforeEach(async () => {
    vi.resetModules();
    const actualParseTimestamp = (await vi.importActual("../parse_timestamp"))
      .default as typeof parseTimestamp;
    mocks.parseTimestamp.mockImplementation(actualParseTimestamp);
  });
  afterEach(() => {
    mocks.parseTimestamp.mockReset();
  });

  it("should correctly parse regular cue blocks", () => {
    expect(parseCueBlock(cueBlock1, 0)).toEqual({
      start: 31.08,
      end: 452.2,
      header: "112",
      settings: {},
      payload: [
        "Je suis le petit chevalier",
        "Avec le ciel dessus mes yeux",
        "Je ne peux pas me effroyer",
      ],
    });
    expect(parseCueBlock(cueBlock2, 0)).toEqual({
      start: 1075.52,
      end: 1077.64,
      header: undefined,
      settings: {},
      payload: ["Je suis le petit chevalier"],
    });
    expect(parseCueBlock(cueBlock3, 0)).toEqual({
      start: 1081,
      end: 1089,
      header: undefined,
      settings: {},
      payload: [],
    });
    expect(parseCueBlock(cueBlock4, 0)).toEqual({
      start: 1111.08,
      end: 1112.2,
      header: "116",
      settings: {},
      payload: [],
    });
    expect(parseCueBlock(cueBlock5, 0)).toEqual({
      start: 0,
      end: 4,
      header: undefined,
      settings: {
        position: "10%,line-left",
        align: "left",
        size: "35%",
      },
      payload: ["Where did he go?"],
    });
  });

  it("should add timeOffset in seconds", () => {
    expect(parseCueBlock(cueBlock1, 10.1)).toEqual({
      start: 41.18,
      end: 462.3,
      header: "112",
      settings: {},
      payload: [
        "Je suis le petit chevalier",
        "Avec le ciel dessus mes yeux",
        "Je ne peux pas me effroyer",
      ],
    });
    expect(parseCueBlock(cueBlock2, 6)).toEqual({
      start: 1081.52,
      end: 1083.64,
      header: undefined,
      settings: {},
      payload: ["Je suis le petit chevalier"],
    });
    expect(parseCueBlock(cueBlock3, -1.5)).toEqual({
      start: 1079.5,
      end: 1087.5,
      header: undefined,
      settings: {},
      payload: [],
    });
    expect(parseCueBlock(cueBlock4, -1)).toEqual({
      start: 1110.08,
      end: 1111.2,
      header: "116",
      settings: {},
      payload: [],
    });
    expect(parseCueBlock(cueBlock5, 2.2)).toEqual({
      start: 2.2,
      end: 6.2,
      header: undefined,
      settings: {
        position: "10%,line-left",
        align: "left",
        size: "35%",
      },
      payload: ["Where did he go?"],
    });
    expect(parseCueBlock(cueBlock5, -2.2)).toEqual({
      start: -2.2,
      end: 4 - 2.2,
      header: undefined,
      settings: {
        position: "10%,line-left",
        align: "left",
        size: "35%",
      },
      payload: ["Where did he go?"],
    });
  });

  it("should return null for invalid cue blocks", () => {
    expect(parseCueBlock(notCueBlock1, 0)).toEqual(null);
    expect(parseCueBlock(notCueBlock1, 5)).toEqual(null);
    expect(parseCueBlock(notCueBlock2, 0)).toEqual(null);
    expect(parseCueBlock(notCueBlock2, 9)).toEqual(null);
    expect(parseCueBlock(notCueBlock3, 0)).toEqual(null);
    expect(parseCueBlock(notCueBlock3, 21)).toEqual(null);
    expect(parseCueBlock(notCueBlock4, 0)).toEqual(null);
    expect(parseCueBlock(notCueBlock5, 0)).toEqual(null);
    expect(parseCueBlock(notCueBlock6, 0)).toEqual(null);
    expect(parseCueBlock(notCueBlock7, 0)).toEqual(null);
  });

  it("should return null if parseTimestamp returns undefined either for the starting timestamp", () => {
    mocks.parseTimestamp.mockImplementation((arg) =>
      arg === "00:00:31.080" ? undefined : 10,
    );
    expect(parseCueBlock(cueBlock1, 0)).toEqual(null);
    expect(mocks.parseTimestamp).toHaveBeenCalledTimes(2);
  });

  it("should return null if parseTimestamp returns undefined either for the ending timestamp", () => {
    mocks.parseTimestamp.mockImplementation((arg) =>
      arg === "00:07:32.200" ? undefined : 10,
    );
    expect(parseCueBlock(cueBlock1, 0)).toEqual(null);
    expect(mocks.parseTimestamp).toHaveBeenCalledTimes(2);
  });
});