Update sequence when trial finishes

packages/data/src/lookitS3.ts

@@ -4,7 +4,7 @@ import {
   S3Client,
   UploadPartCommand,
 } from "@aws-sdk/client-s3";
-import { AWSMissingAttrError, UploadPartError } from "./error";
+import { AWSMissingAttrError, UploadPartError } from "./errors";
 
 /** Provides functionality to upload videos incrementally to an AWS S3 Bucket. */
 class LookitS3 {

packages/lookit-initjspsych/src/errors.ts

@@ -0,0 +1,12 @@
+/** Error when the upload part retries run out. */
+export class SequenceExpDataError extends Error {
+  /**
+   * Error when the upload part retries run out.
+   *
+   * @param error - Error object generated by upload part function.
+   */
+  public constructor() {
+    super("Experiment sequence or data missing.");
+    this.name = "SequenceExpDataError";
+  }
+}

packages/lookit-initjspsych/src/utils.spec.ts

@@ -1,6 +1,7 @@
 import { DataCollection } from "jspsych";
 
 import { Child, JsPsychExpData, Study } from "@lookit/data/dist/types";
+import { Timeline } from "./types";
 import { on_data_update, on_finish } from "./utils";
 
 delete global.window.location;
@@ -47,7 +48,7 @@ test("jsPsych's on_data_update with no exp_data", async () => {
     json: () => Promise.resolve(jsonData),
     ok: true,
   } as Response;
-  const data = {} as DataCollection;
+  const data = {} as JsPsychExpData;
 
   const userFn = jest.fn();
   global.fetch = jest.fn(() => Promise.resolve(response));
@@ -60,12 +61,19 @@ test("jsPsych's on_data_update with no exp_data", async () => {
 });
 
 test("jsPsych's on_finish", async () => {
+  const exp_data = [{ key: "value" }];
   const jsonData = {
-    data: { attributes: { exp_data: {} } },
+    data: {
+      attributes: { exp_data, sequence: ["0-value"] },
+    },
   };
   const data = {
-    /** Mocked jsPsych Data Collection. */
-    values: () => {},
+    /**
+     * Mocked jsPsych Data Collection.
+     *
+     * @returns Exp data.
+     */
+    values: () => exp_data,
   } as DataCollection;
   const response = {
     /**
@@ -91,6 +99,90 @@ test("jsPsych's on_finish", async () => {
 
   expect(await on_finish("some id", userFn)(data)).toBeUndefined();
   expect(userFn).toHaveBeenCalledTimes(1);
-  expect(fetch).toHaveBeenCalledTimes(1);
-  expect(Request).toHaveBeenCalledTimes(1);
+  expect(fetch).toHaveBeenCalledTimes(2);
+  expect(Request).toHaveBeenCalledTimes(2);
+});
+
+test("Is an error thrown when experiment data is empty?", () => {
+  const exp_data: Timeline[] = [];
+  const jsonData = {
+    data: {
+      attributes: { exp_data, sequence: ["0-value"] },
+    },
+  };
+  const data = {
+    /**
+     * Mocked jsPsych Data Collection.
+     *
+     * @returns Exp data.
+     */
+    values: () => exp_data,
+  } as DataCollection;
+  const response = {
+    /**
+     * Mocked json function used in API calls.
+     *
+     * @returns Promise containing mocked json data.
+     */
+    json: () => Promise.resolve(jsonData),
+    ok: true,
+  } as Response;
+
+  const userFn = jest.fn();
+  global.fetch = jest.fn(() => Promise.resolve(response));
+  global.Request = jest.fn();
+
+  Object.assign(window, {
+    chs: {
+      study: { attributes: { exit_url: "exit url" } } as Study,
+      child: {} as Child,
+      pastSessions: {} as Response[],
+    },
+  });
+
+  expect(async () => {
+    await on_finish("some id", userFn)(data);
+  }).rejects.toThrow("Experiment sequence or data missing.");
+});
+
+test("Is an error thrown when experiment sequence is undefined?", () => {
+  const exp_data = [{ key: "value" }];
+  const jsonData = {
+    data: {
+      attributes: { exp_data, sequence: undefined },
+    },
+  };
+  const data = {
+    /**
+     * Mocked jsPsych Data Collection.
+     *
+     * @returns Exp data.
+     */
+    values: () => exp_data,
+  } as DataCollection;
+  const response = {
+    /**
+     * Mocked json function used in API calls.
+     *
+     * @returns Promise containing mocked json data.
+     */
+    json: () => Promise.resolve(jsonData),
+    ok: true,
+  } as Response;
+
+  const userFn = jest.fn();
+  global.fetch = jest.fn(() => Promise.resolve(response));
+  global.Request = jest.fn();
+
+  Object.assign(window, {
+    chs: {
+      study: { attributes: { exit_url: "exit url" } } as Study,
+      child: {} as Child,
+      pastSessions: {} as Response[],
+    },
+  });
+
+  expect(async () => {
+    await on_finish("some id", userFn)(data);
+  }).rejects.toThrow("Experiment sequence or data missing.");
 });

packages/lookit-initjspsych/src/utils.ts

@@ -1,6 +1,7 @@
 import Api from "@lookit/data";
 import { JsPsychExpData, LookitWindow } from "@lookit/data/dist/types";
 import { DataCollection } from "jspsych";
+import { SequenceExpDataError } from "./errors";
 import { UserFuncOnDataUpdate, UserFuncOnFinish } from "./types";
 
 declare let window: LookitWindow;
@@ -55,7 +56,18 @@ export const on_finish = (
   userFunc?: UserFuncOnFinish,
 ) => {
   return async function (data: DataCollection) {
+    const {
+      attributes: { sequence },
+    } = await Api.retrieveResponse(responseUuid);
+
+    const exp_data: JsPsychExpData[] = data.values();
+
+    if (!sequence || sequence.length === 0 || exp_data.length === 0) {
+      throw new SequenceExpDataError();
+    }
+
     const { exit_url } = window.chs.study.attributes;
+    const last_exp = exp_data[exp_data.length - 1];
 
     // Don't call the function if not defined by user.
     if (typeof userFunc === "function") {
@@ -64,7 +76,8 @@ export const on_finish = (
 
     await Api.finish();
     await Api.updateResponse(responseUuid, {
-      exp_data: data.values() as JsPsychExpData[],
+      exp_data,
+      sequence: [...sequence, `${last_exp.trial_index}-${last_exp.trial_type}`],
       completed: true,
     });