jsPsych/packages/jspsych/tests/data/recorddataparameter.test.ts

import htmlKeyboardResponse from "@jspsych/plugin-html-keyboard-response";
import { pressKey, startTimeline } from "@jspsych/test-utils";

import { initJsPsych } from "../../src";

describe("The record_data parameter", () => {
  it("Defaults to true", async () => {
    const { getData } = await startTimeline([
      {
        type: htmlKeyboardResponse,
        stimulus: "<p>foo</p>",
      },
    ]);

    await pressKey(" ");

    expect(getData().count()).toBe(1);
  });

  it("Can be set to false to prevent the data from being recorded", async () => {
    const onFinish = jest.fn();
    const onTrialFinish = jest.fn();
    const onDataUpdate = jest.fn();

    const { getData } = await startTimeline(
      [
        {
          type: htmlKeyboardResponse,
          stimulus: "<p>foo</p>",
          record_data: false,
          on_finish: onFinish,
        },
      ],
      { on_trial_finish: onTrialFinish, on_data_update: onDataUpdate }
    );

    await pressKey(" ");

    expect(getData().count()).toBe(0);
    expect(onFinish).toHaveBeenCalledWith(undefined);
    expect(onTrialFinish).toHaveBeenCalledWith(undefined);
    expect(onDataUpdate).not.toHaveBeenCalled();
  });

  it("Can be set as a timeline variable", async () => {
    const jsPsych = initJsPsych();
    const { getData } = await startTimeline(
      [
        {
          timeline: [
            {
              type: htmlKeyboardResponse,
              stimulus: "<p>foo</p>",
              record_data: jsPsych.timelineVariable("record_data"),
            },
          ],
          timeline_variables: [{ record_data: true }, { record_data: false }],
        },
      ],
      jsPsych
    );

    await pressKey(" ");
    await pressKey(" ");

    expect(getData().count()).toBe(1);
  });

  it("Can be set as a function", async () => {
    const jsPsych = initJsPsych();
    const { getData } = await startTimeline(
      [
        {
          type: htmlKeyboardResponse,
          stimulus: "<p>foo</p>",
          record_data: () => false,
        },
      ],
      jsPsych
    );

    await pressKey(" ");

    expect(getData().count()).toBe(0);
  });
});