Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
922b7acc03 | ||
|
|
dc83f97be4 | ||
|
|
7f7d7588f3 | ||
|
|
b9c6d193a4 | ||
|
|
062adaf9d3 | ||
|
|
1cf4074eb3 | ||
|
|
bc6f087efb | ||
|
|
8cb1756d6c | ||
|
|
851811eb35 | ||
|
|
f5802cf34a | ||
|
|
c9bb6efa43 | ||
|
|
67fcd7923e | ||
|
|
26568429bc | ||
|
|
f3720ff2c1 | ||
|
|
68716b9e56 | ||
|
|
c2d850a0d0 | ||
|
|
6d62ca5677 | ||
|
|
58aac77a0b | ||
|
|
0462ab1f88 | ||
|
|
60fca4d540 | ||
|
|
dba5d49448 | ||
|
|
1633c7bb7b | ||
|
|
7eda6c50a4 | ||
|
|
f2ae2a7de7 | ||
|
|
3210b3bd15 | ||
|
|
9fad051f75 | ||
|
|
a818822023 | ||
|
|
012184af30 | ||
|
|
c1f7ffb5b4 | ||
|
|
6816081644 |
No files matched your search
@@ -0,0 +1,223 @@
|
||||
---
|
||||
name: garbage-collector
|
||||
description: Daily maintenance agent that reads pre-scanned gc-findings.json, then opens Tier A draft PRs (mechanical fixes like removing stale TODOs and console.logs) and Tier B GitHub Issues (architectural drift, oversized files, outdated deps). Runs headless via the garbage-collector.yml cron. Also invokable interactively as @garbage-collector for manual sweeps.
|
||||
tools: Read, Grep, Glob, Bash, Edit, Write
|
||||
model: haiku
|
||||
color: orange
|
||||
---
|
||||
|
||||
You are the WorldWideView Garbage Collector — a low-cost maintenance agent responsible for keeping the codebase clean between human-led development cycles.
|
||||
|
||||
## Step 1 — Read your charter
|
||||
|
||||
```bash
|
||||
cat .agents/rules/garbage-collection.md
|
||||
```
|
||||
|
||||
Internalize all guard rails, caps, and the never-touch list before taking any action.
|
||||
|
||||
## Step 2 — Read the findings
|
||||
|
||||
```bash
|
||||
cat gc-findings.json
|
||||
```
|
||||
|
||||
This was produced by `scripts/gc-scan.mjs` before you were invoked. You do **not** re-scan the codebase — you triage this list only.
|
||||
|
||||
If `gc-findings.json` does not exist or is empty, output "No findings to process." and stop.
|
||||
|
||||
## Step 3 — Check dry-run mode
|
||||
|
||||
```bash
|
||||
echo "${DRY_RUN:-false}"
|
||||
```
|
||||
|
||||
If `true`, jump to **Step 7 (Dry-run summary)** and skip all PR/Issue creation.
|
||||
|
||||
## Step 4 — Check for existing GC work (idempotency)
|
||||
|
||||
```bash
|
||||
# Open gc-bot PRs
|
||||
gh pr list --label gc-bot --state open --json number,title,headRefName,body
|
||||
|
||||
# Existing gc/* remote branches
|
||||
git branch -r --list 'origin/gc/*'
|
||||
|
||||
# Open gc-bot Issues
|
||||
gh issue list --label gc-bot --state open --json number,title
|
||||
```
|
||||
|
||||
Build a mental map of already-handled concerns. For each finding, skip it if an open PR or Issue already covers the same file + pattern.
|
||||
|
||||
## Step 5 — Tier A: Create draft PRs (max 3 per run)
|
||||
|
||||
Group related Tier A findings by `patternId` or `type`. Process the highest-value group first (most findings → most cleanup per PR).
|
||||
|
||||
For each group (up to 3 total):
|
||||
|
||||
### 5a — Create a branch
|
||||
|
||||
```bash
|
||||
SHA=$(git rev-parse --short HEAD)
|
||||
BRANCH="gc/<patternId>-${SHA}"
|
||||
git checkout -b "${BRANCH}"
|
||||
```
|
||||
|
||||
### 5b — Apply the mechanical fix
|
||||
|
||||
Follow these per-type rules:
|
||||
|
||||
**stale-todo (issueClosed: true)**
|
||||
Delete the entire comment line. Do not change surrounding code.
|
||||
|
||||
**stale-todo (issueClosed: false, age > 90d)**
|
||||
Add `# STALE(gc-bot):` prefix to the comment so the human sees it needs resolution. Do not delete — the human decides. This makes it Tier A-lite (no code risk, just marks it).
|
||||
|
||||
**anti-pattern: mdc-ref**
|
||||
Replace `.mdc` with `.md` in the file content. Check that the referenced file actually exists with `.md` extension before renaming.
|
||||
|
||||
**anti-pattern: console-log**
|
||||
Delete the `console.log(...)` line entirely. If it's the only statement in a block, delete the block too (only if the block has no other statements).
|
||||
|
||||
**anti-pattern: ts-ignore**
|
||||
Delete the `// @ts-ignore` line. If the next line now has a type error that is trivially fixable (e.g., adding a missing cast), fix it. If the type error is non-trivial, revert to Tier B (create an Issue instead).
|
||||
|
||||
**anti-pattern: ts-nocheck**
|
||||
Delete the `// @ts-nocheck` line. Check if the file still compiles cleanly with `npx tsc --noEmit --skipLibCheck` — if not, revert the deletion and file a Tier B Issue instead.
|
||||
|
||||
### 5c — Verify the change is safe
|
||||
|
||||
```bash
|
||||
# Count changed lines — must be ≤150
|
||||
git diff --stat
|
||||
|
||||
# Quick type check on changed files only
|
||||
npx tsc --noEmit --skipLibCheck 2>&1 | head -20
|
||||
```
|
||||
|
||||
If changed lines exceed 150 or type errors are introduced, `git checkout .` and file a Tier B Issue for this group instead.
|
||||
|
||||
### 5d — Commit and push
|
||||
|
||||
```bash
|
||||
git add -p # stage only the GC changes
|
||||
git commit -m "chore: [gc] remove <N> stale <type> findings"
|
||||
git push origin "${BRANCH}"
|
||||
```
|
||||
|
||||
### 5e — Open a draft PR
|
||||
|
||||
```bash
|
||||
gh pr create --draft --label gc-bot \
|
||||
--title "chore: [gc] <short description (≤60 chars)>" \
|
||||
--body "$(cat <<'EOF'
|
||||
## What changed
|
||||
<bullet list of files and what was removed/changed>
|
||||
|
||||
## Why
|
||||
Detector: `<patternId>` in `scripts/gc-scan.mjs`
|
||||
Rule violated: `<rule from garbage-collection.md>`
|
||||
Age / evidence: <age in days, or closed issue number>
|
||||
|
||||
## How to verify
|
||||
1. <step>
|
||||
2. Run `pnpm test` — all tests should still pass
|
||||
3. Run `pnpm build` — build must be clean
|
||||
|
||||
> This PR was opened automatically by the GC bot. Review before merging.
|
||||
EOF
|
||||
)"
|
||||
```
|
||||
|
||||
Return to main: `git checkout main`
|
||||
|
||||
## Step 6 — Tier B: Create GitHub Issues (max 5 per run)
|
||||
|
||||
Group related Tier B findings into one Issue per `type` (e.g., all oversized files in one Issue).
|
||||
|
||||
```bash
|
||||
gh issue create --label gc-bot \
|
||||
--title "[gc] <type>: <short description>" \
|
||||
--body "$(cat <<'EOF'
|
||||
## Summary
|
||||
<what was detected and why it matters>
|
||||
|
||||
## Files / packages affected
|
||||
<file list with line counts or versions>
|
||||
|
||||
## Suggested action
|
||||
<concrete next step — e.g., "split this file", "upgrade this dep", "fix this rule reference">
|
||||
|
||||
## How to close this
|
||||
Resolve the issue and close this ticket manually.
|
||||
|
||||
> Filed automatically by the GC bot on <date>.
|
||||
EOF
|
||||
)"
|
||||
```
|
||||
|
||||
## Step 7 — Dry-run summary
|
||||
|
||||
Find or create the tracking Issue:
|
||||
|
||||
```bash
|
||||
gh issue list --label gc-bot --state open --search "[gc-bot] Daily Scan Reports" --json number,title
|
||||
```
|
||||
|
||||
If it does not exist:
|
||||
```bash
|
||||
gh issue create --label gc-bot \
|
||||
--title "[gc-bot] Daily Scan Reports" \
|
||||
--body "This issue collects daily dry-run scan summaries. Enable normal mode by setting DRY_RUN=false in the workflow."
|
||||
```
|
||||
|
||||
Then post a comment:
|
||||
```bash
|
||||
gh issue comment <number> --body "$(cat <<'EOF'
|
||||
## GC Dry-run Report — <date>
|
||||
|
||||
| Tier | Count | Types |
|
||||
|---|---|---|
|
||||
| A (would fix) | <n> | <comma-separated types> |
|
||||
| B (would file) | <n> | <comma-separated types> |
|
||||
|
||||
### Tier A findings
|
||||
<table: file | line | type | description>
|
||||
|
||||
### Tier B findings
|
||||
<table: file/package | type | description>
|
||||
|
||||
No PRs or Issues were created (dry-run mode).
|
||||
EOF
|
||||
)"
|
||||
```
|
||||
|
||||
## Step 8 — Output summary
|
||||
|
||||
Print a clean markdown summary:
|
||||
|
||||
```
|
||||
## GC Run Complete
|
||||
|
||||
### PRs opened (<n>/3)
|
||||
- #<number>: <title> (<branch>)
|
||||
|
||||
### Issues opened (<n>/5)
|
||||
- #<number>: <title>
|
||||
|
||||
### Skipped (already handled)
|
||||
- <n> findings skipped — covered by existing open work
|
||||
|
||||
### Not actioned
|
||||
- <n> Tier B findings below cap — will appear in next run
|
||||
```
|
||||
|
||||
If nothing was created: "No new findings requiring action."
|
||||
|
||||
## Important invariants
|
||||
|
||||
- Never touch the never-touch list in the charter.
|
||||
- Never create a PR with more than 150 changed lines.
|
||||
- Never mark a PR as ready-for-review.
|
||||
- Never push directly to `main`.
|
||||
- If a Tier A fix risks introducing a regression and you cannot verify it is safe, file a Tier B Issue instead — safety always beats throughput.
|
||||
@@ -1,169 +0,0 @@
|
||||
---
|
||||
trigger: model_decision
|
||||
description: Architecture rules and conventions for the WorldwideView Next.js 16 frontend application, state management, and CesiumJS integration.
|
||||
---
|
||||
|
||||
# WorldwideView Application Architecture
|
||||
|
||||
## 1. Core Framework
|
||||
- Built on **Next.js 16 (App Router)** with `output: "standalone"`.
|
||||
- Uses **React 19** and **TypeScript 5** (strict mode).
|
||||
- **Styling**: Strictly Vanilla CSS. No Tailwind or CSS-in-JS.
|
||||
- **Component File Size**: Max 150 lines per file. Split components, extract helpers, and use hooks for anything larger.
|
||||
|
||||
## 2. State & Event Bus
|
||||
- **Zustand**: Slices handle global state (`globe`, `layers`, `timeline`, `ui`, `filter`, `data`, `config`, `favorites`, `geojson`).
|
||||
- **DataBus**: Custom typed pub/sub singleton (`DataBus.getInstance().emit()`) decoupling React components from background WebSocket streams.
|
||||
|
||||
## 3. Edition System
|
||||
Features are controlled by `NEXT_PUBLIC_WWV_EDITION`:
|
||||
- `local`: Self-hosted, full features, auth.
|
||||
- `cloud`: Managed instance.
|
||||
- `demo`: Public demo, no auth.
|
||||
|
||||
## Source Layout
|
||||
|
||||
|
||||
```
|
||||
worldwideview/
|
||||
├── .agents/ # AI agent workflows, rules, memories, skills
|
||||
├── docs/ # Public-facing documentation
|
||||
├── artifacts/
|
||||
│ └── context/ # ← THIS FOLDER — private source of truth (not committed)
|
||||
├── packages/ # Plugin packages (workspaces)
|
||||
├── public/ # Static assets (Cesium assets, GeoJSON data files)
|
||||
├── scripts/ # Build/utility scripts (copy-cesium.mjs, scaffold-osm-plugin.mjs, etc.)
|
||||
└── src/
|
||||
├── app/ # Next.js App Router (layouts, pages, API routes)
|
||||
├── components/ # React UI components (HUD, LayersPanel, Panels, Sidebar)
|
||||
├── core/
|
||||
│ ├── data/ # DataBus, PollingManager, CacheLayer
|
||||
│ ├── globe/ # Cesium hooks, viewer lifecycle, primitive collections
|
||||
│ └── plugins/ # Plugin registry, lifecycle, loaders
|
||||
├── lib/ # Shared utilities, server-side logic
|
||||
│ └── marketplace/ # Marketplace bridge (auth, token, CORS, repository)
|
||||
└── plugins/ # Built-in feature plugins (aviation, maritime, borders, etc.)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Module Breakdown
|
||||
|
||||
### `src/core/data/` — The Heartbeat
|
||||
|
||||
- **DataBus**: Decentralized event pipeline for all system actions. Plugins emit, components subscribe.
|
||||
- **PollingManager**: Intelligent scheduler for external API calls with exponential backoff.
|
||||
- **CacheLayer**: 2-stage persistent caching — In-Memory + IndexedDB (`worldwideview-cache`).
|
||||
|
||||
### `src/core/globe/` — Rendering Engine
|
||||
|
||||
- **Cesium Integration**: Low-level control over the Cesium Viewer and Primitive Collections.
|
||||
- **EntityRenderer**: High-performance Primitive-based renderer. See `Primitives vs. Entities` below.
|
||||
- **Spiderifier & Clustering Engine** (`StackManager.ts` & `stackAnimation.ts`):
|
||||
- Automatically identifies overlapping entities and groups them into geometrically balanced clusters (concentric rings for <18 density, Fermat's golden spiral for massive stacks).
|
||||
- **Mobile Layout Constraints**: Integrates responsive coordinate geometry. Modifies logical icon dimensions via `iconUpscaler.ts` (32px mobile / 48px desktop) and scales the radial expansion offsets proportionally by 70% on mobile displays to ensure tight, aesthetically pleasing clusters without massive gaps.
|
||||
- **Z-Fighting Mitigation**: Clustering involves highly frequent stack rebuild cycles on any zoom/pan delta. To prevent chaotic render flickering, the global `AnimationLoop` explicitly yields visibility management to `stackAnimation.ts` via `isEntityClustered()`. Items transitioning into the `collapsed` state intentionally bypass animation lerping (to prevent 220ms ghost visibility bleed) and mathematically cloak themselves instantly.
|
||||
- Globe is initialized via `GlobeView.tsx`. Viewer instance passed via `CesiumContext`.
|
||||
|
||||
### `src/core/plugins/` — Plugin System
|
||||
|
||||
- **PluginManager**: Registers, boots, and destroys plugins. Enforces capability checks.
|
||||
- **Loaders**: Plugins are dynamically imported at runtime as ES module bundles (`loadPluginFromManifest`). The legacy `StaticDataPlugin` and `DeclarativePlugin` runtimes are fully deprecated.
|
||||
- **Manifest Requirement**: All plugins MUST include a `"worldwideview"` manifest block in their `package.json` (containing `id`, `icon`, `category`, and `format`). This is strictly required by the Marketplace in order to parse display attributes correctly.
|
||||
|
||||
---
|
||||
|
||||
## Performance: Primitives vs. Entities
|
||||
|
||||
**Core design decision:** Use Cesium `Primitive` API instead of the high-level `Entity` API for high-count datasets.
|
||||
|
||||
| Feature | Entity API | Primitive API (WWV) |
|
||||
|---|---|---|
|
||||
| **Abstraction** | High (easy to use) | Low (direct GPU access) |
|
||||
| **JS Overhead** | Significant per-entity objects | Minimal (batched draw calls) |
|
||||
| **Max Capacity** | ~1,000 entities | **100,000+ points/billboards** |
|
||||
| **WWV Use Case** | Info window / detail panel content | Live data point visualization |
|
||||
|
||||
Specifically: `PointPrimitiveCollection` and `BillboardCollection` ensure 60FPS even with dense global data. The full migration from Entity-based rendering to Primitives was completed to eliminate severe FPS drops.
|
||||
|
||||
---
|
||||
|
||||
## Globe Occlusion & Depth Testing
|
||||
|
||||
- **Correct approach:** `depthTestAgainstTerrain = false` — uses GPU to depth-test against the smooth WGS84 ellipsoid. Icons visible on the near hemisphere, correctly occluded behind Earth.
|
||||
- **Avoid:** `eyeOffset`, `disableDepthTestDistance` hacks that push entities in front of everything. These cause icons to bleed through the globe.
|
||||
- The Plugin SDK's `CesiumEntityOptions` exposes this via `disableDepthTestDistance` when absolutely needed for specific usecases.
|
||||
|
||||
---
|
||||
|
||||
## Data Pipeline (Example: Aviation)
|
||||
|
||||
```
|
||||
Remote API (e.g. OpenSky)
|
||||
↓ [raw JSON, every ~30s via PollingManager]
|
||||
Plugin (e.g. AviationPlugin)
|
||||
↓ [parse, filter, sanitize → GeoEntity[]]
|
||||
DataBus.emit("dataUpdated", { entities })
|
||||
↓
|
||||
EntityRenderer [batched Primitive update]
|
||||
↓
|
||||
GPU (CesiumJS) → 60FPS visualization
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Database (Unified PostgreSQL)
|
||||
|
||||
**Location:** We have migrated from a fragmented SQLite + PostgreSQL setup to a unified **PostgreSQL** architecture using Prisma 7 with the `@prisma/adapter-pg` driver. This enables true multi-tenant cloud capability, real-time sync, and scalable connection pooling via `DATABASE_URL`.
|
||||
|
||||
**Next.js Core Tables:**
|
||||
| Model | Table | Purpose |
|
||||
|---|---|---|
|
||||
| `User` | `users` | Auth accounts (email, bcrypt password, role) |
|
||||
| `InstalledPlugin` | `installed_plugins` | Marketplace plugin install records |
|
||||
| `Setting` | `settings` | Key-value app config (Cesium token, map style, etc.) |
|
||||
| `Tenant` | `tenants` | Multi-tenant organization boundaries |
|
||||
|
||||
**Data Engine Tables:**
|
||||
Managed explicitly via optimized queries in `packages/wwv-data-engine/src/db.ts` targeting PostgreSQL to maximize ingest performance.
|
||||
Includes tables like `iranwar_events`, `earthquakes`, `wildfires`, and `maritime_history`.
|
||||
|
||||
> [!WARNING]
|
||||
> **Catastrophic Time-Series Polling (The Lookback Trap):**
|
||||
> High-frequency polling (e.g. 6,000 aircraft every 10s) accumulates millions of rows rapidly.
|
||||
> - **DO NOT** query unindexed columns (like `ts`) for lookback/freshness without a dedicated index, otherwise you will trigger full table scans and 500 Route timeout errors.
|
||||
> - **REQUIRED:** Implement aggressive data retention / hourly pruning via `scheduler.ts` to prevent infinite table growth.
|
||||
> - **PREFERRED:** Keep real-time / spatial lookbacks in Redis (like `getLiveSnapshot()`), and leave PostgreSQL strictly for historical chronological replays that hit standard indices.
|
||||
|
||||
**Hot-Caching (Redis) & Connection Rules:**
|
||||
The `wwv-data-engine` polls external APIs, dumps raw payloads to PostgreSQL for historical persistence, and broadcasts active snapshots via WebSockets while persisting to Upstash Redis. The Next.js frontend fetches initial state from Redis to ensure horizontal scalability.
|
||||
*TLS Connection Requirement:* The `REDIS_URL` mapped in Coolify and `.env.local` must use the `rediss://` protocol for TLS encryption. Attempting to use plain `redis://` with Upstash will cause the connection to drop (`ECONNRESET`) and throw a `MaxRetriesPerRequestError (which is 3)` inside the data engine.
|
||||
*Upstash Request Limit Throttling:* Due to Upstash Serverless billing (capped at 10k requests/day or 500k/month on free tier), the data engine decouples WebSocket live broadcasting from Redis persistence. High-frequency scrapers (like Aviation) run every 15 seconds to push WebSockets, but the backend forces a **5-minute throttle** before saving the next snapshot to Upstash using `zlib` compression. This executes just 2 commands (`SET` and `EXPIRE`) per 5 minutes per scraper, completely eliminating `max requests limit exceeded` errors while retaining real-time frontend updates.
|
||||
|
||||
**Resilience (Data Self-Healing):**
|
||||
Even with persistent PostgreSQL, critical history (like `iranwarlive` events) should be bundled as `seed.json` or `history.csv` artifacts. If the Data Engine detects an empty table, it MUST parse its built-in fallback seed to hydrate the database and Redis, ensuring 100% data recovery without manual intervention.
|
||||
|
||||
**Dynamic Engine URL Resolution:**
|
||||
The decoupled Data Engine lives at `http://localhost:5001` during local development, and deploys to `https://dataengine.worldwideview.dev` in production. The Next.js frontend injects this context directly into the plugin via the `ctx.env` object (specifically reading from `NEXT_PUBLIC_WWV_PLUGIN_DATA_ENGINE_URL` environment variables). Plugins resolve their required backend natively by parsing `this.context.env.DATA_ENGINE_URL`. The legacy `globalThis.__WWV_ENGINE_URL__` proxy approach has been fully deprecated.
|
||||
|
||||
---
|
||||
|
||||
## Settings Architecture
|
||||
|
||||
User-configurable values live in the `settings` table (not `.env`). They can be updated without rebuilds.
|
||||
|
||||
| Setting Type | Where | Example |
|
||||
|---|---|---|
|
||||
| **Infrastructure** | `.env` | `DATABASE_URL`, `NEXT_PUBLIC_WWV_EDITION` |
|
||||
| **User settings** | `settings` table (DB) | Cesium token, map style, API keys |
|
||||
|
||||
**Setup Wizard:** If `cesium_token` is missing from the DB on first load, the app shows a setup wizard. Plugin-level wizards work the same way — plugin declares required settings in its manifest; if missing, it renders a setup form instead of data.
|
||||
|
||||
---
|
||||
|
||||
## Design Principles
|
||||
|
||||
- **Single Responsibility:** Plugins only handle data mapping — they don't know about UI or cache.
|
||||
- **Dependency Inversion:** `PluginManager` communicates via the `WorldPlugin` interface — new plugins don't require core changes.
|
||||
- **Event-Driven:** Components subscribe to what they need via DataBus — no prop-drilling.
|
||||
- **Defensive Programming:** All external calls wrapped in error boundaries + `PollingManager` backoff.
|
||||
@@ -1,7 +1,9 @@
|
||||
---
|
||||
trigger: glob
|
||||
description: Strict guidelines for rendering geospatial entities, handling 3D terrain clipping, and applying dynamic animation properties against Cesium's runtime engine.
|
||||
globs: "src/core/globe/**/*"
|
||||
paths:
|
||||
- "src/core/globe/**/*"
|
||||
- "src/plugins/**/*"
|
||||
- "packages/wwv-plugin-*/src/**/*"
|
||||
---
|
||||
|
||||
# Cesium Rendering Rules
|
||||
@@ -23,6 +25,23 @@ When creating primitive objects:
|
||||
- **Points** (`PointPrimitive`): Can use `size`, `outlineWidth`, and `outlineColor`.
|
||||
- **Billboards** (`BillboardGraphics` for SVG/Icons): Must **NOT** use `size`, `outlineWidth`, or `outlineColor`. You must use `iconScale` to resize them. Mixing point properties on billboards causes severe shader clipping.
|
||||
|
||||
## Sizing Conventions
|
||||
|
||||
| Entity type | Knob | Default | Typical band | Source |
|
||||
|-------------|--------------|------------------------------------|------------------|--------|
|
||||
| `point` | `size` | `8` desktop / `12` mobile | 5–12 | `src/core/globe/primitiveOps.ts` (`defaultPointSize`) |
|
||||
| `billboard` | `iconScale` | `0.7` (`DEFAULT_BILLBOARD_SCALE`) | 0.6–0.9 | `src/core/globe/primitiveOps.ts` (`DEFAULT_BILLBOARD_SCALE`) |
|
||||
| `model` | `modelScale` | `1.0` + `modelMinPixelSize` | varies per asset | `src/core/globe/ModelManager.ts`, `src/core/globe/hooks/useModelRendering.ts` |
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **Cross-plugin parity rule.** If your plugin renders alongside maritime / aviation / military-aviation on the globe, **leave `iconScale` unset** (or pick a value inside 0.6–0.9). A value below 0.5 will look visibly broken next to peer plugins. A value above 1.0 will dominate the globe.
|
||||
|
||||
> [!CAUTION]
|
||||
> **Silent-ignore footgun.** `size` is a `PointPrimitive` property. If you set `size` on a `billboard` entity it is **silently dropped** — Cesium does not error and the billboard simply renders at `DEFAULT_BILLBOARD_SCALE`. When converting a point plugin to a billboard plugin, replace `size: N` with `iconScale: ~N/16` (the canvas base is `getBaseSize() = 48px` desktop) — do not delete it and do not translate it literally as `iconScale: N/10`. This footgun has shipped at least once (see commit history on `local-plugins/wwv-plugin-satellite`).
|
||||
|
||||
> [!NOTE]
|
||||
> **Backdrop stack.** `createSvgIconUrl` (in the SDK) already wraps the icon in a 44×44 SVG with a dark backdrop circle. `src/core/globe/iconUpscaler.ts` then redraws onto a 48px canvas with **another** backdrop circle (`DEFAULT_BG = "rgba(15, 23, 42, 0.55)"`). Pass `background: false` to `createSvgIconUrl` when you want only the host's circle. Don't add a third backdrop in your own SVG.
|
||||
|
||||
## Performance Culling
|
||||
|
||||
> [!TIP]
|
||||
|
||||
@@ -1,8 +1,16 @@
|
||||
---
|
||||
trigger: model_decision
|
||||
description: Cloud edition implementation details, PostgreSQL Row-Level Security (RLS) isolation, cross-subdomain auth, and cryptographic license keys.
|
||||
paths:
|
||||
- "src/lib/auth*"
|
||||
- "src/app/api/auth/**/*"
|
||||
- "src/core/auth.ts"
|
||||
- "src/core/storage.ts"
|
||||
- "src/core/tenant.ts"
|
||||
---
|
||||
|
||||
> **SUPERSEDED by ADR-003** (`docs/architecture/decisions/adr-0003-shared-identity-and-ecosystem-auth-host.md`).
|
||||
> The auth host is `worldwideview.dev` (worldwideview-web repo), not `app.worldwideview.dev`. Read ADR-003 first.
|
||||
|
||||
# WorldWideView — Cloud & Auth Architecture
|
||||
|
||||
|
||||
@@ -14,6 +22,16 @@ description: Cloud edition implementation details, PostgreSQL Row-Level Security
|
||||
|
||||
## Auth Strategy
|
||||
|
||||
> [!WARNING]
|
||||
> **This section is superseded by [ADR-003](../../docs/architecture/decisions/adr-0003-shared-identity-and-ecosystem-auth-host.md) (2026-05-22).**
|
||||
> The decisions below describing `app.worldwideview.dev` as the auth owner and NextAuth as the ecosystem IdP are no longer current. The new architecture is:
|
||||
> - **`worldwideview.dev`** (the `worldwideview-web` repo) owns all login, signup, and account management UI
|
||||
> - **Supabase Auth** (single shared project) is the identity provider for all products
|
||||
> - Session cookies are scoped to `.worldwideview.dev` and shared across all subdomains
|
||||
> - The Marketplace never owns auth UI and never redirects to `app.worldwideview.dev`
|
||||
>
|
||||
> The multi-tenant RLS, tier matrix, license key, and CI/CD sections below remain valid.
|
||||
|
||||
**Auth.js (NextAuth)** is the single auth API across all editions. `app.worldwideview.dev` owns **all auth UI** — login, registration, password reset. No other subdomain ever shows a login or registration form.
|
||||
|
||||
```typescript
|
||||
|
||||
@@ -1,21 +0,0 @@
|
||||
---
|
||||
trigger: always_on
|
||||
---
|
||||
|
||||
# Context and Memory Synchronization
|
||||
|
||||
## 1. Purpose
|
||||
This specification ensures that any agent maintains persistent, accurate project context by pointing them directly to the Single Source of Truth for this repository.
|
||||
|
||||
## 2. Synchronization Target
|
||||
The agent MUST orient itself by immediately reading:
|
||||
1. `c:\dev\worldwideview\AGENTS.md` (The root index of all technical stack details)
|
||||
2. `c:\dev\worldwideview\.agents\rules\platform-architecture.md` (The high-level platform goals)
|
||||
|
||||
If deep technical rules are required for a specific domain (e.g., UI state, Map Rendering, Monorepo management), the agent MUST consult the relevant file in `c:\dev\worldwideview\.agents\rules\`.
|
||||
|
||||
## 3. Reflecting Changes
|
||||
If the architecture fundamentally changes (e.g., migrating off Zustand, or removing Cesium), the agent MUST proactively update the `AGENTS.md` and relevant files in `.agents/rules/` to reflect this new reality.
|
||||
|
||||
## 4. Goal
|
||||
A new chat instance MUST be able to reconstruct an accurate, comprehensive understanding of the project solely from reading the root `AGENTS.md` file and branching out to the specific rules as necessary. This prevents context bloat and ensures accuracy.
|
||||
@@ -1,28 +0,0 @@
|
||||
---
|
||||
trigger: always_on
|
||||
description: Guidelines for ongoing project maintenance, cleanliness, and self-correction during everyday development tasks.
|
||||
---
|
||||
|
||||
# Continuous Improvement & Maintenance
|
||||
|
||||
As an AI agent working within the WorldWideView project, you are expected to practice the **Boy Scout Rule**: always leave the codebase (and its context) cleaner than you found it.
|
||||
|
||||
While executing your primary programming tasks, you MUST actively abide by these maintenance protocols:
|
||||
|
||||
## 1. Documentation & Rule Parity
|
||||
- **Self-Correction**: If you notice that an architectural choice you are implementing contradicts an existing rule in `.agents/rules/`, you must halt and update the rule file to reflect the new paradigm.
|
||||
- **Dead Context**: If you encounter context, plans, or architectural files referencing deprecated concepts (e.g., legacy microservices, `StaticDataPlugin`), proactively prune or update them.
|
||||
|
||||
## 2. Codebase Cleanliness
|
||||
- **Dead Code**: If you refactor a file and leave behind unused functions, imports, or CSS classes, clean them up immediately. Do not leave "commented out" code unless explicitly requested for future use.
|
||||
- **Console Logs**: Remove debugging `console.log` statements before finalizing a feature, except for structured error logging or critical startup info.
|
||||
- **Sandbox Hygiene**: Any throwaway scripts or debugging tools placed in `/local-scripts/` should be deleted once the underlying issue is resolved, unless they provide permanent utility.
|
||||
|
||||
## 3. Dependency & Typings Checks
|
||||
- **Type Safety**: Never use `any` or `@ts-ignore` as a shortcut when refactoring. Always build the proper TypeScript interfaces.
|
||||
- **Manifest Validation**: Whenever you touch a plugin, ensure its `package.json` `"worldwideview"` manifest block is completely accurate and synced with its capabilities.
|
||||
|
||||
## 4. The "See Something, Say Something" Rule
|
||||
If you spot an unrelated but obvious bug, security vulnerability, or architectural anti-pattern in the file you are editing:
|
||||
1. Fix it if it's a minor, isolated issue (and document the fix in your summary).
|
||||
2. For larger issues, explicitly call it out to the user so it can be added to the technical debt backlog.
|
||||
@@ -1,6 +1,9 @@
|
||||
---
|
||||
trigger: model_decision
|
||||
description: Architecture rules and dependency management guidelines for wwv-data-engine seeders.
|
||||
description: Architecture rules and dependency management guidelines for wwv-data-engine seeders, pnpm workspace dependency loading, and WebSocket payload contracts.
|
||||
paths:
|
||||
- "packages/**/*"
|
||||
- "local-seeders/**/*"
|
||||
- "docker-compose.yml"
|
||||
---
|
||||
|
||||
# Data Engine V2 Architecture & Dependency Loading
|
||||
@@ -28,4 +31,61 @@ In production, the `wwv-data-engine-v2` does NOT mount the local file system. In
|
||||
4. It then runs a single **workspace-aware `pnpm install --prod`**. This ensures all custom unbundled dependencies declared by the extracted plugins are downloaded directly into the container and properly linked together.
|
||||
|
||||
## 5. Namespace Separation Rule
|
||||
To prevent collisions and `404` or `ERR_MODULE_NOT_FOUND` errors, seeders **MUST NOT** exist simultaneously in both the community (`wwv-seeders-community`) and private (`wwv-seeders-private`) repositories. Namespace overlaps will cause module resolution failures when the V2 engine attempts to load them. Private seeders have priority.
|
||||
To prevent collisions and `404` or `ERR_MODULE_NOT_FOUND` errors, seeders **MUST NOT** exist simultaneously in both the community (`wwv-seeders`, cloned to `local-seeders/community/`) and private (`wwv-seeders-private`, cloned to `local-seeders/private/`) repositories. Namespace overlaps will cause module resolution failures when the V2 engine attempts to load them. Private seeders have priority.
|
||||
|
||||
## 6. Plugin ID Contract — Single Source of Truth
|
||||
|
||||
> **See ADR-0002** (`docs/architecture/decisions/adr-0002-seeder-exported-name-as-canonical-plugin-id.md`) for full rationale and alternatives considered.
|
||||
|
||||
**Rule:** Every seeder MUST export a `name` field that exactly matches the corresponding frontend plugin's `id` field (kebab-case).
|
||||
|
||||
```typescript
|
||||
// ✅ Correct — seeder src/index.ts
|
||||
export default {
|
||||
name: "gps-jamming", // MUST equal the frontend plugin id
|
||||
cron: "0 0 * * *",
|
||||
fn: seedGpsJam,
|
||||
};
|
||||
|
||||
// ❌ Wrong — do not use folder names, camelCase, or abbreviations
|
||||
export default {
|
||||
name: "gpsjam", // mismatch — frontend plugin is "gps-jamming"
|
||||
...
|
||||
};
|
||||
```
|
||||
|
||||
**How the engine uses it:** `seeder-loader.ts` reads each seeder's exported `name` as the canonical plugin ID. This ID is used for:
|
||||
- The `/manifest` endpoint's `plugins` array (what the frontend checks for local routing)
|
||||
- WebSocket data messages (`pluginId` field)
|
||||
- Redis keys (`data:<name>:live`)
|
||||
- Scheduler logs
|
||||
|
||||
**Folder names are organizational only.** The engine warns at startup if `toKebabCase(folderName) !== seeder.name`, but this is cosmetic — the seeder's exported `name` always wins. Folder renames are a future cleanup, not a functional requirement.
|
||||
|
||||
**Frontend side:** `resolveEngineUrl(pluginId)` checks `localEngineHasPlugin(pluginId)` against the manifest. If the names match, the plugin routes to `ws://localhost:5000/stream`. No alias maps or translation layers are needed.
|
||||
|
||||
## 7. WebSocket Payload Format Contract
|
||||
|
||||
When a seeder calls `setLiveSnapshot(pluginId, payload, ttl)`, the engine broadcasts:
|
||||
```json
|
||||
{ "type": "data", "pluginId": "my-plugin", "payload": <whatever you passed> }
|
||||
```
|
||||
|
||||
**`WsClient` payload handling rules (in order):**
|
||||
|
||||
1. Plugin has `mapWebsocketPayload(payload, existingEntities)` → called with raw payload → must return `GeoEntity[]`
|
||||
2. No handler + payload **is** a flat `GeoEntity[]` array → used directly (timestamp normalized)
|
||||
3. No handler + payload is **any other object** → **silently dropped** with a console warning
|
||||
|
||||
This means:
|
||||
|
||||
| Seeder sends | Frontend needs | Notes |
|
||||
|---|---|---|
|
||||
| `[{id, latitude, longitude, ...}]` | Nothing (WsClient handles) | ✅ Simplest for basic point data |
|
||||
| `{ items: [{...}] }` | `mapWebsocketPayload` | Standard engine snapshot format |
|
||||
| `{ satellites: [{...}] }` | `mapWebsocketPayload` | Named-collection format |
|
||||
|
||||
**Recommendation:** If the seeder and frontend plugin are developed together, use a **flat `GeoEntity[]` array** — no `mapWebsocketPayload` needed. Use named objects (e.g. `{ satellites: [...] }`) only when the seeder data has a domain-specific shape worth preserving; in that case you **must** implement `mapWebsocketPayload` on the frontend plugin.
|
||||
|
||||
> [!CAUTION]
|
||||
> The most common silent bug: seeder sends `{ items: [...] }` (an object), frontend plugin omits `mapWebsocketPayload`. Data arrives but WsClient drops it with a console warning. The globe stays empty. Always implement `mapWebsocketPayload` for any plugin whose seeder sends an object payload.
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
description: Rules for safe Prisma schema changes, defensive migrations, and PostgreSQL DDL operations.
|
||||
paths:
|
||||
- "prisma/**/*"
|
||||
---
|
||||
|
||||
# Database Migrations & Schema Modification Rules
|
||||
|
||||
## 1. Defensive Migrations
|
||||
@@ -7,10 +13,22 @@ When making database schema changes, you must ensure that generated migrations a
|
||||
- **Add "IF EXISTS" clauses**: Prisma can sometimes produce brittle drop statements (`DROP INDEX "my_index"`). To prevent migrations from crashing if a state desynchronization occurs, manually edit the migration file to use `DROP INDEX IF EXISTS "my_index";` or `DROP TABLE IF EXISTS "table_name";`.
|
||||
- **Data Preservation**: When dropping columns or renaming, carefully review the migration to ensure data is correctly mapped. In PostgreSQL, ensure that cascaded drops don't accidentally remove required data.
|
||||
|
||||
## 2. Managing Failed Migrations
|
||||
## 2. P3005 Auto-Baseline (Handled in `docker-entrypoint.sh`)
|
||||
|
||||
`docker-entrypoint.sh` automatically recovers from Prisma **P3005** ("schema not empty, no migration history"). This happens when `pnpm dev` (which runs `prisma db push`) populates the database before the Docker stack is started.
|
||||
|
||||
The entrypoint only auto-baselines when **both** conditions hold:
|
||||
1. The error is exactly P3005.
|
||||
2. `prisma migrate diff` reports zero schema drift between the live DB and `prisma/schema.prisma`.
|
||||
|
||||
If drift is detected the container exits with a clear error message directing you to `pnpm db:reset`.
|
||||
|
||||
> **Never add manual `migrate resolve --applied` calls** unless you are outside the container and have independently verified the above two conditions. The entrypoint already handles the common case.
|
||||
|
||||
## 3. Managing Failed Migrations
|
||||
If a migration fails in production:
|
||||
- **Never blindly mark as resolved**: Do not run `prisma migrate resolve --applied <migration_name>` unless you have explicitly verified that the database schema precisely matches the expected state.
|
||||
- If you use `resolve --applied`, Prisma will permanently skip that migration in the future, leaving your database structurally out of sync with your Prisma Client.
|
||||
|
||||
## 3. Backups Before DDL
|
||||
## 4. Backups Before DDL
|
||||
Never perform direct DDL operations (ALTER, DROP, CREATE) on a production database without first confirming an automated backup exists, or manually taking a `pg_dump` backup of the database.
|
||||
@@ -1,3 +1,12 @@
|
||||
---
|
||||
description: Docker build patterns, pnpm dev commands, Vitest strategy, Coolify deployment rules, and security headers.
|
||||
paths:
|
||||
- "Dockerfile"
|
||||
- "docker-compose.yml"
|
||||
- ".github/**/*"
|
||||
- "next.config.ts"
|
||||
---
|
||||
|
||||
# Deployment, Testing, and Operations
|
||||
|
||||
## Development Commands
|
||||
|
||||
@@ -1,69 +0,0 @@
|
||||
# Directory Structure & Repositories
|
||||
|
||||
## Directory Structure
|
||||
|
||||
```
|
||||
worldwideview/
|
||||
├── src/
|
||||
│ ├── app/ # Next.js App Router (pages, API routes, layouts)
|
||||
│ │ ├── api/ # Server-side API routes (auth, aviation, camera, etc.)
|
||||
│ │ ├── login/ # Login page
|
||||
│ │ ├── setup/ # First-time setup page
|
||||
│ │ └── globals.css # Root stylesheet
|
||||
│ ├── components/
|
||||
│ │ ├── common/ # Shared UI: BootOverlay, FloatingWindow, PluginIcon
|
||||
│ │ ├── layout/ # AppShell, Header, SearchBar, DataBusSubscriber
|
||||
│ │ ├── panels/ # LayerPanel, EntityInfoCard, FilterPanel, GraphicsSettings
|
||||
│ │ ├── timeline/ # Timeline component
|
||||
│ │ ├── marketplace/ # Plugin install/unverified dialogs
|
||||
│ │ ├── ui/ # Tooltip, ReloadToast
|
||||
│ │ └── video/ # Floating video manager
|
||||
│ ├── core/
|
||||
│ │ ├── data/ # DataBus, PollingManager, CacheLayer, SmartFetcher
|
||||
│ │ ├── filters/ # filterEngine (applies plugin filters to entities)
|
||||
│ │ ├── globe/ # GlobeView, EntityRenderer, AnimationLoop, StackManager,
|
||||
│ │ │ │ CameraController, InteractionHandler, SelectionHandler,
|
||||
│ │ │ │ ModelManager, ImageryProviderFactory
|
||||
│ │ │ └── hooks/ # useCameraActions, useEntityRendering, useModelRendering, etc.
|
||||
│ │ ├── hooks/ # useBootSequence, useIsMobile, useMarketplaceSync
|
||||
│ │ ├── plugins/ # PluginManager, PluginRegistry, PluginManifest,
|
||||
│ │ │ │ loadPluginFromManifest, validateManifest, InstalledPluginsLoader
|
||||
│ │ │ └── loaders/ # mapJsonToEntities (Legacy loaders like DeclarativePlugin are deprecated)
|
||||
│ │ └── state/ # Zustand store + slices (config, data, globe, layers, timeline, ui, etc.)
|
||||
│ ├── lib/ # auth, db, rateLimit, analytics, AIS stream, marketplace APIs
|
||||
│ ├── plugins/ # GeoJSON plugin registrations
|
||||
│ ├── styles/ # HUD animations CSS
|
||||
│ ├── types/ # GeoJSON types, Umami types
|
||||
│ └── generated/ # Prisma generated client (gitignored)
|
||||
├── local-plugins/ # Local sandbox for developing plugins (gitignored)
|
||||
├── packages/ # pnpm monorepo workspace packages
|
||||
│ ├── wwv-plugin-sdk/ # Plugin SDK: type definitions, manifest schema
|
||||
│ ├── wwv-plugin-aviation/
|
||||
│ ├── wwv-plugin-maritime/
|
||||
│ ├── wwv-plugin-wildfire/
|
||||
│ ├── wwv-plugin-borders/
|
||||
│ ├── wwv-plugin-camera/
|
||||
│ ├── wwv-plugin-military-aviation/
|
||||
│ ├── wwv-plugin-satellite/
|
||||
│ ├── wwv-plugin-iranwarlive/ # Standalone plugin with custom endpoints
|
||||
│ └── wwv-plugin-{airports,embassies,lighthouses,nuclear,seaports,spaceports,volcanoes}/
|
||||
├── prisma/ # schema.prisma, migrations/
|
||||
├── public/ # Static assets, Cesium workers, plugin GeoJSON data
|
||||
├── scripts/ # Build scripts (copy-cesium, scaffold-osm-plugin, setup)
|
||||
├── data/ # PostgreSQL data volume (gitignored)
|
||||
├── Dockerfile # Multi-stage production build
|
||||
├── docker-compose.yml # Main app + data engine runner + local seeders
|
||||
└── .agents/ # Agent documentation, rules, skills, workflows
|
||||
```
|
||||
|
||||
## Related Repositories
|
||||
|
||||
| Repo | Purpose |
|
||||
|---|---|
|
||||
| `worldwideview` | Main application (this repo) |
|
||||
| `wwv-data-engine` | Generic data engine runner (PUBLIC, runs via Docker) |
|
||||
| `wwv-seeders-community` | Open-source community seeders (PUBLIC) |
|
||||
| `wwv-seeders-private` | Proprietary seeder scripts (PRIVATE, downloaded in prod) |
|
||||
| `worldwideview-marketplace` | Plugin marketplace web app |
|
||||
| `worldwideview-plugins` | Published npm plugin packages (frontend source) |
|
||||
| `worldwideview-web` | Marketing / landing page |
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
trigger: testing
|
||||
description: Guidelines and architecture for the Playwright End-to-End (E2E) testing infrastructure.
|
||||
globs:
|
||||
paths:
|
||||
- "tests/**"
|
||||
- "public/e2e-fixtures/**"
|
||||
- "playwright.config.ts"
|
||||
|
||||
@@ -1,34 +0,0 @@
|
||||
---
|
||||
trigger: model_decision
|
||||
description: A comprehensive guide to the WorldWideView ecosystem repositories in the local C:\dev environment. Use this to determine which repository to edit based on the feature being developed.
|
||||
---
|
||||
|
||||
# Ecosystem Repositories & Development Structure
|
||||
|
||||
The WorldWideView platform is not a single monolith; it is distributed across several repositories. In the local development environment, these repositories are organized as sibling directories under `C:\dev\`.
|
||||
|
||||
If you are asked to implement a feature or fix a bug, you **MUST** determine the correct repository to edit before writing code.
|
||||
|
||||
## Ecosystem Map (C:\dev\)
|
||||
|
||||
| Repository Folder | Purpose & When to Edit |
|
||||
|---|---|
|
||||
| **`worldwideview`** | The main application, Next.js frontend, Cesium globe, UI components, and the core plugin SDK. **Edit here** for anything related to the UI, state, map rendering, or built-in plugin frontend configurations. |
|
||||
| **`wwv-data-engine`** | The V2 Data Engine (Host Environment) that runs the seeders. **Edit here** if you need to modify how the engine parses WebSocket streams, implements REST APIs, downloads seeder bundles, or handles Redis caching. |
|
||||
| **`wwv-seeders`** | The community (public) data seeders. **Edit here** to create or modify background polling scripts (e.g. `aviation.ts`, `wildfire.ts`) that fetch data from public APIs and normalize it into `GeoEntity` arrays. |
|
||||
| **`wwv-seeders-private`** | The proprietary (private) data seeders. **Edit here** for closed-source, premium, or high-security data ingestion scripts. |
|
||||
| **`worldwideview-marketplace`** | The Plugin Marketplace web application. **Edit here** if you are modifying the platform where users browse, purchase, or manage plugin installations. |
|
||||
| **`worldwideview-plugins`** | Independent repository for published npm plugin packages (typically frontend source bundles). |
|
||||
| **`worldwideview-web`** | The marketing site, landing pages, and documentation. |
|
||||
| **`wwv-test`** | A testing ground repository (e.g., for docker-compose setups, scratch testing). |
|
||||
|
||||
## Cross-Repository Workflows
|
||||
|
||||
1. **Adding a New Data Source:**
|
||||
- Write the backend fetcher inside `C:\dev\wwv-seeders` (or `private`).
|
||||
- Write the frontend plugin interface inside `C:\dev\worldwideview` (or dynamically loaded via `worldwideview-plugins`).
|
||||
2. **Fixing Real-Time Streaming Issues:**
|
||||
- Investigate `C:\dev\worldwideview` (for frontend `WsClient` or `DataBus`).
|
||||
- Investigate `C:\dev\wwv-data-engine` (for backend Fastify websocket broadcasting).
|
||||
3. **Pnpm Workspaces:**
|
||||
- The Data Engine V2 automatically combines `community` and `private` seeders at runtime using pnpm workspaces. When testing seeders locally, refer to `C:\dev\worldwideview\local-seeders`.
|
||||
@@ -1,17 +0,0 @@
|
||||
# Environment Variables
|
||||
|
||||
| Variable | Required | Description |
|
||||
|---|---|---|
|
||||
| `DATABASE_URL` | Yes | PostgreSQL connection string |
|
||||
| `AUTH_SECRET` | Yes | JWT signing secret (generate with `openssl rand -hex 32`) |
|
||||
| `NEXT_PUBLIC_CESIUM_ION_TOKEN` | No | Cesium Ion access token |
|
||||
| `NEXT_PUBLIC_BING_MAPS_KEY` | No | Bing Maps imagery |
|
||||
| `NEXT_PUBLIC_GOOGLE_MAPS_API_KEY` | No | Google 3D Tiles |
|
||||
| `NEXT_PUBLIC_WWV_EDITION` | No | `local` / `cloud` / `demo` (default: `local`) |
|
||||
| `NEXT_PUBLIC_WWV_PLUGIN_DATA_ENGINE_URL` | No | Override engine WebSocket URL (default: cloud) |
|
||||
| `OPENSKY_CREDENTIALS` | No | Comma-separated `id:secret` pairs for credential rotation |
|
||||
| `WWV_BRIDGE_TOKEN` | No | Shared secret for marketplace → WWV install bridge |
|
||||
| `WWV_DEMO_ADMIN_SECRET` | No | Demo edition admin password |
|
||||
| `IRANWARLIVE_BACKEND_URL` | No | Override for IranWarLive custom backend URL |
|
||||
|
||||
Secrets go in `.env.local` (gitignored). Non-secrets go in `.env` (committed).
|
||||
@@ -0,0 +1,74 @@
|
||||
# Garbage Collection Policy
|
||||
|
||||
## Purpose
|
||||
|
||||
The Garbage Collector (GC) is a daily Haiku-model agent that keeps the codebase clean. It detects stale TODOs, deprecated patterns, and architectural drift, then either applies a small mechanical fix (Tier A → draft PR) or files a report for human decision (Tier B → GitHub Issue). The GC **never makes architectural decisions** and **never auto-merges** anything.
|
||||
|
||||
## Two-tier output model
|
||||
|
||||
| Tier | Criteria | Output |
|
||||
|---|---|---|
|
||||
| **A — Mechanical** | Safe, codemod-like, no architectural judgement required | Draft PR with code change |
|
||||
| **B — Judgement** | Requires human architectural decision or context | GitHub Issue, no code |
|
||||
|
||||
When unsure of the tier, escalate to Tier B. Never attempt a refactor that requires understanding business intent.
|
||||
|
||||
## How the GC works
|
||||
|
||||
1. `scripts/gc-scan.mjs` runs first — deterministic shell-based detectors, zero cost, emits `gc-findings.json`.
|
||||
2. The Haiku agent reads `gc-findings.json` and the policy below. It **does not free-scan the codebase** — it only triages the pre-computed findings list.
|
||||
3. The agent creates draft PRs and Issues per the caps and guard rails below.
|
||||
|
||||
## Approved finding types (from gc-scan.mjs)
|
||||
|
||||
| Type | Tier | Description |
|
||||
|---|---|---|
|
||||
| `stale-todo` | A | TODO/FIXME/HACK/XXX comment older than 90 days, or referencing a closed issue |
|
||||
| `anti-pattern` (mdc-ref) | A | `.mdc` file reference — must be `.md` |
|
||||
| `anti-pattern` (console-log) | A | Stray `console.log(` in `.ts`/`.tsx` files |
|
||||
| `anti-pattern` (ts-ignore) | A | `@ts-ignore` suppressing a real type error |
|
||||
| `anti-pattern` (ts-nocheck) | A | `@ts-nocheck` disabling all type checking |
|
||||
| `anti-pattern` (hardcoded-url) | B | Hardcoded `localhost:5001`/`5000` engine URL |
|
||||
| `anti-pattern` (deprecated) | B | `@deprecated` symbol still active in production code |
|
||||
| `oversized-file` | B | Source file exceeding ~350 lines |
|
||||
| `orphaned-rule-ref` | B | Rule file references a path that no longer exists |
|
||||
| `outdated-dep` | B | Dependency behind latest version |
|
||||
|
||||
## PR guard rails (mandatory — no exceptions)
|
||||
|
||||
- All PRs are **DRAFT**. Never mark ready-for-review. Never auto-merge.
|
||||
- Label every PR and Issue `gc-bot`.
|
||||
- **Max 3 PRs per run. Max 5 Issues per run.**
|
||||
- **Max ~150 changed lines per PR.** One concern per PR.
|
||||
- Branch naming: `gc/<patternId-or-type>-<git-short-sha>` (e.g. `gc/console-log-a3f1b2c`)
|
||||
- Before creating anything: check open `gc-bot` PRs and Issues for the same concern — skip if already covered.
|
||||
- Commit prefix: `chore:` for removal/cleanup, `refactor:` for structural fixes. Both are patch-level per the project `/commit` rule.
|
||||
- Every PR description must include: what changed · which detector flagged it · which rule it violates · how to verify the fix is correct.
|
||||
|
||||
## Never-touch list (absolute — the agent must refuse)
|
||||
|
||||
- `prisma/migrations/**` — migrations are irreversible
|
||||
- `pnpm-lock.yaml` — lockfile integrity
|
||||
- `.env`, `.env.local`, `.env.*`, any file containing secrets or tokens
|
||||
- Generated assets: `public/cesium/**`, `.next/**`, `node_modules/**`
|
||||
- Large seed files: `packages/*/data/**`, `local-seeders/**`
|
||||
- Binary assets: images, videos, fonts, `.db` files
|
||||
- `local-scripts/` — scratch / one-off scripts, not subject to conventions
|
||||
|
||||
## Dry-run mode
|
||||
|
||||
When `DRY_RUN=true` (set in the workflow dispatch input):
|
||||
|
||||
- Post one summary comment on the tracking Issue (`[gc-bot] Daily Scan Reports`). Create that Issue if it does not exist (label: `gc-bot`).
|
||||
- List every finding with tier, file, line, description.
|
||||
- **Do not create any PRs or Issues.**
|
||||
- Use dry-run for the first 3–5 days after deployment to validate finding quality before enabling normal mode.
|
||||
|
||||
## Idempotency rules
|
||||
|
||||
A finding is already handled if **either** of these is true:
|
||||
|
||||
1. A remote branch matching `gc/<same-patternId-or-type>-*` exists (`git branch -r --list 'origin/gc/<type>-*'`).
|
||||
2. An open PR or Issue labelled `gc-bot` already covers the same file + concern.
|
||||
|
||||
Skip handled findings without error or noise.
|
||||
@@ -1,6 +1,8 @@
|
||||
---
|
||||
trigger: model_decision
|
||||
description: Guidelines for the WorldwideView plugin marketplace, database interactions, and dynamic plugin installation.
|
||||
description: Guidelines for the WorldWideView plugin marketplace, database interactions, PKCE auth flow, and dynamic plugin installation.
|
||||
paths:
|
||||
- "src/lib/marketplace/**/*"
|
||||
- "src/app/api/marketplace/**/*"
|
||||
---
|
||||
|
||||
# Marketplace Architecture
|
||||
@@ -16,6 +18,18 @@ Plugins from the marketplace use the `bundle` format and are imported at runtime
|
||||
- `pluginManager.loadFromManifest()` validates and registers these plugins.
|
||||
- Ensure any schema changes to the marketplace tables follow the `database-migrations.md` rule.
|
||||
|
||||
## 4. Fresh-Install Seeding
|
||||
|
||||
Fresh installs (no rows in `InstalledPlugin`) auto-seed a starter set so the globe isn't empty on day one. The source of truth is the **signed verified registry** (`marketplace.worldwideview.dev/api/registry`, loaded by `registryClient.getVerifiedPluginIds()`).
|
||||
|
||||
- **No hard-coded plugin lists.** Publishing a plugin to the verified registry is what makes it part of the fresh-install starter set.
|
||||
- **Idempotent**: a `defaults_seeded` row in the `Setting` table prevents re-runs. If the registry is unreachable on first attempt, the guard is NOT set — the next request retries.
|
||||
- **Existing instances** with `defaults_seeded=true` are untouched. To pull in newly-verified plugins, users install via the marketplace UI.
|
||||
- **Demo edition** uses an independent path (`NEXT_PUBLIC_DEMO_DEFAULT_PLUGINS` env var, handled in `AppShell.tsx` and `useMarketplaceSync.ts`) — not this seeder.
|
||||
|
||||
> [!CAUTION]
|
||||
> Do not reintroduce a static `DEFAULT_PLUGIN_IDS` constant or any other hard-coded plugin list. That drifted from npm reality, caused 404s for unpublished IDs, and conflated "verified" with "auto-installed."
|
||||
|
||||
## Current Implementation State
|
||||
|
||||
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
---
|
||||
trigger: model_decision
|
||||
description: Strict rules for operating within the pnpm monorepo workspace environment structure across frontend and backend services.
|
||||
globs: ""
|
||||
paths:
|
||||
- "packages/**/*"
|
||||
- "pnpm-workspace.yaml"
|
||||
- "local-plugins/**/*"
|
||||
---
|
||||
|
||||
# Monorepo Workflow Guidelines
|
||||
@@ -13,7 +15,7 @@ Strict rules for operating within the `pnpm` monorepo workspace environment stru
|
||||
|
||||
- The Next.js frontend is located at root `.`.
|
||||
- Individual standalone plugins are located at `packages/wwv-plugin-[name]`.
|
||||
- For heavy plugin processing, data engine seeders are located at `local-seeders/community/[name]` or `local-seeders/private/[name]`.
|
||||
- For heavy plugin processing, data engine seeders are located at `local-seeders/community/[name]` or `local-seeders/private/[name]`. **These are separate git clones** (`github.com/silvertakana/wwv-seeders` and `wwv-seeders-private` respectively) — `pnpm install` from the main repo does NOT pull seeder code. Run `git pull` inside each clone to get upstream changes.
|
||||
|
||||
## Critical Workspace Rule
|
||||
|
||||
|
||||
@@ -1,120 +0,0 @@
|
||||
---
|
||||
trigger: model_decision
|
||||
description: High-level platform goals, product vision, business model, multi-repository layout, and the Edition System.
|
||||
---
|
||||
|
||||
# WorldWideView — Platform Architecture
|
||||
|
||||
|
||||
> **This folder is the canonical source of truth for the project. It is NOT committed to git.**
|
||||
> It contains live architectural decisions, future plans, and operational knowledge.
|
||||
|
||||
---
|
||||
|
||||
> [!TIP]
|
||||
> **For the fundamental system architecture, component layout, and data pipelines, please read [`docs/ARCHITECTURE.md`](../../../docs/ARCHITECTURE.md) first.**
|
||||
> This file focuses strictly on the advanced business vision, multi-repository layout, and the Edition System.
|
||||
|
||||
## Product Vision & Business Model
|
||||
|
||||
WorldWideView operates on a **VS Code distribution model**. It is a visualization platform, not a compute provider. Plugin authors bring their own backends to display real-time geospatial intelligence.
|
||||
|
||||
---
|
||||
|
||||
## Repository Structure
|
||||
|
||||
Five repositories, modelled after the n8n pattern:
|
||||
|
||||
| Repo | License | Purpose |
|
||||
|---|---|---|
|
||||
| `silvertakana/worldwideview` | Elastic License 2.0 | Core 3D globe app (Next.js + CesiumJS + Prisma) |
|
||||
| `silvertakana/wwv-data-engine` | Open Source | Generic runner (Fastify + Redis + WS) |
|
||||
| `silvertakana/wwv-seeders-community` | Open Source | Open-source community seeders |
|
||||
| `silvertakana/wwv-seeders-private` | **Private** | Proprietary seeder scripts (aviation, maritime, etc.) |
|
||||
| `silvertakana/worldwideview-marketplace` | Open Source | Plugin catalog, signed registry, admin UI |
|
||||
| `silvertakana/worldwideview-plugins` | Open Source | Published plugin frontend source |
|
||||
| `silvertakana/worldwideview-web` | Open Source | Landing page, docs, static content |
|
||||
| `silvertakana/worldwideview-cloud` | **Private** | Cloud deployment config — Docker Compose, nginx, provisioning scripts |
|
||||
| `silvertakana/plugin-sdk` | MIT | `@worldwideview/plugin-sdk` — shared types for repos + 3rd-party authors |
|
||||
|
||||
**n8n Parallel:**
|
||||
| n8n | WorldWideView |
|
||||
|---|---|
|
||||
| `n8n-io/n8n` | `silvertakana/worldwideview` |
|
||||
| `n8n-io/n8n-cloud` (private) | `silvertakana/worldwideview-cloud` (private) |
|
||||
| `n8n.io` landing | `worldwideview.dev` (static on Vercel) |
|
||||
| `app.n8n.cloud` dashboard | `app.worldwideview.dev` |
|
||||
| `[user].app.n8n.cloud` | `[user].app.worldwideview.dev` |
|
||||
| `@n8n/workflow` npm | `@worldwideview/plugin-sdk` npm |
|
||||
|
||||
---
|
||||
|
||||
## Domain Architecture
|
||||
|
||||
| URL | What | Stack |
|
||||
|---|---|---|
|
||||
| `worldwideview.dev` | Static marketing/landing | Next.js (static export) on Vercel |
|
||||
| `app.worldwideview.dev` | Auth, accounts, dashboard | Next.js + Supabase Auth |
|
||||
| `[user].app.worldwideview.dev` | User's cloud WWV instance | Next.js (multi-tenant, RLS) |
|
||||
| `marketplace.worldwideview.dev` | Plugin catalog, publishing, install | Next.js (SSO via WorldWideView auth) |
|
||||
| `demo.worldwideview.dev` | Public demo — pre-configured, read-only | Next.js (WWV app) |
|
||||
| `docs.worldwideview.dev` | Documentation | TBD (Mintlify/Nextra) |
|
||||
| `status.worldwideview.dev` | Uptime / incident | Uptime Kuma |
|
||||
| `api.worldwideview.dev` | Built-in data services (aviation, maritime) | Next.js API routes or standalone |
|
||||
| `cdn.worldwideview.dev` | Plugin bundle storage | Cloudflare R2 |
|
||||
|
||||
**Reserved subdomains:** `www`, `app`, `api`, `demo`, `marketplace`, `docs`, `status`, `admin`, `cdn`, `blog`, `changelog`
|
||||
|
||||
---
|
||||
|
||||
## Infrastructure
|
||||
|
||||
All on **Coolify** running on a repurposed **ThinkPad T480s** (i5-8350U, 16GB RAM, 256GB NVMe, Ubuntu). Zero monthly hosting cost.
|
||||
|
||||
```
|
||||
ThinkPad T480s (home server, $0/mo) Supabase (hosted)
|
||||
├── Coolify ──→ ├── PostgreSQL (cloud DB)
|
||||
│ ├── worldwideview.dev (landing, Vercel) ├── Auth (GoTrue)
|
||||
│ ├── app.worldwideview.dev (auth/dashboard) └── Storage (file uploads)
|
||||
│ ├── WWV Cloud App (Docker)
|
||||
│ ├── Marketplace App (Docker) Cloudflare (free)
|
||||
│ ├── Demo Instance (Docker) ├── DNS + wildcard routing
|
||||
│ ├── api.worldwideview.dev ├── CDN caching
|
||||
│ ├── Uptime Kuma ├── DDoS protection
|
||||
│ └── Plausible Analytics └── R2 (plugin bundle CDN)
|
||||
└── Ubuntu Server
|
||||
```
|
||||
|
||||
**CI/CD:** Push to `silvertakana/worldwideview` → GitHub Actions builds Docker image → pushes to `ghcr.io/silvertakana/worldwideview:latest` → Coolify webhook triggers rolling restart.
|
||||
|
||||
**Monitoring:** Uptime Kuma (all subdomains), Plausible/Umami analytics.
|
||||
|
||||
---
|
||||
|
||||
## Business Model
|
||||
|
||||
**Distribution platform, not compute provider.** Plugin authors handle their own backends.
|
||||
|
||||
| Revenue Stream | How |
|
||||
|---|---|
|
||||
| **Cloud hosting** | `[user].app.worldwideview.dev` — free/pro/enterprise tiers |
|
||||
| **Marketplace cut** | % of paid plugin subscriptions via Stripe Connect |
|
||||
| **Verified tier** | Plugin authors pay for review + verified badge |
|
||||
| **Pro/Enterprise license** | More quota, faster cache TTL, advanced features |
|
||||
| **Extension packs** | Curated bundles of related plugins |
|
||||
|
||||
Plugin authors can monetize independently (VS Code + GitHub Copilot model). Selling through the marketplace is **incentivized** (managed billing, featured placement, analytics) but not mandatory.
|
||||
|
||||
---
|
||||
|
||||
## Editions
|
||||
|
||||
Three editions; same codebase, gated by `NEXT_PUBLIC_WWV_EDITION`:
|
||||
|
||||
| Edition | Value | Database | Auth | Plugin Install |
|
||||
|---|---|---|---|---|
|
||||
| **Local** | `local` | PostgreSQL | Auth.js Credentials | Yes |
|
||||
| **Cloud** | `cloud` | PostgreSQL (Supabase) | Auth.js + Supabase | Yes |
|
||||
| **Demo** | `demo` | PostgreSQL (read-only) | Disabled | No |
|
||||
|
||||
Three thin adapter files handle edition differences: `src/core/auth.ts`, `src/core/storage.ts`, `src/core/tenant.ts`. Everything else is edition-unaware.
|
||||
@@ -1,6 +1,10 @@
|
||||
---
|
||||
trigger: model_decision
|
||||
description: The standard operating procedure for instantiating, modifying, and registering a new data source plugin within the engine.
|
||||
paths:
|
||||
- "src/core/plugins/**/*"
|
||||
- "packages/wwv-plugin-*/src/**/*"
|
||||
- "local-plugins/**/*"
|
||||
- "packages/wwv-plugin-sdk/src/**/*"
|
||||
---
|
||||
|
||||
# Plugin Architecture & Data Flow
|
||||
@@ -17,6 +21,59 @@ A valid plugin class MUST provide:
|
||||
3. `renderEntity(GeoEntity)` to determine visual style.
|
||||
4. `getPollingInterval()` (defaults fallback securely to standard store config).
|
||||
|
||||
## Plugin Data Delivery Types
|
||||
|
||||
Plugins receive entity data in one of three modes. Choose the right mode before writing code — mixing them causes silent data loss.
|
||||
|
||||
| Mode | `getPollingInterval()` | `fetch()` | `mapWebsocketPayload()` | When to use |
|
||||
|---|---|---|---|---|
|
||||
| **REST-only** | `> 0` (ms) | Returns `GeoEntity[]` | Not needed | Static or slow-changing data (< every 30s). No seeder required. |
|
||||
| **WebSocket-only** | `0` | Return `[]` immediately | **Required** if seeder sends object payload | Live-streaming data from a seeder (satellites, AIS, flights) |
|
||||
| **Hybrid** | `> 0` | Returns initial snapshot | **Required** if seeder sends object payload | Needs both immediate data on load AND live updates |
|
||||
|
||||
### WebSocket-Only Pattern (most live-data plugins)
|
||||
|
||||
```typescript
|
||||
getPollingInterval(): number {
|
||||
return 0; // WS-only — do NOT call REST on enable
|
||||
}
|
||||
|
||||
async fetch(_timeRange: TimeRange): Promise<GeoEntity[]> {
|
||||
return []; // Initial data arrives via mapWebsocketPayload within seconds
|
||||
}
|
||||
|
||||
mapWebsocketPayload(payload: any, _existingEntities: GeoEntity[]): GeoEntity[] {
|
||||
// Transform raw engine payload → GeoEntity[]
|
||||
// payload shape depends on what the seeder calls setLiveSnapshot() with
|
||||
const items = payload?.items ?? (Array.isArray(payload) ? payload : []);
|
||||
return items.map((item: any): GeoEntity => ({
|
||||
id: `my-plugin-${item.id}`,
|
||||
pluginId: "my-plugin",
|
||||
latitude: item.lat,
|
||||
longitude: item.lon,
|
||||
altitude: item.alt ?? 0,
|
||||
timestamp: new Date(),
|
||||
label: item.name,
|
||||
properties: item,
|
||||
}));
|
||||
}
|
||||
```
|
||||
|
||||
> [!WARNING]
|
||||
> If `getPollingInterval()` returns `0` but the seeder sends an object payload, you **MUST** implement `mapWebsocketPayload`. Without it, `WsClient` drops the data silently. See `data-engine-architecture.md §7` for the exact rule.
|
||||
|
||||
### `mapWebsocketPayload` Signature
|
||||
|
||||
```typescript
|
||||
mapWebsocketPayload(payload: any, existingEntities: GeoEntity[]): GeoEntity[]
|
||||
```
|
||||
|
||||
- `payload` — raw value from `setLiveSnapshot()` in the seeder (whatever shape the seeder stores)
|
||||
- `existingEntities` — current entities in the store for this plugin (use for incremental updates)
|
||||
- Must return a **complete replacement** `GeoEntity[]` (not a diff)
|
||||
|
||||
---
|
||||
|
||||
## Plugin Architectures (Manifest Formats)
|
||||
|
||||
Plugins are defined via `PluginManifest` and operate on an **All-Bundle** architecture.
|
||||
@@ -52,6 +109,33 @@ All plugins MUST define their identity and compatibility via a `"worldwideview"`
|
||||
}
|
||||
```
|
||||
|
||||
### `peerDependencies` Rule for npm-Published Plugins
|
||||
|
||||
Plugins published to npm **MUST** declare the following as `peerDependencies`, not `dependencies`:
|
||||
|
||||
```json
|
||||
{
|
||||
"peerDependencies": {
|
||||
"@worldwideview/wwv-plugin-sdk": "*",
|
||||
"react": ">=19",
|
||||
"lucide-react": "*"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Also peer (never bundle): `react-dom`, `cesium`, `resium`, `zustand`.
|
||||
|
||||
Bundling these causes multiple React instances in the host app, breaking hooks (`Invalid hook call` at runtime).
|
||||
|
||||
### File Extension Rule
|
||||
|
||||
- Files containing **JSX** (any `<Component />` syntax, `return (<div>...)`) → must use `.tsx`
|
||||
- Files with no JSX (pure TypeScript, even importing React types) → use `.ts`
|
||||
|
||||
This is enforced by the TypeScript compiler. A `.ts` file with JSX will fail to build.
|
||||
|
||||
---
|
||||
|
||||
## The Registration Pipeline
|
||||
|
||||
> [!NOTE]
|
||||
@@ -78,9 +162,9 @@ DataBus.getInstance().emit('dataUpdated', {
|
||||
});
|
||||
```
|
||||
|
||||
## Local Plugin Development (Sandbox)
|
||||
## Local Plugin Development
|
||||
|
||||
To rapidly iterate on plugins without polluting the core monorepo `packages/` directory or git history, use the local devkit:
|
||||
`local-plugins/` is a **git clone of the canonical community plugin repo** (`github.com/silvertakana/wwv-plugins`), gitignored from the main `worldwideview` repo. It has its own remote — commits and pushes go upstream to that public repo, not to `worldwideview`. Run `cd local-plugins && git pull` before working to get the latest community plugins.
|
||||
|
||||
1. **Create**: Run `node packages/wwv-cli/dist/index.js create <name> --local` to scaffold a full plugin structure inside the `local-plugins/` directory.
|
||||
2. **Develop**: Running `pnpm dev` or `pnpm dev:all` automatically spawns the `dev:plugins` watcher. Any changes made to plugins in `local-plugins/` will be instantly rebuilt using Vite (externalizing large globals) and synced to `public/plugins-local/` for hot-reloading.
|
||||
@@ -208,7 +292,7 @@ When implementing the `token-exchange` flow or communicating across domains, all
|
||||
Starting in 2026, WorldWideView adopted the **Architect and Toolbox** paradigm using NPM global tools, ensuring a fully decoupled developer experience. Plugin repositories contain *pure code* with absolutely no platform hosting boilerplate (e.g. no embedded docker-compose files).
|
||||
|
||||
### The Developer Experience
|
||||
1. **Scaffold**: `node packages/wwv-cli/dist/index.js create <name> --local` (Creates sandbox inside `local-plugins/`)
|
||||
1. **Scaffold**: `node packages/wwv-cli/dist/index.js create <name> --local` (Creates plugin inside `local-plugins/` — the community plugin repo clone)
|
||||
2. **Install**: `pnpm install` (Links dependencies via workspace)
|
||||
3. **Develop**: `pnpm dev:all` (Starts frontend, data engine, and plugin watcher dynamically)
|
||||
|
||||
@@ -391,10 +475,11 @@ While avoiding monolithic coupling, WWV plans to implement the following high-UX
|
||||
|
||||
## Local Plugins & Seeders
|
||||
|
||||
### 1. Local Sandbox Workflow
|
||||
### 1. Local Plugin Workflow (`local-plugins/` — community plugin repo clone)
|
||||
`local-plugins/` is a git clone of `github.com/silvertakana/wwv-plugins` with its own remote. Pull latest before starting: `cd local-plugins && git pull`.
|
||||
- **Scaffold**: `node packages/wwv-cli/dist/index.js create` (creates inside `local-plugins/wwv-plugin-<name>` by default, or `packages/` if `--core` is used).
|
||||
- **Develop**: `pnpm dev` triggers hot-reloading via `dev:plugins` watch script.
|
||||
- **Publish**: `node packages/wwv-cli/dist/index.js publish <name> [--org <your-org>]` publishes the plugin from the project root. (No linking is needed; the sandbox natively functions in the workspace).
|
||||
- **Publish**: `node packages/wwv-cli/dist/index.js publish <name> [--org <your-org>]` publishes the plugin from the project root. Commit and push from inside `local-plugins/` to contribute back to the community repo.
|
||||
|
||||
### 2. Data Engine Seeders
|
||||
Seeders in `wwv-data-engine/src/seeders/` provide the backend data.
|
||||
|
||||
@@ -1,25 +0,0 @@
|
||||
---
|
||||
trigger: model_decision
|
||||
description: Server development and debugging rules for the production/homelab server using SSH and Coolify MCP.
|
||||
---
|
||||
|
||||
# Server Management & Debugging
|
||||
|
||||
## 1. Coolify MCP (High-Level)
|
||||
Use the `coolify` MCP server for managed actions:
|
||||
- **Discovery**: `mcp_coolify_projects`, `mcp_coolify_environments`
|
||||
- **Inspection**: `mcp_coolify_application_logs`, `mcp_coolify_get_application`
|
||||
- **Actions**: `mcp_coolify_control` (restart, stop)
|
||||
|
||||
## 2. Direct SSH (Low-Level)
|
||||
For filesystem or network issues, use direct SSH to the production server:
|
||||
`ssh [email protected] "<command>"`
|
||||
|
||||
**Common Commands**:
|
||||
- `docker ps`
|
||||
- `docker logs --tail 100 <container_id>`
|
||||
- `df -h`
|
||||
- `top -b -n 1` (Never run interactive `top` or `nano` via agent commands).
|
||||
|
||||
## 3. Safety Precautions
|
||||
Always use non-interactive flags for SSH. Communicate clearly before executing high-risk actions like volume deletion or critical infrastructure restarts.
|
||||
@@ -1,378 +0,0 @@
|
||||
---
|
||||
trigger: model_decision
|
||||
description: Human-centered design principles, stakeholder map, and decision matrix.
|
||||
---
|
||||
|
||||
# Stakeholders & Human-Centered Design
|
||||
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **This document is mandatory reading before any feature, UI, API, or architectural decision.**
|
||||
> Every line of code in this project ultimately serves a human being. The AI agent MUST identify which stakeholder(s) a change affects and design the solution around their needs, abilities, and constraints — not the other way around.
|
||||
|
||||
---
|
||||
|
||||
## Why This Document Exists
|
||||
|
||||
Software that doesn't consider its humans fails. Not technically — socially. A plugin API that's elegant internally but hostile to external developers will die with zero third-party plugins. A monetization tier that ignores what users actually value will generate zero revenue. A contribution process that assumes PhD-level Cesium knowledge will attract zero contributors.
|
||||
|
||||
**The directive is simple:** Before you write code, ask *"Who is this for, what do they need, and what will they actually experience?"*
|
||||
|
||||
---
|
||||
|
||||
## The Stakeholder Universe
|
||||
|
||||
WorldWideView is not a single-user tool. It is a **platform ecosystem** with at least nine distinct human roles, each with different goals, different technical abilities, different emotional states when they interact with the product, and different definitions of "success."
|
||||
|
||||
```
|
||||
┌──────────────────┐
|
||||
│ Owner / Founder │
|
||||
│ (silvertakana) │
|
||||
└────────┬─────────┘
|
||||
│ vision, architecture, deployment
|
||||
┌───────────────────┼───────────────────┐
|
||||
│ │ │
|
||||
┌──────┴──────┐ ┌───────┴───────┐ ┌───────┴───────┐
|
||||
│ Core Devs │ │ Contributors │ │ Plugin Devs │
|
||||
│ (team) │ │ (community) │ │ (3rd party) │
|
||||
└──────┬──────┘ └───────┬───────┘ └───────┬───────┘
|
||||
│ │ │
|
||||
└───────────┬───────┘ │
|
||||
│ build the product │ extend the product
|
||||
┌───────────┴────────────────────────────┘
|
||||
│
|
||||
┌──────┴──────────────────────────────────┐
|
||||
│ The Application │
|
||||
│ ┌────────┐ ┌────────┐ ┌───────────┐ │
|
||||
│ │ Demo │ │ Local │ │ Cloud │ │
|
||||
│ │Instance│ │Instance│ │ Instance │ │
|
||||
│ └───┬────┘ └───┬────┘ └─────┬─────┘ │
|
||||
└──────┼───────────┼─────────────┼────────┘
|
||||
│ │ │
|
||||
┌──────┴──┐ ┌─────┴────┐ ┌────┴─────┐
|
||||
│Casual │ │Power User│ │Paying │
|
||||
│Visitor │ │(self-host)│ │Customer │
|
||||
└─────────┘ └──────────┘ └────┬─────┘
|
||||
│
|
||||
┌────────┴────────┐
|
||||
│ Advertisers │
|
||||
│ (demo edition) │
|
||||
└─────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Stakeholder Profiles
|
||||
|
||||
### 1. Owner / Founder (silvertakana)
|
||||
|
||||
| Attribute | Description |
|
||||
|---|---|
|
||||
| **Role** | Solo founder, architect, deployer, and operator of the entire ecosystem |
|
||||
| **Goal** | Build a sustainable, revenue-generating geospatial intelligence platform that rivals WorldMonitor |
|
||||
| **Motivations** | Technical excellence, creative ownership, financial independence, community building |
|
||||
| **Technical Ability** | Expert — TypeScript, Next.js, CesiumJS, Docker, infrastructure, Prisma, AI-assisted development |
|
||||
| **Emotional State** | Ambitious but resource-constrained; every wasted hour counts double |
|
||||
| **Definition of Success** | Growing user base, marketplace with active plugin developers, recurring revenue, industry recognition |
|
||||
| **Pain Points** | Single point of failure for ops, deployment, and architecture decisions; time pressure; hosting cost sensitivity ($0/mo target) |
|
||||
| **Interaction Surface** | `.agents/` rules, ROADMAP.md, Coolify dashboard, code reviews, AI pair-programming sessions |
|
||||
|
||||
**Design implications:**
|
||||
- Automation is critical — CI/CD, self-healing databases, zero-config setup
|
||||
- AI agent rules must preserve the owner's vision even when the owner isn't in the conversation
|
||||
- Cost-efficient architecture (PostgreSQL, ThinkPad server, free-tier services) is a feature, not a compromise
|
||||
- Every architectural decision must consider the owner's ability to maintain it solo
|
||||
|
||||
---
|
||||
|
||||
### 2. Core Development Team (WWV Devs)
|
||||
|
||||
| Attribute | Description |
|
||||
|---|---|
|
||||
| **Role** | Trusted developers with direct commit access to the monorepo |
|
||||
| **Goal** | Ship features quickly without breaking existing functionality |
|
||||
| **Motivations** | Clean code, clear architecture, fast iteration, not getting paged at 2am |
|
||||
| **Technical Ability** | High — comfortable with TypeScript, Next.js App Router, Zustand, pnpm workspaces |
|
||||
| **Emotional State** | Productive when patterns are clear; frustrated by undocumented gotchas |
|
||||
| **Definition of Success** | PRs merged cleanly, features work on first deploy, zero regressions |
|
||||
| **Pain Points** | File bloat (>150 lines), implicit state dependencies, CesiumJS rendering quirks, Docker build complexity |
|
||||
| **Interaction Surface** | `src/core/`, `src/components/`, `packages/`, PR reviews, `pnpm dev` |
|
||||
|
||||
**Design implications:**
|
||||
- 150-line file limit is sacred — enforce it in every code change
|
||||
- Clear slice boundaries in Zustand store prevent cross-team conflicts
|
||||
- `AGENTS.md` and `.agents/` context must always be current so that AI-augmented devs have accurate context
|
||||
- Rendering rules (billboard vs. point, never mix properties) must be enforced systematically
|
||||
- Docker gotchas documented in `06-dev-workflows.md` prevent time-sink debugging
|
||||
|
||||
---
|
||||
|
||||
### 3. Open Source Contributors
|
||||
|
||||
| Attribute | Description |
|
||||
|---|---|
|
||||
| **Role** | External developers who fork, fix bugs, add features, or create plugins via PRs |
|
||||
| **Goal** | Contribute meaningfully without needing to understand the entire 50-package monorepo |
|
||||
| **Motivations** | Portfolio building, learning CesiumJS/geospatial tech, improving a tool they use, open source goodwill |
|
||||
| **Technical Ability** | **Variable** — ranges from junior devs submitting typo fixes to senior engineers contributing optimizations |
|
||||
| **Emotional State** | Enthusiastic but easily discouraged by onboarding friction; will abandon contribution if setup takes >15 minutes |
|
||||
| **Definition of Success** | PR accepted and merged; their name in the contributors list; feature actually ships |
|
||||
| **Pain Points** | Complex monorepo, CesiumJS learning curve, Elastic License 2.0 implications, unclear "where to start" |
|
||||
| **Interaction Surface** | `CONTRIBUTING.md`, `docs/SETUP.md`, `docs/PLUGIN_GUIDE.md`, GitHub Issues, PR templates |
|
||||
|
||||
**Design implications:**
|
||||
- **One-command setup** (`pnpm run setup && pnpm dev:all`) is non-negotiable — if it breaks, contributors leave
|
||||
- `CONTRIBUTING.md` must use `pnpm` (currently shows `npm` in places — this is a bug)
|
||||
- "Good first issue" labels on GitHub attract newcomers
|
||||
- Plugin creation is the #1 entry point for contributors — the scaffold script and Plugin Guide must be flawless
|
||||
- The Elastic License 2.0 must be clearly communicated (it's NOT fully open source — contributors need to understand what they're signing up for)
|
||||
|
||||
---
|
||||
|
||||
### 4. Third-Party Plugin Developers
|
||||
|
||||
| Attribute | Description |
|
||||
|---|---|
|
||||
| **Role** | External developers who build and publish plugins to the WorldWideView Marketplace |
|
||||
| **Goal** | Create a plugin that integrates their data source, potentially monetize it |
|
||||
| **Motivations** | Revenue (marketplace cut), reach (installed on many WWV instances), reputation, data evangelism |
|
||||
| **Technical Ability** | **Mid-to-high** — comfortable with TypeScript and npm, but NOT Cesium experts. They should never need to learn Cesium internals. |
|
||||
| **Emotional State** | Evaluating whether the platform is worth investing development time in. Extremely sensitive to DX friction. |
|
||||
| **Definition of Success** | Plugin published, visible in marketplace, installed by users, data renders correctly, optional revenue stream |
|
||||
| **Pain Points** | (1) Backend hosting burden — they need a VPS for active plugins (the "VPS Problem"), (2) No distributable mini-engine yet, (3) SDK docs may not cover edge cases, (4) Rendering bugs with billboard/point property mixing |
|
||||
| **Interaction Surface** | `@worldwideview/wwv-plugin-sdk`, `docs/PLUGIN_GUIDE.md`, `docs/creating-a-plugin.md`, marketplace submission UI, npm publishing |
|
||||
|
||||
**Design implications:**
|
||||
- The Plugin SDK is the **#1 most important public API surface** — it must be impeccably documented, versioned, and stable
|
||||
- `WorldPlugin` interface changes are breaking changes that affect real people with real published packages
|
||||
- Three plugin formats (Declarative, Static, Code Bundle) exist specifically to lower the barrier:
|
||||
- **Declarative** = zero code (JSON only) — anyone with a data URL can create a plugin
|
||||
- **Static** = GeoJSON file + manifest — data analysts who aren't developers
|
||||
- **Code Bundle** = full TypeScript — professional developers
|
||||
- The future **Mini-Engine Docker image** (§3 of `03-plugin-system.md`) is critical for reducing the VPS burden
|
||||
- Rendering must be abstracted — plugin devs define `renderEntity()`, and the engine handles GPU batching
|
||||
- Error messages from the plugin lifecycle must be clear, not cryptic Cesium stack traces
|
||||
- Marketplace analytics (install counts, usage) are what keep plugin developers motivated
|
||||
|
||||
---
|
||||
|
||||
### 5. Casual Visitors (Demo Users)
|
||||
|
||||
| Attribute | Description |
|
||||
|---|---|
|
||||
| **Role** | Anonymous visitors who land on `demo.worldwideview.dev` — no account, no setup |
|
||||
| **Goal** | Explore the globe, see cool real-time data, understand what WorldWideView is |
|
||||
| **Motivations** | Curiosity, news events (war, natural disasters, flight tracking), linked from social media or Reddit |
|
||||
| **Technical Ability** | **Low to none** — they don't know what ADS-B or GeoJSON means. They just want to see planes on a globe. |
|
||||
| **Emotional State** | Impatient. They will leave within 10 seconds if the globe doesn't load or the UI is confusing. |
|
||||
| **Definition of Success** | "Whoa, this is cool" → bookmark/share → return later → potentially convert to self-host or cloud user |
|
||||
| **Pain Points** | Slow boot time (Cesium asset loading), confusing UX, data not loading (API rate limits), ads disrupting experience |
|
||||
| **Interaction Surface** | Boot overlay, 3D globe, layer toggle panel, entity hover/click, info cards, timeline, ad strip |
|
||||
|
||||
**Design implications:**
|
||||
- **First 5 seconds are everything** — the boot overlay must feel cinematic, not broken
|
||||
- Pre-activate compelling default layers (aviation is the universal crowd-pleaser)
|
||||
- Globe interaction must work without instructions — left-click drag, scroll zoom, click entity
|
||||
- The "Why ads?" banner (`DemoAdStrip`) is a trust-building honesty moment — keep it human and transparent
|
||||
- Mobile layout must be flawless — many demo visitors come from social media on phones
|
||||
- No login walls, no setup wizards, no configuration prompts — demo is zero-friction
|
||||
- Performance on commodity hardware (integrated GPUs, 2017 laptops) must be acceptable
|
||||
- Error states must be invisible — if OpenSky is down, the layer just shows fewer planes, not an error dialog
|
||||
|
||||
---
|
||||
|
||||
### 6. Self-Hosted Power Users (Local Edition)
|
||||
|
||||
| Attribute | Description |
|
||||
|---|---|
|
||||
| **Role** | Technical users who run WorldWideView on their own hardware (Raspberry Pi, home server, VPS) |
|
||||
| **Goal** | Full control over their own geospatial intelligence dashboard, no cloud dependency |
|
||||
| **Motivations** | Privacy, customization, data sovereignty, OSINT hobbyism, professional intelligence work |
|
||||
| **Technical Ability** | **High** — comfortable with Docker, environment variables, CLI tools, possibly contributing plugins |
|
||||
| **Emotional State** | Empowered but demanding. They chose self-hosting for a reason — they expect it to work without phoning home. |
|
||||
| **Definition of Success** | Instance running 24/7, plugins installed and polling reliably, data persisted locally, zero external dependencies |
|
||||
| **Pain Points** | Docker build complexity, PostgreSQL connection pooling issues, Cesium token setup, Prisma migration gotchas, plugin data not loading |
|
||||
| **Interaction Surface** | `docker-compose.yml`, `.env.local`, Setup Wizard, Layers Panel, Config Panel, Marketplace Bridge, `pnpm run dev:all` |
|
||||
|
||||
**Design implications:**
|
||||
- **Zero-config first run** — `pnpm run setup && pnpm dev` or `docker-compose up` must "just work"
|
||||
- The Setup Wizard (Cesium token prompt) is the ONLY mandatory configuration step — minimize it
|
||||
- PostgreSQL must handle concurrent reads from the app + data engine efficiently
|
||||
- Self-hosted users are the most likely to become contributors — treat their issues as high-priority
|
||||
- Data engine self-healing (fallback seeds) ensures restarts don't lose data
|
||||
- Offline capability is a differentiator — cached entities in IndexedDB survive network outages
|
||||
- `NEXT_PUBLIC_WWV_EDITION=local` must be the default, most-tested path
|
||||
|
||||
---
|
||||
|
||||
### 7. Paying Customers (Cloud Pro/Enterprise)
|
||||
|
||||
| Attribute | Description |
|
||||
|---|---|
|
||||
| **Role** | Users or organizations paying for `[user].app.worldwideview.dev` — the revenue engine |
|
||||
| **Goal** | Reliable, always-on geospatial intelligence with history, higher rate limits, and team access |
|
||||
| **Motivations** | Professional OSINT, military/defense analysis, logistics monitoring, journalism, corporate security |
|
||||
| **Technical Ability** | **Variable** — from journalists who just need a globe to security analysts who want API access |
|
||||
| **Emotional State** | **Paying customers have the lowest tolerance for bugs.** They expect enterprise-grade uptime and support. |
|
||||
| **Definition of Success** | Data is live, history works, team members can access, exports work, it doesn't go down |
|
||||
| **Pain Points** | Downtime, stale data, missing features compared to competitors, unclear what "Pro" actually gives them |
|
||||
| **Interaction Surface** | Cloud dashboard, license key input, plugin marketplace, support channels, billing UI |
|
||||
|
||||
**Design implications:**
|
||||
- **Uptime is king** — Uptime Kuma monitoring, error alerting, and rollback procedures exist for this reason
|
||||
- Tier differentiation must be clear and valuable:
|
||||
- Free: 3 users, 500MB, 24h history
|
||||
- Pro: 20 users, 5GB, full history, snapshot capture
|
||||
- Enterprise: unlimited, 50GB+, custom domains
|
||||
- License key verification (RSA-signed JWT) prevents forgery but must not be onerous UX
|
||||
- RLS tenant isolation is non-negotiable — data leaks between tenants are existential
|
||||
- Response caching at the API proxy layer makes the $0/mo server viable for multiple tenants
|
||||
- The cloud edition must feel **identical** to local — same UI, same plugins, same experience
|
||||
|
||||
---
|
||||
|
||||
### 8. Advertisers (Demo Edition Revenue)
|
||||
|
||||
| Attribute | Description |
|
||||
|---|---|
|
||||
| **Role** | Google AdSense (programmatic) — automated ad placement on the demo instance |
|
||||
| **Goal** | Display relevant ads to engaged visitors, generate clicks/impressions |
|
||||
| **Motivations** | ROI on ad spend; relevant audience targeting |
|
||||
| **Technical Ability** | N/A — they interact through Google's ad platform, not with WWV directly |
|
||||
| **Emotional State** | N/A — algorithmic. But their platform (AdSense) has strict technical requirements. |
|
||||
| **Definition of Success** | Ads render correctly, non-intrusively, on viewable screen real estate |
|
||||
| **Pain Points** | AdSense script crashes on resize, ads failing to fill on localhost/tunnels, ads overlapping interactive content |
|
||||
| **Interaction Surface** | `DemoAdStrip.tsx`, `AdUnit.tsx`, Google AdSense publisher dashboard |
|
||||
|
||||
**Design implications:**
|
||||
- Ad strip is a **structurally separate sibling container** — never overlaps the globe viewport
|
||||
- Fixed-position elements (header, timeline, sidebars) use `--ad-strip-inset` CSS variable to avoid overlap
|
||||
- AdSense `push()` errors on resize are handled by fully unmounting ad units below 850px height
|
||||
- Ads are **demo edition only** — they never appear in local or cloud editions
|
||||
- The "Why ads?" banner is a conscious UX choice that builds trust with users and is dismissible
|
||||
- Ad revenue is a temporary bridge to sustainability, not the long-term business model
|
||||
|
||||
---
|
||||
|
||||
### 9. Data Source Providers (Upstream APIs)
|
||||
|
||||
| Attribute | Description |
|
||||
|---|---|
|
||||
| **Role** | External services that provide the raw data: OpenSky, AIS providers, NASA FIRMS, ACLED, CelesTrak, GPSJam, etc. |
|
||||
| **Goal** | Serve data within their rate limits and terms of service |
|
||||
| **Motivations** | Open data mission (NASA, CelesTrak), freemium conversion (OpenSky), research community |
|
||||
| **Technical Ability** | N/A — they expose APIs; WWV consumes them |
|
||||
| **Emotional State** | Hostile if rate-limited. Neutral if respected. |
|
||||
| **Definition of Success** | API consumers stay within rate limits, attribute correctly, and don't DDOS their endpoints |
|
||||
| **Pain Points** | Credential rotation failures (OpenSky), rate limit exhaustion, unattributed scraping |
|
||||
| **Interaction Surface** | Data Engine seeders, API route proxies, `OPENSKY_CREDENTIALS` rotation, `pollingIntervalMs` settings |
|
||||
|
||||
**Design implications:**
|
||||
- **Respect upstream rate limits** — this is an ethical and practical obligation
|
||||
- Credential rotation (`OPENSKY_CREDENTIALS` comma-separated pairs) prevents per-key throttling
|
||||
- The Data Engine's 5-minute Redis throttle (`setLiveSnapshot`) is specifically designed to stay within Upstash free-tier limits
|
||||
- API proxy caching (1000 users → 1 upstream request) is architecturally essential
|
||||
- Attribution (e.g., "Data: OpenSky Network") should be visible in entity detail panels
|
||||
- Graceful degradation when APIs go down — show cached data, not error modals
|
||||
|
||||
---
|
||||
|
||||
## The Stakeholder Decision Matrix
|
||||
|
||||
When making any decision, use this matrix to identify impact:
|
||||
|
||||
| Decision Area | Owner | Core Devs | Contributors | Plugin Devs | Casual Visitors | Power Users | Paying Customers | Advertisers | Data Providers |
|
||||
|---|---|---|---|---|---|---|---|---|---|
|
||||
| **Plugin SDK change** | ⚠️ | ⚠️ | ⬜ | 🔴 | ⬜ | ⬜ | ⬜ | ⬜ | ⬜ |
|
||||
| **UI/UX redesign** | ⚠️ | ⬜ | ⬜ | ⬜ | 🔴 | ⚠️ | 🔴 | ⚠️ | ⬜ |
|
||||
| **Rendering pipeline change** | ⚠️ | 🔴 | ⬜ | ⚠️ | ⚠️ | ⚠️ | ⚠️ | ⬜ | ⬜ |
|
||||
| **Database schema migration** | ⚠️ | ⚠️ | ⬜ | ⬜ | ⬜ | 🔴 | 🔴 | ⬜ | ⬜ |
|
||||
| **New data source plugin** | ✅ | ⬜ | ✅ | ⬜ | ✅ | ✅ | ✅ | ⬜ | ⚠️ |
|
||||
| **Pricing/tier change** | 🔴 | ⬜ | ⬜ | ⚠️ | ⬜ | ⚠️ | 🔴 | ⬜ | ⬜ |
|
||||
| **Ad placement change** | ⚠️ | ⬜ | ⬜ | ⬜ | ⚠️ | ⬜ | ⬜ | 🔴 | ⬜ |
|
||||
| **API rate limit adjustment** | ⬜ | ⬜ | ⬜ | ⬜ | ⬜ | ⬜ | ⚠️ | ⬜ | 🔴 |
|
||||
| **Marketplace policy** | 🔴 | ⬜ | ⬜ | 🔴 | ⬜ | ⬜ | ⚠️ | ⬜ | ⬜ |
|
||||
| **Docker/deployment change** | 🔴 | ⚠️ | ⬜ | ⬜ | ⬜ | 🔴 | ⚠️ | ⬜ | ⬜ |
|
||||
| **License change** | 🔴 | ⚠️ | 🔴 | 🔴 | ⬜ | ⚠️ | ⬜ | ⬜ | ⬜ |
|
||||
|
||||
**Legend:** 🔴 = Primary impact (design for this person) | ⚠️ = Secondary impact (consider carefully) | ✅ = Positive impact | ⬜ = Minimal/no impact
|
||||
|
||||
---
|
||||
|
||||
## The Golden Rules
|
||||
|
||||
### 1. Every Feature Has a Human
|
||||
|
||||
Before writing a single line of code, the AI agent MUST answer:
|
||||
- **WHO** is this for? (Name the stakeholder)
|
||||
- **WHY** do they need it? (What problem does it solve for them?)
|
||||
- **HOW** will they discover/use it? (What's their journey?)
|
||||
- **WHAT** happens when it breaks? (Graceful degradation plan)
|
||||
|
||||
### 2. Reduce Friction, Not Features
|
||||
|
||||
The most dangerous failure mode is building powerful systems with hostile interfaces. Apply the **Principle of Least Effort**:
|
||||
- Contributors: one-command setup, not a wiki page of prerequisites
|
||||
- Plugin devs: `renderEntity()` returns an object, not a Cesium Primitive
|
||||
- Casual visitors: zero onboarding, zero configuration
|
||||
- Power users: sensible defaults, optional configuration
|
||||
- Paying customers: it just works, always
|
||||
|
||||
### 3. Design for the Least Technical User in Each Cohort
|
||||
|
||||
| Cohort | Least Technical Member | Design Target |
|
||||
|---|---|---|
|
||||
| Plugin Developers | Data analyst who can write JSON | Declarative plugin format |
|
||||
| Contributors | Junior dev on their first open source PR | Scaffold scripts + clear CONTRIBUTING.md |
|
||||
| Casual Visitors | Non-technical person who followed a Twitter link | Auto-loading layers, intuitive globe controls |
|
||||
| Power Users | Sysadmin who can `docker-compose up` but doesn't know Next.js | Pre-built Docker images, `.env` only config |
|
||||
| Paying Customers | Journalist tracking a conflict | Clear UI, no jargon, exportable data |
|
||||
|
||||
### 4. Protect the Ecosystem Trust
|
||||
|
||||
The trust hierarchy is cryptographically enforced (Ed25519 signed registry), but trust is also social:
|
||||
- **Built-in plugins** must always work — they're the first impression
|
||||
- **Verified plugins** carry WorldWideView's reputation — review them seriously
|
||||
- **Unverified plugins** get a warning dialog — users make informed decisions
|
||||
- **Plugin developers** who see installs and analytics stay motivated
|
||||
- **Data providers** who aren't rate-limit abused will keep serving data
|
||||
|
||||
### 5. Revenue Serves Sustainability, Not Extraction
|
||||
|
||||
The business model exists to keep the project alive:
|
||||
- Ads on demo = temporary hosting cost recovery (transparent "Why ads?" banner)
|
||||
- Cloud Pro = value exchange (history, higher limits, team access)
|
||||
- Marketplace cut = sustainable ecosystem (Stripe Connect revenue split)
|
||||
- Plugin developer monetization = VS Code model (developers set their own prices)
|
||||
|
||||
Never design a feature that extracts value from users without returning it. The demo must always be useful, not crippled.
|
||||
|
||||
---
|
||||
|
||||
## Applying This Document
|
||||
|
||||
### For the AI Agent
|
||||
|
||||
When the agent is asked to implement a feature, modify architecture, or solve a bug, it MUST:
|
||||
|
||||
1. **Identify affected stakeholders** from the list above
|
||||
2. **Consider the least-technical user** in each affected cohort
|
||||
3. **Check the decision matrix** for impact severity
|
||||
4. **Apply the golden rules** to the implementation approach
|
||||
5. **Document stakeholder considerations** in PR descriptions and implementation plans
|
||||
|
||||
### For Human Developers
|
||||
|
||||
When reviewing PRs or proposing features, ask:
|
||||
- "Did we consider how this affects plugin developers?"
|
||||
- "Will a first-time contributor understand this?"
|
||||
- "Does this work on the demo without configuration?"
|
||||
- "Will this survive a Docker restart on the ThinkPad?"
|
||||
|
||||
---
|
||||
|
||||
## Version History
|
||||
|
||||
| Date | Change |
|
||||
|---|---|
|
||||
| 2026-04-05 | Initial stakeholder map created from comprehensive project research |
|
||||
@@ -1,7 +1,8 @@
|
||||
---
|
||||
trigger: glob
|
||||
description: Guidelines on managing the single source of truth across WorldWideView using Zustand, avoiding prop-drilling, and isolating UI rerenders.
|
||||
globs: "src/core/state/**/*, src/components/**/*"
|
||||
paths:
|
||||
- "src/core/state/**/*"
|
||||
- "src/components/**/*"
|
||||
---
|
||||
|
||||
# Zustand State Management
|
||||
|
||||
@@ -1,32 +0,0 @@
|
||||
---
|
||||
trigger: model_decision
|
||||
description: Troubleshooting and debugging guidelines for WorldWideView, covering latency, logging, and namespace collisions.
|
||||
---
|
||||
|
||||
# Troubleshooting and Debugging
|
||||
|
||||
## 1. Plugin Data Latency
|
||||
If there is a noticeable delay (e.g., ~1 second) between enabling a plugin and the initial data arriving on the globe, **do not assume the UI is blocking**.
|
||||
- **WebSocket Handshake**: Initial latency is often caused by the time it takes to establish a new WebSocket connection to the engine's `/stream`.
|
||||
- **Upstream Cooldowns**: Plugins querying external providers (like OpenSky for `aviation`) have strict rate limits. If a snapshot returns a `404`, it might mean the seeder is in a cooldown period or hasn't successfully fetched data yet. This is expected behavior.
|
||||
- **Diagnosis**: Instrument the `DataBusSubscriber` and `WsClient` with timing logs (`performance.now()`) to track exactly where the bottleneck occurs (manifest discovery vs connection establishment vs first payload).
|
||||
|
||||
## 2. Log Verbosity and Structured Logging
|
||||
We employ a **structured logging strategy** in the frontend to reduce noise and improve readability.
|
||||
- **Rule**: Do not add excessive `console.log` statements that dump raw JSON payloads or stream contents directly to the console in core files like `WsClient.ts` or `PluginManager.ts`.
|
||||
- **Implementation**: If detailed logs are needed, use conditional debug levels or summarize the output (e.g., logging payload sizes or entity counts instead of the full object array). This ensures critical diagnostic information remains visible without overflowing the terminal.
|
||||
|
||||
## 3. Namespace Collisions
|
||||
If a plugin fails to load in the Data Engine with a `404` or `Error [ERR_MODULE_NOT_FOUND]` error during startup:
|
||||
- **Root Cause**: The seeder may exist simultaneously in both the `wwv-seeders-community` and `wwv-seeders-private` repositories.
|
||||
- **Resolution**: Seeders must have a unique namespace. Ensure that private plugins (e.g., `aviation`, `maritime`, `military-aviation`) are explicitly removed from the community repository to prevent workspace-level module resolution failures when the V2 engine attempts to load them. Private seeders take priority, but overlapping names will cause dependency conflicts.
|
||||
|
||||
## 4. Agent Execution Environments (Windows/PowerShell)
|
||||
When an AI agent or developer is executing CLI commands via tools in this project on Windows:
|
||||
- **Rule**: NEVER use the `&&` operator to chain commands in PowerShell. It will result in parser errors.
|
||||
- **Resolution**: Use sequential execution, run commands separately, or use PowerShell-safe chaining like `; if ($?) { }`.
|
||||
|
||||
## 5. Next.js vs. Undici Fetch Type Mismatches
|
||||
When implementing SSRF protections (e.g., DNS IP Pinning via custom `Dispatcher`), you will likely use `undici.Agent`.
|
||||
- **Root Cause**: Passing global Next.js `RequestInit` options directly into `undici.fetch` will throw strict TypeScript errors because the `BodyInit` and `RequestCache` signatures differ, and `dns.lookup` returns a generic `number` instead of exactly `4 | 6` for IP families.
|
||||
- **Resolution**: Strip out Next.js specific keys, explicitly cast `body` as `any`, and explicitly type `resolvedFamily: number` when interfacing between Next.js request streams and the `undici` library.
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
name: migrate-legacy-plugin
|
||||
description: Use when moving a WorldWideView plugin from packages/ (or ../worldwideview-plugins/packages/) to local-plugins/, converting legacy plugins to the new Engine & Payload architecture, or when a plugin hardcodes engine URLs, bundles Node.js built-ins, or uses import.meta.url for file paths inside Docker containers
|
||||
description: Use when moving a WorldWideView plugin from packages/ to local-plugins/ (the wwv-plugins community repo clone), converting legacy plugins to the new Engine & Payload architecture, or when a plugin hardcodes engine URLs, bundles Node.js built-ins, or uses import.meta.url for file paths inside Docker containers
|
||||
---
|
||||
|
||||
# Migrate Legacy Plugin to Modern Architecture
|
||||
|
||||
## Overview
|
||||
|
||||
Moves a WorldWideView plugin from the old `packages/` monorepo location (or the external `worldwideview-plugins` repository) into the `local-plugins/` directory (which is itself a publishable Git repository). Simultaneously fixes two **independent** concerns that legacy plugins always have:
|
||||
Moves a WorldWideView plugin from the old `packages/` monorepo location into the `local-plugins/` directory (which is a git clone of `github.com/silvertakana/wwv-plugins` — the canonical community plugin repo). Simultaneously fixes two **independent** concerns that legacy plugins always have:
|
||||
|
||||
1. **Frontend routing** — hardcoded engine URLs must be replaced with `resolveEngineUrl()`
|
||||
2. **Backend seeder build** — ESM bundling and container-aware file paths
|
||||
@@ -16,7 +16,7 @@ Moves a WorldWideView plugin from the old `packages/` monorepo location (or the
|
||||
|
||||
## When to Use
|
||||
|
||||
- Moving a plugin from `packages/wwv-plugin-<name>/` (or `../worldwideview-plugins/packages/wwv-plugin-<name>/`) to `local-plugins/wwv-plugin-<name>/`
|
||||
- Moving a plugin from `packages/wwv-plugin-<name>/` to `local-plugins/wwv-plugin-<name>/`
|
||||
- Plugin's `fetch()` hardcodes a URL like `https://dataengine.worldwideview.dev`
|
||||
- Plugin uses `this.context?.apiBaseUrl` instead of `resolveEngineUrl()`
|
||||
- Backend seeder crashes with `Dynamic require` or `ERR_INVALID_FILE_URL_PATH` in Docker
|
||||
@@ -38,7 +38,7 @@ Moves a WorldWideView plugin from the old `packages/` monorepo location (or the
|
||||
> ```
|
||||
> Example: `node scripts/migrate-plugin.mjs gps-jamming`
|
||||
>
|
||||
> The script will automatically copy the frontend plugin, inject peerDependencies, refactor `index.tsx` routing, fix the backend seeder's build settings and `SEEDERS_DIR` paths, and register the plugin in `defaultPlugins.ts`.
|
||||
> The script will automatically copy the frontend plugin, inject peerDependencies, refactor `index.tsx` routing, and fix the backend seeder's build settings and `SEEDERS_DIR` paths. (Fresh-install seeding no longer involves a hard-coded list — once published to npm with a valid `worldwideview` block, the plugin is registered via the signed verified registry.)
|
||||
> **You still need to run `pnpm install` and verify the builds manually as described below.**
|
||||
|
||||
> [!IMPORTANT]
|
||||
@@ -59,14 +59,13 @@ Copy the plugin from `packages/` (or the external plugins repo) to `local-plugin
|
||||
# From project root (if in local packages/)
|
||||
cp -r packages/wwv-plugin-<name> local-plugins/wwv-plugin-<name>
|
||||
|
||||
# OR from external plugins repository:
|
||||
cp -r ../worldwideview-plugins/packages/wwv-plugin-<name> local-plugins/wwv-plugin-<name>
|
||||
```
|
||||
|
||||
The `local-plugins/` directory is:
|
||||
- Part of the pnpm workspace (`pnpm-workspace.yaml` includes `local-plugins/*`)
|
||||
- Gitignored from the main worldwideview repo (it IS its own Git repo — `worldwideview-plugins`)
|
||||
- Gitignored from the main worldwideview repo — it IS its own git repo (`github.com/silvertakana/wwv-plugins`, the canonical community plugin repo)
|
||||
- Auto-discovered by the `dev:plugins` watcher during `pnpm dev`
|
||||
- Run `cd local-plugins && git pull` before working to fetch the latest community plugins
|
||||
|
||||
## Step 2: Fix Frontend Routing (getEngineUrl)
|
||||
|
||||
@@ -220,7 +219,7 @@ local-seeders/community/packages/gps-jamming/
|
||||
|
||||
After moving to `local-plugins/`, remove the old references:
|
||||
|
||||
- [ ] Delete `packages/wwv-plugin-<name>/` directory (or the source directory in `../worldwideview-plugins/packages/`)
|
||||
- [ ] Delete `packages/wwv-plugin-<name>/` directory
|
||||
- [ ] Remove from `transpilePackages` in `next.config.ts` (if present)
|
||||
- [ ] Remove path alias from `tsconfig.json` `paths` (if present)
|
||||
- [ ] Remove any registration in `AppShell.tsx` (now loaded dynamically)
|
||||
|
||||
@@ -29,20 +29,15 @@ A WorldWideView plugin is a self-contained data source that renders geospatial e
|
||||
|
||||
## Architecture Decision
|
||||
|
||||
```dot
|
||||
digraph plugin_type {
|
||||
rankdir=TB;
|
||||
node [shape=diamond];
|
||||
|
||||
"Does it need live\nexternal API data?" -> "Is polling\nfrequency > 30s?" [label="yes"];
|
||||
"Does it need live\nexternal API data?" -> "Static GeoJSON\n(wwvStaticCompiler)" [label="no"];
|
||||
"Is polling\nfrequency > 30s?" -> "Cron Seeder\n(engine)" [label="yes"];
|
||||
"Is polling\nfrequency > 30s?" -> "Init Seeder\n(engine)" [label="no"];
|
||||
|
||||
"Static GeoJSON\n(wwvStaticCompiler)" [shape=box];
|
||||
"Cron Seeder\n(engine)" [shape=box];
|
||||
"Init Seeder\n(engine)" [shape=box];
|
||||
}
|
||||
```
|
||||
Does it need live external API data?
|
||||
├── NO → Static GeoJSON plugin (wwvStaticCompiler in vite.config.ts)
|
||||
│ No seeder needed. Place data in data/data.json.
|
||||
└── YES → Does it update more often than every 30s?
|
||||
├── NO → Cron Seeder (engine, registerSeeder with cron string)
|
||||
│ getPollingInterval() = 0, mapWebsocketPayload() required
|
||||
└── YES → Init Seeder (engine, registerSeeder with init function)
|
||||
getPollingInterval() = 0, mapWebsocketPayload() required
|
||||
```
|
||||
|
||||
---
|
||||
@@ -146,7 +141,7 @@ export default class WildfiresPlugin implements WorldPlugin {
|
||||
| `getLayerConfig()` | Layer appearance (color, clustering, max entities) |
|
||||
| `renderEntity(entity)` | Per-entity Cesium rendering options |
|
||||
|
||||
**Optional:**
|
||||
**Optional (but `mapWebsocketPayload` is REQUIRED for WS-only plugins with object payloads):**
|
||||
|
||||
| Method | Purpose |
|
||||
|---|---|
|
||||
@@ -158,7 +153,7 @@ export default class WildfiresPlugin implements WorldPlugin {
|
||||
| `getDetailComponent()` | Custom detail panel for selected entity |
|
||||
| `getSettingsComponent()` | Plugin settings UI |
|
||||
| `getGlobeComponent()` | React component injected into globe view |
|
||||
| `mapWebsocketPayload(payload, existing)` | Transform raw WS data into `GeoEntity[]` |
|
||||
| `mapWebsocketPayload(payload, existing)` | **Required if seeder payload is an object** (not a flat array). Transforms raw engine payload → `GeoEntity[]`. Without it, `WsClient` drops object payloads silently. |
|
||||
| `requiresConfiguration(settings)` | Return `true` if plugin needs setup first |
|
||||
|
||||
### 1.3 Package Metadata
|
||||
@@ -518,14 +513,30 @@ export default class IssPlugin implements WorldPlugin {
|
||||
|
||||
destroy(): void {}
|
||||
|
||||
async fetch(timeRange: TimeRange): Promise<GeoEntity[]> {
|
||||
return []; // WS-only plugin
|
||||
async fetch(_timeRange: TimeRange): Promise<GeoEntity[]> {
|
||||
return []; // WS-only — data arrives via mapWebsocketPayload
|
||||
}
|
||||
|
||||
getPollingInterval(): number {
|
||||
return 0; // WS-only
|
||||
}
|
||||
|
||||
// REQUIRED: seeder sends { source, fetchedAt, items: [...], totalCount } (an object).
|
||||
// Without this, WsClient drops the payload silently — the globe stays empty.
|
||||
mapWebsocketPayload(payload: any, _existingEntities: GeoEntity[]): GeoEntity[] {
|
||||
const items: any[] = payload?.items ?? (Array.isArray(payload) ? payload : []);
|
||||
return items.map((item: any): GeoEntity => ({
|
||||
id: `iss-${item.id}`,
|
||||
pluginId: "iss",
|
||||
latitude: item.lat,
|
||||
longitude: item.lon,
|
||||
altitude: item.alt ?? 0,
|
||||
timestamp: new Date(),
|
||||
label: "International Space Station",
|
||||
properties: { speed: item.speed },
|
||||
}));
|
||||
}
|
||||
|
||||
getLayerConfig(): LayerConfig {
|
||||
return {
|
||||
color: "#ffffff",
|
||||
@@ -644,7 +655,9 @@ Categories are **lowercase**: `"aviation"` not `"Aviation"`, `"natural-disaster"
|
||||
- [ ] **Engine:** Seeder file in `wwv-seeders/src/seeders/<name>.ts` (or private repo)
|
||||
- [ ] **Engine:** `registerSeeder({ name })` matches frontend plugin `id`
|
||||
- [ ] **Engine:** Calls `setLiveSnapshot()` with correct plugin ID key
|
||||
- [ ] **Engine:** Data shape is an object with `items` array (or plugin implements `mapWebsocketPayload`)
|
||||
- [ ] **Engine:** Seeder payload is either a flat `GeoEntity[]` array OR plugin implements `mapWebsocketPayload` (any other object is silently dropped by WsClient)
|
||||
- [ ] **Frontend (WS-only):** `getPollingInterval()` returns `0` and `fetch()` returns `[]`
|
||||
- [ ] **Frontend (WS-only):** `mapWebsocketPayload(payload, existingEntities)` implemented if seeder sends an object
|
||||
- [ ] **Engine:** SQLite table created in `db.ts` if historical data needed
|
||||
- [ ] **Verification:** `GET localhost:5000/manifest` includes the plugin ID
|
||||
- [ ] **Verification:** `GET localhost:5000/health` shows seeder last-run timestamp
|
||||
|
||||
@@ -0,0 +1,50 @@
|
||||
node_modules
|
||||
**/node_modules
|
||||
**/dist
|
||||
**/.next
|
||||
.git
|
||||
|
||||
# Database files at ANY depth
|
||||
/data
|
||||
packages/*/data
|
||||
**/*.db
|
||||
**/*.sqlite
|
||||
**/*.sqlite3
|
||||
**/*-journal
|
||||
**/*.db-wal
|
||||
**/*.db-shm
|
||||
|
||||
# ============================================================
|
||||
# UNIGNORE FOR AI AGENT (FILTERED PATHS ONLY)
|
||||
# ============================================================
|
||||
|
||||
# Code Frameworks, Configurations & Typings
|
||||
!/out/
|
||||
!*.tsbuildinfo
|
||||
!next-env.d.ts
|
||||
!/build
|
||||
!*.code-workspace
|
||||
|
||||
# Generated Codebase Assets & Database Schemas (e.g., Prisma Client)
|
||||
!/src/generated/
|
||||
|
||||
# Permanent Local Automation and Scripts Shared in Project
|
||||
!/local-scripts/
|
||||
!/public/plugins-local/
|
||||
|
||||
# Local Structural Repositories & Workspaces
|
||||
!local-plugins/*
|
||||
!/worldmonitor/
|
||||
!local-seeders/*
|
||||
|
||||
# Complete Ecosystem Repositories (Allows Agent to Cross-Reference Layouts)
|
||||
!/packages/wwv-data-engine/
|
||||
!/worldwideview-marketplace/
|
||||
!/worldwideview-plugins/
|
||||
!/worldwideview-web/
|
||||
!/wwv-data-engine/
|
||||
!/wwv-data-engine-public/
|
||||
!/wwv-seeders/
|
||||
!/wwv-seeders-private/
|
||||
!/wwv-test/
|
||||
!worldwideview.code-workspace
|
||||
@@ -4,5 +4,11 @@ install_deps = "pnpm install"
|
||||
[[pre-start]]
|
||||
copy_env = """powershell -Command "if (Test-Path '../worldwideview/.env') { Copy-Item '../worldwideview/.env' '.env' -Force }""""
|
||||
|
||||
[[pre-start]]
|
||||
copy_local_plugins = """powershell -Command "if (Test-Path '../worldwideview/local-plugins') { robocopy '../worldwideview/local-plugins' 'local-plugins' /E /XD node_modules dist .next coverage /XF '*.log' /NFL /NDL /NJH /NJS | Out-Null }""""
|
||||
|
||||
[[pre-start]]
|
||||
copy_local_seeders = """powershell -Command "if (Test-Path '../worldwideview/local-seeders') { robocopy '../worldwideview/local-seeders' 'local-seeders' /E /XD .pnpm-store node_modules /NFL /NDL /NJH /NJS | Out-Null }""""
|
||||
|
||||
[[pre-remove]]
|
||||
docker_clean = "docker compose down -v"
|
||||
@@ -19,6 +19,12 @@ DATABASE_URL=postgresql://postgres:postgres@localhost:5432/worldwideview
|
||||
# at the project root so docker-compose can inject it.
|
||||
AUTH_SECRET=
|
||||
|
||||
# Encryption Master Key (REQUIRED — generate with: openssl rand -hex 16)
|
||||
# Must be exactly 32 characters. Used to derive the AES-256-GCM key for credentials at rest.
|
||||
# PRE-DEPLOY GATE: verify this is set in Coolify for every environment before merging C1 changes.
|
||||
# If unset the server will refuse to start (enforced in src/instrumentation.ts).
|
||||
ENCRYPTION_MASTER_KEY=
|
||||
|
||||
# Cesium Ion Access Token (optional — get one free at https://ion.cesium.com/)
|
||||
NEXT_PUBLIC_CESIUM_ION_TOKEN=
|
||||
|
||||
@@ -48,6 +54,25 @@ ACLED_PASSWORD=
|
||||
# Generate any random string, then set the same value in the marketplace instance config.
|
||||
WWV_BRIDGE_TOKEN=
|
||||
|
||||
# Marketplace URL — used by ticketClient.ts for token exchange (server-side only)
|
||||
# Falls back to NEXT_PUBLIC_WWV_MARKETPLACE_URL then https://app.worldwideview.dev
|
||||
MARKETPLACE_URL=
|
||||
|
||||
# Marketplace URL — used for PKCE connect/callback and client-side links
|
||||
NEXT_PUBLIC_WWV_MARKETPLACE_URL=
|
||||
|
||||
# Plugin Ticket Auth — comma-separated plugin IDs that require WS first-message auth (ADR-001).
|
||||
# Empty (default) = ticket auth dormant for all plugins. Set AFTER Marketplace + Data Engine deploy.
|
||||
# Example: NEXT_PUBLIC_WWV_TICKET_AUTH_PLUGINS=aviation,maritime
|
||||
NEXT_PUBLIC_WWV_TICKET_AUTH_PLUGINS=
|
||||
|
||||
# SSRF Proxy Host Allowlist (REQUIRED in production)
|
||||
# "*" = permissive (logs WARN per request — use to observe traffic for one week, then tighten).
|
||||
# "" = deny all (safe default when not set).
|
||||
# Comma-separated list = only those hostnames allowed (e.g. "192.168.1.100,camera.example.com").
|
||||
# Ship with "*" in Coolify; replace with concrete list after one week of log observation.
|
||||
PROXY_HOST_ALLOWLIST=*
|
||||
|
||||
# Default plugins enabled on boot for demo edition
|
||||
# Comma-separated list of plugin IDs
|
||||
NEXT_PUBLIC_DEMO_DEFAULT_PLUGINS=
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# Garbage Collector — Daily Sweep Prompt
|
||||
|
||||
You are the WorldWideView Garbage Collector agent running headless in GitHub Actions.
|
||||
|
||||
Run the garbage-collector agent sweep:
|
||||
|
||||
1. Read `.agents/rules/garbage-collection.md` for your charter and all guard rails.
|
||||
2. Read `gc-findings.json` for the pre-scanned findings produced by `scripts/gc-scan.mjs`.
|
||||
3. Check the `DRY_RUN` environment variable — if `true`, post a dry-run summary only (no PRs or Issues).
|
||||
4. Execute the full sweep procedure described in `.agents/agents/garbage-collector.md`.
|
||||
|
||||
Do not scan the codebase yourself. Work only from `gc-findings.json`.
|
||||
@@ -0,0 +1,116 @@
|
||||
name: Garbage Collector
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: '0 6 * * *' # 06:00 UTC daily
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
dry_run:
|
||||
description: 'Dry run — report findings only, open no PRs or Issues (recommended for first 3–5 days)'
|
||||
required: false
|
||||
default: 'true'
|
||||
type: choice
|
||||
options: ['true', 'false']
|
||||
days_branch:
|
||||
description: 'Days before a branch is considered stale'
|
||||
required: false
|
||||
default: '90'
|
||||
days_comment:
|
||||
description: 'Days before a TODO/FIXME comment is flagged'
|
||||
required: false
|
||||
default: '180'
|
||||
|
||||
concurrency:
|
||||
group: garbage-collector
|
||||
cancel-in-progress: true
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
issues: write
|
||||
id-token: write
|
||||
|
||||
jobs:
|
||||
collect:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 15
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GC_BOT_TOKEN }}
|
||||
DRY_RUN: ${{ github.event.inputs.dry_run || 'false' }}
|
||||
DAYS_BRANCH: ${{ github.event.inputs.days_branch || '90' }}
|
||||
DAYS_COMMENT: ${{ github.event.inputs.days_comment || '180' }}
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0 # full history required for git blame and branch age
|
||||
token: ${{ secrets.GC_BOT_TOKEN }} # PAT so pushed branches trigger CI
|
||||
|
||||
- name: Configure git user
|
||||
run: |
|
||||
git config user.name 'WorldWideView GC Bot'
|
||||
git config user.email '[email protected]'
|
||||
|
||||
- name: Setup pnpm
|
||||
uses: pnpm/action-setup@v4
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '22'
|
||||
cache: 'pnpm'
|
||||
|
||||
- name: Install dependencies
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Run deterministic scan
|
||||
run: |
|
||||
node scripts/gc-scan.mjs \
|
||||
--out gc-findings.json \
|
||||
--days-branch=${{ env.DAYS_BRANCH }} \
|
||||
--days-comment=${{ env.DAYS_COMMENT }}
|
||||
|
||||
- name: Upload findings artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: gc-findings-${{ github.run_id }}
|
||||
path: gc-findings.json
|
||||
retention-days: 30
|
||||
|
||||
- name: Run Garbage Collector agent
|
||||
uses: anthropics/claude-code-action@v1
|
||||
with:
|
||||
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
||||
show_full_output: true
|
||||
prompt: |
|
||||
You are the WorldWideView Garbage Collector agent running headless in GitHub Actions.
|
||||
|
||||
Read `.agents/rules/garbage-collection.md` for your charter and all guard rails.
|
||||
Read `gc-findings.json` for the pre-scanned findings produced by `scripts/gc-scan.mjs`.
|
||||
|
||||
The DRY_RUN environment variable is: ${{ env.DRY_RUN }}
|
||||
|
||||
## If DRY_RUN is "true":
|
||||
Do NOT create any PRs or Issues.
|
||||
Instead, find or create the tracking Issue titled "[gc-bot] Daily Scan Reports" (label: gc-bot) in
|
||||
the silvertakana/worldwideview repository using the gh CLI:
|
||||
|
||||
# Find existing tracking issue
|
||||
gh issue list --repo silvertakana/worldwideview --label gc-bot --search "[gc-bot] Daily Scan Reports" --json number,title
|
||||
|
||||
# If it exists, add a comment:
|
||||
gh issue comment <number> --repo silvertakana/worldwideview --body "..."
|
||||
|
||||
# If it doesn't exist, create it:
|
||||
gh issue create --repo silvertakana/worldwideview --title "[gc-bot] Daily Scan Reports" --label gc-bot --body "..."
|
||||
|
||||
The comment body must list every finding with: tier, file, line, description.
|
||||
Include the run ID (${{ github.run_id }}) and timestamp at the top.
|
||||
|
||||
## If DRY_RUN is "false":
|
||||
Execute the full sweep procedure described in `.claude/agents/garbage-collector.md`.
|
||||
Create Tier A draft PRs and Tier B Issues per the guard rails in `.agents/rules/garbage-collection.md`.
|
||||
|
||||
Do not scan the codebase yourself. Work only from gc-findings.json.
|
||||
claude_args: '--model claude-haiku-4-5-20251001 --allowedTools Bash,Read,Edit,Write,Grep,Glob'
|
||||
@@ -41,6 +41,11 @@ jobs:
|
||||
pnpm run predev
|
||||
|
||||
- name: Run Playwright tests
|
||||
env:
|
||||
# Prevent Firefox from loading the AT-SPI/MSAA accessibility bridge on
|
||||
# Linux CI — without this, Firefox hangs for ~20 min waiting for a bus
|
||||
# that doesn't exist on ubuntu-latest runners.
|
||||
NO_AT_BRIDGE: ${{ matrix.browser == 'firefox' && '1' || '0' }}
|
||||
run: pnpm test:e2e --project=${{ matrix.browser }}
|
||||
|
||||
- uses: actions/upload-artifact@v4
|
||||
|
||||
@@ -13,6 +13,7 @@ jobs:
|
||||
env:
|
||||
NEXT_PUBLIC_WWV_EDITION: local
|
||||
AUTH_SECRET: ci-placeholder-secret-not-used-in-tests
|
||||
ENCRYPTION_MASTER_KEY: ci-placeholder-key-not-used-in-tests
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
|
||||
@@ -31,7 +32,10 @@ jobs:
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Setup environment
|
||||
run: cp .env.example .env
|
||||
run: |
|
||||
cp .env.example .env
|
||||
sed -i 's/^ENCRYPTION_MASTER_KEY=.*/ENCRYPTION_MASTER_KEY=ci-placeholder-key-not-used-in-tests/' .env
|
||||
sed -i 's/^AUTH_SECRET=.*/AUTH_SECRET=ci-placeholder-secret-not-used-in-tests/' .env
|
||||
|
||||
- name: Test predev setup
|
||||
# Tests that Docker DB boots, port mappings work, Prisma pushes schema, and plugins sync
|
||||
|
||||
+8
-6
@@ -19,12 +19,9 @@ node_modules/
|
||||
|
||||
# agents
|
||||
/.agents/plans
|
||||
/.agents/context
|
||||
/.agents/research/
|
||||
|
||||
# claude code IDE config
|
||||
/.claude/
|
||||
/.cline/
|
||||
/.agents/context/
|
||||
/.agents/settings.local.json
|
||||
|
||||
# performance
|
||||
/performance/
|
||||
@@ -32,6 +29,9 @@ node_modules/
|
||||
# artifacts
|
||||
/artifacts/
|
||||
|
||||
# gc bot — generated scan output, never commit
|
||||
gc-findings.json
|
||||
|
||||
# scripts (tracked, but temporary scratchpads should go in /local-scripts/)
|
||||
|
||||
|
||||
@@ -64,7 +64,8 @@ yarn-error.log*
|
||||
.pnpm-debug.log*
|
||||
|
||||
# env files (can opt-in for committing if needed)
|
||||
.env*
|
||||
.env
|
||||
.env.local
|
||||
|
||||
# vercel
|
||||
.vercel
|
||||
@@ -96,6 +97,7 @@ packages/wwv-data-engine/
|
||||
|
||||
# IDE workspace files
|
||||
*.code-workspace
|
||||
*.vscode
|
||||
|
||||
# Build outputs and generated assets
|
||||
/public/cesium/
|
||||
|
||||
@@ -2,11 +2,8 @@
|
||||
|
||||
## 1. Project Identity
|
||||
|
||||
WorldWideView is a **real-time geospatial intelligence engine** that visualizes live global data on an interactive 3D globe. Built with **Next.js 16**, **CesiumJS**, **React 19**, and **Zustand**, it renders everything from live aircraft and maritime vessels to conflict events, satellites, and environmental data — all through a modular plugin architecture.
|
||||
WorldWideView is a **real-time geospatial intelligence engine** visualizing live global data on an interactive 3D globe. Built with **Next.js 16**, **CesiumJS**, **React 19**, and **Zustand**. Design/feature target: `www.worldmonitor.app` ([reference repo](https://github.com/koala73/worldmonitor)).
|
||||
|
||||
### Target Inspiration
|
||||
Our primary design, feature-set, and operational layout goal is to mimic the structure and capabilities of `www.worldmonitor.app`.
|
||||
- **Reference Codebase**: [GitHub - koala73/worldmonitor](https://github.com/koala73/worldmonitor)
|
||||
---
|
||||
|
||||
## 2. Tech Stack
|
||||
@@ -16,489 +13,152 @@ Our primary design, feature-set, and operational layout goal is to mimic the str
|
||||
| Framework | Next.js 16 (App Router, `output: "standalone"`) |
|
||||
| Language | TypeScript 5, strict mode |
|
||||
| 3D Engine | CesiumJS + Resium (Google Photorealistic 3D Tiles) |
|
||||
| State | Zustand (slice-based: globe, layers, timeline, UI, filters, data, config, favorites, geojson) |
|
||||
| State | Zustand (9 slices: globe, layers, timeline, ui, filter, data, config, favorites, geojson) |
|
||||
| Event Bus | Custom typed `DataBus` (pub/sub singleton) |
|
||||
| Styling | Vanilla CSS — **no Tailwind** |
|
||||
| Database | PostgreSQL via Prisma 7 (local and cloud) |
|
||||
| Database | PostgreSQL via Prisma 7 |
|
||||
| Auth | NextAuth v5 beta (Credentials provider, JWT sessions) |
|
||||
| Package Manager | pnpm (monorepo with `pnpm-workspace.yaml`) |
|
||||
| Testing | Vitest + jsdom + React Testing Library |
|
||||
| Deployment | Docker multi-stage build → Coolify |
|
||||
| Analytics | Vercel Analytics / custom `trackEvent` |
|
||||
|
||||
---
|
||||
|
||||
## 3. Directory Structure
|
||||
## 3. Critical Invariants
|
||||
|
||||
> [!NOTE]
|
||||
> See `.agents/rules/directory-structure.md` for the full project directory map and related repositories.
|
||||
|
||||
---
|
||||
|
||||
## 4. Architecture Patterns
|
||||
|
||||
> [!NOTE]
|
||||
> See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) for the human-facing architecture deep-dive — plugin system, state management, data pipeline, data engine & seeders, rendering pipeline, and edition system.
|
||||
|
||||
Key invariants agents MUST respect:
|
||||
Agents MUST respect these at all times:
|
||||
|
||||
- **Plugin source of truth**: `@worldwideview/wwv-plugin-sdk` — never define plugin types locally.
|
||||
- **All-Bundle Model**: every plugin (seeder, CDN-loaded, static-compiled, active-proxied) is dynamically imported via `loadPluginFromManifest` using `import(/* webpackIgnore: true */ entry)`. Legacy `StaticDataPlugin` / `DeclarativePlugin` runtimes are deprecated.
|
||||
- **Agnostic frontend**: the renderer has no concept of a "unified" data engine. Each plugin **MUST declare its own `streamUrl`** in its manifest or config; do not assume one shared pipe.
|
||||
- **Nine Zustand slices** under `src/core/state/`: `globe`, `layers`, `timeline`, `ui`, `filter`, `data`, `config`, `favorites`, `geojson`. Access via `useStore` in React, `useStore.getState()` elsewhere.
|
||||
- **Primitive-based rendering** (not Cesium Entity API). Point/Billboard/Label/Polyline collections only. Never mix `size`/`outlineWidth`/`outlineColor` onto billboard entities — GPU silently clips.
|
||||
- **Three editions** controlled by `NEXT_PUBLIC_WWV_EDITION` (`local` / `cloud` / `demo`); feature flags derived in `src/core/edition.ts`.
|
||||
- **All-Bundle Model**: every plugin is dynamically imported via `loadPluginFromManifest` using `import(/* webpackIgnore: true */ entry)`. Legacy `StaticDataPlugin` / `DeclarativePlugin` runtimes are deprecated.
|
||||
- **Agnostic frontend**: each plugin **MUST declare its own `streamUrl`**; do not assume one shared pipe.
|
||||
- **Nine Zustand slices** under `src/core/state/`: access via `useStore` in React, `useStore.getState()` elsewhere.
|
||||
- **Primitive-based rendering**: Point/Billboard/Label/Polyline collections only. Never mix `size`/`outlineWidth`/`outlineColor` onto billboard entities — GPU silently clips.
|
||||
- **Three editions** via `NEXT_PUBLIC_WWV_EDITION` (`local` / `cloud` / `demo`); feature flags in `src/core/edition.ts`.
|
||||
- **Nested git clones**: `local-plugins/` (community plugins) and `local-seeders/community/` + `local-seeders/private/` (seeders) are **independent git repos cloned inside this repo, gitignored from it**. Each has its own remote. Run `git pull` inside each before editing; commits/pushes there go to their own upstream — not to `worldwideview`. See `.agents/context/ecosystem-repositories.md`.
|
||||
|
||||
---
|
||||
|
||||
## 5. Critical Conventions
|
||||
## 4. Conventions
|
||||
|
||||
### 5.1 File Size
|
||||
- **File size**: ~300 lines max. Extract helpers, split components, use hooks.
|
||||
- **Import aliases**: `@/*` → `./src/*`; `@worldwideview/wwv-plugin-sdk` → `./packages/wwv-plugin-sdk/src`
|
||||
- **CSS**: Vanilla CSS only. Global: `src/app/globals.css`. Scoped: CSS Modules. HUD: `src/styles/hud-animations.css`.
|
||||
- **Rendering entities**: Points use `type: "point"` + `size`/`outlineColor`/`outlineWidth`. Billboards use `type: "billboard"` + `iconUrl`/`iconScale`. NEVER mix.
|
||||
- **Plugin registration**: Built-ins via `AppShell.tsx` → `PluginRegistry` → `PluginManager`. Marketplace plugins via `InstalledPluginsLoader`.
|
||||
- **Workspace**: Use `"workspace:*"` (not `"*"`) for internal deps. New `packages/` plugins need `transpilePackages` in `next.config.ts`.
|
||||
- **Temp files**: Save debugging scripts/outputs exclusively in `/local-scripts/` — never in root.
|
||||
- **Cleanliness**: Remove dead code, unused imports, debug `console.log` before finalising. Never use `any` or `@ts-ignore`. Never create `.mdc` files.
|
||||
|
||||
**Guideline: ~300 lines per file.** If a file grows excessively large, consider modularizing it. Extract helpers, split components, or use hooks.
|
||||
---
|
||||
|
||||
### 5.2 Import Aliases
|
||||
|
||||
- `@/*` → `./src/*`
|
||||
- `@worldwideview/wwv-plugin-sdk` → `./packages/wwv-plugin-sdk/src`
|
||||
- Plugin modules are dynamically imported and do not require individual `tsconfig.json` aliases
|
||||
|
||||
### 5.3 CSS Rules
|
||||
|
||||
- **Vanilla CSS only** — no Tailwind, no CSS-in-JS
|
||||
- Global styles in `src/app/globals.css`
|
||||
- Component-scoped styles use CSS Modules (`.module.css`) or co-located `.css` files
|
||||
- HUD animations in `src/styles/hud-animations.css`
|
||||
|
||||
### 5.4 Rendering Entity Rules
|
||||
|
||||
When returning `CesiumEntityOptions` from `renderEntity()`:
|
||||
|
||||
- **Points**: Use `type: "point"` with `color`, `size`, `outlineColor`, `outlineWidth`
|
||||
- **Billboards**: Use `type: "billboard"` with `iconUrl`, `color`, `iconScale`
|
||||
- **NEVER mix**: Do not use `size`/`outlineWidth`/`outlineColor` on billboard entities — causes GPU clipping
|
||||
|
||||
### 5.5 Plugin Registration
|
||||
|
||||
Built-in plugins are instantiated in `AppShell.tsx` and registered via `PluginRegistry` → `PluginManager`. Marketplace-installed plugins are loaded from the database via `InstalledPluginsLoader`.
|
||||
|
||||
### 5.6 Workspace Rules
|
||||
|
||||
- Always run `pnpm install` from project root after creating new packages or linking local plugins
|
||||
- Official plugin packages go in `packages/wwv-plugin-<name>/`
|
||||
- Experimental/local plugin sandboxes go in `local-plugins/wwv-plugin-<name>/`
|
||||
- Globs for `packages/*`, `packages/*/backend`, and `local-plugins/*` are mapped in `pnpm-workspace.yaml` and `tsconfig.json` paths
|
||||
- Add new `packages/` plugins to `transpilePackages` in `next.config.ts` if required
|
||||
|
||||
### 5.7 AI Meta-Directives: Antigravity Standard
|
||||
|
||||
> [!NOTE]
|
||||
> This repository is orchestrated via the **Antigravity open standard**. The entry point for the agent framework is `CLAUDE.md` / `AGENTS.md` at the project root.
|
||||
## 5. AI Meta-Directives
|
||||
|
||||
> [!WARNING]
|
||||
> - **Always** use standard `.md` file extensions for rules, skills, and workflows.
|
||||
> - **Never** use proprietary `.mdc` extensions.
|
||||
> - **Never** reference Cursor IDE rules; we use the open `.agents/` standard.
|
||||
> - **MUST**: You MUST update Semantic Versioning numbering inside the relevant `package.json` file prior to executing any code commits, adhering strictly to the `[/commit]` workflow rules (`feat:` -> Minor, `fix/refactor/perf:` -> Patch).
|
||||
> - **MUST Detail Commit Levels & Bumps**: On description changes or release notes, you must detail the level of commit (Major/Minor/Fix) for *each* individual change. If there are multiple accumulated changes, you MUST EITHER commit them individually and bump the version each time, OR commit them all at once and bump the version multiple times.
|
||||
> - **MUST Explain Complex Concepts Simply**: Whenever providing a complicated technical explanation to the user, you MUST include a simple explanation below it. Use an analogy with reference to the correct terminology, comparing the concept to something from everyday life to ensure the user easily understands it.
|
||||
> - **MUST Be Transparent & Narrate Actions (Gemini 3.1 Agents)**: If you are a Gemini 3.1 agent, you MUST always be fully transparent. **Whenever you do anything, you must explicitly say what you are going to do in a visible chat message to the user, and ONLY THEN do it.** This ensures the user can actually see and verify what you are doing in real time. Do not jump to destructive actions without stating your intent first. Keep this narration conversational and natural. Avoid stiff, robotic templates. Just explicitly drop a brief, casual note about what you are checking, fixing, or deleting *before* you run the tool.
|
||||
> - **MUST Require Explicit Authorization**: Do NOT execute any state-changing tools (e.g., modifying files, writing code, running scripts, executing git commands) without first obtaining clear, explicit permission from the user to proceed with that specific action, **UNLESS** the action is a simple, straightforward, and safe operation (e.g., no deletion or dangerous operations). For safe operations, you may proceed without explicit permission. Otherwise, inform the user of your proposed plan and WAIT for their approval before acting. **Crucially, if you realize you have violated this rule by taking an unauthorized action, DO NOT automatically revert it. Reverting is itself an action that requires authorization. Just answer the question.**
|
||||
> - **MUST Ask Clarifying Questions**: Never assume anything. If requirements are unclear, if you encounter an unexpected roadblock, or if the user's intent could be interpreted in multiple ways, you MUST pause and ask clarifying questions. Do NOT proceed until the developer has explicitly answered your question or requested you to proceed anyway.
|
||||
|
||||
### 5.8 Workspace Hygiene
|
||||
Whenever agents generate temporary debugging scripts, test REST endpoints via `.mjs`, or dump traces/JSON outputs, they **MUST** save these exclusively inside `/local-scripts/`. The root directory is strictly for production configuration files.
|
||||
|
||||
### 5.9 Rule Adherence & Proactive Updates
|
||||
> [!CAUTION]
|
||||
> **Agents will trust the `.agents/rules/` files unconditionally.**
|
||||
> Whenever you execute a major architectural shift or make a change that invalidates an existing rule, you **MUST** immediately update the corresponding rule file(s) and/or `AGENTS.md` to reflect the new reality. Do not leave rules untouched after a change; operating on outdated information will cause future agents to break the codebase.
|
||||
> - Always use `.md` extensions. Never `.mdc`. Never reference Cursor IDE rules.
|
||||
> - **MUST** bump semver in `package.json` before every commit via `/commit` workflow (`feat:` → Minor, `fix/refactor/perf:` → Patch).
|
||||
> - **MUST** explain complex concepts simply — include an everyday-life analogy.
|
||||
> - **MUST** require explicit user authorization before any state-changing action that isn't simple/safe.
|
||||
> - **MUST** ask clarifying questions rather than assume when requirements are unclear.
|
||||
> - **MUST** update `.agents/rules/` files immediately whenever an architectural shift invalidates them.
|
||||
|
||||
---
|
||||
|
||||
## 6. Environment & Configuration
|
||||
|
||||
> [!NOTE]
|
||||
> See `.agents/rules/environment-config.md` for required environment variables and secrets.
|
||||
See `.agents/context/environment-config.md` for required environment variables and secrets.
|
||||
|
||||
---
|
||||
|
||||
## 7. Development, Deployment & Testing
|
||||
## 7. Development & Deployment
|
||||
|
||||
> [!NOTE]
|
||||
> See `.agents/rules/deployment-and-testing.md` for development commands, Docker architecture, Vitest strategy, and CSP security headers.
|
||||
```bash
|
||||
pnpm dev # Frontend only (auto-runs prisma db push + copy-cesium)
|
||||
pnpm dev:all # Frontend + data engine via Docker Compose
|
||||
pnpm build # Production build
|
||||
pnpm test # Vitest
|
||||
pnpm db:reset # Wipe + re-migrate DB (destructive)
|
||||
```
|
||||
|
||||
See `.agents/context/` → [deployment and testing details in `.agents/rules/deployment-and-testing.md`] for Docker architecture, Coolify rules, and CSP headers.
|
||||
|
||||
---
|
||||
|
||||
## 12. On-Demand Rules
|
||||
## 8. On-Demand Rules (path-scoped, auto-load on file access)
|
||||
|
||||
Read the relevant rule file when working in that domain:
|
||||
These load automatically when you read/edit files matching their paths:
|
||||
|
||||
| Rule | When to use | Path |
|
||||
|---|---|---|
|
||||
| `platform-architecture` | High-level platform goals, product vision, business model, and Edition System | `.agents/rules/platform-architecture.md` |
|
||||
| `application-architecture` | Next.js frontend, Zustand state management, and CesiumJS integration | `.agents/rules/application-architecture.md` |
|
||||
| `plugin-architecture` | Creating/modifying plugins, lifecycle, capability declarations, and seeders (See ADR-0001) | `.agents/rules/plugin-architecture.md` |
|
||||
| `marketplace-architecture` | Dynamic plugin installation, DB sync, CDN loading, and PKCE Auth (See ADR-0001) | `.agents/rules/marketplace-architecture.md` |
|
||||
| `cloud-auth-architecture` | Cloud edition, PostgreSQL RLS, multi-tenancy, and licensing | `.agents/rules/cloud-auth-architecture.md` |
|
||||
| `server-management` | Server development and debugging using SSH and Coolify MCP | `.agents/rules/server-management.md` |
|
||||
| `stakeholders-and-human-centered-design` | Human-centered design principles and stakeholder map | `.agents/rules/stakeholders-and-human-centered-design.md` |
|
||||
| `directory-structure` | Project structure and related repositories | `.agents/rules/directory-structure.md` |
|
||||
| `ecosystem-repositories` | WorldWideView ecosystem repositories and cross-repository workflows | `.agents/rules/ecosystem-repositories.md` |
|
||||
| `deployment-and-testing` | Docker build patterns, testing strategies, security headers | `.agents/rules/deployment-and-testing.md` |
|
||||
| `environment-config` | Secrets and environment variables | `.agents/rules/environment-config.md` |
|
||||
| `monorepo-workflow` | pnpm commands, adding packages, workspace config | `.agents/rules/monorepo-workflow.md` |
|
||||
| `data-engine-architecture` | Data Engine backend seeder loading, pnpm workspace dependencies | `.agents/rules/data-engine-architecture.md` |
|
||||
| `cesium-rendering` | Globe rendering, entity types, primitives, LOD, culling | `.agents/rules/cesium-rendering.md` |
|
||||
| `state-management` | Zustand slices, store access, plugin settings | `.agents/rules/state-management.md` |
|
||||
| `database-migrations` | Prisma schema changes, migrations, PostgreSQL | `.agents/rules/database-migrations.md` |
|
||||
| `continuous-improvement` | When to create/update rules, skills, or workflows | `.agents/rules/continuous-improvement.md` |
|
||||
| `context-and-memory` | How to orient and maintain project context between sessions | `.agents/rules/context-and-memory.md` |
|
||||
| `troubleshooting-and-debugging` | Resolving plugin latency, namespace collisions, or deployment issues | `.agents/rules/troubleshooting-and-debugging.md` |
|
||||
| `e2e-testing` | Guidelines and architecture for the Playwright End-to-End (E2E) testing infrastructure | `.agents/rules/e2e-testing.md` |
|
||||
| Rule | Triggers on |
|
||||
|---|---|
|
||||
| `.agents/rules/cesium-rendering.md` | `src/core/globe/**`, `src/plugins/**`, `packages/wwv-plugin-*/src/**` |
|
||||
| `.agents/rules/state-management.md` | `src/core/state/**`, `src/components/**` |
|
||||
| `.agents/rules/plugin-architecture.md` | `src/core/plugins/**`, `packages/wwv-plugin-*/src/**`, `local-plugins/**` |
|
||||
| `.agents/rules/marketplace-architecture.md` | `src/lib/marketplace/**`, `src/app/api/marketplace/**` |
|
||||
| `.agents/rules/cloud-auth-architecture.md` | `src/lib/auth*`, `src/app/api/auth/**`, `src/core/auth.ts` |
|
||||
| `.agents/rules/database-migrations.md` | `prisma/**` |
|
||||
| `.agents/rules/monorepo-workflow.md` | `packages/**`, `pnpm-workspace.yaml`, `local-plugins/**` |
|
||||
| `.agents/rules/data-engine-architecture.md` | `packages/**`, `local-seeders/**`, `docker-compose.yml` |
|
||||
| `.agents/rules/deployment-and-testing.md` | `Dockerfile`, `docker-compose.yml`, `.github/**`, `next.config.ts` |
|
||||
| `.agents/rules/e2e-testing.md` | `tests/**`, `public/e2e-fixtures/**`, `playwright.config.ts` |
|
||||
|
||||
---
|
||||
|
||||
## 13. Slash Commands / Workflows
|
||||
## 9. On-Demand Context (read explicitly when needed)
|
||||
|
||||
Invoke by name. Read the skill/workflow file and follow its steps.
|
||||
See `.agents/context/INDEX.md` for the full navigation table. Key files:
|
||||
|
||||
| When to read | File |
|
||||
|---|---|
|
||||
| Product vision, business model, Edition system | `.agents/context/platform-architecture.md` |
|
||||
| Finding files, repo layout | `.agents/context/directory-structure.md` |
|
||||
| Routing fix to correct repository | `.agents/context/ecosystem-repositories.md` |
|
||||
| Next.js, data pipeline, Redis, DB schema | `.agents/context/application-architecture.md` |
|
||||
| Debugging plugin data, namespace collisions | `.agents/context/troubleshooting-and-debugging.md` |
|
||||
| SSH, Coolify MCP | `.agents/context/server-management.md` |
|
||||
| Coding principles, Definition of Done | `.agents/context/coding-principles.md` |
|
||||
| `.env` variables and secrets | `.agents/context/environment-config.md` |
|
||||
|
||||
---
|
||||
|
||||
## 10. Slash Commands
|
||||
|
||||
| Command | Description | File |
|
||||
|---|---|---|
|
||||
| `/commit` | **Required before every commit** — bump semver + conventional commit | `.agents/skills/commit/SKILL.md` |
|
||||
| `/remember` | Save a lesson, constraint, or fact into `.agents/` permanent memory | `.agents/skills/remember/SKILL.md` |
|
||||
| `/remember` | Save a lesson or fact into permanent memory | `.agents/skills/remember/SKILL.md` |
|
||||
| `/pr-review` | 6-role comprehensive pull request review | `.agents/skills/pr-review/SKILL.md` |
|
||||
| `/update-context` | Sync `.agents/context/` with current project state | Global skill |
|
||||
| `/local-dev` | Check, start, and troubleshoot local dev environment | `.agents/workflows/local-dev.md` |
|
||||
| `/local-dev` | Check, start, troubleshoot local dev environment | `.agents/workflows/local-dev.md` |
|
||||
| `/data-engine-cli` | Use the wwv-data-engine CLI wrapper | `.agents/workflows/data-engine-cli.md` |
|
||||
| `/debugging-coolify` | Troubleshoot deployed apps on Coolify via MCP/SSH | `.agents/workflows/debugging-coolify.md` |
|
||||
| `/five` | Five Whys root cause analysis | `.agents/workflows/five.md` |
|
||||
| `/stitch-to-nextjs` | Generate UI with Stitch MCP, port into Next.js | `.agents/workflows/stitch-to-nextjs.md` |
|
||||
| `/bing-news-hydration` | Hydrate event attributes with Bing RSS news | `.agents/workflows/bing-news-hydration.md` |
|
||||
| `/generate-user-roadmap` | Generate updated user-facing roadmap | `.agents/workflows/generate-user-roadmap.md` |
|
||||
|
||||
---
|
||||
|
||||
## 14. Agent Skills Reference
|
||||
|
||||
Refer to these skill documents for specialized tasks:
|
||||
|
||||
### Project Skills (`.agents/skills/`)
|
||||
## 11. Agent Skills Reference
|
||||
|
||||
| Skill | When to Use |
|
||||
|---|---|
|
||||
| `worldwideview-plugin-creation` | **Use when creating any plugin** — strict architectural checklist |
|
||||
| `plugin-creation-master-guide.md` | Decision matrix for choosing plugin architecture |
|
||||
| `osm-static-plugin-creation.md` | Creating static GeoJSON plugins from OpenStreetMap |
|
||||
| `microservice-plugin-creation.md` | Legacy guide for standalone Fastify microservices |
|
||||
| `database-operations.md` | Prisma schema changes, migrations, database queries |
|
||||
| `database-incident-recovery-procedures.md` | Authoritative protocol for safely restoring a broken production database |
|
||||
| `index-documentation.md` | Maintaining project documentation index |
|
||||
| `context7` | Fetch up-to-date library docs via Context7 API |
|
||||
| `cesium-context7` | CesiumJS-specific documentation lookup |
|
||||
| `database-incident-recovery-procedures.md` | Safely restoring a broken production database |
|
||||
|
||||
### Global Skills
|
||||
|
||||
52 skills are available across all projects. See `.agents/global-skills-index.md` for the full list and invocation paths.
|
||||
52 global skills available. See `.agents/global-skills-index.md`.
|
||||
|
||||
---
|
||||
|
||||
## 15. Pull Request & Commit Guidelines
|
||||
## 12. Pull Request & Commit Guidelines
|
||||
|
||||
- **Commit Format**: We strictly enforce Conventional Commits (`feat:`, `fix:`, `refactor:`, `perf:`).
|
||||
- **Workflow**: You **MUST** use the `/commit` workflow before every git commit to ensure proper semantic versioning bumps.
|
||||
- **Required Checks**: Ensure `pnpm test` and `pnpm build` complete successfully before proposing a merge.
|
||||
- **Review Process**: Use `/pr-review` to conduct a comprehensive multi-role review on any pull request.
|
||||
- **Git Worktrees & Database Lifecycle**: We use [Worktrunk](https://github.com/max-sixty/worktrunk) to manage parallel branches and avoid relative path breakage. `git-wt switch --create <branch>` provisions isolated sibling worktrees configured with `.env` files and `pnpm install`. The database port is assigned deterministically based on the directory hash.
|
||||
> [!CAUTION]
|
||||
> You MUST use `git-wt remove` to clean up worktrees. Manually deleting a worktree folder (`rm -rf`) will orphan the associated PostgreSQL Docker volume. If this happens, you must manually run `pnpm run db:prune` in the main repository to reclaim disk space.
|
||||
- **Commit format**: Conventional Commits (`feat:`, `fix:`, `refactor:`, `perf:`). Use `/commit` workflow.
|
||||
- **Required checks**: `pnpm test` and `pnpm build` must pass before merge.
|
||||
- **Review**: Use `/pr-review` for comprehensive multi-role review.
|
||||
- **Worktrees**: Use `git-wt switch --create <branch>` and `git-wt remove` (never `rm -rf` a worktree — orphans the PostgreSQL Docker volume).
|
||||
|
||||
---
|
||||
|
||||
## 16. Debugging and Troubleshooting
|
||||
|
||||
- **Prisma & PostgreSQL Sync Issues**: If the local database state falls out of sync with Prisma schema, do not manually drop tables. Instead, run `pnpm db:reset` to cleanly wipe and re-apply all migrations.
|
||||
- **Cesium Entity Clipping**: If `billboard` entities are clipping or failing to render correctly, verify that you are not mixing `point` primitive properties (like `size` or `outlineWidth`) into the `billboard` options.
|
||||
- **Build Exhaustion (Docker)**: Multi-stage pnpm builds generate massive cache layers. If a Coolify deployment fails silently or PostgreSQL crashes abruptly, check host disk space and run `docker builder prune -a -f`.
|
||||
- **Next.js Typechecking Failures**: If backend-only `scripts/` fail during Next.js build, verify that the scripts directory is properly listed in the `exclude` array of `tsconfig.json`.
|
||||
|
||||
## 17. Coding Principles
|
||||
|
||||
You are about to write or modify code. **Read this file first.** It exists to prevent the failure mode where every fix makes the next harder — the kind of accumulated coupling and band-aid-on-band-aid that turns a clean codebase into a fragile one over months. This file is the constitution that keeps that from happening.
|
||||
|
||||
### The hard rule
|
||||
## Hard Rule
|
||||
|
||||
> **Always interface-based, extensible, composable, modular. Never band-aids on band-aids.**
|
||||
|
||||
If you find yourself adding a flag, an `if`-check, or a special case to make a problem go away, you are probably band-aiding. Stop and find the seam where the abstraction broke. Fix it there.
|
||||
|
||||
### Core principles
|
||||
|
||||
#### 1. Interfaces before implementations
|
||||
|
||||
Define the contract first. The contract is what other components depend on; the implementation is replaceable. Public functions accept the interface, not the concrete type.
|
||||
|
||||
```ts
|
||||
// Yes
|
||||
function attachSource(source: DataSource) { ... }
|
||||
|
||||
// No
|
||||
function attachPostgresSource(pg: PostgresInstance) { ... }
|
||||
```
|
||||
|
||||
When a pattern repeats across two modules, refactor it into an interface immediately. Don't wait for the third copy to "earn" the abstraction — by then the costs have compounded.
|
||||
|
||||
#### 2. Loose coupling through explicit contracts
|
||||
|
||||
Components communicate through well-defined contracts: typed function signatures, events on a bus, message queues, or capability registries. Pick the form that fits, but pick *one* and make it the only path.
|
||||
|
||||
Components do **not** communicate through:
|
||||
|
||||
- Direct imports of each other's internal modules
|
||||
- Shared mutable state outside the contract
|
||||
- Synchronous request/response when async fits the actual data flow
|
||||
- "Just this once" backdoors that bypass the contract
|
||||
|
||||
If you're tempted to write `import { internalThing } from '../other-module/internal'`, you are doing it wrong. If the symbol you need isn't part of the other module's public contract, either it should be — propose adding it — or you're solving the problem in the wrong place.
|
||||
|
||||
#### 3. Domain boundaries are sacred
|
||||
|
||||
Each domain (module, service, bounded context, plugin) owns its own state and its own surface. Cross-domain access is **explicit, gated, and audited** — never a shortcut.
|
||||
|
||||
Forbidden:
|
||||
- Reading another domain's storage directly
|
||||
- Calling another domain's private functions
|
||||
- Hardcoded `if (tenant === 'X')` or `if (mode === 'special')` branches in shared code
|
||||
|
||||
Allowed:
|
||||
- A documented capability or API on the other domain that you call
|
||||
- A configuration field on the relevant record that drives the strategy
|
||||
- Cross-domain access gated by explicit policy (default **deny**, opt-in per case), with the access itself logged
|
||||
|
||||
The rule of thumb: if removing a domain would require code archaeology in three other domains to figure out what depends on its internals, the boundary has already been violated. Treat that as a bug.
|
||||
|
||||
#### 4. Don't bend your architecture to fit a dependency
|
||||
|
||||
When you bring in a library or framework, use it where it fits cleanly; build natively where it doesn't.
|
||||
|
||||
Let the dependency handle (don't reinvent):
|
||||
- The thing it's specifically good at, in the shape it expects
|
||||
|
||||
Your code owns (the dependency can't represent):
|
||||
- Anything that's specifically your domain
|
||||
- Anything that requires identity, lifecycle, or invariants the dependency doesn't model
|
||||
- The integration seams between the dependency and your domain
|
||||
|
||||
If you find yourself bending your design to fit a library convenience, stop. Either the library has a hook for what you need, or you build it natively. Don't compromise architecture for the convenience of pulling in someone else's defaults.
|
||||
|
||||
#### 5. Data lifetimes are deliberate, not incidental
|
||||
|
||||
Different data has different lifetimes. Get this wrong and you'll either retain garbage forever or delete things users care about. Common categories:
|
||||
|
||||
- **Operational telemetry** (logs, metrics, internal events) — short rolling window. Useful for crash recovery and immediate investigation; not useful enough to keep forever.
|
||||
- **User content** (messages, documents, records the user created or that represent their lived experience with the system) — **permanent unless the user explicitly deletes it.** Never pruned by a sweep, never deleted by a retention policy authored for telemetry.
|
||||
- **Resumable session state** — bounded window appropriate to the use case; archived (state flag flipped) rather than deleted.
|
||||
|
||||
Name each category in your codebase. Write the retention policy for each one separately. Never propose a sweep that crosses categories — "delete events older than 30 days" is fine if events are telemetry; the same policy applied to user content is data loss masquerading as housekeeping. If storage pressure ever becomes real for content, introduce cold-tiered storage, not deletion.
|
||||
|
||||
#### 6. Optional features must be truly removable
|
||||
|
||||
Every optional feature (plugin, extension, integration, side module) declares its surface explicitly and communicates through the same contracts as everything else. No optional feature reaches into another's internals.
|
||||
|
||||
Test for whether something is core vs. optional: **if removing this feature should break the system, it's core. Otherwise it's optional, and it should be removable without leaving residue.**
|
||||
|
||||
If you can't delete an "optional" module's directory and have the system keep running, it isn't optional. Either fix the coupling or move it into core honestly.
|
||||
|
||||
#### 7. Put code where it belongs
|
||||
|
||||
When a feature spans layers (a trigger lives here, the action lives there, the data model lives somewhere else), resist the urge to fold it all into one place "for convenience." The feature lives in three places because each piece belongs to a different domain. Routing across them is the job — not collapsing them.
|
||||
|
||||
The general rule: if a feature needs to read/write durable state, it's a tool/extension on top of the layer that owns that state; if it's "the system should know about this concept," it's a configuration or contract change. Often it's both, with a thin handler that wires them together. That thin handler is fine — it's load-bearing — but it doesn't justify smashing the layers together.
|
||||
|
||||
### Antipatterns to refuse
|
||||
|
||||
These are common failure modes that, repeated over time, calcify a codebase. Refuse them when you catch yourself reaching for them.
|
||||
|
||||
| Antipattern | Better answer |
|
||||
|---|---|
|
||||
| Adding a new flag to an existing function instead of extracting a strategy | Extract the strategy interface; existing call sites pass the default strategy |
|
||||
| Patching around a bug at the call site | Find the seam where the abstraction broke; fix it there |
|
||||
| Direct database access from a feature module | Go through the layer that owns the data; if no surface exists, propose one |
|
||||
| Hardcoded paths, model names, IDs, environment specifics in business logic | Configuration; or look up via registry |
|
||||
| `if (tenant === 'X') { ... }` in shared code | Strategy on the record, or a per-tenant config field |
|
||||
| Inheriting one layer's concerns into another (or vice versa) | Cross the boundary through the documented contract |
|
||||
| "It works for now" — inline coupling between layers | If the layers are real, draw the contract; if they're not, merge them honestly |
|
||||
| Adding a defensive `try/catch` to swallow an error | Find why the error happens; gate cleanly at the right boundary |
|
||||
| Writing a comment to explain what code does | Rename and refactor so the code reads itself |
|
||||
| Copying a snippet from one module into another "to avoid the dependency" | Either it belongs in a shared module, or the duplicate will drift — pick |
|
||||
|
||||
### Debugging discipline
|
||||
|
||||
When something breaks:
|
||||
|
||||
1. **Reproduce it.** Don't trust intuition about what's failing.
|
||||
2. **Find the seam.** Where did the abstraction break? Which contract is being violated, and by whom?
|
||||
3. **Fix at the seam.** Not at the call site. Not at the consumer. At the boundary that's wrong.
|
||||
4. **If you can't find the seam, surface it.** Tell the user explicitly: "this is a design gap; the right fix needs an architectural decision, not a patch." Do not paper over.
|
||||
|
||||
If a fix doesn't work, **don't add another guard on top.** Find the real seam and gate cleanly. Stacked defensive layers are how clean codebases become unmaintainable.
|
||||
|
||||
### Lifecycle invariants and state-changing operations
|
||||
|
||||
Most recurring bugs cluster around the same shape: an operation crosses lifecycle state without checking, and the result is silent corruption, lost data, or orphan rows. The recipe that prevents recurrences:
|
||||
|
||||
1. **Name the invariant.** "Closed sessions don't accept work." "Scoped grants need a scope id." "Subscriptions past retention can't deliver swept events." Write it down before reaching for code.
|
||||
2. **Throw a typed error at the seam.** The single function that crosses the invariant refuses the bad case with a typed, named error — not a boolean return, not a silent skip, not a generic `Error`.
|
||||
3. **Pre-check at every call site that mutates *before* reaching the seam.** If the seam check fires after `store.append()`, you've left an orphan row. The pre-check is hygiene; the seam check is correctness — both are required. When the same pre-check appears at a second call site, extract a helper.
|
||||
4. **Validate, then mutate — never the reverse.** Within a single function, resolve all inputs that could fail (key derivation, lookups, permission checks) before touching durable state. A validation throw should leave nothing half-applied. If you can't separate validation from mutation, the function is doing two jobs.
|
||||
5. **A documented unsafe API is still unsafe.** A docstring that says "don't use this when X" is a foot-gun, not a warranty disclaimer. Either make the API safe in case X (drain, throw, refuse) or remove it.
|
||||
|
||||
If you're tempted to skip step 3 because "the seam check covers it," check whether the call site writes anything before reaching the seam. If yes, you need the pre-check.
|
||||
|
||||
### Definition of done — checklist for adding or updating a function
|
||||
|
||||
Every code change must satisfy the relevant checklist before merge. Refusal triggers below mean **stop and surface to the user** — do not ship a half-met checklist.
|
||||
|
||||
#### Adding a new function
|
||||
|
||||
All must be true:
|
||||
|
||||
- [ ] Belongs in this module (not somewhere else)
|
||||
- [ ] Fulfills an existing interface, OR a new interface is added with it (and reasons documented in a spec doc / ADR)
|
||||
- [ ] Has a doc-comment header (purpose + params + returns + thrown errors if relevant)
|
||||
- [ ] Has at least one test that targets the contract (not implementation details)
|
||||
- [ ] Test passes locally and in CI
|
||||
- [ ] Doesn't introduce direct cross-module imports of internals — communication through public contracts only
|
||||
- [ ] Doesn't touch storage owned by another component — route through that component's surface
|
||||
- [ ] Matches the spec doc's contract for this component (if no spec covers it, update the spec first)
|
||||
- [ ] Name is clear enough that the header comment is a summary, not an explanation
|
||||
|
||||
#### Updating an existing function
|
||||
|
||||
All must be true:
|
||||
|
||||
- [ ] Reason for change is clear (bug fix / new requirement / refactor / spec change)
|
||||
- [ ] Doc-comment still accurate after change (update if not)
|
||||
- [ ] Existing tests cover the new behavior (add new tests if not)
|
||||
- [ ] Build is green (all tests passing)
|
||||
- [ ] If this changes the contract: spec doc updated AND an ADR added if the change is load-bearing
|
||||
- [ ] Fix is at the seam, not at the symptom (no band-aid patches)
|
||||
- [ ] No new flags or special cases added in lieu of strategy extraction
|
||||
|
||||
#### Refusal triggers (any one means stop)
|
||||
|
||||
- Adding `if (tenant === 'X')` to shared code → use per-tenant config instead
|
||||
- Adding a flag to make a problem go away → extract the abstraction the flag implies
|
||||
- Direct DB or filesystem access from a feature module → route through the owning component
|
||||
- `try`/`catch` swallowing an error → find why the error happens, gate cleanly
|
||||
- Test omitted because "it's trivial" → no
|
||||
- Function-header skipped because "it's obvious" → no
|
||||
- "Just add another guard here" when a guard didn't work → find the real seam
|
||||
- Patch shipped to "unblock the build" without root-cause fix → no, surface the design gap
|
||||
|
||||
If any criterion isn't met, stop. Surface to the user as a design question. Don't paper over.
|
||||
|
||||
### Code-style minimums
|
||||
|
||||
#### Comments
|
||||
|
||||
**Every function gets a doc-comment header** in your language's idiomatic format (TSDoc, JSDoc, Python docstrings, Rust `///`, Javadoc, etc.). Not optional. Long-running codebases get re-read after gaps; function-header docs are how re-onboarding stays cheap.
|
||||
|
||||
Required content:
|
||||
|
||||
- One-line summary at a contract level (what the function guarantees, not what the code does line-by-line)
|
||||
- Each parameter and what it represents
|
||||
- Return value
|
||||
- Thrown errors / failure conditions if relevant
|
||||
- Example usage when the call shape is non-obvious
|
||||
|
||||
Apply this to public, internal, exported, and private functions. Apply to methods on classes too.
|
||||
|
||||
**Inline comments inside function bodies** still follow the standard rule: only for non-obvious WHY (hidden constraints, workarounds, surprising behavior, references to bug reports). Don't comment WHAT the code does — well-named identifiers and the function-header doc cover that.
|
||||
|
||||
#### Tests
|
||||
|
||||
**Every function ships with at least one test. Tests passing is a build requirement.**
|
||||
|
||||
- Tests target the contract (function signature + documented behavior + invariants), not implementation details. Refactoring should not break tests; behavior changes should.
|
||||
- A new implementation of an interface must pass the same contract test suite (write tests against the interface, not against a specific implementation).
|
||||
- Test names describe the case being verified, not the function: `it('refuses resume after archival window expires')` not `it('resumeSession')`.
|
||||
- For storage code: tests use a real (temporary) instance of the storage layer, created and torn down per test or per suite. Don't mock the storage engine — you're testing the wrong thing if you do.
|
||||
- For integration code that depends on an external library's hooks: contract tests against that library's surface so a dependency bump catches behavior changes.
|
||||
- Build pipeline (CI or local) runs all tests; non-zero exit = build fails. There is no "build succeeded but tests failed" state.
|
||||
|
||||
#### Logging
|
||||
|
||||
**Every new feature with a non-happy-path ships with a log line at each rare branch.** Use a structured logger with module-scoped child loggers. The log file is where "something's not working" turns into "what actually happened."
|
||||
|
||||
Level guidance:
|
||||
|
||||
- **info** — expected-but-noteworthy edges: a UI race that hits a closed resource, a permission bypass for a privileged principal. Correct behavior an operator might want to confirm fired.
|
||||
- **warn** — should be rare and worth investigating: race past a pre-check, lost events past retention, programmer/operator errors (calling a method after stop, a key that should have resolved didn't).
|
||||
- **error** — actual failures the operator must respond to: handler crashes, dispatch loop crashes, integration failures.
|
||||
- **debug** — high-volume internal state changes; always pair with a `module` field so it can be filtered.
|
||||
|
||||
Pass structured fields, not interpolated strings — fields are what makes a log queryable:
|
||||
|
||||
```ts
|
||||
// Yes
|
||||
logger.warn({ session_id, state }, "rejected append against non-live session");
|
||||
|
||||
// No
|
||||
logger.warn(`session ${session_id} (${state}) rejected append`);
|
||||
```
|
||||
|
||||
If you add a new typed error or a new event topic, also log it. The typed error tells the immediate caller; the event tells subscribers; the log tells the operator. The three are independent surfaces for the same fact, and all three are needed — events don't show up in the log, logs don't show up on the bus, errors don't survive the catch.
|
||||
|
||||
#### Structure
|
||||
|
||||
- Keep modules small. If a file is over ~500 lines, ask whether it has more than one responsibility.
|
||||
- Prefer explicit composition (caller wires things together) over implicit dependency-injection magic.
|
||||
- One public concept per module. If a file exports both `Foo` and `unrelatedHelperUsedNowhereElse`, the helper has the wrong home.
|
||||
|
||||
#### Dependencies
|
||||
|
||||
**Always check the registry for the current version before adding or updating a dependency.** Don't pick versions from memory.
|
||||
|
||||
The simple test: did you actually run `<package-manager> view <pkg> version` (or its equivalent) before pinning? If not, you're guessing — and the guess is almost always behind, sometimes by a major version with active deprecation.
|
||||
|
||||
Why this matters:
|
||||
|
||||
- **Long-running codebases.** Stale dependency anchors compound. A v3 you picked because that's what was on your mind will still be v3 a year later, and the v4 migration gets harder every month it waits.
|
||||
- **Active deprecations are real.** Common libraries are mid-deprecation cycles for older majors. Pinning to a soon-deprecated version on day one means the eventual upgrade is forced rather than chosen.
|
||||
- **"Latest" doesn't mean "use without thinking."** Read the changelog for breaking changes; decide whether to take them now or pin behind explicitly. But the *default* posture should be: pick latest, and justify in writing if pinning behind.
|
||||
|
||||
If you must pin behind latest, leave a comment in the manifest (or a CHANGELOG note) explaining why — a known incompatibility with another dep, an in-progress migration, a tested-and-rejected major bump. *"I haven't checked"* is not an acceptable reason.
|
||||
|
||||
Apply to: adding a new dep, updating an existing one, scaffolding a new package. *Not* required for routine no-op installs that don't touch versions.
|
||||
|
||||
#### Doc-vs-spec discipline
|
||||
|
||||
Specification documents (the deeper ones that describe how a component must behave) are **functional specifications**, not narrative essays. The discipline:
|
||||
|
||||
- **Concrete data structures** — type definitions, schemas, DDL, JSON examples
|
||||
- **Concrete function signatures** — input/output types, error types
|
||||
- **Concrete event/message payloads** — name + schema + example
|
||||
- **Concrete API signatures** — input/output schemas, side effects, permission requirements
|
||||
- **Flow pseudocode** — when orchestration is non-obvious
|
||||
- **Invariants** — explicitly listed: "after X happens, Y is always true"
|
||||
- **Failure modes** — enumerated: "if X fails, the system does Y"
|
||||
- **Acceptance tests** — statements another engineer can implement: "given input X, output Y"
|
||||
|
||||
Avoid in spec docs:
|
||||
- Long prose explaining motivation (that goes in ADRs / decision records)
|
||||
- Discussion of alternatives considered (also ADRs)
|
||||
- Background context (README handles this)
|
||||
- Marketing/aspirational tone
|
||||
|
||||
Spec docs are for implementation. Read one and you should know what to build.
|
||||
|
||||
### When in doubt
|
||||
|
||||
Ask the human user. Specifically:
|
||||
|
||||
- "I don't see a clean seam for this; the options I see are A or B. Which fits the architecture you have in mind?"
|
||||
- "This requires a new contract / capability / interface. Should I draft it before implementing?"
|
||||
- "I'm about to add a special case here; that smells like a missing abstraction. Do you want me to extract the abstraction or note the smell and defer?"
|
||||
|
||||
Don't ship band-aids and ask forgiveness later. The user has explicitly said: prevent that pattern.
|
||||
Read `.agents/context/coding-principles.md` before any non-trivial code change.
|
||||
+4
-1
@@ -21,6 +21,7 @@ services:
|
||||
required: false
|
||||
environment:
|
||||
- "AUTH_SECRET=${AUTH_SECRET:-default_secret_for_local_dev}"
|
||||
- "ENCRYPTION_MASTER_KEY=${ENCRYPTION_MASTER_KEY:-local_dev_encryption_key_change_in_prod}"
|
||||
- "WWV_DEMO_ADMIN_SECRET=${WWV_DEMO_ADMIN_SECRET:-}"
|
||||
- "WWV_BRIDGE_TOKEN=${WWV_BRIDGE_TOKEN:-}"
|
||||
- "DATABASE_URL=postgresql://postgres:postgres@db:5432/worldwideview?schema=public"
|
||||
@@ -58,11 +59,13 @@ services:
|
||||
command: >
|
||||
sh -c "
|
||||
echo 'Syncing workspace dependencies...' &&
|
||||
cd $$SEEDERS_DIR/community && CI=true pnpm install --ignore-scripts && pnpm -r rebuild better-sqlite3 esbuild &&
|
||||
if [ -d \"$$SEEDERS_DIR/community\" ]; then cd $$SEEDERS_DIR/community && CI=true pnpm install --ignore-scripts && pnpm -r rebuild better-sqlite3 esbuild; fi &&
|
||||
if [ -d \"$$SEEDERS_DIR/private\" ]; then cd $$SEEDERS_DIR/private && CI=true pnpm install --ignore-scripts && pnpm -r rebuild better-sqlite3 esbuild; fi &&
|
||||
cd /app && node dist/server.js"
|
||||
ports:
|
||||
- "5000:5000"
|
||||
volumes:
|
||||
- ./local-seeders:/app/seeders
|
||||
environment:
|
||||
- PORT=5000
|
||||
- REDIS_URL=redis://wwv-redis:6379
|
||||
|
||||
+54
-2
@@ -29,8 +29,60 @@ if [ -z "$DATABASE_URL" ]; then
|
||||
fi
|
||||
|
||||
echo "[entrypoint] Running database migrations..."
|
||||
prisma migrate deploy
|
||||
echo "[entrypoint] Migrations complete."
|
||||
set +e
|
||||
MIGRATE_OUT=$(prisma migrate deploy 2>&1)
|
||||
MIGRATE_CODE=$?
|
||||
set -e
|
||||
|
||||
if [ $MIGRATE_CODE -eq 0 ]; then
|
||||
echo "[entrypoint] Migrations complete."
|
||||
elif echo "$MIGRATE_OUT" | grep -q "P3005"; then
|
||||
# P3005: schema exists but _prisma_migrations has no history.
|
||||
# Happens when 'prisma db push' (pnpm dev) ran before 'prisma migrate deploy' (docker).
|
||||
# Safe to auto-baseline only if there is zero schema drift.
|
||||
echo "[entrypoint] P3005: schema exists without migration history."
|
||||
echo "[entrypoint] Verifying schema matches migrations before auto-baselining..."
|
||||
set +e
|
||||
DIFF_OUT=$(prisma migrate diff \
|
||||
--from-url "$DATABASE_URL" \
|
||||
--to-schema-datamodel prisma/schema.prisma \
|
||||
--script 2>&1)
|
||||
DIFF_CODE=$?
|
||||
set -e
|
||||
if [ $DIFF_CODE -ne 0 ]; then
|
||||
echo "[entrypoint] Could not verify schema state — aborting." >&2
|
||||
echo "$DIFF_OUT" >&2
|
||||
exit 1
|
||||
fi
|
||||
# Positive-match for DDL keywords: any real drift emits at least one of these.
|
||||
# Checking for presence is safer than checking for absence of content.
|
||||
if echo "$DIFF_OUT" | grep -qiE "^(CREATE|ALTER|DROP|INSERT|UPDATE|DELETE|TRUNCATE)"; then
|
||||
echo "[entrypoint] Schema drift detected — cannot auto-baseline." >&2
|
||||
echo "[entrypoint] Run 'pnpm db:reset' to wipe and re-migrate, or resolve drift manually." >&2
|
||||
echo "$MIGRATE_OUT" >&2
|
||||
exit 1
|
||||
fi
|
||||
echo "[entrypoint] No drift detected. Baselining existing schema..."
|
||||
for migration_dir in prisma/migrations/*/; do
|
||||
if [ -f "${migration_dir}migration.sql" ]; then
|
||||
migration_name=$(basename "$migration_dir")
|
||||
echo "[entrypoint] Marking as applied: $migration_name"
|
||||
set +e
|
||||
prisma migrate resolve --applied "$migration_name"
|
||||
RESOLVE_CODE=$?
|
||||
set -e
|
||||
if [ $RESOLVE_CODE -ne 0 ]; then
|
||||
echo "[entrypoint] Failed to baseline $migration_name — aborting." >&2
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
done
|
||||
prisma migrate deploy
|
||||
echo "[entrypoint] Migrations complete."
|
||||
else
|
||||
echo "$MIGRATE_OUT" >&2
|
||||
exit $MIGRATE_CODE
|
||||
fi
|
||||
|
||||
# Generate self-signed SSL certificates for local HTTPS bridging if they don't exist
|
||||
if [ ! -f "./data/localhost.crt" ] || [ ! -f "./data/localhost.key" ]; then
|
||||
|
||||
+6
-4
@@ -75,9 +75,11 @@ For legacy plugins (e.g., Webcams) that *cannot* use WebSockets, the local proxy
|
||||
## Operational Implementation Details
|
||||
|
||||
### 1. Library Selection
|
||||
* **`jose`:** The industry-standard library for modern JS. Used by the Marketplace to generate Ed25519 keys, sign JWTs, and expose the JWKS endpoint.
|
||||
* **`jose`:** The industry-standard library for modern JS. Used by the Marketplace to generate Ed25519 keys, sign JWTs, and expose the JWKS endpoint. **Also used by Data Engines** to verify tickets — `createRemoteJWKSet` handles remote fetching, caching, and `kid` selection, and `jwtVerify` validates the signature plus `iss`/`aud`/`exp` in one call, with native OKP/Ed25519 support.
|
||||
* **`openid-client`:** The RFC-compliant library used by the Local App to execute the PKCE Authorization Code flow securely.
|
||||
* **`@fastify/jwt` + `get-jwks`:** Used by Data Engines. `@fastify/jwt` provides the middleware, while `get-jwks` (built by the Fastify core team) handles remote fetching, local LRU caching, and OKP-to-PEM conversion for Ed25519 keys.
|
||||
|
||||
> [!NOTE]
|
||||
> **Amendment (2026-05-22):** The original draft specified `@fastify/jwt` + `get-jwks` for Data Engines. This was found to be incorrect during local integration testing: `get-jwks.getPublicKey()` converts JWKs via `jwk-to-pem`, which **does not support OKP/Ed25519 keys** (throws `Unsupported key type "OKP"`). `@fastify/jwt`'s standalone `verify()` is also incompatible with a remote-JWKS async key resolver. Data Engines now use `jose` — the same library already mandated for the Marketplace — which supports Ed25519 natively.
|
||||
|
||||
### 2. Hardened First-Message Auth
|
||||
Data Engines MUST enforce strict WebSocket handshake rules:
|
||||
@@ -145,8 +147,8 @@ sequenceDiagram
|
||||
M->>L: 5-min JWT (aud: Engine A)
|
||||
L->>U: JWT
|
||||
U->>E: wss://engine (Origin validation)
|
||||
U->>E: { type: "auth", jwt: "..." }
|
||||
E->>E: Verify with get-jwks cache
|
||||
U->>E: { type: "auth", v: 1, token: "..." }
|
||||
E->>E: Verify JWT via jose (cached JWKS)
|
||||
E->>U: Stream
|
||||
end
|
||||
```
|
||||
@@ -0,0 +1,158 @@
|
||||
# ADR-0002: Source-of-truth for plugin identity and registration
|
||||
|
||||
## Status
|
||||
Accepted
|
||||
|
||||
## Date
|
||||
2026-05-20
|
||||
|
||||
## Context
|
||||
|
||||
Two related problems in the plugin system surfaced in the same period, and both have the same root cause: canonical plugin information was being derived in middleware translation layers (folder names, hard-coded lists) rather than at its proper source. Each problem is fixed by pushing the canonical truth back to its rightful owner and removing the static translation in the middle. Documenting them together makes the shared principle explicit and discourages future regressions of the same shape.
|
||||
|
||||
### Problem 1 — Engine seeder ID derived from folder name
|
||||
|
||||
The WorldWideView local data engine discovers seeders by scanning the filesystem under `/app/seeders`. Historically, the engine assigned each seeder an ID equal to its **folder name** (e.g., the folder `gpsjam/` became plugin ID `"gpsjam"`).
|
||||
|
||||
The frontend, however, identifies plugins by a separate **`id` field** declared in each plugin class (e.g., `"gps-jamming"`). The engine's `/manifest` endpoint listed available plugins using folder-derived IDs, and the frontend's `localEngineHasPlugin(pluginId)` performed an exact string match against that list.
|
||||
|
||||
This created a silent failure mode: six seeders had folder names that did not match their corresponding frontend plugin IDs:
|
||||
|
||||
| Folder name | Frontend plugin `id` |
|
||||
|---|---|
|
||||
| `gpsjam/` | `gps-jamming` |
|
||||
| `sanctions/` | `international-sanctions` |
|
||||
| `wildfires/` | `wildfire` |
|
||||
| `civilUnrest/` | `civil-unrest` |
|
||||
| `conflictEvents/` | `conflict-events` |
|
||||
| `cyberAttacks/` | `cyber-attacks` |
|
||||
|
||||
When `localEngineHasPlugin('gps-jamming')` returned `false` (because the manifest listed `"gpsjam"`), the frontend silently fell through to the production cloud engine, bypassing the local engine entirely. The bug was invisible — no error, just incorrect routing.
|
||||
|
||||
A short-term patch introduced `SEEDER_ID_ALIASES` in `src/core/data/engineManifest.ts` — a frontend translation map from folder names to plugin IDs. This was explicitly a band-aid: it duplicated knowledge in a consumer rather than fixing the contract at the source, and would go stale as new seeders were added.
|
||||
|
||||
The engine's TypeScript source (`seeder-loader.ts`) also had a `toKebabCase()` helper intended to normalize camelCase folder names (e.g., `civilUnrest` → `civil-unrest`), but its compiled `dist/` was stale (the production image had not been rebuilt to include it), and `toKebabCase` alone cannot resolve abbreviation mismatches like `gpsjam` → `gps-jamming`.
|
||||
|
||||
### Problem 2 — Fresh-install plugin set hard-coded
|
||||
|
||||
The marketplace auto-seeder ([src/lib/marketplace/seedDefaultPlugins.ts](../../../src/lib/marketplace/seedDefaultPlugins.ts)) writes a starter set of plugins to the database on first boot so the globe isn't empty on day one. The list of plugins to seed lived in a hard-coded constant `DEFAULT_PLUGIN_IDS` ([src/lib/marketplace/defaultPlugins.ts](../../../src/lib/marketplace/defaultPlugins.ts)).
|
||||
|
||||
Two failure modes followed from the static list:
|
||||
|
||||
1. **Drift**: ten plugins were published to npm under `@worldwideview/*` and verified — surveillance-satellites, military-bases, embassies, seaports, lighthouses, spaceports, iranwarlive, undersea-cables, mineral-mines, nuclear-facilities — but never added to `DEFAULT_PLUGIN_IDS`. Fresh installs missed them silently.
|
||||
2. **Phantom 404s**: two entries in the list (`fortiguard`, `nz-traffic-cameras`) were dev-only sandboxes in `local-plugins/`, never published to npm. Every fresh boot hit `https://marketplace.worldwideview.dev/api/plugins/fortiguard` → 404, logged a warning, and continued. The branch `fix/diagnose-plugins-404` was opened to diagnose those.
|
||||
|
||||
A separate, signed verified-plugins registry already existed at `marketplace.worldwideview.dev/api/registry`, loaded by [registryClient.ts](../../../src/lib/marketplace/registryClient.ts) with Ed25519 verification. It was used for trust-stamping installed plugins but not for selecting which plugins to seed. That registry is the authoritative list of plugins that have been reviewed and verified — exactly the list a starter set should come from.
|
||||
|
||||
### Shared shape
|
||||
|
||||
Both problems wrap the same anti-pattern: a consumer (frontend, seeder) maintains a static translation/list derived from the producer's actual identity (seeder export, npm publication). The translation drifts. The fix in both cases is the same: stop translating in the consumer; let the producer declare the truth and consume it directly.
|
||||
|
||||
## Decisions
|
||||
|
||||
### Decision 1 — The seeder's exported `name` field is the canonical plugin ID
|
||||
|
||||
The engine reads each seeder's `dist/index.mjs` default export's `name` property and uses it as the plugin ID everywhere:
|
||||
|
||||
- `/manifest` endpoint `plugins` array
|
||||
- WebSocket welcome message plugin list
|
||||
- WebSocket data message `pluginId` field
|
||||
- Redis key (`data:<name>:live`)
|
||||
- Scheduler logs
|
||||
|
||||
The folder name is used only as a filesystem fallback if the seeder exports no `name`. The engine logs a warning at startup whenever the kebab-cased folder name differs from the seeder's exported `name`, making drift visible without blocking startup.
|
||||
|
||||
**Contract:** Every seeder MUST export a `name` field that exactly equals the corresponding frontend plugin's `id` field (kebab-case). This is a two-place contract: declare the same ID string in the seeder export and in the frontend plugin class.
|
||||
|
||||
Implementation: `seeder-loader.ts` was updated to set `id = seederConfig.name || toKebabCase(folderName)` instead of `id = toKebabCase(folderName)`. The frontend `SEEDER_ID_ALIASES` map was removed entirely. No translation layer exists between the engine's manifest and the frontend's plugin lookup.
|
||||
|
||||
### Decision 2 — The signed verified registry is the source-of-truth for fresh-install auto-seeding
|
||||
|
||||
The marketplace auto-seeder iterates the set returned by `getVerifiedPluginIds()` (the signed registry) instead of a hard-coded `DEFAULT_PLUGIN_IDS` constant. Publishing a plugin to the verified registry automatically makes it part of the fresh-install starter set on subsequent boots, with no code change.
|
||||
|
||||
The static `DEFAULT_PLUGIN_IDS` list is deleted. There is no fallback list in code — if the registry is unreachable on first attempt, the seeder defers without marking-seeded so the next request retries (the 5-min in-memory cache in `registryClient.ts` bounds the request rate during outages).
|
||||
|
||||
Trust stamping is collapsed: every plugin landed by the seeder is `verified` by definition, so the per-plugin `verified.has(pluginId)` check inside the seeder is dropped — `manifest.trust = "verified"` is set directly.
|
||||
|
||||
**Contract:** A plugin is part of the fresh-install starter set iff it appears in the signed verified-plugins registry. There is no other list to maintain.
|
||||
|
||||
## Shared principle
|
||||
|
||||
> **Canonical plugin truth lives at the source. Reject static translation/lookup layers in the middle.**
|
||||
|
||||
This is the architectural rule both decisions encode. Concrete corollaries for future contributions:
|
||||
|
||||
- Don't introduce a static map in a consumer to compensate for a producer that mis-labels itself. Fix the producer.
|
||||
- Don't introduce a static list in code to enumerate what a registry or filesystem already enumerates. Read from the registry/filesystem.
|
||||
- A translation layer that "just needs an entry added each time we publish a plugin" is a foot-gun — it will silently drift the moment someone forgets.
|
||||
|
||||
## Alternatives Considered
|
||||
|
||||
### For Decision 1
|
||||
|
||||
#### Folder renames (rejected as primary fix)
|
||||
Rename the six mismatched folders to match their frontend plugin IDs (e.g., `gpsjam/` → `gps-jamming/`). This would make the folder name the canonical ID.
|
||||
|
||||
- **Rejected as primary fix** because Windows Docker Desktop holds NTFS volume mount locks on running containers, making renames impossible without a full Docker Desktop shutdown. More importantly, it makes the canonical ID fragile — any accidental folder rename breaks routing silently.
|
||||
- Folder renames remain a cosmetic cleanup option, now that the seeder export is the actual source of truth.
|
||||
|
||||
#### Frontend alias map (`SEEDER_ID_ALIASES`)
|
||||
Maintain a static mapping in `engineManifest.ts` that translates engine-reported IDs to frontend plugin IDs.
|
||||
|
||||
- **Rejected** because it puts translation responsibility on the consumer rather than the producer. Every new seeder with a naming mismatch requires a manual alias entry. The map goes stale silently — no warning if an alias is wrong or missing.
|
||||
|
||||
#### `toKebabCase()` normalization only
|
||||
Apply `toKebabCase()` to folder names in the engine and rely on the convention that folder names encode the plugin ID in camelCase.
|
||||
|
||||
- **Rejected** because `toKebabCase` cannot resolve abbreviation mismatches (`gpsjam` → still `gpsjam`, not `gps-jamming`) or singular/plural differences (`wildfires` → still `wildfires`, not `wildfire`). It only handles camelCase-to-kebab conversion.
|
||||
|
||||
#### Strict validation with engine startup failure
|
||||
Refuse to load any seeder whose folder name doesn't match its exported `name`, blocking startup until inconsistencies are resolved.
|
||||
|
||||
- **Rejected** as too aggressive for a local dev environment. A warning is sufficient — startup continues, mismatches are visible, and the system keeps working.
|
||||
|
||||
### For Decision 2
|
||||
|
||||
#### Add the missing 10 IDs to `DEFAULT_PLUGIN_IDS` (rejected)
|
||||
Extend the static list to include the newly-published plugins.
|
||||
|
||||
- **Rejected** because it ships a fix that resolves the immediate symptom while preserving the underlying drift mechanism. The list would go stale again the next time a plugin is published.
|
||||
|
||||
#### Hybrid: registry as default + static fallback list
|
||||
Read from the registry; fall back to a hard-coded list if the registry is empty/unreachable.
|
||||
|
||||
- **Rejected** because it reintroduces the static list as a permanent shadow source-of-truth. Fallback lists go stale silently. The chosen "defer seeding on empty registry" behavior is safer — fresh installs retry on the next request rather than locking in a stale set.
|
||||
|
||||
#### Delete auto-seeding entirely (rejected)
|
||||
Drop the seeder and let users install everything from the marketplace UI starting from an empty globe.
|
||||
|
||||
- **Rejected** because fresh installs should have something to look at on day one. The user explicitly stated this requirement: "we want the user to have something to get started with."
|
||||
|
||||
## Consequences
|
||||
|
||||
### Easier
|
||||
|
||||
**Decision 1 — engine seeder identity**
|
||||
- Self-documenting identity. Reading any seeder's `src/index.ts` immediately tells you its plugin ID. No external registry to consult.
|
||||
- Filesystem layout is irrelevant. Folders can be named for readability or organized in subdirectories without affecting routing.
|
||||
- No translation layers. The frontend receives the correct ID directly from the manifest; `localEngineHasPlugin()` works with a direct string comparison.
|
||||
- Drift is visible. The engine warns on startup when folder names diverge from exported names, catching mistakes during development rather than silently at runtime.
|
||||
- Adding a new seeder requires only: (1) export `name: '<plugin-id>'` matching the frontend plugin's `id`, (2) no registration step, no alias map entry.
|
||||
|
||||
**Decision 2 — marketplace seeding**
|
||||
- Publishing a plugin to the verified registry is sufficient to add it to the starter set. No code change, no PR to add an ID to a constant.
|
||||
- Phantom 404s are gone. The seeder only queries IDs that exist in the verified registry, which by construction reflects what's actually published.
|
||||
- Trust semantics align. "Verified" and "auto-seeded on fresh install" are now the same condition, not two near-overlapping lists that can drift.
|
||||
- Registry outages no longer brick fresh installs. The deferral semantics ensure the seeder retries instead of marking-seeded with zero rows.
|
||||
|
||||
### Harder
|
||||
|
||||
**Decision 1 — engine seeder identity**
|
||||
- Seeder author bears responsibility. If a seeder exports the wrong `name`, routing fails silently (same failure mode as before, but now localized to the seeder rather than the folder). The startup warning mitigates this.
|
||||
- Contract validation is advisory, not enforced. There is no build-time check that the seeder's `name` matches an actual frontend plugin `id`. A validation script (`scripts/validate-seeder-ids.mjs`) is the recommended mitigation.
|
||||
- Engine image must be kept up to date. The fix lives in `dist/seeder-loader.js` inside the Docker image. If the published `ghcr.io/silvertakana/wwv-data-engine:latest` image is behind the local source, the behavior reverts to folder-name-based IDs. Local changes require `docker cp` injection or an image rebuild until the fix is published.
|
||||
|
||||
**Decision 2 — marketplace seeding**
|
||||
- The verified registry must be kept accurate. A newly-published plugin doesn't auto-seed until it's added to the registry and the registry is re-signed. Operational responsibility shifts from "remember to add the ID to a code constant" to "remember to add the ID to the registry" — a similar discipline, but now at the right layer (the marketplace, not the consumer).
|
||||
- Existing instances are not back-filled. Users whose `Setting` table already has `defaults_seeded=true` will not automatically receive newly-verified plugins; they must install via the marketplace UI. This is by design — re-seeding could reinstall plugins a user explicitly uninstalled.
|
||||
- Dev-only sandboxes (`local-plugins/<name>/`) no longer "tag along" via the default list. `fortiguard` and `nz-traffic-cameras` only reach users once published to npm and added to the verified registry. The local-plugins folder discovery in `/api/marketplace/load` still surfaces them in dev (`NODE_ENV=development` or `WWV_PLUGIN_DEV=true`).
|
||||
@@ -0,0 +1,175 @@
|
||||
# ADR-0003: Shared Identity & Ecosystem Authentication Host
|
||||
|
||||
## Status
|
||||
Proposed *(Pending Review)*
|
||||
|
||||
## Date
|
||||
2026-05-22
|
||||
|
||||
## Related
|
||||
- **Builds on:** ADR-001 (Decentralized Plugin Auth & SSRF Mitigation) — specifically the PKCE flow that lets the Local App acquire tokens from the Marketplace
|
||||
- **Supersedes:** `.agents/rules/cloud-auth-architecture.md` (which incorrectly states that `app.worldwideview.dev` owns all login UI — this ADR reverses that)
|
||||
|
||||
---
|
||||
|
||||
## Context
|
||||
|
||||
WorldWideView is growing into a multi-product ecosystem:
|
||||
|
||||
| Product | URL | Purpose |
|
||||
|---|---|---|
|
||||
| Landing / Auth | `worldwideview.dev` | Marketing, login, signup, cloud plan registration |
|
||||
| Marketplace | `marketplace.worldwideview.dev` | Browse, install, and manage plugins |
|
||||
| Cloud App | `app.worldwideview.dev` (or `[tenant].app.worldwideview.dev`) | Hosted geospatial intelligence instance |
|
||||
| Local App | Self-hosted | User's own instance, authenticated locally |
|
||||
|
||||
Four interrelated problems required a unified decision:
|
||||
|
||||
1. **No Marketplace identity system exists.** Users have nowhere to create an account, log in, or manage subscriptions.
|
||||
2. **Fragmented account experience.** Without a plan, a user would need separate accounts for the Marketplace and the Cloud App — unacceptable for a single-vendor ecosystem.
|
||||
3. **Cookie domain fragmentation.** If each product hosts its own login page, sessions cannot be shared across subdomains. A user logged into the Marketplace would need to log in again at the Cloud App.
|
||||
4. **The `worldwideview-web` repo is a static export** (`output: "export"`). It has a `/login` page backed by client-side Supabase but cannot support server-side sessions, API routes, or cross-subdomain cookie management.
|
||||
|
||||
---
|
||||
|
||||
## Decisions
|
||||
|
||||
### ADR-003A: Federated Identity — One Account Across All Products
|
||||
|
||||
All WorldWideView products share a **single identity**. A user who creates an account anywhere in the ecosystem (Marketplace, Cloud App, or the landing site) has that same identity available everywhere else.
|
||||
|
||||
This is the standard industry pattern for multi-product SaaS — used by GitHub (one account → GitHub, Marketplace, Actions, Packages), Atlassian (one account → Jira, Confluence, Marketplace), and Stripe (one account → Dashboard, Atlas, Stripe Apps).
|
||||
|
||||
The shared identity store is a **single Supabase project**. All products point to the same `NEXT_PUBLIC_SUPABASE_URL` and read from the same `auth.users` table. No synchronisation jobs, no duplicate user records.
|
||||
|
||||
### ADR-003B: Supabase Auth as the Identity Provider
|
||||
|
||||
**Supabase Auth** is the identity layer for the entire ecosystem. It was chosen over:
|
||||
|
||||
- **Better Auth** — excellent self-hosted option, but requires a Postgres database to be provisioned separately. Since the Marketplace and `worldwideview-web` have no existing database, Supabase provides auth + Postgres in a single managed service with zero extra infrastructure.
|
||||
- **NextAuth v5** — already present in the Local App for local access control, but it is not a full identity platform. Missing 2FA, RBAC, and a proper OAuth server model. Not suitable as an ecosystem-wide IdP.
|
||||
- **Clerk** — fastest setup and best Stripe integration, but ~$25–50/month at low user counts, per-MAU pricing at scale, and user data is stored on Clerk's servers. Vendor lock-in is unacceptable for a product that holds plugin and subscription data.
|
||||
|
||||
Supabase Auth provides:
|
||||
- Email + password, Google OAuth, GitHub OAuth, and magic link — all configured in the Supabase dashboard with no provider code
|
||||
- `@supabase/ssr` package with first-class Next.js App Router support (server components, middleware, server actions)
|
||||
- Cookie-based sessions that can be scoped to the parent domain
|
||||
- Free tier is sufficient for early-stage Marketplace; Pro plan ($25/month) unlocks unlimited MAU
|
||||
|
||||
### ADR-003C: `worldwideview.dev` (worldwideview-web repo) is the Ecosystem Auth Host
|
||||
|
||||
The login and account registration UI lives at **`worldwideview.dev`** — the apex domain, served by the `worldwideview-web` repository. Three alternatives were considered:
|
||||
|
||||
**Option A — Each app has its own login page**
|
||||
Rejected. Each product renders its own login form against the shared Supabase project. Browser `localStorage` (used by client-side Supabase) is domain-scoped and cannot be shared across subdomains. This means a user logged in at `marketplace.worldwideview.dev` would not be recognised at `app.worldwideview.dev`. Solving this in each app separately creates duplicated middleware and fragile cookie coordination.
|
||||
|
||||
**Option B — Marketplace owns the login page**
|
||||
Rejected. The Cloud App would be permanently subordinate to the Marketplace for authentication. If the Marketplace is down, Cloud App users cannot log in. Also creates a confusing UX: users navigate to `app.worldwideview.dev` and are immediately bounced to `marketplace.worldwideview.dev` just to authenticate.
|
||||
|
||||
**Option C — Dedicated `accounts.worldwideview.dev` subdomain**
|
||||
Seriously considered. A neutral auth subdomain is the cleanest long-term architecture. Rejected for now because it requires a third Next.js deployment and a third Coolify application. The same result is achieved by hosting auth on the apex domain itself (`worldwideview.dev`), which is already managed by `worldwideview-web` and is the identity host by virtue of owning the root domain.
|
||||
|
||||
**Chosen: Apex domain as auth host.** The `worldwideview-web` repo becomes the auth surface for the whole ecosystem:
|
||||
|
||||
| Path | Type | Purpose |
|
||||
|---|---|---|
|
||||
| `/` | Static | Landing page (marketing) |
|
||||
| `/about`, `/docs`, `/plugins` | Static | Marketing content |
|
||||
| `/login` | Dynamic (SSR) | Shared login for all products |
|
||||
| `/signup` | Dynamic (SSR) | New account creation |
|
||||
| `/cloud` | Dynamic (SSR) | Cloud plan registration and subscription |
|
||||
| `/accounts/*` | Dynamic (SSR) | Account management, billing, API keys |
|
||||
| `/api/auth/callback` | Dynamic (SSR) | OAuth redirect handler (Google, GitHub) |
|
||||
|
||||
**Why the apex domain is correct:** A session cookie set on `worldwideview.dev` is automatically inherited by all subdomains (`marketplace.worldwideview.dev`, `app.worldwideview.dev`, and any future product). This is the same mechanism used by Stripe — `stripe.com/login` sets the session that `dashboard.stripe.com` reads.
|
||||
|
||||
### ADR-003D: Cross-Subdomain Session Sharing via Parent Domain Cookie
|
||||
|
||||
Supabase Auth session cookies are explicitly scoped to the parent domain so that all products share the same session without additional coordination:
|
||||
|
||||
```typescript
|
||||
// Applied in worldwideview-web middleware and all Supabase server clients
|
||||
cookieOptions: {
|
||||
domain: '.worldwideview.dev', // leading dot = all subdomains inherit
|
||||
path: '/',
|
||||
sameSite: 'lax',
|
||||
secure: true, // HTTPS required — see local dev below
|
||||
}
|
||||
```
|
||||
|
||||
Each product (Marketplace, Cloud App) reads this cookie to get the authenticated user, then calls `supabase.auth.getUser()` server-side to validate the session. No cross-app API calls for authentication.
|
||||
|
||||
**Logout** must clear the cookie on the parent domain, not the subdomain, or the session will persist across products.
|
||||
|
||||
### ADR-003E: `worldwideview-web` Converts from Static Export to Mixed Static/SSR
|
||||
|
||||
The current `worldwideview-web` uses `output: "export"` in `next.config.ts`, forcing every page to be a static HTML file served by Nginx. This is removed.
|
||||
|
||||
Without `output: "export"`, Next.js App Router applies per-route rendering:
|
||||
- Pages that do not call `cookies()`, `headers()`, or other dynamic functions are **statically generated at build time** — marketing pages remain fast and CDN-cached with no change required.
|
||||
- Pages that call `cookies()` (all auth pages using `@supabase/ssr`) are **server-rendered on request**.
|
||||
|
||||
The Docker deployment changes from an Nginx static image to a Node.js runtime image. The Coolify application is updated in-place — no new Coolify application is needed.
|
||||
|
||||
### ADR-003F: `wwv.local` Local Development Environment
|
||||
|
||||
Because the parent-domain cookie requires `secure: true` (HTTPS only), local development using `localhost` will not replicate production session-sharing behaviour. A local HTTPS domain is required.
|
||||
|
||||
The project adopts `wwv.local` as the local development TLD with a self-signed certificate:
|
||||
|
||||
| Local URL | Maps to | Purpose |
|
||||
|---|---|---|
|
||||
| `wwv.local` | worldwideview-web on port 3001 | Landing + auth |
|
||||
| `marketplace.wwv.local` | worldwideview-marketplace on port 3002 | Marketplace |
|
||||
| `app.wwv.local` | worldwideview main app on port 3000 | Local App / Cloud App |
|
||||
|
||||
This setup is a deliberate investment: it ensures that cross-subdomain auth, redirect flows, and cookie behaviour can be tested locally before production deployment. The setup cost is a one-time `mkcert` install and hosts file edit per developer machine.
|
||||
|
||||
Setup (documented in each repo's README):
|
||||
```bash
|
||||
# Install mkcert (once per machine)
|
||||
# macOS: brew install mkcert && mkcert -install
|
||||
# Windows: choco install mkcert && mkcert -install
|
||||
|
||||
mkcert "*.wwv.local" wwv.local
|
||||
# Add to hosts: 127.0.0.1 wwv.local marketplace.wwv.local app.wwv.local
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Security Constraints (from Pre-Mortem Review)
|
||||
|
||||
The following risks were identified and mitigated before implementation:
|
||||
|
||||
| Risk | Mitigation |
|
||||
|---|---|
|
||||
| Supabase anon key can read all rows if RLS is disabled | Row Level Security (RLS) MUST be enabled on all app-specific tables (`MarketplaceUser`, `InstalledPlugin`). Policy: `using (id = auth.uid())`. Server routes use `SUPABASE_SERVICE_ROLE_KEY` which bypasses RLS by design. |
|
||||
| PKCE authorization code replay attack | The authorization code is deleted from the database transactionally at the moment of redemption. Any subsequent attempt receives `400 invalid_grant`. |
|
||||
| Supabase free tier limits magic link email to 2/hour per address | A custom SMTP provider (Resend) is configured in Supabase project settings before magic link is enabled in production. |
|
||||
| `MarketplaceUser` becomes orphaned when `auth.users` row is deleted | A Postgres trigger on `auth.users` DELETE cascades to `MarketplaceUser` and all related rows. |
|
||||
| Ed25519 signing key rotation causes token rejection at Data Engines | Signing keys are stored in a `SigningKey` DB table, not env vars. The JWKS endpoint serves all non-revoked keys simultaneously. During rotation, the old key is marked `retiring` and kept in JWKS for 10 minutes before being marked `revoked`. |
|
||||
|
||||
---
|
||||
|
||||
## Marketplace PKCE OAuth Server (Relation to ADR-001)
|
||||
|
||||
The Marketplace acts as the **OAuth 2.0 Authorization Server** in the ADR-001 PKCE flow. Supabase Auth handles user identity; a thin custom layer handles the code exchange:
|
||||
|
||||
1. Local App redirects user to `marketplace.worldwideview.dev/api/oauth/authorize`
|
||||
2. Marketplace validates the Supabase session (or redirects to `worldwideview.dev/login`)
|
||||
3. User sees consent screen and approves
|
||||
4. Marketplace issues a short-lived authorization code (60s TTL), redirects to Local App
|
||||
5. Local App exchanges code + `code_verifier` for a long-lived API Key
|
||||
6. Subsequent plugin connections use the API Key to request 5-minute EdDSA JWTs (ADR-001B)
|
||||
|
||||
This is not a new Supabase feature — it is custom Next.js API routes sitting on top of the existing Supabase Auth session.
|
||||
|
||||
---
|
||||
|
||||
## Consequences
|
||||
|
||||
- **One Supabase project** is a shared dependency across `worldwideview-web`, `worldwideview-marketplace`, and `worldwideview` (Cloud App). A Supabase outage affects all products simultaneously. This is an accepted tradeoff at current scale; the mitigation is Supabase's SLA and free-tier generous limits.
|
||||
- **`worldwideview-web` must run as a Node.js server**, not a static Nginx container. This increases Coolify resource usage marginally but enables all auth functionality.
|
||||
- **Local development requires `mkcert` setup** (one-time, ~5 minutes). This is a deliberate decision to prevent a class of production bugs that cannot be caught with `localhost`.
|
||||
- **The old `cloud-auth-architecture.md` rule is invalidated.** That rule stated `app.worldwideview.dev` owns all login UI and the Marketplace redirects there. The reverse is now true. That rules file must be updated to reference this ADR.
|
||||
- **Upgrade path is clear:** If the Marketplace matures into a platform that third-party developers build against (issuing OAuth tokens to external apps), the existing PKCE layer is extended without changing the user table or Supabase project. The identity layer is already decoupled from the token exchange layer.
|
||||
@@ -0,0 +1,167 @@
|
||||
# ADR-001 Pre-flight Audit — 2026-05-21
|
||||
|
||||
**Auditor:** Claude (ADR-001 Local App workstream) **Branch:** `feat/adr-001-local-app`
|
||||
**Status:** Complete — see gate summary in §6
|
||||
|
||||
This document records the six step-0 checklist items from the master deploy plan
|
||||
(`i-want-you-to-delightful-candle.md`, §"Deploy Order") before any ADR-001 code
|
||||
lands on production.
|
||||
|
||||
---
|
||||
|
||||
## 1. Coolify Env-Var Audit
|
||||
|
||||
Swept every `JWT_*`, `TICKET_*`, `JWKS_*`, and `AUTH_*` variable across the three
|
||||
live services. Values are masked; only presence is recorded.
|
||||
|
||||
### Debris check
|
||||
|
||||
| Service | Coolify resource | `JWT_*` | `TICKET_*` | `JWKS_*` | `AUTH_SECRET` | Decision |
|
||||
|---|---|---|---|---|---|---|
|
||||
| Local App | `worldwideview-demo` | — | — | — | ✓ set | nothing to remove |
|
||||
| Data Engine | `wwv-engine-stack` | — | — | — | — | nothing to remove |
|
||||
| Marketplace | `worldwideview-marketplace` | — | — | — | — | nothing to remove |
|
||||
|
||||
**Result: No debris from the previous failed deploy.** All three services are clean.
|
||||
No removals required.
|
||||
|
||||
### ADR-001 vars — gaps to fill in deploy steps 1–2
|
||||
|
||||
| Service | Missing var | Required by | When to set | Notes |
|
||||
|---|---|---|---|---|
|
||||
| `worldwideview-demo` | `ENCRYPTION_MASTER_KEY` | **C1 hard gate** | **Step 1 — first action** | Without it the app boots but step-1 code will refuse to start |
|
||||
| `worldwideview-demo` | `MARKETPLACE_URL` | C3 ticketClient | Step 1 | Server-side token exchange endpoint |
|
||||
| `worldwideview-demo` | `NEXT_PUBLIC_WWV_MARKETPLACE_URL` | C3/C5 client | Step 1 | Client-side Marketplace link |
|
||||
| `worldwideview-demo` | `PROXY_HOST_ALLOWLIST` | C2 SSRF | Step 1 | Set to `"*"` (observation mode); tighten in step 7c |
|
||||
| `worldwideview-demo` | `NEXT_PUBLIC_WWV_TICKET_AUTH_PLUGINS` | C5 flag | Step 6 | Leave empty (dormant) until step 6 cutover |
|
||||
| `worldwideview-marketplace` | `DATABASE_URL`, `AUTH_SECRET` | A basics | Step 2 | Marketplace cannot function without these |
|
||||
| `worldwideview-marketplace` | EdDSA signing key + JWKS endpoint | A1–A2 | Step 2 | Required for `/api/auth/exchange` to sign tickets |
|
||||
| `wwv-engine-stack` | JWKS / JWT public-key config | B JWKS wiring | Step 4 | See §5 — not blocking until cutover |
|
||||
|
||||
---
|
||||
|
||||
## 2. Data Engine `main` Branch State
|
||||
|
||||
**Repo:** `silvertakana/wwv-data-engine`
|
||||
**Branch audited:** `main` (HEAD matches `feat/adr-001-data-engine`)
|
||||
|
||||
The `main` branch is **not** in a rolled-back clean state. The decentralised auth
|
||||
work from the prior attempt was **retained and fully merged** (PR #5
|
||||
`feature/decentralised-plugin-auth-data-engine`, PR #6 `chore/standardise-ci`), with
|
||||
four additional fix commits on top.
|
||||
|
||||
**Auth code present in `main`:**
|
||||
|
||||
- Dependencies: `@fastify/jwt ^10`, `get-jwks ^11`, `jose ^6`
|
||||
- `websocket.ts` verifies EdDSA JWTs:
|
||||
```
|
||||
allowedIss: 'https://marketplace.worldwideview.dev'
|
||||
algorithms: ['EdDSA']
|
||||
clockTolerance: 60
|
||||
expectedAud: process.env.ENGINE_ID || 'wwv-data-engine'
|
||||
```
|
||||
|
||||
**Env-gated bypass (commit `e3e2940`):**
|
||||
`WWV_SKIP_WS_AUTH=true` is set on `wwv-engine-stack`. When true, every WS connection
|
||||
is pre-authenticated with no JWT required. **This bypass is currently load-bearing:**
|
||||
the JWKS endpoint is not yet wired (`websocket.ts:23` comment confirms), so the
|
||||
engine cannot verify real tokens. `WWV_SKIP_WS_AUTH=true` must stay until Workstream
|
||||
B wires JWKS (deploy step 4).
|
||||
|
||||
**Uncommitted working-tree WIP (not blocking steps 1–3):**
|
||||
`src/server.ts`, `src/websocket.ts`, `src/websocket.spec.ts` modified; untracked
|
||||
`HANDOFF.md`, `src/startup-checks.ts`, `vitest.config.ts`. The Data Engine
|
||||
workstream has unfinished work not yet committed. Must be resolved before step 4.
|
||||
|
||||
---
|
||||
|
||||
## 3. Dormant Routes / Flags Already in Production
|
||||
|
||||
| Flag / Route | Service | Current value | Introduced | Notes |
|
||||
|---|---|---|---|---|
|
||||
| `WWV_SKIP_WS_AUTH` | `wwv-engine-stack` | `true` (load-bearing) | 2026-05-20 | Engine bypass — must stay `true` until JWKS wired (step 4) |
|
||||
|
||||
No other ADR-001 feature flags are active in production. The old no-auth data path
|
||||
is still the only path through the Data Engine.
|
||||
|
||||
---
|
||||
|
||||
## 4. `ENCRYPTION_MASTER_KEY` Gate (C1)
|
||||
|
||||
**Status: FAIL — not set on `worldwideview-demo`**
|
||||
|
||||
The `ENCRYPTION_MASTER_KEY` env var is absent from the live Local App. Once
|
||||
`src/instrumentation.ts` boot validation ships (deploy step 1), the app will
|
||||
**refuse to start** if this var is missing.
|
||||
|
||||
**Action required before deploy step 1:**
|
||||
Generate a 32-character key (`openssl rand -hex 16`) and set `ENCRYPTION_MASTER_KEY`
|
||||
on `worldwideview-demo` in Coolify. This is the **first action of deploy step 1** and
|
||||
blocks all subsequent steps.
|
||||
|
||||
---
|
||||
|
||||
## 5. SDK Delivery Decision (Gate for Workstream B)
|
||||
|
||||
**Status: OPEN — operator to confirm**
|
||||
|
||||
No evidence of a published `@worldwideview/wwv-plugin-sdk` package in the deployed
|
||||
services. The `auth-contracts.ts` types (`TokenExchangeRequest`,
|
||||
`TokenExchangeResponse`, `PluginTicket`, `MarketplaceSessionToken`) currently live in
|
||||
the Local App's bundled SDK package.
|
||||
|
||||
Workstream B JWKS wiring requires a decision on how the engine receives the
|
||||
Marketplace public key:
|
||||
- **Option A:** Ed25519 public key as a Coolify env var (simplest)
|
||||
- **Option B:** Remote JWKS URL env var — engine fetches key from
|
||||
`https://marketplace.worldwideview.dev/.well-known/jwks.json` at startup
|
||||
|
||||
**Cross-repo issuer alignment note:** The engine hard-codes
|
||||
`allowedIss: 'https://marketplace.worldwideview.dev'`. The Local App's `MARKETPLACE_URL`
|
||||
config defaults to `https://app.worldwideview.dev`. Confirm that the live Marketplace
|
||||
issues JWTs with `iss: https://marketplace.worldwideview.dev` before step 5 smoke test.
|
||||
|
||||
This decision must be made and documented before deploy step 4.
|
||||
|
||||
---
|
||||
|
||||
## 6. Gate Summary
|
||||
|
||||
| Gate | Status | Blocks deploy step | Action |
|
||||
|---|---|---|---|
|
||||
| No legacy JWT/TICKET debris | ✅ PASS | — | None |
|
||||
| `ENCRYPTION_MASTER_KEY` set on Local App | ❌ FAIL | **Step 1** | Set as first action of step 1 |
|
||||
| Marketplace configured (DB, auth, signing key) | ❌ FAIL | **Step 2** | Configure `worldwideview-marketplace` in Coolify |
|
||||
| SDK delivery decision confirmed | ⚠️ OPEN | Step 4 | Operator decision needed |
|
||||
| Data Engine JWKS wired | ❌ FAIL | Step 4 / cutover | `WWV_SKIP_WS_AUTH` bypass active until then |
|
||||
| Data Engine WIP committed | ⚠️ OPEN | Step 4 | Not blocking steps 1–3 |
|
||||
| Issuer alignment confirmed | ⚠️ OPEN | Step 5 smoke test | Verify `iss` claim matches engine `allowedIss` |
|
||||
|
||||
**Top pre-cutover risks:**
|
||||
|
||||
1. **JWKS not wired on the engine** — `WWV_SKIP_WS_AUTH=true` is the only thing
|
||||
keeping streams alive. If this flag is ever accidentally unset, all WebSocket
|
||||
streams break immediately.
|
||||
2. **Marketplace under-configured** — token exchange will error until step 2 env vars
|
||||
are set. `worldwideview-marketplace` currently has only infra vars (NIXPACKS,
|
||||
REDIS, REGISTRY_PRIVATE_KEY).
|
||||
3. **`ENCRYPTION_MASTER_KEY` missing** — deploy step 1 will trigger a boot refusal
|
||||
if not set first. This is the riskiest item in the pre-cutover phase per the
|
||||
master plan.
|
||||
|
||||
---
|
||||
|
||||
## 7. Cleanup Log
|
||||
|
||||
**Removed this step (2026-05-21):**
|
||||
|
||||
| Resource | Type | UUID | Reason |
|
||||
|---|---|---|---|
|
||||
| `wwv-app-stack` | Coolify service | `h3gtnyotl6b7007hudlfqyf9` | Operator-confirmed deprecated |
|
||||
|
||||
**Remaining cleanup decisions (operator to confirm before step 4):**
|
||||
|
||||
| Resource | Type | UUID | Notes |
|
||||
|---|---|---|---|
|
||||
| `worldwideview web` | Application | `cisr3bruyyvvoeym41dexxa3` | Repo `silvertakana/worldwideview-web`; only REDIS+AISSTREAM vars — appears stale. Verify before removing. |
|
||||
| `wwv-data-engine-legacy` | Application | `sj8519kr561va8ktcdq166hn` | Repo `wwv-data-engine-internal`, branch `master`; appears superseded by `wwv-engine-stack`. Verify before removing. |
|
||||
@@ -0,0 +1,79 @@
|
||||
# ADR-001 Feature Flags
|
||||
|
||||
Single source of truth for all feature flags introduced by
|
||||
[ADR-0001](architecture/decisions/adr-0001-decentralized-plugin-auth-and-ssrf-mitigation.md)
|
||||
(Decentralized Plugin Auth + SSRF Mitigation).
|
||||
|
||||
**Keep the per-environment table current** whenever a flag is set, changed, or
|
||||
removed in Coolify. Drift between staging and production is the primary paper-cut
|
||||
this doc exists to prevent.
|
||||
|
||||
---
|
||||
|
||||
## Flag Inventory
|
||||
|
||||
### 5 Master-Plan Flags
|
||||
|
||||
| Flag | Repo | Default | Meaning |
|
||||
|---|---|---|---|
|
||||
| `NEXT_PUBLIC_WWV_TICKET_AUTH_PLUGINS` | **Local App** | `""` (empty = dormant) | Comma-separated plugin IDs that require WS first-message auth (e.g. `aviation,maritime`). Empty or unset → ticket auth disabled for all plugins. Set *after* Marketplace + Data Engine are deployed (step 6). |
|
||||
| `REQUIRE_TICKET_AUTH` | **Data Engine** | `false` | When `true`, the engine rejects any WS connection that does not present a valid ticket. Global — applies to all plugins. Replaces `WWV_SKIP_WS_AUTH=false` once JWKS is wired (step 7a). |
|
||||
| `REQUIRE_TICKET_AUTH_PLUGINS` | **Data Engine** | `""` | Comma-separated plugin IDs for per-plugin enforcement before enabling the global flag. Not yet implemented (see Divergence Note below). |
|
||||
| `ENFORCE_ORIGIN_ALLOWLIST` | **Data Engine** | `false` | When `true`, the engine rejects connections from Origins not in its configured allowlist. Enable after populating the allowlist from observed traffic (step 7b). |
|
||||
| `PROXY_HOST_ALLOWLIST` | **Local App** | `""` (deny all) | SSRF allowlist for the camera / iframe proxy route. `""` or unset = deny all (safe default). `"*"` = permissive + logs WARN per host (observation mode). Comma-separated list = explicit allowlist. Ship `"*"` initially; tighten to an explicit list after one week of log observation (step 7c). |
|
||||
|
||||
### Deployed Reality: `WWV_SKIP_WS_AUTH`
|
||||
|
||||
> **Divergence note:** The Data Engine workstream implemented a single global bypass
|
||||
> flag (`WWV_SKIP_WS_AUTH`) instead of the three granular master-plan flags
|
||||
> (`REQUIRE_TICKET_AUTH`, `REQUIRE_TICKET_AUTH_PLUGINS`, `ENFORCE_ORIGIN_ALLOWLIST`).
|
||||
> The master-plan flags remain the target architecture and must be implemented before
|
||||
> step 7. `WWV_SKIP_WS_AUTH` is the current interim control.
|
||||
|
||||
| Flag | Repo | Default | Meaning |
|
||||
|---|---|---|---|
|
||||
| `WWV_SKIP_WS_AUTH` | **Data Engine** | `false` | When `true`, every WS connection is pre-authenticated — no JWT is checked. **Currently `true` in production and load-bearing** (JWKS not yet wired; the engine cannot verify real tokens). Must stay `true` until deploy step 4 wires JWKS. Flip to `false` as part of step 5 smoke test, replacing it with `REQUIRE_TICKET_AUTH=true`. |
|
||||
|
||||
---
|
||||
|
||||
## Per-Environment Table
|
||||
|
||||
Update this table whenever a flag changes in Coolify.
|
||||
|
||||
| Flag | Local dev | Staging | Production | Last updated |
|
||||
|---|---|---|---|---|
|
||||
| `NEXT_PUBLIC_WWV_TICKET_AUTH_PLUGINS` | `""` (.env.example) | `""` (not set) | `""` (not set) | 2026-05-21 |
|
||||
| `REQUIRE_TICKET_AUTH` | N/A | N/A | N/A (not yet implemented) | — |
|
||||
| `REQUIRE_TICKET_AUTH_PLUGINS` | N/A | N/A | N/A (not yet implemented) | — |
|
||||
| `ENFORCE_ORIGIN_ALLOWLIST` | N/A | N/A | N/A (not yet implemented) | — |
|
||||
| `PROXY_HOST_ALLOWLIST` | `"*"` (.env.example) | TBD — set before step 5 | not set (= deny all) | 2026-05-21 |
|
||||
| `WWV_SKIP_WS_AUTH` | `false` | TBD — set before step 4 | `true` (**load-bearing**) | 2026-05-20 |
|
||||
|
||||
---
|
||||
|
||||
## Rollout Sequence
|
||||
|
||||
The sequence in which flags are set during the ADR-001 deploy order:
|
||||
|
||||
| Deploy step | Service | Flag change | Notes |
|
||||
|---|---|---|---|
|
||||
| Step 1 | Local App | Set `PROXY_HOST_ALLOWLIST="*"` | Observation mode — watch WARN logs for one week |
|
||||
| Step 3 | Local App | `NEXT_PUBLIC_WWV_TICKET_AUTH_PLUGINS=""` confirmed empty | Dormant — no change needed, just confirm |
|
||||
| Step 4 | Data Engine | JWKS wired; `WWV_SKIP_WS_AUTH` remains `true` | Both paths exist, neither enforced |
|
||||
| Step 5 (staging) | Local App | `NEXT_PUBLIC_WWV_TICKET_AUTH_PLUGINS=test-synthetic` | Smoke test only — revert after |
|
||||
| Step 5 (staging) | Data Engine | `WWV_SKIP_WS_AUTH=false` | Prove real JWT verification end-to-end |
|
||||
| Step 6 | Local App | `NEXT_PUBLIC_WWV_TICKET_AUTH_PLUGINS=<first-real-plugin>` | One plugin at a time, 24 h soak |
|
||||
| Step 6 | Data Engine | `REQUIRE_TICKET_AUTH_PLUGINS=<same-plugin>` | Mirror Local App change |
|
||||
| Step 7a | Data Engine | `REQUIRE_TICKET_AUTH=true` | Global default-deny; 24 h soak |
|
||||
| Step 7b | Data Engine | `ENFORCE_ORIGIN_ALLOWLIST=true` | After populating allowlist from observed connections |
|
||||
| Step 7c | Local App | `PROXY_HOST_ALLOWLIST=<observed-list>` | Replace `"*"` with explicit host list |
|
||||
|
||||
---
|
||||
|
||||
## Rollback
|
||||
|
||||
Every step is independently revertable by flipping its single flag back. The old
|
||||
no-auth data path remains wired throughout steps 1–6 and is only superseded at
|
||||
step 7a. If anything breaks, removing the plugin from
|
||||
`NEXT_PUBLIC_WWV_TICKET_AUTH_PLUGINS` immediately restores the old path for that
|
||||
plugin.
|
||||
+15
-15
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "worldwideview",
|
||||
"version": "2.15.12",
|
||||
"private": true,
|
||||
"version": "2.18.1",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"packageManager": "[email protected]",
|
||||
"scripts": {
|
||||
@@ -31,8 +31,8 @@
|
||||
"@prisma/adapter-pg": "^7.8.0",
|
||||
"@prisma/client": "^7.8.0",
|
||||
"@prisma/client-runtime-utils": "7.8.0",
|
||||
"@sentry/nextjs": "^10.52.0",
|
||||
"@supabase/supabase-js": "^2.105.4",
|
||||
"@sentry/nextjs": "^10.53.1",
|
||||
"@supabase/supabase-js": "^2.106.0",
|
||||
"@types/pg": "^8.20.0",
|
||||
"@vercel/analytics": "^1.6.1",
|
||||
"@worldwideview/wwv-plugin-sdk": "workspace:*",
|
||||
@@ -42,21 +42,21 @@
|
||||
"hls.js": "^1.6.16",
|
||||
"insecam-api": "^0.0.3",
|
||||
"jose": "^6.2.3",
|
||||
"lucide-react": "^1.14.0",
|
||||
"lucide-react": "^1.16.0",
|
||||
"next": "16.2.6",
|
||||
"next-auth": "^5.0.0-beta.30",
|
||||
"openid-client": "^6.8.4",
|
||||
"pg": "^8.20.0",
|
||||
"pg": "^8.21.0",
|
||||
"prisma": "^7.8.0",
|
||||
"react": "19.2.6",
|
||||
"react-dom": "19.2.6",
|
||||
"react-player": "^3.4.0",
|
||||
"resium": "1.21.0",
|
||||
"satellite.js": "^7.0.0",
|
||||
"resium": "1.21.1",
|
||||
"satellite.js": "^7.0.1",
|
||||
"stripe": "^22.1.1",
|
||||
"tslib": "^2.8.1",
|
||||
"undici": "^8.2.0",
|
||||
"ws": "^8.14.2",
|
||||
"undici": "^8.3.0",
|
||||
"ws": "^8.20.1",
|
||||
"zod": "^4.4.3",
|
||||
"zustand": "^5.0.13"
|
||||
},
|
||||
@@ -74,9 +74,9 @@
|
||||
"@types/react": "^19",
|
||||
"@types/react-dom": "^19",
|
||||
"@types/ws": "^8.18.1",
|
||||
"@typescript-eslint/eslint-plugin": "^8.59.3",
|
||||
"@typescript-eslint/parser": "^8.59.3",
|
||||
"@vitejs/plugin-react": "^5.1.4",
|
||||
"@typescript-eslint/eslint-plugin": "^8.59.4",
|
||||
"@typescript-eslint/parser": "^8.59.4",
|
||||
"@vitejs/plugin-react": "^6.0.2",
|
||||
"@vitest/coverage-v8": "4.1.6",
|
||||
"concurrently": "^9.2.1",
|
||||
"copy-webpack-plugin": "^14.0.0",
|
||||
@@ -92,9 +92,9 @@
|
||||
"jsdom": "^28.1.0",
|
||||
"rollup-plugin-external-globals": "^0.13.0",
|
||||
"tree-kill": "^1.2.2",
|
||||
"tsx": "^4.21.0",
|
||||
"tsx": "^4.22.2",
|
||||
"typescript": "^5",
|
||||
"vite": "^8.0.12",
|
||||
"vite": "^8.0.13",
|
||||
"vitest": "^4.1.6"
|
||||
},
|
||||
"pnpm": {
|
||||
|
||||
@@ -13,11 +13,11 @@
|
||||
"clean": "rm -rf dist"
|
||||
},
|
||||
"dependencies": {
|
||||
"commander": "^12.1.0",
|
||||
"commander": "^14.0.3",
|
||||
"prompts": "^2.4.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^20.0.0",
|
||||
"@types/node": "^25.9.1",
|
||||
"@types/prompts": "^2.4.9",
|
||||
"typescript": "^5.0.0"
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@worldwideview/wwv-lib-incidents",
|
||||
"version": "1.0.2",
|
||||
"version": "1.0.3",
|
||||
"description": "Shared abstract base classes for WorldWideView incident plugins (earthquakes, wildfires, conflicts)",
|
||||
"main": "src/index.ts",
|
||||
"types": "src/index.ts",
|
||||
|
||||
@@ -0,0 +1,354 @@
|
||||
/**
|
||||
* Guard tests for the BaseIncidentPlugin WebSocket payload contract.
|
||||
*
|
||||
* CONTEXT — The bug being guarded against:
|
||||
* WsClient.handleDataMessage (src/core/data/WsClient.ts, lines 166-190) has three branches:
|
||||
* 1. Plugin has `mapWebsocketPayload` → called with raw payload → must return GeoEntity[]
|
||||
* 2. No handler AND payload IS a flat array → used directly (timestamps normalised)
|
||||
* 3. No handler AND payload is ANY OTHER object → silently dropped (console.warn + return)
|
||||
*
|
||||
* BaseIncidentPlugin currently has NO `mapWebsocketPayload`. The canonical data-engine
|
||||
* scheduler wraps snapshots as `{ source, fetchedAt, items, totalCount }` (an object, not
|
||||
* an array), so branch 3 fires for every BaseIncidentPlugin subclass whose seeder uses the
|
||||
* standard scheduler wrapper — including the earthquakes plugin.
|
||||
*
|
||||
* TEST STRATEGY:
|
||||
* - it.fails(...) → asserts the DESIRED post-fix behavior; currently fails → proves the bug.
|
||||
* CI will flip these to green once BaseIncidentPlugin gains mapWebsocketPayload.
|
||||
* - it(...) → asserts current working behaviour that must NOT regress.
|
||||
*/
|
||||
|
||||
import { describe, it, expect } from "vitest";
|
||||
import { BaseIncidentPlugin } from "./index";
|
||||
import type {
|
||||
GeoEntity,
|
||||
TimeRange,
|
||||
ServerPluginConfig,
|
||||
FilterDefinition,
|
||||
PluginCategory,
|
||||
CesiumEntityOptions,
|
||||
} from "@worldwideview/wwv-plugin-sdk";
|
||||
|
||||
// ─── Minimal GeoEntity factory ────────────────────────────────────────────────
|
||||
|
||||
function makeEntity(id: string, overrides: Partial<GeoEntity> = {}): GeoEntity {
|
||||
return {
|
||||
id,
|
||||
pluginId: "test-incident-plugin",
|
||||
latitude: 35.6762,
|
||||
longitude: 139.6503,
|
||||
timestamp: new Date("2025-01-01T00:00:00Z"),
|
||||
properties: {},
|
||||
...overrides,
|
||||
};
|
||||
}
|
||||
|
||||
// ─── Minimal concrete subclass ────────────────────────────────────────────────
|
||||
// We keep it as bare-bones as possible — only the abstract members required to
|
||||
// instantiate the class. We do NOT add mapWebsocketPayload here, so we're testing
|
||||
// the BaseIncidentPlugin base behaviour exactly.
|
||||
|
||||
class MinimalIncidentPlugin extends BaseIncidentPlugin {
|
||||
id = "test-incident-plugin";
|
||||
name = "Test Incident Plugin";
|
||||
description = "Test";
|
||||
icon = null;
|
||||
category: PluginCategory = "natural-disaster";
|
||||
version = "0.0.1";
|
||||
|
||||
async fetch(_timeRange: TimeRange): Promise<GeoEntity[]> {
|
||||
return [];
|
||||
}
|
||||
|
||||
getServerConfig(): ServerPluginConfig {
|
||||
return {
|
||||
apiBasePath: "/api/test-incident-plugin",
|
||||
streamUrl: "ws://localhost:5001/stream",
|
||||
pollingIntervalMs: 0,
|
||||
};
|
||||
}
|
||||
|
||||
getFilterDefinitions(): FilterDefinition[] {
|
||||
return [];
|
||||
}
|
||||
|
||||
getLegend(): { label: string; color: string; filterId?: string; filterValue?: string }[] {
|
||||
return [];
|
||||
}
|
||||
|
||||
protected getSeverityValue(_entity: GeoEntity): number {
|
||||
return 0;
|
||||
}
|
||||
|
||||
protected getSeverityColor(_value: number): string {
|
||||
return "#ef4444";
|
||||
}
|
||||
|
||||
protected getSeveritySize(_value: number): number {
|
||||
return 10;
|
||||
}
|
||||
}
|
||||
|
||||
// ─── Subclass that DOES override mapWebsocketPayload ─────────────────────────
|
||||
|
||||
const FIXED_ENTITIES = [makeEntity("override-1"), makeEntity("override-2")];
|
||||
|
||||
class OverridingIncidentPlugin extends MinimalIncidentPlugin {
|
||||
id = "overriding-incident-plugin";
|
||||
|
||||
mapWebsocketPayload(_payload: unknown, _existingEntities?: GeoEntity[]): GeoEntity[] {
|
||||
return FIXED_ENTITIES;
|
||||
}
|
||||
}
|
||||
|
||||
// ─── Helpers that mimic WsClient.handleDataMessage branching logic ────────────
|
||||
// We test the plugin method in isolation (unit test), not the full WsClient,
|
||||
// because WsClient has DOM/Zustand/DataBus dependencies. This mirrors the exact
|
||||
// logic from WsClient lines 172-182.
|
||||
|
||||
function simulateWsClientDispatch(
|
||||
plugin: BaseIncidentPlugin,
|
||||
rawPayload: unknown
|
||||
): GeoEntity[] | null {
|
||||
if (typeof (plugin as any).mapWebsocketPayload === "function") {
|
||||
return (plugin as any).mapWebsocketPayload(rawPayload, []);
|
||||
}
|
||||
if (!Array.isArray(rawPayload)) {
|
||||
// This is the silent-drop branch — return null to signal "dropped"
|
||||
return null;
|
||||
}
|
||||
return (rawPayload as GeoEntity[]).map((e) => ({
|
||||
...e,
|
||||
timestamp: new Date(e.timestamp || Date.now()),
|
||||
}));
|
||||
}
|
||||
|
||||
// ─── Test suite ───────────────────────────────────────────────────────────────
|
||||
|
||||
describe("BaseIncidentPlugin — WebSocket payload contract", () => {
|
||||
|
||||
describe("scheduler-wrapped payload { source, fetchedAt, items, totalCount }", () => {
|
||||
/**
|
||||
* DESIRED behavior: BaseIncidentPlugin.mapWebsocketPayload should unwrap the
|
||||
* canonical scheduler envelope and return the items array as GeoEntity[].
|
||||
*
|
||||
* CURRENT state: the method does not exist on BaseIncidentPlugin, so
|
||||
* simulateWsClientDispatch returns null (silent drop) instead of the items.
|
||||
*
|
||||
* This test is marked it.fails so CI proves the bug today and will automatically
|
||||
* turn green once the fix is landed.
|
||||
*/
|
||||
it.fails(
|
||||
"unwraps { source, fetchedAt, items, totalCount } and returns items as GeoEntity[] " +
|
||||
"(CURRENTLY FAILS — BaseIncidentPlugin has no mapWebsocketPayload)",
|
||||
() => {
|
||||
const plugin = new MinimalIncidentPlugin();
|
||||
const entity1 = makeEntity("eq-1");
|
||||
const entity2 = makeEntity("eq-2");
|
||||
|
||||
const wrappedPayload = {
|
||||
source: "usgs-earthquake-feed",
|
||||
fetchedAt: "2025-01-01T00:00:00Z",
|
||||
items: [entity1, entity2],
|
||||
totalCount: 2,
|
||||
};
|
||||
|
||||
// After the fix: mapWebsocketPayload should exist and return both entities
|
||||
const result = simulateWsClientDispatch(plugin, wrappedPayload);
|
||||
|
||||
expect(result).not.toBeNull();
|
||||
expect(Array.isArray(result)).toBe(true);
|
||||
expect(result).toHaveLength(2);
|
||||
expect(result![0].id).toBe("eq-1");
|
||||
expect(result![1].id).toBe("eq-2");
|
||||
}
|
||||
);
|
||||
|
||||
/**
|
||||
* Documents the CURRENT broken behaviour explicitly.
|
||||
* When the fix lands, this test should be DELETED (the positive assertion above replaces it).
|
||||
*/
|
||||
it(
|
||||
"currently drops the wrapped payload silently (returns null) because mapWebsocketPayload is absent",
|
||||
() => {
|
||||
const plugin = new MinimalIncidentPlugin();
|
||||
const wrappedPayload = {
|
||||
source: "usgs-earthquake-feed",
|
||||
fetchedAt: "2025-01-01T00:00:00Z",
|
||||
items: [makeEntity("eq-1")],
|
||||
totalCount: 1,
|
||||
};
|
||||
|
||||
// simulateWsClientDispatch returns null to represent the silent drop
|
||||
const result = simulateWsClientDispatch(plugin, wrappedPayload);
|
||||
expect(result).toBeNull();
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
describe("flat GeoEntity[] payload", () => {
|
||||
/**
|
||||
* Flat arrays bypass mapWebsocketPayload entirely in WsClient — they work today.
|
||||
* This test MUST stay green before and after the fix.
|
||||
*/
|
||||
it("passes flat GeoEntity[] through unchanged (current working behaviour)", () => {
|
||||
const plugin = new MinimalIncidentPlugin();
|
||||
const entities = [makeEntity("eq-flat-1"), makeEntity("eq-flat-2")];
|
||||
|
||||
const result = simulateWsClientDispatch(plugin, entities);
|
||||
|
||||
expect(result).not.toBeNull();
|
||||
expect(result).toHaveLength(2);
|
||||
expect(result![0].id).toBe("eq-flat-1");
|
||||
expect(result![1].id).toBe("eq-flat-2");
|
||||
});
|
||||
|
||||
it("normalises timestamp strings to Date objects for flat array payloads", () => {
|
||||
const plugin = new MinimalIncidentPlugin();
|
||||
const raw = [{
|
||||
...makeEntity("eq-ts-1"),
|
||||
// Simulate a timestamp that arrives over the wire as a string
|
||||
timestamp: "2025-06-01T12:00:00Z" as unknown as Date,
|
||||
}];
|
||||
|
||||
const result = simulateWsClientDispatch(plugin, raw);
|
||||
|
||||
expect(result).not.toBeNull();
|
||||
expect(result![0].timestamp).toBeInstanceOf(Date);
|
||||
});
|
||||
});
|
||||
|
||||
describe("GeoJSON { features: [...] } payload", () => {
|
||||
/**
|
||||
* DESIRED behavior: BaseIncidentPlugin.mapWebsocketPayload should normalise a
|
||||
* GeoJSON FeatureCollection envelope into a GeoEntity[].
|
||||
*
|
||||
* CURRENT state: no mapWebsocketPayload → silent drop (null).
|
||||
*
|
||||
* Marked it.fails for the same reason as the scheduler-wrapped test.
|
||||
*/
|
||||
it.fails(
|
||||
"normalises a GeoJSON FeatureCollection into GeoEntity[] " +
|
||||
"(CURRENTLY FAILS — BaseIncidentPlugin has no mapWebsocketPayload)",
|
||||
() => {
|
||||
const plugin = new MinimalIncidentPlugin();
|
||||
|
||||
const geojsonPayload = {
|
||||
type: "FeatureCollection",
|
||||
features: [
|
||||
{
|
||||
type: "Feature",
|
||||
geometry: { type: "Point", coordinates: [139.65, 35.68] },
|
||||
properties: { id: "gj-1", magnitude: 4.5 },
|
||||
},
|
||||
{
|
||||
type: "Feature",
|
||||
geometry: { type: "Point", coordinates: [135.50, 34.69] },
|
||||
properties: { id: "gj-2", magnitude: 3.1 },
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
const result = simulateWsClientDispatch(plugin, geojsonPayload);
|
||||
|
||||
expect(result).not.toBeNull();
|
||||
expect(Array.isArray(result)).toBe(true);
|
||||
expect(result).toHaveLength(2);
|
||||
// Each feature should have been converted to a GeoEntity with lat/lon
|
||||
expect(result![0].latitude).toBeCloseTo(35.68, 2);
|
||||
expect(result![0].longitude).toBeCloseTo(139.65, 2);
|
||||
}
|
||||
);
|
||||
|
||||
it(
|
||||
"currently drops a GeoJSON FeatureCollection silently because mapWebsocketPayload is absent",
|
||||
() => {
|
||||
const plugin = new MinimalIncidentPlugin();
|
||||
|
||||
const geojsonPayload = {
|
||||
type: "FeatureCollection",
|
||||
features: [
|
||||
{
|
||||
type: "Feature",
|
||||
geometry: { type: "Point", coordinates: [139.65, 35.68] },
|
||||
properties: {},
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
const result = simulateWsClientDispatch(plugin, geojsonPayload);
|
||||
expect(result).toBeNull();
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
describe("subclass override of mapWebsocketPayload", () => {
|
||||
/**
|
||||
* A subclass that implements mapWebsocketPayload is handled correctly TODAY.
|
||||
* This covers the "conflict-events" / "iranwarlive" pattern and must stay green.
|
||||
*/
|
||||
it("calls the subclass override and returns its result regardless of payload shape", () => {
|
||||
const plugin = new OverridingIncidentPlugin();
|
||||
|
||||
// Even if the payload is an object (which would normally be dropped), the
|
||||
// subclass override is respected.
|
||||
const wrappedPayload = {
|
||||
source: "conflict-api",
|
||||
fetchedAt: "2025-01-01T00:00:00Z",
|
||||
items: [makeEntity("conflict-1")],
|
||||
totalCount: 1,
|
||||
};
|
||||
|
||||
const result = simulateWsClientDispatch(plugin, wrappedPayload);
|
||||
|
||||
// Should return the overriding subclass's fixed result, not the raw items
|
||||
expect(result).toStrictEqual(FIXED_ENTITIES);
|
||||
});
|
||||
|
||||
it("override is also called for flat array payloads, taking precedence over default handling", () => {
|
||||
const plugin = new OverridingIncidentPlugin();
|
||||
const flatPayload = [makeEntity("flat-1"), makeEntity("flat-2"), makeEntity("flat-3")];
|
||||
|
||||
const result = simulateWsClientDispatch(plugin, flatPayload);
|
||||
|
||||
// The override always wins — result is FIXED_ENTITIES, not the 3-element flat array
|
||||
expect(result).toStrictEqual(FIXED_ENTITIES);
|
||||
expect(result).toHaveLength(2);
|
||||
});
|
||||
});
|
||||
|
||||
describe("BaseIncidentPlugin structural contract", () => {
|
||||
/**
|
||||
* Confirm mapWebsocketPayload is NOT present on BaseIncidentPlugin today.
|
||||
* This is the definitive proof of the bug — once the fix is added, this test
|
||||
* should be updated (or removed) alongside the it.fails tests above.
|
||||
*/
|
||||
it("does NOT have mapWebsocketPayload defined (confirms the bug exists)", () => {
|
||||
const plugin = new MinimalIncidentPlugin();
|
||||
expect(typeof (plugin as any).mapWebsocketPayload).toBe("undefined");
|
||||
});
|
||||
|
||||
it("implements the required WorldPlugin lifecycle methods", () => {
|
||||
const plugin = new MinimalIncidentPlugin();
|
||||
expect(typeof plugin.initialize).toBe("function");
|
||||
expect(typeof plugin.destroy).toBe("function");
|
||||
expect(typeof plugin.fetch).toBe("function");
|
||||
expect(typeof plugin.getPollingInterval).toBe("function");
|
||||
expect(typeof plugin.getLayerConfig).toBe("function");
|
||||
expect(typeof plugin.renderEntity).toBe("function");
|
||||
});
|
||||
|
||||
it("returns polling interval of 0 (WebSocket-only mode)", () => {
|
||||
const plugin = new MinimalIncidentPlugin();
|
||||
expect(plugin.getPollingInterval()).toBe(0);
|
||||
});
|
||||
|
||||
it("returns default layer config with clustering enabled", () => {
|
||||
const plugin = new MinimalIncidentPlugin();
|
||||
const config = plugin.getLayerConfig();
|
||||
expect(config.clusterEnabled).toBe(true);
|
||||
expect(config.color).toBe("#ef4444");
|
||||
expect(typeof config.clusterDistance).toBe("number");
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -1,10 +1,11 @@
|
||||
|
||||
import { describe, it, expectTypeOf } from "vitest";
|
||||
import type {
|
||||
TokenExchangeRequest,
|
||||
TokenExchangeResponse,
|
||||
import type {
|
||||
TokenExchangeRequest,
|
||||
TokenExchangeResponse,
|
||||
WebSocketAuthMessage,
|
||||
SensitiveString,
|
||||
PluginTicket,
|
||||
Tier,
|
||||
PKCEConnectRequest,
|
||||
PKCETokenExchange,
|
||||
@@ -40,7 +41,7 @@ describe("Auth Contracts", () => {
|
||||
it("WebSocketAuthMessage has exact required properties including protocol version", () => {
|
||||
expectTypeOf<WebSocketAuthMessage>().toHaveProperty("type").toEqualTypeOf<"auth">();
|
||||
expectTypeOf<WebSocketAuthMessage>().toHaveProperty("v").toEqualTypeOf<1>();
|
||||
expectTypeOf<WebSocketAuthMessage>().toHaveProperty("token").toEqualTypeOf<SensitiveString>();
|
||||
expectTypeOf<WebSocketAuthMessage>().toHaveProperty("token").toEqualTypeOf<PluginTicket>();
|
||||
|
||||
// @ts-expect-error - missing version
|
||||
const _badMsg: WebSocketAuthMessage = { type: "auth", token: "jwt-token-here" as SensitiveString };
|
||||
|
||||
@@ -8,6 +8,12 @@
|
||||
*/
|
||||
export type SensitiveString = string & { readonly __brand: "SensitiveString" };
|
||||
|
||||
/** Marketplace session JWT issued after PKCE; scoped to this Local App only. */
|
||||
export type MarketplaceSessionToken = string & { readonly __brand: "marketplace-session" };
|
||||
|
||||
/** Short-lived, audience-bound JWT obtained from token exchange; used for WebSocket auth. */
|
||||
export type PluginTicket = string & { readonly __brand: "plugin-ticket" };
|
||||
|
||||
/**
|
||||
* Factory function to safely cast a string to a SensitiveString.
|
||||
* This provides a single grep target for every place a secret enters the system.
|
||||
@@ -66,7 +72,7 @@ export interface WebSocketAuthMessage {
|
||||
/** Protocol version to allow future wire shape evolution */
|
||||
v: 1;
|
||||
/** The short-lived JWT obtained from the Token Exchange */
|
||||
token: SensitiveString;
|
||||
token: PluginTicket;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -41,9 +41,15 @@ export default defineConfig({
|
||||
},
|
||||
{
|
||||
name: 'firefox',
|
||||
use: {
|
||||
use: {
|
||||
...devices['Desktop Firefox'],
|
||||
storageState: 'playwright/.auth/user.json'
|
||||
storageState: 'playwright/.auth/user.json',
|
||||
launchOptions: {
|
||||
firefoxUserPrefs: {
|
||||
// Disable MSAA/AT-SPI accessibility layer — causes hangs on Linux CI
|
||||
'accessibility.force_disabled': 1,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
|
||||
Generated
+728
-1591
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,390 @@
|
||||
#!/usr/bin/env node
|
||||
// gc-scan.mjs — deterministic garbage detection for the GC bot
|
||||
// Zero npm dependencies. Emits gc-findings.json consumed by the garbage-collector agent.
|
||||
//
|
||||
// Usage: node scripts/gc-scan.mjs [--out <path>] [--days-branch=90] [--days-comment=180]
|
||||
|
||||
import { execSync } from 'node:child_process';
|
||||
import { writeFileSync, readFileSync, existsSync } from 'node:fs';
|
||||
import { join, resolve, relative } from 'node:path';
|
||||
|
||||
const ROOT = process.cwd();
|
||||
|
||||
// Parse CLI args: --out <path>, --days-branch=N, --days-comment=N
|
||||
const ARGS = Object.fromEntries(
|
||||
process.argv.slice(2).flatMap(a => {
|
||||
const m = a.match(/^--([\w-]+)=(.+)$/);
|
||||
return m ? [[m[1], m[2]]] : [];
|
||||
})
|
||||
);
|
||||
const outIdx = process.argv.indexOf('--out');
|
||||
const OUT = outIdx !== -1 ? process.argv[outIdx + 1] : (ARGS['out'] ?? 'gc-findings.json');
|
||||
const STALE_BRANCH_DAYS = Number(ARGS['days-branch'] ?? 90);
|
||||
const STALE_COMMENT_DAYS = Number(ARGS['days-comment'] ?? 180);
|
||||
|
||||
/** @type {Array<Record<string, unknown>>} */
|
||||
const findings = [];
|
||||
|
||||
function run(cmd) {
|
||||
try {
|
||||
return execSync(cmd, { encoding: 'utf8', cwd: ROOT, stdio: ['pipe', 'pipe', 'pipe'] }).trim();
|
||||
} catch {
|
||||
return '';
|
||||
}
|
||||
}
|
||||
|
||||
function add(finding) {
|
||||
findings.push(finding);
|
||||
}
|
||||
|
||||
function daysAgo(isoDate) {
|
||||
if (!isoDate) return Infinity;
|
||||
return (Date.now() - new Date(isoDate).getTime()) / 86_400_000;
|
||||
}
|
||||
|
||||
// ─── Detector 1: Stale branches ──────────────────────────────────────────────
|
||||
function detectStaleBranches() {
|
||||
const out = run(
|
||||
'git for-each-ref --sort=committerdate refs/remotes/origin ' +
|
||||
'--format=%(refname:short)|%(committerdate:iso8601)|%(authorname)|%(subject)'
|
||||
);
|
||||
for (const line of out.split('\n').filter(Boolean)) {
|
||||
const [ref, date, author, subject] = line.split('|');
|
||||
const branch = ref.replace('origin/', '');
|
||||
if (['HEAD', 'main', 'master', 'develop'].includes(branch)) continue;
|
||||
const age = daysAgo(date);
|
||||
if (age < STALE_BRANCH_DAYS) continue;
|
||||
const mergeBase = run(`git merge-base origin/main "${ref}" 2>/dev/null`);
|
||||
const branchHead = run(`git rev-parse "${ref}"`);
|
||||
const isMerged = mergeBase === branchHead;
|
||||
add({
|
||||
type: 'stale-branch',
|
||||
tier: 'B',
|
||||
branch,
|
||||
author,
|
||||
lastCommitDate: date?.trim(),
|
||||
ageDays: Math.floor(age),
|
||||
isMerged,
|
||||
lastSubject: subject,
|
||||
description: `Branch '${branch}' is ${Math.floor(age)} days old${isMerged ? ' and fully merged into main — safe to delete' : ' with no recent activity'}`,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
// ─── Detector 2: Stale TODO/FIXME/HACK comments ──────────────────────────────
|
||||
function detectStaleTodos() {
|
||||
const raw = run(
|
||||
'git grep -rn --fixed-strings -e "TODO" -e "FIXME" -e "HACK" -e "XXX" ' +
|
||||
'-- "*.ts" "*.tsx" "*.mjs" "*.js"'
|
||||
);
|
||||
if (!raw) return;
|
||||
|
||||
// Cap at 40 matches to keep git blame calls fast on large repos
|
||||
const lines = raw.split('\n').filter(Boolean).slice(0, 40);
|
||||
|
||||
for (const line of lines) {
|
||||
const firstColon = line.indexOf(':');
|
||||
if (firstColon === -1) continue;
|
||||
const afterFile = line.slice(firstColon + 1);
|
||||
const secondColon = afterFile.indexOf(':');
|
||||
if (secondColon === -1) continue;
|
||||
|
||||
const file = line.slice(0, firstColon);
|
||||
const lineNum = afterFile.slice(0, secondColon);
|
||||
const content = afterFile.slice(secondColon + 1).trim();
|
||||
|
||||
if (file.startsWith('node_modules/') || file.includes('public/cesium')) continue;
|
||||
|
||||
const blameOut = run(`git blame -L ${lineNum},${lineNum} --porcelain "${file}"`);
|
||||
const timeMatch = blameOut.match(/^author-time (\d+)/m);
|
||||
if (!timeMatch) continue;
|
||||
|
||||
const ageInDays = (Date.now() - parseInt(timeMatch[1], 10) * 1000) / 86_400_000;
|
||||
if (ageInDays < STALE_COMMENT_DAYS) continue;
|
||||
|
||||
const issueMatch = content.match(/#(\d+)/);
|
||||
let issueClosed = false;
|
||||
if (issueMatch) {
|
||||
const state = run(`gh issue view ${issueMatch[1]} --json state -q .state 2>/dev/null`);
|
||||
issueClosed = state.toUpperCase() === 'CLOSED';
|
||||
}
|
||||
|
||||
add({
|
||||
type: 'stale-todo',
|
||||
tier: 'A',
|
||||
file,
|
||||
line: parseInt(lineNum, 10),
|
||||
content: content.slice(0, 200),
|
||||
ageInDays: Math.round(ageInDays),
|
||||
issueClosed,
|
||||
linkedIssue: issueMatch ? issueMatch[1] : null,
|
||||
description: issueClosed
|
||||
? `TODO references closed issue #${issueMatch[1]} (${Math.round(ageInDays)}d old) — safe to delete`
|
||||
: `TODO/comment is ${Math.round(ageInDays)} days old — review and resolve or delete`,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
// ─── Detector 3: Known anti-patterns ─────────────────────────────────────────
|
||||
const ANTI_PATTERNS = [
|
||||
{
|
||||
id: 'mdc-ref',
|
||||
tier: 'A',
|
||||
globs: ['*.ts', '*.tsx', '*.md', '*.mjs'],
|
||||
pattern: '\\.mdc',
|
||||
desc: '.mdc file reference — must be .md (project invariant: never .mdc files)',
|
||||
},
|
||||
{
|
||||
id: 'console-log',
|
||||
tier: 'A',
|
||||
globs: ['*.ts', '*.tsx'],
|
||||
pattern: 'console\\.log(',
|
||||
excludePrefix: 'scripts/',
|
||||
desc: 'stray console.log — remove or replace with structured logging',
|
||||
},
|
||||
{
|
||||
id: 'ts-ignore',
|
||||
tier: 'A',
|
||||
globs: ['*.ts', '*.tsx'],
|
||||
pattern: '@ts-ignore',
|
||||
desc: '@ts-ignore suppresses real type errors — remove and fix the underlying type',
|
||||
},
|
||||
{
|
||||
id: 'ts-nocheck',
|
||||
tier: 'A',
|
||||
globs: ['*.ts', '*.tsx'],
|
||||
pattern: '@ts-nocheck',
|
||||
desc: '@ts-nocheck disables all type checking for the file — remove and fix types',
|
||||
},
|
||||
{
|
||||
id: 'hardcoded-url',
|
||||
tier: 'B',
|
||||
globs: ['*.ts', '*.tsx'],
|
||||
pattern: 'localhost:500',
|
||||
excludePrefix: 'scripts/',
|
||||
desc: 'hardcoded engine URL (localhost:5001/5000) — use env var or plugin streamUrl instead',
|
||||
},
|
||||
{
|
||||
id: 'deprecated',
|
||||
tier: 'B',
|
||||
globs: ['*.ts', '*.tsx'],
|
||||
pattern: '@deprecated',
|
||||
desc: '@deprecated JSDoc on a symbol — audit whether all callers have migrated',
|
||||
},
|
||||
];
|
||||
|
||||
function detectAntiPatterns() {
|
||||
for (const { id, tier, globs, pattern, desc, excludePrefix } of ANTI_PATTERNS) {
|
||||
const globArgs = globs.map(g => `"${g}"`).join(' ');
|
||||
const raw = run(`git grep -En "${pattern}" -- ${globArgs}`);
|
||||
if (!raw) continue;
|
||||
|
||||
const hits = raw
|
||||
.split('\n')
|
||||
.filter(l => l && !(excludePrefix && l.startsWith(excludePrefix)))
|
||||
.slice(0, 15);
|
||||
|
||||
for (const line of hits) {
|
||||
const m = line.match(/^([^:]+):(\d+):(.*)/);
|
||||
if (!m) continue;
|
||||
if (m[1].startsWith('node_modules/') || m[1].includes('public/cesium')) continue;
|
||||
add({
|
||||
type: 'anti-pattern',
|
||||
patternId: id,
|
||||
tier,
|
||||
file: m[1],
|
||||
line: parseInt(m[2], 10),
|
||||
content: m[3].trim().slice(0, 200),
|
||||
description: desc,
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ─── Detector 4: Oversized source files ──────────────────────────────────────
|
||||
function detectOversizedFiles() {
|
||||
const fileList = run('git ls-files "*.ts" "*.tsx"').split('\n').filter(Boolean);
|
||||
for (const file of fileList) {
|
||||
if (file.startsWith('node_modules/') || file.includes('public/cesium') || file.includes('.next/')) continue;
|
||||
const fullPath = join(ROOT, file);
|
||||
if (!existsSync(fullPath)) continue;
|
||||
const lineCount = readFileSync(fullPath, 'utf8').split('\n').length;
|
||||
if (lineCount > 350) {
|
||||
add({
|
||||
type: 'oversized-file',
|
||||
tier: 'B',
|
||||
file,
|
||||
lines: lineCount,
|
||||
description: `${lineCount} lines exceeds ~300-line convention — extract helpers, split component, or use hooks`,
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ─── Detector 5: Orphaned rule file references ───────────────────────────────
|
||||
function detectOrphanedRuleRefs() {
|
||||
const ruleFiles = run('git ls-files ".agents/rules/"').split('\n').filter(f => f.endsWith('.md'));
|
||||
for (const ruleFile of ruleFiles) {
|
||||
const fullPath = join(ROOT, ruleFile);
|
||||
if (!existsSync(fullPath)) continue;
|
||||
const content = readFileSync(fullPath, 'utf8');
|
||||
const seen = new Set();
|
||||
for (const [, ref] of content.matchAll(
|
||||
/`((?:src|packages|local-plugins|local-seeders|\.agents)\/[^`\s]+)`/g
|
||||
)) {
|
||||
const base = ref.replace(/\/\*\*.*/, '').replace(/\/\*.*/, '').replace(/\{[^}]+\}.*/, '');
|
||||
if (!base || seen.has(base)) continue;
|
||||
seen.add(base);
|
||||
const tracked = run(`git ls-files "${base}" "${base}/" 2>/dev/null`);
|
||||
if (!tracked && !existsSync(join(ROOT, base))) {
|
||||
add({
|
||||
type: 'orphaned-rule-ref',
|
||||
tier: 'B',
|
||||
file: ruleFile,
|
||||
ref: base,
|
||||
description: `Rule file references '${base}' which no longer exists — update or remove`,
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ─── Detector 6: Orphaned workspace packages ─────────────────────────────────
|
||||
function detectOrphanedPackages() {
|
||||
try {
|
||||
const wsInfo = run('pnpm list --recursive --depth=0 --json 2>/dev/null');
|
||||
if (!wsInfo) return;
|
||||
const pkgs = JSON.parse(wsInfo);
|
||||
const allNames = new Set(pkgs.map(p => p.name).filter(Boolean));
|
||||
const reverseDepCount = Object.fromEntries([...allNames].map(n => [n, 0]));
|
||||
for (const pkg of pkgs) {
|
||||
for (const dep of Object.keys({ ...pkg.dependencies, ...pkg.devDependencies })) {
|
||||
if (reverseDepCount[dep] !== undefined) reverseDepCount[dep]++;
|
||||
}
|
||||
}
|
||||
for (const [name, count] of Object.entries(reverseDepCount)) {
|
||||
const pkg = pkgs.find(p => p.name === name);
|
||||
if (!pkg?.path?.includes('/packages/')) continue;
|
||||
if (count === 0) {
|
||||
add({
|
||||
type: 'orphaned-package',
|
||||
tier: 'B',
|
||||
name,
|
||||
path: relative(ROOT, pkg.path),
|
||||
description: `Workspace package '${name}' has no reverse dependencies inside the monorepo — consider removing`,
|
||||
});
|
||||
}
|
||||
}
|
||||
} catch { /* skip if pnpm unavailable */ }
|
||||
}
|
||||
|
||||
// ─── Detector 7: Old Prisma migrations ───────────────────────────────────────
|
||||
function detectOldMigrations() {
|
||||
const migrationsDir = resolve(ROOT, 'prisma/migrations');
|
||||
if (!existsSync(migrationsDir)) return;
|
||||
const dirs = run(`ls -1 "${migrationsDir}"`).split('\n').filter(Boolean);
|
||||
for (const dir of dirs) {
|
||||
const sqlFile = `prisma/migrations/${dir}/migration.sql`;
|
||||
const lastTouch = run(`git log -1 --format=%ci -- "${sqlFile}"`);
|
||||
if (!lastTouch) continue;
|
||||
const age = daysAgo(lastTouch);
|
||||
if (age < 365) continue;
|
||||
add({
|
||||
type: 'old-migration',
|
||||
tier: 'B',
|
||||
migration: dir,
|
||||
ageDays: Math.floor(age),
|
||||
lastTouched: lastTouch.trim(),
|
||||
description: `Migration '${dir}' is ${Math.floor(age)} days old — verify it is still actively needed`,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
// ─── Detector 8: Outdated dependencies ───────────────────────────────────────
|
||||
function detectOutdatedDeps() {
|
||||
if (!existsSync(join(ROOT, 'package.json'))) return;
|
||||
const raw = run('pnpm outdated --no-color 2>/dev/null || true');
|
||||
if (!raw) return;
|
||||
const dataLines = raw
|
||||
.split('\n')
|
||||
.filter(l => l.trim() && !l.startsWith('Package') && !l.startsWith('Legend') && !l.startsWith(' '));
|
||||
for (const line of dataLines.slice(0, 12)) {
|
||||
const cols = line.trim().split(/\s+/);
|
||||
if (cols.length < 3) continue;
|
||||
const [pkg, current, latest] = cols;
|
||||
if (!pkg || !current || !latest || current === latest) continue;
|
||||
const isMajor = current.replace(/^[^0-9]*/, '').split('.')[0] !== latest.replace(/^[^0-9]*/, '').split('.')[0];
|
||||
add({
|
||||
type: 'outdated-dep',
|
||||
tier: 'B',
|
||||
package: pkg,
|
||||
current,
|
||||
latest,
|
||||
isMajor,
|
||||
description: `${pkg}: ${current} → ${latest}${isMajor ? ' ⚠ MAJOR bump — review breaking changes before upgrading' : ''}`,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
// ─── Run all detectors ────────────────────────────────────────────────────────
|
||||
console.log('WorldWideView GC Scan');
|
||||
console.log(`Repo: ${run('git remote get-url origin') || ROOT}`);
|
||||
console.log(`Commit: ${run('git rev-parse --short HEAD') || 'unknown'}`);
|
||||
console.log(`Thresholds: branch=${STALE_BRANCH_DAYS}d comment=${STALE_COMMENT_DAYS}d`);
|
||||
console.log('');
|
||||
|
||||
detectStaleBranches();
|
||||
console.log(` stale-branch ${findings.filter(f => f.type === 'stale-branch').length}`);
|
||||
|
||||
detectStaleTodos();
|
||||
console.log(` stale-todo ${findings.filter(f => f.type === 'stale-todo').length}`);
|
||||
|
||||
detectAntiPatterns();
|
||||
console.log(` anti-pattern ${findings.filter(f => f.type === 'anti-pattern').length}`);
|
||||
|
||||
detectOversizedFiles();
|
||||
console.log(` oversized-file ${findings.filter(f => f.type === 'oversized-file').length}`);
|
||||
|
||||
detectOrphanedRuleRefs();
|
||||
console.log(` orphaned-rule-ref ${findings.filter(f => f.type === 'orphaned-rule-ref').length}`);
|
||||
|
||||
detectOrphanedPackages();
|
||||
console.log(` orphaned-package ${findings.filter(f => f.type === 'orphaned-package').length}`);
|
||||
|
||||
detectOldMigrations();
|
||||
console.log(` old-migration ${findings.filter(f => f.type === 'old-migration').length}`);
|
||||
|
||||
detectOutdatedDeps();
|
||||
console.log(` outdated-dep ${findings.filter(f => f.type === 'outdated-dep').length}`);
|
||||
|
||||
// Deduplicate
|
||||
const seen = new Set();
|
||||
const deduped = findings.filter(f => {
|
||||
const key = [
|
||||
f.type,
|
||||
f.file ?? f.package ?? f.name ?? f.migration ?? f.branch ?? '',
|
||||
f.line ?? f.ref ?? '',
|
||||
f.patternId ?? '',
|
||||
].join(':');
|
||||
if (seen.has(key)) return false;
|
||||
seen.add(key);
|
||||
return true;
|
||||
});
|
||||
|
||||
const output = {
|
||||
scanDate: new Date().toISOString(),
|
||||
thresholds: { STALE_BRANCH_DAYS, STALE_COMMENT_DAYS },
|
||||
repo: run('git remote get-url origin') || ROOT,
|
||||
commit: run('git rev-parse --short HEAD') || 'unknown',
|
||||
summary: {
|
||||
total: deduped.length,
|
||||
tierA: deduped.filter(f => f.tier === 'A').length,
|
||||
tierB: deduped.filter(f => f.tier === 'B').length,
|
||||
},
|
||||
findings: deduped,
|
||||
};
|
||||
|
||||
writeFileSync(OUT, JSON.stringify(output, null, 2));
|
||||
console.log('');
|
||||
console.log(`Total: ${deduped.length} (Tier A: ${output.summary.tierA}, Tier B: ${output.summary.tierB})`);
|
||||
console.log(`Output: ${OUT}`);
|
||||
+9
-1
@@ -27,6 +27,7 @@ if (!existsSync(EXAMPLE)) {
|
||||
}
|
||||
|
||||
const secret = randomBytes(32).toString("hex");
|
||||
const encryptionKey = randomBytes(32).toString("hex");
|
||||
let content = readFileSync(EXAMPLE, "utf8");
|
||||
|
||||
// Fill in the AUTH_SECRET line
|
||||
@@ -36,6 +37,13 @@ if (content.includes("AUTH_SECRET=")) {
|
||||
content += `\nAUTH_SECRET=${secret}\n`;
|
||||
}
|
||||
|
||||
// Fill in the ENCRYPTION_MASTER_KEY line
|
||||
if (content.includes("ENCRYPTION_MASTER_KEY=")) {
|
||||
content = content.replace(/^ENCRYPTION_MASTER_KEY=.*$/m, `ENCRYPTION_MASTER_KEY=${encryptionKey}`);
|
||||
} else {
|
||||
content += `\nENCRYPTION_MASTER_KEY=${encryptionKey}\n`;
|
||||
}
|
||||
|
||||
// Strip comment-only sections (keep values)
|
||||
content = content
|
||||
.split("\n")
|
||||
@@ -48,6 +56,6 @@ content = content
|
||||
|
||||
writeFileSync(TARGET, content, "utf8");
|
||||
|
||||
console.log("✅ .env created with a generated AUTH_SECRET.");
|
||||
console.log("✅ .env created with generated AUTH_SECRET and ENCRYPTION_MASTER_KEY.");
|
||||
console.log(" Fill in any optional API keys (Cesium, Bing, OpenSky, etc.)");
|
||||
console.log(" then run: npm run dev");
|
||||
+220
-24
@@ -7,6 +7,7 @@
|
||||
*/
|
||||
|
||||
import fs from "fs";
|
||||
import os from "os";
|
||||
import path from "path";
|
||||
import { build } from "vite";
|
||||
import { fileURLToPath } from "url";
|
||||
@@ -26,9 +27,72 @@ const EXTERNAL_GLOBALS = {
|
||||
"resium": "globalThis.__WWV_HOST__.Resium",
|
||||
};
|
||||
|
||||
/**
|
||||
* Synthetic host-module exports for `@/` imports that plugins use to access
|
||||
* the host application's runtime objects (store, plugin manager, components).
|
||||
*
|
||||
* When a plugin sub-component does `import { useStore } from "@/core/state/store"`,
|
||||
* the tsconfig `@/*` alias (inherited from the main app root tsconfig) would normally
|
||||
* resolve that to the actual `src/core/state/store.ts` file — pulling the entire Zustand
|
||||
* store (and its transitive deps like `src/core/edition.ts`) into the bundle.
|
||||
* This plugin intercepts those imports at the resolveId stage, before Vite touches
|
||||
* the filesystem, and substitutes a synthetic module that reads from the host globals
|
||||
* injected at runtime by `hostGlobals.ts`.
|
||||
*/
|
||||
const HOST_MODULE_SYNTHETICS = {
|
||||
"@/core/state/store": `export const useStore = globalThis.__WWV_HOST__.useStore;`,
|
||||
"@/core/plugins/PluginManager": `export const pluginManager = globalThis.__WWV_HOST__.pluginManager;`,
|
||||
"@/components/video/CameraStream": `export const CameraStream = globalThis.__WWV_HOST__.CameraStream;`,
|
||||
"zustand": `
|
||||
const zustand = globalThis.__WWV_HOST__.zustand || {};
|
||||
export default zustand;
|
||||
export const { create, createStore } = zustand;
|
||||
`,
|
||||
};
|
||||
|
||||
/**
|
||||
* @function wwvHostRedirectPlugin
|
||||
* @description Vite plugin that intercepts host-app module imports (`@/core/...`,
|
||||
* `@/components/...`) in local plugin builds and redirects them to the runtime
|
||||
* host globals instead of bundling the full app source tree.
|
||||
*
|
||||
* @returns {import('vite').Plugin}
|
||||
*/
|
||||
function wwvHostRedirectPlugin() {
|
||||
return {
|
||||
name: "wwv-host-redirect",
|
||||
enforce: "pre",
|
||||
resolveId(id) {
|
||||
if (id in HOST_MODULE_SYNTHETICS) return `\0${id}`;
|
||||
return null;
|
||||
},
|
||||
load(id) {
|
||||
if (!id.startsWith("\0")) return null;
|
||||
const originalId = id.slice(1);
|
||||
return HOST_MODULE_SYNTHETICS[originalId] ?? null;
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* @function readJsonFile
|
||||
* @description Reads a UTF-8 JSON file, tolerating a leading BOM (U+FEFF).
|
||||
* Node's `fs.readFileSync(p, 'utf-8')` preserves the BOM byte, which `JSON.parse`
|
||||
* then rejects with "Unexpected token". Scaffolders and editors on Windows
|
||||
* occasionally emit BOMs into `package.json`; pnpm/npm strip them silently,
|
||||
* so we match that behavior here to avoid breaking dev on otherwise-valid files.
|
||||
* @param {string} filePath
|
||||
* @returns {any}
|
||||
*/
|
||||
function readJsonFile(filePath) {
|
||||
let text = fs.readFileSync(filePath, "utf-8");
|
||||
if (text.charCodeAt(0) === 0xFEFF) text = text.slice(1);
|
||||
return JSON.parse(text);
|
||||
}
|
||||
|
||||
/**
|
||||
* @function discoverLocalPlugins
|
||||
* @description Finds all directories in `local-plugins/` that contain a valid
|
||||
* @description Finds all directories in `local-plugins/` that contain a valid
|
||||
* `package.json` with a `worldwideview` manifest block.
|
||||
* @returns {Array<{dir: string, manifest: any, pluginDir: string}>}
|
||||
*/
|
||||
@@ -40,43 +104,141 @@ export function discoverLocalPlugins() {
|
||||
if (dir.startsWith(".")) return false;
|
||||
const pkgPath = path.join(LOCAL_PLUGINS_DIR, dir, "package.json");
|
||||
if (!fs.existsSync(pkgPath)) return false;
|
||||
const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
|
||||
const pkg = readJsonFile(pkgPath);
|
||||
return !!pkg.worldwideview;
|
||||
})
|
||||
.map(dir => {
|
||||
const pkgPath = path.join(LOCAL_PLUGINS_DIR, dir, "package.json");
|
||||
const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
|
||||
const pkg = readJsonFile(pkgPath);
|
||||
const manifest = pkg.worldwideview;
|
||||
manifest.version = pkg.version;
|
||||
manifest.name = pkg.name;
|
||||
manifest.description = pkg.description;
|
||||
return { dir, manifest, pluginDir: path.join(LOCAL_PLUGINS_DIR, dir) };
|
||||
return { dir, manifest, pkg, pluginDir: path.join(LOCAL_PLUGINS_DIR, dir) };
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* @function buildPlugin
|
||||
* @description Invokes the Vite build engine to compile a plugin's source
|
||||
* into a single ES module, externalizing shared host dependencies.
|
||||
* @function resolvePluginEntry
|
||||
* @description Resolves the TypeScript source entry file for a plugin.
|
||||
*
|
||||
* Resolution order:
|
||||
* 1. `worldwideview.dev_entry` — explicit override in the manifest block
|
||||
* 2. `pkg.types` — if it points to a .ts/.tsx source file (not a .d.ts declaration)
|
||||
* 3. `pkg.source` — explicit source field (less common, but valid)
|
||||
* 4. Heuristic fallback: src/index.ts → src/index.tsx → index.ts → index.tsx
|
||||
*
|
||||
* @param {string} pluginDir - Absolute path to the plugin directory.
|
||||
* @param {any} manifest - The parsed `worldwideview` manifest block.
|
||||
* @param {any} pkg - The full parsed package.json object.
|
||||
* @returns {string|null} Absolute path to the entry file, or null if not found.
|
||||
*/
|
||||
export async function buildPlugin({ dir, manifest, pluginDir }) {
|
||||
const devEntry = manifest.dev_entry || "index.ts";
|
||||
let entryFile = path.join(pluginDir, devEntry);
|
||||
function resolvePluginEntry(pluginDir, manifest, pkg) {
|
||||
const candidates = [];
|
||||
|
||||
// Fallback: check for .tsx
|
||||
if (!fs.existsSync(entryFile)) {
|
||||
const tsxEntry = devEntry.replace(".ts", ".tsx");
|
||||
entryFile = path.join(pluginDir, tsxEntry);
|
||||
if (!fs.existsSync(entryFile)) {
|
||||
console.warn(`[sync] ⚠ No entry file found for ${dir}, skipping`);
|
||||
return false;
|
||||
if (manifest.dev_entry) {
|
||||
candidates.push(path.join(pluginDir, manifest.dev_entry));
|
||||
}
|
||||
|
||||
// pkg.types points to the TS source in all WWV plugins (e.g. "src/index.ts")
|
||||
if (pkg.types && !pkg.types.endsWith(".d.ts")) {
|
||||
candidates.push(path.join(pluginDir, pkg.types));
|
||||
}
|
||||
|
||||
if (pkg.source) {
|
||||
candidates.push(path.join(pluginDir, pkg.source));
|
||||
}
|
||||
|
||||
// Heuristic fallbacks
|
||||
for (const rel of ["src/index.ts", "src/index.tsx", "index.ts", "index.tsx"]) {
|
||||
candidates.push(path.join(pluginDir, rel));
|
||||
}
|
||||
|
||||
return candidates.find(f => fs.existsSync(f)) ?? null;
|
||||
}
|
||||
|
||||
const SKIP_DIRS = new Set(["dist", "node_modules", ".git", ".turbo", ".vite"]);
|
||||
|
||||
/**
|
||||
* @function latestSourceMtime
|
||||
* @description Walks a plugin directory and returns the newest mtime (ms) across
|
||||
* source files. Used to decide whether a cached `dist/frontend.mjs` is still valid.
|
||||
* Skips build/output dirs so this is fast even on cold disks.
|
||||
* @param {string} rootDir
|
||||
* @returns {number} newest mtime in ms, or 0 if no files found
|
||||
*/
|
||||
function latestSourceMtime(rootDir) {
|
||||
let newest = 0;
|
||||
/** @param {string} dir */
|
||||
function walk(dir) {
|
||||
let entries;
|
||||
try {
|
||||
entries = fs.readdirSync(dir, { withFileTypes: true });
|
||||
} catch {
|
||||
return;
|
||||
}
|
||||
for (const entry of entries) {
|
||||
if (entry.name.startsWith(".") && entry.name !== ".env") continue;
|
||||
if (SKIP_DIRS.has(entry.name)) continue;
|
||||
const full = path.join(dir, entry.name);
|
||||
if (entry.isDirectory()) {
|
||||
walk(full);
|
||||
} else if (entry.isFile()) {
|
||||
const m = fs.statSync(full).mtimeMs;
|
||||
if (m > newest) newest = m;
|
||||
}
|
||||
}
|
||||
}
|
||||
walk(rootDir);
|
||||
return newest;
|
||||
}
|
||||
|
||||
/**
|
||||
* @function isBuildFresh
|
||||
* @description Returns true if the plugin's existing `dist/frontend.mjs` is newer
|
||||
* than every source file under its directory — meaning Vite would produce a
|
||||
* byte-identical bundle and the build can be skipped.
|
||||
* @param {string} pluginDir
|
||||
* @returns {boolean}
|
||||
*/
|
||||
function isBuildFresh(pluginDir) {
|
||||
const distFile = path.join(pluginDir, "dist", "frontend.mjs");
|
||||
if (!fs.existsSync(distFile)) return false;
|
||||
const distMtime = fs.statSync(distFile).mtimeMs;
|
||||
const sourceMtime = latestSourceMtime(pluginDir);
|
||||
return distMtime >= sourceMtime;
|
||||
}
|
||||
|
||||
/**
|
||||
* @function buildPlugin
|
||||
* @description Invokes the Vite build engine to compile a plugin's source
|
||||
* into a single ES module, externalizing shared host dependencies.
|
||||
*
|
||||
* Returns `"fresh"` if an up-to-date `dist/frontend.mjs` already exists (no build run),
|
||||
* `true` if Vite produced a new bundle, or `false` on failure.
|
||||
*/
|
||||
export async function buildPlugin({ dir, manifest, pkg, pluginDir }) {
|
||||
if (isBuildFresh(pluginDir)) {
|
||||
return "fresh";
|
||||
}
|
||||
|
||||
const entryFile = resolvePluginEntry(pluginDir, manifest, pkg ?? {});
|
||||
|
||||
if (!entryFile) {
|
||||
console.warn(`[sync] ⚠ No entry file found for ${dir}, skipping`);
|
||||
return false;
|
||||
}
|
||||
|
||||
try {
|
||||
await build({
|
||||
root: pluginDir,
|
||||
// Disable auto-loading the plugin's own vite.config.ts — the local
|
||||
// plugins' node_modules may be symlinked to a different repo's SDK
|
||||
// build (worktree scenario), which breaks config loading. The sync
|
||||
// script provides all necessary config inline.
|
||||
configFile: false,
|
||||
logLevel: "warn",
|
||||
plugins: [wwvHostRedirectPlugin()],
|
||||
build: {
|
||||
lib: {
|
||||
entry: entryFile,
|
||||
@@ -114,7 +276,7 @@ export async function buildPlugin({ dir, manifest, pluginDir }) {
|
||||
}
|
||||
}
|
||||
|
||||
export function syncToPublic({ dir, manifest, pluginDir }) {
|
||||
export function syncToPublic({ dir, manifest, pluginDir }, { quiet = false } = {}) {
|
||||
const publicName = manifest.id || dir.replace("wwv-plugin-", "");
|
||||
const targetDir = path.join(OUTPUT_DIR, publicName);
|
||||
const distFile = path.join(pluginDir, "dist", "frontend.mjs");
|
||||
@@ -151,7 +313,7 @@ export function syncToPublic({ dir, manifest, pluginDir }) {
|
||||
JSON.stringify(pluginJson, null, 2)
|
||||
);
|
||||
|
||||
console.log(`[sync] ✅ ${publicName} → public/plugins-local/${publicName}/`);
|
||||
if (!quiet) console.log(`[sync] ✅ ${publicName} → public/plugins-local/${publicName}/`);
|
||||
}
|
||||
|
||||
// Clean stale plugins from public/plugins-local/ that no longer exist in local-plugins/
|
||||
@@ -166,6 +328,32 @@ function cleanStale(activeIds) {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @function runWithConcurrency
|
||||
* @description Runs an async worker over `items` with a fixed concurrency cap.
|
||||
* Vite builds are CPU-bound; running all ~30 in parallel thrashes the scheduler
|
||||
* and balloons RSS. A cap around half the logical cores keeps wall-clock low
|
||||
* without starving the rest of the dev environment (Next.js, the data engine).
|
||||
* @template T, R
|
||||
* @param {T[]} items
|
||||
* @param {number} concurrency
|
||||
* @param {(item: T) => Promise<R>} worker
|
||||
* @returns {Promise<R[]>}
|
||||
*/
|
||||
async function runWithConcurrency(items, concurrency, worker) {
|
||||
const results = new Array(items.length);
|
||||
let cursor = 0;
|
||||
const workers = Array.from({ length: Math.min(concurrency, items.length) }, async () => {
|
||||
while (true) {
|
||||
const i = cursor++;
|
||||
if (i >= items.length) return;
|
||||
results[i] = await worker(items[i]);
|
||||
}
|
||||
});
|
||||
await Promise.all(workers);
|
||||
return results;
|
||||
}
|
||||
|
||||
export async function syncAll() {
|
||||
const plugins = discoverLocalPlugins();
|
||||
|
||||
@@ -175,12 +363,20 @@ export async function syncAll() {
|
||||
return;
|
||||
}
|
||||
|
||||
console.log(`[sync] Found ${plugins.length} local plugin(s): ${plugins.map(p => p.dir).join(", ")}`);
|
||||
const concurrency = Math.max(2, Math.min(plugins.length, Math.ceil(os.cpus().length / 2)));
|
||||
console.log(`[sync] Found ${plugins.length} local plugin(s); building with concurrency=${concurrency}`);
|
||||
const started = Date.now();
|
||||
|
||||
for (const plugin of plugins) {
|
||||
const ok = await buildPlugin(plugin);
|
||||
if (ok) syncToPublic(plugin);
|
||||
}
|
||||
let freshCount = 0;
|
||||
let builtCount = 0;
|
||||
await runWithConcurrency(plugins, concurrency, async (plugin) => {
|
||||
const result = await buildPlugin(plugin);
|
||||
if (result === "fresh") freshCount++;
|
||||
else if (result) builtCount++;
|
||||
if (result) syncToPublic(plugin, { quiet: result === "fresh" });
|
||||
});
|
||||
|
||||
console.log(`[sync] Done in ${((Date.now() - started) / 1000).toFixed(1)}s (${builtCount} built, ${freshCount} cached)`);
|
||||
|
||||
const activeIds = plugins.map(p => p.manifest.id || p.dir.replace("wwv-plugin-", ""));
|
||||
cleanStale(activeIds);
|
||||
|
||||
@@ -15,40 +15,66 @@ if (!fs.existsSync(LOCAL_PLUGINS_DIR)) {
|
||||
let debounceTimeout = null;
|
||||
let isSyncing = false;
|
||||
let pendingSync = false;
|
||||
/** Files changed since last sync completed — collected during the debounce window */
|
||||
const pendingChanges = new Set();
|
||||
|
||||
function handleFileChange(eventType, filename) {
|
||||
if (filename && (
|
||||
filename.includes("dist") ||
|
||||
filename.includes("node_modules") ||
|
||||
if (!filename) return;
|
||||
if (
|
||||
filename.includes("dist") ||
|
||||
filename.includes("node_modules") ||
|
||||
filename.endsWith(".map") ||
|
||||
filename.includes(".git")
|
||||
)) return; // ignore build artifacts and git internals
|
||||
|
||||
) return; // ignore build artifacts and git internals
|
||||
|
||||
pendingChanges.add(filename);
|
||||
|
||||
if (debounceTimeout) {
|
||||
clearTimeout(debounceTimeout);
|
||||
}
|
||||
|
||||
|
||||
debounceTimeout = setTimeout(async () => {
|
||||
if (isSyncing) {
|
||||
pendingSync = true;
|
||||
return;
|
||||
}
|
||||
await runSync(filename);
|
||||
await runSync();
|
||||
}, 500);
|
||||
}
|
||||
|
||||
async function runSync(filename) {
|
||||
/**
|
||||
* Pulls plugin slugs out of changed file paths so we can name what triggered the rebuild.
|
||||
* fs.watch on `local-plugins/` emits paths like `aviation/src/index.ts` (POSIX or Windows).
|
||||
*/
|
||||
function summarizeChangedPlugins(files) {
|
||||
const slugs = new Set();
|
||||
for (const f of files) {
|
||||
const head = f.split(/[\\/]/)[0];
|
||||
if (head) slugs.add(head);
|
||||
}
|
||||
return [...slugs];
|
||||
}
|
||||
|
||||
async function runSync() {
|
||||
isSyncing = true;
|
||||
console.log(`\n[watch] Change detected in local plugins (file: ${filename}). Syncing...`);
|
||||
const changed = summarizeChangedPlugins(pendingChanges);
|
||||
pendingChanges.clear();
|
||||
const label = changed.length === 0
|
||||
? "pending changes"
|
||||
: changed.length <= 3
|
||||
? changed.join(", ")
|
||||
: `${changed.slice(0, 3).join(", ")} (+${changed.length - 3} more)`;
|
||||
console.log(`\n[watch] 🔄 Change detected in: ${label}`);
|
||||
try {
|
||||
await syncAll();
|
||||
console.log(`[watch] ✨ Hot-reload ready`);
|
||||
} catch (err) {
|
||||
console.error(`[watch] Sync failed:`, err);
|
||||
} finally {
|
||||
isSyncing = false;
|
||||
if (pendingSync) {
|
||||
pendingSync = false;
|
||||
await runSync("pending changes");
|
||||
await runSync();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,54 @@
|
||||
import { describe, it, expect, vi, beforeEach } from "vitest";
|
||||
import { NextRequest } from "next/server";
|
||||
import { auth } from "@/lib/auth";
|
||||
import { getTicket } from "@/lib/auth/ticketClient";
|
||||
import { GET } from "./route";
|
||||
|
||||
vi.mock("@/lib/auth", () => ({ auth: vi.fn() }));
|
||||
vi.mock("@/lib/auth/ticketClient", () => ({ getTicket: vi.fn() }));
|
||||
vi.mock("@/core/edition", () => ({ isAuthEnabled: true }));
|
||||
|
||||
describe("GET /api/auth/ticket", () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
it("returns 401 when no session exists", async () => {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
vi.mocked(auth).mockResolvedValue(null as any);
|
||||
const req = new NextRequest("http://localhost/api/auth/ticket?pluginId=aviation");
|
||||
const res = await GET(req);
|
||||
expect(res.status).toBe(401);
|
||||
expect(await res.json()).toEqual({ error: "Unauthorized" });
|
||||
});
|
||||
|
||||
it("returns 400 when pluginId query param is missing", async () => {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
vi.mocked(auth).mockResolvedValue({ user: { id: "u1" } } as any);
|
||||
const req = new NextRequest("http://localhost/api/auth/ticket");
|
||||
const res = await GET(req);
|
||||
expect(res.status).toBe(400);
|
||||
expect(await res.json()).toEqual({ error: "Missing pluginId" });
|
||||
});
|
||||
|
||||
it("returns 500 when getTicket throws", async () => {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
vi.mocked(auth).mockResolvedValue({ user: { id: "u1" } } as any);
|
||||
vi.mocked(getTicket).mockRejectedValue(new Error("Marketplace unreachable"));
|
||||
const req = new NextRequest("http://localhost/api/auth/ticket?pluginId=aviation");
|
||||
const res = await GET(req);
|
||||
expect(res.status).toBe(500);
|
||||
expect(await res.json()).toEqual({ error: "Failed to obtain plugin ticket" });
|
||||
});
|
||||
|
||||
it("returns 200 with token on success", async () => {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
vi.mocked(auth).mockResolvedValue({ user: { id: "u1" } } as any);
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
vi.mocked(getTicket).mockResolvedValue("plugin-ticket-abc" as any);
|
||||
const req = new NextRequest("http://localhost/api/auth/ticket?pluginId=aviation");
|
||||
const res = await GET(req);
|
||||
expect(res.status).toBe(200);
|
||||
expect(await res.json()).toEqual({ token: "plugin-ticket-abc" });
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,32 @@
|
||||
import { NextRequest, NextResponse } from "next/server";
|
||||
import { auth } from "@/lib/auth";
|
||||
import { isAuthEnabled } from "@/core/edition";
|
||||
import { getTicket } from "@/lib/auth/ticketClient";
|
||||
|
||||
/**
|
||||
* GET /api/auth/ticket?pluginId=<id>
|
||||
* Returns a short-lived PluginTicket for the given plugin.
|
||||
* Used by WsClient (browser) to obtain auth tokens without DB access.
|
||||
*/
|
||||
export async function GET(req: NextRequest) {
|
||||
if (isAuthEnabled) {
|
||||
const session = await auth();
|
||||
if (!session?.user) {
|
||||
return NextResponse.json({ error: "Unauthorized" }, { status: 401 });
|
||||
}
|
||||
}
|
||||
|
||||
const pluginId = req.nextUrl.searchParams.get("pluginId");
|
||||
if (!pluginId) {
|
||||
return NextResponse.json({ error: "Missing pluginId" }, { status: 400 });
|
||||
}
|
||||
|
||||
try {
|
||||
const token = await getTicket(pluginId);
|
||||
return NextResponse.json({ token });
|
||||
} catch (err) {
|
||||
const message = err instanceof Error ? err.message : String(err);
|
||||
console.error("[ticket-route]", message);
|
||||
return NextResponse.json({ error: "Failed to obtain plugin ticket" }, { status: 500 });
|
||||
}
|
||||
}
|
||||
@@ -3,6 +3,7 @@ import { auth } from "@/lib/auth";
|
||||
import { isAuthEnabled } from "@/core/edition";
|
||||
import { cameraProxyLimiter } from "@/lib/rateLimiters";
|
||||
import { getClientIp } from "@/lib/rateLimit";
|
||||
import { safeFetch } from "@/lib/security/ssrf";
|
||||
|
||||
const MAX_IFRAME_DURATION_MS = 10 * 1000; // 10 seconds timeout for HTML
|
||||
|
||||
@@ -28,13 +29,14 @@ export async function GET(req: NextRequest) {
|
||||
}
|
||||
|
||||
try {
|
||||
const upstream = await fetch(targetUrl, {
|
||||
const upstream = await safeFetch(targetUrl, {
|
||||
headers: {
|
||||
"User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
|
||||
Accept: "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8",
|
||||
"Accept-Language": "en-US,en;q=0.5",
|
||||
},
|
||||
signal: AbortSignal.timeout(MAX_IFRAME_DURATION_MS),
|
||||
maxSize: 5 * 1024 * 1024,
|
||||
timeout: MAX_IFRAME_DURATION_MS,
|
||||
});
|
||||
|
||||
if (!upstream.ok) {
|
||||
|
||||
@@ -21,16 +21,18 @@ export async function GET(req: NextRequest) {
|
||||
|
||||
const marketplaceUrl = process.env.NEXT_PUBLIC_WWV_MARKETPLACE_URL || "https://app.worldwideview.dev";
|
||||
const issuer = new URL(marketplaceUrl);
|
||||
const server = {
|
||||
issuer: issuer.toString(),
|
||||
authorization_endpoint: new URL("/oauth/authorize", issuer).toString(),
|
||||
token_endpoint: new URL("/api/tickets/exchange", issuer).toString(),
|
||||
};
|
||||
const config = { server, clientId: "local-app" };
|
||||
|
||||
const config = new client.Configuration(
|
||||
{
|
||||
issuer: issuer.toString(),
|
||||
authorization_endpoint: new URL("/oauth/authorize", issuer).toString(),
|
||||
token_endpoint: new URL("/api/oauth/token", issuer).toString(),
|
||||
},
|
||||
"local-app",
|
||||
);
|
||||
|
||||
try {
|
||||
const tokens = await client.authorizationCodeGrant(
|
||||
config as any,
|
||||
config,
|
||||
new URL(req.url),
|
||||
{ expectedState: stateCookie, pkceCodeVerifier: verifierCookie }
|
||||
);
|
||||
@@ -54,8 +56,8 @@ export async function GET(req: NextRequest) {
|
||||
}
|
||||
});
|
||||
}
|
||||
} catch (err: any) {
|
||||
console.error("[PKCE] Exchange failed:", err.message);
|
||||
} catch (err) {
|
||||
console.error("[PKCE] Exchange failed:", err instanceof Error ? err.message : String(err));
|
||||
return NextResponse.json({ error: "Failed to exchange authorization code" }, { status: 500 });
|
||||
}
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@ import { NextResponse } from "next/server";
|
||||
import type { NextRequest } from "next/server";
|
||||
import { auth } from "@/lib/auth";
|
||||
import { issueMarketplaceToken } from "@/lib/marketplace/marketplaceToken";
|
||||
import type { MarketplaceSessionToken } from "@worldwideview/wwv-plugin-sdk";
|
||||
import { grantTokenLimiter } from "@/lib/rateLimiters";
|
||||
import { getClientIp } from "@/lib/rateLimit";
|
||||
import { isPluginInstallEnabled, isDemo, isDemoAdmin } from "@/core/edition";
|
||||
@@ -68,7 +69,7 @@ export async function GET(request: NextRequest) {
|
||||
return NextResponse.json({ error: "Invalid or missing redirectTo" }, { status: 400 });
|
||||
}
|
||||
|
||||
const token = await issueMarketplaceToken(session.user.id ?? "");
|
||||
const token: MarketplaceSessionToken = await issueMarketplaceToken(session.user.id ?? "");
|
||||
const dest = new URL(redirectTo);
|
||||
// Token in fragment — never sent to server in logs/referer
|
||||
return NextResponse.redirect(`${dest.toString()}#token=${token}`);
|
||||
|
||||
@@ -3,6 +3,7 @@ import type { NextRequest } from "next/server";
|
||||
import { auth } from "@/lib/auth";
|
||||
import { upsertPlugin } from "@/lib/marketplace/repository";
|
||||
import { issueMarketplaceToken } from "@/lib/marketplace/marketplaceToken";
|
||||
import type { MarketplaceSessionToken } from "@worldwideview/wwv-plugin-sdk";
|
||||
import type { PluginManifest } from "@/core/plugins/PluginManifest";
|
||||
import { validateManifest } from "@/core/plugins/validateManifest";
|
||||
import { installLimiter } from "@/lib/rateLimiters";
|
||||
@@ -113,7 +114,7 @@ export async function GET(request: NextRequest) {
|
||||
return NextResponse.json({ error: "Install failed" }, { status: 500 });
|
||||
}
|
||||
|
||||
const token = await issueMarketplaceToken(session.user.id ?? "");
|
||||
const token: MarketplaceSessionToken = await issueMarketplaceToken(session.user.id ?? "");
|
||||
const successUrl = new URL(redirectTo);
|
||||
|
||||
// Unverified plugins need user confirmation on the WWV client side
|
||||
|
||||
@@ -6,6 +6,7 @@ import { GET as connectRoute } from "./connect/route";
|
||||
import { GET as callbackRoute } from "./callback/route";
|
||||
|
||||
vi.mock("openid-client", () => ({
|
||||
Configuration: vi.fn().mockImplementation(function(this: object) { return this; }),
|
||||
randomState: vi.fn(() => "mock-state"),
|
||||
randomPKCECodeVerifier: vi.fn(() => "mock-verifier"),
|
||||
calculatePKCECodeChallenge: vi.fn(() => "mock-challenge"),
|
||||
|
||||
@@ -129,15 +129,27 @@ export function AppShell() {
|
||||
console.log("[AppShell] Platform Ready. Waiting for globe tiles...");
|
||||
};
|
||||
|
||||
// Start boot sequence when globe tiles are loaded
|
||||
const unsubGlobe = dataBus.on("globeReady", () => {
|
||||
console.log("[AppShell] Globe ready — starting boot sequence.");
|
||||
// Guard so boot only starts once regardless of which trigger fires first.
|
||||
let bootStarted = false;
|
||||
const startBootOnce = (reason: string) => {
|
||||
if (bootStarted) return;
|
||||
bootStarted = true;
|
||||
console.log(`[AppShell] Starting boot sequence (${reason}).`);
|
||||
boot.startBoot();
|
||||
});
|
||||
};
|
||||
|
||||
// Primary trigger: globe signals it is ready.
|
||||
const unsubGlobe = dataBus.on("globeReady", () => startBootOnce("globeReady"));
|
||||
|
||||
// Safety fallback: if the globe never initialises (e.g. WebGL unavailable
|
||||
// in headless CI environments), force the boot sequence after 20 s so the
|
||||
// app still reaches the "ready" state and tests are not left hanging.
|
||||
const safetyTimer = setTimeout(() => startBootOnce("safety-timeout"), 20_000);
|
||||
|
||||
startPlatform();
|
||||
|
||||
return () => {
|
||||
clearTimeout(safetyTimer);
|
||||
unsubGlobe();
|
||||
boot.cleanup();
|
||||
pluginManager.destroy();
|
||||
|
||||
@@ -64,7 +64,7 @@ describe("resolveEngineUrl", () => {
|
||||
await fetchLocalEngineManifest();
|
||||
|
||||
const url = resolveEngineUrl("plugin-local");
|
||||
expect(url).toContain("localhost:5001/stream");
|
||||
expect(url).toContain("localhost:5000/stream");
|
||||
});
|
||||
|
||||
it("should fall back to plugin's custom streamUrl if not local", () => {
|
||||
|
||||
@@ -0,0 +1,153 @@
|
||||
// @vitest-environment jsdom
|
||||
import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
|
||||
|
||||
vi.mock("../edition", () => ({
|
||||
ticketAuthEnabledForPlugin: vi.fn(),
|
||||
}));
|
||||
vi.mock("./DataBus", () => ({
|
||||
dataBus: { emit: vi.fn() },
|
||||
}));
|
||||
vi.mock("../plugins/PluginManager", () => ({
|
||||
pluginManager: { getPlugin: vi.fn(() => null) },
|
||||
}));
|
||||
vi.mock("../state/store", () => ({
|
||||
useStore: { getState: vi.fn(() => ({ entitiesByPlugin: {} })) },
|
||||
}));
|
||||
|
||||
// Fake WebSocket that stays CONNECTING until explicitly opened by tests
|
||||
class FakeWebSocket {
|
||||
static CONNECTING = 0;
|
||||
static OPEN = 1;
|
||||
static CLOSING = 2;
|
||||
static CLOSED = 3;
|
||||
static instances: FakeWebSocket[] = [];
|
||||
|
||||
readyState = FakeWebSocket.CONNECTING;
|
||||
onopen: ((e: Event) => void) | null = null;
|
||||
onmessage: ((e: MessageEvent) => void) | null = null;
|
||||
onclose: (() => void) | null = null;
|
||||
onerror: (() => void) | null = null;
|
||||
readonly sentMessages: string[] = [];
|
||||
|
||||
constructor(public url: string) {
|
||||
FakeWebSocket.instances.push(this);
|
||||
}
|
||||
|
||||
send(data: string) {
|
||||
this.sentMessages.push(data);
|
||||
}
|
||||
|
||||
close() {
|
||||
this.readyState = FakeWebSocket.CLOSED;
|
||||
this.onclose?.();
|
||||
}
|
||||
|
||||
triggerOpen() {
|
||||
this.readyState = FakeWebSocket.OPEN;
|
||||
this.onopen?.(new Event("open"));
|
||||
}
|
||||
|
||||
triggerMessage(data: object) {
|
||||
this.onmessage?.(new MessageEvent("message", { data: JSON.stringify(data) }));
|
||||
}
|
||||
}
|
||||
|
||||
// Flush all pending Promise microtasks (handles multiple nested awaits in fetchPluginTicket)
|
||||
const flushPromises = async () => {
|
||||
for (let i = 0; i < 10; i++) await Promise.resolve();
|
||||
};
|
||||
|
||||
let savedWebSocket: typeof WebSocket;
|
||||
let engineIndex = 0;
|
||||
const nextEngineUrl = () => `wss://engine-${++engineIndex}.test`;
|
||||
|
||||
describe("WsClient — first-message auth", () => {
|
||||
beforeEach(() => {
|
||||
FakeWebSocket.instances.length = 0;
|
||||
savedWebSocket = global.WebSocket;
|
||||
global.WebSocket = FakeWebSocket as unknown as typeof WebSocket;
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
global.WebSocket = savedWebSocket;
|
||||
});
|
||||
|
||||
it("sends subscribe immediately on open when ticket auth is not required", async () => {
|
||||
const { ticketAuthEnabledForPlugin } = await import("../edition");
|
||||
vi.mocked(ticketAuthEnabledForPlugin).mockReturnValue(false);
|
||||
|
||||
const { wsClient } = await import("./WsClient");
|
||||
const url = nextEngineUrl();
|
||||
|
||||
wsClient.subscribe("aviation", url);
|
||||
const ws = FakeWebSocket.instances.at(-1)!;
|
||||
ws.triggerOpen();
|
||||
|
||||
const msgs = ws.sentMessages.map((m) => JSON.parse(m));
|
||||
expect(msgs).toContainEqual({ action: "subscribe", pluginId: "aviation" });
|
||||
expect(msgs.some((m: { type?: string }) => m.type === "auth")).toBe(false);
|
||||
});
|
||||
|
||||
it("sends auth message before any subscribe when ticket auth is required", async () => {
|
||||
const { ticketAuthEnabledForPlugin } = await import("../edition");
|
||||
vi.mocked(ticketAuthEnabledForPlugin).mockReturnValue(true);
|
||||
|
||||
const fetchSpy = vi.spyOn(globalThis, "fetch").mockResolvedValueOnce(
|
||||
new Response(JSON.stringify({ token: "ticket-abc" }), { status: 200 })
|
||||
);
|
||||
|
||||
const { wsClient } = await import("./WsClient");
|
||||
const url = nextEngineUrl();
|
||||
|
||||
wsClient.subscribe("aviation", url);
|
||||
const ws = FakeWebSocket.instances.at(-1)!;
|
||||
ws.triggerOpen();
|
||||
await flushPromises();
|
||||
|
||||
const msgs = ws.sentMessages.map((m) => JSON.parse(m));
|
||||
expect(msgs).toContainEqual({ type: "auth", v: 1, token: "ticket-abc" });
|
||||
expect(msgs.some((m: { action?: string }) => m.action === "subscribe")).toBe(false);
|
||||
expect(fetchSpy).toHaveBeenCalledWith(
|
||||
expect.stringContaining("/api/auth/ticket?pluginId=aviation")
|
||||
);
|
||||
|
||||
fetchSpy.mockRestore();
|
||||
});
|
||||
|
||||
it("flushes all queued subscribes after receiving a welcome message", async () => {
|
||||
const { ticketAuthEnabledForPlugin } = await import("../edition");
|
||||
vi.mocked(ticketAuthEnabledForPlugin).mockReturnValue(true);
|
||||
|
||||
const fetchSpy = vi.spyOn(globalThis, "fetch").mockResolvedValueOnce(
|
||||
new Response(JSON.stringify({ token: "ticket-abc" }), { status: 200 })
|
||||
);
|
||||
|
||||
const { wsClient } = await import("./WsClient");
|
||||
const url = nextEngineUrl();
|
||||
|
||||
wsClient.subscribe("aviation", url);
|
||||
wsClient.subscribe("maritime", url);
|
||||
|
||||
const ws = FakeWebSocket.instances.at(-1)!;
|
||||
ws.triggerOpen();
|
||||
await flushPromises();
|
||||
|
||||
// Before welcome: no subscribes yet
|
||||
const beforeWelcome = ws.sentMessages.map((m) => JSON.parse(m));
|
||||
expect(beforeWelcome.some((m: { action?: string }) => m.action === "subscribe")).toBe(false);
|
||||
|
||||
// Simulate engine welcome
|
||||
ws.triggerMessage({ type: "welcome", plugins: [] });
|
||||
|
||||
// After welcome: both subscribes flushed
|
||||
const afterWelcome = ws.sentMessages.map((m) => JSON.parse(m));
|
||||
const subscribePids = afterWelcome
|
||||
.filter((m: { action?: string }) => m.action === "subscribe")
|
||||
.map((m: { pluginId?: string }) => m.pluginId);
|
||||
expect(subscribePids).toContain("aviation");
|
||||
expect(subscribePids).toContain("maritime");
|
||||
|
||||
fetchSpy.mockRestore();
|
||||
});
|
||||
});
|
||||
@@ -36,6 +36,8 @@ describe("WsClient", () => {
|
||||
beforeEach(() => {
|
||||
vi.useFakeTimers();
|
||||
vi.clearAllMocks();
|
||||
// Pin Math.random to 0 so jitter is deterministic (delay = base only)
|
||||
vi.spyOn(Math, "random").mockReturnValue(0);
|
||||
|
||||
// Mock WebSocket global
|
||||
mockWs = {
|
||||
@@ -85,7 +87,7 @@ describe("WsClient", () => {
|
||||
);
|
||||
});
|
||||
|
||||
it("should attempt to reconnect after 5s if the connection is closed while subscriptions exist", () => {
|
||||
it("should attempt to reconnect after base delay if the connection is closed while subscriptions exist", () => {
|
||||
wsClient.subscribe("plugin-a", "ws://engine-1/stream");
|
||||
mockWs.onclose();
|
||||
|
||||
|
||||
+94
-12
@@ -2,6 +2,16 @@ import type { WsStreamPayload, GeoEntity } from "@worldwideview/wwv-plugin-sdk";
|
||||
import { dataBus } from "./DataBus";
|
||||
import { pluginManager } from "../plugins/PluginManager";
|
||||
import { useStore } from "../state/store";
|
||||
import { ticketAuthEnabledForPlugin } from "../edition";
|
||||
import type { PluginTicket } from "@worldwideview/wwv-plugin-sdk";
|
||||
|
||||
async function fetchPluginTicket(pluginId: string): Promise<PluginTicket> {
|
||||
const res = await fetch(`/api/auth/ticket?pluginId=${encodeURIComponent(pluginId)}`);
|
||||
if (!res.ok) throw new Error(`[WSClient] Ticket fetch failed (${res.status}) for ${pluginId}`);
|
||||
const data = await res.json() as { token?: string };
|
||||
if (!data.token) throw new Error(`[WSClient] Ticket response missing token for ${pluginId}`);
|
||||
return data.token as PluginTicket;
|
||||
}
|
||||
|
||||
interface EngineConnection {
|
||||
ws: WebSocket | null;
|
||||
@@ -9,11 +19,27 @@ interface EngineConnection {
|
||||
subscriptions: Set<string>;
|
||||
/** Grace period timer — closes the connection if no plugins remain subscribed */
|
||||
cleanupTimer: NodeJS.Timeout | null;
|
||||
/** Backoff attempt counter — resets after a stable connection (>5s open) */
|
||||
reconnectAttempts: number;
|
||||
/** Timer that resets the backoff counter once a connection has been stable */
|
||||
stableConnectionTimer: NodeJS.Timeout | null;
|
||||
/** True while waiting for the server's welcome after sending an auth message */
|
||||
awaitingWelcome: boolean;
|
||||
/** Closes the connection if the server doesn't send welcome within 3s */
|
||||
authTimeoutTimer: NodeJS.Timeout | null;
|
||||
}
|
||||
|
||||
const RECONNECT_DELAY_MS = 5000;
|
||||
const RECONNECT_BASE_MS = 5000;
|
||||
const RECONNECT_MAX_MS = 60000; // Cap at 1 minute
|
||||
const RECONNECT_JITTER_MS = 4000;
|
||||
const STABLE_CONNECTION_MS = 5000; // Reset backoff after 5s of stable connection
|
||||
const CLEANUP_GRACE_MS = 30000;
|
||||
|
||||
/** Normalizes underscore-based pluginIds to kebab-case (e.g. `my_plugin` → `my-plugin`). */
|
||||
function normalizePluginId(id: string): string {
|
||||
return id.replace(/_/g, "-");
|
||||
}
|
||||
|
||||
class WebSocketClient {
|
||||
private engines = new Map<string, EngineConnection>();
|
||||
|
||||
@@ -25,6 +51,10 @@ class WebSocketClient {
|
||||
reconnectTimer: null,
|
||||
subscriptions: new Set(),
|
||||
cleanupTimer: null,
|
||||
reconnectAttempts: 0,
|
||||
stableConnectionTimer: null,
|
||||
awaitingWelcome: false,
|
||||
authTimeoutTimer: null,
|
||||
};
|
||||
this.engines.set(engineUrl, engine);
|
||||
}
|
||||
@@ -43,9 +73,37 @@ class WebSocketClient {
|
||||
|
||||
engine.ws.onopen = () => {
|
||||
console.debug(`[WSClient] 🟢 Connected to ${engineUrl}. WS Handshake took ${(performance.now() - wsStart).toFixed(2)}ms`);
|
||||
// Resubscribe to all active plugins on this engine
|
||||
for (const pluginId of engine.subscriptions) {
|
||||
this.send(engine, { action: "subscribe", pluginId });
|
||||
// Only reset backoff if the connection stays open for a non-trivial time —
|
||||
// an immediate close (e.g. server-side rejection) shouldn't be treated as success.
|
||||
if (engine.stableConnectionTimer) clearTimeout(engine.stableConnectionTimer);
|
||||
engine.stableConnectionTimer = setTimeout(() => {
|
||||
engine.reconnectAttempts = 0;
|
||||
}, STABLE_CONNECTION_MS);
|
||||
|
||||
// Check whether any subscription on this engine requires ticket auth.
|
||||
const ticketPlugin = [...engine.subscriptions].find((id) => ticketAuthEnabledForPlugin(id));
|
||||
if (ticketPlugin) {
|
||||
engine.awaitingWelcome = true;
|
||||
fetchPluginTicket(ticketPlugin)
|
||||
.then((ticket) => {
|
||||
this.send(engine, { type: "auth", v: 1, token: ticket });
|
||||
// 3s timeout — if the server doesn't send welcome, close and trigger reconnect.
|
||||
engine.authTimeoutTimer = setTimeout(() => {
|
||||
if (engine.awaitingWelcome) {
|
||||
console.warn(`[WSClient] Auth timeout waiting for welcome from ${engineUrl}. Closing to reconnect.`);
|
||||
engine.ws?.close();
|
||||
}
|
||||
}, 3000);
|
||||
})
|
||||
.catch((err: unknown) => {
|
||||
console.error(`[WSClient] Failed to get ticket for ${ticketPlugin}:`, err instanceof Error ? err.message : err);
|
||||
engine.ws?.close();
|
||||
});
|
||||
} else {
|
||||
// No ticket auth required — subscribe immediately.
|
||||
for (const pluginId of engine.subscriptions) {
|
||||
this.send(engine, { action: "subscribe", pluginId });
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
@@ -55,9 +113,15 @@ class WebSocketClient {
|
||||
console.debug(`[WSClient] 📥 Received raw message at +${(msgTime - wsStart).toFixed(2)}ms from start:`, event.data.substring(0, 150) + (event.data.length > 150 ? '...' : ''));
|
||||
const data = JSON.parse(event.data);
|
||||
|
||||
// Handle welcome message (informational, no action needed)
|
||||
if (data.type === "welcome") {
|
||||
console.debug(`[WSClient] 👋 Engine ${engineUrl} serves: ${data.plugins?.join(", ")}`);
|
||||
if (engine.awaitingWelcome) {
|
||||
engine.awaitingWelcome = false;
|
||||
if (engine.authTimeoutTimer) { clearTimeout(engine.authTimeoutTimer); engine.authTimeoutTimer = null; }
|
||||
for (const pluginId of engine.subscriptions) {
|
||||
this.send(engine, { action: "subscribe", pluginId });
|
||||
}
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -74,25 +138,41 @@ class WebSocketClient {
|
||||
};
|
||||
|
||||
engine.ws.onclose = () => {
|
||||
console.warn(`[WSClient] Disconnected from ${engineUrl}. Reconnecting in 5s...`);
|
||||
engine.ws = null;
|
||||
engine.awaitingWelcome = false;
|
||||
if (engine.authTimeoutTimer) { clearTimeout(engine.authTimeoutTimer); engine.authTimeoutTimer = null; }
|
||||
if (engine.stableConnectionTimer) {
|
||||
clearTimeout(engine.stableConnectionTimer);
|
||||
engine.stableConnectionTimer = null;
|
||||
}
|
||||
if (engine.reconnectTimer) clearTimeout(engine.reconnectTimer);
|
||||
// Only reconnect if there are still active subscriptions
|
||||
if (engine.subscriptions.size > 0) {
|
||||
engine.reconnectTimer = setTimeout(() => this.connectEngine(engineUrl), RECONNECT_DELAY_MS);
|
||||
// Exponential backoff with jitter to prevent thundering herd on engine restart.
|
||||
// 5s -> 10s -> 20s -> 40s -> 60s (cap), plus ±4s of jitter so simultaneous
|
||||
// sessions don't all reconnect at the same instant.
|
||||
const expDelay = Math.min(
|
||||
RECONNECT_BASE_MS * Math.pow(2, engine.reconnectAttempts),
|
||||
RECONNECT_MAX_MS
|
||||
);
|
||||
const delay = expDelay + Math.random() * RECONNECT_JITTER_MS;
|
||||
engine.reconnectAttempts++;
|
||||
console.warn(`[WSClient] Disconnected from ${engineUrl}. Reconnecting in ${Math.round(delay / 1000)}s (attempt ${engine.reconnectAttempts})...`);
|
||||
engine.reconnectTimer = setTimeout(() => this.connectEngine(engineUrl), delay);
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
private handleDataMessage(data: WsStreamPayload) {
|
||||
const plugin = pluginManager.getPlugin(data.pluginId!)?.plugin;
|
||||
const pluginId = normalizePluginId(data.pluginId!);
|
||||
const plugin = pluginManager.getPlugin(pluginId)?.plugin;
|
||||
let finalEntities = data.payload as GeoEntity[];
|
||||
const existingEntities = useStore.getState().entitiesByPlugin[data.pluginId!] || [];
|
||||
const existingEntities = useStore.getState().entitiesByPlugin[pluginId] || [];
|
||||
|
||||
if (plugin && typeof (plugin as any).mapWebsocketPayload === "function") {
|
||||
finalEntities = (plugin as any).mapWebsocketPayload(data.payload, existingEntities);
|
||||
} else if (!Array.isArray(data.payload)) {
|
||||
console.warn(`[WsClient] Payload for ${data.pluginId} is an object but no mapWebsocketPayload exists. Ignoring.`);
|
||||
console.warn(`[WsClient] Payload for ${pluginId} is an object but no mapWebsocketPayload exists. Ignoring.`);
|
||||
return;
|
||||
} else {
|
||||
finalEntities = finalEntities.map((e) => ({
|
||||
@@ -101,10 +181,10 @@ class WebSocketClient {
|
||||
}));
|
||||
}
|
||||
|
||||
console.debug(`[WSClient] 🔄 Dispatching ${finalEntities.length} entities for ${data.pluginId} to DataBus`);
|
||||
console.debug(`[WSClient] 🔄 Dispatching ${finalEntities.length} entities for ${pluginId} to DataBus`);
|
||||
|
||||
dataBus.emit("dataUpdated", {
|
||||
pluginId: data.pluginId!,
|
||||
pluginId,
|
||||
entities: finalEntities,
|
||||
});
|
||||
}
|
||||
@@ -143,6 +223,8 @@ class WebSocketClient {
|
||||
if (engine.subscriptions.size === 0) {
|
||||
console.log(`[WSClient] No subscriptions remain for ${engineUrl}. Closing connection.`);
|
||||
if (engine.reconnectTimer) clearTimeout(engine.reconnectTimer);
|
||||
if (engine.stableConnectionTimer) clearTimeout(engine.stableConnectionTimer);
|
||||
if (engine.authTimeoutTimer) { clearTimeout(engine.authTimeoutTimer); engine.authTimeoutTimer = null; }
|
||||
engine.ws?.close();
|
||||
this.engines.delete(engineUrl);
|
||||
}
|
||||
|
||||
@@ -8,37 +8,24 @@ let manifestFetched = false;
|
||||
/**
|
||||
* Resolve the base URL of the local data engine.
|
||||
*
|
||||
* Priority:
|
||||
* 1. `NEXT_PUBLIC_WWV_PLUGIN_DATA_ENGINE_URL` env var — if the operator
|
||||
* pointed plugins at a specific engine URL (most common in
|
||||
* self-host setups), use that. We strip any trailing `/stream`
|
||||
* since the var is sometimes set to the WebSocket URL.
|
||||
* 2. `localhost:5001` — matches the port wwv-data-engine's
|
||||
* docker-compose.yaml binds. The previous default of 5000 was
|
||||
* always wrong: the engine has listened on 5001 since the v2
|
||||
* refactor. Port 5000 is also famously hijacked on macOS by the
|
||||
* AirPlay Receiver, which would return 403 to any GET regardless
|
||||
* of whether an engine was running, so it produced misleading
|
||||
* "no local engine" results on every macOS dev machine.
|
||||
* Always checks localhost:5000 — the port docker-compose.yml binds for
|
||||
* wwv-data-engine. NEXT_PUBLIC_WWV_PLUGIN_DATA_ENGINE_URL is intentionally
|
||||
* NOT used here: that variable belongs to each plugin's own declared engine
|
||||
* URL (production, third-party, etc.) and must not poison local detection.
|
||||
* Mixing the two caused the production engine to be reported as "local".
|
||||
*/
|
||||
function getLocalEngineBase() {
|
||||
const envUrl = process.env.NEXT_PUBLIC_WWV_PLUGIN_DATA_ENGINE_URL;
|
||||
if (envUrl) {
|
||||
// Strip a trailing `/stream` if present (the var is sometimes
|
||||
// set to the WebSocket URL); also normalize ws[s]:// to http[s]://.
|
||||
return envUrl
|
||||
.replace(/\/stream\/?$/, "")
|
||||
.replace(/^ws:\/\//, "http://")
|
||||
.replace(/^wss:\/\//, "https://")
|
||||
.replace(/\/+$/, "");
|
||||
}
|
||||
if (typeof window === "undefined") return "http://localhost:5001";
|
||||
return `${window.location.protocol}//${window.location.hostname}:5001`;
|
||||
if (typeof window === "undefined") return "http://localhost:5000";
|
||||
return `${window.location.protocol}//${window.location.hostname}:5000`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch the list of available seeders from a local engine.
|
||||
* Returns null if no local engine is detected (timeout after 2s).
|
||||
* Returns null if no local engine is detected (timeout after 500ms).
|
||||
*
|
||||
* The engine guarantees manifest IDs are already in kebab-case (the seeder's
|
||||
* exported `name` field is the canonical plugin ID). No client-side translation
|
||||
* is needed — what the engine reports is what the frontend uses.
|
||||
*/
|
||||
export async function fetchLocalEngineManifest(): Promise<string[] | null> {
|
||||
if (manifestFetched) return localManifest;
|
||||
|
||||
@@ -20,11 +20,8 @@ function toWsStreamUrl(url: string): string {
|
||||
const DEFAULT_ENGINE_URL = toWsStreamUrl(RAW_ENGINE_URL);
|
||||
|
||||
function getLocalWsUrl() {
|
||||
if (process.env.NEXT_PUBLIC_WWV_PLUGIN_DATA_ENGINE_URL) {
|
||||
return DEFAULT_ENGINE_URL;
|
||||
}
|
||||
if (typeof window === "undefined") return "ws://localhost:5001/stream";
|
||||
return `${window.location.protocol === "https:" ? "wss:" : "ws:"}//${window.location.hostname}:5001/stream`;
|
||||
if (typeof window === "undefined") return "ws://localhost:5000/stream";
|
||||
return `${window.location.protocol === "https:" ? "wss:" : "ws:"}//${window.location.hostname}:5000/stream`;
|
||||
}
|
||||
/**
|
||||
* Resolves the WebSocket engine URL for a given plugin.
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
import { describe, it, expect, vi, afterEach } from "vitest";
|
||||
import { ticketAuthEnabledForPlugin } from "./edition";
|
||||
|
||||
describe("ticketAuthEnabledForPlugin", () => {
|
||||
afterEach(() => {
|
||||
vi.unstubAllEnvs();
|
||||
});
|
||||
|
||||
it("returns false when env var is empty (dormant default)", () => {
|
||||
vi.stubEnv("NEXT_PUBLIC_WWV_TICKET_AUTH_PLUGINS", "");
|
||||
expect(ticketAuthEnabledForPlugin("aviation")).toBe(false);
|
||||
expect(ticketAuthEnabledForPlugin("maritime")).toBe(false);
|
||||
});
|
||||
|
||||
it("returns true only for plugin IDs in the comma-separated list", () => {
|
||||
vi.stubEnv("NEXT_PUBLIC_WWV_TICKET_AUTH_PLUGINS", "aviation,maritime");
|
||||
expect(ticketAuthEnabledForPlugin("aviation")).toBe(true);
|
||||
expect(ticketAuthEnabledForPlugin("maritime")).toBe(true);
|
||||
expect(ticketAuthEnabledForPlugin("wildfire")).toBe(false);
|
||||
});
|
||||
|
||||
it("trims whitespace around plugin IDs", () => {
|
||||
vi.stubEnv("NEXT_PUBLIC_WWV_TICKET_AUTH_PLUGINS", " aviation , maritime ");
|
||||
expect(ticketAuthEnabledForPlugin("aviation")).toBe(true);
|
||||
expect(ticketAuthEnabledForPlugin("maritime")).toBe(true);
|
||||
});
|
||||
|
||||
it("returns false for a partial match (no substring matching)", () => {
|
||||
vi.stubEnv("NEXT_PUBLIC_WWV_TICKET_AUTH_PLUGINS", "aviation");
|
||||
expect(ticketAuthEnabledForPlugin("avi")).toBe(false);
|
||||
});
|
||||
});
|
||||
@@ -99,6 +99,22 @@ export function getDemoAdminSecret(): string | undefined {
|
||||
/** Demo admin session role constant. */
|
||||
export const DEMO_ADMIN_ROLE = "demo-admin";
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Per-plugin ticket auth flag (ADR-001)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Returns true when the given plugin requires WebSocket first-message auth
|
||||
* (i.e., must send a PluginTicket before any subscribe message).
|
||||
*
|
||||
* Controlled by NEXT_PUBLIC_WWV_TICKET_AUTH_PLUGINS (comma-separated plugin IDs).
|
||||
* Empty or unset → ticket auth is disabled for all plugins (dormant / safe default).
|
||||
*/
|
||||
export function ticketAuthEnabledForPlugin(pluginId: string): boolean {
|
||||
const list = process.env.NEXT_PUBLIC_WWV_TICKET_AUTH_PLUGINS ?? "";
|
||||
return list.split(",").map((s) => s.trim()).filter(Boolean).includes(pluginId);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns `true` when the session belongs to the demo admin user.
|
||||
* Accepts any session-like object (uses runtime narrowing to avoid
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
|
||||
|
||||
vi.mock("@sentry/nextjs", () => ({ captureRequestError: vi.fn() }));
|
||||
vi.mock("./sentry.server.config", () => ({}));
|
||||
vi.mock("./sentry.edge.config", () => ({}));
|
||||
|
||||
import { register } from "./instrumentation";
|
||||
|
||||
describe("instrumentation — register()", () => {
|
||||
beforeEach(() => {
|
||||
vi.stubEnv("NEXT_RUNTIME", "nodejs");
|
||||
vi.stubEnv("ENCRYPTION_MASTER_KEY", "test-key-64-chars-abcdef1234567890abcdef");
|
||||
vi.stubEnv("AUTH_SECRET", "test-auth-secret");
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.unstubAllEnvs();
|
||||
});
|
||||
|
||||
it("throws when ENCRYPTION_MASTER_KEY is not set", async () => {
|
||||
vi.stubEnv("ENCRYPTION_MASTER_KEY", "");
|
||||
await expect(register()).rejects.toThrow(
|
||||
"[startup] ENCRYPTION_MASTER_KEY is not set. The server cannot start without it."
|
||||
);
|
||||
});
|
||||
|
||||
it("throws when AUTH_SECRET is not set", async () => {
|
||||
vi.stubEnv("AUTH_SECRET", "");
|
||||
await expect(register()).rejects.toThrow(
|
||||
"[startup] AUTH_SECRET is not set. The server cannot start without it."
|
||||
);
|
||||
});
|
||||
|
||||
it("resolves without throwing when both secrets are set", async () => {
|
||||
await expect(register()).resolves.toBeUndefined();
|
||||
});
|
||||
|
||||
it("does not throw when NEXT_RUNTIME is edge (skips nodejs checks)", async () => {
|
||||
vi.stubEnv("NEXT_RUNTIME", "edge");
|
||||
vi.stubEnv("ENCRYPTION_MASTER_KEY", "");
|
||||
await expect(register()).resolves.toBeUndefined();
|
||||
});
|
||||
});
|
||||
@@ -2,6 +2,13 @@ import * as Sentry from "@sentry/nextjs";
|
||||
|
||||
export async function register() {
|
||||
if (process.env.NEXT_RUNTIME === "nodejs") {
|
||||
// Fail fast at boot — prevents silent zero-key encryption (ADR-001C / Verification §7).
|
||||
if (!process.env.ENCRYPTION_MASTER_KEY) {
|
||||
throw new Error("[startup] ENCRYPTION_MASTER_KEY is not set. The server cannot start without it.");
|
||||
}
|
||||
if (!process.env.AUTH_SECRET) {
|
||||
throw new Error("[startup] AUTH_SECRET is not set. The server cannot start without it.");
|
||||
}
|
||||
await import("./sentry.server.config");
|
||||
}
|
||||
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||
import { describe, it, expect } from "vitest";
|
||||
import { describe, it, expect, beforeAll, afterAll } from "vitest";
|
||||
import { encryptCredential, decryptCredential } from "./encryption";
|
||||
|
||||
describe("AES-256-GCM Encryption with PBKDF2", () => {
|
||||
beforeAll(() => { process.env.ENCRYPTION_MASTER_KEY = "test-master-key-32-chars-padding!!"; });
|
||||
afterAll(() => { delete process.env.ENCRYPTION_MASTER_KEY; });
|
||||
it("should correctly encrypt and decrypt a string", async () => {
|
||||
const secret = "my-super-secret-api-key";
|
||||
|
||||
|
||||
@@ -5,8 +5,11 @@ const ITERATIONS = 100000;
|
||||
const KEY_LENGTH = 32;
|
||||
const DIGEST = "sha256";
|
||||
|
||||
// In production, this should be set in the environment
|
||||
const MASTER_KEY = process.env.ENCRYPTION_MASTER_KEY || "00000000000000000000000000000000";
|
||||
function getMasterKey(): string {
|
||||
const key = process.env.ENCRYPTION_MASTER_KEY;
|
||||
if (!key) throw new Error('[encryption] ENCRYPTION_MASTER_KEY env var is required');
|
||||
return key;
|
||||
}
|
||||
|
||||
export interface EncryptedCredential {
|
||||
version: string;
|
||||
@@ -18,7 +21,7 @@ export interface EncryptedCredential {
|
||||
export async function encryptCredential(plainText: string): Promise<EncryptedCredential> {
|
||||
return new Promise((resolve, reject) => {
|
||||
const salt = crypto.randomBytes(16);
|
||||
crypto.pbkdf2(MASTER_KEY, salt, ITERATIONS, KEY_LENGTH, DIGEST, (err, key) => {
|
||||
crypto.pbkdf2(getMasterKey(), salt, ITERATIONS, KEY_LENGTH, DIGEST, (err, key) => {
|
||||
if (err) return reject(err);
|
||||
|
||||
const nonce = crypto.randomBytes(12);
|
||||
@@ -54,7 +57,7 @@ export async function decryptCredential(cred: EncryptedCredential): Promise<stri
|
||||
const ciphertext = payloadParts[0];
|
||||
const authTag = Buffer.from(payloadParts[1], "base64");
|
||||
|
||||
crypto.pbkdf2(MASTER_KEY, salt, ITERATIONS, KEY_LENGTH, DIGEST, (err, key) => {
|
||||
crypto.pbkdf2(getMasterKey(), salt, ITERATIONS, KEY_LENGTH, DIGEST, (err, key) => {
|
||||
if (err) return reject(err);
|
||||
|
||||
try {
|
||||
|
||||
@@ -0,0 +1,122 @@
|
||||
import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
|
||||
|
||||
vi.mock("@/lib/db", () => ({
|
||||
prisma: {
|
||||
marketplaceCredential: {
|
||||
findUnique: vi.fn(),
|
||||
},
|
||||
},
|
||||
}));
|
||||
|
||||
vi.mock("@/lib/auth/encryption", () => ({
|
||||
decryptCredential: vi.fn(),
|
||||
}));
|
||||
|
||||
// getTicket caches by ENGINE_AUDIENCE across test runs — re-import per test suite
|
||||
// by clearing the module registry so the cache starts fresh.
|
||||
describe("ticketClient", () => {
|
||||
beforeEach(() => {
|
||||
vi.resetModules();
|
||||
vi.resetAllMocks();
|
||||
process.env.MARKETPLACE_URL = "https://marketplace.test";
|
||||
process.env.ENCRYPTION_MASTER_KEY = "test-key-32-chars-xxxxxxxxxxx!!";
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
delete process.env.MARKETPLACE_URL;
|
||||
delete process.env.ENCRYPTION_MASTER_KEY;
|
||||
});
|
||||
|
||||
it("fetches a ticket, caches it, and returns the same token on the second call", async () => {
|
||||
const { prisma } = await import("@/lib/db");
|
||||
const { decryptCredential } = await import("@/lib/auth/encryption");
|
||||
const { getTicket } = await import("./ticketClient");
|
||||
|
||||
const mockCred = { tenantId: "local", version: "v1", salt: "s", nonce: "n", ciphertext: "c" };
|
||||
vi.mocked(prisma.marketplaceCredential.findUnique).mockResolvedValue(mockCred as never);
|
||||
vi.mocked(decryptCredential).mockResolvedValue("my-api-key");
|
||||
|
||||
const fetchSpy = vi.spyOn(globalThis, "fetch").mockResolvedValue(
|
||||
new Response(JSON.stringify({ token: "ticket-abc" }), { status: 200 })
|
||||
);
|
||||
|
||||
const t1 = await getTicket("aviation");
|
||||
const t2 = await getTicket("aviation");
|
||||
|
||||
expect(t1).toBe("ticket-abc");
|
||||
expect(t2).toBe("ticket-abc");
|
||||
// fetch should be called only once — second call hits cache
|
||||
expect(fetchSpy).toHaveBeenCalledTimes(1);
|
||||
|
||||
fetchSpy.mockRestore();
|
||||
});
|
||||
|
||||
it("sends the correct body to the Marketplace exchange endpoint", async () => {
|
||||
const { prisma } = await import("@/lib/db");
|
||||
const { decryptCredential } = await import("@/lib/auth/encryption");
|
||||
const { getTicket } = await import("./ticketClient");
|
||||
|
||||
const mockCred = { tenantId: "local", version: "v1", salt: "s", nonce: "n", ciphertext: "c" };
|
||||
vi.mocked(prisma.marketplaceCredential.findUnique).mockResolvedValue(mockCred as never);
|
||||
vi.mocked(decryptCredential).mockResolvedValue("my-api-key");
|
||||
|
||||
const fetchSpy = vi.spyOn(globalThis, "fetch").mockResolvedValue(
|
||||
new Response(JSON.stringify({ token: "ticket-xyz" }), { status: 200 })
|
||||
);
|
||||
|
||||
await getTicket("maritime");
|
||||
|
||||
expect(fetchSpy).toHaveBeenCalledOnce();
|
||||
const [url, init] = fetchSpy.mock.calls[0];
|
||||
expect(url).toBe("https://marketplace.test/api/auth/exchange");
|
||||
expect(init?.method).toBe("POST");
|
||||
|
||||
const body = JSON.parse(init?.body as string);
|
||||
expect(body.apiKey).toBe("my-api-key"); // camelCase — matches Marketplace
|
||||
expect(body.audience).toBe("wwv-data-engine"); // engine-scoped per ADR-001B
|
||||
expect(body.plugin_id).toBe("maritime"); // retained for future scoping
|
||||
|
||||
fetchSpy.mockRestore();
|
||||
});
|
||||
|
||||
it("throws when no MarketplaceCredential row exists", async () => {
|
||||
const { prisma } = await import("@/lib/db");
|
||||
const { getTicket } = await import("./ticketClient");
|
||||
|
||||
vi.mocked(prisma.marketplaceCredential.findUnique).mockResolvedValue(null);
|
||||
|
||||
await expect(getTicket("aviation")).rejects.toThrow("No marketplace credential found");
|
||||
});
|
||||
|
||||
it("throws on a non-OK response from the Marketplace", async () => {
|
||||
const { prisma } = await import("@/lib/db");
|
||||
const { decryptCredential } = await import("@/lib/auth/encryption");
|
||||
const { getTicket } = await import("./ticketClient");
|
||||
|
||||
const mockCred = { tenantId: "local", version: "v1", salt: "s", nonce: "n", ciphertext: "c" };
|
||||
vi.mocked(prisma.marketplaceCredential.findUnique).mockResolvedValue(mockCred as never);
|
||||
vi.mocked(decryptCredential).mockResolvedValue("my-api-key");
|
||||
|
||||
vi.spyOn(globalThis, "fetch").mockResolvedValueOnce(
|
||||
new Response(JSON.stringify({ error: "Unauthorized" }), { status: 401 })
|
||||
);
|
||||
|
||||
await expect(getTicket("aviation")).rejects.toThrow("Token exchange failed (401)");
|
||||
});
|
||||
|
||||
it("throws when the Marketplace response is missing the token field", async () => {
|
||||
const { prisma } = await import("@/lib/db");
|
||||
const { decryptCredential } = await import("@/lib/auth/encryption");
|
||||
const { getTicket } = await import("./ticketClient");
|
||||
|
||||
const mockCred = { tenantId: "local", version: "v1", salt: "s", nonce: "n", ciphertext: "c" };
|
||||
vi.mocked(prisma.marketplaceCredential.findUnique).mockResolvedValue(mockCred as never);
|
||||
vi.mocked(decryptCredential).mockResolvedValue("my-api-key");
|
||||
|
||||
vi.spyOn(globalThis, "fetch").mockResolvedValueOnce(
|
||||
new Response(JSON.stringify({}), { status: 200 })
|
||||
);
|
||||
|
||||
await expect(getTicket("aviation")).rejects.toThrow("missing 'token' field");
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,75 @@
|
||||
import type { PluginTicket } from "@worldwideview/wwv-plugin-sdk";
|
||||
import { decryptCredential } from "@/lib/auth/encryption";
|
||||
import { prisma as db } from "@/lib/db";
|
||||
|
||||
interface CacheEntry {
|
||||
ticket: PluginTicket;
|
||||
/** Unix ms — the ticket is considered stale 30s before the 5-min expiry */
|
||||
expiresAt: number;
|
||||
}
|
||||
|
||||
const TICKET_LIFETIME_MS = 4.5 * 60 * 1000; // refresh 30s before the 5-min expiry
|
||||
|
||||
// Per ADR-001B: audience = the Data Engine's ENGINE_ID (default "wwv-data-engine").
|
||||
// Per-engine audiences (true multi-engine decentralisation) are a follow-up.
|
||||
const ENGINE_AUDIENCE = "wwv-data-engine";
|
||||
|
||||
// Cache is keyed by audience, not pluginId — the ticket is user/engine-scoped.
|
||||
// All plugins on the same engine share one ticket, avoiding redundant exchange calls.
|
||||
const cache = new Map<string, CacheEntry>();
|
||||
|
||||
function getMarketplaceUrl(): string {
|
||||
return (
|
||||
process.env.MARKETPLACE_URL ||
|
||||
process.env.NEXT_PUBLIC_WWV_MARKETPLACE_URL ||
|
||||
"https://app.worldwideview.dev"
|
||||
);
|
||||
}
|
||||
|
||||
async function fetchTicket(pluginId: string): Promise<PluginTicket> {
|
||||
const cred = await db.marketplaceCredential.findUnique({
|
||||
where: { tenantId: "local" },
|
||||
});
|
||||
if (!cred) {
|
||||
throw new Error(`[ticketClient] No marketplace credential found. Complete the PKCE flow first.`);
|
||||
}
|
||||
|
||||
const apiKey = await decryptCredential(cred);
|
||||
const url = `${getMarketplaceUrl()}/api/auth/exchange`;
|
||||
|
||||
const response = await fetch(url, {
|
||||
method: "POST",
|
||||
headers: { "Content-Type": "application/json" },
|
||||
// apiKey camelCase — matches the Marketplace /api/auth/exchange destructure.
|
||||
// audience = engine ID per ADR-001B, not pluginId.
|
||||
// plugin_id retained for future Marketplace entitlement scoping.
|
||||
body: JSON.stringify({ apiKey, audience: ENGINE_AUDIENCE, plugin_id: pluginId }),
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
const body = await response.text().catch(() => "");
|
||||
throw new Error(`[ticketClient] Token exchange failed (${response.status}): ${body}`);
|
||||
}
|
||||
|
||||
const data = await response.json() as { token?: string };
|
||||
if (!data.token) {
|
||||
throw new Error("[ticketClient] Token exchange response missing 'token' field.");
|
||||
}
|
||||
|
||||
return data.token as PluginTicket;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a short-lived PluginTicket for the given plugin ID.
|
||||
* Results are cached by engine audience; the ticket is refreshed 30s before expiry (4.5-min window).
|
||||
*/
|
||||
export async function getTicket(pluginId: string): Promise<PluginTicket> {
|
||||
const cached = cache.get(ENGINE_AUDIENCE);
|
||||
if (cached && cached.expiresAt > Date.now()) {
|
||||
return cached.ticket;
|
||||
}
|
||||
|
||||
const ticket = await fetchTicket(pluginId);
|
||||
cache.set(ENGINE_AUDIENCE, { ticket, expiresAt: Date.now() + TICKET_LIFETIME_MS });
|
||||
return ticket;
|
||||
}
|
||||
@@ -1,31 +0,0 @@
|
||||
/**
|
||||
* Marketplace plugins automatically installed on fresh instances.
|
||||
*
|
||||
* These provide a rich out-of-the-box experience — the globe looks alive
|
||||
* from the very first load. Users can uninstall any of these afterwards.
|
||||
*
|
||||
* All core plugins are now installed via marketplace defaults.
|
||||
*/
|
||||
export const DEFAULT_PLUGIN_IDS = [
|
||||
"aviation",
|
||||
"maritime",
|
||||
"military-aviation",
|
||||
"wildfire",
|
||||
"camera",
|
||||
"borders",
|
||||
"osm-search",
|
||||
"earthquakes",
|
||||
"satellite",
|
||||
"daynight",
|
||||
"conflict-zones",
|
||||
"volcanoes",
|
||||
"airports",
|
||||
"international-sanctions",
|
||||
"gps-jamming",
|
||||
"fortiguard",
|
||||
"nz-traffic-cameras",
|
||||
"air-defense",
|
||||
"civil-unrest",
|
||||
"conflict-events",
|
||||
"cyber-attacks",
|
||||
] as const;
|
||||
@@ -1,5 +1,6 @@
|
||||
import { SignJWT, jwtVerify } from "jose";
|
||||
import { randomUUID } from "crypto";
|
||||
import type { MarketplaceSessionToken } from "@worldwideview/wwv-plugin-sdk";
|
||||
|
||||
const SCOPE = "marketplace";
|
||||
const ISSUER = "worldwideview";
|
||||
@@ -17,10 +18,11 @@ function getSecret(): Uint8Array {
|
||||
}
|
||||
|
||||
/**
|
||||
* Issue a JWT scoped to marketplace API access, bound to a specific user.
|
||||
* Issue a marketplace session JWT scoped to API access, bound to a specific user.
|
||||
* Signed with AUTH_SECRET — no database required.
|
||||
* Returns a branded MarketplaceSessionToken to prevent accidental use as a WebSocket credential.
|
||||
*/
|
||||
export async function issueMarketplaceToken(userId: string): Promise<string> {
|
||||
export async function issueMarketplaceToken(userId: string): Promise<MarketplaceSessionToken> {
|
||||
return new SignJWT({ scope: SCOPE })
|
||||
.setProtectedHeader({ alg: "HS256" })
|
||||
.setSubject(userId)
|
||||
@@ -29,7 +31,7 @@ export async function issueMarketplaceToken(userId: string): Promise<string> {
|
||||
.setJti(randomUUID())
|
||||
.setIssuedAt()
|
||||
.setExpirationTime(EXPIRY)
|
||||
.sign(getSecret());
|
||||
.sign(getSecret()) as Promise<MarketplaceSessionToken>;
|
||||
}
|
||||
|
||||
export interface MarketplaceTokenPayload {
|
||||
|
||||
@@ -4,7 +4,6 @@ import {
|
||||
} from "vitest";
|
||||
|
||||
import { seedDefaultPlugins } from "./seedDefaultPlugins";
|
||||
import { DEFAULT_PLUGIN_IDS } from "./defaultPlugins";
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Mocks — must be declared before importing the module under test
|
||||
@@ -50,6 +49,9 @@ vi.stubGlobal("fetch", mockFetch);
|
||||
// Helpers
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/** Fake verified registry payload used by most tests. */
|
||||
const FAKE_VERIFIED_IDS = ["aviation", "maritime", "surveillance-satellites"];
|
||||
|
||||
function fakeManifest(id: string) {
|
||||
return {
|
||||
id,
|
||||
@@ -72,10 +74,11 @@ describe("seedDefaultPlugins", () => {
|
||||
mockIsDemo = false;
|
||||
delete process.env.WWV_SKIP_DEFAULT_PLUGINS;
|
||||
|
||||
// Defaults: not seeded, no existing plugins, manifests valid
|
||||
// Defaults: not seeded, no existing plugins, manifests valid,
|
||||
// verified registry returns the fake set.
|
||||
mockFindFirst.mockResolvedValue(null);
|
||||
mockCount.mockResolvedValue(0);
|
||||
mockGetVerifiedPluginIds.mockResolvedValue(new Set(DEFAULT_PLUGIN_IDS));
|
||||
mockGetVerifiedPluginIds.mockResolvedValue(new Set(FAKE_VERIFIED_IDS));
|
||||
mockValidateManifest.mockReturnValue({ valid: true, errors: [] });
|
||||
mockUpsertPlugin.mockResolvedValue({});
|
||||
mockCreate.mockResolvedValue({});
|
||||
@@ -90,11 +93,11 @@ describe("seedDefaultPlugins", () => {
|
||||
}));
|
||||
});
|
||||
|
||||
it("seeds all default plugins on a fresh install", async () => {
|
||||
it("seeds every plugin in the verified registry on a fresh install", async () => {
|
||||
await seedDefaultPlugins();
|
||||
|
||||
expect(mockUpsertPlugin).toHaveBeenCalledTimes(DEFAULT_PLUGIN_IDS.length);
|
||||
for (const id of DEFAULT_PLUGIN_IDS) {
|
||||
expect(mockUpsertPlugin).toHaveBeenCalledTimes(FAKE_VERIFIED_IDS.length);
|
||||
for (const id of FAKE_VERIFIED_IDS) {
|
||||
expect(mockUpsertPlugin).toHaveBeenCalledWith(
|
||||
id,
|
||||
"1.0.0",
|
||||
@@ -117,6 +120,7 @@ describe("seedDefaultPlugins", () => {
|
||||
|
||||
expect(mockUpsertPlugin).not.toHaveBeenCalled();
|
||||
expect(mockFetch).not.toHaveBeenCalled();
|
||||
expect(mockGetVerifiedPluginIds).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("marks seeded without installing when plugins already exist", async () => {
|
||||
@@ -133,14 +137,28 @@ describe("seedDefaultPlugins", () => {
|
||||
);
|
||||
});
|
||||
|
||||
it("handles marketplace API failure gracefully", async () => {
|
||||
it("does not markSeeded when the verified registry is empty", async () => {
|
||||
// Simulates registry outage / signature failure / no cache
|
||||
mockGetVerifiedPluginIds.mockResolvedValue(new Set<string>());
|
||||
|
||||
await seedDefaultPlugins();
|
||||
|
||||
expect(mockUpsertPlugin).not.toHaveBeenCalled();
|
||||
expect(mockFetch).not.toHaveBeenCalled();
|
||||
// Critical: guard row is NOT written so the next request retries
|
||||
expect(mockCreate).not.toHaveBeenCalled();
|
||||
expect(mockUpdateMany).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("handles marketplace manifest fetch failure gracefully", async () => {
|
||||
mockFetch.mockRejectedValue(new Error("Network error"));
|
||||
|
||||
await seedDefaultPlugins();
|
||||
|
||||
// Should NOT throw
|
||||
// No upserts (every manifest fetch failed), but guard row IS written
|
||||
// — we got a non-empty verified set, so seeding completed (with zero
|
||||
// successes); next request shouldn't retry the whole flow.
|
||||
expect(mockUpsertPlugin).not.toHaveBeenCalled();
|
||||
// Guard row still written (fail-safe)
|
||||
expect(mockCreate).toHaveBeenCalled();
|
||||
});
|
||||
|
||||
@@ -151,6 +169,7 @@ describe("seedDefaultPlugins", () => {
|
||||
|
||||
expect(mockUpsertPlugin).not.toHaveBeenCalled();
|
||||
expect(mockFetch).not.toHaveBeenCalled();
|
||||
expect(mockGetVerifiedPluginIds).not.toHaveBeenCalled();
|
||||
// Guard row written so it doesn't re-check
|
||||
expect(mockCreate).toHaveBeenCalled();
|
||||
});
|
||||
@@ -162,6 +181,7 @@ describe("seedDefaultPlugins", () => {
|
||||
|
||||
expect(mockUpsertPlugin).not.toHaveBeenCalled();
|
||||
expect(mockFetch).not.toHaveBeenCalled();
|
||||
expect(mockGetVerifiedPluginIds).not.toHaveBeenCalled();
|
||||
expect(mockCreate).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
@@ -177,25 +197,16 @@ describe("seedDefaultPlugins", () => {
|
||||
await seedDefaultPlugins();
|
||||
|
||||
// One fewer than total (the first was skipped)
|
||||
expect(mockUpsertPlugin).toHaveBeenCalledTimes(DEFAULT_PLUGIN_IDS.length - 1);
|
||||
expect(mockUpsertPlugin).toHaveBeenCalledTimes(FAKE_VERIFIED_IDS.length - 1);
|
||||
});
|
||||
|
||||
it("stamps trust from the verified registry", async () => {
|
||||
const firstId = DEFAULT_PLUGIN_IDS[0];
|
||||
// Only the first plugin is verified
|
||||
mockGetVerifiedPluginIds.mockResolvedValue(new Set([firstId]));
|
||||
|
||||
it("stamps every seeded plugin as verified", async () => {
|
||||
await seedDefaultPlugins();
|
||||
|
||||
// Check the first call has "verified"
|
||||
const firstCall = mockUpsertPlugin.mock.calls[0];
|
||||
expect(firstCall[0]).toBe(firstId);
|
||||
const firstManifest = JSON.parse(firstCall[2]);
|
||||
expect(firstManifest.trust).toBe("verified");
|
||||
|
||||
// Check a non-verified one
|
||||
const secondCall = mockUpsertPlugin.mock.calls[1];
|
||||
const secondManifest = JSON.parse(secondCall[2]);
|
||||
expect(secondManifest.trust).toBe("unverified");
|
||||
expect(mockUpsertPlugin).toHaveBeenCalledTimes(FAKE_VERIFIED_IDS.length);
|
||||
for (const call of mockUpsertPlugin.mock.calls) {
|
||||
const manifest = JSON.parse(call[2]);
|
||||
expect(manifest.trust).toBe("verified");
|
||||
}
|
||||
});
|
||||
});
|
||||
@@ -1,8 +1,6 @@
|
||||
/* eslint-disable no-console */
|
||||
import { isDemo } from "@/core/edition";
|
||||
import { validateManifest } from "@/core/plugins/validateManifest";
|
||||
import { prisma } from "../db";
|
||||
import { DEFAULT_PLUGIN_IDS } from "./defaultPlugins";
|
||||
import { upsertPlugin } from "./repository";
|
||||
import { getVerifiedPluginIds } from "./registryClient";
|
||||
|
||||
@@ -10,16 +8,20 @@ const MARKETPLACE_URL = process.env.NEXT_PUBLIC_MARKETPLACE_URL
|
||||
|| "https://marketplace.worldwideview.dev";
|
||||
|
||||
/**
|
||||
* Seed default marketplace plugins on a fresh install.
|
||||
* Seed verified marketplace plugins on a fresh install.
|
||||
*
|
||||
* Runs once per instance lifecycle — an idempotent guard
|
||||
* (`defaults_seeded` in the Setting table) prevents re-runs.
|
||||
* The signed registry (`getVerifiedPluginIds`) is the single source of truth
|
||||
* for which plugins land in a brand-new instance — there is no hard-coded
|
||||
* default list. Publish a plugin to the verified registry and it auto-seeds
|
||||
* on subsequent fresh installs.
|
||||
*
|
||||
* Like the "sample data" that ships with a new app: the seeder
|
||||
* writes records to the database on first boot, then never runs again.
|
||||
* Runs at most once per instance lifecycle: an idempotent guard
|
||||
* (`defaults_seeded` in the Setting table) prevents re-runs. If the registry
|
||||
* is empty or unreachable on first attempt, the guard is NOT set — the next
|
||||
* request retries.
|
||||
*
|
||||
* Errors are logged but never thrown — a failed seed must never
|
||||
* block the application from starting.
|
||||
* Errors are logged but never thrown — a failed seed must never block the
|
||||
* application from starting.
|
||||
*/
|
||||
export async function seedDefaultPlugins(): Promise<void> {
|
||||
try {
|
||||
@@ -45,22 +47,29 @@ export async function seedDefaultPlugins(): Promise<void> {
|
||||
return;
|
||||
}
|
||||
|
||||
const verified = await getVerifiedPluginIds();
|
||||
if (verified.size === 0) {
|
||||
// Registry unreachable / signature failed / empty — defer so the
|
||||
// next request retries instead of locking in an empty fresh install.
|
||||
console.warn(
|
||||
"[DefaultPlugins] Verified registry returned empty — deferring seed, will retry next request",
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
console.log(
|
||||
`[DefaultPlugins] Fresh install detected — seeding ${DEFAULT_PLUGIN_IDS.length} default plugins…`,
|
||||
`[DefaultPlugins] Fresh install detected — seeding ${verified.size} verified plugins…`,
|
||||
);
|
||||
|
||||
const verified = await getVerifiedPluginIds();
|
||||
let installed = 0;
|
||||
|
||||
for (const pluginId of DEFAULT_PLUGIN_IDS) {
|
||||
for (const pluginId of verified) {
|
||||
try {
|
||||
const manifest = await fetchManifest(pluginId);
|
||||
if (!manifest) continue;
|
||||
|
||||
// Server-side trust stamping
|
||||
manifest.trust = verified.has(pluginId)
|
||||
? "verified"
|
||||
: "unverified";
|
||||
// Every plugin in the verified set is by definition verified.
|
||||
manifest.trust = "verified";
|
||||
|
||||
// Reconstruct CDN entry for npm-distributed plugins
|
||||
if (manifest.npmPackage) {
|
||||
@@ -93,7 +102,7 @@ export async function seedDefaultPlugins(): Promise<void> {
|
||||
|
||||
await markSeeded();
|
||||
console.log(
|
||||
`[DefaultPlugins] Seeded ${installed}/${DEFAULT_PLUGIN_IDS.length} plugins`,
|
||||
`[DefaultPlugins] Seeded ${installed}/${verified.size} plugins`,
|
||||
);
|
||||
} catch (err) {
|
||||
console.error("[DefaultPlugins] Seeder failed:", err);
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { describe, it, expect } from "vitest";
|
||||
import { describe, it, expect, afterEach } from "vitest";
|
||||
import { safeFetch, validateOrigin, isPrivateIP } from "./ssrf";
|
||||
|
||||
describe("SSRF Protection Utility", () => {
|
||||
@@ -34,8 +34,42 @@ describe("SSRF Protection Utility", () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe("checkHostAllowlist via safeFetch", () => {
|
||||
const originalAllowlist = process.env.PROXY_HOST_ALLOWLIST;
|
||||
|
||||
afterEach(() => {
|
||||
if (originalAllowlist === undefined) {
|
||||
delete process.env.PROXY_HOST_ALLOWLIST;
|
||||
} else {
|
||||
process.env.PROXY_HOST_ALLOWLIST = originalAllowlist;
|
||||
}
|
||||
});
|
||||
|
||||
it("denies all when PROXY_HOST_ALLOWLIST is unset", async () => {
|
||||
delete process.env.PROXY_HOST_ALLOWLIST;
|
||||
await expect(safeFetch("https://camera.example.com/feed")).rejects.toThrow(/SSRF.*PROXY_HOST_ALLOWLIST/);
|
||||
});
|
||||
|
||||
it("denies all when PROXY_HOST_ALLOWLIST is empty string", async () => {
|
||||
process.env.PROXY_HOST_ALLOWLIST = "";
|
||||
await expect(safeFetch("https://camera.example.com/feed")).rejects.toThrow(/SSRF.*PROXY_HOST_ALLOWLIST/);
|
||||
});
|
||||
|
||||
it("rejects a host not in the concrete allowlist", async () => {
|
||||
process.env.PROXY_HOST_ALLOWLIST = "allowed.example.com";
|
||||
await expect(safeFetch("https://blocked.example.com/feed")).rejects.toThrow(/not in PROXY_HOST_ALLOWLIST/);
|
||||
});
|
||||
|
||||
it("passes the allowlist check for '*' but still rejects private IPs", async () => {
|
||||
process.env.PROXY_HOST_ALLOWLIST = "*";
|
||||
// Private IP clears the allowlist but the post-DNS private-IP check still fires
|
||||
await expect(safeFetch("https://127.0.0.1/data")).rejects.toThrow(/SSRF/);
|
||||
});
|
||||
});
|
||||
|
||||
describe("safeFetch", () => {
|
||||
it("should reject private IPs immediately", async () => {
|
||||
process.env.PROXY_HOST_ALLOWLIST = "*"; // bypass allowlist for these tests
|
||||
await expect(safeFetch("https://127.0.0.1/data")).rejects.toThrow(/SSRF/);
|
||||
await expect(safeFetch("https://169.254.169.254/latest/meta-data")).rejects.toThrow(/SSRF/);
|
||||
});
|
||||
|
||||
@@ -22,7 +22,31 @@ interface FetchOptions extends RequestInit {
|
||||
timeout?: number;
|
||||
}
|
||||
|
||||
function checkHostAllowlist(hostname: string): void {
|
||||
const raw = process.env.PROXY_HOST_ALLOWLIST ?? "";
|
||||
const allowlist = raw.trim();
|
||||
|
||||
if (allowlist === "*") {
|
||||
console.warn(`[SSRF] PROXY_HOST_ALLOWLIST="*" — permissive mode, host: ${hostname}. Populate the list from WARN logs then tighten.`);
|
||||
return;
|
||||
}
|
||||
|
||||
if (!allowlist) {
|
||||
throw new Error(`SSRF Error: PROXY_HOST_ALLOWLIST is not configured. Set to "*" to allow all (permissive) or a comma-separated host list.`);
|
||||
}
|
||||
|
||||
const allowed = allowlist.split(",").map((h) => h.trim()).filter(Boolean);
|
||||
if (!allowed.includes(hostname)) {
|
||||
throw new Error(`SSRF Error: Host "${hostname}" is not in PROXY_HOST_ALLOWLIST.`);
|
||||
}
|
||||
}
|
||||
|
||||
export async function safeFetch(urlStr: string, options: FetchOptions = {}): Promise<Response> {
|
||||
const hostForCheck = (() => {
|
||||
try { return new URL(urlStr).hostname; } catch { return ""; }
|
||||
})();
|
||||
checkHostAllowlist(hostForCheck);
|
||||
|
||||
if (!validateOrigin(urlStr)) {
|
||||
throw new Error("SSRF Error: Invalid protocol. Only HTTPS is allowed.");
|
||||
}
|
||||
|
||||
Reference in new issue
Block a user