|
| 1 | +// Copyright (c) 2026 ObjectStack. Licensed under the Apache-2.0 license. |
| 2 | + |
| 3 | +/** |
| 4 | + * `ApprovalEscalation.timeoutHours` is CALENDAR (wall-clock) hours — pinned |
| 5 | + * through the real code path, not restated. |
| 6 | + * |
| 7 | + * The declaration's `describe` text on `ApprovalEscalationSchema` says the |
| 8 | + * clock out loud; `slaDueAt` in `approval-service.ts` is the one runtime site |
| 9 | + * that turns the declared number into a deadline; the escalation sweep compares |
| 10 | + * that deadline against the injected clock. This file drives all three through |
| 11 | + * `openNodeRequest` → `getRequest` → `runEscalations`, so the sentence in the |
| 12 | + * schema and the arithmetic in the service cannot drift apart without a red |
| 13 | + * here. |
| 14 | + * |
| 15 | + * Timezone assumption, stated: NONE is required. Every timestamp the service |
| 16 | + * reads or writes is an ISO-8601 UTC string (`toISOString()` / `Date.parse` of |
| 17 | + * a `Z`-suffixed literal) and the deadline is `created_at` plus elapsed |
| 18 | + * milliseconds, so the assertions hold under any `TZ` the runner sets — they |
| 19 | + * are written against UTC instants and never call a local-time accessor. The |
| 20 | + * DST cases document what the SAME instants read as on a wall clock in |
| 21 | + * America/New_York, to make the elapsed-time-versus-local-time distinction |
| 22 | + * visible where a reader would otherwise infer it. |
| 23 | + */ |
| 24 | + |
| 25 | +import { describe, it, expect } from 'vitest'; |
| 26 | +import { ApprovalService } from './approval-service.js'; |
| 27 | + |
| 28 | +interface Row { [k: string]: any } |
| 29 | + |
| 30 | +/** |
| 31 | + * Read-and-append engine double: `find` + `insert` only. |
| 32 | + * |
| 33 | + * The three paths under test dispatch nothing else — `openNodeRequest` finds |
| 34 | + * and inserts, `getRequest` finds, and the `notify` escalation arm finds and |
| 35 | + * inserts the audit action. No `update` / `delete` member exists on purpose: |
| 36 | + * `check:engine-double-contract` pins those write verbs to the real engine's |
| 37 | + * dispatch, and a double that does not declare them has nothing to pin. |
| 38 | + */ |
| 39 | +function makeEngine() { |
| 40 | + const tables: Record<string, Row[]> = {}; |
| 41 | + const ensure = (n: string) => (tables[n] ??= []); |
| 42 | + const matches = (row: Row, filter: any): boolean => { |
| 43 | + if (!filter || typeof filter !== 'object') return true; |
| 44 | + for (const [k, v] of Object.entries(filter)) { |
| 45 | + if (k === '$or') { |
| 46 | + if (!(v as any[]).some((sub) => matches(row, sub))) return false; |
| 47 | + continue; |
| 48 | + } |
| 49 | + if (k.startsWith('$')) throw new Error(`fake engine: unsupported filter operator ${k}`); |
| 50 | + const rv = row[k]; |
| 51 | + if (v != null && typeof v === 'object' && '$in' in (v as any)) { |
| 52 | + if (!(v as any).$in.includes(rv)) return false; |
| 53 | + continue; |
| 54 | + } |
| 55 | + if (v != null && typeof v === 'object' && '$ne' in (v as any)) { |
| 56 | + if (rv === (v as any).$ne) return false; |
| 57 | + continue; |
| 58 | + } |
| 59 | + if (rv !== v) return false; |
| 60 | + } |
| 61 | + return true; |
| 62 | + }; |
| 63 | + return { |
| 64 | + _tables: tables, |
| 65 | + async find(object: string, options?: any) { |
| 66 | + const rows = ensure(object).filter((r) => matches(r, options?.filter ?? options?.where)); |
| 67 | + // Honour the caller's bound by presence, after the filter — the shape |
| 68 | + // `check:objectql-double-limit` pins, so a `limit: 1` read cannot be |
| 69 | + // silently answered with every row. |
| 70 | + return typeof options?.limit === 'number' ? rows.slice(0, options.limit) : rows; |
| 71 | + }, |
| 72 | + async insert(object: string, data: Row) { ensure(object).push({ ...data }); return { ...data }; }, |
| 73 | + async count(object: string) { return ensure(object).length; }, |
| 74 | + registerHook() { /* no-op */ }, |
| 75 | + unregisterHooksByPackage() { /* no-op */ }, |
| 76 | + }; |
| 77 | +} |
| 78 | + |
| 79 | +const HOUR = 3_600_000; |
| 80 | +const SYS = { isSystem: true, positions: [], permissions: [] } as any; |
| 81 | +const CTX = { userId: 'u1', tenantId: 't1', positions: [], permissions: [] } as any; |
| 82 | + |
| 83 | +/** A node whose only escalation dependency is the clock: `notify`, no reassign. */ |
| 84 | +function input(nodeId: string, timeoutHours: number) { |
| 85 | + return { |
| 86 | + object: 'opportunity', |
| 87 | + recordId: 'opp1', |
| 88 | + runId: 'run_1', |
| 89 | + nodeId, |
| 90 | + flowName: 'deal_approval', |
| 91 | + config: { |
| 92 | + approvers: [{ type: 'user' as const, value: 'u9' }], |
| 93 | + behavior: 'first_response' as const, |
| 94 | + lockRecord: false, |
| 95 | + escalation: { timeoutHours, action: 'notify' as const, escalateTo: 'boss', notifySubmitter: false }, |
| 96 | + }, |
| 97 | + record: { id: 'opp1', amount: 100 }, |
| 98 | + }; |
| 99 | +} |
| 100 | + |
| 101 | +/** |
| 102 | + * Open a node request and return the PENDING row. `openNodeRequest` can also |
| 103 | + * answer with an auto outcome (an empty approver slate under |
| 104 | + * `onEmptyApprovers: 'auto_approve'`), which carries no `id` and no SLA — the |
| 105 | + * arm this file is not about, so it is refused loudly rather than narrowed |
| 106 | + * away with a cast. |
| 107 | + */ |
| 108 | +async function openPending(svc: ApprovalService, nodeInput: ReturnType<typeof input>) { |
| 109 | + const opened = await svc.openNodeRequest(nodeInput, CTX); |
| 110 | + if (!('id' in opened)) throw new Error('expected a pending approval request, got an auto outcome'); |
| 111 | + return opened; |
| 112 | +} |
| 113 | + |
| 114 | +/** A service whose clock is set by the test, in UTC instants. */ |
| 115 | +function serviceAt(iso: string) { |
| 116 | + let nowMs = Date.parse(iso); |
| 117 | + const engine = makeEngine(); |
| 118 | + const svc = new ApprovalService({ engine: engine as any, clock: { now: () => new Date(nowMs) } }); |
| 119 | + return { svc, engine, setNow: (at: string) => { nowMs = Date.parse(at); } }; |
| 120 | +} |
| 121 | + |
| 122 | +const utcDay = (iso: string) => new Date(iso).getUTCDay(); // 0 = Sunday … 5 = Friday, 6 = Saturday |
| 123 | + |
| 124 | +// 2026-01-16 is a Friday; the calendar claims below are about the dates they name. |
| 125 | +const FRIDAY_1700 = '2026-01-16T17:00:00.000Z'; |
| 126 | +const MONDAY_0900 = '2026-01-19T09:00:00.000Z'; |
| 127 | + |
| 128 | +describe('ApprovalEscalation.timeoutHours is calendar (wall-clock) hours', () => { |
| 129 | + it('the fixture dates are the weekdays the assertions name', () => { |
| 130 | + expect(utcDay(FRIDAY_1700)).toBe(5); |
| 131 | + expect(utcDay(MONDAY_0900)).toBe(1); |
| 132 | + }); |
| 133 | + |
| 134 | + it('Friday 17:00 + timeoutHours 4 is due Friday 21:00 — the same evening, not the next business day', async () => { |
| 135 | + const { svc, setNow } = serviceAt(FRIDAY_1700); |
| 136 | + const req = await openPending(svc, input('sla_4h', 4)); |
| 137 | + |
| 138 | + const row = await svc.getRequest(req.id, SYS); |
| 139 | + expect(row?.created_at).toBe(FRIDAY_1700); |
| 140 | + expect(row?.sla_due_at).toBe('2026-01-16T21:00:00.000Z'); |
| 141 | + expect(utcDay(row!.sla_due_at!)).toBe(5); |
| 142 | + // A business-hours reading would put this deadline on Monday at the |
| 143 | + // earliest; the wall clock puts it before Monday's first working hour. |
| 144 | + expect(Date.parse(row!.sla_due_at!)).toBeLessThan(Date.parse(MONDAY_0900)); |
| 145 | + |
| 146 | + // The sweep reads the same deadline: one millisecond early is not overdue, |
| 147 | + // the deadline instant itself is — on Friday night, with nobody at work. |
| 148 | + setNow('2026-01-16T20:59:59.999Z'); |
| 149 | + expect(await svc.runEscalations()).toMatchObject({ escalated: 0 }); |
| 150 | + setNow('2026-01-16T21:00:00.000Z'); |
| 151 | + expect(await svc.runEscalations()).toMatchObject({ escalated: 1 }); |
| 152 | + |
| 153 | + const actions = await svc.listActions(req.id, SYS); |
| 154 | + expect(actions.at(-1)).toMatchObject({ action: 'escalate', actor_id: 'system:sla' }); |
| 155 | + }); |
| 156 | + |
| 157 | + it('a 168-hour deadline spans the weekend: due the next Friday at the same hour, 7 × 24 elapsed hours', async () => { |
| 158 | + const { svc, setNow } = serviceAt(FRIDAY_1700); |
| 159 | + const req = await openPending(svc, input('sla_168h', 168)); |
| 160 | + |
| 161 | + const row = await svc.getRequest(req.id, SYS); |
| 162 | + const due = row!.sla_due_at!; |
| 163 | + expect(due).toBe('2026-01-23T17:00:00.000Z'); |
| 164 | + expect(utcDay(due)).toBe(5); |
| 165 | + expect(Date.parse(due) - Date.parse(FRIDAY_1700)).toBe(168 * HOUR); |
| 166 | + |
| 167 | + // Saturday and Sunday sit inside the window and are not skipped: the |
| 168 | + // deadline is not 168 working hours later (that would be four weeks out). |
| 169 | + const saturday = '2026-01-17T12:00:00.000Z'; |
| 170 | + const sunday = '2026-01-18T12:00:00.000Z'; |
| 171 | + expect(utcDay(saturday)).toBe(6); |
| 172 | + expect(utcDay(sunday)).toBe(0); |
| 173 | + for (const weekendInstant of [saturday, sunday]) { |
| 174 | + expect(Date.parse(weekendInstant)).toBeGreaterThan(Date.parse(FRIDAY_1700)); |
| 175 | + expect(Date.parse(weekendInstant)).toBeLessThan(Date.parse(due)); |
| 176 | + } |
| 177 | + |
| 178 | + setNow(MONDAY_0900); |
| 179 | + expect(await svc.runEscalations()).toMatchObject({ escalated: 0 }); |
| 180 | + setNow(due); |
| 181 | + expect(await svc.runEscalations()).toMatchObject({ escalated: 1 }); |
| 182 | + }); |
| 183 | + |
| 184 | + it('a DST transition changes nothing: elapsed hours, not local wall-clock hours (spring forward)', async () => { |
| 185 | + // 2026-03-08T05:00:00Z is 00:00 EST in America/New_York; at 02:00 local the |
| 186 | + // clocks jump to 03:00 EDT. Four ELAPSED hours later is 09:00Z = 05:00 EDT — |
| 187 | + // five o'clock on the local wall, four hours of real time. The service adds |
| 188 | + // elapsed milliseconds, so the deadline is the 09:00Z instant on every host. |
| 189 | + const created = '2026-03-08T05:00:00.000Z'; |
| 190 | + const { svc } = serviceAt(created); |
| 191 | + const req = await openPending(svc, input('sla_dst_spring', 4)); |
| 192 | + const row = await svc.getRequest(req.id, SYS); |
| 193 | + expect(row?.sla_due_at).toBe('2026-03-08T09:00:00.000Z'); |
| 194 | + expect(Date.parse(row!.sla_due_at!) - Date.parse(created)).toBe(4 * HOUR); |
| 195 | + }); |
| 196 | + |
| 197 | + it('a DST transition changes nothing: elapsed hours, not local wall-clock hours (fall back)', async () => { |
| 198 | + // 2026-11-01T05:00:00Z is 01:00 EDT in America/New_York; at 02:00 EDT the |
| 199 | + // clocks go back to 01:00 EST. Four ELAPSED hours later is 09:00Z = 04:00 |
| 200 | + // EST — three o'clock-hours on the local wall, four hours of real time. |
| 201 | + const created = '2026-11-01T05:00:00.000Z'; |
| 202 | + const { svc } = serviceAt(created); |
| 203 | + const req = await openPending(svc, input('sla_dst_fall', 4)); |
| 204 | + const row = await svc.getRequest(req.id, SYS); |
| 205 | + expect(row?.sla_due_at).toBe('2026-11-01T09:00:00.000Z'); |
| 206 | + expect(Date.parse(row!.sla_due_at!) - Date.parse(created)).toBe(4 * HOUR); |
| 207 | + }); |
| 208 | +}); |
0 commit comments