Include question ID in JSON exports of health check retros, fix group being ignored on import

Author: davidje13

backend/src/export/RetroJsonExport.ts

@@ -11,6 +11,7 @@ import type {
   CurveCubicBezier,
   Colour,
 } from '../shared/api-entities';
+import { getQuestionID, makeUserAnswerID } from '../shared/health';
 
 type MaybeAsyncIterable<T> = Iterable<T> | AsyncIterable<T>;
 
@@ -34,6 +35,7 @@ export interface RetroItemJsonExport {
   created: string;
   category: string;
   group?: string | undefined;
+  for?: string | undefined;
   message: string;
   votes: number;
   completed?: string | undefined;
@@ -141,14 +143,17 @@ function importRetroItemAttachment(
   }
 }
 
-function exportRetroItem(item: RetroItem): RetroItemJsonExport {
+function exportRetroItem(item: RetroItem, format: string): RetroItemJsonExport {
   const result: RetroItemJsonExport = {
     created: exportTimestamp(item.created),
     category: item.category,
     group: item.group,
     message: item.message,
     votes: item.votes,
   };
+  if (format === 'health') {
+    result.for = getQuestionID(item);
+  }
   if (item.doneTime > 0) {
     result.completed = exportTimestamp(item.doneTime);
   }
@@ -158,9 +163,12 @@ function exportRetroItem(item: RetroItem): RetroItemJsonExport {
   return result;
 }
 
-function importRetroItem(item: RetroItemJsonExport): RetroItem {
+function importRetroItem(item: RetroItemJsonExport, format: string): RetroItem {
   return {
-    id: randomUUID(),
+    id:
+      format === 'health' && item.for
+        ? makeUserAnswerID(item.for, randomUUID())
+        : randomUUID(),
     created: importTimestamp(item.created),
     category: item.category,
     group: item.group,
@@ -193,21 +201,21 @@ function importRetroHistoryItem(
   };
 }
 
-function exportRetroData(archive: RetroData): RetroDataJsonExport {
+function exportRetroData(retro: RetroData): RetroDataJsonExport {
   return {
-    format: archive.format,
-    options: archive.options,
-    items: archive.items.map(exportRetroItem),
-    history: archive.history.map(exportRetroHistoryItem),
+    format: retro.format,
+    options: retro.options,
+    items: retro.items.map((item) => exportRetroItem(item, retro.format)),
+    history: retro.history.map(exportRetroHistoryItem),
   };
 }
 
-export function importRetroDataJson(archive: RetroDataJsonExport): RetroData {
+export function importRetroDataJson(retro: RetroDataJsonExport): RetroData {
   return {
-    format: archive.format,
-    options: archive.options,
-    items: archive.items.map(importRetroItem),
-    history: archive.history?.map(importRetroHistoryItem) ?? [],
+    format: retro.format,
+    options: retro.options,
+    items: retro.items.map((item) => importRetroItem(item, retro.format)),
+    history: retro.history?.map(importRetroHistoryItem) ?? [],
   };
 }
 

backend/src/helpers/exportedJsonParsers.ts

@@ -29,6 +29,8 @@ export const extractExportedColour = json.exactObject({
 export const extractExportedRetroItem = json.object<RetroItemJsonExport>({
   created: jsonIsoDate,
   category: json.string,
+  group: json.optional(json.string),
+  for: json.optional(json.string),
   message: json.string,
   votes: json.number,
   completed: json.optional(jsonIsoDate),

backend/src/routers/openapi.ts

@@ -1536,6 +1536,12 @@ export const openapi = Buffer.from(
                   "The type of the item. The meaning of this will vary depending on the type of retro, but 'action' is a common category denoting Action Items.",
                 example: 'happy',
               },
+              for: {
+                type: 'string',
+                description:
+                  'For health check retros, this is the question ID associated with this answer.',
+                example: 'learning',
+              },
               message: {
                 type: 'string',
                 description: 'The user-provided content of the item.',

backend/src/shared/health.ts

@@ -18,6 +18,11 @@ interface AnswersSummary {
   counts: Counts;
 }
 
+export const getQuestionID = (item: RetroItem) => item.id.split(':')[0]!;
+
+export const makeUserAnswerID = (questionID: string, userID: string) =>
+  `${questionID}:${userID}`;
+
 export function summariseHealthVotes(
   retroItems: RetroItem[],
 ): HealthSummary | null {
@@ -28,7 +33,7 @@ export function summariseHealthVotes(
     if (item.category === 'action') {
       continue;
     }
-    const questionID = item.id.split(':')[0]!;
+    const questionID = getQuestionID(item);
     let answer = answers.get(questionID);
     if (!answer) {
       answer = { id: questionID, counts: { ...ZERO_COUNTS } };

frontend/src/actions/healthRetro.ts

@@ -1,5 +1,9 @@
 import type { Retro, RetroItem } from '../shared/api-entities';
-import type { AnswerID, HealthSummary } from '../shared/health';
+import {
+  makeUserAnswerID,
+  type AnswerID,
+  type HealthSummary,
+} from '../shared/health';
 import type { Spec } from '../api/reducer';
 import { setRetroState } from './retro';
 
@@ -24,9 +28,6 @@ export const addHistoricSummary = (summary: HealthSummary): Spec<Retro>[] => [
   { history: ['push', summary] },
 ];
 
-export const makeUserAnswerID = (questionID: string, userID: string) =>
-  `${questionID}:${userID}`;
-
 export const answerQuestion = (
   group: string | undefined,
   questionID: string,

frontend/src/components/guidance/Preview.tsx

@@ -6,7 +6,7 @@ import type {
   Retro,
   RetroItem,
 } from '../../shared/api-entities';
-import type { AnswerID } from '../../shared/health';
+import { makeUserAnswerID, type AnswerID } from '../../shared/health';
 import { classNames } from '../../helpers/classNames';
 import { useWindowSize, type Size } from '../../hooks/env/useWindowSize';
 import type { Spec } from '../../api/reducer';
@@ -130,7 +130,10 @@ export const answerHealth = (
     delay: (animate ? 1700 : 0) + delayAnswer,
     spec: {
       localState: {
-        [`health-message:${questionID}:${userID}`]: ['=', '...' + message],
+        [`health-message:${makeUserAnswerID(questionID, userID)}`]: [
+          '=',
+          '...' + message,
+        ],
       },
     },
   },
@@ -140,7 +143,7 @@ export const answerHealth = (
       items: [
         'push',
         {
-          id: `${questionID}:${userID}`,
+          id: makeUserAnswerID(questionID, userID),
           category: answerID,
           message,
           created: 0,
@@ -170,7 +173,7 @@ export const addHealthAnswers = (
     'push',
     ...Object.entries(allAnswers).flatMap(([userID, answers]) =>
       answers.map(([questionID, answerID, message = '']) => ({
-        id: `${questionID}:${userID}`,
+        id: makeUserAnswerID(questionID, userID),
         category: answerID,
         message,
         created: 0,

frontend/src/components/retro-formats/health/questions/Questions.tsx

@@ -1,13 +1,12 @@
 import { useLayoutEffect, type FunctionComponent } from 'react';
 import { Link } from 'wouter';
 import type { RetroItem } from '../../../../shared/api-entities';
-import type { AnswerID } from '../../../../shared/health';
+import { makeUserAnswerID, type AnswerID } from '../../../../shared/health';
 import { startViewTransition } from '../../../../helpers/viewTransition';
 import { classNames } from '../../../../helpers/classNames';
 import { useStateMap } from '../../../../hooks/useStateMap';
 import {
   getQuestionProgress,
-  makeUserAnswerID,
   type HealthQuestion,
 } from '../../../../actions/healthRetro';
 import { Examples } from '../common/Examples';

frontend/src/shared/health.ts

@@ -18,6 +18,11 @@ interface AnswersSummary {
   counts: Counts;
 }
 
+export const getQuestionID = (item: RetroItem) => item.id.split(':')[0]!;
+
+export const makeUserAnswerID = (questionID: string, userID: string) =>
+  `${questionID}:${userID}`;
+
 export function summariseHealthVotes(
   retroItems: RetroItem[],
 ): HealthSummary | null {
@@ -28,7 +33,7 @@ export function summariseHealthVotes(
     if (item.category === 'action') {
       continue;
     }
-    const questionID = item.id.split(':')[0]!;
+    const questionID = getQuestionID(item);
     let answer = answers.get(questionID);
     if (!answer) {
       answer = { id: questionID, counts: { ...ZERO_COUNTS } };