Files
Moheeb Zara 4aa6646499 fix(onboarding): atomic DB append for step completion (deferred bug L3)
markOnboardingStepDone read space_members.onboarding_progress, appended the step
id in JS, and wrote the whole jsonb object back — a lost-update race where two
near-simultaneous completions (double-submit, or two steps ticked quickly) both
read the same base array and the second write clobbered the first, silently
dropping a step.

Replace it with mark_onboarding_step_done (migration 055): a single atomic
UPDATE that dedup-appends the step id into onboarding_progress.completed_step_ids
under the row lock — no update can be lost (READ COMMITTED re-evaluates the jsonb
expression against the latest tuple via EvalPlanQual), other keys are preserved,
and re-appending an existing id is a no-op. Ownership-guarded by auth.uid() so a
caller can only complete steps on their own membership row; the no-JWT service
path is trusted and scoped by p_member_id (mirrors class_signup_tx et al.).

integration/onboarding-progress.test.ts covers dedup/idempotency, key
preservation, the auth.uid ownership gate, and the point of the fix: 12
concurrent completions all survive.

Migration 055 folded into schema.sql; types/database.ts regenerated.
typecheck 0 · lint 0 errors · 645 unit · 58 integration · build ok
2026-08-04 22:36:12 -07:00

270 lines
9.3 KiB
TypeScript

'use server'
import { revalidatePath } from 'next/cache'
import { createClient } from '@/lib/supabase/server'
import { createAdminClient } from '@/lib/supabase/admin'
import type { Json } from '@/types/database'
import { requireMember, requireMemberWithRole, parseInput } from '@/lib/auth-helpers'
import {
createOnboardingStepSchema,
updateOnboardingStepSchema,
uuidSchema,
} from '@/lib/validations'
import { claimMyAnonymousSubmissions } from './forms'
import { evaluateRequiredFormStep } from '@/lib/forms-logic'
const ONBOARDING_ADMIN_ROLES = ['admin', 'board'] as const
// --- Admin: manage steps -----------------------------------------------------
export async function createOnboardingStep(input: {
step_type: 'welcome' | 'code_of_conduct' | 'profile' | 'payment' | 'content' | 'form'
title: string
body?: string | null
config?: Record<string, unknown>
is_enabled?: boolean
is_required?: boolean
sort_order?: number
}) {
const v = parseInput(createOnboardingStepSchema, input)
if (!v.ok) return { error: v.error }
const supabase = await createClient()
const auth = await requireMemberWithRole(supabase, ONBOARDING_ADMIN_ROLES, 'Admin or board access required')
if (!auth.ok) return { error: auth.error }
const { member } = auth
// Custom steps get a generated key; built-in keys are reserved for the
// seeded rows so they stay addressable.
const stepKey = `custom-${crypto.randomUUID().slice(0, 12)}`
const { data, error } = await supabase
.from('space_onboarding_steps')
.insert({
space_id: member.space_id,
step_key: stepKey,
step_type: v.data.step_type,
title: v.data.title,
body: v.data.body ?? null,
config: (v.data.config ?? {}) as Json,
is_enabled: v.data.is_enabled ?? true,
is_required: v.data.is_required ?? false,
is_system: false,
sort_order: v.data.sort_order ?? 100,
})
.select('id')
.single()
if (error) return { error: error.message }
revalidatePath('/customize')
return { id: data.id }
}
export async function updateOnboardingStep(stepId: string, updates: {
title?: string
body?: string | null
config?: Record<string, unknown>
is_enabled?: boolean
is_required?: boolean
sort_order?: number
}) {
const idCheck = parseInput(uuidSchema, stepId)
if (!idCheck.ok) return { error: 'Invalid step ID' }
const v = parseInput(updateOnboardingStepSchema, updates)
if (!v.ok) return { error: v.error }
const supabase = await createClient()
const auth = await requireMemberWithRole(supabase, ONBOARDING_ADMIN_ROLES, 'Admin or board access required')
if (!auth.ok) return { error: auth.error }
const { member } = auth
const patch: Record<string, unknown> = {}
if (v.data.title !== undefined) patch.title = v.data.title
if (v.data.body !== undefined) patch.body = v.data.body
if (v.data.config !== undefined) patch.config = v.data.config
if (v.data.is_enabled !== undefined) patch.is_enabled = v.data.is_enabled
if (v.data.is_required !== undefined) patch.is_required = v.data.is_required
if (v.data.sort_order !== undefined) patch.sort_order = v.data.sort_order
const { error } = await supabase
.from('space_onboarding_steps')
.update(patch)
.eq('id', idCheck.data)
.eq('space_id', member.space_id)
if (error) return { error: error.message }
revalidatePath('/customize')
return { success: true as const }
}
export async function deleteOnboardingStep(stepId: string) {
const v = parseInput(uuidSchema, stepId)
if (!v.ok) return { error: 'Invalid step ID' }
const supabase = await createClient()
const auth = await requireMemberWithRole(supabase, ['admin'], 'Admin access required')
if (!auth.ok) return { error: auth.error }
const { member } = auth
// RLS also blocks deleting is_system rows; surface a clear message.
const { error, count } = await supabase
.from('space_onboarding_steps')
.delete({ count: 'exact' })
.eq('id', v.data)
.eq('space_id', member.space_id)
if (error) return { error: error.message }
if (count === 0) return { error: 'Built-in steps cannot be deleted. Disable it instead.' }
revalidatePath('/customize')
return { success: true as const }
}
// --- Member: progress through the flow ---------------------------------------
export async function markOnboardingStepDone(stepId: string) {
const v = parseInput(uuidSchema, stepId)
if (!v.ok) return { error: 'Invalid step ID' }
const supabase = await createClient()
const auth = await requireMember(supabase)
if (!auth.ok) return { error: auth.error }
const { member } = auth
// Atomic dedup-append in the DB (migration 055). The old read-modify-write on
// onboarding_progress had a lost-update race: two near-simultaneous
// completions both read the same base array and the second write clobbered
// the first, silently dropping a step. The RPC pins the write to the caller's
// own row via auth.uid().
const { error } = await supabase.rpc('mark_onboarding_step_done', {
p_member_id: member.id,
p_step_id: v.data,
})
if (error) return { error: error.message }
return { success: true as const }
}
// Completes onboarding. Server-side double-check: every enabled+required step
// must be in completed_step_ids, so a tampered client cannot skip a required
// code-of-conduct acknowledgement.
export async function finishOnboarding() {
const supabase = await createClient()
const auth = await requireMember(supabase)
if (!auth.ok) return { error: auth.error }
const { member } = auth
const { data: steps } = await supabase
.from('space_onboarding_steps')
.select('id, is_required, is_enabled, step_type, config')
.eq('space_id', member.space_id)
.eq('is_enabled', true)
const { data: row } = await supabase
.from('space_members')
.select('onboarding_progress')
.eq('id', member.id)
.single()
const progress = (row?.onboarding_progress ?? {}) as { completed_step_ids?: string[] }
const done = new Set(progress.completed_step_ids ?? [])
const candidates = (steps ?? []).filter(s => s.is_required && !done.has(s.id))
// A required 'form' step is also satisfied if a submission for the
// configured form already exists for this member (any version — re-sign is
// non-blocking). If the form is missing or not published, the step is
// treated as non-blocking: a misconfiguration must not trap members out of
// their own space. Submissions are forms.manage-only under RLS, so the
// existence probe uses the service client.
const admin = createAdminClient()
for (const s of candidates) {
if (s.step_type !== 'form') {
return { error: 'Please complete the required steps before finishing.' }
}
const formId = (s.config as { form_id?: string } | null)?.form_id
let formPublished = false
let submissionExists = false
if (formId) {
const { data: form } = await supabase
.from('forms')
.select('id, status')
.eq('id', formId)
.eq('space_id', member.space_id)
.maybeSingle()
formPublished = !!form && form.status === 'published'
if (formPublished) {
const { count } = await admin
.from('form_submissions')
.select('id', { count: 'exact', head: true })
.eq('form_id', formId)
.eq('space_id', member.space_id)
.eq('member_id', member.id)
submissionExists = (count ?? 0) > 0
}
}
if (
evaluateRequiredFormStep({
stepType: s.step_type,
formId,
formPublished,
submissionExists,
}) === 'block'
) {
return { error: 'Please complete the required form before finishing.' }
}
}
// onboarding_completed_at is blocked by the self-change trigger (migration
// 024) so a member cannot skip required steps via a raw PostgREST call.
// Set it via the service client AFTER the required-steps check above, scoped
// to this member's own id. Reuses the `admin` client created above.
const { error } = await admin
.from('space_members')
.update({ onboarding_completed_at: new Date().toISOString() })
.eq('id', member.id)
.eq('space_id', member.space_id)
if (error) return { error: error.message }
// Best-effort: pull in any prior anonymous submissions for this now-verified
// member (e.g., a waiver signed before they had an account). Never blocks
// finishing.
try {
await claimMyAnonymousSubmissions()
} catch {
/* advisory */
}
revalidatePath('/dashboard')
return { success: true as const }
}
// Skip is only honored when no enabled step is required.
export async function skipOnboarding() {
const supabase = await createClient()
const auth = await requireMember(supabase)
if (!auth.ok) return { error: auth.error }
const { member } = auth
const { count } = await supabase
.from('space_onboarding_steps')
.select('*', { count: 'exact', head: true })
.eq('space_id', member.space_id)
.eq('is_enabled', true)
.eq('is_required', true)
if ((count ?? 0) > 0) {
return { error: 'This space requires you to complete onboarding.' }
}
const admin = createAdminClient()
const { error } = await admin
.from('space_members')
.update({ onboarding_completed_at: new Date().toISOString() })
.eq('id', member.id)
.eq('space_id', member.space_id)
if (error) return { error: error.message }
revalidatePath('/dashboard')
return { success: true as const }
}