52 lines
4.4 KiB
Markdown
52 lines
4.4 KiB
Markdown
# System Overview
|
|
|
|
## Current Architecture
|
|
|
|
The deployed production architecture is the Next.js Web workload plus a separate HTTP-polling Node Worker. Production server state is stored directly in PostgreSQL through a shared server-only adapter; development and tests can explicitly use local JSON. ACK deploys database migration, Web, Worker, Service, and Ingress resources separately.
|
|
|
|
ADR-003's Go backend is implemented and merged into `main` under `backend/` (see the Module Map), but no Go workload is deployed and no production traffic is routed to it. Until the single-writer cutover passes its compatibility checks, the Next.js/Node topology above remains the deployed and authoritative truth.
|
|
|
|
## Approved Target Architecture
|
|
|
|
The accepted target in ADR-003 is a same-origin Next.js frontend plus Go modular-monolith backend:
|
|
|
|
| Target component | Responsibility | Constraint | Implementation state |
|
|
|---|---|---|---|
|
|
| Next.js frontend | Pages, static assets, SSR, browser UI | Calls Go over HTTP; no RDS/provider/OSS/business Secret. | Existing; unchanged until cutover. |
|
|
| Go backend | Existing HTTP/file contracts, identity, administration, assets, jobs, billing, usage, providers, storage, Webhooks, readiness | Owns relational access and initially embeds WorkerLoop. | Implemented in `backend/` and merged; unrouted in production. |
|
|
| RDS PostgreSQL | Relational state and cross-instance concurrency | Retains versioned migrations and both concurrency-sensitive database functions. | Production database; migrations 0001/0002 apply at rollout. |
|
|
| Migration Job | Schema and application-role grants | Remains one-shot and separate from long-lived workloads. | Existing Job; migration 0002 included. |
|
|
| Alibaba Cloud OSS | Shared generated/uploaded assets | Must be production-ready before horizontal workload scaling. | Still behind a storage Adapter; not validated against real OSS. |
|
|
|
|
Ingress will eventually route page/static paths to Next.js and `/api`, `/uploads`, and `/generated-results` to Go. The initial target remains two long-lived Pods (`Next x1 + Go x1`). The Go implementation is complete and merged; deployment and traffic cutover are not.
|
|
|
|
## Main Components
|
|
|
|
| Component | Responsibility | Notes |
|
|
|---|---|---|
|
|
| Next.js Web | Browser/API routes, domain services, persistence calls, internal Worker tick endpoint | Owns the PostgreSQL pool and `/api/ready` until cutover. |
|
|
| Worker | Periodically invokes the internal Worker tick endpoint | No direct database connection or RDS Secret. |
|
|
| PostgreSQL adapter | Backend selection, Pool lifecycle, TLS, parameterized queries, transactions, readiness | Server-only module at `lib/server/database.ts`. |
|
|
| Go backend | `cmd/zhinian-api` plus 18 `internal/` packages: identity, administration, assets, billing, usage, jobs, providers, webhook, httpapi, publicapi, application, orchestration, postgres, localstore, logging, settings, templates, prompt | Merged into `main`; locally runnable and contract-tested; unrouted in production. |
|
|
| Contract fixtures | Language-neutral JSON contracts for auth, admin, assets, billing, http, jobs, logs, providers, settings, usage, webhook under `contracts/` | Shared executable acceptance source for TypeScript and Go consumers. |
|
|
| RDS PostgreSQL | Accounts, assets, jobs, usage, templates, billing state | Schema managed by versioned migrations (0001, 0002). |
|
|
| Migration Job | Applies migrations and exact application-role privileges | Must complete before Web rollout. |
|
|
| Runtime/object storage | Uploads, generated assets, and logs | Container-local/PVC by default; use OSS/shared storage before scaling horizontally. |
|
|
|
|
## Important Boundaries
|
|
|
|
- Production backend selection is explicit and fail-closed; never turn a PostgreSQL configuration failure into local JSON fallback.
|
|
- Store callers depend on stable store interfaces, not `pg` or SQL details.
|
|
- Multi-statement consistency uses one transaction client; atomic job claim and wallet posting remain database functions.
|
|
- Database credentials are injected only into Web and migration workloads; Worker uses the internal HTTP boundary.
|
|
- The merged Go implementation must not be routed in production before the cutover review; Next Route Handlers, Secrets, and ACK manifests stay under their current owners until then.
|
|
|
|
## Related Decisions
|
|
|
|
- Current implementation: `RDS-001`, `RDS-002`, and `ACK-001`.
|
|
- Accepted target: `ADR-003`; it supersedes ACK-001 only after verified implementation and cutover.
|
|
|
|
## Last Updated
|
|
|
|
2026-08-14
|