Files
vfxreview/lib/shot-status.ts
twotalesanimation 94792279c5 fix(status): reset review state on a new version, and derive shot status everywhere
Requesting changes on a shot and then re-rendering it through the render queue
left every layer of the app still showing the old verdict. Three independent
causes, all on the pipeline path.

finalizePreview inherited the superseded version's approvalStatus
unconditionally. The carry-over exists so a re-export of a signed-off shot does
not reappear as awaiting review, but it applied equally to NEEDS_CHANGES and
REJECTED, so the render queued to address a note arrived already wearing that
note and nothing registered that the work had been redone. carryApproval now
carries only APPROVED.

The pipeline never moved the task. One left on CHANGES by a review or a QC fail
stayed there through every re-render, with no way out but a manual kanban drag.
A genuinely new version now moves it to INTERNAL_REVIEW, as actions/versions.ts
and batch-upload already did. A replaced version is excluded: regeneratePreview
re-delivers the same version after a slate fix and is not a new submission.

The pipeline never called recalcShotStatus at all, so shot boards went stale the
moment a render changed a task. finalizePreview and the QC fail path both
recalculate now; the latter already documented the REVISIONS derivation it was
relying on and never triggering.

Shot.status is derived from tasks and approval flags, but six call sites wrote
it directly with the status they expected: internallyApproveShot,
shareWithClient, unshareFromClient, clientApproveShot, unapproveShot and the
client approve route. Rule 1 of the derivation is that any CHANGES task outranks
an approval, so a shot could be pushed past open rework and then snap back to
REVISIONS on the next unrelated recalc, which is close to unreportable as a bug.
They now set the approval inputs and let recalcShotStatus derive.
unshareFromClient additionally hardcoded READY_FOR_CLIENT even for a
client-approved shot. updateShotStatus keeps its direct write as the deliberate
manual override, now documented as transient for the same reason.

markShotForRevisions replaces the duplicated change-request logic. Both copies
marked all non-DONE tasks CHANGES, which matches nothing on the shot this is
most often called for: one out for client review precisely because all its tasks
are finished. The request then derived to INTERNAL_REVIEW and had no visible
effect anywhere. When nothing is picked up it now reopens the task behind the
shot's latest version, which is the deliverable the reviewer was looking at.

A client's shot-level change request also marks the versions and writes Approval
rows now. The dashboard counters, the version badges and the portal's own
filters all read Version.approvalStatus, so a shot-level verdict was invisible
everywhere those look.

clearStaleShotApproval covers the reverse case: uploading a new version onto an
approved shot moved the task to INTERNAL_REVIEW and changed nothing visible,
because the derivation short-circuits on shotApprovalStatus. The shot kept
reading COMPLETE while carrying work nobody had looked at. This is the one
user-visible behaviour change here, so watch the boards on a live show: an
approved shot now drops back to INTERNAL_REVIEW on a new upload. sharedWithClient
is deliberately left alone, since revoking client access stays a separate act.

submitApproval and unapproveVersion are transactional now. The verdict, the
version, the task and the derived shot status are one decision, and a failure
partway through left the three layers disagreeing with no way to tell which one
was right.

KanbanCard compared approvalStatus against "CHANGES_REQUESTED", which is not a
member of the enum, so the changes-requested icon never rendered at all.

Thirteen tests cover carryApproval, markShotForRevisions including the all-DONE
regression, and clearStaleShotApproval. What is not covered is the pipeline
transaction itself, which needs a database: queue a render against a shot in
REVISIONS and confirm the task and shot both move before trusting this on a
show.

Version.reviewStatus is still written nowhere while being published through
ext/shots/lookup and EXT_API_REFERENCE.md as a permanent "PENDING". Left alone
deliberately: removing a field from that contract could break the connector.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-31 18:17:04 +02:00

177 lines
5.7 KiB
TypeScript

import { ShotStatus, ShotApprovalStatus, TaskStatus } from "@prisma/client";
import { db } from "@/lib/db";
import type { PrismaClient } from "@prisma/client";
type TxClient = Omit<
PrismaClient,
"$connect" | "$disconnect" | "$on" | "$transaction" | "$use" | "$extends"
>;
/**
* Derive shot status from tasks + shot-level approval fields.
*
* Priority order (highest → lowest):
* 1. REVISIONS — any task is CHANGES
* 2. COMPLETE — shotApprovalStatus === CLIENT_APPROVED
* 3. CLIENT_REVIEW — shotApprovalStatus === INTERNALLY_APPROVED && sharedWithClient
* 4. READY_FOR_CLIENT — shotApprovalStatus === INTERNALLY_APPROVED && !sharedWithClient
* 5. IN_PROGRESS — any task is TODO or IN_PROGRESS
* 6. INTERNAL_REVIEW — tasks exist but none blocking, approval still PENDING
* 7. WAITING — no tasks
*/
export function deriveShotStatus(
tasks: { status: TaskStatus }[],
shotApprovalStatus: ShotApprovalStatus,
sharedWithClient: boolean
): ShotStatus {
// 1. Changes requested — highest priority
if (tasks.some((t) => t.status === "CHANGES")) return "REVISIONS";
// 2. Client approved — terminal completion state
if (shotApprovalStatus === "CLIENT_APPROVED") return "COMPLETE";
// 3 & 4. Internally approved — client-facing states
if (shotApprovalStatus === "INTERNALLY_APPROVED") {
return sharedWithClient ? "CLIENT_REVIEW" : "READY_FOR_CLIENT";
}
// 5. Active work in progress (approval still PENDING)
if (tasks.some((t) => t.status === "TODO" || t.status === "IN_PROGRESS")) {
return "IN_PROGRESS";
}
// 6. All work done, awaiting internal approval
if (tasks.length > 0) return "INTERNAL_REVIEW";
// 7. No tasks yet
return "WAITING";
}
/**
* Query all tasks + approval fields for a shot, derive the correct ShotStatus,
* and persist it. Accepts an optional Prisma transaction client (tx).
*/
export async function recalcShotStatus(
shotId: string,
tx?: TxClient
): Promise<void> {
const client = tx ?? db;
const [tasks, shot] = await Promise.all([
client.task.findMany({
where: { shotId },
select: { status: true },
}),
client.shot.findUnique({
where: { id: shotId },
select: { shotApprovalStatus: true, sharedWithClient: true },
}),
]);
if (!shot) return;
const newStatus = deriveShotStatus(tasks, shot.shotApprovalStatus, shot.sharedWithClient);
await client.shot.update({
where: { id: shotId },
data: { status: newStatus },
});
}
/**
* New review material arrived on a shot, so any standing sign-off is stale.
*
* deriveShotStatus short-circuits on shotApprovalStatus: a CLIENT_APPROVED shot
* reads COMPLETE and an INTERNALLY_APPROVED one reads READY_FOR_CLIENT no matter
* what its tasks say. Without this, uploading a new version onto an approved
* shot moved the task to INTERNAL_REVIEW and changed nothing visible — the shot
* still read as signed off while carrying work nobody had looked at.
*
* sharedWithClient is left alone; clearing the approval is enough to pull the
* shot back to INTERNAL_REVIEW, and revoking client access is a separate,
* deliberate act (unshareFromClient).
*
* @returns true if a stale approval was actually cleared.
*/
export async function clearStaleShotApproval(
client: TxClient,
shotId: string
): Promise<boolean> {
const shot = await client.shot.findUnique({
where: { id: shotId },
select: { shotApprovalStatus: true },
});
if (!shot || shot.shotApprovalStatus === "PENDING") return false;
await client.shot.update({
where: { id: shotId },
data: { shotApprovalStatus: "PENDING" },
});
return true;
}
/**
* Put a shot into revisions: clear its approval, unshare it, and mark the tasks
* that need rework so the derivation lands on REVISIONS.
*
* The task selection is the subtle part. Marking every non-DONE task as CHANGES
* matches nothing at all on the shot this is most often called for — one that is
* out for client review precisely *because* all of its tasks are finished. That
* left the shot deriving to INTERNAL_REVIEW and the change request with no
* visible effect anywhere. So when nothing was picked up, the task behind the
* shot's latest version is marked instead: that is the deliverable the reviewer
* was actually looking at.
*
* @param taskId Mark only this task (a reviewer calling out one specific task).
* @returns ids of the tasks moved to CHANGES.
*/
export async function markShotForRevisions(
client: TxClient,
shotId: string,
taskId?: string
): Promise<string[]> {
await client.shot.update({
where: { id: shotId },
data: { shotApprovalStatus: "PENDING", sharedWithClient: false },
});
let changed: string[];
if (taskId) {
await client.task.update({ where: { id: taskId }, data: { status: "CHANGES" } });
changed = [taskId];
} else {
const open = await client.task.findMany({
where: { shotId, status: { not: "DONE" } },
select: { id: true },
});
if (open.length > 0) {
await client.task.updateMany({
where: { shotId, status: { not: "DONE" } },
data: { status: "CHANGES" },
});
changed = open.map((t) => t.id);
} else {
// Every task is DONE — reopen the one that produced what was reviewed.
const latest = await client.version.findFirst({
where: { task: { shotId } },
orderBy: [{ isLatest: "desc" }, { createdAt: "desc" }],
select: { taskId: true },
});
if (latest?.taskId) {
await client.task.update({
where: { id: latest.taskId },
data: { status: "CHANGES" },
});
changed = [latest.taskId];
} else {
changed = [];
}
}
}
await recalcShotStatus(shotId, client);
return changed;
}