teqo-backup/src/collections/CampaignDemand.ts
Francisco Solla 2cc8f2c14d feat(C143): demandas visíveis apenas para responsáveis explícitos + candidato/coordenador
- campaignDemand.responsibles (hasMany → campaignUser, staff elegível) com
  hook beforeValidate que descarta ids não-staff (fail-closed)
- canRead/UpdateCampaignDemand por membership: assessor só vê demandas onde
  é responsável; unrestricted/admin sempre; leader nunca (fim do escopo
  municipal de demandas)
- criador entra automaticamente como responsável no hook de criação (form,
  wizard, rascunhos C90); migration com backfill created_by_id → responsável
- UI: picker multi-select na criação (nova + wizard) e card de gestão no
  detalhe com save full-replace + advisory lock; sugestões = assessores do
  município; rótulo 'Visível para: Responsáveis · Candidato · Coordenador'
- int tests reescritos para a regra nova + 5 casos novos; e2e novo de
  visibilidade (lista/URL/gestão); fixture e2e com createCampaignDemand
- impl plan + changelog; importMap regenerado com S3_* dummy (OPS69)
2026-08-19 23:55:07 -03:00

504 lines
15 KiB
TypeScript

import type {
CollectionBeforeChangeHook,
CollectionBeforeValidateHook,
CollectionConfig,
} from 'payload'
import { APIError } from 'payload'
import { relationshipId } from '@/lib/relationship'
import {
CAMPAIGN_DEMAND_ESCALATED_DECISION_MESSAGE,
CAMPAIGN_DEMAND_INVALID_STATUS_MESSAGE,
campaignDemandKindLabels,
campaignDemandKinds,
campaignDemandStatusLabels,
campaignDemandStatuses,
campaignDemandTransitions,
type CampaignDemandStatus,
} from '@/lib/schemas/campaignDemand'
import { slugify } from '@/lib/slug'
import { trimmedText } from '@/lib/text'
import {
canCreateCampaignDemand,
canDeleteCampaignDemand,
canManageCampaignStaffField,
canReadCampaignDemand,
canReadCampaignStaffField,
canSetCampaignSystemField,
canUpdateCampaignDemand,
eligibleCampaignStaffWhere,
isCampaignUnrestricted,
} from '@/utilities/campaignAccess'
import { systemStampedActorField } from '@/utilities/campaignAuditFields'
import { acquireTextAdvisoryLocks } from '@/utilities/postgresTransactionLocks'
const DEMAND_KIND_OPTIONS = campaignDemandKinds.map((value) => ({
value,
label: campaignDemandKindLabels[value],
}))
const DEMAND_STATUS_OPTIONS = campaignDemandStatuses.map((value) => ({
value,
label: campaignDemandStatusLabels[value],
}))
/**
* C143 — responsibles are always eligible staff (coordinator/advisor/candidate).
* The picker catalog already filters, but the invariant belongs in the data
* path, fail-closed: forged/non-eligible ids (a leader, a deleted account) are
* dropped from any create/update. Intentional admin bypass — the hook must SEE
* the non-eligible rows to drop them (same precedent as the slug probe).
*/
const restrictResponsiblesToStaff: CollectionBeforeValidateHook = async ({ data, req }) => {
if (!data) return data
const rawResponsibles = data.responsibles
if (!Array.isArray(rawResponsibles) || rawResponsibles.length === 0) return data
const ids = rawResponsibles
.map((entry) => relationshipId(entry))
.filter((id): id is number => id !== null)
if (ids.length === 0) return data
// Bypass (documented in the hook's comment): the eligibility probe must see
// the non-eligible rows (leaders, deleted accounts) to drop them.
const eligible = await req.payload.find({
collection: 'campaignUser',
where: { and: [{ id: { in: ids } }, eligibleCampaignStaffWhere] },
depth: 0,
limit: 0,
pagination: false,
select: { name: true },
overrideAccess: true,
req,
})
const eligibleIDs = new Set(eligible.docs.map((doc) => doc.id))
data.responsibles = [...new Set(ids.filter((id) => eligibleIDs.has(id)))]
return data
}
const setCanonicalDemandSlug: CollectionBeforeValidateHook = ({ data, operation, originalDoc }) => {
if (!data) return data
const title = trimmedText(data.title ?? originalDoc?.title)
const slug = slugify(title)
if (!slug) {
throw new APIError('Informe um título com letras ou números.', 400)
}
data.title = title
data.slug = operation === 'create' ? slug : originalDoc?.slug
return data
}
const MAX_DEMAND_SLUG_ATTEMPTS = 20
/**
* With AI-derived titles (B195), equal titles across municipalities become
* likely, and the `unique` slug constraint must not turn that into a failed
* create — a demand creation can never fail over its title. Suffixes the
* candidate slug (`-2`, `-3`, …) against existing rows; runs after
* `setCanonicalDemandSlug` so `data.slug` is already the canonical candidate.
*
* Opt-in via `req.context.campaignDemandUniqueSlug` (set by the form-created
* record action): direct creates — the activity demand drafts (C90) and the
* admin UI — keep the strict constraint, which the activity rollback contract
* pins. Fail closed like the C6 bulk-import opt-outs: only honored inside an
* active transaction. A text advisory lock on the base slug serializes
* concurrent creates of the same derived title, so the probe cannot race the
* insert.
*/
const ensureUniqueDemandSlug: CollectionBeforeValidateHook = async ({ data, operation, req }) => {
if (!data || operation !== 'create' || !data.slug) return data
if (req.context?.campaignDemandUniqueSlug === true) {
if (req.transactionID == null) {
throw new APIError('campaignDemandUniqueSlug exige uma transação ativa.', 500)
}
} else {
return data
}
const baseSlug = data.slug
await acquireTextAdvisoryLocks(req.payload, req, [`campaign-demand-slug:${baseSlug}`])
// One probe for the whole candidate window instead of one query per attempt.
const candidates = Array.from({ length: MAX_DEMAND_SLUG_ATTEMPTS }, (_, index) =>
index === 0 ? baseSlug : `${baseSlug}-${index + 1}`,
)
// Intentional admin bypass: the slug-existence probe must see every demand
// row, including ones the creating staff cannot yet read.
const existing = await req.payload.find({
collection: 'campaignDemand',
where: { slug: { in: candidates } },
depth: 0,
limit: 0,
pagination: false,
overrideAccess: true,
req,
})
const existingSlugs = new Set(existing.docs.map((doc) => doc.slug))
for (const candidate of candidates) {
if (!existingSlugs.has(candidate)) {
data.slug = candidate
return data
}
}
throw new APIError('Não foi possível gerar um endereço único para a demanda.', 409)
}
const isDemandStatus = (value: unknown): value is CampaignDemandStatus =>
typeof value === 'string' && (campaignDemandStatuses as readonly string[]).includes(value)
/**
* Workflow + authorship rules (staff-only creation):
* - status moves follow campaignDemandTransitions; decisions on "escalada"
* demands are coordinator/candidate-only;
* - every status move appends a server-derived statusHistory entry.
*/
const enforceDemandWorkflow: CollectionBeforeChangeHook = async ({
data,
operation,
originalDoc,
req,
}) => {
const actor = req.user?.collection === 'campaignUser' ? req.user : null
if (operation === 'create') {
if (actor) {
data.createdBy = actor.id
// C143 — the creator is always a responsible (explicit-responsible
// visibility): union with any client-provided list so a create can
// never leave its author outside the demand's own visibility.
const existingResponsibles = Array.isArray(data.responsibles)
? data.responsibles
.map((entry) => relationshipId(entry))
.filter((id): id is number => id !== null)
: []
data.responsibles = [...new Set([...existingResponsibles, actor.id])]
}
const initialStatus = isDemandStatus(data.status) ? data.status : 'aberta'
data.status = initialStatus
data.statusHistory = [
{
status: initialStatus,
note: trimmedText(data.decisionNote) || null,
author: actor?.id ?? null,
createdAt: new Date().toISOString(),
},
]
return data
}
const previousStatus: CampaignDemandStatus = isDemandStatus(originalDoc?.status)
? originalDoc.status
: 'aberta'
const rawNextStatus: unknown = data.status === undefined ? previousStatus : data.status
if (!isDemandStatus(rawNextStatus)) {
throw new APIError(CAMPAIGN_DEMAND_INVALID_STATUS_MESSAGE, 400)
}
const nextStatus: CampaignDemandStatus = rawNextStatus
if (nextStatus !== previousStatus) {
const allowed = campaignDemandTransitions[previousStatus] ?? []
if (!allowed.includes(nextStatus)) {
throw new APIError(
`Transição de status inválida: ${campaignDemandStatusLabels[previousStatus]} → ${campaignDemandStatusLabels[nextStatus]}.`,
409,
)
}
if (
previousStatus === 'escalada' &&
(nextStatus === 'aprovada' || nextStatus === 'rejeitada') &&
actor &&
!isCampaignUnrestricted(actor)
) {
throw new APIError(CAMPAIGN_DEMAND_ESCALATED_DECISION_MESSAGE, 403)
}
const history = Array.isArray(originalDoc?.statusHistory) ? [...originalDoc.statusHistory] : []
history.push({
status: nextStatus,
note: trimmedText(data.decisionNote ?? originalDoc?.decisionNote) || null,
author: actor?.id ?? null,
createdAt: new Date().toISOString(),
})
data.statusHistory = history
if (nextStatus === 'aprovada' || nextStatus === 'rejeitada') {
data.decidedBy = actor?.id ?? null
data.decidedAt = new Date().toISOString()
}
} else if (data.statusHistory !== undefined) {
// History is append-only and server-derived.
data.statusHistory = originalDoc?.statusHistory ?? []
}
return data
}
const validateDemandActivityMunicipality: CollectionBeforeValidateHook = async ({
data,
operation,
originalDoc,
req,
}) => {
if (!data) return data
const municipalityID = relationshipId(data.municipality ?? originalDoc?.municipality)
const activityID = relationshipId(data.activity ?? originalDoc?.activity)
if (!activityID) return data
if (!municipalityID) throw new APIError('Município da demanda inválido.', 400)
if (
operation === 'update' &&
municipalityID === relationshipId(originalDoc?.municipality) &&
activityID === relationshipId(originalDoc?.activity)
) {
return data
}
const requestContext = req.context as Record<string, unknown>
const cacheKey = `campaignDemand:activityMunicipality:${activityID}`
let activityMunicipalityID = requestContext[cacheKey]
if (typeof activityMunicipalityID !== 'number') {
const activity = await req.payload.findByID({
collection: 'activity',
id: activityID,
depth: 0,
select: { municipality: true },
overrideAccess: true,
req,
})
activityMunicipalityID = relationshipId(activity.municipality)
requestContext[cacheKey] = activityMunicipalityID
}
if (activityMunicipalityID !== municipalityID) {
throw new APIError('A demanda e a atividade devem pertencer ao mesmo município.', 409)
}
return data
}
export const CampaignDemand: CollectionConfig = {
slug: 'campaignDemand',
labels: {
singular: 'Demanda',
plural: 'Demandas',
},
admin: {
group: 'Campanha',
useAsTitle: 'title',
defaultColumns: ['title', 'kind', 'municipality', 'status', 'updatedAt'],
description:
'Necessidades operacionais da campanha. Custo e comprovantes são controle interno — não substituem a prestação de contas oficial (SPCE/TSE).',
},
access: {
create: canCreateCampaignDemand,
read: canReadCampaignDemand,
update: canUpdateCampaignDemand,
delete: canDeleteCampaignDemand,
},
hooks: {
beforeValidate: [
restrictResponsiblesToStaff,
setCanonicalDemandSlug,
ensureUniqueDemandSlug,
validateDemandActivityMunicipality,
],
beforeChange: [enforceDemandWorkflow],
},
fields: [
{
name: 'title',
type: 'text',
label: 'Título',
required: true,
minLength: 2,
maxLength: 160,
index: true,
},
{
name: 'slug',
type: 'text',
label: 'Slug',
required: true,
unique: true,
index: true,
admin: {
readOnly: true,
},
access: {
create: canSetCampaignSystemField,
update: canSetCampaignSystemField,
},
},
{
name: 'kind',
type: 'select',
label: 'Tipo',
required: true,
index: true,
options: [...DEMAND_KIND_OPTIONS],
},
{
name: 'description',
type: 'textarea',
label: 'Descrição',
maxLength: 4000,
},
{
name: 'municipality',
type: 'relationship',
relationTo: 'municipality',
label: 'Município',
required: true,
index: true,
},
{
name: 'activity',
type: 'relationship',
relationTo: 'activity',
label: 'Atividade',
index: true,
},
{
name: 'leadership',
type: 'relationship',
relationTo: 'leadership',
label: 'Liderança solicitante',
index: true,
},
{
name: 'responsibles',
type: 'relationship',
relationTo: 'campaignUser',
label: 'Responsáveis',
hasMany: true,
index: true,
filterOptions: eligibleCampaignStaffWhere,
admin: {
description:
'Só responsáveis, candidato e coordenador veem a demanda. O criador entra automaticamente.',
},
},
{
name: 'status',
type: 'select',
label: 'Status',
required: true,
defaultValue: 'aberta',
index: true,
access: {
create: canManageCampaignStaffField,
update: canManageCampaignStaffField,
},
options: [...DEMAND_STATUS_OPTIONS],
},
{
name: 'decisionNote',
type: 'textarea',
label: 'Nota da decisão',
maxLength: 2000,
access: {
create: canManageCampaignStaffField,
update: canManageCampaignStaffField,
},
},
{
name: 'decidedBy',
type: 'relationship',
relationTo: 'campaignUser',
label: 'Decidida por',
admin: {
readOnly: true,
},
access: {
create: canSetCampaignSystemField,
update: canSetCampaignSystemField,
},
},
{
name: 'decidedAt',
type: 'date',
label: 'Decidida em',
admin: {
readOnly: true,
},
access: {
create: canSetCampaignSystemField,
update: canSetCampaignSystemField,
},
},
{
name: 'cost',
type: 'number',
label: 'Custo estimado (R$)',
min: 0,
access: {
create: canManageCampaignStaffField,
read: canReadCampaignStaffField,
update: canManageCampaignStaffField,
},
admin: {
description: 'Controle interno de gastos. Não substitui a prestação de contas oficial.',
},
},
{
name: 'receipts',
type: 'upload',
relationTo: 'media',
label: 'Comprovantes',
hasMany: true,
access: {
create: canManageCampaignStaffField,
read: canReadCampaignStaffField,
update: canManageCampaignStaffField,
},
admin: {
description:
'Documentos fiscais podem conter CPF/CNPJ — acesso restrito ao staff. Não substitui o SPCE.',
},
},
{
name: 'statusHistory',
type: 'array',
label: 'Histórico de status',
access: {
read: canReadCampaignStaffField,
update: canSetCampaignSystemField,
},
admin: {
readOnly: true,
},
fields: [
{
name: 'status',
type: 'select',
label: 'Status',
required: true,
options: [...DEMAND_STATUS_OPTIONS],
},
{
name: 'note',
type: 'textarea',
label: 'Nota',
maxLength: 2000,
},
{
name: 'author',
type: 'relationship',
relationTo: 'campaignUser',
label: 'Autor',
},
{
name: 'createdAt',
type: 'date',
label: 'Registrado em',
},
],
},
systemStampedActorField({ setAccess: canSetCampaignSystemField }),
],
}