jsPsych/packages/plugin-instructions/src/index.spec.ts

import { pressKey, simulateTimeline, startTimeline } from "@jspsych/test-utils";

import instructions from ".";

jest.useFakeTimers();

describe("instructions plugin", () => {
  test("keys can be specified as strings", async () => {
    const { getHTML, expectFinished } = await startTimeline([
      {
        type: instructions,
        pages: ["page 1", "page 2"],
        key_forward: "a",
      },
    ]);

    expect(getHTML()).toContain("page 1");

    pressKey("a");
    expect(getHTML()).toContain("page 2");

    pressKey("a");
    await expectFinished();
  });

  test("bug issue #544 reproduce", async () => {
    const { getHTML, expectFinished } = await startTimeline([
      {
        type: instructions,
        pages: ["page 1", "page 2"],
        key_forward: "a",
        allow_backward: false,
      },
    ]);

    expect(getHTML()).toContain("page 1");

    pressKey("a");
    expect(getHTML()).toContain("page 2");

    pressKey("ArrowLeft");
    expect(getHTML()).toContain("page 2");

    pressKey("a");
    await expectFinished();
  });

  test("view history data is stored as array of objects", async () => {
    const { getData, expectFinished } = await startTimeline([
      {
        type: instructions,
        pages: ["page 1", "page 2"],
        key_forward: "a",
      },
    ]);

    pressKey("a");
    pressKey("a");

    await expectFinished();

    var data = getData().values()[0].view_history;
    expect(data[0].page_index).toEqual(0);
    expect(data[1].page_index).toEqual(1);
  });
});

describe("instructions plugin simulation", () => {
  test("data-only mode works", async () => {
    const { getData, expectFinished } = await simulateTimeline([
      {
        type: instructions,
        pages: ["page 1", "page 2", "page 3", "page 4", "page 5", "page 6"],
      },
    ]);

    await expectFinished();

    const data = getData().values()[0];

    expect(data.view_history.length).toBeGreaterThanOrEqual(6);
    expect(data.view_history[data.view_history.length - 1].page_index).toBe(5);
  });

  test("visual mode works", async () => {
    const { getData, expectRunning, expectFinished } = await simulateTimeline(
      [
        {
          type: instructions,
          pages: ["page 1", "page 2", "page 3", "page 4", "page 5", "page 6"],
        },
      ],
      "visual"
    );

    await expectRunning();

    jest.runAllTimers();

    await expectFinished();

    const data = getData().values()[0];

    expect(data.view_history.length).toBeGreaterThanOrEqual(6);
    expect(data.view_history[data.view_history.length - 1].page_index).toBe(5);
  });
});