Answer a retried feedback submission with the one already saved #24

Merged
Paddy merged 2 commits from fix/feedback-submission-idempotency into master 2026-11-16 17:28:37 +00:00
5 changed files with 227 additions and 11 deletions

No files matched your search

+1
View File
@@ -1,3 +1,4 @@
USE nachklang_feedback;
SOURCE /migrations/feedback/001_init.sql;
SOURCE /migrations/feedback/002_add_poster_image_url.sql;
SOURCE /migrations/feedback/003_add_submission_client_token.sql;
@@ -0,0 +1,17 @@
-- Nachklang e.V. Feedback module — makes submitting idempotent per form visit.
-- Apply manually against the FEEDBACK_DB database, after 002_add_poster_image_url.sql:
-- mysql -h <DB_HOST> -u <DB_USER> -p <FEEDBACK_DB> < 003_add_submission_client_token.sql
--
-- The form generates one UUID per visit and resends it on every retry. When
-- a submission saved but its response never reached the phone, the visitor
-- sees an error and taps "absenden" again; the API now finds the stored token
-- and answers with the original submission instead of saving a copy.
--
-- Unique per event, not globally: one visit can switch to another concert's
-- form in the same tab, and that event's submission must still save.
--
-- NULL for every row written before this migration and for any client that
-- sends no token; a UNIQUE index allows any number of NULLs.
ALTER TABLE submissions
ADD COLUMN client_token CHAR(36) NULL AFTER ip_hash,
ADD UNIQUE KEY uq_sub_event_client_token (event_id, client_token);
@@ -56,6 +56,10 @@
* website:
* type: string
* description: Honeypot field. Must stay empty; a real visitor never fills it in.
* clientToken:
* type: string
* format: uuid
* description: Generated once per form and resent on every retry. A retry whose token is already stored for this event returns the original submissionId instead of saving a duplicate. Optional; a value that isn't a UUID is ignored.
* SubmissionResponse:
* type: object
* properties:
@@ -95,4 +99,5 @@ export interface SubmissionRequestBody {
guestBook?: GuestBookInput;
newsletter?: NewsletterInput;
website?: string;
clientToken?: string;
}
@@ -11,6 +11,8 @@ const CONSENT_TEXT_VERSION = '2026-08-02';
const EMAIL_RE = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
const CLIENT_TOKEN_RE = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
// A real setlist tops out around a few dozen songs and a handful of
// questions, so a legitimate submission never comes close to this. Caps
// total generated rows regardless of how large the client's answers/ratings
@@ -136,6 +138,33 @@ export const validateNewsletter = (input?: NewsletterInput): ValidatedNewsletter
return {firstName, lastName, email};
};
/**
* The form generates one UUID per visit and resends it on every retry, so a
* request whose response was lost (the row saved, but the phone never heard
* back) can be told apart from a genuinely new submission. Anything that
* isn't a UUID is treated as "no token" rather than rejected - an old cached
* copy of the form must still be able to submit.
*/
export const normalizeClientToken = (token: unknown): string | null => {
return typeof token === 'string' && CLIENT_TOKEN_RE.test(token) ? token.toLowerCase() : null;
};
// Scoped to the event: the token is per form visit, and one visit can move
// on to another concert's form, so a match for a different event is not a
// retry of this one.
const findSubmissionIdByClientToken = async (clientToken: string, slug: string): Promise<number | null> => {
const conn = await NachklangFeedbackDB.getConnection();
try {
const rows = await conn.query(
'SELECT s.submission_id FROM submissions s JOIN events e ON e.event_id = s.event_id WHERE s.client_token = ? AND e.slug = ?',
[clientToken, slug]
);
return rows.length > 0 ? rows[0].submission_id : null;
} finally {
await conn.end();
}
};
export type SubmitResult =
| { status: 'OK'; submissionId: number; newsletterDropped: boolean }
| { status: 'NOT_FOUND' }
@@ -146,9 +175,29 @@ export type SubmitResult =
* Validates and persists one feedback submission. Re-checks event
* eligibility (the window may have closed between page load and submit),
* validates every answer against the event's live questions/songs, then
* inserts everything in a single transaction.
* inserts everything in a single transaction. A retry carrying an already
* stored client token gets the original submission back instead of a copy.
*/
export const submitFeedback = async (slug: string, body: SubmissionRequestBody, ipHash: string | null): Promise<SubmitResult> => {
const clientToken = normalizeClientToken(body.clientToken);
const newsletter = validateNewsletter(body.newsletter);
// body.newsletter is only sent at all when the visitor had the opt-in
// checkbox on (see FeedbackForm.tsx), so a present-but-invalid block
// (e.g. a mistyped email) is distinguishable from "didn't opt in" - the
// rest of the submission still saves, but the client can tell the
// visitor their newsletter signup specifically didn't go through.
const newsletterDropped = !!body.newsletter && !newsletter;
// Checked before eligibility, so a retry still succeeds if the feedback
// window closed in the seconds after the original saved.
if (clientToken) {
const existingId = await findSubmissionIdByClientToken(clientToken, slug);
if (existingId !== null) {
logger.info('Feedback submission retry answered with the stored submission', {submissionId: existingId});
return {status: 'OK', submissionId: existingId, newsletterDropped};
}
}
const lookup = await getEventConfigBySlug(slug);
if (lookup.status === 'NOT_FOUND') return {status: 'NOT_FOUND'};
if (lookup.status === 'CLOSED') return {status: 'CLOSED'};
@@ -159,13 +208,6 @@ export const submitFeedback = async (slug: string, body: SubmissionRequestBody,
const answerRows = validateAnswers(body.answers || [], questionsById, songTitleById);
const guestBook = validateGuestBook(body.guestBook);
const newsletter = validateNewsletter(body.newsletter);
// body.newsletter is only sent at all when the visitor had the opt-in
// checkbox on (see FeedbackForm.tsx), so a present-but-invalid block
// (e.g. a mistyped email) is distinguishable from "didn't opt in" - the
// rest of the submission still saves, but the client can tell the
// visitor their newsletter signup specifically didn't go through.
const newsletterDropped = !!body.newsletter && !newsletter;
if (answerRows.length === 0 && !guestBook && !newsletter) {
return {status: 'EMPTY'};
@@ -175,8 +217,8 @@ export const submitFeedback = async (slug: string, body: SubmissionRequestBody,
try {
await conn.beginTransaction();
const subQuery = 'INSERT INTO submissions (event_id, ip_hash, has_guestbook, has_newsletter) VALUES (?,?,?,?) RETURNING submission_id';
const subRes = await conn.query(subQuery, [eventId, ipHash, guestBook ? 1 : 0, newsletter ? 1 : 0]);
const subQuery = 'INSERT INTO submissions (event_id, ip_hash, has_guestbook, has_newsletter, client_token) VALUES (?,?,?,?,?) RETURNING submission_id';
const subRes = await conn.query(subQuery, [eventId, ipHash, guestBook ? 1 : 0, newsletter ? 1 : 0, clientToken]);
const submissionId = subRes[0].submission_id;
for (const row of answerRows) {
@@ -220,8 +262,16 @@ export const submitFeedback = async (slug: string, body: SubmissionRequestBody,
}
return {status: 'OK', submissionId, newsletterDropped};
} catch (err) {
} catch (err: any) {
await conn.rollback();
// Two copies of the same retry both got past the lookup above; the
// unique index on (event_id, client_token) let only one of them commit.
if (clientToken && err?.code === 'ER_DUP_ENTRY') {
const existingId = await findSubmissionIdByClientToken(clientToken, slug);
if (existingId !== null) {
return {status: 'OK', submissionId: existingId, newsletterDropped};
}
}
throw err;
} finally {
await conn.end();
@@ -0,0 +1,143 @@
import {vi, describe, it, expect, beforeEach, type Mock} from 'vitest';
vi.mock('../../src/models/feedback/Feedback.db.js', () => ({
NachklangFeedbackDB: {getConnection: vi.fn()}
}));
vi.mock('../../src/models/feedback/public/events.public.service.js', () => ({
getEventConfigBySlug: vi.fn()
}));
vi.mock('../../src/models/feedback/integrations/salesforce.service.js', () => ({
syncNewsletterSignup: vi.fn().mockResolvedValue(undefined)
}));
vi.mock('../../src/middleware/logger.js', () => ({
__esModule: true,
default: {info: vi.fn(), error: vi.fn()}
}));
import {NachklangFeedbackDB} from '../../src/models/feedback/Feedback.db.js';
import {getEventConfigBySlug} from '../../src/models/feedback/public/events.public.service.js';
import {submitFeedback} from '../../src/models/feedback/public/submissions.service.js';
const mockGetConnection = NachklangFeedbackDB.getConnection as Mock;
const mockGetEventConfigBySlug = getEventConfigBySlug as Mock;
const TOKEN = '3f2b8c1e-4d5a-4b6c-9e7f-0a1b2c3d4e5f';
const BODY = {answers: [{eventQuestionId: 26, text: 'Danke!'}], clientToken: TOKEN};
const SLUG = 'sommerkonzert-2026';
const LOOKUP_SQL = 'SELECT s.submission_id FROM submissions s';
// One fake connection serves every query; `existingId` is what a lookup by
// client_token finds when it was stored for `existingSlug`, and
// `insertError` makes the submissions INSERT throw.
const makeConn = ({existingId = null, existingSlug = SLUG, insertError = null}: {existingId?: number | null; existingSlug?: string; insertError?: any} = {}) => ({
query: vi.fn(async (sql: string, params: any[] = []) => {
if (sql.startsWith(LOOKUP_SQL)) {
return existingId === null || params[1] !== existingSlug ? [] : [{submission_id: existingId}];
}
if (sql.startsWith('INSERT INTO submissions')) {
if (insertError) throw insertError;
return [{submission_id: 90}];
}
return [];
}),
beginTransaction: vi.fn().mockResolvedValue(undefined),
commit: vi.fn().mockResolvedValue(undefined),
rollback: vi.fn().mockResolvedValue(undefined),
end: vi.fn().mockResolvedValue(undefined)
});
const allQueries = (conn: ReturnType<typeof makeConn>): [string, any[]][] => conn.query.mock.calls as any;
describe('submitFeedback - client token idempotency', () => {
beforeEach(() => {
mockGetConnection.mockReset();
mockGetEventConfigBySlug.mockReset();
mockGetEventConfigBySlug.mockResolvedValue({
status: 'OK',
eventId: 22,
event: {
questions: [{eventQuestionId: 26, questionId: 4, type: 'FREE_TEXT', label: 'Sonstiges', position: 0}],
songs: []
}
});
});
it('returns the already-saved submission for a repeated token without inserting again', async () => {
const conn = makeConn({existingId: 82});
mockGetConnection.mockResolvedValue(conn);
const result = await submitFeedback('sommerkonzert-2026', BODY, 'hash');
expect(result).toEqual({status: 'OK', submissionId: 82, newsletterDropped: false});
expect(allQueries(conn).some(([sql]) => sql.startsWith('INSERT'))).toBe(false);
});
it('still answers a retry with the saved submission after the feedback window closed', async () => {
mockGetConnection.mockResolvedValue(makeConn({existingId: 82}));
mockGetEventConfigBySlug.mockResolvedValue({status: 'CLOSED'});
const result = await submitFeedback('sommerkonzert-2026', BODY, 'hash');
expect(result).toEqual({status: 'OK', submissionId: 82, newsletterDropped: false});
});
it('stores a new token, lowercased, on the submissions row', async () => {
const conn = makeConn();
mockGetConnection.mockResolvedValue(conn);
const result = await submitFeedback('sommerkonzert-2026', {...BODY, clientToken: TOKEN.toUpperCase()}, 'hash');
expect(result).toEqual({status: 'OK', submissionId: 90, newsletterDropped: false});
const insert = allQueries(conn).find(([sql]) => sql.startsWith('INSERT INTO submissions'))!;
expect(insert[1]).toContain(TOKEN);
});
it('saves a new submission when the token was only ever used for a different event', async () => {
// Same browser tab, two concerts: the token must not make the second
// event's feedback come back as the first event's submission.
const conn = makeConn({existingId: 82, existingSlug: 'winterkonzert-2026'});
mockGetConnection.mockResolvedValue(conn);
const result = await submitFeedback(SLUG, BODY, 'hash');
expect(result).toEqual({status: 'OK', submissionId: 90, newsletterDropped: false});
expect(allQueries(conn).find(([sql]) => sql.startsWith(LOOKUP_SQL))![1]).toEqual([TOKEN, SLUG]);
});
it('ignores a malformed token: no lookup, and the row is stored without one', async () => {
const conn = makeConn();
mockGetConnection.mockResolvedValue(conn);
await submitFeedback('sommerkonzert-2026', {...BODY, clientToken: 'not-a-uuid'}, 'hash');
expect(allQueries(conn).some(([sql]) => sql.startsWith(LOOKUP_SQL))).toBe(false);
const insert = allQueries(conn).find(([sql]) => sql.startsWith('INSERT INTO submissions'))!;
expect(insert[1]).not.toContain('not-a-uuid');
expect(insert[1][insert[1].length - 1]).toBeNull();
});
it('resolves a concurrent duplicate that loses the race on the unique index to the winning submission', async () => {
const dupError = Object.assign(new Error('Duplicate entry'), {code: 'ER_DUP_ENTRY', errno: 1062});
const racingConn = makeConn({insertError: dupError});
// First lookup (before the INSERT) finds nothing; the one after the
// duplicate-key error finds the row the other request committed.
const lookupAfterRace = makeConn({existingId: 83});
mockGetConnection
.mockResolvedValueOnce(makeConn())
.mockResolvedValueOnce(racingConn)
.mockResolvedValueOnce(lookupAfterRace);
const result = await submitFeedback('sommerkonzert-2026', BODY, 'hash');
expect(result).toEqual({status: 'OK', submissionId: 83, newsletterDropped: false});
expect(racingConn.rollback).toHaveBeenCalled();
expect(racingConn.commit).not.toHaveBeenCalled();
});
it('rethrows a duplicate-key error when the request carried no token', async () => {
const dupError = Object.assign(new Error('Duplicate entry'), {code: 'ER_DUP_ENTRY', errno: 1062});
mockGetConnection.mockResolvedValue(makeConn({insertError: dupError}));
await expect(submitFeedback('sommerkonzert-2026', {answers: BODY.answers}, 'hash')).rejects.toThrow('Duplicate entry');
});
});