Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
53 changes: 43 additions & 10 deletions formulus-formplayer/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,29 @@ import { formDataJsonEqual } from './renderers/subObservationHelpers';
import { mergeIncomingFormData } from './jsonforms/clearHiddenControlData';

/** Embedded sub-observation session (also accepts legacy `returnOnly` from older hosts). */
function removeExpiredDrafts(init: FormInitData): void {
if (isSubObservationSession(init)) return;
try {
draftService.cleanupExpiredDrafts({
keep: draft =>
init.observationId != null &&
draft.formType === init.formType &&
draft.observationId === init.observationId,
});
} catch (error) {
console.warn('[App.tsx] Draft cleanup skipped:', error);
}
}

function listDraftsWithoutBlocking(formType: string, formVersion: string) {
try {
return draftService.getDraftsForForm(formType, formVersion);
} catch (error) {
console.warn('[App.tsx] Could not read drafts:', error);
return [];
}
}

function isSubObservationSession(init: FormInitData): boolean {
const i = init as FormInitData & { returnOnly?: boolean };
return Boolean(i.subObservationMode || i.returnOnly);
Expand Down Expand Up @@ -911,6 +934,8 @@ function App() {
return; // Exit early
}

removeExpiredDrafts(initData);

// Check if this is a new form (no savedData) and if drafts exist
if (
shouldOfferDraftSelector(
Expand All @@ -923,7 +948,7 @@ function App() {
savedData,
)
) {
const availableDrafts = draftService.getDraftsForForm(
const availableDrafts = listDraftsWithoutBlocking(
receivedFormType,
resolveFormSchemaVersion(formSchema),
);
Expand Down Expand Up @@ -1528,15 +1553,23 @@ function App() {
draftFlushQueue.current.retire();
}
await draftFlushQueue.current.settled();
if (payloadFormInit.observationId != null) {
draftService.deleteDraftsForFormInstance(
payloadFormInit.formType,
payloadFormInit.observationId,
);
} else if (draftSessionKey) {
draftService.deleteDraftForNewObservationSession(
payloadFormInit.formType,
draftSessionKey,
// Already saved natively: cleanup failing must not fail the submit.
try {
if (payloadFormInit.observationId != null) {
draftService.deleteDraftsForFormInstance(
payloadFormInit.formType,
payloadFormInit.observationId,
);
} else if (draftSessionKey) {
draftService.deleteDraftForNewObservationSession(
payloadFormInit.formType,
draftSessionKey,
);
}
} catch (cleanupError) {
console.warn(
'[App.tsx] Draft cleanup after submit failed:',
cleanupError,
);
}
// Persist sticky field values for next new observation of this form.
Expand Down
25 changes: 25 additions & 0 deletions formulus-formplayer/src/components/DraftSelector.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ interface DraftSelectorProps {
// Container style – matched with other confirm UIs (no semi-transparent overlay)
const CONFIRM_CARD_RADIUS = 0.7;
const CONFIRM_BORDER_WIDTH = 1;
const DAY_MS = 24 * 60 * 60 * 1000;

export const DraftSelector: React.FC<DraftSelectorProps> = ({
formType,
Expand All @@ -53,12 +54,14 @@ export const DraftSelector: React.FC<DraftSelectorProps> = ({
const theme = useTheme();
const t = useOdeT();
const [drafts, setDrafts] = useState<DraftSummary[]>([]);
const [loadedAt, setLoadedAt] = useState(0);
const [deleteConfirmOpen, setDeleteConfirmOpen] = useState(false);
const [draftToDelete, setDraftToDelete] = useState<string | null>(null);

// Load drafts on component mount and when formType changes
const loadDrafts = useCallback(() => {
const formDrafts = draftService.getDraftsForForm(formType, formVersion);
setLoadedAt(Date.now());
setDrafts(formDrafts);
}, [formType, formVersion]);

Expand All @@ -83,6 +86,14 @@ export const DraftSelector: React.FC<DraftSelectorProps> = ({
setDraftToDelete(null);
};

const expiryText = (expiresAt: Date): string => {
const days = Math.ceil((expiresAt.getTime() - loadedAt) / DAY_MS);
if (days <= 1) return t('draft.expiresToday', 'Deleted within a day');
return t('draft.expiresInDays', 'Deleted in {{count}} days', {
count: days,
});
};

const formatDate = (date: Date): string =>
date.toLocaleString(undefined, {
year: 'numeric',
Expand Down Expand Up @@ -136,6 +147,20 @@ export const DraftSelector: React.FC<DraftSelectorProps> = ({
date: formatDate(draft.updatedAt),
})}
</Typography>
<Typography
variant="caption"
color="text.secondary"
noWrap
sx={{ display: 'block', textAlign: 'left' }}>
{[
draft.isOtherVersion
? t('draft.otherVersion', 'Different form version')
: null,
expiryText(draft.expiresAt),
]
.filter(Boolean)
.join(' · ')}
</Typography>
</Box>
<Box
sx={{
Expand Down
3 changes: 3 additions & 0 deletions formulus-formplayer/src/locales/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@
"draft.formLabel": "Form: {{formType}}",
"draft.newFormSection": "New Form",
"draft.deleteConfirm": "Are you sure you want to delete this draft? This action cannot be undone.",
"draft.otherVersion": "Different form version",
"draft.expiresToday": "Deleted within a day",
"draft.expiresInDays": "Deleted in {{count}} days",

"finalize.title": "Finalize",
"finalize.summary": "FORM SUMMARY",
Expand Down
3 changes: 3 additions & 0 deletions formulus-formplayer/src/locales/fr.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@
"draft.formLabel": "Formulaire : {{formType}}",
"draft.newFormSection": "Nouveau formulaire",
"draft.deleteConfirm": "Voulez-vous vraiment supprimer ce brouillon ? Cette action est irréversible.",
"draft.otherVersion": "Autre version du formulaire",
"draft.expiresToday": "Supprimé dans moins d’un jour",
"draft.expiresInDays": "Supprimé dans {{count}} jours",

"finalize.title": "Finaliser",
"finalize.summary": "RÉSUMÉ DU FORMULAIRE",
Expand Down
3 changes: 3 additions & 0 deletions formulus-formplayer/src/locales/pt.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@
"draft.formLabel": "Formulário: {{formType}}",
"draft.newFormSection": "Novo formulário",
"draft.deleteConfirm": "Tem a certeza de que pretende eliminar este rascunho? Esta ação não pode ser anulada.",
"draft.otherVersion": "Outra versão do formulário",
"draft.expiresToday": "Excluído em menos de um dia",
"draft.expiresInDays": "Excluído em {{count}} dias",

"finalize.title": "Finalizar",
"finalize.summary": "RESUMO DO FORMULÁRIO",
Expand Down
3 changes: 3 additions & 0 deletions formulus-formplayer/src/locales/sw.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@
"draft.formLabel": "Fomu: {{formType}}",
"draft.newFormSection": "Fomu mpya",
"draft.deleteConfirm": "Una uhakika unataka kufuta rasimu hii? Kitendo hiki hakiwezi kutenduliwa.",
"draft.otherVersion": "Toleo tofauti la fomu",
"draft.expiresToday": "Itafutwa ndani ya siku moja",
"draft.expiresInDays": "Itafutwa baada ya siku {{count}}",
"finalize.title": "Kamilisha",
"finalize.summary": "MUHTASARI WA FOMU",
"finalize.notProvided": "Haijatolewa",
Expand Down
34 changes: 26 additions & 8 deletions formulus-formplayer/src/renderers/SwipeLayoutRenderer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import { Button } from '@ode/components/react-web';
import { FormContext, useFormContext } from '../App';
import { primaryKeyboardEnterKeyHint } from '../utils/keyboardEnterKeyHint';
import { draftService } from '../services/DraftService';
import type { FormInitData } from '../types/FormulusInterfaceDefinition';
import FormProgressBar from '../components/FormProgressBar';
import FormLayout from '../components/FormLayout';
import {
Expand Down Expand Up @@ -827,6 +828,25 @@ const SwipeLayoutRenderer = ({
);
};

/** A failed draft save (e.g. full storage) must not block page navigation. */
function saveDraftWithoutBlocking(
formInitData: FormInitData,
data: Record<string, any>,
draftSessionKey: string | null | undefined,
reason: string,
): void {
try {
draftService.saveDraft(
formInitData.formType,
data,
formInitData,
draftSessionKey,
);
} catch (error) {
console.warn(`[SwipeLayout] Draft not saved on ${reason}:`, error);
}
}

// ---------------------------------------------------------------------------
// Wrapper – manages page state and draft persistence
// ---------------------------------------------------------------------------
Expand All @@ -848,12 +868,11 @@ const SwipeLayoutWrapper = (props: ControlProps) => {
(page: number) => {
// Save the current form data before changing the page
if (data && formInitData && !skipDraftPersistence) {
console.log('Saving draft data on page change:', data);
draftService.saveDraft(
formInitData.formType,
data,
saveDraftWithoutBlocking(
formInitData,
data,
draftSessionKey,
'page change',
);
}
setCurrentPage(page);
Expand All @@ -865,12 +884,11 @@ const SwipeLayoutWrapper = (props: ControlProps) => {
const handleNavigateToPage = (event: CustomEvent) => {
// Save the current form data before navigating to a specific page
if (data && formInitData && !skipDraftPersistence) {
console.log('Saving draft data before navigation event:', data);
draftService.saveDraft(
formInitData.formType,
data,
saveDraftWithoutBlocking(
formInitData,
data,
draftSessionKey,
'navigation event',
);
}
setCurrentPage(event.detail.page);
Expand Down
134 changes: 134 additions & 0 deletions formulus-formplayer/src/services/DraftService.cleanup.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
// @vitest-environment jsdom
import { beforeEach, expect, it, vi } from 'vitest';

const DAY = 24 * 60 * 60 * 1000;
const NOW = new Date('2026-11-20T12:00:00.000Z');
const scoped = (key: string) => `ode:profile-a:formplayer:${key}`;

beforeEach(() => {
localStorage.clear();
vi.restoreAllMocks();
vi.resetModules();
});

async function draftService() {
const { formplayerStorage } = await import('./ProfileStorage');
formplayerStorage.initialize({ __odeProfileId: 'profile-a' }, localStorage);
return (await import('./DraftService')).draftService;
}

function legacyBlob(rows: Array<{ id: string; updatedAt: string }>) {
localStorage.setItem(
scoped('formulus_drafts'),
JSON.stringify(
rows.map(row => ({
id: row.id,
formType: 'household',
data: { name: row.id },
createdAt: row.updatedAt,
updatedAt: row.updatedAt,
observationId: null,
draftSessionKey: `session-${row.id}`,
})),
),
);
}

const daysAgo = (days: number) =>
new Date(NOW.getTime() - days * DAY).toISOString();

it('migrates the single drafts blob into one entry per draft', async () => {
legacyBlob([
{ id: 'a', updatedAt: daysAgo(1) },
{ id: 'b', updatedAt: daysAgo(2) },
]);
const drafts = await draftService();
expect(drafts.getTotalDraftCount()).toBe(2);
expect(localStorage.getItem(scoped('formulus_drafts'))).toBeNull();
expect(localStorage.getItem(scoped('draft_v2:a'))).toContain('"name":"a"');
expect(drafts.getDraft('b')?.data).toEqual({ name: 'b' });
});

it('rolls a failed migration back so it can retry later', async () => {
legacyBlob([{ id: 'a', updatedAt: daysAgo(1) }]);
const drafts = await draftService();
const setItem = Storage.prototype.setItem;
const spy = vi
.spyOn(Storage.prototype, 'setItem')
.mockImplementation(function (this: Storage, key, value) {
if (key === scoped('drafts_index_v2')) throw new Error('quota');
setItem.call(this, key, value);
});
expect(() => drafts.getTotalDraftCount()).toThrow('quota');
expect(localStorage.getItem(scoped('formulus_drafts'))).toContain('"a"');
expect(localStorage.getItem(scoped('draft_v2:a'))).toBeNull();
spy.mockRestore();
expect(drafts.getTotalDraftCount()).toBe(1);
});

it('removes drafts not edited within the max age, keeping recent ones', async () => {
legacyBlob([
{ id: 'fresh', updatedAt: daysAgo(6) },
{ id: 'stale', updatedAt: daysAgo(8) },
]);
const drafts = await draftService();
expect(drafts.cleanupExpiredDrafts({ now: NOW })).toBe(1);
expect(drafts.getDraft('fresh')).not.toBeNull();
expect(drafts.getDraft('stale')).toBeNull();
expect(localStorage.getItem(scoped('draft_v2:stale'))).toBeNull();
});

it('keeps drafts with future or invalid dates and drafts selected by keep', async () => {
legacyBlob([
{ id: 'future', updatedAt: new Date(NOW.getTime() + DAY).toISOString() },
{ id: 'corrupt', updatedAt: 'not a date' },
{ id: 'opening', updatedAt: daysAgo(30) },
]);
const drafts = await draftService();
expect(
drafts.cleanupExpiredDrafts({
now: NOW,
keep: draft => draft.id === 'opening',
}),
).toBe(0);
expect(drafts.getTotalDraftCount()).toBe(3);
});

it('honours a custom max age and treats non-positive values as disabled', async () => {
legacyBlob([{ id: 'a', updatedAt: daysAgo(3) }]);
const drafts = await draftService();
expect(drafts.cleanupExpiredDrafts({ now: NOW, maxAgeDays: 0 })).toBe(0);
expect(drafts.cleanupExpiredDrafts({ now: NOW, maxAgeDays: 2 })).toBe(1);
});

it('reports when each draft expires, counted from its last edit', async () => {
const drafts = await draftService();
vi.useFakeTimers();
vi.setSystemTime(NOW);
drafts.saveDraft('household', { name: 'x' }, undefined, 'session-x');
vi.useRealTimers();
const [summary] = drafts.getDraftsForForm('household');
expect(summary.expiresAt.getTime()).toBe(NOW.getTime() + 7 * DAY);
});

it('a draft that cannot be stored does not affect other drafts', async () => {
const drafts = await draftService();
drafts.saveDraft('household', { name: 'small' }, undefined, 'small');
const setItem = Storage.prototype.setItem;
vi.spyOn(Storage.prototype, 'setItem').mockImplementation(function (
this: Storage,
key,
value,
) {
if (String(value).includes('huge')) throw new Error('quota');
setItem.call(this, key, value);
});
expect(() =>
drafts.saveDraft('household', { name: 'huge' }, undefined, 'big'),
).toThrow('quota');
vi.restoreAllMocks();
expect(drafts.getTotalDraftCount()).toBe(1);
expect(drafts.getDraftsForForm('household')[0].dataPreview).toContain(
'small',
);
});
Original file line number Diff line number Diff line change
Expand Up @@ -136,12 +136,15 @@ it('keeps legacy unversioned drafts discoverable without relabeling on update',
expect(
draft
.getDraftsForForm('household', '2')
.filter(item => !item.isOtherVersion)
.map(item => item.id)
.sort(),
).toEqual(['legacy', matching].sort());
expect(
draft.getDraftsForForm('household', '2').map(item => item.id),
).not.toContain(mismatched);
const listed = draft.getDraftsForForm('household', '2');
expect(listed.find(item => item.id === mismatched)?.isOtherVersion).toBe(
true,
);
expect(listed.find(item => item.id === matching)?.isOtherVersion).toBe(false);
draft.saveDraft(
'household',
{ name: 'Resumed' },
Expand Down
Loading
Loading