kibin/NetForge
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(05-01): complete Dashboard Metrics API plan

Browse Source 
Tasks completed: 2/2
- DashboardService with 6 metric aggregation methods
- GET /api/dashboard endpoint and 6 integration tests

SUMMARY: .planning/phases/05-visibility-and-client-portal/05-01-SUMMARY.md

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
kevin-asprec
2026-03-05 17:24:50 +08:00
parent 5b1b4ee0e1
commit 7de961f6c7
2 changed files with 118 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
.planning/STATE.md
View File

@@ -5,23 +5,23 @@
See: .planning/PROJECT.md (updated 2026-03-04)
**Core value:** ISP owners can see exactly where their money is — who owes what, what's been collected, what's been spent, and what the business actually looks like financially — in real time.
**Current focus:** Phase 4 complete (all 5 plans). Ready for Phase 5.
**Current focus:** Phase 5 in progress — Visibility and Client Portal.
## Current Position
Phase: 4 of 5 (Inventory, Expenses, and Financial Reports)
Plan: 5 of 5 in phase 4 (23/23 total complete)
Status: Phase 4 complete. All plans done: 04-01, 04-02, 04-03, 04-04, 04-05.
Last activity: 2026-03-05 — Completed 04-04-PLAN.md (Expense Reports and Audit Trail — 9 tests, category/vendor reports, ACCT-08 audit trail)
Phase: 5 of 5 (Visibility and Client Portal)
Plan: 1 of 5 in phase 5 (24/28 total complete)
Status: In progress. 05-01 complete (Dashboard Metrics API).
Last activity: 2026-03-05 — Completed 05-01-PLAN.md (Dashboard Metrics API — 6 tests, revenue/overdue/subscriber/cashflow/collector metrics)
Progress: [███████████████████████] 100% (23/23 plans across all phases)
Progress: [████████████████████████░░░░] 86% (24/28 plans across all phases)
## Performance Metrics
**Velocity:**
- Total plans completed: 16
- Average duration: 10.9 min
- Total execution time: 175 min
- Total plans completed: 17
- Average duration: 10.3 min
- Total execution time: 178 min
**By Phase:**
@@ -31,10 +31,11 @@ Progress: [███████████████████████
| 02-subscriber-and-billing-core | 5/5 complete | 57 min | 11.4 min |
| 03-operational-modules | 5/5 complete | ~65 min | ~13 min |
| 04-inventory-expenses-reports | 5/5 complete | 71 min | 14.2 min |
| 05-visibility-and-client-portal | 1/5 complete | 3 min | 3 min |
**Recent Trend:**
- Last 10 plans: 03-01 (15 min), 03-02 (11 min), 03-04 (6 min), 03-05 (9 min), 04-01 (16 min), 04-03 (17 min), 04-05 (10 min), 04-02 (8 min), 04-04 (20 min)
- Trend: stable — 04-04 all 9 tests passed first run, clean execution
- Last 10 plans: 03-02 (11 min), 03-04 (6 min), 03-05 (9 min), 04-01 (16 min), 04-03 (17 min), 04-05 (10 min), 04-02 (8 min), 04-04 (20 min), 05-01 (3 min)
- Trend: 05-01 fastest plan yet — pure service + API + tests, no schema changes
*Updated after each plan completion*
@@ -142,6 +143,10 @@ Recent decisions affecting current work:
- [04-04]: Expense aggregation done in JS after findMany -- same pattern as outstanding reports, collector balances (acceptable for ISP scale)
- [04-04]: AuditTrailService queries JEs by referenceType+referenceId -- works for all sources (Invoice, Payment, Expense, Collection, etc.)
- [04-04]: Expense report cleanup order: expenses -> vendors -> expenseCategories (custom) -> paymentAllocations -> payments -> invoiceLines -> invoices -> journalEntryLines -> null reversesEntryId -> journalEntries -> subscribers -> servicePlans -> accountingPeriods -> accounts -> ticketCategories -> expenseCategories (system) -> users -> tenant
- [05-01]: Dashboard revenue metrics use Payment.createdAt (not paymentDate) for today/month filtering
- [05-01]: Cash flow uses same approach as FinancialReportService — POSTED JE lines on revenue (4xxx) and expense (5xxx) accounts with normal balance logic
- [05-01]: getDashboardSummary runs all 5 metric methods in parallel via Promise.all
- [05-01]: Dashboard cleanup order: expenses -> vendors -> expenseCategories (custom) -> collectionAllocations -> collections -> remittances -> paymentAllocations -> payments -> invoiceLines -> invoices -> journalEntryLines -> null reversesEntryId -> journalEntries -> zoneAssignments -> subscribers -> zones -> servicePlans -> accountingPeriods -> accounts -> ticketCategories -> expenseCategories (system) -> users -> tenant
### Pending Todos
@@ -159,6 +164,6 @@ None.
## Session Continuity
Last session: 2026-03-05T06:55:00Z
Stopped at: Completed 04-04-PLAN.md (Expense Reports and Audit Trail — 9 tests). Phase 4 fully complete.
Last session: 2026-03-05T09:23:00Z
Stopped at: Completed 05-01-PLAN.md (Dashboard Metrics API — 6 tests, all passing).
Resume file: None