Study Condition in URL by jaykim1213 · Pull Request #1023 · revisit-studies/study

jaykim1213 · 2026-01-30T16:10:59Z

Does this PR close any open issues?

Closes #799

Give a longer description of what this PR addresses and why it's needed

Add study condition in URL
Add selecting study condition and copying study links from the landing page
Add demo-condition
Support multiple conditions (comma separated)
/path/to/study?condition=color,size
Add condition to tidy download
Add condition filter in analysis page
Add condition in the sidebar

"sequence": {
    "order": "fixed",
    "components": [
      "introduction",
      {
        "id": "color",
        "conditional": true,
        "components": [
          "color-trial-1",
          "color-trial-2"
        ],
        "order": "random"
      },
      {
        "id": "shape",
        "conditional": true,
        "components": [
          "shape-trial-1",
          "shape-trial-2"
        ],
        "order": "fixed"
      }
    ]
  }

These would then be accessed via a query param:

/path/to/study?condition=size
/path/to/study?condition=color
/path/to/study?condition=size,color

The effect would be that blocks that don't match the condition specified in the query param would be ignored. So all blocks with no condition will be included, all blocks with the matching condition as well.

Provide pictures/videos of the behavior before and after these changes (optional)

Live demo:
https://revisit.dev/study/PR1023
https://revisit.dev/study/PR1023/demo-condition?condition=color

Landing page

Study

Analysis

Are there any additional TODOs before this PR is ready to go?

TODOs:

Update relevant documentation

github-actions · 2026-01-30T16:11:11Z

🪓 PR closed, deleted preview.

Copilot

Pull request overview

This PR implements study conditions in URL query parameters, allowing researchers to define multiple experimental conditions within a single study configuration and select which condition to run via a URL parameter (e.g., ?condition=color). This addresses issue #799 by enabling condition-based filtering of study sequences without requiring duplicate study configurations.

Changes:

Added condition field to ComponentBlock and DynamicBlock types and schemas to mark conditional blocks
Implemented condition filtering utilities (parseConditionParam, filterSequenceByCondition, getSequenceConditions, getConditionParticipantCounts)
Modified sequence generation and storage to support condition-based filtering
Updated UI components to display and select conditions (ConfigSwitcher landing page with dropdown)
Preserved search parameters across navigation to maintain condition context
Added demo-condition study showcasing color, size, and shape condition variants

Reviewed changes

Copilot reviewed 28 out of 28 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
src/utils/handleSequenceConditions.ts	New utility module for parsing, filtering, and analyzing conditions in sequences
src/utils/handleSequenceConditions.spec.ts	Comprehensive test coverage for condition parsing and filtering functions
src/storage/engines/types.ts	Modified sequence generation logic to handle conditions; added updateParticipantSearchParams method
src/utils/handleRandomSequences.tsx	Updated to preserve condition field when converting ComponentBlocks to Sequences
src/utils/getSequenceFlatMap.ts	Added condition field preservation in path mapping
src/store/types.ts	Added optional condition field to Sequence interface
src/parser/types.ts	Added condition field to ComponentBlock and DynamicBlock interfaces with documentation
src/parser/StudyConfigSchema.json	Added condition property to ComponentBlock and DynamicBlock schemas
src/parser/LibraryConfigSchema.json	Added condition property to library schemas
src/components/Shell.tsx	Implemented condition filtering and handling for participant sessions
src/components/ConfigSwitcher.tsx	Added condition selector dropdown with participant counts per condition
src/components/interface/StepsPanel.tsx	Preserved search params in navigation
src/controllers/ComponentController.tsx	Preserved search params when auto-forwarding participants
src/utils/useNavigateToTrial.tsx	Added searchParams parameter to preserve condition when opening trials
src/analysis/individualStudy/thinkAloud/ThinkAloudFooter.tsx	Preserved participant search params in replay links
src/analysis/individualStudy/table/TableView.tsx	Added conditional Condition column when participants have conditions
src/analysis/individualStudy/replay/SingleTask.tsx	Added searchParams to task replay navigation
src/analysis/individualStudy/replay/AllTasksTimeline.tsx	Passed participant searchParams to SingleTask components
public/global.json	Registered demo-condition study
public/demo-condition/config.json	Demo study configuration with three conditions (color, size, shape)
public/demo-condition/assets/*	HTML and markdown assets for demo trials

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

JackWilb

Some thoughts

JackWilb · 2026-02-03T00:58:20Z

+    if (hasConditions && config) {
+      // Generate fresh sequences and filter for this participant's condition
+      const fullSequenceArray = generateSequenceArray(config);
+      sequenceArray = fullSequenceArray.map((seq) => filterSequenceByCondition(seq, activeCondition));


Is it possible that we don't generate a sequence with the requested condition if the config is large enough?

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Added reminder for participants to proceed correctly.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 29 out of 29 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-12T20:01:50Z

+        const matchingSequence = studyCondition
+          ? generatedSequences.find(
+            (sequence) => getSequenceConditions(sequence).includes(studyCondition),
+          )
+          : generatedSequences[0];


The fallback logic for finding a matching sequence when studyCondition is specified is incorrect. The code looks for a sequence that contains the specified condition using getSequenceConditions, but it should instead filter the selected sequence using filterSequenceByCondition.

Currently, if a condition is specified in the URL but an error occurs, the fallback will try to find a pre-generated sequence that happens to include that condition. However, this doesn't apply the condition filtering logic and may include all conditional blocks instead of just the matching ones.

The correct approach would be to select a sequence (e.g., generatedSequences[0]) and then apply filterSequenceByCondition to it, similar to how it's done in the success path at line 148.

Updated it to filter using filterSequenceByCondition

const matchingSequence = generatedSequences[0]; const fallbackSequence = filterSequenceByCondition( matchingSequence, studyCondition, );

JackWilb

Some questions

JackWilb · 2026-02-12T19:58:43Z

          >
            <g>
-              <SingleTask incomplete={answer.startTime === 0} isCorrect={isCorrect} hasCorrect={hasCorrect} key={name} labelHeight={currentHeight * LABEL_GAP} height={maxHeight} name={name} xScale={scale} scaleStart={scaleStart} scaleEnd={scaleEnd} trialOrder={answer.trialOrder} participantId={participantData.participantId} studyId={studyId} />
+              <SingleTask incomplete={answer.startTime === 0} isCorrect={isCorrect} hasCorrect={hasCorrect} key={name} labelHeight={currentHeight * LABEL_GAP} height={maxHeight} name={name} xScale={scale} scaleStart={scaleStart} scaleEnd={scaleEnd} trialOrder={answer.trialOrder} participantId={participantData.participantId} studyId={studyId} condition={participantData.searchParams?.condition} />


Are there any issues with using participantData.searchParams here? Does this work on refresh? What if I switch to a different condition? How are the searchParams updated for a participant? They shouldn't be able to change conditions in a study, but we should be able to in dev.

Add a studyCondition with the ParticipantData in storage types.ts so it also works when it's refreshed since it's saved in the storage

Add if the mode is developmentModeEnabled, allow updating condition

JackWilb · 2026-02-12T20:02:36Z

+                      {!isComponent && conditional && (
+                        <Badge size="xs" ml={5} variant="transparent">{label}</Badge>
+                      )}


Do we need this with the new logic in the sequence?

Use icon and tooltip instead of a badge

JackWilb · 2026-02-12T20:05:02Z

+            ...participantSession.searchParams,
+            condition: studyCondition,
+          };
+          await storageEngine.updateParticipantSearchParams(updatedSearchParams);


Does this let a participant change conditions mid way through a study?

It will not update the condition unless in devMode

types.ts

async updateStudyCondition(condition: string | string[]) { ... const modes = await this.getModes(this.studyId); if (!modes.developmentModeEnabled) { throw new Error('Cannot update study condition when development mode is disabled'); } ... }

JackWilb · 2026-02-13T16:46:03Z

Moving the stored data
Gating the ability to change behind devMode
Expand the test to make sure we can't change unless we're in devMode
Study stage to tidy download
Multi select on study card, multi select in study browser
Show condition on all rows for participant in tidy download
Double check nested conditions

# Conflicts: # src/components/ConfigSwitcher.tsx # src/components/downloader/DownloadTidy.tsx

jaykim1213 · 2026-02-20T16:41:55Z

Default not selectable in multi select dropdown

Copilot

Pull request overview

Copilot reviewed 32 out of 32 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 38 out of 38 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

jaykim1213 added 6 commits January 27, 2026 16:34

Add condition in component block

45d57bb

Add demo condition

5d876da

Add demo condition study

2e11a8a

Add condition to dynamic blocks

f435d92

Add condition url param to work

7fe941f

Fix lint warning

c8a78e4

JackWilb linked an issue Jan 30, 2026 that may be closed by this pull request

Top Level Flag for Study Condition in URL #799

Closed

jaykim1213 added 4 commits January 30, 2026 12:39

Add supporting multiple query param

502b046

Add shape component to demo condition

81a1aea

Update shape components in demo condition

a7ad4cf

Update replay to reflect study condition

ab5c0a7

jaykim1213 added this to the v2.4 milestone Jan 30, 2026

jaykim1213 added 3 commits January 30, 2026 16:19

Fix help message

d98ac1e

Allow multple params in condition

b6cc0d0

Fix yarn errors

c8a52e7

jaykim1213 marked this pull request as ready for review February 2, 2026 21:49

JackWilb requested a review from Copilot February 3, 2026 00:42

Copilot started reviewing on behalf of JackWilb February 3, 2026 00:42 View session

Copilot AI reviewed Feb 3, 2026

View reviewed changes

JackWilb reviewed Feb 3, 2026

View reviewed changes

JackWilb and others added 9 commits February 2, 2026 18:06

Update public/demo-condition/assets/color-trial-2.html

c187796

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update public/demo-condition/assets/color-trial-2.html

5fcdec7

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Add reminder for using 'Next Participant' in demo

2a9df00

Added reminder for participants to proceed correctly.

Fix maintaining latin square balance

8cca209

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Fix double filtering

dd30027

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Refactor condition handling in sequence filtering

40ab4a1

Refactor study condition

492e418

Add filtering recursively

80b28b5

Fix condition test

59e850b

JackWilb requested a review from Copilot February 12, 2026 19:56

Copilot started reviewing on behalf of JackWilb February 12, 2026 19:57 View session

Copilot AI reviewed Feb 12, 2026

View reviewed changes

JackWilb reviewed Feb 12, 2026

View reviewed changes

Add demo condition test

4b86a13

jaykim1213 added 2 commits February 17, 2026 16:59

Address PR comment

49c122b

Address PR comments

b2d24ea

jaykim1213 removed this from the v2.4 milestone Feb 19, 2026

jaykim1213 mentioned this pull request Feb 20, 2026

Add tests #1017

Merged

13 tasks

Merge branch 'dev' into jk/studyConditionURL

3e6a9f6

# Conflicts: # src/components/ConfigSwitcher.tsx # src/components/downloader/DownloadTidy.tsx

JackWilb requested review from JackWilb and Copilot February 20, 2026 16:36

Copilot started reviewing on behalf of JackWilb February 20, 2026 16:37 View session

Copilot AI reviewed Feb 20, 2026

View reviewed changes

Comment thread src/storage/engines/types.ts

JackWilb added 6 commits February 20, 2026 10:10

Add default condition handling in getConditionData method

3fb09a5

Fix sequence filtering to prefer persisted participant conditions

2474839

Reset analysis condition filter when options change

f99a391

Optimize condition analytics via sequence assignments

29613cf

Preserve query params across timeout and training redirects

7bb6e85

Encode replay query params when navigating to trials

92fa9a7

JackWilb requested a review from Copilot February 20, 2026 19:47

Copilot started reviewing on behalf of JackWilb February 20, 2026 19:48 View session

Copilot AI reviewed Feb 20, 2026

View reviewed changes

Comment thread src/components/Shell.tsx

Comment thread src/analysis/individualStudy/table/TableView.tsx Outdated

Comment thread src/storage/engines/types.ts Outdated

JackWilb added 2 commits February 20, 2026 13:24

Fix issues from code review

b9891fb

Add test for condition persistence after reload

7f4ec65

JackWilb approved these changes Feb 20, 2026

View reviewed changes

jaykim1213 merged commit e908906 into dev Feb 20, 2026
6 of 8 checks passed

jaykim1213 deleted the jk/studyConditionURL branch February 20, 2026 20:56

Conversation

jaykim1213 commented Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Does this PR close any open issues?

Give a longer description of what this PR addresses and why it's needed

Provide pictures/videos of the behavior before and after these changes (optional)

Landing page

Study

Analysis

Are there any additional TODOs before this PR is ready to go?

Uh oh!

github-actions Bot commented Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JackWilb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

JackWilb Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

jaykim1213 Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JackWilb left a comment

Choose a reason for hiding this comment

Uh oh!

JackWilb Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

jaykim1213 Feb 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JackWilb Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

jaykim1213 Feb 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JackWilb Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

jaykim1213 Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

JackWilb commented Feb 13, 2026 • edited by jaykim1213 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jaykim1213 commented Feb 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

jaykim1213 commented Jan 30, 2026 •

edited

Loading

github-actions Bot commented Jan 30, 2026 •

edited

Loading

jaykim1213 Feb 13, 2026 •

edited

Loading

jaykim1213 Feb 13, 2026 •

edited

Loading

JackWilb commented Feb 13, 2026 •

edited by jaykim1213

Loading

jaykim1213 commented Feb 20, 2026 •

edited

Loading