Add support for different seed profiles (#257)

Author: edwardhorsford

app.js

@@ -19,7 +19,8 @@ const viewsPath = [
 
 const entryPoints = [
   'app/assets/sass/main.scss',
-  'app/assets/javascript/*.js'
+  'app/assets/javascript/*.js',
+  'app/data/generated/**/*.json'
 ]
 
 async function init() {

app/assets/javascript/main.js

@@ -95,6 +95,19 @@ document.addEventListener('DOMContentLoaded', () => {
   // Handle reset data in background
   setupResetSessionLink()
 
+  // Reading workflow: auto-dismiss the opinion banner after a delay
+  const opinionBanner = document.querySelector('[data-reading-opinion-banner]')
+  if (opinionBanner) {
+    const delay = parseInt(opinionBanner.dataset.autoCloseDelay, 10) || 3000
+    setTimeout(() => {
+      opinionBanner.classList.add('app-reading-opinion-banner--fade-out')
+      // Remove from DOM after the CSS transition (0.2s) completes
+      opinionBanner.addEventListener('transitionend', () => {
+        opinionBanner.remove()
+      }, { once: true })
+    }, delay)
+  }
+
   // Reading workflow: delay initial opinion controls to prevent premature clicks
   // When first arriving on a case, users should be prevented from giving an opinion for a period of time. On NBSS this is 30 seconds, but for the prototype is set to 5 seconds to avoid being annoying whilst testing.
   const opinionForm = document.querySelector('[data-reading-opinion-form]')

app/data/session-data-defaults.js

@@ -14,6 +14,11 @@ const { needsRegeneration } = require('../lib/utils/regenerate-data')
 const config = require('../config')
 const repeatReasons = require('./repeat-reasons')
 const symptomTypes = require('./symptom-types')
+const {
+  DEFAULT_SEED_DATA_PROFILE,
+  SEED_DATA_PROFILES,
+  createSeedProfilesState
+} = require('../lib/generators/seed-profiles')
 
 // Check if generated data folder exists and create if needed
 const generatedDataPath = path.join(__dirname, 'generated')
@@ -26,6 +31,7 @@ let clinics = []
 let events = []
 let generationInfo = {
   generatedAt: 'Never',
+  seedDataProfile: DEFAULT_SEED_DATA_PROFILE,
   stats: { participants: 0, clinics: 0, events: 0 }
 }
 
@@ -39,16 +45,33 @@ if (fs.existsSync(generationInfoPath)) {
   }
 }
 
+if (!generationInfo.seedDataProfile) {
+  generationInfo.seedDataProfile = DEFAULT_SEED_DATA_PROFILE
+}
+
+if (!SEED_DATA_PROFILES[generationInfo.seedDataProfile]) {
+  generationInfo.seedDataProfile = DEFAULT_SEED_DATA_PROFILE
+}
+
 // Generate or load data
 if (needsRegeneration(generationInfo)) {
   console.log('Generating new seed data...')
-  require('../lib/generate-seed-data.js')()
+  require('../lib/generate-seed-data.js')({
+    seedDataProfile: generationInfo.seedDataProfile
+  })
 
-  // Save generation info
-  fs.writeFileSync(
-    generationInfoPath,
-    JSON.stringify({ generatedAt: new Date().toISOString() })
-  )
+  // Reload generation info written by the generator
+  if (fs.existsSync(generationInfoPath)) {
+    try {
+      generationInfo = JSON.parse(fs.readFileSync(generationInfoPath))
+    } catch (err) {
+      console.warn('Error reading generation info after regeneration:', err)
+    }
+  }
+
+  if (!generationInfo.seedDataProfile) {
+    generationInfo.seedDataProfile = DEFAULT_SEED_DATA_PROFILE
+  }
 }
 
 // Load generated data
@@ -65,6 +88,10 @@ const defaultSettings = {
   debugMode: 'false',
   showEnvironmentBanner: 'true',
   mammogramViewOrder: 'cc-first', // 'cc-first' | 'mlo-first'
+  seedProfiles: {
+    ...createSeedProfilesState(),
+    selectedKey: generationInfo.seedDataProfile
+  },
   screening: {
     confirmIdentityOnCheckIn: 'true',
     manualImageCollection: 'true',

app/lib/generate-seed-data.js

@@ -14,6 +14,7 @@ const { generateClinicsForBSU } = require('./generators/clinic-generator')
 const { generateEvent } = require('./generators/event-generator')
 const { getCurrentRiskLevel } = require('./utils/participants')
 const { generateReadingData } = require('./generators/reading-generator')
+const { getSeedDataProfile } = require('./generators/seed-profiles')
 
 const riskLevels = require('../data/risk-levels')
 
@@ -105,7 +106,8 @@ const generateClinicsForDay = (
   usedParticipantsInSnapshot,
   indices,
   testScenarioParticipantIds = new Set(),
-  unitEvents = []
+  unitEvents = [],
+  seedDataProfile
 ) => {
   const clinics = []
   const events = []
@@ -182,7 +184,8 @@ const generateClinicsForDay = (
         outcomeWeights: config.screening.outcomes[firstClinic.clinicType],
         forceStatus: scenario.participant.config.scheduling.status,
         specialAppointmentOverride:
-          scenario?.participant?.config?.specialAppointment
+          scenario?.participant?.config?.specialAppointment,
+        seedDataProfile
       })
 
       events.push(event)
@@ -254,7 +257,8 @@ const generateClinicsForDay = (
           participant,
           clinic,
           outcomeWeights: config.screening.outcomes[clinic.clinicType],
-          forceInProgress: shouldBeInProgress
+          forceInProgress: shouldBeInProgress,
+          seedDataProfile
         })
 
         if (shouldBeInProgress) {
@@ -286,11 +290,18 @@ const generateSnapshotPeriod = (startDate, numberOfDays) => {
   )
 }
 
-const generateData = async () => {
+const generateData = async (options = {}) => {
+  const selectedSeedDataProfile =
+    options.seedDataProfileObject || getSeedDataProfile(options.seedDataProfile)
+
   if (!fs.existsSync(config.paths.generatedData)) {
     fs.mkdirSync(config.paths.generatedData, { recursive: true })
   }
 
+  console.log(
+    `Using seed data profile: ${selectedSeedDataProfile.label.toLowerCase()}`
+  )
+
   // Create test participants first, using generateParticipant but with overrides
   console.log('Generating test scenario participants...')
   const testParticipants = testScenarios.map((scenario) => {
@@ -383,7 +394,8 @@ const generateData = async () => {
           usedParticipantsInSnapshot,
           indices,
           testScenarioParticipantIds,
-          unitEvents
+          unitEvents,
+          selectedSeedDataProfile
         )
       )
 
@@ -428,7 +440,8 @@ const generateData = async () => {
   console.log('Generating sample reading data...')
   const eventsWithReadingData = generateReadingData(
     sortedEvents,
-    require('../data/users')
+    require('../data/users'),
+    selectedSeedDataProfile
   )
 
   // breastScreeningUnits.forEach(unit => {
@@ -459,6 +472,7 @@ const generateData = async () => {
   writeData('events.json', { events: eventsWithReadingData })
   writeData('generation-info.json', {
     generatedAt: new Date().toISOString(),
+    seedDataProfile: selectedSeedDataProfile.key,
     stats: {
       participants: finalParticipants.length,
       clinics: allClinics.length,

app/lib/generators/event-generator.js

@@ -89,7 +89,8 @@ const generateEvent = ({
   forceStatus = null,
   id = null,
   specialAppointmentOverride = null,
-  forceInProgress = false
+  forceInProgress = false,
+  seedDataProfile = null
 }) => {
   // Parse dates once
   const [hours, minutes] = config.clinics.simulatedTime.split(':')
@@ -103,7 +104,10 @@ const generateEvent = ({
 
   // Generate special appointment requirements for this event
   const specialAppointment =
-    specialAppointmentOverride || generateSpecialAppointment()
+    specialAppointmentOverride ||
+    generateSpecialAppointment({
+      probability: seedDataProfile?.specialAppointment?.probability
+    })
   const hasSpecialAppointment = Boolean(
     specialAppointment?.supportTypes?.length
   )
@@ -268,7 +272,12 @@ const generateEvent = ({
       event.mammogramData = generateMammogramImages({
         startTime: actualStartTime,
         isSeedData: true,
-        config: participant.config
+        config: participant.config,
+        scenarioWeights: seedDataProfile?.mammogram?.scenarioWeights,
+        imperfectChanceForTechnicalOrIncomplete:
+          seedDataProfile?.mammogram?.imperfectChanceForTechnicalOrIncomplete,
+        notesForReaderChanceWithoutImperfect:
+          seedDataProfile?.mammogram?.notesForReaderChanceWithoutImperfect
       })
 
       // Sync event status with mammogram completeness
@@ -295,7 +304,8 @@ const generateEvent = ({
       // Generate previous mammograms (reported mammograms from other facilities)
       const previousMammograms = generatePreviousMammograms({
         eventDate: event.timing.actualEndTime || event.timing.actualStartTime,
-        addedByUserId: event.sessionDetails.startedBy
+        addedByUserId: event.sessionDetails.startedBy,
+        rate: seedDataProfile?.previousMammograms?.rate
       })
       if (previousMammograms) {
         event.previousMammograms = previousMammograms
@@ -306,6 +316,7 @@ const generateEvent = ({
       const medicalInformation = generateMedicalInformation({
         addedByUserId: event.sessionDetails.startedBy,
         config: participant.config,
+        ...(seedDataProfile?.medicalInformation || {}),
         // Allow config to override probabilities for test scenarios
         ...(participant.config?.medicalInformation || {})
       })
@@ -322,6 +333,7 @@ const generateEvent = ({
       const medicalInformation = generateMedicalInformation({
         addedByUserId: event.sessionDetails.startedBy,
         config: participant.config,
+        ...(seedDataProfile?.medicalInformation || {}),
         // Allow config to override probabilities for test scenarios
         ...(participant.config?.medicalInformation || {})
       })
@@ -336,7 +348,12 @@ const generateEvent = ({
         event.mammogramData = generateMammogramImages({
           startTime: dayjs(event.sessionDetails.startedAt),
           isSeedData: true,
-          config: participant.config
+          config: participant.config,
+          scenarioWeights: seedDataProfile?.mammogram?.scenarioWeights,
+          imperfectChanceForTechnicalOrIncomplete:
+            seedDataProfile?.mammogram?.imperfectChanceForTechnicalOrIncomplete,
+          notesForReaderChanceWithoutImperfect:
+            seedDataProfile?.mammogram?.notesForReaderChanceWithoutImperfect
         })
       }
     }
@@ -369,7 +386,11 @@ const generateEvent = ({
     // Select image set for events with mammogram data
     // Done at the end so full event context (symptoms, implants, etc.) is available
     if (event.mammogramData) {
-      const selectedSet = getImageSetForEvent(event.id, 'diagrams', { event })
+      const selectedSet = getImageSetForEvent(event.id, 'diagrams', {
+        event,
+        contextualWeights:
+          seedDataProfile?.imageSetSelection?.contextualTagWeights
+      })
       if (selectedSet) {
         event.mammogramData.selectedSetId = selectedSet.id
       }

app/lib/generators/mammogram-generator.js

@@ -156,7 +156,10 @@ const generateViewImages = ({
 const generateMammogramImages = ({
   startTime = new Date(),
   isSeedData = false,
-  config = {}
+  config = {},
+  scenarioWeights = null,
+  imperfectChanceForTechnicalOrIncomplete = 0.15,
+  notesForReaderChanceWithoutImperfect = 0.05
 } = {}) => {
   const accessionBase = faker.number
     .int({ min: 100000000, max: 999999999 })
@@ -166,7 +169,9 @@ const generateMammogramImages = ({
   const views = {}
 
   // Select scenario (use config override or random weighted selection)
-  const scenario = config.scenario || weighted.select(IMAGE_SCENARIO_WEIGHTS)
+  const scenario =
+    config.scenario ||
+    weighted.select(scenarioWeights || IMAGE_SCENARIO_WEIGHTS)
 
   // Determine view configuration based on scenario
   let viewsToRepeat = config.repeatViews || []
@@ -325,7 +330,7 @@ const generateMammogramImages = ({
       imperfectData.isImperfectButBestPossible = ['yes']
     } else if (
       (scenario === 'technicalRepeat' || scenario === 'incomplete') &&
-      Math.random() < 0.15
+      Math.random() < imperfectChanceForTechnicalOrIncomplete
     ) {
       imperfectData.isImperfectButBestPossible = ['yes']
     }
@@ -343,7 +348,7 @@ const generateMammogramImages = ({
         'Skin folds present due to weight loss',
         'Best possible images achieved'
       ])
-    } else if (Math.random() < 0.05) {
+    } else if (Math.random() < notesForReaderChanceWithoutImperfect) {
       notesData.notesForReader = faker.helpers.arrayElement([
         'Mole on right breast',
         'Pacemaker present',

app/lib/generators/medical-information-generator.js

@@ -27,6 +27,7 @@ const {
  * @param {number} [options.probabilityOfPregnancyBreastfeeding=0.05] - Chance of having pregnancy/breastfeeding data
  * @param {number} [options.probabilityOfOtherMedicalInfo=0.20] - Chance of having other medical information
  * @param {number} [options.probabilityOfBreastFeatures=0.15] - Chance of having breast features
+ * @param {number} [options.probabilityOfMultipleBreastFeatures=0.30] - If breast features exist, chance of multiple markers
  * @param {number} [options.probabilityOfMedicalHistory=0.50] - Chance of having medical history
  * @param {Array} [options.forceMedicalHistoryTypes] - Array of medical history types to force generation (e.g. ['breastCancer', 'cysts'])
  * @param {object} [options.config] - Participant config for overrides and forced generation
@@ -40,6 +41,7 @@ const generateMedicalInformation = (options = {}) => {
     probabilityOfPregnancyBreastfeeding = 0.05,
     probabilityOfOtherMedicalInfo = 0.2,
     probabilityOfBreastFeatures = 0.15,
+    probabilityOfMultipleBreastFeatures = 0.3,
     probabilityOfMedicalHistory = 0.5,
     forceMedicalHistoryTypes,
     config
@@ -99,6 +101,7 @@ const generateMedicalInformation = (options = {}) => {
   // Generate breast features
   const breastFeatures = generateBreastFeatures({
     probabilityOfAnyFeatures: probabilityOfBreastFeatures,
+    probabilityOfMultipleFeatures: probabilityOfMultipleBreastFeatures,
     config
   })
 

app/lib/generators/previous-mammogram-generator.js

@@ -248,11 +248,14 @@ const generatePreviousMammogram = ({
 
 // Generate previous mammograms for an event
 // Returns an array, or null if none generated
-const generatePreviousMammograms = ({ eventDate, addedByUserId }) => {
-  const rate = config.generation?.previousMammogramRate ?? 0.2
+const generatePreviousMammograms = ({ eventDate, addedByUserId, rate }) => {
+  const effectiveRate =
+    rate !== undefined
+      ? rate
+      : (config.generation?.previousMammogramRate ?? 0.2)
 
   // Decide whether this event has reported mammograms
-  if (Math.random() > rate) {
+  if (Math.random() > effectiveRate) {
     return null
   }