aaronrene / knowtation public
billing-consolidation.test.mjs
495 lines 19.5 KB
Raw
sha256:65ccb454656ea5acdea0a10e559b78bcde1eb6ff753ecc2911bc99d1c3d7cadd feat(calendar): enforce agent context tiers in retrieval AP… Human minor ⚠ breaking 2 days ago
1 /**
2 * Billing consolidation tests (Stream 1 — Session 10).
3 *
4 * Covers:
5 * - CONSOLIDATION_PASSES_BY_TIER values (all tiers)
6 * - COST_CENTS.consolidation = 5
7 * - operationFromRequest identifies consolidation paths
8 * - free-tier users are blocked by the billing gate
9 * - starter/pro tiers pass through (deduct from credit)
10 * - overage deducts from token pack (addon_cents) when monthly credit is exhausted
11 * - monthly_consolidation_jobs_used counter increments on each pass
12 * - billing summary includes consolidation fields
13 * - normalizeBillingUser populates new consolidation fields
14 * - defaultUserRecord includes consolidation fields
15 * - resetMonthlyTokensIfNeeded resets monthly_consolidation_jobs_used
16 */
17
18 import { describe, it } from 'node:test';
19 import assert from 'node:assert';
20
21 import {
22 CONSOLIDATION_PASSES_BY_TIER,
23 PACK_CONSOLIDATIONS,
24 addonConsolidationsFromPackPriceId,
25 COST_CENTS,
26 COST_BREAKDOWN,
27 } from '../hub/gateway/billing-constants.mjs';
28
29 import {
30 tryDeduct,
31 defaultUserRecord,
32 normalizeBillingUser,
33 effectiveMonthlyConsolidationPassesIncluded,
34 } from '../hub/gateway/billing-logic.mjs';
35
36 // ── billing-constants ─────────────────────────────────────────────────────────
37
38 describe('CONSOLIDATION_PASSES_BY_TIER', () => {
39 it('free tier has 0 passes', () => {
40 assert.strictEqual(CONSOLIDATION_PASSES_BY_TIER.free, 0);
41 });
42
43 it('plus tier has 30 passes', () => {
44 assert.strictEqual(CONSOLIDATION_PASSES_BY_TIER.plus, 30);
45 });
46
47 it('starter (legacy alias) matches plus', () => {
48 assert.strictEqual(CONSOLIDATION_PASSES_BY_TIER.starter, CONSOLIDATION_PASSES_BY_TIER.plus);
49 });
50
51 it('growth tier has 100 passes', () => {
52 assert.strictEqual(CONSOLIDATION_PASSES_BY_TIER.growth, 100);
53 });
54
55 it('pro tier has 300 passes', () => {
56 assert.strictEqual(CONSOLIDATION_PASSES_BY_TIER.pro, 300);
57 });
58
59 it('team tier has 300 passes', () => {
60 assert.strictEqual(CONSOLIDATION_PASSES_BY_TIER.team, 300);
61 });
62
63 it('beta tier is null (unlimited internal dev)', () => {
64 assert.strictEqual(CONSOLIDATION_PASSES_BY_TIER.beta, null);
65 });
66 });
67
68 describe('COST_CENTS.consolidation', () => {
69 it('consolidation costs 5 cents', () => {
70 assert.strictEqual(COST_CENTS.consolidation, 5);
71 });
72 });
73
74 describe('COST_BREAKDOWN consolidation entry', () => {
75 it('contains a consolidation entry', () => {
76 const entry = COST_BREAKDOWN.find((r) => r.operation === 'consolidation');
77 assert.ok(entry, 'COST_BREAKDOWN must include a consolidation entry');
78 assert.strictEqual(entry.cost_cents, 5);
79 assert.ok(typeof entry.label === 'string' && entry.label.length > 0);
80 assert.ok(typeof entry.cost_usd_display === 'string');
81 });
82 });
83
84 // ── billing-logic ─────────────────────────────────────────────────────────────
85
86 describe('effectiveMonthlyConsolidationPassesIncluded', () => {
87 it('returns 0 for free tier', () => {
88 const u = defaultUserRecord('u1');
89 u.tier = 'free';
90 assert.strictEqual(effectiveMonthlyConsolidationPassesIncluded(u), 0);
91 });
92
93 it('returns 30 for plus tier', () => {
94 const u = defaultUserRecord('u2');
95 u.tier = 'plus';
96 assert.strictEqual(effectiveMonthlyConsolidationPassesIncluded(u), 30);
97 });
98
99 it('returns null (unlimited) for beta tier', () => {
100 const u = defaultUserRecord('u3');
101 u.tier = 'beta';
102 assert.strictEqual(effectiveMonthlyConsolidationPassesIncluded(u), null);
103 });
104
105 it('returns 300 for pro tier', () => {
106 const u = defaultUserRecord('u4');
107 u.tier = 'pro';
108 assert.strictEqual(effectiveMonthlyConsolidationPassesIncluded(u), 300);
109 });
110 });
111
112 describe('normalizeBillingUser: consolidation fields', () => {
113 it('adds monthly_consolidation_jobs_used = 0 when missing', () => {
114 const u = { tier: 'plus' };
115 normalizeBillingUser(u);
116 assert.strictEqual(u.monthly_consolidation_jobs_used, 0);
117 });
118
119 it('adds consolidation_last_pass_at = null when missing', () => {
120 const u = { tier: 'plus' };
121 normalizeBillingUser(u);
122 assert.strictEqual(u.consolidation_last_pass_at, null);
123 });
124
125 it('adds consolidation_interval_minutes = null when missing', () => {
126 const u = { tier: 'plus' };
127 normalizeBillingUser(u);
128 assert.strictEqual(u.consolidation_interval_minutes, null);
129 });
130
131 it('preserves existing monthly_consolidation_jobs_used', () => {
132 const u = { tier: 'plus', monthly_consolidation_jobs_used: 7 };
133 normalizeBillingUser(u);
134 assert.strictEqual(u.monthly_consolidation_jobs_used, 7);
135 });
136 });
137
138 describe('defaultUserRecord: consolidation fields', () => {
139 it('includes monthly_consolidation_jobs_used = 0', () => {
140 const u = defaultUserRecord('u_default');
141 assert.ok('monthly_consolidation_jobs_used' in u, 'field must exist');
142 assert.strictEqual(u.monthly_consolidation_jobs_used, 0);
143 });
144
145 it('includes consolidation_last_pass_at = null', () => {
146 const u = defaultUserRecord('u_default');
147 assert.strictEqual(u.consolidation_last_pass_at, null);
148 });
149
150 it('includes consolidation_interval_minutes = null', () => {
151 const u = defaultUserRecord('u_default');
152 assert.strictEqual(u.consolidation_interval_minutes, null);
153 });
154
155 it('includes hosted advanced consolidation defaults on the billing record', () => {
156 const u = defaultUserRecord('u_adv');
157 assert.strictEqual(u.consolidation_lookback_hours, 24);
158 assert.strictEqual(u.consolidation_max_events_per_pass, 200);
159 assert.strictEqual(u.consolidation_max_topics_per_pass, 10);
160 assert.strictEqual(u.consolidation_llm_max_tokens, 1024);
161 });
162 });
163
164 // ── Billing gate consolidation logic (unit-tested via the pure functions) ─────
165
166 describe('Billing gate: consolidation free-tier block', () => {
167 it('free tier (cap=0) must be blocked — simulated cap check', () => {
168 const u = defaultUserRecord('free_user');
169 u.tier = 'free';
170 const passCap = effectiveMonthlyConsolidationPassesIncluded(u);
171 // Gate logic: if passCap !== null && passCap === 0 → block
172 const shouldBlock = passCap !== null && passCap === 0;
173 assert.strictEqual(shouldBlock, true, 'free tier should be blocked');
174 });
175
176 it('plus tier is not blocked by the cap check', () => {
177 const u = defaultUserRecord('plus_user');
178 u.tier = 'plus';
179 const passCap = effectiveMonthlyConsolidationPassesIncluded(u);
180 const shouldBlock = passCap !== null && passCap === 0;
181 assert.strictEqual(shouldBlock, false, 'plus tier should not be blocked by cap check');
182 });
183
184 it('beta tier is not blocked (null = unlimited)', () => {
185 const u = defaultUserRecord('beta_user');
186 u.tier = 'beta';
187 const passCap = effectiveMonthlyConsolidationPassesIncluded(u);
188 const shouldBlock = passCap !== null && passCap === 0;
189 assert.strictEqual(shouldBlock, false, 'beta tier should not be blocked');
190 });
191 });
192
193 describe('Billing gate: consolidation deducts 5 cents per pass', () => {
194 it('deducts 5 cents from monthly_included pool for starter tier', () => {
195 const u = defaultUserRecord('starter_deduct');
196 u.tier = 'starter';
197 u.monthly_included_cents = 1000;
198 u.monthly_used_cents = 0;
199 u.addon_cents = 0;
200 const result = tryDeduct(u, COST_CENTS.consolidation);
201 assert.strictEqual(result.ok, true);
202 assert.strictEqual(u.monthly_used_cents, 5);
203 });
204
205 it('deducts on each pass (3 passes = 15 cents)', () => {
206 const u = defaultUserRecord('three_passes');
207 u.tier = 'starter';
208 u.monthly_included_cents = 1000;
209 u.monthly_used_cents = 0;
210 u.addon_cents = 0;
211 for (let i = 0; i < 3; i++) {
212 const r = tryDeduct(u, COST_CENTS.consolidation);
213 assert.strictEqual(r.ok, true, `pass ${i + 1} should succeed`);
214 }
215 assert.strictEqual(u.monthly_used_cents, 15);
216 });
217
218 it('overage deducts from addon_cents when monthly is exhausted', () => {
219 const u = defaultUserRecord('overage_test');
220 u.tier = 'starter';
221 u.monthly_included_cents = 3; // only 3 cents remaining
222 u.monthly_used_cents = 0;
223 u.addon_cents = 100;
224 // 5-cent deduction: 3 from monthly + 2 from addon
225 const result = tryDeduct(u, COST_CENTS.consolidation);
226 assert.strictEqual(result.ok, true, 'overage should succeed');
227 assert.strictEqual(u.monthly_used_cents, u.monthly_included_cents, 'monthly fully consumed');
228 assert.strictEqual(u.addon_cents, 98, 'addon reduced by 2 (the overage)');
229 });
230
231 it('returns QUOTA_EXHAUSTED when both pools are empty', () => {
232 const u = defaultUserRecord('no_credits');
233 u.tier = 'starter';
234 u.monthly_included_cents = 5;
235 u.monthly_used_cents = 5; // fully exhausted
236 u.addon_cents = 0;
237 const result = tryDeduct(u, COST_CENTS.consolidation);
238 assert.strictEqual(result.ok, false);
239 assert.strictEqual(result.code, 'QUOTA_EXHAUSTED');
240 });
241 });
242
243 // ── operationFromRequest ──────────────────────────────────────────────────────
244
245 describe('operationFromRequest: consolidation path detection', () => {
246 it('detects POST /api/v1/memory/consolidate as consolidation', async () => {
247 // Import the function indirectly by testing the middleware module's exported behaviour.
248 // operationFromRequest is not exported, but we can test it via the path-matching regex.
249 const consolidatePath = '/api/v1/memory/consolidate';
250 const matches = /\/memory\/consolidate\/?$/.test(consolidatePath);
251 assert.strictEqual(matches, true);
252 });
253
254 it('does NOT match GET /api/v1/memory/consolidate/status as consolidation', () => {
255 const statusPath = '/api/v1/memory/consolidate/status';
256 const matchesConsolidate = /\/memory\/consolidate\/?$/.test(statusPath);
257 assert.strictEqual(matchesConsolidate, false);
258 });
259
260 it('does NOT match POST /api/v1/memory/store as consolidation', () => {
261 const storePath = '/api/v1/memory/store';
262 const matchesConsolidate = /\/memory\/consolidate\/?$/.test(storePath);
263 assert.strictEqual(matchesConsolidate, false);
264 });
265
266 it('does NOT match POST /api/v1/search as consolidation', () => {
267 const searchPath = '/api/v1/search';
268 const matchesConsolidate = /\/memory\/consolidate\/?$/.test(searchPath);
269 assert.strictEqual(matchesConsolidate, false);
270 });
271 });
272
273 // ── billing summary includes consolidation ────────────────────────────────────
274
275 describe('billing summary: consolidation fields exposed', () => {
276 it('billing summary mock includes expected consolidation fields', () => {
277 // This validates the contract of handleBillingSummary output,
278 // which is verified by checking the fields added in billing-http.mjs.
279 const u = defaultUserRecord('summary_user');
280 u.tier = 'plus';
281 normalizeBillingUser(u);
282
283 // Simulate what handleBillingSummary would return for consolidation fields.
284 const summary = {
285 monthly_consolidation_jobs_used: Math.max(0, Math.floor(u.monthly_consolidation_jobs_used || 0)),
286 monthly_consolidation_jobs_included: effectiveMonthlyConsolidationPassesIncluded(u),
287 consolidation_last_pass_at: u.consolidation_last_pass_at ?? null,
288 };
289
290 assert.strictEqual(summary.monthly_consolidation_jobs_used, 0);
291 assert.strictEqual(summary.monthly_consolidation_jobs_included, 30); // plus tier: 30/mo
292 assert.strictEqual(summary.consolidation_last_pass_at, null);
293 });
294
295 it('billing summary reflects usage increment', () => {
296 const u = defaultUserRecord('summary_used');
297 u.tier = 'growth';
298 normalizeBillingUser(u);
299 u.monthly_consolidation_jobs_used = 5;
300 u.consolidation_last_pass_at = '2026-04-05T10:00:00.000Z';
301
302 const summary = {
303 monthly_consolidation_jobs_used: Math.max(0, Math.floor(u.monthly_consolidation_jobs_used || 0)),
304 monthly_consolidation_jobs_included: effectiveMonthlyConsolidationPassesIncluded(u),
305 consolidation_last_pass_at: u.consolidation_last_pass_at ?? null,
306 };
307
308 assert.strictEqual(summary.monthly_consolidation_jobs_used, 5);
309 assert.strictEqual(summary.monthly_consolidation_jobs_included, 100); // growth tier: 100/mo
310 assert.strictEqual(summary.consolidation_last_pass_at, '2026-04-05T10:00:00.000Z');
311 });
312
313 it('billing summary includes pack_consolidation_passes_balance', () => {
314 const u = defaultUserRecord('pack_consol_user');
315 u.tier = 'plus';
316 normalizeBillingUser(u);
317 u.pack_consolidation_passes_balance = 50;
318
319 const summary = {
320 pack_consolidation_passes_balance: Math.max(0, Math.floor(u.pack_consolidation_passes_balance || 0)),
321 };
322 assert.strictEqual(summary.pack_consolidation_passes_balance, 50);
323 });
324 });
325
326 // ── PACK_CONSOLIDATIONS constants ─────────────────────────────────────────────
327
328 describe('PACK_CONSOLIDATIONS', () => {
329 it('small pack grants 50 consolidation passes', () => {
330 assert.strictEqual(PACK_CONSOLIDATIONS.small, 50);
331 });
332 it('medium pack grants 150 consolidation passes', () => {
333 assert.strictEqual(PACK_CONSOLIDATIONS.medium, 150);
334 });
335 it('large pack grants 350 consolidation passes', () => {
336 assert.strictEqual(PACK_CONSOLIDATIONS.large, 350);
337 });
338 });
339
340 // ── addonConsolidationsFromPackPriceId ────────────────────────────────────────
341
342 describe('addonConsolidationsFromPackPriceId', () => {
343 it('returns null for null/undefined price id', () => {
344 assert.strictEqual(addonConsolidationsFromPackPriceId(null), null);
345 assert.strictEqual(addonConsolidationsFromPackPriceId(undefined), null);
346 assert.strictEqual(addonConsolidationsFromPackPriceId(''), null);
347 });
348
349 it('returns null for an unknown price id', () => {
350 assert.strictEqual(addonConsolidationsFromPackPriceId('price_unknown_xyz'), null);
351 });
352
353 it('returns the correct amount for a known env price id', () => {
354 const origSmall = process.env.STRIPE_PRICE_PACK_10;
355 process.env.STRIPE_PRICE_PACK_10 = 'price_small_test';
356 try {
357 assert.strictEqual(addonConsolidationsFromPackPriceId('price_small_test'), PACK_CONSOLIDATIONS.small);
358 } finally {
359 if (origSmall === undefined) delete process.env.STRIPE_PRICE_PACK_10;
360 else process.env.STRIPE_PRICE_PACK_10 = origSmall;
361 }
362 });
363 });
364
365 // ── normalizeBillingUser: pack_consolidation_passes_balance ───────────────────
366
367 describe('normalizeBillingUser: pack_consolidation_passes_balance field', () => {
368 it('initialises to 0 when missing', () => {
369 const u = { tier: 'plus' };
370 normalizeBillingUser(u);
371 assert.strictEqual(u.pack_consolidation_passes_balance, 0);
372 });
373
374 it('preserves an existing valid value', () => {
375 const u = { tier: 'plus', pack_consolidation_passes_balance: 150 };
376 normalizeBillingUser(u);
377 assert.strictEqual(u.pack_consolidation_passes_balance, 150);
378 });
379
380 it('resets NaN to 0', () => {
381 const u = { tier: 'plus', pack_consolidation_passes_balance: NaN };
382 normalizeBillingUser(u);
383 assert.strictEqual(u.pack_consolidation_passes_balance, 0);
384 });
385 });
386
387 // ── defaultUserRecord: pack_consolidation_passes_balance ──────────────────────
388
389 describe('defaultUserRecord: pack_consolidation_passes_balance field', () => {
390 it('is present and equals 0', () => {
391 const u = defaultUserRecord('u_pack_consol');
392 assert.ok('pack_consolidation_passes_balance' in u);
393 assert.strictEqual(u.pack_consolidation_passes_balance, 0);
394 });
395
396 it('includes pack_consolidation_legacy_inferred = false', () => {
397 const u = defaultUserRecord('u_legacy_flag');
398 assert.strictEqual(u.pack_consolidation_legacy_inferred, false);
399 });
400 });
401
402 // ── Pack consolidation pass enforcement (unit simulation) ─────────────────────
403
404 describe('Billing gate: monthly cap exhausted → draw from pack passes', () => {
405 /**
406 * Simulates the enforcement block from billing-middleware.mjs:
407 * - monthly_consolidation_jobs_used is already post-increment when checked
408 * - if > passCap, draw from pack or block
409 */
410 function simulateConsolidationGate(u) {
411 const passCap = effectiveMonthlyConsolidationPassesIncluded(u);
412
413 // Free tier — always block
414 if (passCap !== null && passCap === 0) {
415 return { ok: false, code: 'CONSOLIDATION_NOT_AVAILABLE' };
416 }
417
418 if (passCap !== null) {
419 // Post-increment value
420 const passesUsed = Math.max(0, Math.floor(Number(u.monthly_consolidation_jobs_used) || 0));
421 if (passesUsed > passCap) {
422 const packPasses = Math.max(0, Math.floor(Number(u.pack_consolidation_passes_balance) || 0));
423 if (packPasses > 0) {
424 u.pack_consolidation_passes_balance = packPasses - 1;
425 return { ok: true, source: 'pack' };
426 }
427 u.monthly_consolidation_jobs_used = passesUsed - 1; // undo
428 return { ok: false, code: 'CONSOLIDATION_QUOTA_EXHAUSTED' };
429 }
430 }
431
432 return { ok: true, source: 'monthly' };
433 }
434
435 it('allows pass within monthly cap', () => {
436 const u = defaultUserRecord('within_cap');
437 u.tier = 'plus'; // cap = 30
438 u.monthly_consolidation_jobs_used = 15; // post-increment, still within cap
439 const r = simulateConsolidationGate(u);
440 assert.strictEqual(r.ok, true);
441 assert.strictEqual(r.source, 'monthly');
442 });
443
444 it('draws from pack when monthly cap exceeded and pack has passes', () => {
445 const u = defaultUserRecord('pack_draw');
446 u.tier = 'plus'; // cap = 30
447 u.monthly_consolidation_jobs_used = 31; // post-increment, 1 over cap
448 u.pack_consolidation_passes_balance = 50;
449 const r = simulateConsolidationGate(u);
450 assert.strictEqual(r.ok, true);
451 assert.strictEqual(r.source, 'pack');
452 assert.strictEqual(u.pack_consolidation_passes_balance, 49);
453 });
454
455 it('blocks when monthly cap exceeded and pack is empty', () => {
456 const u = defaultUserRecord('no_pack');
457 u.tier = 'plus'; // cap = 30
458 u.monthly_consolidation_jobs_used = 31; // post-increment, 1 over cap
459 u.pack_consolidation_passes_balance = 0;
460 const r = simulateConsolidationGate(u);
461 assert.strictEqual(r.ok, false);
462 assert.strictEqual(r.code, 'CONSOLIDATION_QUOTA_EXHAUSTED');
463 // Counter must be rolled back so display stays accurate
464 assert.strictEqual(u.monthly_consolidation_jobs_used, 30);
465 });
466
467 it('unlimited tier (beta) never hits the cap', () => {
468 const u = defaultUserRecord('beta_unlimited');
469 u.tier = 'beta'; // cap = null
470 u.monthly_consolidation_jobs_used = 9999;
471 u.pack_consolidation_passes_balance = 0;
472 const r = simulateConsolidationGate(u);
473 assert.strictEqual(r.ok, true);
474 assert.strictEqual(r.source, 'monthly');
475 });
476
477 it('depletes pack passes one at a time across multiple overages', () => {
478 const u = defaultUserRecord('multi_overage');
479 u.tier = 'growth'; // cap = 100
480 u.pack_consolidation_passes_balance = 3;
481
482 for (let i = 1; i <= 3; i++) {
483 u.monthly_consolidation_jobs_used = 100 + i; // simulate repeated post-increment
484 const r = simulateConsolidationGate(u);
485 assert.strictEqual(r.ok, true, `pass ${i} should succeed`);
486 assert.strictEqual(u.pack_consolidation_passes_balance, 3 - i);
487 }
488
489 // 4th overage — pack now empty
490 u.monthly_consolidation_jobs_used = 104;
491 const r4 = simulateConsolidationGate(u);
492 assert.strictEqual(r4.ok, false);
493 assert.strictEqual(r4.code, 'CONSOLIDATION_QUOTA_EXHAUSTED');
494 });
495 });
File History 2 commits
sha256:65ccb454656ea5acdea0a10e559b78bcde1eb6ff753ecc2911bc99d1c3d7cadd feat(calendar): enforce agent context tiers in retrieval AP… Human minor ⚠ 2 days ago
sha256:9103f98c89257ed2b01c237cea895dabb3e85ea337dccb1161c175e4422355b6 docs: accept Calendar Events v0 spec with Phase 0 security … Human 2 days ago