Skip to content

feat: add partialResetInterrogation() method #392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
QRuhier merged 9 commits into from
Jan 12, 2026
Merged

feat: add partialResetInterrogation() method #392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4d028ff
feat: add partialResetInterrogation method
Grafikart Dec 10, 2025
fb5f0bb
feat: add takeControl use case
Grafikart Dec 11, 2025
bade9ca
feat: reset state for moved individuals during sync
Grafikart Dec 11, 2025
b769b3c
fix: sonar review
Grafikart Dec 11, 2025
e81ca10
ref: rename useArticulationTable into getArticulationTable
Grafikart Dec 11, 2025
9289f59
fix: redirection after sync
Grafikart Dec 12, 2025
ea738bb
Merge branch 'main' into feat/reset-state
laurentC35 Jan 5, 2026
76062e6
ref: code review
Grafikart Jan 5, 2026
18ecf78
build: add correctly reset_moved env var
QRuhier Jan 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .env
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ VITE_EXTERNAL_RESOURCES_URL=
VITE_OIDC_ISSUER=
VITE_OIDC_CLIENT_ID=

# When VITE_RESET_MOVED_ENABLED equals true we enable reset interrogations data after moving (default: not enabled: disabled)
VITE_RESET_MOVED_ENABLED=

# When VITE_TELEMETRY_ENABLED equals true we enable telemetry (default: not enabled: disabled)
VITE_TELEMETRY_ENABLED=
# Override max delay in ms to wait for before sending a batch (default: 1min)
Expand Down
49 changes: 49 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,52 @@ pnpm install
pnpm run dev
pnpm run build
```

## Architecture explained

Drama Queen use the clean architecture to create a new feature add a new use case.

This is the minimal structure to make a useCase work. Feel free to split into multiple file if your use case becomes too big.

```ts
import { createSelector, createUsecaseActions } from 'redux-clean-architecture'
import { id } from 'tsafe/id'

import type { State as RootState, Thunks } from '@/core/bootstrap'

const state = (state: RootState) => state[name]
export const name = 'usecase-name'

export type State = {
count: number
}

export const { reducer, actions } = createUsecaseActions({
name,
initialState: id<State>({
counter: 0,
}),
reducers: {
increment: (state, { payload }: { payload: number }) => {
state.count = state.count + payload
},
reset: (state) => {
state.count = 0
},
},
})

export const thunks = {
setTo:
(params: { n: number }) =>
async (...args) => {
const [dispatch, getState, context] = args
dispatch(actions.reset())
dispatch(actions.increment(n))
},
} satisfies Thunks

export const selectors = {
count: createSelector(state, (state: State) => state.count),
}
```
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"scripts": {
"dev": "vite --port 5001 --strictPort",
"test": "vitest run",
"check": "tsc",
"test:watch": "vitest",
"test:coverage": "vitest --coverage",
"build": "tsc && vite build",
Expand Down
34 changes: 34 additions & 0 deletions server/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# dependencies (bun install)
node_modules

# output
out
dist
*.tgz

# code coverage
coverage
*.lcov

# logs
logs
_.log
report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# caches
.eslintcache
.cache
*.tsbuildinfo

# IntelliJ based IDEs
.idea

# Finder (MacOS) folder config
.DS_Store
116 changes: 116 additions & 0 deletions server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
# Mock server

This package is used during development to provide a fake server for the Queen API

```bash
bun run dev
```

Then, in the Drama queen .env set

```env
VITE_QUEEN_API_URL=http://localhost:5000
```

Then you can request a synchronization (http://localhost:5001/queen/synchronize) to get fake data from this API

# How sync works ?

When calling `/queen/synchronize` the runs synchronization workflow runs

- It Uploads local data first
- If upload succeeds, fetch the data remotely and refresh the local data
- When finished (or on error), redirects to `/queen`

This behavior is implemented by the `synchronizeData` use case (`thunks.ts` and `evt.ts`) and the page `SynchronizeData.tsx`.

## The SynchronizeData component

- On mount: calls `synchronizeData.upload()`.
- Subscribes to events; on `uploadError`, `downloadCompleted`, or `downloadFailed`, it posts a `redirect` action and sets `window.location = window.location.origin`.
- Displays progress bars during upload and download.

### Upload step (local ➜ server)

Code: `thunks.upload()` in `src/core/usecases/synchronizeData/thunks.ts`.

- Initializes local sync status in `localSyncStorage` (clears error, success/temp lists).
- Interrogations:
- Reads all locally stored interrogations: `dataStore.getAllInterrogations()`.
- For each interrogation:
- Tries `queenApi.putInterrogation(interrogation)`.
- If the server replies `423` (locked), it is treated as success.
- If the server replies with one of `[400, 403, 404, 500]`, it falls back to `queenApi.postInterrogationInTemp(interrogation)`, then:
- Records the ID in `localSyncStorage.addIdToInterrogationsInTempZone(id)`.
- Deletes local paradata for that interrogation: `dataStore.deleteParadata(id)` and marks that paradata ID as deleted to avoid uploading it later in the same run.
- On success, deletes the local interrogation: `dataStore.deleteInterrogation(id)` and updates progress.
- Paradata (only if telemetry is enabled via `IS_TELEMETRY_ENABLED`):
- Reads all paradata: `dataStore.getAllParadata()`.
- Filters out paradata whose interrogation was just moved to temp (so we don’t upload it): `!deletedParadataIds.has(paradata.idInterrogation)`.
- For each remaining paradata:
- `queenApi.postParadata(paradata)` then `dataStore.deleteParadata(paradata.idInterrogation)` and update progress.
- On success: dispatches `uploadCompleted` and immediately triggers the download step with `dispatch(thunks.download())`.
- On error: flags `localSyncStorage.addError(true)` and dispatches `uploadError` (the page will redirect).

APIs used during upload:

- `queenApi.putInterrogation(interrogation)`
- `queenApi.postInterrogationInTemp(interrogation)`
- `queenApi.postParadata(paradata)`

### Download step (server ➜ local/cache)

Code: `thunks.download()` in `src/core/usecases/synchronizeData/thunks.ts`.

- Campaigns & questionnaires:
- `queenApi.getCampaigns()` → list of campaigns; collect all distinct `questionnaireIds` across them.
- For each `questionnaireId`: `queenApi.getQuestionnaire(id)`.
- On each successful questionnaire fetch, updates progress and stores in memory for later steps.
- Interrogations:
- For each campaign ID:
- `queenApi.getInterrogationsIdsAndQuestionnaireIdsByCampaign(campaignId)` returns pairs `{ id, questionnaireId }`.
- For each `id`: `queenApi.getInterrogation(id)` then `dataStore.updateInterrogation(interrogation)` to refresh the local store.
- If the interrogation’s `questionnaireId` is among the successfully fetched questionnaires, record its ID in `localSyncStorage.addIdToInterrogationsSuccess(id)` (used by the UI/redirect info).
- Certain HTTP errors `[400, 403, 404, 500]` are logged and ignored so the sync can continue; other errors are rethrown to fail the sync.
- Nomenclatures:
- From all fetched questionnaires, gather distinct suggester names (nomenclature IDs).
- For each nomenclature ID: call `queenApi.getNomenclature(id)`.
- The app does not store the data itself; it triggers fetches so the Service Worker can cache responses.
- External resources (optional):
- Only if `EXTERNAL_RESOURCES_URL` is configured.
- `getExternalQuestionnaires()` retrieves the list of external questionnaires (via the external resources API, separate from Queen).
- `getExternalQuestionnaireFiltered()` splits them into `neededQuestionnaires` (those referenced by successfully fetched questionnaires) and `notNeededQuestionnaires`.
- For each needed questionnaire: `getResourcesFromExternalQuestionnaire({ questionnaire, callBackTotal, callBackReset, callBackUnit })` which fetches and puts files into the browser Cache Storage, updating progress callbacks along the way.
- Deletes caches for `notNeededQuestionnaires` and any “old” external caches not in the list (`getOldExternalCacheNames` + `caches.delete`). If none are needed, it also deletes the root cache `cache-root-external`.
- Completion:
- After all of the above finish, dispatches `downloadCompleted`.
- On any unexpected error: sets `localSyncStorage.addError(true)` and dispatches `downloadFailed`.

APIs used during download:

- `queenApi.getCampaigns()`
- `queenApi.getQuestionnaire(questionnaireId)`
- `queenApi.getInterrogationsIdsAndQuestionnaireIdsByCampaign(campaignId)`
- `queenApi.getInterrogation(id)`
- `queenApi.getNomenclature(id)`
- External resources helpers: `getExternalQuestionnaires`, `getExternalQuestionnaireFiltered`, `getResourcesFromExternalQuestionnaire`, `getOldExternalCacheNames` (use fetch/cache under the hood)

### What data is fetched from the API?

- From Queen API:
- List of campaigns
- Questionnaires by ID
- Interrogation IDs (per campaign) and each interrogation’s full data
- Nomenclatures referenced by questionnaires
- From the external resources API (if configured):
- List of external questionnaires
- Each questionnaire’s resource files to cache

### What is done with the fetched data?

- Interrogations: stored/updated locally via `dataStore.updateInterrogation` (download) and deleted locally once successfully uploaded (upload). Temp-zone handling is used as a fallback for certain server errors.
- Questionnaires: fetched to ensure local consistency and to derive nomenclature and external-resource needs; not stored directly here besides in-memory usage and SW caching.
- Nomenclatures: fetched to let the Service Worker cache them; progress updated.
- External resources: fetched and placed into Cache Storage; unneeded caches are cleaned up.
- Progress state is kept in Redux-like state (`synchronizeData/state.ts`) to drive the UI’s progress bars.
- `localSyncStorage` tracks success/error and lists of interrogation IDs handled during the run.
30 changes: 30 additions & 0 deletions server/bun.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading