Series terminate predicate receives serialized Date and Set values instead of the item's data #1683

Activity

1. joshunrau

   added

   BugType: existing behavior is wrongType: existing behavior is wrong

   Priority: MediumReal value; schedule normallyReal value; schedule normally

   Difficulty: LowIsolated change, about 2 hours or lessIsolated change, about 2 hours or less

   Area: SharedCross-tier packages (schemas, react-core, etc.) not covered by another areaCross-tier packages (schemas, react-core, etc.) not covered by another area

   on Oct 7, 2026
2. joshunrau commented on Oct 26, 2026

   

   joshunrau

   on Oct 26, 2026

   CollaboratorAuthor

   More actions

   Still reproduces on main (d86740e). SeriesInstrumentRenderer.tsx:80-97 is unchanged. No commit or open PR has touched InstrumentRenderer/ since this was filed.

   Fix

   • Take the first suggestion and drop the reviver alternative. For a FORM item, data is already the output of libui's validationSchema.safeParseAsync(values) (libui 6.16.1, src/components/Form/Form.tsx:134, passed to onSubmit at :152), so its Date and Set values are real. For an INTERACTIVE item it is the $Json-parsed payload (InteractiveContent.tsx:79), which holds neither type and comes through the replacer unchanged. So data is correct for both kinds. Rename parsedData to serializedData, the name ScalarInstrumentRenderer.tsx:68 uses.
   • This is the only call site. The scalar renderer already gives its summary the raw data (ScalarInstrumentRenderer.tsx:89), nothing under apps/ calls a series' terminate, and web and gateway both render series through this component.
   • A predicate that throws for any other reason still leaves Submit dead, e.g. data.visitDate.getFullYear() on an optional date the subject left empty. Wrap the call: console.error the error, show an error notification in en, es and fr, and return without calling onSubmit, as the validation branch at :82-93 does. Do not treat a throw as false. In a consent gate like DNP_HAPPINESS_QUESTIONNAIRE_WITH_CONSENT, that would administer the items the predicate exists to skip.

   Tests

   • Unit: the existing terminate tests (SeriesInstrumentRenderer.test.tsx:361-390) submit only strings, which survive the replacer. For the new test, put a Date and a Set in the item's initialValues. libui's getInitialValues passes them through, so fireEvent.submit needs no date picker. Assert that complete follows the predicate and that onSubmit still receives the tagged form. Add a second test where terminate throws: a notification appears and onSubmit is not called.
   • e2e: no seeded instrument can drive this. The only built-in terminate (DNP_HAPPINESS_QUESTIONNAIRE_WITH_CONSENT/index.ts:48) reads a boolean, and POST /instruments/series takes no params ($CreateSeriesInstrumentData, packages/schemas/src/instrument/instrument.base.ts:276-291).
     1. Add an ApiClient method that posts { bundle } to /instruments. Only authorization.spec.ts:402 posts there today. Interactive instruments in a series ignore their language-select, language-lock, toggle and fullscreen options #1686 needs the same helper, and the comment there sets out the ways to build the bundle.
     2. Upload a hand-written FORM with a date field, then a two-item SERIES whose terminate reads that date. Put uniqueId in the form's internal.name, since its id is a hash of name and edition, and in the series title the spec clicks. Load zod through the __import preamble, as compiled bundles do (packages/instrument-bundler/src/bundle.ts:12-18). The API validates uploads against $AnyInstrument (instruments.service.ts:102), so the bundles need every required field.
     3. Call isolatedGroupManager() after the uploads, because api.createGroup grants only the instruments that exist when it runs (api-client.ts:70). Then build page objects with new StartSessionPage(page) and their own goto, as datahub.spec.ts:190 does. getPageModel would re-authenticate as actingRole, whose cached group predates the uploads.
     4. Enter a mid-year date such as 1999-06-01 and expect seriesCompletionHeading after the first item. libui's DateField stores UTC midnight (DateField.tsx:27), so a January 1 date can land in the previous year west of UTC.

   Landing

   #1686 and #1813 change other hunks of this file, so order does not matter. #1673 and #1668 rewrite this createSubmitHandler. With #1673, the new catch should return { success: false, errorMessage }, as the validation branch will, so libui shows the error and does not empty a resetButton form. #1668's in-flight guard must not be held when the catch returns, so set it after validation and terminate, or clear it in the catch. Otherwise a throwing predicate locks Submit for good. #1723 is the same replacer/reviver mismatch on the API side.

   _{Triage note written with Claude Code. Code references point at main @ d86740e.}