Merge branch 'feat-v4' into ci-fix-make

src/App/App.jsx

@@ -5,7 +5,7 @@ import "@fortawesome/fontawesome-free/css/all.css";
 import "./index.css";
 
 // Import configurations and utilities
-import { config, SETTINGS } from "../config/main";
+import { CONFIG, SETTINGS } from "../config/";
 import { trigger } from "../config/trigger";
 import { getProlificId, getSearchParam } from "../lib/utils";
 
@@ -48,14 +48,14 @@ export default function App() {
     async function setUpHoneycomb() {
       // For testing and debugging purposes
       console.log({
-        "Honeycomb Configuration": config,
+        "Honeycomb Configuration": CONFIG,
         "Task Settings": SETTINGS,
       });
 
       // If on desktop
-      if (config.USE_ELECTRON) {
+      if (CONFIG.USE_ELECTRON) {
         // TODO @brown-ccv #443 : Pass NODE_ENV here as well
-        await window.electronAPI.setConfig(config); // Pass config to Electron ipcMain
+        await window.electronAPI.setConfig(CONFIG); // Pass config to Electron ipcMain
         await window.electronAPI.setTrigger(trigger); // Pass trigger to Electron ipcMain
 
         // Fill in login fields based on environment variables (may still be blank)
@@ -66,16 +66,16 @@ export default function App() {
       } else {
         // TODO @brown-ccv #227: Deprecate USE_PROLIFIC, always get URL
         // TODO @brown-ccv #416: Match USE_PROLIFIC variable names, include session
-        if (config.USE_PROLIFIC) {
+        if (CONFIG.USE_PROLIFIC) {
           const pID = getProlificId();
-          if (config.USE_FIREBASE && pID) {
+          if (CONFIG.USE_FIREBASE && pID) {
             setMethod("firebase");
             handleLogin("prolific", pID);
           } else {
             // Error - Prolific must be used with Firebase
             setIsError(true);
           }
-        } else if (config.USE_FIREBASE) {
+        } else if (CONFIG.USE_FIREBASE) {
           // Fill in login fields based on query parameters (may still be blank)
           const maybeStudyID = getSearchParam("studyID");
           const maybeParticipantID = getSearchParam("participantID");

src/App/components/JsPsychExperiment.jsx

@@ -2,7 +2,7 @@ import { initJsPsych } from "jspsych";
 import PropTypes from "prop-types";
 import React from "react";
 
-import { config } from "../../config/main";
+import { CONFIG } from "../../config/";
 import { buildTimeline, jsPsychOptions } from "../../experiment";
 import { initParticipant } from "../deployments/firebase";
 
@@ -31,7 +31,7 @@ export default function JsPsychExperiment({
       const startDate = new Date().toISOString();
 
       // Write the initial record to Firestore
-      if (config.USE_FIREBASE) initParticipant(studyID, participantID, startDate);
+      if (CONFIG.USE_FIREBASE) initParticipant(studyID, participantID, startDate);
 
       const tempJsPsych = initJsPsych({
         // Combine necessary Honeycomb options with custom ones (src/timelines/main.js)

src/config/main.js → src/config/env.js

@@ -1,28 +1,14 @@
 import { getProlificId } from "../lib/utils";
 
-import language from "./language.json";
-import settings from "./settings.json";
-
-// TODO @brown-ccv #363: Separate into index.js (for exporting) and env.js
-
-// Re-export the language object
-// TODO @brown-ccv #373: Save language in Firebase
-export const LANGUAGE = language;
-// Re-export the settings object
-// TODO @brown-ccv #374: Save settings in Firebase
-export const SETTINGS = settings;
-
 const USE_ELECTRON = window.electronAPI !== undefined; // Whether or not the experiment is running in Electron (local app)
 const USE_PROLIFIC = getProlificId() !== null; // Whether or not the experiment is running with Prolific
 const USE_FIREBASE = import.meta.env.VITE_FIREBASE === "true"; // Whether or not the experiment is running in Firebase (web app)
-
 const USE_CAMERA = import.meta.env.VITE_VIDEO === "true" && USE_ELECTRON; // Whether or not to use video recording
-// TODO @brown-ccv #341: Remove USE_EEG - separate variables for USE_PHOTODIODE and USE_EVENT_MARKER
 const USE_EEG = import.meta.env.VITE_USE_EEG === "true" && USE_ELECTRON; // Whether or not the EEG/event marker is available (TODO @brown-ccv: This is only used for sending event codes)
 const USE_PHOTODIODE = import.meta.env.VITE_USE_PHOTODIODE === "true" && USE_ELECTRON; // whether or not the photodiode is in use
 
 // Configuration object for Honeycomb
-export const config = {
+const config = {
   // Deployments
   USE_ELECTRON,
   USE_PROLIFIC,
@@ -32,3 +18,4 @@ export const config = {
   USE_EEG,
   USE_CAMERA,
 };
+export default config;

src/config/index.js

@@ -0,0 +1,12 @@
+// Re-export the language object
+// TODO @brown-ccv #373: Save language in Firebase
+import language from "./language.json";
+// Re-export the settings object
+// TODO @brown-ccv #374: Save settings in Firebase
+import settings from "./settings.json";
+import config from "./env.js";
+
+export const LANGUAGE = language;
+export const SETTINGS = settings;
+// Configuration object for Honeycomb
+export const CONFIG = config;

src/experiment/procedures/endProcedure.js

@@ -1,4 +1,4 @@
-import { config } from "../../config/main";
+import { CONFIG } from "../../config/";
 import { buildCameraEndTrial } from "../trials/camera";
 import { conclusionTrial } from "../trials/conclusion";
 import { exitFullscreenTrial } from "../trials/fullscreen";
@@ -15,7 +15,7 @@ export function buildEndProcedure(jsPsych) {
   const procedure = [];
 
   // Conditionally add the camera breakdown trials
-  if (config.USE_CAMERA) {
+  if (CONFIG.USE_CAMERA) {
     procedure.push(buildCameraEndTrial(jsPsych));
   }
 

src/experiment/procedures/honeycombProcedure.js

@@ -1,6 +1,6 @@
 import imageKeyboardResponse from "@jspsych/plugin-image-keyboard-response";
 
-import { config, SETTINGS } from "../../config/main";
+import { CONFIG, SETTINGS } from "../../config/";
 import { eventCodes } from "../../config/trigger";
 import { pdSpotEncode, photodiodeGhostBox } from "../../lib/markup/photodiode";
 import { buildFixationTrial } from "../trials/fixation";
@@ -34,7 +34,7 @@ export function buildHoneycombProcedure(jsPsych) {
     stimulus: jsPsych.timelineVariable("stimulus"),
     prompt: function () {
       // Conditionally displays the photodiodeGhostBox
-      if (config.USE_PHOTODIODE) return photodiodeGhostBox;
+      if (CONFIG.USE_PHOTODIODE) return photodiodeGhostBox;
       else return null;
     },
     // Possible choices are the correct_responses from the task settings
@@ -46,7 +46,7 @@ export function buildHoneycombProcedure(jsPsych) {
     },
     on_load: function () {
       // Conditionally flashes the photodiode when the trial first loads
-      if (config.USE_PHOTODIODE) pdSpotEncode(eventCodes.honeycomb);
+      if (CONFIG.USE_PHOTODIODE) pdSpotEncode(eventCodes.honeycomb);
     },
     // Add a boolean value ("correct") to the data - if the user responded with the correct key or not
     on_finish: function (data) {

src/experiment/procedures/startProcedure.js

@@ -1,4 +1,4 @@
-import { config } from "../../config/main";
+import { CONFIG } from "../../config/";
 
 import { buildCameraStartTrial } from "../trials/camera";
 import { enterFullscreenTrial } from "../trials/fullscreen";
@@ -22,13 +22,13 @@ export function buildStartProcedure(jsPsych) {
   const procedure = [nameTrial, enterFullscreenTrial, introductionTrial];
 
   // Conditionally add the photodiode setup trials
-  if (config.USE_PHOTODIODE) {
+  if (CONFIG.USE_PHOTODIODE) {
     procedure.push(holdUpMarkerTrial);
     procedure.push(initPhotodiodeTrial);
   }
 
   // Conditionally add the camera setup trials
-  if (config.USE_CAMERA) {
+  if (CONFIG.USE_CAMERA) {
     procedure.push(buildCameraStartTrial(jsPsych));
   }
 

src/experiment/trials/adjustVolume.js

@@ -1,5 +1,5 @@
 import htmlKeyboardResponse from "@jspsych/plugin-html-keyboard-response";
-import { LANGUAGE } from "../../config/main";
+import { LANGUAGE } from "../../config/";
 import { div, h1 } from "../../lib/markup/tags";
 
 /** Trial that prompts the user to adjust the volume on their computer */

src/experiment/trials/camera.js

@@ -2,7 +2,7 @@ import htmlKeyboardResponse from "@jspsych/plugin-html-keyboard-response";
 import htmlButtonResponse from "@jspsych/plugin-html-button-response";
 import initializeCamera from "@jspsych/plugin-initialize-camera";
 
-import { LANGUAGE, config } from "../../config/main";
+import { LANGUAGE, CONFIG } from "../../config/";
 import { div, h1, p, tag } from "../../lib/markup/tags";
 
 const WEBCAM_ID = "webcam";
@@ -44,7 +44,7 @@ export function buildCameraStartTrial(jsPsych) {
         response_ends_trial: true,
         on_start: function () {
           // Initialize and store the camera feed
-          if (!config.USE_ELECTRON) {
+          if (!CONFIG.USE_ELECTRON) {
             throw new Error("video recording is only available when running inside Electron");
           }
 
@@ -103,7 +103,7 @@ export function buildCameraEndTrial(jsPsych) {
     on_start: function () {
       // Complete the camera recording
 
-      if (!config.USE_ELECTRON) {
+      if (!CONFIG.USE_ELECTRON) {
         throw new Error("video recording is only available when running inside Electron");
       }
 

src/experiment/trials/conclusion.js

@@ -1,6 +1,6 @@
 import htmlKeyboardResponse from "@jspsych/plugin-html-keyboard-response";
 
-import { LANGUAGE } from "../../config/main";
+import { LANGUAGE } from "../../config/";
 import { h1 } from "../../lib/markup/tags";
 
 /** Trial that displays a completion message for 5 seconds */

src/experiment/trials/fixation.js

@@ -1,6 +1,6 @@
 import htmlKeyboardResponse from "@jspsych/plugin-html-keyboard-response";
 
-import { SETTINGS, config } from "../../config/main";
+import { SETTINGS, CONFIG } from "../../config/";
 import { eventCodes } from "../../config/trigger";
 import { pdSpotEncode, photodiodeGhostBox } from "../../lib/markup/photodiode";
 import { div } from "../../lib/markup/tags";
@@ -21,7 +21,7 @@ export function buildFixationTrial(jsPsych) {
     stimulus: div("", { id: "fixation-dot" }),
     prompt: function () {
       // Conditionally display the photodiodeGhostBox
-      if (config.USE_PHOTODIODE) return photodiodeGhostBox;
+      if (CONFIG.USE_PHOTODIODE) return photodiodeGhostBox;
       else return null;
     },
     trial_duration: function () {
@@ -38,7 +38,7 @@ export function buildFixationTrial(jsPsych) {
     },
     on_load: function () {
       // Conditionally flash the photodiode when the trial first loads
-      if (config.USE_PHOTODIODE) pdSpotEncode(fixationCode);
+      if (CONFIG.USE_PHOTODIODE) pdSpotEncode(fixationCode);
     },
   };
 }

src/experiment/trials/holdUpMarker.js

@@ -1,6 +1,6 @@
 import htmlButtonResponse from "@jspsych/plugin-html-button-response";
 
-import { config, LANGUAGE } from "../../config/main";
+import { CONFIG, LANGUAGE } from "../../config/";
 import { eventCodes } from "../../config/trigger";
 import { pdSpotEncode, photodiodeGhostBox } from "../../lib/markup/photodiode";
 import { div, h1, p } from "../../lib/markup/tags";
@@ -20,13 +20,13 @@ export const holdUpMarkerTrial = {
     let holdUpMarkerPrompt = p(LANGUAGE.trials.holdUpMarker);
 
     // Conditionally add the photodiodeGhostBox
-    if (config.USE_PHOTODIODE) holdUpMarkerPrompt += photodiodeGhostBox;
+    if (CONFIG.USE_PHOTODIODE) holdUpMarkerPrompt += photodiodeGhostBox;
 
     return holdUpMarkerPrompt;
   },
   choices: [LANGUAGE.prompts.continue.button],
   on_load: function () {
     // Conditionally flash the photodiode when the trial first loads
-    if (config.USE_PHOTODIODE) pdSpotEncode(eventCodes.test_connect);
+    if (CONFIG.USE_PHOTODIODE) pdSpotEncode(eventCodes.test_connect);
   },
 };

src/experiment/trials/honeycombTrials.js

@@ -2,7 +2,7 @@ import htmlKeyboardResponse from "@jspsych/plugin-html-keyboard-response";
 import instructionsResponse from "@jspsych/plugin-instructions";
 import preloadResponse from "@jspsych/plugin-preload";
 
-import { LANGUAGE, SETTINGS } from "../../config/main";
+import { LANGUAGE, SETTINGS } from "../../config/";
 import { eventCodes } from "../../config/trigger";
 import { b, div, image, p } from "../../lib/markup/tags";
 

src/experiment/trials/initPhotodiode.js

@@ -1,6 +1,6 @@
 import htmlKeyboardResponse from "@jspsych/plugin-html-keyboard-response";
 
-import { config } from "../../config/main";
+import { CONFIG } from "../../config/";
 import { eventCodes } from "../../config/trigger";
 import { pdSpotEncode, photodiodeGhostBox } from "../../lib/markup/photodiode";
 
@@ -10,10 +10,10 @@ export const initPhotodiodeTrial = {
   trial_duration: 1600,
   stimulus: photodiodeGhostBox,
   on_load: function () {
-    if (!config.USE_ELECTRON) {
+    if (!CONFIG.USE_ELECTRON) {
       throw new Error("photodiode recording is only available when running inside Electron");
     }
-    if (!config.USE_PHOTODIODE) {
+    if (!CONFIG.USE_PHOTODIODE) {
       console.warn("photodiode trial was run but USE_PHOTODIODE is set to false ");
     }
 

src/experiment/trials/introduction.js

@@ -1,6 +1,6 @@
 import htmlKeyboardResponse from "@jspsych/plugin-html-keyboard-response";
 
-import { LANGUAGE } from "../../config/main";
+import { LANGUAGE } from "../../config/";
 import { div, p, h1 } from "../../lib/markup/tags";
 
 /** Task that displays a introduction message with the photodiode ghost box */

src/experiment/trials/name.js

@@ -1,6 +1,6 @@
 import htmlKeyboardResponse from "@jspsych/plugin-html-keyboard-response";
 
-import { LANGUAGE } from "../../config/main";
+import { LANGUAGE } from "../../config/";
 import { h1 } from "../../lib/markup/tags";
 
 /** Task that displays the name of the experiment */

src/experiment/trials/survey.js

@@ -1,6 +1,6 @@
 import jsPsychSurveyPlugin from "@jspsych/plugin-survey";
 
-import { LANGUAGE } from "../../config/main";
+import { LANGUAGE } from "../../config/";
 
 // The survey plugin includes additional styling
 import "@jspsych/plugin-survey/css/survey.css";

src/lib/markup/photodiode.js

@@ -1,4 +1,4 @@
-import { config } from "../../config/main";
+import { CONFIG } from "../../config/";
 import { div, span } from "./tags";
 
 // TODO @brown-ccv #329: Refactor photodiode logic to be a custom jsPsych extension
@@ -22,11 +22,11 @@ export const photodiodeGhostBox = div(span("", { id: SPOT_ID }), { id: BOX_ID })
  * @param {number} taskCode The unique code for the given trial on which this function executes
  */
 export function pdSpotEncode(taskCode) {
-  if (!config.USE_ELECTRON) {
+  if (!CONFIG.USE_ELECTRON) {
     throw new Error("photodiodeSpot trial is only available when running inside Electron");
   }
 
-  if (config.USE_PHOTODIODE) {
+  if (CONFIG.USE_PHOTODIODE) {
     // TODO @brown-ccv #333: Get blink time from config.json (equipment.trigger_box.event_codes) (40ms is the default)
     const blinkTime = 40;
     // TODO @brown-ccv #354: Gen numBlinks from config.json (equipment.trigger_box.event_codes) (40ms is the default)