Persist provenance as separate assets

Author: JackWilb

src/storage/engines/types.ts

@@ -1453,12 +1453,24 @@ export abstract class StorageEngine {
     return this.parseProvenanceStorageObject(provenanceObject);
   }
 
+  async deleteProvenance(taskName: string) {
+    if (!this.currentParticipantId || !this.studyId) {
+      return;
+    }
+    try {
+      await this._deleteFromStorage(`provenance/${this.currentParticipantId}`, taskName);
+    } catch (error) {
+      console.warn(`Failed to delete provenance for task ${taskName}:`, error);
+    }
+  }
+
   async saveProvenance(
     provenanceGraph: StoredProvenance | null | undefined,
     taskName: string,
   ) {
     const provenanceToSave = normalizeStoredProvenance(provenanceGraph);
     if (!provenanceToSave) {
+      await this.deleteProvenance(taskName);
       return undefined;
     }
 

src/storage/tests/highLevel.spec.ts

@@ -840,6 +840,49 @@ describe.each([
     });
   });
 
+  test('saveProvenance with null/undefined deletes existing provenance asset', async () => {
+    storageEngine = new LocalStorageEngine(true);
+    await storageEngine.connect();
+    await storageEngine.initializeStudyDb(studyId);
+    sequenceArray = await generateSequenceArray(configSimple);
+    const participantSession = await storageEngine.initializeParticipantSession({}, configSimple, participantMetadata);
+    const identifier = 'intro_0';
+
+    // First, save a provenance asset
+    const provenanceGraph = {
+      root: 'root',
+      nodes: {
+        root: {
+          id: 'root',
+          createdOn: 10,
+          children: [],
+        },
+      },
+    };
+    await storageEngine.saveProvenance({
+      aboveStimulus: undefined,
+      belowStimulus: undefined,
+      sidebar: undefined,
+      stimulus: provenanceGraph,
+    }, identifier);
+
+    // Verify it was saved
+    let storedProvenance = await storageEngine.getProvenance(identifier, participantSession.participantId);
+    expect(storedProvenance).toEqual({
+      aboveStimulus: undefined,
+      belowStimulus: undefined,
+      sidebar: undefined,
+      stimulus: provenanceGraph,
+    });
+
+    // Now save with null — should delete the existing asset
+    await storageEngine.saveProvenance(null, identifier);
+
+    // Verify it was deleted
+    storedProvenance = await storageEngine.getProvenance(identifier, participantSession.participantId);
+    expect(storedProvenance).toBeNull();
+  });
+
   test('saveAnswers coalesces to the latest answer and finalizeParticipant persists completion after delayed writes', async () => {
     storageEngine = new DelayedLocalStorageEngine(true);
     await storageEngine.connect();

src/store/hooks/useNextStep.ts

@@ -90,18 +90,26 @@ export function useNextStep() {
           timedOut: !collectData,
         };
         const answersToPersist = { ...answers, [identifier]: toSave };
-        const handleResponsePersistenceError = (error: unknown) => {
-          console.error('Failed to save participant response data', error);
-          showNotification({
-            title: 'Failed to Save Response',
-            message: 'Your response could not be saved. Please check your connection and try again.',
-            color: 'red',
-          });
-        };
 
         if (storageEngine) {
-          storageEngine.saveAnswers(answersToPersist).catch(handleResponsePersistenceError);
-          storageEngine.saveProvenance(provenanceGraph, identifier).catch(handleResponsePersistenceError);
+          storageEngine.saveAnswers(answersToPersist).catch((error) => {
+            console.error('Failed to save participant response data', error);
+            showNotification({
+              title: 'Failed to Save Response',
+              message: 'Your response could not be saved. Please check your connection and try again.',
+              color: 'red',
+            });
+          });
+          if (provenanceGraph) {
+            storageEngine.saveProvenance(provenanceGraph, identifier).catch((error) => {
+              console.error('Failed to save participant response data', error);
+              showNotification({
+                title: 'Failed to Save Response',
+                message: 'Your response could not be saved. Please check your connection and try again.',
+                color: 'red',
+              });
+            });
+          }
         }
 
         storeDispatch(