Compare commits
176
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
02d8355a83 | ||
|
|
0ff1d23e4a | ||
|
|
598e00171c | ||
|
|
caf1638fdc | ||
|
|
ad3c7845a5 | ||
|
|
339bf6c0f3 | ||
|
|
16c82c9184 | ||
|
|
ad324a6592 | ||
|
|
0a51e198d7 | ||
|
|
1d6381182e | ||
|
|
beb295445f | ||
|
|
dd62116351 | ||
|
|
d675d91441 | ||
|
|
fb07195ec2 | ||
|
|
1838f1a5cd | ||
|
|
28e4e67043 | ||
|
|
594f85afb2 | ||
|
|
b29133fca0 | ||
|
|
ac0092c8a8 | ||
|
|
f0daefd53d | ||
|
|
94f8a47e0d | ||
|
|
161401a0af | ||
|
|
399b811c7e | ||
|
|
786e60865a | ||
|
|
ded2d587e4 | ||
|
|
b177c6987d | ||
|
|
b11125fd5f | ||
|
|
db1a9ad191 | ||
|
|
cfd8e4b7d0 | ||
|
|
a475a5a562 | ||
|
|
8f859f4559 | ||
|
|
8a594d28ea | ||
|
|
382ceed2f1 | ||
|
|
df072feea7 | ||
|
|
943ab91564 | ||
|
|
7a262c617c | ||
|
|
a69b1d9aac | ||
|
|
a1b3a71e6e | ||
|
|
338cde0813 | ||
|
|
b7311268f8 | ||
|
|
54078f351c | ||
|
|
a149be8560 | ||
|
|
10fdafbdb6 | ||
|
|
2280fc4d19 | ||
|
|
118106ff8f | ||
|
|
6a915cca62 | ||
|
|
42dadd0b40 | ||
|
|
583c0e57a6 | ||
|
|
ae14a30168 | ||
|
|
019b427442 | ||
|
|
04beadc0e2 | ||
|
|
cf67c5d96f | ||
|
|
bf7e9c4bee | ||
|
|
a1c4fed23b | ||
|
|
e6c7dcf295 | ||
|
|
9e44e91d81 | ||
|
|
c6cd515588 | ||
|
|
0f871729c0 | ||
|
|
e73f81d6fe | ||
|
|
f5235bf219 | ||
|
|
19f10d25df | ||
|
|
3ddd6ec150 | ||
|
|
e26aee6dd2 | ||
|
|
42f4701fda | ||
|
|
4c6978ea90 | ||
|
|
3c03b4e7a4 | ||
|
|
d2bdb0cee8 | ||
|
|
335b74a486 | ||
|
|
014a360d5d | ||
|
|
21adb9f2e8 | ||
|
|
b792dc0373 | ||
|
|
cbbc38ecc9 | ||
|
|
bbb231541b | ||
|
|
70fd3e1818 | ||
|
|
0ee8ae700c | ||
|
|
2c17b1e701 | ||
|
|
2ed8da0e1c | ||
|
|
9006064240 | ||
|
|
fe2cfa9dac | ||
|
|
84f3691c22 | ||
|
|
f9384b8244 | ||
|
|
d0ae85049f | ||
|
|
64815c114c | ||
|
|
e86fdf56d0 | ||
|
|
c25a1e6d58 | ||
|
|
f9c8bcff17 | ||
|
|
008e8cd01d | ||
|
|
1d1c7b270b | ||
|
|
63a5e5d8a1 | ||
|
|
39c1172b0b | ||
|
|
09ac165420 | ||
|
|
1daa8a6979 | ||
|
|
2c97f8e1e3 | ||
|
|
1fb830e962 | ||
|
|
5e542c3ca6 | ||
|
|
7e25fdfba2 | ||
|
|
c56987d6ce | ||
|
|
40888fb7dd | ||
|
|
1845a1ced9 | ||
|
|
e6305ca92f | ||
|
|
ebd9106cb8 | ||
|
|
51c8c28a08 | ||
|
|
9b7c41834c | ||
|
|
98c724a8c8 | ||
|
|
e6e0b8cbd4 | ||
|
|
98ab6372a1 | ||
|
|
772754e069 | ||
|
|
a254784c3a | ||
|
|
4889d7abea | ||
|
|
045eb03440 | ||
|
|
a773336d4b | ||
|
|
fcbe5f460e | ||
|
|
ab80dad42b | ||
|
|
69b66b44c9 | ||
|
|
e1d2c38687 | ||
|
|
1e21de55d7 | ||
|
|
c480bfdbd2 | ||
|
|
8dcb9f406d | ||
|
|
0625371ed4 | ||
|
|
45a213ac09 | ||
|
|
753071224e | ||
|
|
93504624ae | ||
|
|
ca17552d3d | ||
|
|
a9934f471e | ||
|
|
25e4280cad | ||
|
|
2e30a04ff1 | ||
|
|
6adb693f53 | ||
|
|
ef323f2c57 | ||
|
|
215dd9251c | ||
|
|
ce081c21fc | ||
|
|
0634712802 | ||
|
|
179dbdfad2 | ||
|
|
62d344baec | ||
|
|
6a3b143614 | ||
|
|
6cb7be0de1 | ||
|
|
1e59c9868e | ||
|
|
af1915805a | ||
|
|
d8205e6c3a | ||
|
|
e5b686c556 | ||
|
|
400a6abe74 | ||
|
|
6c8163dae3 | ||
|
|
e0ac5041c2 | ||
|
|
0b64459cfe | ||
|
|
e917caf7f1 | ||
|
|
6730aaff13 | ||
|
|
7c1fce98bd | ||
|
|
30bee799e1 | ||
|
|
031a073cf9 | ||
|
|
43d6a057ba | ||
|
|
9c03edb65c | ||
|
|
9f1f39203e | ||
|
|
9b459206d6 | ||
|
|
cd44a41c5d | ||
|
|
82cc79fa45 | ||
|
|
fdc722de51 | ||
|
|
be692fadaa | ||
|
|
eb12866d03 | ||
|
|
c279b7c3d1 | ||
|
|
b6d14dd720 | ||
|
|
72f485f405 | ||
|
|
8f82310e3d | ||
|
|
3fe9edf6f3 | ||
|
|
0156ead243 | ||
|
|
7bd6b32121 | ||
|
|
bc10b09788 | ||
|
|
45c41fd2a0 | ||
|
|
78fb1dc484 | ||
|
|
5fb36069ac | ||
|
|
c4207bd6e1 | ||
|
|
138ea6c721 | ||
|
|
dc10e8ad5c | ||
|
|
84f694f93b | ||
|
|
fa60f845c1 | ||
|
|
6e3a8ab625 | ||
|
|
739bffa05b | ||
|
|
9888f11a4b |
No files matched your search
@@ -0,0 +1,169 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
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/**/*"
|
||||
---
|
||||
|
||||
# Cesium Rendering Rules
|
||||
|
||||
## Purpose
|
||||
Strict guidelines for rendering geospatial entities, handling 3D terrain clipping, and applying dynamic animation properties against Cesium's runtime engine.
|
||||
|
||||
## When to Apply
|
||||
Whenever writing code for plugins, visual layers, or modifying components like `EntityRenderer` or `GlobeView`.
|
||||
|
||||
## Critical Limitations
|
||||
|
||||
### `HeightReference.CLAMP_TO_GROUND` Warning
|
||||
> [!WARNING]
|
||||
> Do **not** apply `HeightReference.CLAMP_TO_GROUND` to label text rendering (`LabelGraphics`). Due to a known issue in Cesium 1.121+, clamping tens of thousands of dynamic labels blocks the UI thread continuously because Cesium recalculates the terrain intersection each frame.
|
||||
|
||||
### Primitive Restrictions
|
||||
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.
|
||||
|
||||
## Performance Culling
|
||||
|
||||
> [!TIP]
|
||||
> Do not rely solely on depth buffering (`disableDepthTestDistance`) when viewing the backside of the globe. Use CPU-side calculating (dot-product against the Earth's radius) to implement manual horizon culling. Render nothing if the scalar projection is behind the tangential threshold.
|
||||
|
||||
## LOD & Stacking
|
||||
1. Convert distant entities to `billboard` representations.
|
||||
2. If closely grouped, the `StackManager` should spiderify components circularly. Non-hub objects fade to 0.4 opacity when expanded to reduce visual clutter.
|
||||
3. Use the `useModelRendering` hook exclusively for transitioning high-importance entities (like aircraft or ships) into full 3D GLTF models on approach.
|
||||
@@ -0,0 +1,226 @@
|
||||
---
|
||||
trigger: model_decision
|
||||
description: Cloud edition implementation details, PostgreSQL Row-Level Security (RLS) isolation, cross-subdomain auth, and cryptographic license keys.
|
||||
---
|
||||
|
||||
# WorldWideView — Cloud & Auth Architecture
|
||||
|
||||
|
||||
> [!NOTE]
|
||||
> **This file contains the master plan and advanced implementation details for the future Cloud edition.**
|
||||
> It covers single-container multi-tenancy, PostgreSQL Row-Level Security (RLS) isolation, cross-subdomain auth, and cryptographic license keys. It is intended for AI reference when building multi-tenant or auth-related features.
|
||||
|
||||
---
|
||||
|
||||
## Auth Strategy
|
||||
|
||||
**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
|
||||
// src/lib/auth.ts
|
||||
const providers = isCloud
|
||||
? [SupabaseProvider({ /* delegates to Supabase Auth (GoTrue) */ })]
|
||||
: [Credentials({ /* local bcrypt + PostgreSQL */ })];
|
||||
|
||||
export const { auth, signIn, signOut } = NextAuth({ providers });
|
||||
```
|
||||
|
||||
Application code is **identical** across editions — always calls `auth()`, `signIn()`, `signOut()`.
|
||||
|
||||
**One account for the entire ecosystem:**
|
||||
- Cloud instance (`[user].app.worldwideview.dev`)
|
||||
- Marketplace (browse, install, publish) — via SSO redirect
|
||||
- Local instance Bridge API connection
|
||||
|
||||
**Marketplace never owns auth UI** — it redirects to `app.worldwideview.dev/login?redirect_to=marketplace...` for all sign-in.
|
||||
|
||||
---
|
||||
|
||||
## Decentralized Plugin Authentication (Token Exchange)
|
||||
|
||||
For cross-domain plugin communication (Local App connecting to Marketplace or Data Engines), WWV uses an **Asymmetric JWT Token Exchange (PKCE)** model.
|
||||
- **PKCE Flow**: The Local App uses standard OAuth 2.0 PKCE to exchange a `code` for a long-lived API key from the Marketplace.
|
||||
- **Token Exchange**: The Local App exchanges its long-lived API key for a short-lived, audience-bound JWT before connecting to a decentralized Data Engine.
|
||||
- **WebSocket First-Message Auth**: Data Engines enforce a "First-Message Auth" pattern over WebSockets. The client MUST immediately send a `{ type: "auth", v: 1, token: "..." }` message upon opening the connection to prevent SSRF vulnerabilities and credential leakage.
|
||||
|
||||
---
|
||||
|
||||
## Registration & Auto-Provisioning
|
||||
|
||||
Registration: `app.worldwideview.dev/register`
|
||||
|
||||
```
|
||||
1. User fills: email, password, username (= subdomain)
|
||||
2. Account created (Supabase Auth)
|
||||
3. Tenant row inserted instantly → [username].app.worldwideview.dev is live
|
||||
4. User lands on their instance → Setup Wizard (Cesium token)
|
||||
```
|
||||
|
||||
**Subdomain validation:** alphanumeric + hyphens, min 3 chars, not already taken.
|
||||
**Reserved names:** `www`, `app`, `api`, `demo`, `marketplace`, `docs`, `status`, `admin`, `cdn`, `blog`, `changelog`
|
||||
|
||||
"Provisioning" is just inserting a database row — no container to spin up (multi-tenant shared app).
|
||||
|
||||
---
|
||||
|
||||
## Multi-Tenant Architecture
|
||||
|
||||
**One Docker container, RLS isolation.** All cloud tenants share one Next.js deployment. Data isolation enforced at the **PostgreSQL database level** via Row-Level Security:
|
||||
|
||||
```
|
||||
nginx (wildcard *.app.worldwideview.dev)
|
||||
→ reads subdomain → passes X-Tenant-ID header
|
||||
→ single WWV Docker container (Next.js)
|
||||
→ middleware reads X-Tenant-ID
|
||||
→ sets app.tenant_id in DB connection
|
||||
→ RLS scopes ALL queries to that tenant
|
||||
```
|
||||
|
||||
```sql
|
||||
ALTER TABLE installed_plugins ENABLE ROW LEVEL SECURITY;
|
||||
CREATE POLICY tenant_isolation ON installed_plugins
|
||||
USING (tenant_id = current_setting('app.tenant_id')::uuid);
|
||||
```
|
||||
|
||||
PostgreSQL **physically refuses** to return other tenants' rows — even application bugs cannot leak data.
|
||||
|
||||
> Schema-per-tenant (stronger isolation) can be offered later for enterprise. The `tenant_id` design makes migration straightforward.
|
||||
|
||||
### Security Analysis
|
||||
|
||||
| Concern | Risk | Mitigation |
|
||||
|---|---|---|
|
||||
| Data bleed between tenants | 🔴 Critical | RLS enforced at PostgreSQL level |
|
||||
| One tenant crashes the app | 🟡 Medium | Next.js request isolation. Rate limit per tenant at nginx |
|
||||
| One tenant hammers CPU | 🟡 Medium | Rate limiting at nginx (req/min per subdomain) |
|
||||
| Plugin code between tenants | 🟢 Low | Plugins run in the user's **browser**, not the server |
|
||||
| Server crash from users | 🟢 Low | Users can't run arbitrary server code. Rate limits handle abuse |
|
||||
|
||||
---
|
||||
|
||||
## Storage & Database
|
||||
|
||||
| Feature | Local | Cloud |
|
||||
|---|---|---|
|
||||
| **Database queries** | Prisma → PostgreSQL | Prisma → PostgreSQL (Supabase) |
|
||||
| **Auth** | None (single owner) | Supabase Auth (GoTrue) |
|
||||
| **File storage** | Local filesystem (`data/`) | Supabase Storage |
|
||||
| **Storage limit** | ∞ (your disk) | Quota enforced per tier |
|
||||
|
||||
**Prisma is write-once, deploy-anywhere** — the same queries and schema work on both databases. `DATABASE_URL` in `.env` is the only difference.
|
||||
|
||||
---
|
||||
|
||||
## Tier Matrix
|
||||
|
||||
| Deployment | `NEXT_PUBLIC_WWV_EDITION` | License Key | Users | Storage |
|
||||
|---|---|---|---|---|
|
||||
| **Demo** | `demo` | none | ∞ (anonymous, read-only) | N/A |
|
||||
| Local Free | `local` | none | 1 (owner) | ∞ |
|
||||
| Local Pro | `local` | Pro key | 1 (owner) | ∞ |
|
||||
| Local Team | `local` | Team key | Unlimited | ∞ |
|
||||
| Cloud Free | `cloud` | none | 3 | 500 MB |
|
||||
| Cloud Pro | `cloud` | Pro key | 20 | 5 GB |
|
||||
| Cloud Enterprise | `cloud` | Enterprise key | Unlimited | 50 GB+ |
|
||||
|
||||
### Cryptographic License Keys
|
||||
|
||||
Paid features gated by **RSA-signed JWTs** — users cannot forge them by flipping flags:
|
||||
|
||||
```typescript
|
||||
// Marketplace signs (PRIVATE key — only you have this):
|
||||
const licenseKey = jwt.sign(
|
||||
{ tier: "pro", exp: "2027-01-01", org: "acme-corp" },
|
||||
PRIVATE_KEY, { algorithm: "RS256" }
|
||||
);
|
||||
|
||||
// WWV verifies (PUBLIC key — hardcoded in codebase):
|
||||
const license = jwt.verify(process.env.WWV_LICENSE_KEY, PUBLIC_KEY);
|
||||
// license.tier = "free" | "pro" | "team"
|
||||
```
|
||||
|
||||
### Storage Quota (Cloud Only)
|
||||
|
||||
- **Counts:** Imported GeoJSON, plugin data history, uploaded assets
|
||||
- **NOT counted:** Built-in plugin real-time data (transient)
|
||||
- **Quota exceeded:** Upgrade prompt, reject new imports, allow read access
|
||||
|
||||
---
|
||||
|
||||
## Environment Variables
|
||||
|
||||
### Local `.env`
|
||||
```env
|
||||
NEXT_PUBLIC_WWV_EDITION=local
|
||||
DATABASE_URL=postgresql://postgres:postgres@localhost:5432/wwv?schema=public
|
||||
```
|
||||
|
||||
### Cloud `.env`
|
||||
```env
|
||||
NEXT_PUBLIC_WWV_EDITION=cloud
|
||||
DATABASE_URL=postgresql://...
|
||||
NEXT_PUBLIC_SUPABASE_URL=https://[project].supabase.co
|
||||
NEXT_PUBLIC_SUPABASE_ANON_KEY=eyJ...
|
||||
SUPABASE_SERVICE_ROLE_KEY=eyJ...
|
||||
WWV_TENANT_MODE=rls
|
||||
WWV_STORAGE_PROVIDER=supabase
|
||||
```
|
||||
|
||||
### Demo `.env`
|
||||
```env
|
||||
NEXT_PUBLIC_WWV_EDITION=demo
|
||||
DATABASE_URL=postgresql://...
|
||||
```
|
||||
|
||||
`.env` is **infrastructure only** — things the operator sets once. Everything user-configurable lives in the `settings` DB table.
|
||||
|
||||
---
|
||||
|
||||
## Edition Adapters
|
||||
|
||||
Three thin files are all that differs between editions — everything else is edition-unaware:
|
||||
|
||||
| Adapter | Local | Cloud | Demo |
|
||||
|---|---|---|---|
|
||||
| `src/core/auth.ts` | Auth.js `Credentials` (bcrypt + PostgreSQL) | Auth.js `@auth/supabase-adapter` | Disabled |
|
||||
| `src/core/storage.ts` | `fs.writeFile()` to `data/` | Supabase Storage SDK | Read-only |
|
||||
| `src/core/tenant.ts` | No-op (single tenant) | Sets `app.tenant_id` for RLS | No-op |
|
||||
|
||||
---
|
||||
|
||||
## Bot Prevention (Layered)
|
||||
|
||||
| Layer | What | Cost |
|
||||
|---|---|---|
|
||||
| **Email verification** | Supabase Auth built-in | Free |
|
||||
| **Rate limiting** | 3 signups per IP per hour (nginx) | Free |
|
||||
| **Cloudflare Turnstile** | Invisible CAPTCHA on signup | Free |
|
||||
| **Cloudflare Bot Fight Mode** | Auto-enabled on free tier | Free |
|
||||
|
||||
---
|
||||
|
||||
## CI/CD Pipeline
|
||||
|
||||
```
|
||||
Push to silvertakana/worldwideview
|
||||
→ GitHub Actions: build Docker image
|
||||
→ Push to ghcr.io/silvertakana/worldwideview:latest
|
||||
→ Coolify webhook triggers
|
||||
→ Rolling restart (zero downtime)
|
||||
```
|
||||
|
||||
### `worldwideview-cloud/docker-compose.yml` (concept)
|
||||
```yaml
|
||||
services:
|
||||
wwv-cloud:
|
||||
image: ghcr.io/silvertakana/worldwideview:latest
|
||||
environment:
|
||||
NEXT_PUBLIC_WWV_EDITION: cloud
|
||||
DATABASE_URL: ${SUPABASE_PG_URL}
|
||||
SUPABASE_URL: ${SUPABASE_URL}
|
||||
SUPABASE_ANON_KEY: ${SUPABASE_ANON_KEY}
|
||||
labels:
|
||||
- "traefik.http.routers.wwv.rule=HostRegexp(`{user:[a-z0-9-]+}.app.worldwideview.dev`)"
|
||||
```
|
||||
|
||||
The cloud repo (`worldwideview-cloud`) holds **no application logic** — it is purely a thin deployment configuration layer that pulls versioned Docker images.
|
||||
@@ -0,0 +1,21 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,31 @@
|
||||
---
|
||||
trigger: model_decision
|
||||
description: Architecture rules and dependency management guidelines for wwv-data-engine seeders.
|
||||
---
|
||||
|
||||
# Data Engine V2 Architecture & Dependency Loading
|
||||
|
||||
## 1. Engine Versions: V2 vs Legacy
|
||||
The current and only active engine is **`wwv-data-engine-v2`**.
|
||||
- **Legacy Engine**: Previously, data sources ran as isolated, standalone microservices running their own Node environments.
|
||||
- **V2 Engine**: Acts as a unified **"Host Environment" runner**. It is a single Node.js process that dynamically downloads and executes multiple independent seeder bundles (both public community seeders and private seeders).
|
||||
|
||||
## 2. Deployment Architecture
|
||||
- **Single Docker Image**: V2 is deployed via Coolify as a single Docker image, natively mapping environment variables continuously into the container shell.
|
||||
- **Automated Restarts**: Code pushes to the `wwv-data-engine-public` repository automatically trigger a service restart via a secure `COOLIFY_API_TOKEN` configured in the CI/CD pipeline (replacing unreliable generic webhooks).
|
||||
- **Dual-Output Engine**: Seeders in V2 expose both a WebSocket stream (`/stream`) for real-time instantaneous updates, and a REST API endpoint (`/api/:id`) for fetching live data snapshots directly from Redis.
|
||||
|
||||
## 3. Pnpm Workspaces & Dynamic Dependency Loading
|
||||
To prevent seeders from ballooning in size by bundling a massive amount of dependencies, the system heavily relies on `pnpm` workspaces.
|
||||
- **Host Environment**: The V2 engine natively provides common geospatial and utility packages (e.g., `zod`, `ws`, `node-cron`, `undici`, `satellite.js`, `geoip-lite`). Seeders **MUST NOT** bundle these standard dependencies, and should leave them external in `tsup`.
|
||||
- **Dynamic Workspaces**: When V2 loads a compiled `dist/index.mjs` via `node`, it dynamically resolves imports by traversing up to the workspace `node_modules`.
|
||||
|
||||
## 4. Production Deployment & Downloader
|
||||
In production, the `wwv-data-engine-v2` does NOT mount the local file system. Instead:
|
||||
1. `download-seeders.ts` runs on container startup.
|
||||
2. It fetches the latest compiled `seeders.zip` from GitHub Releases for both community and private repositories.
|
||||
3. **CRITICAL STEP:** After unzipping the workspaces into a staging directory (`/app/seeders`), the script dynamically generates a root `package.json` and `pnpm-workspace.yaml`.
|
||||
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.
|
||||
@@ -4,8 +4,8 @@
|
||||
When making database schema changes, you must ensure that generated migrations are resilient against environmental discrepancies.
|
||||
|
||||
- **Review Generated SQL**: Always review the `.sql` files generated by `npx prisma migrate dev`.
|
||||
- **Add "IF EXISTS" clauses**: SQLite and Prisma can sometimes produce brittle drop statements (`DROP INDEX "my_index"`). To prevent migrations from crashing if a state desynchronization occurs (e.g., the index was already dropped or never created), 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, SQLite does not cleanly support it and requires table recreation. Carefully review the `INSERT INTO "new_table" SELECT ...` clauses to ensure data is correctly mapped.
|
||||
- **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
|
||||
If a migration fails in production:
|
||||
@@ -13,4 +13,4 @@ If a migration fails in production:
|
||||
- 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
|
||||
Never perform direct DDL operations (ALTER, DROP, CREATE) on a production database (via Prisma or direct SQLite access) without first confirming an automated backup exists, or manually taking a backup of the `wwv.db` file.
|
||||
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.
|
||||
@@ -0,0 +1,320 @@
|
||||
# Deployment, Testing, and Operations
|
||||
|
||||
## Development Commands
|
||||
|
||||
```bash
|
||||
pnpm install # Install all workspace dependencies
|
||||
pnpm run setup # Generate .env.local with AUTH_SECRET (first-time setup)
|
||||
pnpm dev # Next.js frontend only (auto-runs prisma db push + copy-cesium)
|
||||
pnpm dev:all # Frontend + wwv-data-engine (via Docker Compose) concurrently
|
||||
pnpm dev:backends # Starts the local data engine + Redis via Docker Compose
|
||||
pnpm build # Production build
|
||||
pnpm test # Run all Vitest tests (scoped to src/lib, src/core, src/plugins)
|
||||
pnpm db:reset # Reset and re-migrate the frontend database (destructive)
|
||||
pnpm start:backends # Legacy command for standalone Fastify backends
|
||||
pnpm clean:backends # Wipe all plugin database records
|
||||
pnpm run scaffold-osm-plugin <name> # Generate a new plugin from scaffold
|
||||
pnpm dev:plugins # File watcher for local-plugins/ directory (runs automatically in dev)
|
||||
node packages/wwv-cli/dist/index.js create <name> --local # Scaffold a new local plugin
|
||||
node packages/wwv-cli/dist/index.js link <name> # Promote a local plugin to packages/
|
||||
```
|
||||
|
||||
Frontend runs at `http://localhost:3000`.
|
||||
|
||||
## Deployment
|
||||
|
||||
- **Docker**: Multi-stage Dockerfile using the Extractor Pattern (`deps` → `builder` → `runner`). The `node_modules` folders must be explicitly untracked in from `git` across the workspace to prevent corrupted BuildKit contextual cache overlaps during the `COPY . .` stage.
|
||||
- **Standalone output**: `next.config.ts` uses `output: "standalone"`.
|
||||
- **Cesium assets**: Copied to `public/cesium/` via `scripts/copy-cesium.mjs` at build time, excluded from output tracing.
|
||||
- **Prisma Configuration**: `prisma.config.ts` must export a native javascript object instead of dynamically importing CLI wrapper binaries (`prisma/config` or `dotenv`). The standalone Next.js tracer strips CLI devDependencies during the build, which will cause fatal runtime container crashes if imported.
|
||||
- **Data Engine**: The single runner container defined in `docker-compose.yml`, proxied via `next.config.ts` rewrites.
|
||||
- **Coolify**: Deployed via Dockerfile builder natively mapping environment variables continuously into the container shell.
|
||||
- **Docker volumes**: Ensure PostgreSQL data and Redis volumes are mounted for persistence.
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
- **Framework**: Vitest with jsdom environment
|
||||
- **Coverage**: `src/lib/**`, `src/core/**`, `src/plugins/**`
|
||||
- **Run**: `pnpm test` (or `vitest run`)
|
||||
- **Type-Level Contract Testing**: When defining shared TypeScript interfaces/contracts (e.g., in `wwv-plugin-sdk`), you MUST use `expectTypeOf` from `vitest` to assert the actual contract shapes at compile-time instead of writing literal-value identity runtime assertions. You must also enforce `@ts-expect-error` negative type tests to ensure missing or invalid fields trigger compilation errors.
|
||||
- **Key test files**: `rateLimit.test.ts`, `edition.test.ts`, `demoAdmin.test.ts`, `DeclarativePlugin.test.ts`, `cors.test.ts`, `repository.test.ts`, `marketplaceToken.test.ts`
|
||||
|
||||
### E2E Testing (Playwright)
|
||||
|
||||
WorldWideView uses Playwright for End-to-End browser testing to verify the complete UI integration including NextAuth.
|
||||
|
||||
- **Run**: `pnpm run test:e2e` (Ensure your database is running before executing)
|
||||
- **Auth Bypass**: Playwright uses a `global.setup.ts` to directly insert a test user into the database and simulate a UI login to capture a `storageState.json` cookie file. This allows all tests to run pre-authenticated without bypassing production security logic.
|
||||
- **Database Access in Setup**: Because Playwright setup scripts run in a vanilla Node context, importing Next.js backend utilities like `src/lib/db.ts` will crash with `next/headers` resolution errors. You MUST instantiate `PrismaClient` directly using `@prisma/adapter-pg` in any Playwright `setup` or `teardown` scripts.
|
||||
- **Component Synchronization**: Do not use arbitrary timeouts. Tests MUST wait for the application boot sequence to finish by waiting for the `[data-testid="app-ready"]` marker on the `AppShell` to be attached.
|
||||
- **Stable Selectors**: Always use `data-testid` properties (e.g. `data-testid="panel-toggle-left"`) for interacting with UI components in E2E tests rather than fragile CSS classes or dynamic text.
|
||||
- **Worktree Port Conflicts**: If you are testing in a git worktree, configure `playwright.config.ts` to spawn the `webServer` on an alternative port (e.g. `3001`) to avoid colliding with other running worktrees.
|
||||
|
||||
## Security Headers
|
||||
|
||||
Configured in `next.config.ts` `headers()`:
|
||||
- **CSP**: Restrictive with exceptions for CesiumJS (`unsafe-eval`, `unsafe-inline`), camera streams (`http: https:`), and analytics
|
||||
- **X-Frame-Options**: DENY
|
||||
- **X-Content-Type-Options**: nosniff
|
||||
- **Referrer-Policy**: strict-origin-when-cross-origin
|
||||
- **Permissions-Policy**: camera/microphone disabled, geolocation self-only
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Package Manager
|
||||
|
||||
The project uses **pnpm workspaces**. All `npm` commands in older docs/scripts should be treated as `pnpm`.
|
||||
|
||||
```bash
|
||||
pnpm install # install all workspace deps
|
||||
pnpm run dev # start dev server ONLY (worldwideview/)
|
||||
pnpm run dev:all # start ALL services concurrently (worldwideview, data-engine, marketplace)
|
||||
pnpm run build # production build
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Local Dev Setup
|
||||
|
||||
```
|
||||
1. Clone repo
|
||||
2. pnpm install
|
||||
3. pnpm run setup # generates .env.local with AUTH_SECRET, copies .env.example
|
||||
4. pnpm run dev:all # predev: prisma migrate deploy + copy-cesium.mjs → then starts all services
|
||||
5. Open http://localhost:3000
|
||||
```
|
||||
|
||||
**Marketplace:** `cd worldwideview-marketplace && pnpm run dev` → http://localhost:3001
|
||||
|
||||
**Database auto-creates** on first run via `predev` script — no manual DB setup required.
|
||||
|
||||
---
|
||||
|
||||
## Database Operations
|
||||
|
||||
**All SQL from `c:\dev\worldwideview`:**
|
||||
|
||||
```powershell
|
||||
npx prisma db execute --sql "<SQL>"
|
||||
```
|
||||
|
||||
> Stop the dev server first to avoid "database is locked" errors.
|
||||
|
||||
### Common Commands
|
||||
|
||||
```powershell
|
||||
# View row counts (all tables)
|
||||
npx prisma db execute --sql "SELECT 'users' AS t, COUNT(*) AS n FROM users UNION ALL SELECT 'aviation_history', COUNT(*) FROM aviation_history UNION ALL SELECT 'installed_plugins', COUNT(*) FROM installed_plugins UNION ALL SELECT 'settings', COUNT(*) FROM settings;"
|
||||
|
||||
# List installed plugins
|
||||
npx prisma db execute --sql "SELECT pluginId, version, installedAt FROM installed_plugins ORDER BY installedAt DESC;"
|
||||
|
||||
# Clear all installed plugins
|
||||
npx prisma db execute --sql "DELETE FROM installed_plugins;"
|
||||
|
||||
# List settings
|
||||
npx prisma db execute --sql "SELECT key, value FROM settings;"
|
||||
|
||||
# Set/update a setting
|
||||
npx prisma db execute --sql "INSERT INTO settings (key, value) VALUES ('<key>', '<value>') ON CONFLICT (key) DO UPDATE SET value = EXCLUDED.value;"
|
||||
|
||||
# Prune aviation history older than 7 days
|
||||
npx prisma db execute --sql "DELETE FROM aviation_history WHERE timestamp < NOW() - INTERVAL '7 days';"
|
||||
|
||||
# Vacuum (reclaim disk space after pruning)
|
||||
npx prisma db execute --sql "VACUUM FULL;"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Data Engine & Data Recovery
|
||||
|
||||
The secondary backend (Data Engine) handles high-volume API ingestion and pushes active snapshots to Upstash Redis. Because its PostgreSQL database is completely wiped on fresh Coolify deployments if volumes aren't preserved, it uses **Self-Healing Architecture**.
|
||||
|
||||
**How Recovery Works:**
|
||||
1. Upon startup, or during the 60-second cron cycle, the seeder checks if the target table (e.g., `iranwar_events`) is empty.
|
||||
2. If empty, the engine instantly hydrates the PostgreSQL database and the Upstash Redis cache from the committed fallback payload (e.g., `data/fallback/iranwar_seed.json`).
|
||||
3. To **force a rapid recovery** locally (such as when testing new scraper data), simply wipe the table and let the minute-tick refill it via `npx prisma db execute --sql "DELETE FROM iranwar_events;"`.
|
||||
|
||||
**OSINT Scraping & Hydration Best Practices:**
|
||||
Utility scripts (like `hydrate.ts`) exist to repair or enrich the fallback seed block offline. Important takeaways from building these scrapers:
|
||||
- **Location Mapping:** Always append structured `_osint_meta.coordinates: {lat, lng}`. Without exact coordinates, the SDK defaults to Null Island or scatters points uniformly across the globe (declutter grid effect).
|
||||
- **Tracking URL Resolution:** News aggregators (like Bing News RSS) wrap URLs in tracking redirect pages (`apiclick.aspx`). Never serve these directly to the frontend. Use `cheerio` to fetch the tracking page, parse the `<noscript><meta refresh="URL=..."></noscript>` node, extract the *actual* news URL, and then scrape the destination article for `og:image` and `og:video` tags.
|
||||
- **Frontend Sync:** Ensure Next.js schema mapping in the plugin (`wwv-plugin-xyz/src/index.ts`) perfectly mirrors the enriched fields so they render correctly in the UI.
|
||||
|
||||
### Schema Changes
|
||||
|
||||
```powershell
|
||||
npx prisma db push # sync schema changes to DB (non-destructive)
|
||||
npx prisma migrate dev --name "<description>" # create + apply a migration
|
||||
npx prisma generate # regenerate Prisma client types after schema change
|
||||
npx prisma studio # visual DB browser at http://localhost:5555
|
||||
```
|
||||
|
||||
### Full Reset
|
||||
|
||||
```powershell
|
||||
# Stop dev server first
|
||||
Remove-Item c:\dev\worldwideview\data\wwv.db
|
||||
npx prisma db push
|
||||
pnpm run dev
|
||||
```
|
||||
|
||||
### Browser Cache Clearing
|
||||
|
||||
```javascript
|
||||
// Clear IndexedDB entity cache
|
||||
indexedDB.deleteDatabase("worldwideview-cache");
|
||||
|
||||
// Clear localStorage user API keys
|
||||
Object.keys(localStorage)
|
||||
.filter(k => k.startsWith("wwv_"))
|
||||
.forEach(k => localStorage.removeItem(k));
|
||||
```
|
||||
|
||||
Known `wwv_*` localStorage keys (defined in `src/lib/userApiKeys.ts`):
|
||||
- `wwv_key_google_maps`
|
||||
- `wwv_key_nasa_firms`
|
||||
|
||||
Hard refresh: `Ctrl+Shift+R`
|
||||
|
||||
---
|
||||
|
||||
## DB Troubleshooting
|
||||
|
||||
| Error | Fix |
|
||||
|---|---|
|
||||
| "Database is locked" | Stop the dev server first |
|
||||
| "Table does not exist" | Run `npx prisma db push` |
|
||||
| "Plugin still shows after clearing" | Hard-refresh (`Ctrl+Shift+R`) or clear IndexedDB |
|
||||
| DB file is very large | Prune aviation history + run `VACUUM` |
|
||||
| Prisma client types are stale | Run `npx prisma generate` |
|
||||
|
||||
---
|
||||
|
||||
## Creating Static OSM Plugins
|
||||
|
||||
See full guide: `.agents/skills/osm-static-plugin-creation.md`
|
||||
|
||||
**Quick start:**
|
||||
```bash
|
||||
node scripts/scaffold-osm-plugin.mjs '{
|
||||
"name": "volcanoes",
|
||||
"displayName": "Volcanoes",
|
||||
"osmTag": "natural=volcano",
|
||||
"icon": "Mountain",
|
||||
"color": "#ef4444",
|
||||
"category": "Natural Disaster"
|
||||
}'
|
||||
```
|
||||
|
||||
**Manual Overpass API query (PowerShell):**
|
||||
```powershell
|
||||
$tag = '"natural"="volcano"'
|
||||
$body = "data=[out:json][timeout:300];(node[$tag];way[$tag];relation[$tag];);out center;"
|
||||
Invoke-RestMethod -Uri 'https://overpass-api.de/api/interpreter' -Method Post -Body $body -OutFile 'tmp/raw_data.json'
|
||||
```
|
||||
|
||||
**Note:** OSM data is licensed under **ODbL** — include attribution in plugin READMEs.
|
||||
|
||||
---
|
||||
|
||||
## npm Plugin Publishing
|
||||
|
||||
See full guide: `.agents/skills/version-control/npm-plugin-publishing.md`
|
||||
|
||||
```bash
|
||||
# First-time publish
|
||||
pnpm publish --workspace=packages/wwv-plugin-<name> --access public
|
||||
|
||||
# Future versions — via Trusted Publishing (GitHub Actions CI/CD)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Git / Version Control
|
||||
|
||||
See full guide: `.agents/skills/version-control/git-version-control.md`
|
||||
|
||||
**Commit convention:** `feat:`, `fix:`, `chore:`, `docs:` prefixes.
|
||||
**Commit when:** A new feature is completed (per project rules).
|
||||
|
||||
---
|
||||
|
||||
## Security Checks
|
||||
|
||||
See full guide: `.agents/skills/security/security-check.md`
|
||||
|
||||
---
|
||||
|
||||
## Deployment
|
||||
|
||||
**Host Server:**
|
||||
The production Coolify instance runs on a local server at `192.168.68.64`. Direct SSH access: `ssh [email protected]`.
|
||||
|
||||
**CI/CD Flow:**
|
||||
1. Push to `silvertakana/worldwideview`
|
||||
2. Coolify webhook triggers → automated BuildKit deployment on the host server.
|
||||
|
||||
**GitHub Actions Workflows:**
|
||||
- **Minimal Permissions:** CodeQL and GitHub security best practices dictate that `GITHUB_TOKEN` permissions should always be explicitly constrained. When creating or modifying `.github/workflows/*.yml` files, you MUST always include an explicit `permissions` block (e.g., `permissions: { contents: read }` or similar required scopes) at the top level or job level to adhere to the principle of least privilege.
|
||||
|
||||
**Coolify Deployment Rules & Gotchas (The "Redis 500k" Rule):**
|
||||
- **Coolify Pulls from GitHub:** Coolify does *not* deploy your local workspace files. It strictly clones the repository from GitHub.
|
||||
- **Push Before You Deploy:** If you make a critical infrastructure or optimization fix locally (e.g., swapping a massive `HSET` pipeline for a compressed 5-min throttled `setLiveSnapshot`), you **must** `git commit` and `git push` those changes to the `main` branch before triggering a Coolify deployment.
|
||||
- **The "Rollback DDOS" Risk:** If you update environmental variables (like a new Upstash Redis URL) inside Coolify and deploy *without* pushing your local optimized code to GitHub, Coolify will pull the *older, unoptimized* repository code and aim it at your new endpoints. This will immediately exhaust the 500,000 requests/month Upstash free limit.
|
||||
- **Redis Connection Errors:** If the data engine crashes on startup with `MaxRetriesPerRequestError: Reached the max retries per request limit (which is 3)` and `ECONNRESET`, the `REDIS_URL` in your Coolify environment variables is incorrectly using `redis://` instead of the TLS-required `rediss://`.
|
||||
- **Immediate Rollback on Failure:** Whenever a Coolify deployment fails or introduces a critical bug (such as rate-limit exhaustion), **immediately select the last known working deployment in the Coolify dashboard and redeploy it.** Do not leave a broken deployment hanging while trying to debug directly in production. Roll back to stability first, debug locally, commit the verified fix, and then deploy forward.
|
||||
- **Public Port Binding:** Both the `wwv` (Next.js frontend) and `wwv-data-engine` containers are meant to be directly exposed to the internet, rather than relying on Traefik internal network routing. They MUST use `ports: - "3000:3000"` and `ports: - "5000:5000"` respectively in `docker-compose.yml`. Using `expose` hides them behind internal Docker routing. Only backend infrastructure like `db` and `wwv-redis` should use `expose`.
|
||||
|
||||
**Local verification:**
|
||||
Before pushing infrastructure changes, run `docker build -t wwv-test .` to verify that the Next.js `standalone` isolated multi-stage build works correctly.
|
||||
|
||||
**Critical Docker/BuildKit Patterns:**
|
||||
- **No Tracked `node_modules`:** Never track `node_modules` in git. It will severely break the Docker `COPY . .` BuildKit cache stage, as it attempts to overwrite the internally symlinked modules from the `deps` stage with the non-symlinked folders from git, causing cryptic `cannot copy to non-directory` errors.
|
||||
- **Prisma 7 in Standalone:** Prisma v7 strictly forbids `url = env("DATABASE_URL")` in `schema.prisma` if `prisma.config.ts` exists. You *must* provide the `url` property in `prisma.config.ts`.
|
||||
- **The `dotenv` Paradox:** Next.js `standalone` output does NOT automatically trace CLI tool devDependencies (like `dotenv`). If you import `dotenv` in `prisma.config.ts`, the production runner container will crash in a reboot loop. *Solution:* `prisma.config.ts` must use native Node `fs` and `path` to gracefully read from `.env` as a fallback, exporting a plain Javascript object without CLI wrappers.
|
||||
- **Standalone Scripts & Next.js Typechecking:** Next.js `pnpm build` triggers `tsc`. By default, this will aggressively typecheck the `scripts/` directory. One-off migration scripts that import backend-only dependencies (like `pg`) will fail the global build. Always ensure `"scripts"` is added to the `"exclude"` array in `tsconfig.json`.
|
||||
- **WSL2 / Docker Memory Bloat:** Next.js `standalone` + `pnpm workspaces` caching takes roughly 7GB to 10GB of virtual disk space and maxes out WSL2 memory during `docker-compose build`. Avoid building complex monorepos locally unless necessary. To reclaim local BuildKit disk space: `docker builder prune -a -f`. To reclaim WSL RAM: `wsl --shutdown`.
|
||||
- **TypeScript NodeNext ESM Extensions:** By default in strict NodeNext ESM, backend scripts compiled via TypeScript (like `server.ts`) require dynamic imports to explicitly list the extension. You MUST write `await import('./routes/index.js')`, even if the underlying code is a `.ts` file, or the Docker compilation will fail with `TS2834`.
|
||||
- **Git vs Docker Context Bloat:** Ensure `.dockerignore` ruthlessly excludes generated artifacts (e.g., `artifacts/`, `performance/`). Ensure `.gitignore` strips large binary caches like heavy database seed files inside `packages/*/data/` to prevent GitHub from bouncing commits exceeding the 100MB chunk limit.
|
||||
- **Host Resource Exhaustion & Implicit Failures:** Complex multi-stage pnpm builds generate massive amounts of intermediate layer cache. If the Coolify host server reaches 100% disk capacity during an active deployment, the build logs will silently truncate and die abruptly with no explicit `pnpm` error. Worse, services like PostgreSQL (`coolify-db`) will instantly crash because they cannot write lock files, causing total system outages. Always maintain at least 30-40GB of free space on deployment hosts before auto-deploying via Coolify.
|
||||
|
||||
|
||||
**Local update:** `git pull && pnpm install && pnpm run dev`
|
||||
|
||||
---
|
||||
|
||||
## Disk Space Management & Monitoring
|
||||
|
||||
The Docker build uses `standalone` output to minimize image size. The `copy-cesium.mjs` script copies only the required Cesium assets into `public/` — avoids shipping the entire Cesium package (300MB+) in the build.
|
||||
|
||||
**Host Server Maintenance:**
|
||||
On Coolify deployment targets (e.g., `192.168.68.64`), dangling BuildKit caches and orphaned images will eventually consume 100% of the disk.
|
||||
- To recover a crashed server: SSH into the host and run `docker system prune -a -f`.
|
||||
- **Proactive Monitoring:** Use the `netdata-remote` MCP server to poll or setup alerts for the host disk space. It is highly recommended to set a warning alert when disk usage exceeds 80%.
|
||||
|
||||
**Application Database Growth:**
|
||||
Aviation history can grow large. Prune regularly:
|
||||
```powershell
|
||||
npx prisma db execute --sql "DELETE FROM aviation_history WHERE timestamp < datetime('now', '-7 days');"
|
||||
npx prisma db execute --sql "VACUUM;"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Terminology Quick Reference
|
||||
|
||||
| Term | Definition |
|
||||
|---|---|
|
||||
| **Edition** | `local`, `cloud`, or `demo` — set via `NEXT_PUBLIC_WWV_EDITION`. Drives auth/storage/tenant adapters |
|
||||
| **Bridge API** | Routes in WWV (`/api/marketplace/*`) that the marketplace calls to install/manage plugins |
|
||||
| **Setup Wizard** | First-run config UI — app-level (Cesium token) and plugin-level (plugin API keys) |
|
||||
| **Runtime Settings Store** | `settings` DB table — replaces `.env` for everything user-facing |
|
||||
| **RLS** | Row-Level Security — PostgreSQL feature enforcing tenant data isolation at the DB level |
|
||||
| **Snapshot Capture** | WWV periodically stores plugin data per tenant for history/timeline. Pro/Local only |
|
||||
| **Trust Stamping** | WWV always overwrites `manifest.trust` server-side — no client claims are accepted |
|
||||
| **NpmCache** | DB table caching NPM registry metadata to decouple from live NPM polling |
|
||||
@@ -0,0 +1,69 @@
|
||||
# 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 |
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
trigger: testing
|
||||
description: Guidelines and architecture for the Playwright End-to-End (E2E) testing infrastructure.
|
||||
globs:
|
||||
- "tests/**"
|
||||
- "public/e2e-fixtures/**"
|
||||
- "playwright.config.ts"
|
||||
---
|
||||
|
||||
# E2E Testing Infrastructure
|
||||
|
||||
The WorldWideView project uses **Playwright** for end-to-end (E2E) testing. This document outlines the boundaries, architectural decisions, and conventions required when authoring or modifying E2E tests.
|
||||
|
||||
## 1. Resource Constraints & Parallelism
|
||||
- **Worker Limits:** The Playwright configuration (`playwright.config.ts`) is strictly limited to a maximum of **2 workers**.
|
||||
- **Reasoning:** Running Next.js compilation alongside a heavy Prisma connection pool inside multiple parallel test workers will lead to database connection exhaustion and resource contention on CI and local environments. Do not increase the worker count beyond 2 without careful consideration of the database pool limits.
|
||||
|
||||
## 2. Test User Lifecycle
|
||||
E2E tests require an authenticated user to access core application features. We manage this test user securely to ensure the environment stays pristine:
|
||||
|
||||
- **Setup (`tests/global.setup.ts`):** Before tests run, the global setup script defensively deletes any existing test user (`[email protected]`) and creates a fresh instance with the `ADMIN` role. It then performs a UI login to capture the authentication state, which is shared across all test files.
|
||||
- **Teardown (`tests/global.teardown.ts`):** After the entire test suite completes (regardless of success or failure), the global teardown script runs and completely purges the test user from the database.
|
||||
- **Safety:** Do not use `[email protected]` for manual testing. It is volatile and intended exclusively for the CI test runner.
|
||||
|
||||
## 3. UI Interaction Conventions
|
||||
- **Strict Selector Usage**: ALWAYS use `data-testid` selectors (e.g., `getByTestId('panel-toggle-left')`) for DOM interactions. **NEVER rely on CSS classes** (like `.layer-item__toggle` or `.dock-btn`) or deep DOM structures, as these are brittle and break during design refactors. If a `data-testid` is missing from an element you need to test, you MUST add it to the React component source code first.
|
||||
- **Dialog Interception:** WorldWideView relies on heavy frontend plugin discovery and dynamic rendering. For example, the `UnverifiedPluginBatchDialog` may unexpectedly appear and block UI interactions in a fresh browser context.
|
||||
- *Mitigation:* Ensure your test suites either explicitly handle these dialogs (e.g., in a `beforeEach` block) or inject mock plugins that bypass the verification flow entirely.
|
||||
|
||||
## 4. Mock Plugins
|
||||
- **Data Interface Strictness**: WorldWideView's `PluginManager` is extremely strict. **ALL mock plugins MUST implement `getPollingInterval`, `fetch`, and `renderEntity`**, even if they are purely UI-focused (like a bottom-panel plugin). Failure to implement these will crash the renderer.
|
||||
- **Capabilities**: If your mock UI plugin needs to be manually activated by the user, ensure its manifest includes the `"ui:sidebar"` capability so it appears in the layer list.
|
||||
- **Injection:** We inject safe, deterministic mock plugins into the database during the `global.setup.ts` phase to test the core rendering pipeline without relying on external APIs. Ensure your mock plugin is registered in the setup and teardown cleanup arrays.
|
||||
- **Location:** Mock plugin configurations and manifests are stored in `public/e2e-fixtures/`. When modifying the rendering engine, ensure you also update the mock plugin (`public/e2e-fixtures/mock-plugin.js`) to reflect any changes in the Plugin SDK capabilities.
|
||||
|
||||
## 5. Security Permissions
|
||||
- When integrating Playwright tests into GitHub Actions (e.g., `.github/workflows/playwright.yml`), you MUST include an explicit permissions block (e.g., `permissions: { contents: read }`) to adhere to CodeQL and least-privilege scoping rules.
|
||||
|
||||
> [!WARNING]
|
||||
> If you encounter flaky tests or `ECONNREFUSED` errors during Playwright runs, check if the local Next.js dev server or the Docker engine stack is competing for ports (e.g., port 5432 or 3000). Ensure `pnpm run dev:backends` is running and stable before launching the test suite.
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
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`.
|
||||
@@ -0,0 +1,17 @@
|
||||
# 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,223 @@
|
||||
---
|
||||
trigger: model_decision
|
||||
description: Guidelines for the WorldwideView plugin marketplace, database interactions, and dynamic plugin installation.
|
||||
---
|
||||
|
||||
# Marketplace Architecture
|
||||
|
||||
## 1. InstalledPluginsLoader
|
||||
Marketplace plugins are dynamically loaded via `InstalledPluginsLoader`. At startup, this service queries the PostgreSQL database (`installed_plugins` table) for dynamically installed manifests.
|
||||
|
||||
## 2. Dynamic Bundle Loading
|
||||
Plugins from the marketplace use the `bundle` format and are imported at runtime from CDN endpoints (e.g., unpkg) via `loadPluginFromManifest()`.
|
||||
|
||||
## 3. Database Sync
|
||||
- Marketplace installations mutate the Prisma database.
|
||||
- `pluginManager.loadFromManifest()` validates and registers these plugins.
|
||||
- Ensure any schema changes to the marketplace tables follow the `database-migrations.md` rule.
|
||||
|
||||
## Current Implementation State
|
||||
|
||||
|
||||
- **Stage 4 (Bridge API + One-Click Install)** ✅ COMPLETE
|
||||
- Plugin data currently served from a volume-backed **PostgreSQL database** — plugins are submitted by entering an NPM package name in the Admin UI
|
||||
- The marketplace auto-fetches metadata from the NPM registry and parses the `"worldwideview"` block in `package.json`
|
||||
- A background `NpmCache` table caches NPM registry metadata to decouple from live NPM dependency
|
||||
- Future: Supabase DB for full publisher workflow (Stage 5)
|
||||
|
||||
---
|
||||
|
||||
## Plugin Submission Flow (Current)
|
||||
|
||||
1. Developer publishes their plugin to npm with a `"worldwideview"` block in `package.json`
|
||||
2. Admin opens the Marketplace Admin UI
|
||||
3. Admin enters the npm package name (e.g. `@worldwideview/wwv-plugin-my-data`)
|
||||
4. Marketplace fetches metadata from NPM registry, parses the manifest block, stores in PostgreSQL DB
|
||||
5. Plugin appears in the browse catalog
|
||||
|
||||
> Static plugins still need their GeoJSON files placed in the host application's `public/data/` directory.
|
||||
|
||||
---
|
||||
|
||||
## Token Exchange Authentication (PKCE)
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **See ADR-0001 (Decentralized Plugin Authentication & SSRF Mitigation)**
|
||||
> The PKCE flow and API key proxying MUST adhere to ADR-0001. This mandates AES-256-GCM encryption with 100,000 PBKDF2 iterations for all credentials stored in the `MarketplaceCredential` model, and DNS IP Pinning / stream chunking on all proxy requests to mitigate SSRF.
|
||||
|
||||
Auth is governed by an **Asymmetric JWT Token Exchange (PKCE)** model to eliminate static, long-lived, and un-rotatable tokens. The Marketplace acts as the OAuth Authorization Server.
|
||||
|
||||
```
|
||||
Local App initiates connection
|
||||
↓
|
||||
Local App generates PKCE `code_verifier` and `code_challenge` (S256)
|
||||
↓
|
||||
Local App redirects to Marketplace: /oauth/authorize?response_type=code&...
|
||||
↓
|
||||
User authenticates on Marketplace and grants access
|
||||
↓
|
||||
Marketplace redirects back to Local App: /api/marketplace/callback?code=...
|
||||
↓
|
||||
Local App exchanges `code` + `code_verifier` for a long-lived API Key from Marketplace
|
||||
↓
|
||||
Local App securely stores API Key (encrypted via AES-256-GCM)
|
||||
```
|
||||
|
||||
### Data Engine Connections
|
||||
|
||||
Once connected, the Local App uses the long-lived API Key to fetch short-lived entitlements for specific data engines:
|
||||
1. **Request JWT**: Local App requests a short-lived JWT for a specific Data Engine audience.
|
||||
2. **Issue JWT**: Marketplace signs an EdDSA JWT containing the user's entitlements and the specific audience.
|
||||
3. **Connect**: Local App connects to the decentralized Data Engine via WebSocket and performs "First-Message Auth" by sending the JWT.
|
||||
4. **Verify**: Data Engine verifies the EdDSA signature using the Marketplace's public JWKS. No central DB lookup is required.
|
||||
|
||||
`validateMarketplaceAuth` accepts auth in priority order:
|
||||
1. Active Auth.js session (same-origin browser)
|
||||
2. EdDSA JWT Bearer token (cross-origin, audience-bound)
|
||||
3. Legacy static `WWV_BRIDGE_TOKEN` (backward compat)
|
||||
|
||||
---
|
||||
|
||||
## WWV Bridge API Routes (Implemented)
|
||||
|
||||
| Route | Method | Purpose |
|
||||
|---|---|---|
|
||||
| `/api/marketplace/install-redirect` | GET | Browser redirect install — checks session, installs plugin, issues JWT |
|
||||
| `/api/marketplace/grant-token` | GET | Issues marketplace JWT without install (for Manage page) |
|
||||
| `/api/marketplace/status` | GET | Returns all installed plugins (session or JWT auth) |
|
||||
| `/api/marketplace/uninstall` | POST | Deletes an installed plugin record |
|
||||
| `/api/marketplace/load` | GET | Returns valid non-built-in manifests for client startup (no auth) |
|
||||
| `/api/auth/setup-status` | GET | CORS-enabled connection test endpoint |
|
||||
|
||||
### Auth Module: `src/lib/marketplace/`
|
||||
|
||||
| File | Purpose |
|
||||
|---|---|
|
||||
| `auth.ts` | `validateMarketplaceAuth()` — session → JWT → legacy token |
|
||||
| `marketplaceToken.ts` | `issueMarketplaceToken()` / `verifyMarketplaceToken()` — HS256 JWT via jose |
|
||||
| `cors.ts` | CORS headers for marketplace bridge routes |
|
||||
| `repository.ts` | `upsertPlugin()`, `uninstallPlugin()`, `getInstalledPlugins()` |
|
||||
| `registryClient.ts` | Fetches and Ed25519-verifies the signed plugin registry. 5-min in-memory cache. Stamps trust at install time |
|
||||
| `trustedPlugins.ts` | `localStorage` helpers for tracking user-approved unverified plugins |
|
||||
|
||||
---
|
||||
|
||||
## Marketplace API Endpoints (Target State)
|
||||
|
||||
### Public
|
||||
| Method | Path | Description |
|
||||
|---|---|---|
|
||||
| GET | `/api/plugins` | List/search plugins |
|
||||
| GET | `/api/plugins/:id` | Plugin detail |
|
||||
| GET | `/api/plugins/:id/bundle` | Download plugin bundle |
|
||||
| GET | `/api/categories` | List categories |
|
||||
| GET | `/api/registry` | Ed25519-signed verified-plugins registry — fetched by WWV at install time |
|
||||
|
||||
### Authenticated (Consumer)
|
||||
| Method | Path | Description |
|
||||
|---|---|---|
|
||||
| POST | `/api/instances` | Register a WWV instance |
|
||||
| PUT | `/api/instances/:id/default` | Set default instance |
|
||||
| POST | `/api/plugins/:id/install` | Trigger install to default instance |
|
||||
| GET | `/api/me/plugins` | List user's installed plugins |
|
||||
|
||||
### Authenticated (Publisher)
|
||||
| Method | Path | Description |
|
||||
|---|---|---|
|
||||
| POST | `/api/publisher/plugins` | Submit a new plugin |
|
||||
| PUT | `/api/publisher/plugins/:id` | Update plugin |
|
||||
| POST | `/api/publisher/plugins/:id/versions` | Publish new version |
|
||||
| GET | `/api/publisher/analytics` | Publisher analytics |
|
||||
|
||||
---
|
||||
|
||||
## Data Model
|
||||
|
||||
### WWV Local DB (Prisma — current)
|
||||
|
||||
```prisma
|
||||
model InstalledPlugin {
|
||||
id String @id @default(uuid())
|
||||
pluginId String
|
||||
version String
|
||||
config String // Full manifest JSON
|
||||
installedAt DateTime @default(now())
|
||||
}
|
||||
|
||||
model NpmCache {
|
||||
id String @id @default(uuid())
|
||||
packageName String @unique
|
||||
metadata String // JSON — cached NPM registry response
|
||||
lastFetched DateTime @default(now())
|
||||
}
|
||||
```
|
||||
|
||||
### Marketplace DB (Supabase — target, Stage 5+)
|
||||
|
||||
```
|
||||
users ─── published_plugins ─── plugin_versions
|
||||
│
|
||||
reviews
|
||||
```
|
||||
|
||||
Key fields on `published_plugins`: `slug`, `publisher_namespace` (`publisher.plugin-name`), `status` (`draft | review | published | rejected`), `manifest` (jsonb).
|
||||
|
||||
### Cloud DB (Supabase PostgreSQL — RLS-scoped)
|
||||
|
||||
```
|
||||
tenants ─── installed_plugins
|
||||
└── settings
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Security
|
||||
|
||||
| Concern | Mitigation |
|
||||
|---|---|
|
||||
| No static API keys | Install flow uses session redirects — no token to leak |
|
||||
| Marketplace JWT | 30-day HS256, scope-locked, verified via `jose` |
|
||||
| CSRF | Install/grant-token are GET redirects — user explicitly navigates |
|
||||
| Open redirect | `redirectTo` validated against allowlist |
|
||||
| Manifest tampering | Base64 only — no code execution. Validated via `validateManifest()` |
|
||||
| Malicious plugins | Sandboxed in Web Workers (unverified). CSP headers. Code review (verified) |
|
||||
| Supply chain | Plugin bundles checksummed (SHA-256), integrity verified |
|
||||
| Plugin API keys | Stored encrypted (AES-256-GCM) in `MarketplaceCredential` model, never exposed to browser |
|
||||
| Trust forgery | Registry signed with Ed25519 — `verified` cannot be claimed for unlisted plugins |
|
||||
| Trust stamping | WWV always overwrites `manifest.trust` server-side — client/marketplace input ignored |
|
||||
| Unverified consent | Warning dialog before any unverified plugin loads; approval stored per-plugin in `localStorage` |
|
||||
|
||||
---
|
||||
|
||||
## API Key Proxy & Rate Limiting (For `apikey` plugins)
|
||||
|
||||
Response caching makes server-as-proxy viable at scale:
|
||||
|
||||
```
|
||||
1000 users viewing earthquake plugin:
|
||||
→ 1000 requests hit your proxy
|
||||
→ Proxy: "I fetched this URL 3s ago, cache still valid"
|
||||
→ Returns cached response to all 1000
|
||||
→ 1 actual upstream request to USGS
|
||||
```
|
||||
|
||||
| Tier | Proxy req/min | Cache TTL |
|
||||
|---|---|---|
|
||||
| Free | 60 | 30s |
|
||||
| Pro | 300 | 10s |
|
||||
| Enterprise | Unlimited | 5s |
|
||||
|
||||
---
|
||||
|
||||
## History & Timeline
|
||||
|
||||
**Third-party history (`historyUrl`):** Plugin manifest declares a history URL with `%t` placeholder. WWV replaces it with the scrubber timestamp — third-party provides the endpoint. No storage on your side. Available on all tiers.
|
||||
|
||||
**WWV Snapshot Capture:** Your server periodically stores plugin data per tenant. Counts toward storage quota. Pro/Local only.
|
||||
|
||||
| Feature | Free (cloud) | Pro / Local |
|
||||
|---|---|---|
|
||||
| Live data (declarative `url`) | ✅ | ✅ |
|
||||
| Third-party history (`historyUrl`) | ✅ If supported by API | ✅ |
|
||||
| WWV snapshot capture | ❌ | ✅ Counts toward quota |
|
||||
| Built-in aviation/maritime history | ✅ Limited (24h) | ✅ Full |
|
||||
@@ -0,0 +1,30 @@
|
||||
---
|
||||
trigger: model_decision
|
||||
description: Strict rules for operating within the pnpm monorepo workspace environment structure across frontend and backend services.
|
||||
globs: ""
|
||||
---
|
||||
|
||||
# Monorepo Workflow Guidelines
|
||||
|
||||
## Purpose
|
||||
Strict rules for operating within the `pnpm` monorepo workspace environment structure across frontend and backend services.
|
||||
|
||||
## Directory Isolation
|
||||
|
||||
- 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]`.
|
||||
|
||||
## Critical Workspace Rule
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Because plugins use internal workspace references, you MUST strictly use `"workspace:*"` instead of `"*"` in `package.json` dependencies (e.g. `"@worldwideview/wwv-plugin-sdk": "workspace:*"`). Using `"*"` can cause pnpm to eagerly resolve cached registry versions instead of strictly linking your local code, resulting in opaque TypeScript and compilation errors.
|
||||
> **Whenever you add a new plugin package or adjust the SDK, you MUST run `pnpm install` then `pnpm build` from the project ROOT directory to propagate TS types properly.**
|
||||
|
||||
## Start/Exec Flow
|
||||
|
||||
Running `pnpm dev:all` from the project root employs `docker-compose` to spin up the data engine runner and your local seeders alongside the Next.js frontend.
|
||||
|
||||
## Next.js Monorepo Exceptions
|
||||
|
||||
When modifying `next.config.ts`, if new UI components or plugins are added that require SSR/transpilation, ensure they are appended to the `transpilePackages: []` array, or they will throw Next-Router unresolved import errors on production build.
|
||||
@@ -0,0 +1,120 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,403 @@
|
||||
---
|
||||
trigger: model_decision
|
||||
description: The standard operating procedure for instantiating, modifying, and registering a new data source plugin within the engine.
|
||||
---
|
||||
|
||||
# Plugin Architecture & Data Flow
|
||||
|
||||
## Purpose
|
||||
The standard operating procedure for instantiating, modifying, and registering a new data source plugin within the engine.
|
||||
|
||||
## The WorldPlugin Contract
|
||||
|
||||
All data ingest flows through `WorldPlugin` (defined entirely within `@worldwideview/wwv-plugin-sdk`).
|
||||
A valid plugin class MUST provide:
|
||||
1. `id` and `version` (The `version` MUST be dynamically imported via `import pkg from "../package.json"` to prevent duplicate tracking during CI/releases for built-in plugins).
|
||||
2. `fetch(timeRange)` method logic.
|
||||
3. `renderEntity(GeoEntity)` to determine visual style.
|
||||
4. `getPollingInterval()` (defaults fallback securely to standard store config).
|
||||
|
||||
## Plugin Architectures (Manifest Formats)
|
||||
|
||||
Plugins are defined via `PluginManifest` and operate on an **All-Bundle** architecture.
|
||||
All frontend extensions must eventually be compiled into a JS bundle that exports a `WorldPlugin`.
|
||||
|
||||
1. **`bundle` (Dynamic CDN Loaded / Internal)**: Plugins dynamically imported at runtime via ES module references (e.g., `unpkg.com` or local `/plugins/myplugin/frontend.mjs`). Handled by `loadPluginFromManifest` referencing `manifest.entry`.
|
||||
2. **`static` (Legacy)**: Now compiled via `wwvStaticCompiler` into a dynamic bundle. The raw `StaticDataPlugin` runtime class has been removed.
|
||||
3. **`declarative` (Legacy)**: Now compiled or wrapped into bundles.
|
||||
|
||||
No matter the source, the engine evaluates it by directly loading the `entry` file dynamically:
|
||||
`const module = await import(/* webpackIgnore: true */ entry);`
|
||||
|
||||
## Package Metadata (`package.json`)
|
||||
|
||||
All plugins MUST define their identity and compatibility via a `"worldwideview"` block in their `package.json`. This acts as the source-of-truth for generating the `PluginManifest` for the registry. If a plugin does not define `"type"`, validation functions will reject the manifest entirely or rely on legacy fallbacks.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "@worldwideview/wwv-plugin-myplugin",
|
||||
"version": "1.0.0",
|
||||
"worldwideview": {
|
||||
"id": "myplugin", // REQUIRED: Must match the directory name & API routes.
|
||||
"type": "data-layer", // REQUIRED: "data-layer" or "extension"
|
||||
"format": "bundle", // REQUIRED: "bundle", "declarative", or "static"
|
||||
"category": "Aviation", // REQUIRED: Matches PluginCategory union in SDK
|
||||
"icon": "Plane", // RECOMMENDED: Lucide icon name
|
||||
"capabilities": [ // REQUIRED: What the plugin can do
|
||||
"data:own", // (e.g. injects its own data)
|
||||
"globe:overlay", // (e.g. renders 3D elements)
|
||||
"network:fetch"
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## The Registration Pipeline
|
||||
|
||||
> [!NOTE]
|
||||
> All plugin interactions run through three singleton services:
|
||||
> `PluginRegistry` / `InstalledPluginsLoader` -> `PluginManager` -> `PollingManager` -> `DataBus`
|
||||
|
||||
### `InstalledPluginsLoader`
|
||||
Scans the PostgreSQL database at startup for dynamically installed marketplace manifests. Parses, validates (`validateManifest`), and registers valid plugins via `pluginManager.loadFromManifest`.
|
||||
|
||||
### `PluginManager`
|
||||
The orchestrator. Exposes `registerPlugin`, `enablePlugin`, `disablePlugin`. Never bypass the manager to push data manually to the cache. Supports dynamic loading via `loadFromManifest`.
|
||||
|
||||
### `PollingManager`
|
||||
Coordinates interval execution. Implements **exponential backoff**. When a plugin errors, it retries at increasing scales (e.g., 2s → 4s → 8s) automatically.
|
||||
|
||||
### `DataBus`
|
||||
The typed generic event bus separating React UI components from background execution.
|
||||
|
||||
```typescript
|
||||
// How data gets pushed onto the rendering surface securely:
|
||||
DataBus.getInstance().emit('dataUpdated', {
|
||||
pluginId: "mytracker",
|
||||
entities: newEntities
|
||||
});
|
||||
```
|
||||
|
||||
## Local Plugin Development (Sandbox)
|
||||
|
||||
To rapidly iterate on plugins without polluting the core monorepo `packages/` directory or git history, use the local devkit:
|
||||
|
||||
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.
|
||||
3. **Publish**: The `dev:plugins` script natively supports hot-reloading local plugins within the workspace. Once the plugin is ready, you can simply use `node packages/wwv-cli/dist/index.js publish <name> [--org <your-org>]` from the project root to publish it.
|
||||
|
||||
## When to Apply
|
||||
When writing `fetch` implementations for plugins, or tracing why an entity dropped off the map. Ensure missing data correctly triggers the cache fallback via the DataBus. Ensure all new external plugins use the `bundle` format and exist in the marketplace registry to avoid CDN 404 hydrating crashes.
|
||||
|
||||
|
||||
|
||||
## Capability Declarations
|
||||
|
||||
|
||||
Every plugin declares what it can access. Undeclared capabilities are **blocked at runtime**.
|
||||
|
||||
```typescript
|
||||
type PluginCapability =
|
||||
| "data:own" // Fetch and render its own data layer
|
||||
| "data:read:<id>" // Read entities from another plugin
|
||||
| "ui:detail-panel" // Inject UI into entity detail panel
|
||||
| "ui:sidebar" // Add a sidebar section
|
||||
| "ui:toolbar" // Add toolbar buttons
|
||||
| "ui:settings" // Add a settings page
|
||||
| "globe:overlay" // Draw on the globe (polylines, polygons, heatmaps)
|
||||
| "globe:camera" // Control camera movement
|
||||
| "storage:read" // Read from local/cloud storage
|
||||
| "storage:write" // Write to local/cloud storage
|
||||
| "network:fetch" // Make external HTTP requests
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Trust Tiers
|
||||
|
||||
| Trust Tier | Who | Capabilities Allowed | How Determined |
|
||||
|---|---|---|---|
|
||||
| **Built-in** | Ships with WWV | All | Hardcoded in `AppShell` at build time |
|
||||
| **Verified** | WorldWideView-reviewed | Any declared capability | Plugin ID in the **signed registry** |
|
||||
| **Unverified** | Community / 3rd-party | `data:own`, `ui:settings` only | Plugin ID NOT in the registry |
|
||||
|
||||
### Signed Plugin Registry
|
||||
|
||||
Trust is determined by a cryptographically signed JSON file:
|
||||
|
||||
```
|
||||
GET marketplace.worldwideview.dev/api/registry
|
||||
→ { plugins: ["aviation", "maritime", ...], issuedAt, signature }
|
||||
```
|
||||
|
||||
- Signed with **Ed25519** private key (held only by registry maintainer)
|
||||
- WWV instances have the **public key hardcoded** — nobody can forge a fake verified list
|
||||
- WWV fetches and **verifies signature server-side** at install time
|
||||
- Trust is **always stamped server-side** — no client-side trust claims accepted
|
||||
- Registry response cached for **5 minutes** (in-memory on each WWV instance)
|
||||
- If registry unreachable, last cached result used; new unknowns default to `unverified`
|
||||
- **Managing:** Edit `src/data/verifiedPlugins.ts` in marketplace repo and redeploy
|
||||
- **Revoking:** Remove plugin ID and redeploy — WWV instances drop trust on next cache refresh
|
||||
|
||||
### Unverified Plugin Warning
|
||||
|
||||
When an unverified manifest is encountered:
|
||||
1. Plugin held in pending queue (not loaded)
|
||||
2. `UnverifiedPluginDialog` shown: "This plugin is unverified. Install at your own risk."
|
||||
3. User can Allow (stores approval in `localStorage`) or Deny
|
||||
4. Once approved, dialog won't reappear for that plugin ID
|
||||
|
||||
---
|
||||
|
||||
## VS Code Design Patterns Applied
|
||||
|
||||
**Activation events** — plugins declare when they activate, not at startup:
|
||||
```json
|
||||
"activationEvents": ["onView:aviationLayer", "onCommand:wwv.showCockpit"]
|
||||
```
|
||||
|
||||
**Contribution points** — declarative UI, no code needed for sidebar/menu entries:
|
||||
```json
|
||||
"contributes": {
|
||||
"commands": [{ "command": "wwv.enterCockpit", "title": "Enter Cockpit View" }],
|
||||
"settings": [{ "key": "refreshInterval", "type": "number", "default": 10 }]
|
||||
}
|
||||
```
|
||||
|
||||
**Extension dependencies** — plugins can require other plugins (auto-installed if missing):
|
||||
```json
|
||||
"extensionDependencies": ["worldwideview.aviation"]
|
||||
```
|
||||
|
||||
**Publisher namespaces** — `publisher.plugin-name` (e.g., `silvertakana.aviation`). Prevents naming conflicts.
|
||||
|
||||
**Extension packs** — bundles of related plugins:
|
||||
```json
|
||||
{ "id": "worldwideview.military-suite", "extensionPack": ["aviation", "military-bases", "radar-overlay"] }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Plugin Auth Types
|
||||
|
||||
Plugins declare auth type in the manifest:
|
||||
|
||||
| Auth Type | Who Calls the API | Server Role |
|
||||
|---|---|---|
|
||||
| `none` | Browser, directly | Nothing |
|
||||
| `apikey` | Server proxy | Injects key from DB, caches response |
|
||||
| `token-exchange` | Browser, directly (after exchange) | One-time key→token swap |
|
||||
| `oauth` | Browser, directly (after OAuth) | OAuth callback handler, stores token |
|
||||
|
||||
**Recommended for scale:** `token-exchange` — your server is never in the hot path for data requests.
|
||||
|
||||
### Shared Auth Contracts & Security Branding
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **See ADR-0001 (Decentralized Plugin Authentication & SSRF Mitigation)**
|
||||
> All proxy and token-exchange implementations must strictly adhere to ADR-0001. This includes enforcing DNS IP Pinning and stream size limits via `undici.Agent` on all proxy routes to prevent SSRF, and encrypting all long-lived credentials (API keys) using AES-256-GCM with 100k PBKDF2 iterations before storing them in the `MarketplaceCredential` model.
|
||||
|
||||
When implementing the `token-exchange` flow or communicating across domains, all plugins and endpoints MUST use the strictly defined shared auth contracts from `@worldwideview/wwv-plugin-sdk/src/auth-contracts.ts` (e.g., `TokenExchangeRequest`, `WebSocketAuthMessage`).
|
||||
|
||||
**Sensitive Credentials**: All long-lived secrets (like API keys and tokens) MUST use the `SensitiveString` branded type and be instantiated via the `sensitive(str)` factory function. This prevents accidental logging/serialization and creates a single grep target for security audits.
|
||||
|
||||
---
|
||||
|
||||
## Plugin Development Workflows
|
||||
|
||||
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/`)
|
||||
2. **Install**: `pnpm install` (Links dependencies via workspace)
|
||||
3. **Develop**: `pnpm dev:all` (Starts frontend, data engine, and plugin watcher dynamically)
|
||||
|
||||
### Local vs Docker Development
|
||||
The marketplace API natively supports hot-reloading for local plugins without rebuilding the core.
|
||||
|
||||
**Docker-Hosted Mode (Recommended for external devs):**
|
||||
If a developer wants to build a plugin without cloning the 1GB+ WorldWideView monorepo, they can pull the official WWV Docker image and mount their compiled plugin code:
|
||||
1. Run WWV with the development flag: `WWV_PLUGIN_DEV=true`
|
||||
2. Mount the local plugin's `dist/` folder into the container's `/app/local-plugins/` directory.
|
||||
3. Because the plugin is strictly code, Vite rebuilds in <100ms, and a browser refresh instantly loads the new plugin from the Docker volume.
|
||||
|
||||
**Core Contributor Mode:**
|
||||
If working inside a cloned `worldwideview` directory, scaffolding the plugin into `local-plugins/` makes it a pnpm workspace member. Running `pnpm dev:all` automatically spawns `pnpm dev:plugins`, which continuously transpiles local plugins so the Next.js frontend can hot-reload them without complex linking.
|
||||
|
||||
---
|
||||
|
||||
DB stores **references only** — never plugin files:
|
||||
|
||||
```prisma
|
||||
model InstalledPlugin {
|
||||
pluginId String
|
||||
version String
|
||||
manifestUrl String // "https://marketplace.../api/plugins/aviation/manifest"
|
||||
bundleUrl String? // local path or CDN URL (differs by edition)
|
||||
}
|
||||
```
|
||||
|
||||
| Edition | `bundleUrl` | How served |
|
||||
|---|---|---|
|
||||
| **Local** | `file:./plugins/cockpit-view/bundle.js` | Local filesystem (downloaded at install) |
|
||||
| **Cloud** | `https://cdn.worldwideview.dev/plugins/cockpit-view/bundle.js` | CDN at runtime |
|
||||
|
||||
---
|
||||
|
||||
## Environment Variables & Execution Agnosticism
|
||||
|
||||
WWV enforces a strictly decoupled execution context, allowing plugins to function reliably whether they are loading locally (`plugins-local`) or from a public CDN (`unpkg.com`).
|
||||
|
||||
### Dynamic Assets (`import.meta.url`)
|
||||
For file-based assets bundled alongside the plugin (such as JSON datasets or 3D GLTF models), the runtime relies on native ECMAScript relative resolution instead of hardcoded framework paths.
|
||||
- Plugins securely fetch their assets using `new URL('data/data.json', import.meta.url).href`.
|
||||
- **Impact:** Assets resolve properly directly from the domain they were executed on. No CORS bypasses or CDN fallbacks required.
|
||||
|
||||
### .env Passthrough Injection
|
||||
The WorldWideView core engine functions as a "blind pipe" for developer environment variables, allowing organizations to securely route plugins to custom backend microservices (local or cloud) without modifying the platform.
|
||||
1. The developer adds `NEXT_PUBLIC_WWV_PLUGIN_EXAMPLE_URL="http://localhost:5001"` to their `.env.local`.
|
||||
2. The engine detects the `NEXT_PUBLIC_WWV_PLUGIN_` prefix, strips it, and dynamically hydrates the `PluginContext`.
|
||||
3. The plugin natively retrieves `ctx.env.EXAMPLE_URL`.
|
||||
4. *Security Clause:* Variables accessible via `ctx.env` are exposed directly to the **client-side bundle**. Core secrets/API tokens must never be used here; they must exclusively use the server-side `ctx.getSecret()` workflow.
|
||||
|
||||
---
|
||||
|
||||
## Lazy Loading
|
||||
|
||||
Plugins load their code **only when activated**, not at startup:
|
||||
|
||||
```
|
||||
Startup: load manifests from DB (one query) → globe with built-in plugins only
|
||||
Toggle on "Aviation" → import() aviation bundle → register → fetch data
|
||||
Toggle on "Cockpit View" → import() cockpit bundle → register
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Implementation Stack
|
||||
|
||||
| Piece | Library |
|
||||
|---|---|
|
||||
| Bundle loading | Native `import()` or `@module-federation/enhanced/runtime` |
|
||||
| Manifest validation | `zod` |
|
||||
| Sandboxing (unverified plugins) | `comlink` + Web Workers |
|
||||
| Dependency resolution | `toposort` |
|
||||
| Event system | `mitt` (200 bytes) |
|
||||
| Plugin registry | Custom `PluginManager` class |
|
||||
|
||||
---
|
||||
|
||||
## Built-In Plugins (Current)
|
||||
|
||||
| Plugin | Format | Data Source |
|
||||
|---|---|---|
|
||||
| Aviation | bundle | OpenSky Network (ADS-B) |
|
||||
| Maritime | bundle | AIS (maritime tracking) |
|
||||
| Borders | bundle | GeoJSON from public API |
|
||||
| Wildfire | bundle | NASA FIRMS |
|
||||
| Military Bases | bundle (compiled) | OpenStreetMap (via Overpass) |
|
||||
| Nuclear Facilities | bundle (compiled) | OpenStreetMap |
|
||||
| Camera/CCTV | bundle | IP camera streams |
|
||||
| GeoJSON | bundle | User-supplied GeoJSON files |
|
||||
|
||||
Future direction: Aviation and maritime redesigned as **declarative plugins** pointing to `api.worldwideview.dev` — your own API server handles polling, persistence, and history for all tenants.
|
||||
|
||||
---
|
||||
|
||||
## Creating Static OSM Plugins
|
||||
|
||||
For static plugins built from OpenStreetMap data, use the scaffold script:
|
||||
|
||||
```bash
|
||||
node scripts/scaffold-osm-plugin.mjs '{
|
||||
"name": "volcanoes",
|
||||
"displayName": "Volcanoes",
|
||||
"description": "Active and dormant volcanoes worldwide from OSM",
|
||||
"osmTag": "natural=volcano",
|
||||
"icon": "Mountain",
|
||||
"color": "#ef4444",
|
||||
"category": "Natural Disaster"
|
||||
}'
|
||||
```
|
||||
|
||||
This queries Overpass API, converts to GeoJSON, scaffolds the package, and prints marketplace snippets.
|
||||
|
||||
**Common OSM tags:**
|
||||
|
||||
| Dataset | OSM Tag | ~Count |
|
||||
|---------|---------|--------|
|
||||
| Airports | `aeroway=aerodrome` | 40k |
|
||||
| Seaports | `harbour=yes` | 15k |
|
||||
| Nuclear facilities | `generator:source=nuclear` | 758 |
|
||||
| Volcanoes | `natural=volcano` | 1.5k |
|
||||
| Lighthouses | `man_made=lighthouse` | 20k |
|
||||
| Embassies | `amenity=embassy` | 10k |
|
||||
| Helipads | `aeroway=helipad` | 25k |
|
||||
| Power plants | `power=plant` | 15k |
|
||||
| Wind farms | `generator:source=wind` | 50k |
|
||||
|
||||
See skill: `.agents/skills/osm-static-plugin-creation.md`
|
||||
|
||||
---
|
||||
|
||||
## The Data Engine (Backend & Seeders)
|
||||
|
||||
When a plugin requires 24/7 background polling, long-term history (PostgreSQL), or high-frequency caching (Redis), it should leverage the **Data Engine**. The WWV architecture splits the frontend UI package and the backend data collection into two distinct tiers.
|
||||
|
||||
### 1. First-Party / Built-In Plugins
|
||||
For plugins developed directly inside the WWV monorepo:
|
||||
- **Seeder Module**: Developers write a single seeder (e.g. `seeders/aviation.ts`) inside the `wwv-data-engine` package.
|
||||
- **Unified Container**: All first-party seeders run inside one singular `wwv-data-engine` Docker container. This prevents background polling from being destroyed by Next.js edge isolation or HMR.
|
||||
|
||||
### 2. Third-Party / Community Plugins (The VPS Problem)
|
||||
Currently, **there is a high DX friction for third-party developers hosting their own heavy plugins.**
|
||||
- The `wwv-data-engine` is deeply coupled to the WWV host. Third-party developers cannot push their backend seeders into WWV's actual servers.
|
||||
- The `wwv-plugin-sdk` only assists with the frontend `WorldPlugin` interface.
|
||||
- Consequently, a sole developer with a VPS must write their own Node.js backend entirely from scratch to serve their custom data feeds, handle their own caching, and manage multiple Node instances if they create multiple plugins.
|
||||
|
||||
### 3. The Future: Distributable Data Engine Image
|
||||
To solve this friction and make third-party plugin hosting highly intuitive, the WWV roadmap includes publishing a **WWV Mini-Engine** as a standalone Docker image:
|
||||
1. **Lightweight Deployment:** Developers run `docker run worldwideview/mini-engine` on their VPS.
|
||||
2. **Backend SDK:** They write simple `.ts` fetch scripts returning `GeoEntity[]` and drop them into a mounted `/seeders` volume.
|
||||
3. **Zero Configuration:** The Docker engine hot-reloads these seeders, handles the Redis caching, and exposes standardized REST or WebSocket endpoints automatically. The developer focuses only on fetching data, avoiding all backend infrastructure setup.
|
||||
|
||||
See skill: `.agents/skills/data-engine-seeder-creation.md`
|
||||
|
||||
---
|
||||
|
||||
## Architectural Differences: WorldWideView (WWV) vs WorldMonitor (WM)
|
||||
|
||||
While WorldWideView draws UI/UX and feature inspiration from WorldMonitor as a baseline, the underlying plugin architectures are fundamentally different.
|
||||
|
||||
### WorldMonitor (The Inspiration)
|
||||
- **Monolithic Frontend**: Layers and datasets are typically hardcoded directly into the application's core logic.
|
||||
- **Custom Implementations**: Each data source usually requires its own bespoke API fetching, state management, and map rendering logic (e.g., raw Mapbox/Cesium objects).
|
||||
- **Coupled Backend**: Data ingestion is often tightly coupled to the monolithic application or spread across scattered, heterogeneous microservices without a unified cache.
|
||||
|
||||
### WorldWideView (The Reality)
|
||||
- **Extensible VS Code-Style Runtime**: Plugins are wholly independent, sandboxable modules loaded dynamically via activation events. The core map knows nothing about aviation or wildfires.
|
||||
- **Unified Data Contract (`GeoEntity`)**: All data layers map their bespoke formats into a strict, unified `GeoEntity` system. The core engine handles clustering, filtering, and timeline playback generically—no custom rendering trickery needed per dataset.
|
||||
- **Shared Data Engine**: WWV enforces a strict separation of concerns. All 24/7 API polling, data normalizations, and history retention happen off-thread in the singular `wwv-data-engine` (utilizing Redis hot cache + PostgreSQL history retention), providing a clean, unified REST interface for the plugin frontend.
|
||||
- **Cryptographic Trust**: WWV incorporates a signed marketplace registry and fine-grained capability declarations (`data:read`, `ui:sidebar`), establishing an enterprise-ready security posture for third-party extensions.
|
||||
|
||||
### Planned Features (Inspired by Monolithic Systems / WM)
|
||||
While avoiding monolithic coupling, WWV plans to implement the following high-UX features natively or via generic plugin capabilities:
|
||||
|
||||
1. **Decentralized Plugin Connections (Agnostic Client)**: WorldWideView is entirely agnostic to the backend. It does NOT enforce a single unified pipeline. If a user activates 30 different plugins hosted on 30 different custom servers, the frontend will happily open 30 separate WebSocket connections. The client application knows absolutely nothing about the Data Engine—it only reads the `streamUrl` provided by each individual plugin's manifest.
|
||||
2. **Cross-Layer Geofencing & Alerts**: A new `User Alert System` designed explicitly as a **plugin**. Utilizing the unified `GeoEntity` outputs, users can draw a polygon on the map and trigger webhooks/notifications if *any* entity from *any* active plugin crosses the boundary.
|
||||
3. **Advanced Dead-Reckoning Hooks**: Building a `useDeadReckoning()` hook directly into the `@worldwideview/wwv-plugin-sdk`. It will automatically use standard `speed` and `heading` props to smoothly glide vehicle entities across the Cesium globe at 60 FPS between data pings, preventing plugin authors from rewriting complex math logic.
|
||||
4. **Curated Workspaces / Scenarios**: The ability for users to save their current state as a "Workspace URL." This generates a shareable link that encodes the exact camera position, timeline bounds, activated plugins, and their respective layer configurations/filters.
|
||||
|
||||
|
||||
## Local Plugins & Seeders
|
||||
|
||||
### 1. Local Sandbox Workflow
|
||||
- **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).
|
||||
|
||||
### 2. Data Engine Seeders
|
||||
Seeders in `wwv-data-engine/src/seeders/` provide the backend data.
|
||||
- **Cron Seeder**: Uses `registerSeeder({ name: "plugin-id", cron: "..." })` and pushes to Redis via `setLiveSnapshot()`.
|
||||
- **Init Seeder**: High-frequency or persistent websockets via `init: () => void`.
|
||||
- **Constraint**: Seeder `name` MUST exactly match the frontend plugin `id`. Do not bundle workspace dependencies like `ws` or `zod` into the seeder `dist`.
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,378 @@
|
||||
---
|
||||
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 |
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
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/**/*"
|
||||
---
|
||||
|
||||
# Zustand State Management
|
||||
|
||||
## Purpose
|
||||
Guidelines on managing the single source of truth across WorldWideView using Zustand, avoiding prop-drilling, and isolating UI rerenders.
|
||||
|
||||
## Single Centralized State
|
||||
WorldWideView utilizes a monolithic Zustand store located at `src/core/state/store.ts`. It is broken down into exactly 9 semantic slices.
|
||||
|
||||
| Slice Name | Purpose | Example State |
|
||||
|---|---|---|
|
||||
| **Globe** | Cesium Viewer state | `cameraPosition`, `selectedEntity` |
|
||||
| **Layers** | Loaded map tiles/overlays | `activeTileSets` |
|
||||
| **Timeline** | Application current time | `currentTimeRange` |
|
||||
| **UI** | Global overlay states | `isFilterMenuOpen` |
|
||||
| **Filters** | Active visual filtration | `searchQuery`, `categoryFilter` |
|
||||
| **Data** | Entity registry | `entitiesByPlugin` |
|
||||
| **Config** | User preferences | `pollingIntervals`, `pluginSettings` |
|
||||
| **Favorites**| Pinned entities | `favoriteIds` |
|
||||
| **GeoJSON** | Local files loaded in | `localImports` |
|
||||
|
||||
## When to Apply
|
||||
When passing deep state across components, or when a plugin must push state configurations onto the screen.
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Avoid Prop Drilling
|
||||
**Never** pass props further than two levels down. If a component deeper in the tree needs access to something (e.g., `cameraPosition`), it must `useStore(s => s.globe.cameraPosition)`.
|
||||
|
||||
### Selector Destructuring Avoidance
|
||||
> [!WARNING]
|
||||
> Do not destructure wide objects in selectors.
|
||||
> Right: `const isHUD = useStore(state => state.ui.hudVisible);`
|
||||
> Wrong: `const { hudVisible } = useStore(state => state.ui);`
|
||||
> The wrong approach rerenders the component any time *anything* in the `ui` slice changes.
|
||||
|
||||
### Config and Plugins
|
||||
If your plugin has user-configurable values (e.g., color settings, toggle states), its data MUST live inside `state.config.dataConfig.pluginSettings[pluginId]`. Do not spawn un-bound `useState` hooks for UI properties if they affect the global app state.
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,125 @@
|
||||
param (
|
||||
[Parameter(Mandatory=$true, HelpMessage="Base Git SHA")]
|
||||
[string]$BaseSha,
|
||||
|
||||
[Parameter(Mandatory=$true, HelpMessage="Head Git SHA")]
|
||||
[string]$HeadSha,
|
||||
|
||||
[Parameter(Mandatory=$false, HelpMessage="Path to ADR or Requirements File")]
|
||||
[string]$RequirementsFile = "",
|
||||
|
||||
[Parameter(Mandatory=$false, HelpMessage="Brief description of the implemented changes")]
|
||||
[string]$Description = "Implemented recent changes as per requirements.",
|
||||
|
||||
[Parameter(Mandatory=$false, HelpMessage="Model to use")]
|
||||
[string]$Model = "gemini-2.5-flash"
|
||||
)
|
||||
|
||||
# Set strict error handling
|
||||
$ErrorActionPreference = "Stop"
|
||||
|
||||
Write-Host "Gathering Code Review Context..." -ForegroundColor Cyan
|
||||
|
||||
# Ensure local-scripts directory exists
|
||||
$ScriptDir = Split-Path -Parent $MyInvocation.MyCommand.Path
|
||||
$WorkspaceRoot = Split-Path -Parent $ScriptDir
|
||||
$TempPromptFile = Join-Path $ScriptDir "pr-review-prompt.txt"
|
||||
|
||||
# 1. Fetch Requirements text if provided
|
||||
$RequirementsText = "No specific requirements provided."
|
||||
if ($RequirementsFile -ne "") {
|
||||
if (Test-Path $RequirementsFile) {
|
||||
$RequirementsText = Get-Content $RequirementsFile -Raw
|
||||
} else {
|
||||
Write-Warning "Requirements file not found at $RequirementsFile"
|
||||
}
|
||||
}
|
||||
|
||||
# 2. Extract git diff
|
||||
Write-Host "Extracting diff between $BaseSha and $HeadSha..." -ForegroundColor DarkGray
|
||||
try {
|
||||
$DiffOutput = git diff $BaseSha..$HeadSha
|
||||
if ([string]::IsNullOrWhiteSpace($DiffOutput)) {
|
||||
Write-Host "No changes found between $BaseSha and $HeadSha." -ForegroundColor Yellow
|
||||
exit 0
|
||||
}
|
||||
} catch {
|
||||
Write-Error "Failed to execute git diff. Ensure you are in a git repository and the SHAs are valid."
|
||||
exit 1
|
||||
}
|
||||
|
||||
# 3. Construct the Reviewer Prompt
|
||||
$ReviewerPrompt = @"
|
||||
You are a Senior Code Reviewer with expertise in software architecture, design patterns, and best practices. Your job is to review completed work against its plan or requirements and identify issues before they cascade. You are a sub-agent for Antigravity. Output ONLY the review format below. DO NOT use tools.
|
||||
|
||||
## What Was Implemented
|
||||
$Description
|
||||
|
||||
## Requirements / Plan
|
||||
$RequirementsText
|
||||
|
||||
## Git Range to Review
|
||||
**Base:** $BaseSha
|
||||
**Head:** $HeadSha
|
||||
|
||||
```diff
|
||||
$DiffOutput
|
||||
```
|
||||
|
||||
## What to Check
|
||||
- **Plan alignment:** Does the implementation match the requirements? Are deviations justified?
|
||||
- **Code quality:** Clean separation of concerns? Proper error handling?
|
||||
- **Architecture:** Sound design decisions? Security concerns?
|
||||
- **Testing:** Edge cases covered? Integration tests?
|
||||
- **Production readiness:** Backward compatibility? Obvious bugs?
|
||||
|
||||
## Output Format
|
||||
### Strengths
|
||||
[What's well done? Be specific.]
|
||||
|
||||
### Issues
|
||||
#### Critical (Must Fix)
|
||||
[Bugs, security issues, data loss risks, broken functionality]
|
||||
#### Important (Should Fix)
|
||||
[Architecture problems, missing features, poor error handling, test gaps]
|
||||
#### Minor (Nice to Have)
|
||||
[Code style, optimization opportunities, documentation polish]
|
||||
|
||||
For each issue:
|
||||
- File:line reference
|
||||
- What's wrong
|
||||
- Why it matters
|
||||
- How to fix (if not obvious)
|
||||
|
||||
### Recommendations
|
||||
[Improvements for code quality, architecture, or process]
|
||||
|
||||
### Assessment
|
||||
**Ready to merge?** [Yes | No | With fixes]
|
||||
**Reasoning:** [1-2 sentence technical assessment]
|
||||
"@
|
||||
|
||||
# 4. Save to temporary file
|
||||
$ReviewerPrompt | Set-Content $TempPromptFile -Encoding UTF8
|
||||
|
||||
# 5. Dispatch to Gemini CLI
|
||||
Write-Host "Dispatching to Gemini CLI ($Model)..." -ForegroundColor Cyan
|
||||
Write-Host "Depending on the diff size, this may take 30-60 seconds." -ForegroundColor DarkGray
|
||||
|
||||
$GeminiCmd = "$env:APPDATA\npm\gemini.cmd"
|
||||
if (-Not (Test-Path $GeminiCmd)) {
|
||||
Write-Error "Gemini CLI not found at $GeminiCmd. Ensure it is installed globally via npm."
|
||||
exit 1
|
||||
}
|
||||
|
||||
try {
|
||||
Get-Content $TempPromptFile -Raw | & $GeminiCmd -m $Model
|
||||
Write-Host "`nCode Review Complete." -ForegroundColor Green
|
||||
} catch {
|
||||
Write-Error "Failed to execute Gemini CLI. If you received a 429 RESOURCE_EXHAUSTED error, try changing the model (e.g. -Model gemini-1.5-pro)."
|
||||
} finally {
|
||||
# Clean up temp file
|
||||
if (Test-Path $TempPromptFile) {
|
||||
Remove-Item $TempPromptFile -Force
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
{
|
||||
"env": {
|
||||
"CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS": "1"
|
||||
},
|
||||
"permissions": {
|
||||
"allow": [
|
||||
"Read(src/**)",
|
||||
"Bash(npm test)"
|
||||
],
|
||||
"deny": [
|
||||
"Read(.env)",
|
||||
"Write(config.json)"
|
||||
],
|
||||
"defaultMode": "bypassPermissions"
|
||||
},
|
||||
"prefersReducedMotion": false
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
name: architectural-decision-records
|
||||
description: Use when making significant architectural decisions, adding new patterns, or altering core workflows. This skill ensures that all major technical choices are documented via ADRs.
|
||||
---
|
||||
|
||||
# Architectural Decision Records (ADRs)
|
||||
|
||||
## When to use this skill
|
||||
Trigger this skill whenever you are about to introduce a new architectural pattern, make a load-bearing contract change, or bypass an established standard for a necessary reason.
|
||||
|
||||
## Guidelines
|
||||
1. **Never make a major architectural change without an ADR**.
|
||||
2. Store ADRs in `docs/architecture/decisions/` (create this directory if it doesn't exist).
|
||||
3. Name ADR files using the pattern `adr-00##-name.md` (e.g., `adr-0001-use-postgresql.md`).
|
||||
4. An ADR must follow this exact structure:
|
||||
- **Title**: Short, descriptive noun phrase.
|
||||
- **Context**: What is the problem we are solving? What forces are at play? (Be objective).
|
||||
- **Decision**: What is the specific change or pattern we are adopting?
|
||||
- **Consequences**: What becomes easier because of this change? What becomes harder? (There are always trade-offs).
|
||||
|
||||
## Actionable Steps
|
||||
When tasked with a major architecture change, pause and explicitly state: *"This requires an Architectural Decision Record."* Draft the ADR and ask the user to approve the reasoning *before* writing the implementation code.
|
||||
@@ -0,0 +1,257 @@
|
||||
---
|
||||
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
|
||||
---
|
||||
|
||||
# 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:
|
||||
|
||||
1. **Frontend routing** — hardcoded engine URLs must be replaced with `resolveEngineUrl()`
|
||||
2. **Backend seeder build** — ESM bundling and container-aware file paths
|
||||
|
||||
**Core principle:** These are two separate problems in two separate codebases. Never fix one and forget the other.
|
||||
|
||||
## When to Use
|
||||
|
||||
- Moving a plugin from `packages/wwv-plugin-<name>/` (or `../worldwideview-plugins/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
|
||||
- Seeder uses `fileURLToPath(import.meta.url)` for locating seed data files
|
||||
- Plugin builds with `tsc` instead of `tsup`/`vite`
|
||||
|
||||
**Do NOT use for:**
|
||||
- Creating a brand-new plugin from scratch → use `worldwideview-plugin-creation` skill
|
||||
- Modifying rendering or Cesium primitives → see `cesium-rendering` rule
|
||||
- Debugging state management → see `state-management` rule
|
||||
|
||||
## The Two Independent Concerns
|
||||
|
||||
> [!TIP]
|
||||
> **Automated Migration Script**
|
||||
> A new automation script is available! Before doing this manually, simply run:
|
||||
> ```bash
|
||||
> node scripts/migrate-plugin.mjs <plugin-name>
|
||||
> ```
|
||||
> 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`.
|
||||
> **You still need to run `pnpm install` and verify the builds manually as described below.**
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Legacy plugins always have BOTH of these problems. They are independent — you can fix one without the other, but you MUST fix both. Do not get tunnel-visioned into only fixing one.
|
||||
|
||||
| Concern | Where | Symptom | Fix |
|
||||
|---|---|---|---|
|
||||
| **Frontend routing** | `local-plugins/wwv-plugin-<name>/src/index.ts` | Plugin always hits cloud engine, ignores local dev engine | Use `context.getEngineUrl()` |
|
||||
| **Backend build** | `local-seeders/<namespace>/packages/<name>/` | Container crashes on startup with ESM errors | `tsup --format esm --target es2022`, use `SEEDERS_DIR` |
|
||||
|
||||
---
|
||||
|
||||
## Step 1: Move the Plugin Directory
|
||||
|
||||
Copy the plugin from `packages/` (or the external plugins repo) to `local-plugins/`:
|
||||
|
||||
```bash
|
||||
# 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`)
|
||||
- Auto-discovered by the `dev:plugins` watcher during `pnpm dev`
|
||||
|
||||
## Step 2: Fix Frontend Routing (getEngineUrl)
|
||||
|
||||
This is the fix that gets missed most often. Legacy plugins typically hardcode their engine URL or use messy dynamic imports.
|
||||
|
||||
```typescript
|
||||
// ❌ LEGACY — always hits cloud, ignores local engine
|
||||
const baseUrl = this.context?.apiBaseUrl || "https://dataengine.worldwideview.dev";
|
||||
const res = await fetch(`${baseUrl}/api/myplugin`);
|
||||
|
||||
// ❌ BAD (Previous Workaround) — creates bundling chunks and causes 404s
|
||||
const { resolveEngineUrl } = await import("@/core/data/resolveEngineUrl");
|
||||
const wsUrl = resolveEngineUrl(this.id);
|
||||
const engineBase = wsUrl.replace(/^ws/, 'http').replace(/\/stream$/, '');
|
||||
const res = await fetch(`${engineBase}/api/myplugin`);
|
||||
```
|
||||
|
||||
The correct approach uses `this.context.getEngineUrl()` provided by the Host when the plugin is initialized. The Host automatically handles checking `localhost:5000/manifest`, applying `getServerConfig().streamUrl`, reading `plugin.json`, or falling back to the cloud.
|
||||
|
||||
```typescript
|
||||
// ✅ MODERN — resolves local-first, respects split-routing, clean code
|
||||
async fetch(_timeRange: TimeRange): Promise<GeoEntity[]> {
|
||||
try {
|
||||
const engineBase = this.context!.getEngineUrl();
|
||||
const res = await globalThis.fetch(`${engineBase}/api/${this.id}`);
|
||||
if (!res.ok) throw new Error(`Backend returned ${res.status}`);
|
||||
|
||||
const data = await res.json();
|
||||
return this.mapPayloadToEntities(data);
|
||||
} catch (err) {
|
||||
console.error(`[${this.id}] Fetch error:`, err);
|
||||
return [];
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
If the plugin is WebSocket-only (`getPollingInterval()` returns 0 and `fetch()` returns `[]`), the frontend routing is handled automatically by `DataBusSubscriber` and `WsClient`. No changes needed to the plugin class — but verify the seeder ID matches.
|
||||
|
||||
### Why This Matters
|
||||
|
||||
Without this fix, running `pnpm dev:all` starts a local engine at `localhost:5000` with your seeder, but the frontend plugin ignores it and hits the cloud. You'll see stale or missing data and waste time debugging the wrong layer.
|
||||
|
||||
## Step 3: Update package.json
|
||||
|
||||
Ensure the plugin's `package.json` follows the modern format:
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "@worldwideview/wwv-plugin-<name>",
|
||||
"version": "1.0.0",
|
||||
"main": "dist/frontend.mjs",
|
||||
"types": "src/index.ts",
|
||||
"type": "module",
|
||||
"module": "dist/frontend.mjs",
|
||||
"files": ["src"],
|
||||
"worldwideview": {
|
||||
"id": "<name>",
|
||||
"icon": "IconName",
|
||||
"category": "category-name",
|
||||
"format": "bundle",
|
||||
"capabilities": ["layer"]
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@worldwideview/wwv-plugin-sdk": "^1.4.10"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "vite build"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Key differences from legacy:
|
||||
- `"main"` points to `dist/frontend.mjs` (not `src/index.ts`)
|
||||
- Has `"type": "module"` and `"module"` field
|
||||
- Uses `peerDependencies` (not `dependencies`) for SDK
|
||||
- Uses `"workspace:*"` only for libraries that must be linked locally (e.g., `wwv-lib-incidents`)
|
||||
|
||||
## Step 4: Ensure Vite Build Config
|
||||
|
||||
Every `local-plugins/` plugin needs this `vite.config.ts`:
|
||||
|
||||
```typescript
|
||||
import { defineConfig } from "vite";
|
||||
import { wwvPluginGlobals } from "@worldwideview/wwv-plugin-sdk";
|
||||
|
||||
export default defineConfig({
|
||||
plugins: [wwvPluginGlobals()],
|
||||
build: {
|
||||
lib: {
|
||||
entry: "src/index.ts",
|
||||
formats: ["es"],
|
||||
fileName: () => "frontend.mjs",
|
||||
},
|
||||
minify: true,
|
||||
sourcemap: false,
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
`wwvPluginGlobals()` externalizes React, Cesium, Resium, zustand, and the SDK so the plugin doesn't bundle its own copies.
|
||||
|
||||
## Step 5: Fix Backend Seeder (if applicable)
|
||||
|
||||
If the plugin has a corresponding seeder in `local-seeders/`, fix two things:
|
||||
|
||||
### 5a. ESM Build
|
||||
|
||||
Legacy seeders built with `tsc` or bundled Node built-ins. Fix:
|
||||
|
||||
```json
|
||||
"scripts": {
|
||||
"build": "tsup src/index.ts --format esm --target es2022 --clean"
|
||||
}
|
||||
```
|
||||
|
||||
This produces clean ESM that the data engine can `import()` without `Dynamic require` errors.
|
||||
|
||||
### 5b. Container-Aware File Paths
|
||||
|
||||
Legacy seeders used `fileURLToPath(import.meta.url)` to locate seed data. This breaks inside Docker because the transpiled path doesn't match the container filesystem.
|
||||
|
||||
```typescript
|
||||
// ❌ LEGACY — breaks in Docker container
|
||||
import { fileURLToPath } from "url";
|
||||
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
||||
const dataPath = path.join(__dirname, "data", "seed.json");
|
||||
|
||||
// ✅ MODERN — works everywhere
|
||||
const dataPath = process.env.SEEDERS_DIR
|
||||
? path.join(process.env.SEEDERS_DIR, "community", "packages", "<name>", "data", "seed.json")
|
||||
: path.resolve(process.cwd(), "data", "seed.json");
|
||||
```
|
||||
|
||||
`SEEDERS_DIR` is set by the Docker container to `/app/seeders`. When running locally outside Docker, the fallback uses `process.cwd()`.
|
||||
|
||||
### 5c. Seeder Directory Naming
|
||||
|
||||
The folder name inside `local-seeders/community/packages/` or `local-seeders/private/packages/` **must exactly match** the plugin's string ID (`this.id` in `index.tsx`).
|
||||
|
||||
The `wwv-data-engine`'s auto-discovery logic (`seeder-loader.ts`) derives the internal plugin ID from the directory name. If the folder is named `gpsjam` but the frontend plugin expects `gps-jamming`, the frontend will not find it in the `/manifest` and will silently fall back to the cloud engine, breaking local testing.
|
||||
|
||||
```bash
|
||||
# ❌ INCORRECT (Frontend expects "gps-jamming")
|
||||
local-seeders/community/packages/gpsjam/
|
||||
|
||||
# ✅ CORRECT
|
||||
local-seeders/community/packages/gps-jamming/
|
||||
```
|
||||
|
||||
## Step 6: Clean Up packages/ References
|
||||
|
||||
After moving to `local-plugins/`, remove the old references:
|
||||
|
||||
- [ ] Delete `packages/wwv-plugin-<name>/` directory (or the source directory in `../worldwideview-plugins/packages/`)
|
||||
- [ ] 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)
|
||||
- [ ] Run `pnpm install` from project root
|
||||
|
||||
## Step 7: Verify
|
||||
|
||||
```bash
|
||||
# 1. Start everything
|
||||
pnpm dev:all
|
||||
|
||||
# 2. Check engine discovered the seeder (if applicable)
|
||||
curl http://localhost:5000/manifest
|
||||
# Should include your plugin ID
|
||||
|
||||
# 3. Check frontend console — should show:
|
||||
# [EngineManifest] Local engine detected: N seeders ["your-plugin", ...]
|
||||
# NOT: fetching from https://dataengine.worldwideview.dev
|
||||
|
||||
# 4. Toggle the layer on the globe — entities should render
|
||||
```
|
||||
|
||||
## Migration Checklist
|
||||
|
||||
- [ ] Plugin copied from `packages/` (or external repo) to `local-plugins/`
|
||||
- [ ] Frontend `fetch()` uses `this.context.getEngineUrl()` (not hardcoded URLs or dynamic imports)
|
||||
- [ ] `package.json` has `"type": "module"`, `"main": "dist/frontend.mjs"`
|
||||
- [ ] `vite.config.ts` uses `wwvPluginGlobals()` externalization
|
||||
- [ ] Backend seeder builds with `tsup --format esm --target es2022` (if applicable)
|
||||
- [ ] Backend seeder uses `process.env.SEEDERS_DIR` for file paths (if applicable)
|
||||
- [ ] Old source directory deleted
|
||||
- [ ] Old `transpilePackages`/`tsconfig paths` entries removed
|
||||
- [ ] `pnpm install` run from root
|
||||
- [ ] `pnpm dev:all` → local engine detected → data renders on globe
|
||||
@@ -0,0 +1,72 @@
|
||||
---
|
||||
name: playwright-testing
|
||||
description: Use when creating or modifying Playwright end-to-end tests, especially when injecting mock plugins to test platform features.
|
||||
---
|
||||
|
||||
# Playwright E2E Testing & Mock Plugin Guide
|
||||
|
||||
When you are tasked with testing a new feature or plugin in WorldWideView using Playwright, you must use this skill to ensure you follow the strict architecture rules of the platform.
|
||||
|
||||
## 1. Mock Plugin Requirements
|
||||
When creating a mock plugin (e.g., `public/e2e-fixtures/my-mock-plugin.js`) to test a specific UI feature, **you MUST implement the full Data Plugin interface**.
|
||||
|
||||
WorldWideView's `PluginManager` throws fatal runtime errors if a plugin is missing core data fetching methods, even if your plugin only tests a UI component like a bottom panel.
|
||||
|
||||
**Required Methods for EVERY Mock Plugin:**
|
||||
```javascript
|
||||
export default {
|
||||
id: "my-mock-plugin",
|
||||
name: "My Mock Plugin",
|
||||
// ...
|
||||
// MUST BE INCLUDED:
|
||||
fetch: async (timeRange) => { return []; },
|
||||
getPollingInterval: () => { return 60000; },
|
||||
getLayerConfig: () => { return { color: "#FFF", clusterEnabled: false, clusterDistance: 50 }; },
|
||||
renderEntity: (entity) => { return { type: "point", color: "#FFF", size: 5 }; },
|
||||
|
||||
// Your UI testing component (e.g., Sidebar, Bottom Panel)
|
||||
getBottomPanelComponent: () => { ... }
|
||||
}
|
||||
```
|
||||
|
||||
## 2. Mock Plugin Manifest Capabilities
|
||||
If your mock plugin needs to be toggled by the user in the Layers list, you MUST include the `"ui:sidebar"` capability in its `manifest.json`.
|
||||
```json
|
||||
{
|
||||
"capabilities": ["ui:bottom-panel", "ui:sidebar"],
|
||||
"extends": ["sidebar"]
|
||||
}
|
||||
```
|
||||
|
||||
## 3. Database Injection
|
||||
The frontend reads plugins from the database. You MUST inject your mock plugin during `tests/global.setup.ts` using Prisma:
|
||||
|
||||
```typescript
|
||||
const manifestPath = path.join(process.cwd(), 'public', 'e2e-fixtures', 'my-mock-plugin-manifest.json');
|
||||
const manifestStr = fs.readFileSync(manifestPath, 'utf-8');
|
||||
await prisma.installedPlugin.create({
|
||||
data: {
|
||||
pluginId: 'my-mock-plugin',
|
||||
version: '1.0.0',
|
||||
config: manifestStr,
|
||||
enabled: true
|
||||
}
|
||||
});
|
||||
```
|
||||
Make sure to add your new mock plugin ID to the cleanup logic in `global.setup.ts` as well:
|
||||
```typescript
|
||||
await prisma.installedPlugin.deleteMany({
|
||||
where: { pluginId: { in: ['e2e-mock-plugin', 'my-mock-plugin'] } }
|
||||
});
|
||||
```
|
||||
|
||||
## 4. UI Selectors
|
||||
**DO NOT use CSS classes for your locators.** CSS classes change frequently (e.g., `.dock-btn`, `.layer-item__toggle`).
|
||||
You MUST either:
|
||||
1. Add explicit `data-testid` attributes to the React components you are testing.
|
||||
2. Use stable accessibility locators (e.g., `getByRole('button', { name: /Text/ })`).
|
||||
|
||||
## 5. Execution Environment
|
||||
- Ensure `pnpm run dev:backends` is running before you execute tests locally.
|
||||
- Run tests using `pnpm run test:e2e` or `npx playwright test tests/your-test.spec.ts`.
|
||||
- **PowerShell Warning**: Remember you are running in Windows PowerShell. Do NOT chain commands with `&&`. Use `;` instead.
|
||||
@@ -0,0 +1,65 @@
|
||||
---
|
||||
name: using-git-worktrees
|
||||
description: Use when tasked with creating a new git worktree, building features in isolation, setting up parallel branches, or provisioning a safe sandbox environment to test architectural changes.
|
||||
---
|
||||
|
||||
# Using Git Worktrees (Worktrunk)
|
||||
|
||||
## Overview
|
||||
Git worktrees allow you to check out multiple branches of a repository simultaneously without cloning the entire repository from scratch. However, creating worktrees in nested subdirectories breaks relative path resolutions to peer monorepo packages. We use **Worktrunk** (`git-wt`) to automatically provision sibling worktrees and handle environment setup.
|
||||
|
||||
## When to Use
|
||||
- When asked to create an isolated environment for a feature or branch.
|
||||
- When you need a safe sandbox to test destructive or complex architectural changes.
|
||||
- When working on multiple GitHub issues in parallel.
|
||||
|
||||
## Core Directives
|
||||
|
||||
### 1. NEVER Nest Worktrees
|
||||
If you create a worktree inside a subdirectory of the current repo (e.g., `.agents/worktrees/feature`), all relative paths going UP and OUT of the repository (like `../../wwv-data-engine`) will immediately break due to the altered directory depth.
|
||||
|
||||
**Worktrees MUST be siblings of the main repository root.**
|
||||
|
||||
### 2. ALWAYS Use Worktrunk
|
||||
Do not use raw `git worktree add`. Always use the `git-wt` alias provided by Worktrunk. It is pre-configured via `.config/wt.toml` to:
|
||||
- Automatically place the worktree in the correct sibling path.
|
||||
- Automatically run `pnpm install`.
|
||||
- Automatically copy `.env` files so the environment works immediately.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **For AI Agents:** You MUST append the `--yes` flag when creating worktrees to bypass the interactive approval prompt for these hooks, otherwise the command will fail in your non-interactive shell.
|
||||
|
||||
### 3. Database Lifecycle & Port Assignment
|
||||
Each worktree gets a deterministic PostgreSQL port assigned automatically based on its directory hash (to avoid collisions between multiple running worktrees).
|
||||
|
||||
> [!CAUTION]
|
||||
> **Orphaned Volumes:** You MUST use `git-wt remove` to delete worktrees. This triggers a `pre-remove` hook that cleanly tears down the Docker database. If you manually delete the folder (`rm -rf`), the Docker volume is orphaned. If this happens, run `pnpm run db:prune` in the main repository to garbage collect orphaned database volumes.
|
||||
|
||||
## Quick Reference
|
||||
|
||||
| Action | Command | Details |
|
||||
| :--- | :--- | :--- |
|
||||
| **Create Worktree** | `git-wt switch --create <branch> --yes` | Provisions the sibling directory, branch, env files, and dependencies. |
|
||||
| **Delete Worktree** | `git-wt remove` | Deletes the worktree and the associated branch cleanly. Run from within the worktree. |
|
||||
|
||||
## Implementation Steps
|
||||
|
||||
1. Run the create command from the main repository (always include `--yes`):
|
||||
```bash
|
||||
git-wt switch --create feature/my-new-idea --yes
|
||||
```
|
||||
2. **CRITICAL:** Change your working directory to the newly created worktree before editing files. Worktrunk creates it as a sibling.
|
||||
```bash
|
||||
# Example if the main repo is c:\dev\worldwideview
|
||||
cd ../worldwideview.feature-my-new-idea
|
||||
```
|
||||
3. Do your work, run tests, and commit.
|
||||
4. When completely finished and merged, clean up by running `git-wt remove` from inside the worktree directory.
|
||||
|
||||
## Common Mistakes & Red Flags
|
||||
|
||||
| Excuse / Rationalization | Reality & Fix |
|
||||
| :--- | :--- |
|
||||
| "I'll just put the worktree in `.agents/worktrees` to keep the project folder clean." | **Red Flag:** This breaks relative paths to other monorepo packages. Delete the worktree and use `git-wt` to create a sibling worktree instead. |
|
||||
| "I'll use `git worktree add` instead of `git-wt` because it's standard." | **Red Flag:** Raw git won't copy `.env` files or run the `pre-start` hooks for `pnpm install`, leaving you with a broken environment. Delete and use `git-wt`. |
|
||||
| "I ran the command, but my file edits are applying to the main branch." | You forgot to `cd` into the newly created sibling directory. |
|
||||
@@ -0,0 +1,17 @@
|
||||
# TSDoc Review Log
|
||||
|
||||
This document tracks the progress of the codebase-wide TSDoc update.
|
||||
|
||||
## Ambiguous Functions Requiring 3.1 Pro Review
|
||||
If a function's purpose cannot be deduced from its signature or body, it is listed here along with its file path and the specific confusion.
|
||||
|
||||
| File Path | Function/Interface Name | Reason for Ambiguity |
|
||||
| :--- | :--- | :--- |
|
||||
<!-- Flash: Append rows here as you work -->
|
||||
|
||||
## Completed Directories
|
||||
- [/] `src/core/plugins` (In Progress: PluginRegistry.ts documented)
|
||||
- [ ] `src/core/state`
|
||||
- [x] `src/components` (Completed: Layout, Panels, Marketplace, Timeline, UI)
|
||||
- [x] `packages/wwv-plugin-sdk`
|
||||
- [x] `scripts`
|
||||
@@ -0,0 +1,101 @@
|
||||
---
|
||||
name: researching-plugins
|
||||
description: Use when evaluating new data sources, researching APIs, or planning a new plugin structure, before writing any implementation code
|
||||
---
|
||||
|
||||
# Researching Plugins
|
||||
|
||||
## Overview
|
||||
This skill defines the rigorous process for researching, evaluating, and planning new data source plugins for WorldWideView. It combines data source validation (evaluating free tiers, rate limits, and comprehensiveness) with the generation of a placeholder-free, TDD-focused implementation plan.
|
||||
|
||||
## When to Use
|
||||
- The user requests a new data source or layer (e.g., "add weather data", "track global earthquakes")
|
||||
- You need to evaluate an API or dataset for continuous polling and 3D globe visualization
|
||||
- You are formulating the implementation steps for a new plugin
|
||||
- *Do not use* if the plugin is already fully planned and you are just executing tasks
|
||||
|
||||
## 1. Research & Evaluation Process
|
||||
|
||||
### Step 1: Take Inspiration from WorldMonitor
|
||||
Before searching the web blindly, check if the `koala73/worldmonitor` repository already implements a similar feature.
|
||||
- Review their data sources, API endpoints, and polling intervals.
|
||||
- Analyze which data fields they map for visualization.
|
||||
- Use this as a baseline for what is possible and expected.
|
||||
|
||||
### Step 2: Validate Data Sources
|
||||
Search for APIs that meet the following strict criteria. If an API fails these, keep searching or ask the user for guidance:
|
||||
- **Cost**: Prioritize highly robust free tiers or completely open data.
|
||||
- **Comprehensiveness**: Does it provide global coverage? Does it return coordinates (lat/lon) and identifying metadata?
|
||||
- **Rate Limits**: Can it support the required polling interval? (Real-time data needs high rate limits).
|
||||
- **Format**: JSON or GeoJSON is preferred.
|
||||
|
||||
## 2. Draft the Implementation Plan
|
||||
|
||||
Once the data source and API are validated, you MUST write a comprehensive implementation plan using the standards from the `writing-plans` skill.
|
||||
|
||||
Save the research and plan to `.agents/context/YYYY-MM-DD-<plugin-name>-research.md`.
|
||||
|
||||
### Required Plan Header
|
||||
```markdown
|
||||
# [Plugin Name] Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development or superpowers:executing-plans to implement this plan task-by-task.
|
||||
|
||||
**Goal:** [One sentence describing what this plugin does]
|
||||
**Data Source:** [API Name, API URL, Auth Method, Rate Limits]
|
||||
**Architecture:** [Proxy route, Static Data, or Microservice?]
|
||||
|
||||
---
|
||||
```
|
||||
|
||||
### Bite-Sized Task Structure
|
||||
Each task in the plan MUST follow a strict TDD, action-by-action sequence.
|
||||
|
||||
**Required Task Format:**
|
||||
```markdown
|
||||
### Task N: [Component Name]
|
||||
|
||||
**Files:**
|
||||
- Create: `packages/wwv-plugin-[name]/src/index.ts`
|
||||
- Test: `packages/wwv-plugin-[name]/test/index.test.ts`
|
||||
|
||||
- [ ] **Step 1: Write the failing test**
|
||||
[Include full test code block here]
|
||||
|
||||
- [ ] **Step 2: Run test to verify it fails**
|
||||
Run: `pnpm test`
|
||||
Expected: FAIL
|
||||
|
||||
- [ ] **Step 3: Write minimal implementation**
|
||||
[Include full implementation code block here]
|
||||
|
||||
- [ ] **Step 4: Run test to verify it passes**
|
||||
Run: `pnpm test`
|
||||
Expected: PASS
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
[Include git commit command]
|
||||
```
|
||||
|
||||
## The Iron Law of Plan Writing
|
||||
|
||||
1. **No Placeholders:** You MUST provide the exact file paths and complete code blocks for every step. Do not write "TODO: Add error handling" or "Add validation here."
|
||||
2. **Exact File Paths Always:** Define exactly where files live (e.g., `src/app/api/...`).
|
||||
3. **DRY & YAGNI:** Do not add speculative features or abstract prematurely.
|
||||
4. **Define the Types First:** Ensure the API response interfaces and the plugin manifest types are defined early in the plan.
|
||||
|
||||
## Common Mistakes & Rationalizations
|
||||
|
||||
| Excuse / Rationalization | Reality / Fix |
|
||||
|--------------------------|---------------|
|
||||
| "I'll propose a paid API because the free ones are hard to find" | WorldWideView is a free tool; prioritize open data. Dig deeper into governmental or open-source datasets. |
|
||||
| "I left TODOs in the plan so the execution agent can fill them in" | Execution agents fail when given placeholders. The plan MUST contain the exact code to be written. |
|
||||
| "I skipped the test steps because it's just an API wrapper" | Every feature requires tests. Draft a test that mocks the API response. |
|
||||
| "I forgot to specify the architecture type" | You must decide if it's a Static, Proxy, or Microservice plugin during the research phase. |
|
||||
|
||||
## Red Flags - STOP and Start Over
|
||||
If you find yourself doing any of the following, delete your work and start over:
|
||||
- Proposing an API with a 50 requests/day limit for real-time tracking.
|
||||
- Writing a plan step that says "Implement similar to Task 2."
|
||||
- Omitting exact file paths or complete code blocks in your tasks.
|
||||
- Failing to verify if WorldMonitor has already solved this problem.
|
||||
@@ -0,0 +1,653 @@
|
||||
---
|
||||
name: worldwideview-plugin-creation
|
||||
description: Use when creating a new plugin, adding a new data source, or debugging missing plugin data in the WorldWideView project. Triggers on seeder creation, WebSocket streaming issues, plugin registration failures, manifest validation errors, GeoEntity rendering problems, or data engine integration
|
||||
---
|
||||
|
||||
# WorldWideView Plugin Creation
|
||||
|
||||
## Overview
|
||||
|
||||
A WorldWideView plugin is a self-contained data source that renders geospatial entities on a 3D Cesium globe. Every plugin implements the `WorldPlugin` interface from the SDK and connects to the **V2 Data Engine** (Fastify + Redis) that streams live data over WebSocket.
|
||||
|
||||
**Core principle:** Plugins are code bundles. The engine pushes data. The frontend renders it. There is no REST polling between frontend and engine — only WebSocket streaming.
|
||||
|
||||
## When to Use
|
||||
|
||||
- Creating a new data layer plugin (any architecture)
|
||||
- Building a new seeder in the data engine
|
||||
- Plugin data doesn't appear on the globe
|
||||
- WebSocket subscription or split-routing issues
|
||||
- Build failures after adding a plugin package
|
||||
- Debugging `renderEntity` or entity clipping artifacts
|
||||
- Marketplace plugin installation/validation issues
|
||||
|
||||
**Do NOT use for:**
|
||||
- Modifying globe rendering primitives → see `cesium-rendering` rule
|
||||
- Zustand state management → see `state-management` rule
|
||||
- Prisma schema changes → see `database-migrations` rule
|
||||
- Monorepo/pnpm workspace issues → see `monorepo-workflow` rule
|
||||
|
||||
## 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];
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Quick Reference
|
||||
|
||||
| Piece | Location | Purpose |
|
||||
|---|---|---|
|
||||
| Sandbox plugin | `local-plugins/wwv-plugin-<name>/` | Local development workspace for new plugins |
|
||||
| Plugin class | `packages/wwv-plugin-<name>/src/index.ts` | Implements `WorldPlugin` interface |
|
||||
| Package metadata | `packages/wwv-plugin-<name>/package.json` | `worldwideview` block with id, type, format, category |
|
||||
| Engine seeder | `wwv-seeders/src/seeders/<name>.ts` | Fetches external data → Redis → WS broadcast |
|
||||
| Build config | `next.config.ts` → `transpilePackages` | Required for monorepo packages |
|
||||
| TS alias | `tsconfig.json` → `paths` | Required for monorepo packages |
|
||||
| Registration | `src/core/plugins/PluginRegistry.ts` | Register plugin at boot |
|
||||
| WS client | `src/core/data/WsClient.ts` | Client-side WebSocket subscriptions |
|
||||
| URL resolution | `src/core/data/resolveEngineUrl.ts` | Per-plugin local vs cloud routing |
|
||||
| Manifest validation | `src/core/plugins/validateManifest.ts` | Checks required fields for CDN bundles |
|
||||
| Host globals | `src/core/plugins/hostGlobals.ts` | Injects shared deps for CDN plugins |
|
||||
|
||||
---
|
||||
|
||||
## Part 1: Frontend Plugin (WorldPlugin)
|
||||
|
||||
### 1.0 Development Workflow (Local Sandbox)
|
||||
|
||||
The standard way to develop a new plugin is using the **Local Sandbox** (`local-plugins/` directory). This keeps experimental code out of the main monorepo packages until it is ready for production.
|
||||
|
||||
1. **Scaffold**: Run `node packages/wwv-cli/dist/index.js create <name> --local` from the project root. This generates a boilerplate plugin in `local-plugins/wwv-plugin-<name>`.
|
||||
2. **Develop**: Run `pnpm dev`. The built-in file watcher (`pnpm dev:plugins`) automatically rebuilds and syncs your local plugin to `public/plugins-local/` whenever you save a file for instant hot-reloading.
|
||||
3. **Publish (Optional)**: When stable, you can use `node packages/wwv-cli/dist/index.js publish <name>` from the project root to publish the plugin to NPM (use the `--org <your-org>` flag to publish under your own NPM organization instead of `@worldwideview`). There is no need to 'link' plugins to the core monorepo manually, as the local sandbox runs natively inside the workspace.
|
||||
|
||||
### 1.1 Implement the Interface
|
||||
|
||||
Every plugin **must** implement `WorldPlugin` from `@worldwideview/wwv-plugin-sdk`:
|
||||
|
||||
```typescript
|
||||
import type {
|
||||
WorldPlugin, PluginContext, GeoEntity,
|
||||
CesiumEntityOptions, TimeRange, LayerConfig, PluginCategory
|
||||
} from "@worldwideview/wwv-plugin-sdk";
|
||||
import { Flame } from "lucide-react";
|
||||
import pkg from "../package.json";
|
||||
|
||||
export default class WildfiresPlugin implements WorldPlugin {
|
||||
id = "wildfires";
|
||||
name = "Wildfires";
|
||||
description = "Live wildfire incidents from NASA FIRMS";
|
||||
icon = Flame;
|
||||
category: PluginCategory = "natural-disaster";
|
||||
version = pkg.version; // NEVER hardcode — always import from package.json
|
||||
|
||||
async initialize(ctx: PluginContext): Promise<void> {
|
||||
// Store context for later use (env vars, edition, callbacks)
|
||||
}
|
||||
|
||||
destroy(): void {
|
||||
// Cleanup timers, WebSocket connections, etc.
|
||||
}
|
||||
|
||||
async fetch(timeRange: TimeRange): Promise<GeoEntity[]> {
|
||||
// For WS-streamed plugins, return [] — data arrives via WsClient
|
||||
return [];
|
||||
}
|
||||
|
||||
getPollingInterval(): number {
|
||||
return 0; // 0 = no REST polling (WS-only)
|
||||
}
|
||||
|
||||
getLayerConfig(): LayerConfig {
|
||||
return {
|
||||
color: "#ef4444",
|
||||
clusterEnabled: true,
|
||||
clusterDistance: 50,
|
||||
maxEntities: 5000,
|
||||
};
|
||||
}
|
||||
|
||||
renderEntity(entity: GeoEntity): CesiumEntityOptions {
|
||||
return {
|
||||
type: "point",
|
||||
color: "#ef4444",
|
||||
size: 6,
|
||||
outlineColor: "#ffffff",
|
||||
outlineWidth: 1,
|
||||
};
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 1.2 Required vs Optional Methods
|
||||
|
||||
**Required:**
|
||||
|
||||
| Method | Purpose |
|
||||
|---|---|
|
||||
| `initialize(ctx)` | Receive `PluginContext` (env, edition, callbacks) |
|
||||
| `destroy()` | Cleanup on shutdown |
|
||||
| `fetch(timeRange)` | Return entities (REST path). Return `[]` for WS-only |
|
||||
| `getPollingInterval()` | Polling frequency in ms. Return `0` for WS-only |
|
||||
| `getLayerConfig()` | Layer appearance (color, clustering, max entities) |
|
||||
| `renderEntity(entity)` | Per-entity Cesium rendering options |
|
||||
|
||||
**Optional:**
|
||||
|
||||
| Method | Purpose |
|
||||
|---|---|
|
||||
| `getServerConfig()` | REST/WS endpoint config (`apiBasePath`, `streamUrl`) |
|
||||
| `getSelectionBehavior(entity)` | Trail/fly-to on entity click |
|
||||
| `getFilterDefinitions()` | User-facing filter controls |
|
||||
| `getLegend()` | Legend entries for layer panel |
|
||||
| `getSidebarComponent()` | Custom sidebar React component |
|
||||
| `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[]` |
|
||||
| `requiresConfiguration(settings)` | Return `true` if plugin needs setup first |
|
||||
|
||||
### 1.3 Package Metadata
|
||||
|
||||
The `package.json` **must** include a `worldwideview` block:
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "@worldwideview/wwv-plugin-wildfires",
|
||||
"version": "1.0.0",
|
||||
"main": "src/index.ts",
|
||||
"worldwideview": {
|
||||
"id": "wildfires",
|
||||
"type": "data-layer",
|
||||
"format": "bundle",
|
||||
"category": "natural-disaster",
|
||||
"icon": "Flame",
|
||||
"capabilities": ["data:own", "globe:overlay"]
|
||||
},
|
||||
"dependencies": {
|
||||
"@worldwideview/wwv-plugin-sdk": "workspace:*"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Valid categories** (lowercase only): `aviation` · `maritime` · `military` · `conflict` · `natural-disaster` · `infrastructure` · `space` · `cyber` · `economic` · `intelligence` · `custom`
|
||||
|
||||
**Valid capabilities**: `data:own` · `data:read:{plugin}` · `ui:detail-panel` · `ui:sidebar` · `ui:toolbar` · `ui:settings` · `globe:overlay` · `globe:camera` · `storage:read` · `storage:write` · `network:fetch`
|
||||
|
||||
### 1.4 Rendering Rules
|
||||
|
||||
| Entity Type | Properties | Notes |
|
||||
|---|---|---|
|
||||
| `"point"` | `color`, `size`, `outlineColor`, `outlineWidth` | Simple colored dots |
|
||||
| `"billboard"` | `iconUrl`, `color`, `iconScale` | SVG/PNG icons |
|
||||
| `"model"` | `modelUrl`, `modelScale`, `modelMinPixelSize` | 3D glTF models |
|
||||
| `"label"` | `labelText`, `labelFont`, `color` | Text labels |
|
||||
|
||||
> **CRITICAL:** NEVER mix point and billboard properties. Using `size`/`outlineWidth` on a billboard entity causes GPU clipping artifacts. This is a hard rendering constraint.
|
||||
|
||||
Use `createSvgIconUrl()` from the SDK for billboard icons:
|
||||
|
||||
```typescript
|
||||
import { createSvgIconUrl } from "@worldwideview/wwv-plugin-sdk";
|
||||
import { Plane } from "lucide-react";
|
||||
const iconUrl = createSvgIconUrl(Plane, { color: "#3b82f6" });
|
||||
```
|
||||
|
||||
### 1.5 Registration (3 Paths)
|
||||
|
||||
**A. Built-in (monorepo package):**
|
||||
|
||||
```typescript
|
||||
import { pluginRegistry } from "@/core/plugins/PluginRegistry";
|
||||
import { pluginManager } from "@/core/plugins/PluginManager";
|
||||
import WildfiresPlugin from "@worldwideview/wwv-plugin-wildfires";
|
||||
|
||||
const plugin = new WildfiresPlugin();
|
||||
pluginRegistry.register(plugin);
|
||||
await pluginManager.registerPlugin(plugin);
|
||||
```
|
||||
|
||||
`AppShell.tsx` iterates `pluginRegistry.getAll()` at startup.
|
||||
|
||||
**B. Marketplace (database-installed):**
|
||||
`InstalledPluginsLoader` reads from the `installed_plugins` PostgreSQL table and calls `pluginManager.loadFromManifest()`. No code changes needed.
|
||||
|
||||
**C. Dynamic import (runtime):**
|
||||
For user-imported GeoJSON layers, call `pluginManager.loadFromManifest(manifest)` directly.
|
||||
|
||||
### 1.6 Build Configuration (Core Monorepo Packages Only)
|
||||
|
||||
If you decide to manually move a plugin from the local sandbox into the core `packages/` directory, you must manually add it to the build pipeline:
|
||||
|
||||
Add to `next.config.ts`:
|
||||
|
||||
```typescript
|
||||
transpilePackages: [
|
||||
"@worldwideview/wwv-plugin-sdk",
|
||||
"@worldwideview/wwv-plugin-wildfires", // ADD
|
||||
],
|
||||
```
|
||||
|
||||
Add to `tsconfig.json`:
|
||||
|
||||
```json
|
||||
"paths": {
|
||||
"@worldwideview/wwv-plugin-wildfires": ["./packages/wwv-plugin-wildfires/src"]
|
||||
}
|
||||
```
|
||||
|
||||
Run `pnpm install` from project root after creating the package.
|
||||
|
||||
---
|
||||
|
||||
## Part 2: Data Engine Seeder
|
||||
|
||||
The data engine is a **content-agnostic Host Environment runner** (`wwv-data-engine`, deployed via Docker). It runs Fastify on port 5000 with Redis caching and WebSocket streaming. Seeders are volume-mounted from `local-seeders/` (dev) or dynamically downloaded and linked via pnpm workspaces from GitHub Releases (`wwv-seeders` and `wwv-seeders-private`) in production.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> If you are **migrating** an existing plugin from `packages/` to `local-plugins/`, use the `migrate-legacy-plugin` skill instead. It covers both frontend routing fixes AND backend seeder build fixes as two independent concerns.
|
||||
|
||||
### 2.1 Engine Architecture
|
||||
|
||||
```
|
||||
External API → Seeder (fetch + transform)
|
||||
→ setLiveSnapshot(pluginId, payload, ttlSeconds)
|
||||
→ broadcastPluginData() → Active WS subscribers (immediate)
|
||||
→ Redis SET data:{pluginId}:live (throttled to every 5 min)
|
||||
→ SQLite history (optional, via better-sqlite3)
|
||||
```
|
||||
|
||||
**Key components:**
|
||||
- `src/scheduler.ts` — Seeder registry and cron scheduling
|
||||
- `src/redis.ts` — Redis client, `setLiveSnapshot()` and `getLiveSnapshot()`
|
||||
- `src/websocket.ts` — WS handler, `broadcastPluginData()`
|
||||
- `src/seed-utils.ts` — `withRetry()`, `fetchWithTimeout()`, `haversineKm()`
|
||||
- `src/db.ts` — SQLite (better-sqlite3) for local history storage
|
||||
- `src/seeders/index.ts` — Auto-discovery, dynamically requires all seeder files
|
||||
|
||||
### 2.2 Two Seeder Patterns
|
||||
|
||||
**Cron Seeder** (periodic polling — most common):
|
||||
|
||||
```typescript
|
||||
import { db } from "../db";
|
||||
import { setLiveSnapshot } from "../redis";
|
||||
import { fetchWithTimeout, withRetry } from "../seed-utils";
|
||||
import { registerSeeder } from "../scheduler";
|
||||
|
||||
// Optional: SQLite history table insert
|
||||
const insertRow = db.prepare(
|
||||
"INSERT OR IGNORE INTO my_data (id, payload, source_ts, fetched_at) VALUES (@id, @payload, @source_ts, @fetched_at)"
|
||||
);
|
||||
|
||||
async function seedMyPlugin() {
|
||||
console.log("[MyPlugin] Polling external API...");
|
||||
|
||||
const res = await withRetry(() =>
|
||||
fetchWithTimeout("https://api.example.com/data")
|
||||
);
|
||||
const data = await res.json();
|
||||
|
||||
const items = data.features.map((f: any) => ({
|
||||
id: f.id,
|
||||
lat: f.geometry.coordinates[1],
|
||||
lon: f.geometry.coordinates[0],
|
||||
name: f.properties.name,
|
||||
// ... transform to your schema
|
||||
}));
|
||||
|
||||
// Optional: save to SQLite
|
||||
for (const item of items) {
|
||||
insertRow.run({
|
||||
id: item.id,
|
||||
payload: JSON.stringify(item),
|
||||
source_ts: Date.now(),
|
||||
fetched_at: Date.now(),
|
||||
});
|
||||
}
|
||||
|
||||
// REQUIRED: Push to Redis + broadcast to WS subscribers
|
||||
await setLiveSnapshot("my-plugin", {
|
||||
source: "my-plugin",
|
||||
fetchedAt: new Date().toISOString(),
|
||||
items,
|
||||
totalCount: items.length,
|
||||
}, 3600); // TTL in seconds
|
||||
}
|
||||
|
||||
registerSeeder({
|
||||
name: "my-plugin", // MUST match the plugin's id on the frontend
|
||||
cron: "*/15 * * * *", // Every 15 minutes
|
||||
fn: seedMyPlugin,
|
||||
});
|
||||
```
|
||||
|
||||
**Init Seeder** (persistent/high-frequency — e.g., ISS every 5s):
|
||||
|
||||
```typescript
|
||||
import { setLiveSnapshot } from "../redis";
|
||||
import { registerSeeder } from "../scheduler";
|
||||
|
||||
function startMySeeder() {
|
||||
console.log("[MyPlugin] Starting persistent seeder...");
|
||||
|
||||
async function poll() {
|
||||
const res = await fetch("https://api.example.com/live");
|
||||
const data = await res.json();
|
||||
await setLiveSnapshot("my-plugin", data, 60);
|
||||
}
|
||||
|
||||
poll(); // Initial fetch
|
||||
setInterval(poll, 5000); // Every 5 seconds
|
||||
}
|
||||
|
||||
registerSeeder({
|
||||
name: "my-plugin",
|
||||
init: startMySeeder, // No cron — uses init for persistent polling
|
||||
});
|
||||
```
|
||||
|
||||
### 2.3 SeederDefinition Interface
|
||||
|
||||
```typescript
|
||||
interface SeederDefinition {
|
||||
name: string; // Plugin ID — MUST match frontend plugin id
|
||||
cron?: string; // Cron expression (e.g., "0 * * * *" = hourly)
|
||||
fn?: () => Promise<void>; // Function called on each cron tick
|
||||
init?: () => void; // Initialization for persistent seeders (websockets, intervals)
|
||||
}
|
||||
```
|
||||
|
||||
### 2.4 Auto-Discovery & Dependencies
|
||||
|
||||
The V2 engine dynamically `import()`s every compiled `.mjs` file in the extracted seeder workspaces. **You do not need to manually import your seeder** — just create the file and call `registerSeeder()` at module scope.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **V2 Engine Dependencies:** Seeders run in the unified V2 host environment which provides common packages (`zod`, `ws`, `undici`, etc.). **You MUST NOT bundle these dependencies** in your seeder's `dist` folder. Leave them externalized in your build config.
|
||||
|
||||
### 2.5 SQLite History (Optional)
|
||||
|
||||
For data that benefits from historical queries (playback mode), add a table in `src/db.ts`:
|
||||
|
||||
```typescript
|
||||
db.exec(`
|
||||
CREATE TABLE IF NOT EXISTS my_data (
|
||||
id TEXT PRIMARY KEY,
|
||||
payload JSON NOT NULL,
|
||||
source_ts INTEGER NOT NULL,
|
||||
fetched_at INTEGER NOT NULL
|
||||
)
|
||||
`);
|
||||
```
|
||||
|
||||
### 2.6 Utility Functions
|
||||
|
||||
| Function | Purpose |
|
||||
|---|---|
|
||||
| `withRetry(fn, maxRetries, delayMs)` | Exponential backoff retry wrapper |
|
||||
| `fetchWithTimeout(url, options, timeoutMs)` | Fetch with abort signal (default 15s) |
|
||||
| `haversineKm(lat1, lon1, lat2, lon2)` | Distance between coordinates in km |
|
||||
| `sleep(ms)` | Promise-based delay |
|
||||
| `CHROME_UA` | Chrome User-Agent string for scraping |
|
||||
|
||||
---
|
||||
|
||||
## Part 3: Data Pipeline (Frontend ↔ Engine)
|
||||
|
||||
### 3.1 WebSocket Protocol
|
||||
|
||||
**Client → Engine:**
|
||||
```json
|
||||
{ "action": "subscribe", "pluginId": "earthquakes" }
|
||||
{ "action": "unsubscribe", "pluginId": "earthquakes" }
|
||||
```
|
||||
|
||||
**Engine → Client:**
|
||||
```json
|
||||
{ "type": "welcome", "engine": "wwv-data-engine-v2", "plugins": ["earthquakes", "wildfires", ...] }
|
||||
{ "type": "data", "pluginId": "earthquakes", "payload": { "items": [...], "totalCount": 42 } }
|
||||
```
|
||||
|
||||
On subscribe, the engine immediately pushes the latest cached Redis snapshot — no waiting for the next cron tick.
|
||||
|
||||
### 3.2 Split-Routing (resolveEngineUrl)
|
||||
|
||||
`resolveEngineUrl(pluginId)` determines which engine serves each plugin:
|
||||
|
||||
1. **Local engine** (`localhost:5000`) if running and its `/manifest` includes this plugin ← **HIGHEST PRIORITY**
|
||||
2. Plugin's `getServerConfig().streamUrl` (code override)
|
||||
3. Plugin's `PluginManifest.dataSource.streamUrl` (manifest override)
|
||||
4. `NEXT_PUBLIC_WWV_PLUGIN_DATA_ENGINE_URL` env var
|
||||
5. Fallback: `wss://dataenginev2.worldwideview.dev/stream` (cloud)
|
||||
|
||||
### 3.3 Full Data Flow
|
||||
|
||||
```
|
||||
Engine seeder calls setLiveSnapshot(pluginId, payload, ttl)
|
||||
→ broadcastPluginData() fans out to subscribed WS connections
|
||||
→ WsClient receives { type: "data", pluginId, payload }
|
||||
→ WsClient calls plugin.mapWebsocketPayload() if defined
|
||||
→ DataBus.emit("dataUpdated", { pluginId, entities })
|
||||
→ DataBusSubscriber → Zustand store.entitiesByPlugin
|
||||
→ GlobeView (memoized visible entities)
|
||||
→ EntityRenderer (billboard/point/label primitives)
|
||||
```
|
||||
|
||||
### 3.4 Host Globals (CDN Plugins)
|
||||
|
||||
CDN-loaded plugins share the host app's dependencies via `globalThis.__WWV_HOST__`:
|
||||
- `react`, `react-dom`, `react/jsx-runtime`
|
||||
- `cesium`, `resium`
|
||||
- `zustand`
|
||||
- `@worldwideview/wwv-plugin-sdk`
|
||||
|
||||
Use `wwvPluginGlobals()` in your Vite config to externalize automatically:
|
||||
|
||||
```typescript
|
||||
import { defineConfig } from "vite";
|
||||
import { wwvPluginGlobals } from "@worldwideview/wwv-plugin-sdk";
|
||||
|
||||
export default defineConfig({
|
||||
plugins: [wwvPluginGlobals()],
|
||||
build: {
|
||||
lib: { entry: "./src/index.ts", formats: ["es"], fileName: "frontend" },
|
||||
rollupOptions: { output: { entryFileNames: "frontend.mjs" } },
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Part 4: Static GeoJSON Plugins
|
||||
|
||||
For plugins with static data (no live API), use `wwvStaticCompiler`:
|
||||
|
||||
```typescript
|
||||
import { defineConfig } from "vite";
|
||||
import { wwvPluginGlobals, wwvStaticCompiler } from "@worldwideview/wwv-plugin-sdk";
|
||||
|
||||
export default defineConfig({
|
||||
plugins: [wwvStaticCompiler(), wwvPluginGlobals()],
|
||||
build: {
|
||||
lib: { entry: "./src/index.ts", formats: ["es"], fileName: "frontend" },
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
Place GeoJSON in `data/data.json`. The compiler auto-generates a `WorldPlugin` class from `package.json` metadata at build time. No `src/index.ts` needed.
|
||||
|
||||
---
|
||||
|
||||
## Part 5: Example - Simple ISS Tracker Plugin
|
||||
|
||||
Here is a minimal, complete example of a live ISS Tracker plugin utilizing both the frontend SDK and the V2 Engine.
|
||||
|
||||
### 1. Frontend Plugin (`local-plugins/wwv-plugin-iss/src/index.ts`)
|
||||
|
||||
```typescript
|
||||
import type {
|
||||
WorldPlugin, PluginContext, GeoEntity,
|
||||
CesiumEntityOptions, TimeRange, LayerConfig, PluginCategory
|
||||
} from "@worldwideview/wwv-plugin-sdk";
|
||||
import { Satellite } from "lucide-react";
|
||||
import pkg from "../package.json";
|
||||
|
||||
export default class IssPlugin implements WorldPlugin {
|
||||
id = "iss";
|
||||
name = "ISS Tracker";
|
||||
description = "Real-time International Space Station tracking";
|
||||
icon = Satellite;
|
||||
category: PluginCategory = "space";
|
||||
version = pkg.version;
|
||||
|
||||
async initialize(ctx: PluginContext): Promise<void> {}
|
||||
|
||||
destroy(): void {}
|
||||
|
||||
async fetch(timeRange: TimeRange): Promise<GeoEntity[]> {
|
||||
return []; // WS-only plugin
|
||||
}
|
||||
|
||||
getPollingInterval(): number {
|
||||
return 0; // WS-only
|
||||
}
|
||||
|
||||
getLayerConfig(): LayerConfig {
|
||||
return {
|
||||
color: "#ffffff",
|
||||
clusterEnabled: false,
|
||||
maxEntities: 1,
|
||||
};
|
||||
}
|
||||
|
||||
renderEntity(entity: GeoEntity): CesiumEntityOptions {
|
||||
return {
|
||||
type: "point",
|
||||
color: "#ffffff",
|
||||
size: 10,
|
||||
outlineColor: "#3b82f6",
|
||||
outlineWidth: 2,
|
||||
};
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Backend Init Seeder (`wwv-seeders/src/seeders/iss.ts`)
|
||||
|
||||
```typescript
|
||||
import { setLiveSnapshot } from "../redis";
|
||||
import { registerSeeder } from "../scheduler";
|
||||
|
||||
function startIssSeeder() {
|
||||
console.log("[ISS] Starting live tracker...");
|
||||
|
||||
async function poll() {
|
||||
try {
|
||||
const res = await fetch("https://api.wheretheiss.at/v1/satellites/25544");
|
||||
const data = await res.json();
|
||||
|
||||
const item = {
|
||||
id: "iss",
|
||||
lat: data.latitude,
|
||||
lon: data.longitude,
|
||||
alt: data.altitude * 1000, // Convert km to meters
|
||||
name: "International Space Station",
|
||||
speed: data.velocity,
|
||||
};
|
||||
|
||||
await setLiveSnapshot("iss", {
|
||||
source: "iss",
|
||||
fetchedAt: new Date().toISOString(),
|
||||
items: [item],
|
||||
totalCount: 1,
|
||||
}, 10);
|
||||
} catch (err) {
|
||||
console.error("[ISS] Fetch failed", err);
|
||||
}
|
||||
}
|
||||
|
||||
poll(); // Initial fetch
|
||||
setInterval(poll, 5000); // Poll every 5 seconds
|
||||
}
|
||||
|
||||
registerSeeder({
|
||||
name: "iss",
|
||||
init: startIssSeeder,
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Mistakes
|
||||
|
||||
### "Sandbox Plugin Breaking Next.js Build"
|
||||
1. **Premature Configuration** — Modifying `next.config.ts` (`transpilePackages`) or `tsconfig.json` (`paths`) while a plugin is still in `local-plugins/`. The `local-plugins` sandbox relies on dynamic hot-loading in the browser via `pnpm dev:plugins`. Do **not** touch monorepo configs for local plugins.
|
||||
2. **Manual Registration** — Manually adding a sandbox plugin to `AppShell.tsx`. Let the local hot-loading manifest handle sandbox plugins dynamically.
|
||||
|
||||
### "Missing Boilerplate / Errors in package.json"
|
||||
1. **Bypassing the CLI** — Creating a plugin manually instead of using `node packages/wwv-cli/dist/index.js create <name> --local`. Always use the CLI to ensure the correct metadata, type definitions, and test scaffolding are generated.
|
||||
|
||||
### "No data on the globe"
|
||||
1. **Seeder name ≠ plugin id** — The `name` in `registerSeeder()` MUST match the `id` property of the frontend `WorldPlugin` class
|
||||
2. **Engine `/manifest` missing plugin** — Check `GET localhost:5000/manifest` → `plugins` array
|
||||
3. **WsClient not subscribing** — Add `console.log` in `resolveEngineUrl()` to verify URL resolution
|
||||
4. **Plugin hardcodes engine URL** — Legacy plugins use `this.context?.apiBaseUrl` instead of `resolveEngineUrl()`. See `migrate-legacy-plugin` skill
|
||||
4. **`mapWebsocketPayload` missing** — If the engine sends a non-standard payload shape, the plugin must implement `mapWebsocketPayload()` or data silently drops
|
||||
|
||||
### "Build crash / Module not found"
|
||||
1. Missing `transpilePackages` entry in `next.config.ts` → **immediate runtime crash**
|
||||
2. Missing `tsconfig.json` path alias → TypeScript compilation error
|
||||
3. Forgot `pnpm install` after creating package → dependency resolution failure
|
||||
|
||||
### "Invalid Hook Call" (CDN plugins)
|
||||
Plugin bundles its own React instead of using host globals. Fix: add `wwvPluginGlobals()` to Vite config.
|
||||
|
||||
### "Manifest validation failed"
|
||||
Required fields: `id`, `name`, `version`, `entry`, `trust`. Entry URL must be from allowed domains (CDN, localhost, `worldwideview.dev`, or relative path). `capabilities` must be non-empty array.
|
||||
|
||||
### "GPU clipping / entity disappearing"
|
||||
Using `size`/`outlineWidth`/`outlineColor` on a `"billboard"` entity. These properties are **point-only**. Billboard uses `iconUrl`/`iconScale`/`color`.
|
||||
|
||||
### "Redis snapshot not updating"
|
||||
`setLiveSnapshot()` throttles Redis writes to every 5 minutes to avoid exceeding Upstash request limits. WebSocket broadcasts are **not** throttled. Check WS delivery first.
|
||||
|
||||
### "Category type error"
|
||||
Categories are **lowercase**: `"aviation"` not `"Aviation"`, `"natural-disaster"` not `"NaturalDisaster"`. Must match the `PluginCategory` union in the SDK.
|
||||
|
||||
---
|
||||
|
||||
## End-to-End Checklist
|
||||
|
||||
- [ ] **Development:** Scaffolded via `node packages/wwv-cli/dist/index.js create` and developed in `local-plugins/`
|
||||
- [ ] **Publishing:** Published to NPM via `node packages/wwv-cli/dist/index.js publish <name> [--org <your-org>]` (if making public)
|
||||
- [ ] **Frontend:** Plugin class implements `WorldPlugin` with correct `id`
|
||||
- [ ] **Frontend:** `package.json` has `worldwideview` block with matching `id`
|
||||
- [ ] **Frontend:** Version imported from `package.json` (never hardcoded)
|
||||
- [ ] **Frontend:** Added to `transpilePackages` in `next.config.ts`
|
||||
- [ ] **Frontend:** Added path alias in `tsconfig.json`
|
||||
- [ ] **Frontend:** Registered via `pluginRegistry` + `pluginManager` in `AppShell.tsx`
|
||||
- [ ] **Frontend:** `renderEntity()` doesn't mix point/billboard properties
|
||||
- [ ] **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:** 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
|
||||
- [ ] **Verification:** WebSocket subscribe returns data snapshot
|
||||
- [ ] **Workspace:** Ran `pnpm install` from project root
|
||||
- [ ] **Workspace:** Version bump follows `/commit` workflow
|
||||
@@ -0,0 +1,8 @@
|
||||
[[pre-start]]
|
||||
install_deps = "pnpm install"
|
||||
|
||||
[[pre-start]]
|
||||
copy_env = """powershell -Command "if (Test-Path '../worldwideview/.env') { Copy-Item '../worldwideview/.env' '.env' -Force }""""
|
||||
|
||||
[[pre-remove]]
|
||||
docker_clean = "docker compose down -v"
|
||||
@@ -23,3 +23,5 @@ artifacts/
|
||||
performance/
|
||||
tmp/
|
||||
*.geojson
|
||||
**/.pnpm-store
|
||||
local-seeders*
|
||||
@@ -1,15 +0,0 @@
|
||||
DATABASE_URL=file:./data/wwv.db
|
||||
|
||||
# Default plugins enabled on boot for demo edition
|
||||
# Comma-separated list of plugin IDs
|
||||
NEXT_PUBLIC_DEMO_DEFAULT_PLUGINS=iranwarlive,satellite,gps-jamming
|
||||
|
||||
# Edition: "local" | "cloud" | "demo"
|
||||
NEXT_PUBLIC_WWV_EDITION=local
|
||||
|
||||
# Auth Secret (REQUIRED for Docker — generate with: openssl rand -hex 32)
|
||||
# Must be stable across container restarts to preserve sessions.
|
||||
# [WARNING] NEVER commit real secrets here. Real secrets must ONLY go into .env.local!
|
||||
AUTH_SECRET=changeme_d64c1f35b447da89cf6ed5a0988da1379b21904edb91a87c3f5a63942e3d23a4_changeme
|
||||
|
||||
|
||||
+7
-2
@@ -4,8 +4,8 @@
|
||||
# This file is tracked by git. Only put non-secret values here.
|
||||
# Prisma reads DATABASE_URL from this file.
|
||||
|
||||
# Database (SQLite for local — zero config; PostgreSQL for cloud)
|
||||
DATABASE_URL=file:./data/wwv.db
|
||||
# Database (PostgreSQL)
|
||||
DATABASE_URL=postgresql://postgres:postgres@localhost:5432/worldwideview
|
||||
|
||||
# ============================================================
|
||||
# .env.local — NOT committed (secrets & API keys)
|
||||
@@ -55,6 +55,11 @@ NEXT_PUBLIC_DEMO_DEFAULT_PLUGINS=
|
||||
# Edition: "local" | "cloud" | "demo"
|
||||
NEXT_PUBLIC_WWV_EDITION=local
|
||||
|
||||
# Optional Database Teardown
|
||||
# If set to true, terminating 'pnpm run dev' (Ctrl+C) will automatically
|
||||
# stop the local database container (freeing up port 5432).
|
||||
WWV_TEARDOWN_DB_ON_EXIT=false
|
||||
|
||||
# Demo Admin Secret (demo edition only)
|
||||
# Allows operator plugin management on the demo instance via x-wwv-admin-secret header.
|
||||
# Generate any random string. Only set this on the demo deployment.
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
version: 2
|
||||
updates:
|
||||
# 1. Maintain Node.js / pnpm dependencies
|
||||
- package-ecosystem: "npm"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
day: "monday"
|
||||
# Group all minor/patch updates into a single PR so it doesn't spam you
|
||||
groups:
|
||||
dependencies:
|
||||
patterns:
|
||||
- "*"
|
||||
update-types:
|
||||
- "minor"
|
||||
- "patch"
|
||||
|
||||
# 2. Maintain Docker base images
|
||||
- package-ecosystem: "docker"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
day: "monday"
|
||||
|
||||
# 3. Maintain GitHub Actions workflows
|
||||
- package-ecosystem: "github-actions"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "monthly" # Actions update less frequently, monthly is fine
|
||||
+42
-16
@@ -1,19 +1,36 @@
|
||||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
pull_request:
|
||||
branches: [main]
|
||||
|
||||
jobs:
|
||||
# Non-blocking dependency audit. Surfaces high / critical vulnerabilities
|
||||
# in the CI output without failing the build. Flip `continue-on-error` to
|
||||
# `false` once the current transitive vulns (see #97) are resolved.
|
||||
audit:
|
||||
name: Dependency Audit
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- uses: pnpm/action-setup@v6
|
||||
- uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 22
|
||||
cache: pnpm
|
||||
- run: pnpm install --frozen-lockfile
|
||||
- run: pnpm audit --audit-level high
|
||||
|
||||
typecheck:
|
||||
name: Type Check
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: pnpm/action-setup@v4
|
||||
with:
|
||||
version: 9
|
||||
- uses: actions/setup-node@v4
|
||||
- uses: actions/checkout@v6
|
||||
- uses: pnpm/action-setup@v6
|
||||
- uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 22
|
||||
cache: pnpm
|
||||
@@ -21,15 +38,26 @@ jobs:
|
||||
- run: npx prisma generate
|
||||
- run: pnpm exec tsc --noEmit
|
||||
|
||||
lint:
|
||||
name: Lint
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- uses: pnpm/action-setup@v6
|
||||
- uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 22
|
||||
cache: pnpm
|
||||
- run: pnpm install --frozen-lockfile
|
||||
- run: pnpm lint
|
||||
|
||||
test:
|
||||
name: Unit Tests
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: pnpm/action-setup@v4
|
||||
with:
|
||||
version: 9
|
||||
- uses: actions/setup-node@v4
|
||||
- uses: actions/checkout@v6
|
||||
- uses: pnpm/action-setup@v6
|
||||
- uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 22
|
||||
cache: pnpm
|
||||
@@ -42,15 +70,13 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
needs: [typecheck, test]
|
||||
env:
|
||||
DATABASE_URL: file:./data/wwv.db
|
||||
DATABASE_URL: postgresql://ci:ci@localhost:5432/ci
|
||||
AUTH_SECRET: ci-placeholder-secret-not-used-in-tests
|
||||
NEXT_PUBLIC_WWV_EDITION: local
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: pnpm/action-setup@v4
|
||||
with:
|
||||
version: 9
|
||||
- uses: actions/setup-node@v4
|
||||
- uses: actions/checkout@v6
|
||||
- uses: pnpm/action-setup@v6
|
||||
- uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 22
|
||||
cache: pnpm
|
||||
|
||||
@@ -27,7 +27,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
fetch-depth: 1
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@ jobs:
|
||||
actions: read # Required for Claude to read CI results on PRs
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
fetch-depth: 1
|
||||
|
||||
|
||||
@@ -1,23 +1,22 @@
|
||||
name: Docker Build and Publish
|
||||
name: Docker Image CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ "main", "feat/docker-ci" ]
|
||||
branches: [ "main" ]
|
||||
pull_request:
|
||||
branches: [ "main" ]
|
||||
workflow_dispatch:
|
||||
|
||||
env:
|
||||
REGISTRY: ghcr.io
|
||||
IMAGE_NAME: ${{ github.repository }}
|
||||
|
||||
jobs:
|
||||
build-and-push:
|
||||
build-and-push-image:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
@@ -40,16 +39,24 @@ jobs:
|
||||
tags: |
|
||||
type=raw,value=latest,enable={{is_default_branch}}
|
||||
type=ref,event=branch
|
||||
type=ref,event=pr
|
||||
type=semver,pattern={{version}}
|
||||
type=sha
|
||||
type=sha,format=short
|
||||
|
||||
- name: Build and push Docker image
|
||||
uses: docker/build-push-action@v5
|
||||
with:
|
||||
context: .
|
||||
push: true
|
||||
push: ${{ github.event_name != 'pull_request' }}
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
cache-from: type=gha
|
||||
cache-to: type=gha,mode=max
|
||||
build-args: |
|
||||
NEXT_PUBLIC_CESIUM_ION_TOKEN=${{ secrets.NEXT_PUBLIC_CESIUM_ION_TOKEN }}
|
||||
NEXT_PUBLIC_GOOGLE_MAPS_API_KEY=${{ secrets.NEXT_PUBLIC_GOOGLE_MAPS_API_KEY }}
|
||||
NEXT_PUBLIC_BING_MAPS_KEY=${{ secrets.NEXT_PUBLIC_BING_MAPS_KEY }}
|
||||
NEXT_PUBLIC_WWV_EDITION=${{ vars.NEXT_PUBLIC_WWV_EDITION || 'local' }}
|
||||
NEXT_PUBLIC_WS_ENGINE_URL=${{ vars.NEXT_PUBLIC_WS_ENGINE_URL }}
|
||||
NEXT_PUBLIC_WWV_PLUGIN_DATA_ENGINE_URL=${{ vars.NEXT_PUBLIC_WWV_PLUGIN_DATA_ENGINE_URL }}
|
||||
NEXT_PUBLIC_ADSENSE_CLIENT_ID=${{ secrets.NEXT_PUBLIC_ADSENSE_CLIENT_ID }}
|
||||
NEXT_PUBLIC_SUPABASE_URL=${{ vars.NEXT_PUBLIC_SUPABASE_URL }}
|
||||
NEXT_PUBLIC_SUPABASE_ANON_KEY=${{ secrets.NEXT_PUBLIC_SUPABASE_ANON_KEY }}
|
||||
@@ -0,0 +1,53 @@
|
||||
name: Mutation Testing
|
||||
|
||||
# Mutation testing is expensive (10–30 min per full run, even with
|
||||
# `coverageAnalysis: "perTest"`), so we don't gate every PR on it.
|
||||
# Instead it runs weekly so we catch drift in test quality, and on
|
||||
# demand via workflow_dispatch when someone wants to validate a
|
||||
# specific change.
|
||||
on:
|
||||
schedule:
|
||||
# 03:00 UTC Monday = 10 PM US Eastern Sunday night.
|
||||
- cron: '0 3 * * 1'
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
stryker:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 60
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0 # Required for Stryker's incremental mode.
|
||||
|
||||
- name: Setup pnpm
|
||||
uses: pnpm/action-setup@v3
|
||||
with:
|
||||
version: 9
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 22
|
||||
cache: pnpm
|
||||
|
||||
- name: Install dependencies
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Generate Prisma client
|
||||
run: pnpm exec prisma generate
|
||||
|
||||
- name: Run Stryker
|
||||
run: pnpm exec stryker run
|
||||
|
||||
- name: Upload mutation report
|
||||
if: always()
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: stryker-report
|
||||
path: reports/mutation/
|
||||
retention-days: 30
|
||||
@@ -0,0 +1,51 @@
|
||||
name: Playwright Tests
|
||||
on:
|
||||
push:
|
||||
branches: [ main, master ]
|
||||
pull_request:
|
||||
branches: [ main, master ]
|
||||
permissions:
|
||||
contents: read
|
||||
jobs:
|
||||
test:
|
||||
timeout-minutes: 60
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
browser: [chromium, firefox, webkit]
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: pnpm/action-setup@v3
|
||||
with:
|
||||
version: 9.15.4
|
||||
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 20
|
||||
cache: 'pnpm'
|
||||
|
||||
- name: Install dependencies
|
||||
run: pnpm install
|
||||
|
||||
- name: Install Playwright Browsers
|
||||
run: pnpm exec playwright install --with-deps
|
||||
|
||||
- name: Run Project Setup
|
||||
run: pnpm run setup
|
||||
|
||||
- name: Boot Database
|
||||
run: |
|
||||
docker network create coolify || true
|
||||
pnpm run predev
|
||||
|
||||
- name: Run Playwright tests
|
||||
run: pnpm test:e2e --project=${{ matrix.browser }}
|
||||
|
||||
- uses: actions/upload-artifact@v4
|
||||
if: ${{ !cancelled() }}
|
||||
with:
|
||||
name: playwright-report-${{ matrix.browser }}
|
||||
path: playwright-report/
|
||||
retention-days: 30
|
||||
@@ -12,9 +12,9 @@ jobs:
|
||||
contents: read
|
||||
id-token: write # Required for OIDC trusted publishing (no NPM_TOKEN needed)
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/checkout@v6
|
||||
|
||||
- uses: actions/setup-node@v4
|
||||
- uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 20
|
||||
registry-url: "https://registry.npmjs.org"
|
||||
|
||||
@@ -0,0 +1,60 @@
|
||||
name: Test Local Dev Environment
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
pull_request:
|
||||
branches: [main]
|
||||
|
||||
jobs:
|
||||
test-dev:
|
||||
name: Test Local Dev Startup
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
NEXT_PUBLIC_WWV_EDITION: local
|
||||
AUTH_SECRET: ci-placeholder-secret-not-used-in-tests
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
|
||||
- uses: pnpm/action-setup@v6
|
||||
|
||||
- uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 22
|
||||
cache: pnpm
|
||||
|
||||
- name: Create coolify docker network
|
||||
# Needed because docker-compose.yml references external coolify network
|
||||
run: docker network create coolify || true
|
||||
|
||||
- name: Install dependencies
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Setup environment
|
||||
run: cp .env.example .env
|
||||
|
||||
- name: Test predev setup
|
||||
# Tests that Docker DB boots, port mappings work, Prisma pushes schema, and plugins sync
|
||||
run: pnpm run predev
|
||||
|
||||
- name: Test dev server startup
|
||||
run: |
|
||||
# Start the dev server in the background
|
||||
pnpm run dev &
|
||||
DEV_PID=$!
|
||||
|
||||
echo "Waiting for Next.js to respond on port 3000..."
|
||||
|
||||
# Wait up to 120 seconds for the dev server to return a response
|
||||
timeout 120 bash -c 'until curl -s http://localhost:3000 > /dev/null; do sleep 5; done'
|
||||
|
||||
# Check if the process is still running
|
||||
if ! kill -0 $DEV_PID 2>/dev/null; then
|
||||
echo "Dev server crashed or failed to start within timeout!"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Dev server started successfully!"
|
||||
|
||||
# Graceful shutdown
|
||||
kill $DEV_PID
|
||||
@@ -0,0 +1,121 @@
|
||||
name: Test Setup Scripts
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ "main" ]
|
||||
pull_request:
|
||||
branches: [ "main" ]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
test-bash:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: '3.x'
|
||||
|
||||
- name: Start local HTTP server
|
||||
run: |
|
||||
python3 -m http.server 8080 &
|
||||
sleep 2 # Wait for server to start
|
||||
|
||||
- name: Patch setup.sh to use local server
|
||||
run: |
|
||||
sed -i 's|https://raw.githubusercontent.com/silvertakana/worldwideview/main|http://localhost:8080|g' self-host/setup.sh
|
||||
|
||||
- name: Run setup.sh
|
||||
run: |
|
||||
cd self-host
|
||||
bash setup.sh
|
||||
|
||||
- name: Verify .env generation
|
||||
run: |
|
||||
cd self-host
|
||||
if [ ! -f .env ]; then
|
||||
echo ".env file was not created"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if ! grep -q "^AUTH_SECRET=[a-f0-9]\{64\}$" .env; then
|
||||
echo "AUTH_SECRET was not generated correctly or is missing"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Verify docker-compose.yml download
|
||||
run: |
|
||||
cd self-host
|
||||
if [ ! -f docker-compose.yml ]; then
|
||||
echo "docker-compose.yml was not downloaded"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Verify Docker containers are running
|
||||
run: |
|
||||
cd self-host
|
||||
docker compose ps
|
||||
if ! docker compose ps | grep -q "Up"; then
|
||||
echo "Docker containers failed to start"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
test-powershell:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: '3.x'
|
||||
|
||||
- name: Start local HTTP server
|
||||
run: |
|
||||
python3 -m http.server 8080 &
|
||||
sleep 2 # Wait for server to start
|
||||
|
||||
- name: Patch setup.ps1 to use local server
|
||||
run: |
|
||||
sed -i 's|https://raw.githubusercontent.com/silvertakana/worldwideview/main|http://localhost:8080|g' self-host/setup.ps1
|
||||
|
||||
- name: Run setup.ps1
|
||||
run: |
|
||||
cd self-host
|
||||
pwsh ./setup.ps1
|
||||
|
||||
- name: Verify .env generation
|
||||
run: |
|
||||
cd self-host
|
||||
if [ ! -f .env ]; then
|
||||
echo ".env file was not created"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if ! grep -q "^AUTH_SECRET=[a-f0-9]\{64\}$" .env; then
|
||||
echo "AUTH_SECRET was not generated correctly or is missing"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Verify docker-compose.yml download
|
||||
run: |
|
||||
cd self-host
|
||||
if [ ! -f docker-compose.yml ]; then
|
||||
echo "docker-compose.yml was not downloaded"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Verify Docker containers are running
|
||||
run: |
|
||||
cd self-host
|
||||
docker compose ps
|
||||
if ! docker compose ps | grep -q "Up"; then
|
||||
echo "Docker containers failed to start"
|
||||
exit 1
|
||||
fi
|
||||
+46
-3
@@ -18,7 +18,9 @@ node_modules/
|
||||
/out/
|
||||
|
||||
# agents
|
||||
/.agents/
|
||||
/.agents/plans
|
||||
/.agents/context
|
||||
/.agents/research/
|
||||
|
||||
# claude code IDE config
|
||||
/.claude/
|
||||
@@ -63,7 +65,6 @@ yarn-error.log*
|
||||
|
||||
# env files (can opt-in for committing if needed)
|
||||
.env*
|
||||
!.env
|
||||
|
||||
# vercel
|
||||
.vercel
|
||||
@@ -82,6 +83,11 @@ packages/*/dist/
|
||||
/local-scripts/
|
||||
/public/plugins-local/
|
||||
|
||||
# Local plugin development (gitignored workspace)
|
||||
local-plugins/*
|
||||
!local-plugins/.gitkeep
|
||||
!local-plugins/README.md
|
||||
|
||||
# git worktrees
|
||||
/.worktrees/
|
||||
|
||||
@@ -89,4 +95,41 @@ packages/*/dist/
|
||||
packages/wwv-data-engine/
|
||||
|
||||
# IDE workspace files
|
||||
*.code-workspace
|
||||
*.code-workspace
|
||||
|
||||
# Build outputs and generated assets
|
||||
/public/cesium/
|
||||
build_output*.log
|
||||
build_output*.txt
|
||||
/build*.log
|
||||
|
||||
# Root-level scratch scripts and agent artifacts
|
||||
tmp_*.js
|
||||
dump-*.js
|
||||
dump_*.py
|
||||
test*.js
|
||||
test*.mjs
|
||||
delete-dups.js
|
||||
commit.json
|
||||
skills-lock.json
|
||||
|
||||
# Seeder repositories
|
||||
/local-seeders/
|
||||
/.local-seeders-dist/
|
||||
|
||||
# WorldwideView Ecosystem Repositories (Development Structure)
|
||||
# The following ignores represent the different repositories related to the entire setup found in C:\dev
|
||||
/worldwideview-marketplace/
|
||||
/worldwideview-plugins/
|
||||
/worldwideview-web/
|
||||
/wwv-data-engine/
|
||||
/wwv-data-engine-public/
|
||||
/wwv-seeders/
|
||||
/wwv-seeders-private/
|
||||
/wwv-test/
|
||||
worldwideview.code-workspace
|
||||
|
||||
# Playwright
|
||||
/playwright-report/
|
||||
/test-results/
|
||||
/playwright/.auth/
|
||||
@@ -19,7 +19,7 @@ Our primary design, feature-set, and operational layout goal is to mimic the str
|
||||
| State | Zustand (slice-based: globe, layers, timeline, UI, filters, data, config, favorites, geojson) |
|
||||
| Event Bus | Custom typed `DataBus` (pub/sub singleton) |
|
||||
| Styling | Vanilla CSS — **no Tailwind** |
|
||||
| Database | SQLite via Prisma (local), PostgreSQL (cloud) |
|
||||
| Database | PostgreSQL via Prisma 7 (local and cloud) |
|
||||
| Auth | NextAuth v5 beta (Credentials provider, JWT sessions) |
|
||||
| Package Manager | pnpm (monorepo with `pnpm-workspace.yaml`) |
|
||||
| Testing | Vitest + jsdom + React Testing Library |
|
||||
@@ -30,135 +30,24 @@ Our primary design, feature-set, and operational layout goal is to mimic the str
|
||||
|
||||
## 3. 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/ # DeclarativePlugin, StaticDataPlugin, mapJsonToEntities
|
||||
│ │ └── 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)
|
||||
├── 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/ # Includes standalone backend/ microservice
|
||||
│ └── 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/ # SQLite database (gitignored, Docker volume)
|
||||
├── Dockerfile # Multi-stage production build
|
||||
├── docker-compose.yml # Main app + microservice backends
|
||||
└── .agents/ # Agent documentation, rules, skills, workflows
|
||||
```
|
||||
> [!NOTE]
|
||||
> See `.agents/rules/directory-structure.md` for the full project directory map and related repositories.
|
||||
|
||||
---
|
||||
|
||||
## 4. Architecture Patterns
|
||||
|
||||
### 4.1 Plugin System (Core Abstraction)
|
||||
> [!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.
|
||||
|
||||
Every data source is a **plugin** implementing the `WorldPlugin` interface from `@worldwideview/wwv-plugin-sdk`. The lifecycle utilizes a real-time WebSocket Firehose pipeline:
|
||||
Key invariants agents MUST respect:
|
||||
|
||||
```text
|
||||
PluginRegistry.register() → PluginManager.registerPlugin()
|
||||
→ plugin.initialize(context)
|
||||
|
||||
Visibility Toggle → DataBusSubscriber subscribes to layer via WsClient
|
||||
→ Engine responds with instantaneous websocket snapshots over /stream
|
||||
→ WsClient pipes to DataBus.emit("dataUpdated", WsStreamPayload)
|
||||
→ Store → EntityRenderer → Globe
|
||||
```
|
||||
|
||||
Four plugin architectures exist (All-Bundle Model):
|
||||
1. **Data Engine Seeder** — Standalone Fastify container with SQLite microservice or unified seeders (e.g., `iranwarlive-backend`).
|
||||
2. **Dynamic CDN Loaded (Bundle)** — Externally developed plugins dynamically imported at runtime via ES module CDNs (e.g., `unpkg.com` version-pinned URLs).
|
||||
3. **Static Compiled (Bundle)** — Static GeoJSON data wrapped into JS bundles via `wwvStaticCompiler` during build/sync (previously `StaticDataPlugin`).
|
||||
4. **Active Proxied (Bundle)** — Next.js API routes bundled to provide frontend interactions (previously `DeclarativePlugin`).
|
||||
|
||||
All plugins are now dynamically imported at runtime as ES module bundles via `loadPluginFromManifest` utilizing `import(/* webpackIgnore: true */ entry)`. The legacy `StaticDataPlugin` and `DeclarativePlugin` runtimes are fully deprecated.
|
||||
|
||||
Plugin types are re-exported from SDK through `src/core/plugins/PluginTypes.ts` and `PluginManifest.ts` — **source of truth is always `@worldwideview/wwv-plugin-sdk`**.
|
||||
|
||||
### 4.2 State Management
|
||||
|
||||
Zustand store with **nine slices**: `globe`, `layers`, `timeline`, `ui`, `filter`, `data`, `config`, `favorites`, `geojson`. Each slice is in its own file under `src/core/state/`.
|
||||
|
||||
- Access via `useStore` hook or `useStore.getState()` outside React
|
||||
- Plugin settings stored in `configSlice.dataConfig.pluginSettings`
|
||||
- Polling intervals stored in `configSlice.dataConfig.pollingIntervals`
|
||||
|
||||
### 4.3 Data Pipeline
|
||||
|
||||
```text
|
||||
Engine push /stream → DataBusSubscriber WsClient router
|
||||
→ WsClient.handleMessage() → DataBus.emit("websocketData")
|
||||
→ DataBusSubscriber → _hydrateSnapshot() → Store.entitiesByPlugin
|
||||
→ GlobeView (memoized visible entities)
|
||||
→ EntityRenderer (billboard/point primitives)
|
||||
→ AnimationLoop (horizon culling, hover/selection)
|
||||
→ StackManager (co-located entity grouping)
|
||||
```
|
||||
|
||||
### 4.3.1 Split-Routing (Cloud Fallback)
|
||||
|
||||
When a local engine is detected at `localhost:5001`, the frontend fetches its `/manifest` to discover available seeders. Per-plugin routing via `resolveEngineUrl`:
|
||||
- Plugin's seeder is in local manifest → `ws://localhost:5001/stream`
|
||||
- Plugin's seeder is NOT in local manifest → `wss://dataengine.worldwideview.dev/stream`
|
||||
|
||||
This enables core contributors running the public (community) engine locally to see local data for their seeders while proprietary sources (aviation, maritime) continue streaming from the cloud.
|
||||
|
||||
The data engine uses a **public upstream / private fork** model:
|
||||
- `wwv-data-engine` (public) — community seeders, contributors fork and PR here
|
||||
- `wwv-data-engine-internal` (private) — all seeders, deploys to Coolify via `git merge upstream/main`
|
||||
|
||||
### 4.4 Rendering Pipeline
|
||||
|
||||
- **Primitive-based**: Uses `PointPrimitiveCollection`, `BillboardCollection`, `LabelCollection` — NOT Cesium Entity API
|
||||
- **Chunked processing**: Large datasets (10k+) rendered via `ChunkedProcessor`
|
||||
- **LOD system**: Model-type entities promoted to 3D models at close range (`useModelRendering`)
|
||||
- **Horizon culling**: Manual dot-product calculation against Earth radius (NOT depth testing)
|
||||
- **Stack/Spiderifier**: `StackManager` groups co-located entities; `stackAnimation` handles expansion
|
||||
|
||||
### 4.5 Edition System
|
||||
|
||||
Three editions controlled by `NEXT_PUBLIC_WWV_EDITION`:
|
||||
- **`local`** — Self-hosted, full features, auth enabled
|
||||
- **`cloud`** — Managed cloud instance, full features
|
||||
- **`demo`** — Public demo, auth disabled, optional admin via `WWV_DEMO_ADMIN_SECRET`
|
||||
|
||||
Feature flags derived from edition in `src/core/edition.ts`.
|
||||
- **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`.
|
||||
|
||||
---
|
||||
|
||||
@@ -166,13 +55,13 @@ Feature flags derived from edition in `src/core/edition.ts`.
|
||||
|
||||
### 5.1 File Size
|
||||
|
||||
**Max 150 lines per file.** If a file grows beyond this, modularize it. Extract helpers, split components, use hooks.
|
||||
**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`
|
||||
- Each plugin has its own alias in `tsconfig.json`
|
||||
- Plugin modules are dynamically imported and do not require individual `tsconfig.json` aliases
|
||||
|
||||
### 5.3 CSS Rules
|
||||
|
||||
@@ -195,16 +84,16 @@ Built-in plugins are instantiated in `AppShell.tsx` and registered via `PluginRe
|
||||
|
||||
### 5.6 Workspace Rules
|
||||
|
||||
- Always run `pnpm install` from project root after creating new packages
|
||||
- Plugin packages go in `packages/wwv-plugin-<name>/`
|
||||
- Microservice backends go in `packages/wwv-plugin-<name>/backend/`
|
||||
- Both globs (`packages/*` and `packages/*/backend`) are in `pnpm-workspace.yaml`
|
||||
- Add new plugins to `transpilePackages` in `next.config.ts` and `paths` in `tsconfig.json`
|
||||
- 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 (Claude Code)
|
||||
### 5.7 AI Meta-Directives: Antigravity Standard
|
||||
|
||||
> [!NOTE]
|
||||
> This repository is orchestrated via the **Antigravity open standard** using **Claude Code** as the active agent. The entry point for Claude Code is `CLAUDE.md` at the project root.
|
||||
> 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.
|
||||
|
||||
> [!WARNING]
|
||||
> - **Always** use standard `.md` file extensions for rules, skills, and workflows.
|
||||
@@ -213,94 +102,31 @@ Built-in plugins are instantiated in `AppShell.tsx` and registered via `PluginRe
|
||||
> - **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.
|
||||
|
||||
---
|
||||
|
||||
## 6. Environment Variables
|
||||
|
||||
| Variable | Required | Description |
|
||||
|---|---|---|
|
||||
| `DATABASE_URL` | Yes | SQLite: `file:./data/wwv.db` |
|
||||
| `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 microservice URL |
|
||||
|
||||
Secrets go in `.env.local` (gitignored). Non-secrets go in `.env` (committed).
|
||||
### 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.
|
||||
|
||||
---
|
||||
|
||||
## 7. Development Commands
|
||||
## 6. Environment & Configuration
|
||||
|
||||
```bash
|
||||
pnpm install # Install all workspace dependencies
|
||||
pnpm run setup # Generate .env.local with AUTH_SECRET (first-time setup)
|
||||
pnpm dev # Next.js frontend only (auto-runs prisma migrate deploy + copy-cesium)
|
||||
pnpm dev:all # Frontend + wwv-data-engine concurrently (normal development)
|
||||
pnpm dev:backends # Run only the data engine in dev mode
|
||||
pnpm build # Production build
|
||||
pnpm test # Run all Vitest tests (scoped to src/lib, src/core, src/plugins)
|
||||
pnpm db:reset # Reset and re-migrate the frontend SQLite database (destructive)
|
||||
pnpm start:backends # Start all plugin microservice backends in parallel
|
||||
pnpm clean:backends # Wipe all plugin SQLite databases
|
||||
pnpm run scaffold-osm-plugin <name> # Generate a new plugin from scaffold
|
||||
```
|
||||
|
||||
Frontend runs at `http://localhost:3000`.
|
||||
> [!NOTE]
|
||||
> See `.agents/rules/environment-config.md` for required environment variables and secrets.
|
||||
|
||||
---
|
||||
|
||||
## 8. Deployment
|
||||
## 7. Development, Deployment & Testing
|
||||
|
||||
- **Docker**: Multi-stage Dockerfile using the Extractor Pattern (`deps` → `builder` → `runner`). The `node_modules` folders must be explicitly untracked in from `git` across the workspace to prevent corrupted BuildKit contextual cache overlaps during the `COPY . .` stage.
|
||||
- **Standalone output**: `next.config.ts` uses `output: "standalone"`.
|
||||
- **Cesium assets**: Copied to `public/cesium/` via `scripts/copy-cesium.mjs` at build time, excluded from output tracing.
|
||||
- **Prisma Configuration**: `prisma.config.ts` must export a native javascript object instead of dynamically importing CLI wrapper binaries (`prisma/config` or `dotenv`). The standalone Next.js tracer strips CLI devDependencies during the build, which will cause fatal runtime container crashes if imported.
|
||||
- **Microservices**: Separate containers defined in `docker-compose.yml`, proxied via `next.config.ts` rewrites.
|
||||
- **Coolify**: Deployed via Dockerfile builder natively mapping environment variables continuously into the container shell. Persistent storage mount required at `/app/data` for the SQLite root node database.
|
||||
- **Docker volumes**: Mount `/app/data` (frontend SQLite), `/app/packages/wwv-data-engine/data` (data engine SQLite), `/data` (Redis)
|
||||
|
||||
---
|
||||
|
||||
## 9. Testing Strategy
|
||||
|
||||
- **Framework**: Vitest with jsdom environment
|
||||
- **Coverage**: `src/lib/**`, `src/core/**`, `src/plugins/**`
|
||||
- **Run**: `pnpm test` (or `vitest run`)
|
||||
- **Key test files**: `rateLimit.test.ts`, `edition.test.ts`, `demoAdmin.test.ts`, `DeclarativePlugin.test.ts`, `cors.test.ts`, `repository.test.ts`, `marketplaceToken.test.ts`
|
||||
|
||||
---
|
||||
|
||||
## 10. Security Headers
|
||||
|
||||
Configured in `next.config.ts` `headers()`:
|
||||
- **CSP**: Restrictive with exceptions for CesiumJS (`unsafe-eval`, `unsafe-inline`), camera streams (`http: https:`), and analytics
|
||||
- **X-Frame-Options**: DENY
|
||||
- **X-Content-Type-Options**: nosniff
|
||||
- **Referrer-Policy**: strict-origin-when-cross-origin
|
||||
- **Permissions-Policy**: camera/microphone disabled, geolocation self-only
|
||||
|
||||
---
|
||||
|
||||
## 11. Related Repositories
|
||||
|
||||
| Repo | Purpose |
|
||||
|---|---|
|
||||
| `worldwideview` | Main application (this repo) |
|
||||
| `wwv-data-engine` | Open-source data engine — community seeders (PUBLIC) |
|
||||
| `wwv-data-engine-internal` | Proprietary data engine — all seeders (PRIVATE, deployed to Coolify) |
|
||||
| `worldwideview-marketplace` | Plugin marketplace web app |
|
||||
| `worldwideview-plugins` | Published npm plugin packages |
|
||||
| `worldwideview-web` | Marketing / landing page |
|
||||
> [!NOTE]
|
||||
> See `.agents/rules/deployment-and-testing.md` for development commands, Docker architecture, Vitest strategy, and CSP security headers.
|
||||
|
||||
---
|
||||
|
||||
@@ -310,13 +136,26 @@ Read the relevant rule file when working in that domain:
|
||||
|
||||
| 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` |
|
||||
| `plugin-architecture` | Creating/modifying plugins, lifecycle, registration | `.agents/rules/plugin-architecture.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, SQLite/Postgres | `.agents/rules/database-migrations.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` |
|
||||
|
||||
---
|
||||
|
||||
@@ -351,7 +190,7 @@ Refer to these skill documents for specialized tasks:
|
||||
| `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` | Building standalone Fastify microservice backends |
|
||||
| `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 |
|
||||
@@ -361,3 +200,305 @@ Refer to these skill documents for specialized tasks:
|
||||
### Global Skills
|
||||
|
||||
52 skills are available across all projects. See `.agents/global-skills-index.md` for the full list and invocation paths.
|
||||
|
||||
---
|
||||
|
||||
## 15. 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.
|
||||
|
||||
---
|
||||
|
||||
## 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
|
||||
|
||||
> **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.
|
||||
@@ -0,0 +1,51 @@
|
||||
# Design System: WorldWideView
|
||||
**Project ID:** local-worldwideview-app
|
||||
|
||||
## 1. Visual Theme & Atmosphere
|
||||
The WorldWideView platform employs an **"Airy, High-Tech, and Geospatial-Focused"** aesthetic. The design philosophy centers around "Glassmorphism Pro Max"—keeping the user's primary focus on the rich, underlying 3D globe visualization while providing highly legible, structured, and floating Heads-Up Display (HUD) elements.
|
||||
|
||||
The mood is utilitarian yet premium, heavily relying on dense background blurring, delicate inner borders, and vibrant glowing accent states to establish depth, interactivity, and a sense of "live" intelligence.
|
||||
|
||||
## 2. Color Palette & Roles
|
||||
WorldWideView operates using a multi-theme architecture (Default Dark, Pure Black, Legacy OLED, and Light). The core semantic roles for the **Default Dark Theme** are outlined below:
|
||||
|
||||
* **Obsidian Canvas** (`#171717`) - `--bg-primary`: The foundational layer behind the application shell and globe.
|
||||
* **Translucent Slate Glass** (`rgba(38, 38, 38, 0.85)`) - `--bg-glass`: The primary background for floating HUD panels, sidebars, and dialogs. Provides a frosted glass effect that allows the map to bleed through.
|
||||
* **Frost White** (`#ffffff`) - `--text-primary`: Primary typography for headers, active states, and high-emphasis data.
|
||||
* **Muted Ash** (`#a3a3a3`) - `--text-muted`: Secondary typography used for labels, subtitles, and inactive states to establish visual hierarchy.
|
||||
* **Gossamer Edge** (`rgba(255, 255, 255, 0.15)`) - `--border-subtle`: Defines the subtle, crisp edges of glass panels, dividers, and default button states.
|
||||
* **Starlight Cyan** (`#ffffff` / *Legacy:* `#22d3ee`) - `--accent-cyan`: Used for primary actions, active tabs, timeline scrubbers, and play buttons. Often paired with a diffuse glow (`0 0 24px rgba(255, 255, 255, 0.15)`) for emphasis and technical flair.
|
||||
* **Telemetry Green** (`#22c55e`) - `--accent-green`: Used for live status indicators, pulsing connectivity badges, and positive data deltas.
|
||||
* **Warning Amber** (`#f59e0b`) - `--accent-amber`: Used for warnings, "Alpha" badges, or unavailable data states.
|
||||
|
||||
## 3. Typography Rules
|
||||
The system uses a dual-font strategy to balance clean user interfaces with technical precision.
|
||||
|
||||
* **UI Font (Inter):** Used for all general interface elements, headers, and buttons.
|
||||
* Headers and brand elements use a bold `600/700` weight with tight letter-spacing (`-0.02em`) for a sleek, modern feel.
|
||||
* Section titles, keys, and subtitles use a very small size (`11px`), a medium weight, uppercase transformation, and wide letter-spacing (`0.05em` to `0.1em`) to mimic aerospace or military HUD interfaces.
|
||||
* **Monospace Font (JetBrains Mono):** Used strictly for data values, coordinates, telemetry, and exact timestamps (`11px` to `12px`). Ensures tabular alignment, clear distinction between similar characters (e.g., 0 and O), and technical precision.
|
||||
|
||||
## 4. Component Stylings
|
||||
|
||||
* **Glass Panels (Cards/Containers):**
|
||||
* **Shape:** Generously rounded corners (`16px` / `var(--radius-lg)`).
|
||||
* **Surface:** Dense frosted background blur (`24px`).
|
||||
* **Depth:** Elevated significantly above the map using a dual-layered drop shadow (`0 8px 32px rgba(0, 0, 0, 0.4)` combined with `0 2px 8px rgba(0, 0, 0, 0.2)`). Features a crisp inner border (`inset 0 1px 1px rgba(255, 255, 255, 0.1)`) to simulate physical glass thickness.
|
||||
* **Buttons:**
|
||||
* **Shape:** Subtly rounded corners (`12px` / `var(--radius-md)`) with a standard height of `36px`.
|
||||
* **Surface:** Translucent glass background with a subtle border.
|
||||
* **Behavior:** Smooth, spring-based transitions. On hover, the background brightens, the element scales up/translates slightly (`translateY(-1px)`), and primary buttons emit a vivid neon glow. On click (active), buttons physically depress (`scale(0.97)`).
|
||||
* **Tabs & Selectors:**
|
||||
* **Shape:** Softly rounded (`8px` / `var(--radius-sm)`).
|
||||
* **Surface:** Clean, flat, and transparent by default.
|
||||
* **Behavior:** Transitions to a soft glass hover or active state. Active tabs use a highlighted background (`rgba(var(--accent-rgb), 0.1)`) and bright cyan text with increased font weight.
|
||||
* **Timeline Scrubber:**
|
||||
* **Track:** Slender `4px` tall track with softly rounded edges.
|
||||
* **Handle:** A circular `14px` handle that emits a cyan glow, expanding dynamically on hover (`scale(1.2)`).
|
||||
|
||||
## 5. Layout Principles
|
||||
* **Absolute Overlays:** The UI does not push the map; instead, it floats over a full-screen, `z-index: 0` globe canvas. Elements are anchored to the edges (Header to top, Sidebar to sides, Timeline to bottom).
|
||||
* **Strict 4/8dp Rhythm:** All spacing adheres to an 8-point grid base (`4px`, `8px`, `12px`, `16px`, `24px`, `32px`, `48px`).
|
||||
* **Dynamic Containment:** Sidebars and bottom panels push each other dynamically to prevent overlap and optimize map visibility (e.g., when the bottom panel opens, sidebars slide upward).
|
||||
* **Whitespace & Density:** Panels use a dense `16px` padding globally to maximize the amount of intelligence data visible while maintaining clear breathing room between individual data rows. Scrollable areas hide scrollbars until hovered to maintain the clean glass aesthetic.
|
||||
+70
-14
@@ -6,47 +6,94 @@ RUN find . -type f \! -name 'package.json' \! -name 'pnpm-workspace.yaml' \! -na
|
||||
find . -type d -empty -delete
|
||||
|
||||
# Stage 1: Install ALL dependencies (needed for build)
|
||||
FROM node:22-alpine AS deps
|
||||
RUN corepack enable pnpm
|
||||
RUN apk add --no-cache python3 make g++
|
||||
FROM node:26-alpine AS deps
|
||||
RUN npm install -g [email protected]
|
||||
|
||||
WORKDIR /app
|
||||
# Copy only the extracted package.jsons
|
||||
COPY --from=extractor /app ./
|
||||
# Install dependencies with cache mount for pnpm store
|
||||
RUN --mount=type=cache,id=pnpm,target=/root/.local/share/pnpm/store pnpm install --frozen-lockfile
|
||||
RUN --mount=type=cache,id=pnpm,target=/root/.local/share/pnpm/store pnpm install
|
||||
|
||||
|
||||
# Stage 3: Build the application
|
||||
FROM deps AS builder
|
||||
# Copy full source code
|
||||
COPY . .
|
||||
RUN DATABASE_URL="file:./data/wwv.db" npx prisma generate
|
||||
|
||||
# Create an empty SQLite database with all tables applied
|
||||
RUN mkdir -p ./data && DATABASE_URL=file:./data/wwv.db npx prisma migrate deploy
|
||||
|
||||
# Next.js inlines NEXT_PUBLIC_* vars at build time — must be declared as ARGs
|
||||
ARG NEXT_PUBLIC_CESIUM_ION_TOKEN
|
||||
ARG NEXT_PUBLIC_GOOGLE_MAPS_API_KEY
|
||||
ARG NEXT_PUBLIC_BING_MAPS_KEY
|
||||
ARG NEXT_PUBLIC_WWV_EDITION
|
||||
ARG NEXT_PUBLIC_WS_ENGINE_URL
|
||||
ARG NEXT_PUBLIC_WWV_PLUGIN_DATA_ENGINE_URL
|
||||
ARG NEXT_PUBLIC_ADSENSE_CLIENT_ID
|
||||
ARG NEXT_PUBLIC_SUPABASE_URL
|
||||
ARG NEXT_PUBLIC_SUPABASE_ANON_KEY
|
||||
ARG NEXT_PUBLIC_WWV_AGENT_BUS_ENABLED
|
||||
ARG NEXT_PUBLIC_WWV_BUILD_ID
|
||||
ARG NEXT_PUBLIC_WWV_BUILD_AT
|
||||
|
||||
# Run our pregenerate schema swap script and then generate Prisma client
|
||||
RUN NEXT_PUBLIC_WWV_EDITION=$NEXT_PUBLIC_WWV_EDITION pnpm run generate
|
||||
|
||||
# Database migrations run at container startup via docker-entrypoint.sh
|
||||
# DATABASE_URL must be set to a PostgreSQL connection string
|
||||
|
||||
# Stamp the build with a millisecond-precision id + iso timestamp. If the
|
||||
# operator hasn't passed NEXT_PUBLIC_WWV_BUILD_ID via build args, generate
|
||||
# one here so /api/build and the client console.log both carry a unique
|
||||
# value per `docker build`.
|
||||
RUN if [ -z "$NEXT_PUBLIC_WWV_BUILD_ID" ]; then \
|
||||
NEXT_PUBLIC_WWV_BUILD_ID="$(date +%s%3N 2>/dev/null || node -e 'process.stdout.write(String(Date.now()))')" ; \
|
||||
fi && \
|
||||
if [ -z "$NEXT_PUBLIC_WWV_BUILD_AT" ]; then \
|
||||
NEXT_PUBLIC_WWV_BUILD_AT="$(node -e 'process.stdout.write(new Date().toISOString())')" ; \
|
||||
fi && \
|
||||
echo "$NEXT_PUBLIC_WWV_BUILD_ID" > /app/.build-id && \
|
||||
echo "$NEXT_PUBLIC_WWV_BUILD_AT" > /app/.build-at
|
||||
|
||||
# Write .env.production.local so Next.js sees every NEXT_PUBLIC_* var
|
||||
# whose ARG was passed in. Docker doesn't reliably promote ARGs into the
|
||||
# build process's environment for `next build` to inline references with
|
||||
# Webpack's DefinePlugin — `process.env.NEXT_PUBLIC_X` either gets the
|
||||
# inlined literal value (when set) or stays as a runtime polyfill access
|
||||
# that resolves to undefined in the browser. Writing the file is the
|
||||
# documented Next.js path and behaves the same on every host.
|
||||
RUN set +e ; { \
|
||||
echo "NEXT_PUBLIC_WWV_BUILD_ID=$(cat /app/.build-id)" ; \
|
||||
echo "NEXT_PUBLIC_WWV_BUILD_AT=$(cat /app/.build-at)" ; \
|
||||
if [ -n "$NEXT_PUBLIC_WWV_EDITION" ]; then echo "NEXT_PUBLIC_WWV_EDITION=$NEXT_PUBLIC_WWV_EDITION" ; fi ; \
|
||||
if [ -n "$NEXT_PUBLIC_WWV_AGENT_BUS_ENABLED" ]; then echo "NEXT_PUBLIC_WWV_AGENT_BUS_ENABLED=$NEXT_PUBLIC_WWV_AGENT_BUS_ENABLED" ; fi ; \
|
||||
if [ -n "$NEXT_PUBLIC_CESIUM_ION_TOKEN" ]; then echo "NEXT_PUBLIC_CESIUM_ION_TOKEN=$NEXT_PUBLIC_CESIUM_ION_TOKEN" ; fi ; \
|
||||
if [ -n "$NEXT_PUBLIC_GOOGLE_MAPS_API_KEY" ]; then echo "NEXT_PUBLIC_GOOGLE_MAPS_API_KEY=$NEXT_PUBLIC_GOOGLE_MAPS_API_KEY" ; fi ; \
|
||||
if [ -n "$NEXT_PUBLIC_BING_MAPS_KEY" ]; then echo "NEXT_PUBLIC_BING_MAPS_KEY=$NEXT_PUBLIC_BING_MAPS_KEY" ; fi ; \
|
||||
if [ -n "$NEXT_PUBLIC_WS_ENGINE_URL" ]; then echo "NEXT_PUBLIC_WS_ENGINE_URL=$NEXT_PUBLIC_WS_ENGINE_URL" ; fi ; \
|
||||
if [ -n "$NEXT_PUBLIC_WWV_PLUGIN_DATA_ENGINE_URL" ]; then echo "NEXT_PUBLIC_WWV_PLUGIN_DATA_ENGINE_URL=$NEXT_PUBLIC_WWV_PLUGIN_DATA_ENGINE_URL" ; fi ; \
|
||||
if [ -n "$NEXT_PUBLIC_ADSENSE_CLIENT_ID" ]; then echo "NEXT_PUBLIC_ADSENSE_CLIENT_ID=$NEXT_PUBLIC_ADSENSE_CLIENT_ID" ; fi ; \
|
||||
if [ -n "$NEXT_PUBLIC_SUPABASE_URL" ]; then echo "NEXT_PUBLIC_SUPABASE_URL=$NEXT_PUBLIC_SUPABASE_URL" ; fi ; \
|
||||
if [ -n "$NEXT_PUBLIC_SUPABASE_ANON_KEY" ]; then echo "NEXT_PUBLIC_SUPABASE_ANON_KEY=$NEXT_PUBLIC_SUPABASE_ANON_KEY" ; fi ; \
|
||||
} > /app/.env.production.local
|
||||
|
||||
# Run Next.js build with Webpack cache mounted
|
||||
RUN --mount=type=cache,target=/app/.next/cache NODE_OPTIONS="--max_old_space_size=3072" pnpm run build
|
||||
RUN node scripts/copy-cesium.mjs
|
||||
|
||||
# Deploy flattened production dependencies
|
||||
RUN pnpm --filter worldwideview deploy --prod /app/prod
|
||||
|
||||
# Stage 4: Production runner
|
||||
FROM node:22-alpine AS runner
|
||||
FROM node:26-alpine AS runner
|
||||
WORKDIR /app
|
||||
|
||||
RUN apk add --no-cache openssl
|
||||
RUN npm install -g [email protected]
|
||||
|
||||
ENV NODE_ENV=production
|
||||
ENV HOSTNAME=0.0.0.0
|
||||
ENV PORT=3000
|
||||
ENV DATABASE_URL=file:./data/wwv.db
|
||||
# DATABASE_URL must be provided via environment variable (no default)
|
||||
# Example: postgresql://user:pass@host:5432/dbname
|
||||
ENV AUTH_TRUST_HOST=true
|
||||
|
||||
# Copy Prisma schema + migrations for runtime DB init
|
||||
@@ -59,20 +106,29 @@ COPY --from=builder /app/src/generated ./src/generated
|
||||
# Copy standalone server output
|
||||
COPY --from=builder /app/.next/standalone ./
|
||||
|
||||
# Copy deployed production node_modules
|
||||
COPY --from=builder /app/prod/node_modules ./node_modules
|
||||
|
||||
# We no longer copy proddeps/node_modules. Next.js standalone output
|
||||
# already traces and copies all the exact node_modules needed for production.
|
||||
|
||||
# Copy static assets that standalone mode does NOT include
|
||||
COPY --from=builder /app/.next/static ./.next/static
|
||||
COPY --from=builder /app/public ./public
|
||||
COPY --from=builder /app/scripts/https-proxy.mjs ./scripts/https-proxy.mjs
|
||||
|
||||
# Build stamp — read by /api/build at runtime.
|
||||
COPY --from=builder /app/.build-id ./.build-id
|
||||
COPY --from=builder /app/.build-at ./.build-at
|
||||
|
||||
# Entrypoint: migrate DB on first run, then start server
|
||||
COPY docker-entrypoint.sh ./docker-entrypoint.sh
|
||||
RUN sed -i 's/\r$//' ./docker-entrypoint.sh
|
||||
RUN chmod +x ./docker-entrypoint.sh
|
||||
|
||||
# Declare /app/data as a persistent volume mount point.
|
||||
VOLUME ["/app/data"]
|
||||
EXPOSE 3000 3001
|
||||
|
||||
EXPOSE 3000
|
||||
HEALTHCHECK --interval=30s --timeout=10s --start-period=30s --retries=3 \
|
||||
CMD wget --no-verbose --tries=1 --spider http://localhost:3000/api/health || exit 1
|
||||
|
||||
ENTRYPOINT ["./docker-entrypoint.sh"]
|
||||
Binary file not shown.
@@ -1,33 +1,93 @@
|
||||
Elastic License 2.0
|
||||
|
||||
Acceptance
|
||||
URL: https://www.elastic.co/licensing/elastic-license
|
||||
|
||||
## Acceptance
|
||||
|
||||
By using the software, you agree to all of the terms and conditions below.
|
||||
|
||||
Copyright License
|
||||
## Copyright License
|
||||
|
||||
The licensor grants you a non-exclusive, royalty-free, worldwide, non-transferable, non-sublicensable license to use, copy, distribute, make available, and prepare derivative works of the software.
|
||||
The licensor grants you a non-exclusive, royalty-free, worldwide,
|
||||
non-sublicensable, non-transferable license to use, copy, distribute, make
|
||||
available, and prepare derivative works of the software, in each case subject to
|
||||
the limitations and conditions below.
|
||||
|
||||
Limitations
|
||||
## Limitations
|
||||
|
||||
You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
|
||||
You may not provide the software to third parties as a hosted or managed
|
||||
service, where the service provides users with access to any substantial set of
|
||||
the features or functionality of the software.
|
||||
|
||||
You may not move, alter, disable, or circumvent any of the licensing features contained in the software, or remove or obscure any functionality in the software that is protected by the licensing features.
|
||||
You may not move, change, disable, or circumvent the license key functionality
|
||||
in the software, and you may not remove or obscure any functionality in the
|
||||
software that is protected by the license key.
|
||||
|
||||
You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor's trademarks is subject to applicable law.
|
||||
You may not alter, remove, or obscure any licensing, copyright, or other notices
|
||||
of the licensor in the software. Any use of the licensor’s trademarks is subject
|
||||
to applicable law.
|
||||
|
||||
Patents
|
||||
## Patents
|
||||
|
||||
The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import, and have imported, the software. This license is subject to the conditions of this license, and does not cover patent claims infringed by your modifications or your additions to the software. If you or your company make any written claim that the software infringes or contributes to an infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
|
||||
The licensor grants you a license, under any patent claims the licensor can
|
||||
license, or becomes able to license, to make, have made, use, sell, offer for
|
||||
sale, import and have imported the software, in each case subject to the
|
||||
limitations and conditions in this license. This license does not cover any
|
||||
patent claims that you cause to be infringed by modifications or additions to
|
||||
the software. If you or your company make any written claim that the software
|
||||
infringes or contributes to infringement of any patent, your patent license for
|
||||
the software granted under these terms ends immediately. If your company makes
|
||||
such a claim, your patent license ends immediately for work on behalf of your
|
||||
company.
|
||||
|
||||
Notices
|
||||
## Notices
|
||||
|
||||
You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms. If you modify the software, you must include prominent notices in modified copies stating that you have modified it.
|
||||
You must ensure that anyone who gets a copy of any part of the software from you
|
||||
also gets a copy of these terms.
|
||||
|
||||
No Other Rights
|
||||
If you modify the software, you must include in any modified copies of the
|
||||
software prominent notices stating that you have modified the software.
|
||||
|
||||
The terms do not imply any licenses other than those expressly granted under these terms.
|
||||
## No Other Rights
|
||||
|
||||
Termination
|
||||
These terms do not imply any licenses other than those expressly granted in
|
||||
these terms.
|
||||
|
||||
If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violations of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
|
||||
## Termination
|
||||
|
||||
If you use the software in violation of these terms, such use is not licensed,
|
||||
and your licenses will automatically terminate. If the licensor provides you
|
||||
with a notice of your violation, and you cease all violation of this license no
|
||||
later than 30 days after you receive that notice, your licenses will be
|
||||
reinstated retroactively. However, if you violate these terms after such
|
||||
reinstatement, any additional violation of these terms will cause your licenses
|
||||
to terminate automatically and permanently.
|
||||
|
||||
## No Liability
|
||||
|
||||
*As far as the law allows, the software comes as is, without any warranty or
|
||||
condition, and the licensor will not be liable to you for any damages arising
|
||||
out of these terms or the use or nature of the software, under any kind of
|
||||
legal claim.*
|
||||
|
||||
## Definitions
|
||||
|
||||
The **licensor** is the entity offering these terms, and the **software** is the
|
||||
software the licensor makes available under these terms, including any portion
|
||||
of it.
|
||||
|
||||
**you** refers to the individual or entity agreeing to these terms.
|
||||
|
||||
**your company** is any legal entity, sole proprietorship, or other kind of
|
||||
organization that you work for, plus all organizations that have control over,
|
||||
are under the control of, or are under common control with that
|
||||
organization. **control** means ownership of substantially all the assets of an
|
||||
entity, or the power to direct its management and policies by vote, contract, or
|
||||
otherwise. Control can be direct or indirect.
|
||||
|
||||
**your licenses** are all the licenses granted to you for the software under
|
||||
these terms.
|
||||
|
||||
**use** means anything you do with the software requiring one of your licenses.
|
||||
|
||||
**trademark** means trademarks, service marks, and similar rights.
|
||||
@@ -7,6 +7,20 @@
|
||||
|
||||
*A modular situational awareness platform designed to ingest live data streams and render them as interactive, cinematic layers on a high-fidelity CesiumJS 3D globe.*
|
||||
|
||||
[](https://github.com/silvertakana/worldwideview/actions/workflows/ci.yml)
|
||||
[](https://codecov.io/gh/silvertakana/worldwideview)
|
||||
[](https://www.npmjs.com/package/@worldwideview/wwv-plugin-sdk)
|
||||
[](https://github.com/silvertakana/worldwideview/releases)
|
||||
[](https://github.com/silvertakana/worldwideview/graphs/contributors)
|
||||
<br>
|
||||
[](https://nextjs.org/)
|
||||
[](https://cesium.com/)
|
||||
[](https://www.typescriptlang.org/)
|
||||
[](https://www.docker.com/)
|
||||
[](LICENSE)
|
||||
[](#)
|
||||
[](https://makeapullrequest.com)
|
||||
|
||||

|
||||
|
||||
</div>
|
||||
@@ -15,15 +29,57 @@
|
||||
|
||||
WorldWideView is a real-time geospatial engine visualizing live global data on an interactive 3D globe. Utilizing a dynamic "All-Bundle" plugin architecture, independent data sources—like live aircraft, maritime vessels, or conflict events—are ingested and rendered decoupled from the core 3D viewer.
|
||||
|
||||
## Key Features
|
||||
|
||||
- **"All-Bundle" Plugin Architecture**: Ingest any data source dynamically without touching the core platform.
|
||||
- **High-Fidelity 3D Rendering**: Google Photorealistic 3D Tiles and LOD modeling powered by CesiumJS.
|
||||
- **Real-Time Data Pipeline**: High-frequency WebSocket updates managed by a custom `DataBus`.
|
||||
- **Advanced Entity Management**: Automatic horizon culling, chunked primitive rendering, and 3D stacking/spiderification.
|
||||
- **Marketplace Integration**: Download and sync new plugins directly from the UI.
|
||||
- **Agent Bus (opt-in)**: HTTP+SSE control surface that lets an external tool — typically an MCP server fronting an LLM — fly the globe, toggle layers, and select entities in the running browser session. Default off; see [Agent Bus docs](docs/agent-bus.md).
|
||||
|
||||
## Core Technologies
|
||||
|
||||
- **Frontend:** Next.js 16 (App Router), React 19, TypeScript 5
|
||||
- **3D Engine:** CesiumJS + Resium (Google Photorealistic 3D Tiles)
|
||||
- **State Management:** Zustand
|
||||
- **Event Bus:** Custom typed `DataBus` for high-frequency WebSocket updates
|
||||
- **Database:** SQLite via Prisma (local), PostgreSQL (cloud)
|
||||
- **Database:** PostgreSQL via Prisma 7
|
||||
- **Deployment:** Docker multi-stage build, Coolify
|
||||
|
||||
## Project Architecture
|
||||
|
||||
WorldWideView separates the data acquisition layer from the frontend rendering loop, using a real-time event bus to bridge them.
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
subgraph Data Sources
|
||||
A[Public APIs] -->|Poll| B[Data Engine Seeders]
|
||||
C[Microservices] -->|Stream| B
|
||||
end
|
||||
|
||||
subgraph Frontend Pipeline
|
||||
B -->|WebSocket /stream| D[DataBus & WsClient]
|
||||
D -->|Hydrate| E[Zustand Store]
|
||||
E -->|Memoized Entities| F[Entity Renderer]
|
||||
F -->|Primitives| G[CesiumJS Globe]
|
||||
end
|
||||
|
||||
subgraph Plugins
|
||||
H[Plugin Registry] -->|Load| I[Dynamic Import CDNs]
|
||||
end
|
||||
|
||||
H -.-> D
|
||||
```
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before running the application, ensure you have the following installed:
|
||||
- [Node.js](https://nodejs.org/) (v18+)
|
||||
- [pnpm](https://pnpm.io/) (v9+)
|
||||
- [Docker](https://www.docker.com/) (for self-hosting or full local dev)
|
||||
- PostgreSQL (or rely on the `coolify-db` / local compose container)
|
||||
|
||||
## Quick Start (Self-Hosting)
|
||||
|
||||
WorldWideView uses a multi-stage Dockerfile designed for standalone output. To deploy instantly on your own server:
|
||||
@@ -31,17 +87,17 @@ WorldWideView uses a multi-stage Dockerfile designed for standalone output. To d
|
||||
**Mac/Linux:**
|
||||
```bash
|
||||
mkdir worldwideview && cd worldwideview
|
||||
curl -fsSL https://raw.githubusercontent.com/silvertakana/worldwideview/main/setup.sh | bash
|
||||
curl -fsSL https://raw.githubusercontent.com/silvertakana/worldwideview/main/self-host/setup.sh | bash
|
||||
```
|
||||
|
||||
**Windows (PowerShell):**
|
||||
```powershell
|
||||
mkdir worldwideview; cd worldwideview
|
||||
Invoke-WebRequest -Uri https://raw.githubusercontent.com/silvertakana/worldwideview/main/setup.ps1 -UseBasicParsing | Invoke-Expression
|
||||
Invoke-WebRequest -Uri https://raw.githubusercontent.com/silvertakana/worldwideview/main/self-host/setup.ps1 -UseBasicParsing | Invoke-Expression
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> Ensure you mount the `/app/data` volume to persist the SQLite database across container restarts.
|
||||
> Ensure you connect a PostgreSQL database via the `DATABASE_URL` environment variable for production deployments.
|
||||
|
||||
## Quick Start (Local Development)
|
||||
|
||||
@@ -56,6 +112,24 @@ pnpm run dev:all # boots the UI, cache layers, and the data engine
|
||||
```
|
||||
Visit `http://localhost:3000` to see the live globe.
|
||||
|
||||
## Project Structure
|
||||
|
||||
The codebase utilizes a `pnpm` monorepo configuration:
|
||||
|
||||
```text
|
||||
worldwideview/
|
||||
├── src/ # Core frontend app
|
||||
│ ├── app/ # Next.js App Router (pages, API routes)
|
||||
│ ├── components/ # Shared UI, Globe panels, and 3D layouts
|
||||
│ ├── core/ # DataBus, Polling, PluginManager, Store
|
||||
│ └── plugins/ # Built-in plugins and registry logic
|
||||
├── packages/ # Monorepo packages
|
||||
│ ├── wwv-plugin-sdk/ # SDK interfaces and manifest schemas
|
||||
│ └── wwv-plugin-*/ # Individual plugins & their backends
|
||||
├── prisma/ # Database schemas & migrations
|
||||
└── .agents/ # Agent rules, workflows, and documentation
|
||||
```
|
||||
|
||||
## Plugin Ecosystem
|
||||
|
||||
WorldWideView operates on an open-core philosophy. The platform itself is data-agnostic; all data sources are dynamically imported as plugins at runtime.
|
||||
@@ -72,17 +146,35 @@ WorldWideView is distributed across several specialized repositories:
|
||||
3. **`worldwideview-plugins`**: First-party maintained plugins.
|
||||
4. **`worldwideview-marketplace`**: The web application driving the plugin directory.
|
||||
5. **`worldwideview-web`**: Marketing and landing site.
|
||||
6. **[`szski/wwv-mcp`](https://github.com/szski/wwv-mcp)**: Reference MCP server for driving the globe from an LLM agent (Claude Code, Claude Desktop, Cursor, Cline, …) via the [Agent Bus](docs/agent-bus.md). Contributor-hosted today; may move under the project org.
|
||||
|
||||
## Development & Workflow
|
||||
|
||||
- **Branching & Commits:** We strictly enforce [Conventional Commits](https://www.conventionalcommits.org/) (`feat:`, `fix:`, `refactor:`). Every commit should utilize our semantic versioning `[/commit]` workflow.
|
||||
- **Coding Standards:** We emphasize vanilla CSS (no Tailwind), strict TypeScript 5, and file modularity (max 150 lines per file).
|
||||
- **Testing:** We use Vitest with `jsdom`. All new core logic should be accompanied by tests, running via `pnpm test`.
|
||||
|
||||
See [Docs: Development](docs/development.md) and [Docs: Testing](docs/testing.md) for more details.
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome community contributions! Please review our coding standards and PR processes before submitting code. For detailed instructions on local development and setting up your environment, see our [CONTRIBUTING.md](CONTRIBUTING.md).
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the Elastic License 2.0 - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
## Documentation Index
|
||||
|
||||
Explore our comprehensive documentation suite for detailed engineering insights:
|
||||
|
||||
- **[Project Overview](docs/project-overview.md)**: High-level value proposition and technology stack.
|
||||
- **[Architecture](docs/architecture.md)**: DataBus event stream and Zustand state management.
|
||||
- **[Architecture](docs/ARCHITECTURE.md)**: Plugin system, state management, data pipeline, and Cesium rendering deep-dive.
|
||||
- **[Build System](docs/build-system.md)**: Monorepo structure, Next.js standalone output, and Docker builds.
|
||||
- **[Development](docs/development.md)**: Coding conventions and common implementation patterns.
|
||||
- **[Testing](docs/testing.md)**: Vitest setup and coverage targets.
|
||||
- **[Deployment](docs/deployment.md)**: Coolify integration and persistent volumes.
|
||||
- **[Agent Bus](docs/agent-bus.md)**: Wiring an MCP server (or any external tool) to drive the running globe.
|
||||
- **[Files Catalog](docs/files.md)**: Comprehensive mapping of core source files.
|
||||
|
||||
> [!IMPORTANT]
|
||||
|
||||
+3
-3
@@ -26,11 +26,11 @@ Each stage is **self-contained and demo-able**. Any stage can be shipped indepen
|
||||
---
|
||||
|
||||
## Stage 3: Prisma ORM & Local Database ✅
|
||||
**Demo:** "Run `pnpm run dev` on a fresh clone. SQLite auto-creates. App works with zero config."
|
||||
**Demo:** "Run `pnpm run dev` on a fresh clone with a valid DATABASE_URL. App works seamlessly."
|
||||
|
||||
- [x] Prisma (`prisma` + `@prisma/client`)
|
||||
- [x] Schema: `InstalledPlugin`, `Setting`, `User`, `AviationHistory`, `NpmCache`
|
||||
- [x] SQLite default: `DATABASE_URL=file:./data/wwv.db`
|
||||
- [x] PostgreSQL default: `DATABASE_URL` required
|
||||
- [x] `predev` script: `prisma migrate deploy`
|
||||
- [x] DB auto-creates on first run — zero manual setup
|
||||
|
||||
@@ -142,7 +142,7 @@ Each stage is **self-contained and demo-able**. Any stage can be shipped indepen
|
||||
| **License** | EL2.0 for WorldWideView core; Open Source for marketplace |
|
||||
| **Shared types** | `@worldwideview/plugin-sdk` npm package (MIT) |
|
||||
| **Hosting** | Coolify (ThinkPad T480s). Landing page on Vercel (static export) |
|
||||
| **Database** | Supabase PostgreSQL (cloud), SQLite (local), Prisma ORM |
|
||||
| **Database** | PostgreSQL, Prisma ORM |
|
||||
| **Tenant isolation** | Row-Level Security (RLS) in shared PostgreSQL |
|
||||
| **User settings** | Runtime settings store in DB, not `.env` |
|
||||
| **Bot prevention** | Email verification + Cloudflare Turnstile + rate limiting |
|
||||
|
||||
+37
@@ -0,0 +1,37 @@
|
||||
# Security Policy
|
||||
|
||||
Security is a priority for our project. We appreciate the efforts of security researchers and the open-source community in helping us keep our software secure.
|
||||
|
||||
## Supported Versions
|
||||
|
||||
Security updates are provided for the following versions of the project. We highly recommend all users stay on the latest stable release.
|
||||
|
||||
| Version | Supported | Notes |
|
||||
| ------- | ------------------ | ----- |
|
||||
| 2.x.x | :white_check_mark: | Current main release. Receives all security updates. |
|
||||
| 1.x.x | :x: | Legacy version. No longer receiving updates. |
|
||||
| < 1.0 | :x: | Beta versions are not supported. |
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
**Please do not report security vulnerabilities through public GitHub issues.**
|
||||
|
||||
If you believe you have found a security vulnerability in this project, please report it privately so we have time to fix it before the vulnerability is made public.
|
||||
|
||||
### How to Report
|
||||
|
||||
1. **Email us directly:** Send your report to **[support@worldwideview.dev]**.
|
||||
2. **GitHub Security Advisories:** Alternatively, if this repository has Private Vulnerability Reporting enabled, you can click on the `Security` tab -> `Advisories` -> `Report a vulnerability`.
|
||||
|
||||
### What to Include
|
||||
To help us quickly validate and fix the issue, please include the following in your report:
|
||||
* A description of the vulnerability and its potential impact.
|
||||
* The steps required to reproduce the issue (a proof of concept is highly appreciated).
|
||||
* Any relevant environment details (OS, browser, version).
|
||||
|
||||
### What to Expect
|
||||
* **Acknowledgment:** We will acknowledge receipt of your vulnerability report within **48 hours**.
|
||||
* **Triage & Fix:** We will review the report, determine its severity, and work on a patch. We will keep you updated on our progress.
|
||||
* **Disclosure:** Once the vulnerability is patched and a new version is released, we will publish a security advisory. We are happy to credit you for the discovery if you would like!
|
||||
|
||||
*Note: As an open-source project, we currently do not offer financial bug bounties, but we deeply appreciate your contributions to keeping our users safe.*
|
||||
@@ -1,7 +0,0 @@
|
||||
# This file lists tools managed by Aftman, a cross-platform toolchain manager.
|
||||
# For more information, see https://github.com/LPGhatguy/aftman
|
||||
|
||||
# To add a new tool, add an entry to this table.
|
||||
[tools]
|
||||
rojo = "rojo-rbx/[email protected]"
|
||||
# rojo = "rojo-rbx/[email protected]"
|
||||
@@ -1 +0,0 @@
|
||||
{"message":"fix(aviation): implement exponential backoff for rate limits","tree":"55c74a09dac7ce178ecf94d5cb48b2502e57e759","parents":["e25ddc0b648b757ea32b7376bab50d8e75d6d330"]}
|
||||
@@ -1,54 +0,0 @@
|
||||
const fs = require("fs");
|
||||
const { execSync } = require("child_process");
|
||||
|
||||
const uuidsToDelete = [
|
||||
"i331gbc1zzytx7via8lntdm6",
|
||||
"pow71xsobdas7etf5r3hy5ug",
|
||||
"l79dyd03lhtcpgi7swkoxm55",
|
||||
"ry6160tpy4gh2xjfwr011no0",
|
||||
"gfe78t8jm53lltentz19ze60",
|
||||
"e1cg7q8khyvpti5rkp351559",
|
||||
"c35cvvqxhdbslk8yc24g04wk",
|
||||
"ijj9pqkavlusy2wmzsbjtc74",
|
||||
"ghe6bzlr6ex6j51lgxzyhd46",
|
||||
"h3v45w2u1essulzeg56i27a3",
|
||||
"oxk05amog4fla0lskmkfx64x",
|
||||
"yxm4mn60lfp9qah0q4yf2hij",
|
||||
"ezjxo4ehs96lv0ji1n2r0auw",
|
||||
"t12x7pgptsqiu5gbvv35gun5",
|
||||
"urq1ll00a3vv9on6pulmpofe",
|
||||
"eb5zgw5wlgvio2gggbiphpam",
|
||||
"ld1h3pody4nxj3b44pbskl53",
|
||||
"x111xfygqxrlbf5wqlx59f6d",
|
||||
"se1weqr4dj7thp4p1l055wfc",
|
||||
"cqses6urxff0n94i0u6lktzt",
|
||||
"nvcir33nyuvzk5niy3s7eg9w",
|
||||
"s63onga2s6v8r3k10lrdwzth",
|
||||
"cf3uedqnjmwv48h7tm91d95r",
|
||||
"o9124dnnieau9wxoefyxvfgu",
|
||||
"kxzobc8qlvigbsk1d35dpiyi",
|
||||
"eh8lzjbsy2c9kwj2emztcmf6",
|
||||
"umfsos2vcmotfk2cfpqdoycc",
|
||||
"yn1mdh0fngiati6r4625qvv9"
|
||||
];
|
||||
|
||||
const token = "1|vPZPgvB8vVi8ZD5ZKS8lrCrwNlPofVv4I8Tjmqmyd01f92d2";
|
||||
const baseUrl = "https://coolify.worldwideview.dev/api/v1";
|
||||
const appUuid = "nmn55t4io3myfubs72worn7k";
|
||||
|
||||
async function run() {
|
||||
for (const id of uuidsToDelete) {
|
||||
console.log("Deleting", id);
|
||||
try {
|
||||
const res = await fetch(`${baseUrl}/applications/${appUuid}/envs/${id}`, {
|
||||
method: "DELETE",
|
||||
headers: { "Authorization": `Bearer ${token}` }
|
||||
});
|
||||
console.log(id, res.status);
|
||||
} catch(e) {
|
||||
console.error(e);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
run();
|
||||
@@ -0,0 +1,7 @@
|
||||
SUPABASE_PG_URL=postgresql://postgres:[email protected]:5432/postgres
|
||||
SUPABASE_URL=https://xyz.supabase.co
|
||||
SUPABASE_ANON_KEY=eyJ...
|
||||
SUPABASE_SERVICE_ROLE_KEY=eyJ...
|
||||
ACME_EMAIL=[email protected]
|
||||
STRIPE_SECRET_KEY=sk_test_...
|
||||
STRIPE_WEBHOOK_SECRET=whsec_...
|
||||
@@ -0,0 +1,47 @@
|
||||
services:
|
||||
db:
|
||||
image: postgres:15-alpine
|
||||
environment:
|
||||
POSTGRES_USER: postgres
|
||||
POSTGRES_PASSWORD: password
|
||||
POSTGRES_DB: postgres
|
||||
ports:
|
||||
- "5432:5432"
|
||||
|
||||
wwv-cloud:
|
||||
build:
|
||||
context: ../..
|
||||
dockerfile: Dockerfile
|
||||
args:
|
||||
- NEXT_PUBLIC_WWV_EDITION=cloud
|
||||
restart: always
|
||||
environment:
|
||||
NEXT_PUBLIC_WWV_EDITION: cloud
|
||||
DATABASE_URL: postgresql://postgres:password@db:5432/postgres
|
||||
NEXT_PUBLIC_SUPABASE_URL: ${SUPABASE_URL:-http://dummy}
|
||||
NEXT_PUBLIC_SUPABASE_ANON_KEY: ${SUPABASE_ANON_KEY:-dummy}
|
||||
SUPABASE_SERVICE_ROLE_KEY: ${SUPABASE_SERVICE_ROLE_KEY:-dummy}
|
||||
AUTH_SECRET: ${AUTH_SECRET:-dummy_secret_for_local_testing_only_1234567890}
|
||||
ports:
|
||||
- "3001:3000"
|
||||
labels:
|
||||
- "traefik.enable=true"
|
||||
- "traefik.http.routers.wwv.rule=HostRegexp(`{user:[a-z0-9-]+}.app.worldwideview.dev`) || Host(`app.worldwideview.dev`) || Host(`localhost`) || HostRegexp(`{user:[a-z0-9-]+}.localhost`)"
|
||||
- "traefik.http.routers.wwv.entrypoints=web,websecure"
|
||||
# - "traefik.http.routers.wwv.tls.certresolver=letsencrypt"
|
||||
- "traefik.http.services.wwv.loadbalancer.server.port=3000"
|
||||
depends_on:
|
||||
- db
|
||||
|
||||
traefik:
|
||||
image: traefik:v3.0
|
||||
command:
|
||||
- "--api.insecure=true"
|
||||
- "--providers.docker=true"
|
||||
- "--entrypoints.web.address=:80"
|
||||
- "--entrypoints.websecure.address=:443"
|
||||
ports:
|
||||
- "80:80"
|
||||
- "443:443"
|
||||
volumes:
|
||||
- "/var/run/docker.sock:/var/run/docker.sock:ro"
|
||||
@@ -0,0 +1,44 @@
|
||||
services:
|
||||
wwv:
|
||||
image: ghcr.io/silvertakana/worldwideview:latest
|
||||
pull_policy: always
|
||||
ports:
|
||||
- "3100:3000"
|
||||
volumes:
|
||||
- wwv-data:/app/data
|
||||
env_file:
|
||||
- path: .env
|
||||
required: false
|
||||
environment:
|
||||
- "AUTH_SECRET=${AUTH_SECRET:-default_secret_for_local_dev}"
|
||||
- "WWV_DEMO_ADMIN_SECRET=${WWV_DEMO_ADMIN_SECRET:-}"
|
||||
- "WWV_BRIDGE_TOKEN=${WWV_BRIDGE_TOKEN:-}"
|
||||
- "DATABASE_URL=${DATABASE_URL:-postgresql://postgres:postgres@db:5432/worldwideview?schema=public}"
|
||||
# Provide the explicit public or host IP of the data engine for the frontend to use
|
||||
- "NEXT_PUBLIC_WWV_PLUGIN_DATA_ENGINE_URL=http://192.168.68.69:5002/stream"
|
||||
restart: unless-stopped
|
||||
depends_on:
|
||||
db:
|
||||
condition: service_healthy
|
||||
|
||||
db:
|
||||
image: postgres:15-alpine
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
POSTGRES_USER: postgres
|
||||
POSTGRES_PASSWORD: postgres
|
||||
POSTGRES_DB: worldwideview
|
||||
ports:
|
||||
- "5433:5432"
|
||||
volumes:
|
||||
- postgres-data:/var/lib/postgresql/data
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "pg_isready -U postgres -d worldwideview"]
|
||||
interval: 5s
|
||||
timeout: 5s
|
||||
retries: 5
|
||||
start_period: 60s
|
||||
|
||||
volumes:
|
||||
wwv-data:
|
||||
postgres-data:
|
||||
@@ -0,0 +1,35 @@
|
||||
services:
|
||||
wwv-data-engine:
|
||||
image: ghcr.io/silvertakana/wwv-data-engine:latest
|
||||
pull_policy: always
|
||||
ports:
|
||||
- '5002:5000'
|
||||
env_file:
|
||||
- path: .env
|
||||
required: false
|
||||
environment:
|
||||
- PORT=5000
|
||||
- REDIS_URL=redis://wwv-redis:6379
|
||||
- DOWNLOAD_SEEDERS=true
|
||||
- GITHUB_PAT=${GITHUB_PAT:-}
|
||||
- DB_PATH=/app/data/engine.db
|
||||
depends_on:
|
||||
wwv-redis:
|
||||
condition: service_healthy
|
||||
volumes:
|
||||
- wwv-engine-data:/app/data
|
||||
- wwv-seeders:/app/seeders
|
||||
restart: unless-stopped
|
||||
|
||||
wwv-redis:
|
||||
image: redis:7-alpine
|
||||
restart: unless-stopped
|
||||
healthcheck:
|
||||
test: ['CMD', 'redis-cli', 'ping']
|
||||
interval: 5s
|
||||
timeout: 3s
|
||||
retries: 5
|
||||
|
||||
volumes:
|
||||
wwv-engine-data:
|
||||
wwv-seeders:
|
||||
+76
-3
@@ -1,10 +1,21 @@
|
||||
services:
|
||||
wwv:
|
||||
build: .
|
||||
build:
|
||||
context: .
|
||||
args:
|
||||
- NEXT_PUBLIC_WWV_EDITION=${NEXT_PUBLIC_WWV_EDITION:-local}
|
||||
- NEXT_PUBLIC_WWV_PLUGIN_DATA_ENGINE_URL=${NEXT_PUBLIC_WWV_PLUGIN_DATA_ENGINE_URL:-}
|
||||
- NEXT_PUBLIC_SUPABASE_URL=${NEXT_PUBLIC_SUPABASE_URL:-}
|
||||
- NEXT_PUBLIC_SUPABASE_ANON_KEY=${NEXT_PUBLIC_SUPABASE_ANON_KEY:-}
|
||||
- NEXT_PUBLIC_GOOGLE_MAPS_API_KEY=${NEXT_PUBLIC_GOOGLE_MAPS_API_KEY:-}
|
||||
- NEXT_PUBLIC_BING_MAPS_KEY=${NEXT_PUBLIC_BING_MAPS_KEY:-}
|
||||
- NEXT_PUBLIC_CESIUM_ION_TOKEN=${NEXT_PUBLIC_CESIUM_ION_TOKEN:-}
|
||||
- NEXT_PUBLIC_ADSENSE_CLIENT_ID=${NEXT_PUBLIC_ADSENSE_CLIENT_ID:-}
|
||||
ports:
|
||||
- "3000:3000"
|
||||
volumes:
|
||||
- wwv-data:/app/data
|
||||
- ./public/plugins-local:/app/public/plugins-local:ro
|
||||
env_file:
|
||||
- path: .env
|
||||
required: false
|
||||
@@ -12,10 +23,72 @@ services:
|
||||
- "AUTH_SECRET=${AUTH_SECRET:-default_secret_for_local_dev}"
|
||||
- "WWV_DEMO_ADMIN_SECRET=${WWV_DEMO_ADMIN_SECRET:-}"
|
||||
- "WWV_BRIDGE_TOKEN=${WWV_BRIDGE_TOKEN:-}"
|
||||
- "DATABASE_URL=postgresql://postgres:postgres@db:5432/worldwideview?schema=public"
|
||||
depends_on:
|
||||
db:
|
||||
condition: service_healthy
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "wget --no-verbose --tries=1 --spider http://localhost:3000/api/health || exit 1"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
start_period: 30s
|
||||
restart: unless-stopped
|
||||
|
||||
volumes:
|
||||
wwv-data:
|
||||
db:
|
||||
image: postgres:15-alpine
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
POSTGRES_USER: postgres
|
||||
POSTGRES_PASSWORD: postgres
|
||||
POSTGRES_DB: worldwideview
|
||||
ports:
|
||||
- "${WWV_DB_PORT:-5432}:5432"
|
||||
volumes:
|
||||
- postgres-data:/var/lib/postgresql/data
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "pg_isready -U postgres -d worldwideview"]
|
||||
interval: 5s
|
||||
timeout: 5s
|
||||
retries: 5
|
||||
start_period: 60s
|
||||
|
||||
wwv-data-engine:
|
||||
image: ghcr.io/silvertakana/wwv-data-engine:latest
|
||||
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/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"
|
||||
environment:
|
||||
- PORT=5000
|
||||
- REDIS_URL=redis://wwv-redis:6379
|
||||
- SEEDERS_DIR=/app/seeders
|
||||
- DB_PATH=/app/data/engine.db
|
||||
depends_on:
|
||||
wwv-redis:
|
||||
condition: service_healthy
|
||||
restart: unless-stopped
|
||||
profiles:
|
||||
- engine
|
||||
|
||||
wwv-redis:
|
||||
image: redis:7-alpine
|
||||
healthcheck:
|
||||
test: ['CMD', 'redis-cli', 'ping']
|
||||
interval: 5s
|
||||
timeout: 3s
|
||||
retries: 5
|
||||
profiles:
|
||||
- engine
|
||||
|
||||
networks:
|
||||
coolify:
|
||||
external: true
|
||||
|
||||
volumes:
|
||||
wwv-data:
|
||||
postgres-data:
|
||||
+38
-5
@@ -1,14 +1,47 @@
|
||||
#!/bin/sh
|
||||
# ─── Docker Entrypoint ───────────────────────────────────────
|
||||
# Ensures the SQLite database exists and is migrated before
|
||||
# starting the application. On first run with a fresh volume
|
||||
# the DB file won't exist yet, so we run prisma migrate deploy.
|
||||
# Ensures the PostgreSQL database is migrated before starting
|
||||
# the application. DATABASE_URL must point to a PostgreSQL
|
||||
# instance (Supabase, self-hosted, etc).
|
||||
|
||||
set -e
|
||||
|
||||
mkdir -p ./data
|
||||
if [ -z "$DATABASE_URL" ]; then
|
||||
echo "────────────────────────────────────────────────────────────────"
|
||||
echo "🚨 CRITICAL: DATABASE_URL IS NOT SET"
|
||||
echo "────────────────────────────────────────────────────────────────"
|
||||
echo "WorldWideView has migrated to PostgreSQL. If you are an old user,"
|
||||
echo "please update your docker-compose.yml to include a Postgres service."
|
||||
echo ""
|
||||
echo "To migrate your legacy data after setting up Postgres, run:"
|
||||
echo "docker exec -it <container_name> node scripts/migrate-legacy.mjs"
|
||||
echo "────────────────────────────────────────────────────────────────"
|
||||
|
||||
# If dev.db exists, we know they are upgrading. Don't crash, just wait for config.
|
||||
if [ -f "prisma/dev.db" ]; then
|
||||
echo "[entrypoint] Legacy data detected. Waiting for DATABASE_URL to be configured..."
|
||||
# We don't exit here, we'll let the app try to start or just sleep.
|
||||
# For now, let's just let it proceed so they can see the setup page error.
|
||||
else
|
||||
echo "[entrypoint] Exiting. Please provide a DATABASE_URL."
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
echo "[entrypoint] Running database migrations..."
|
||||
npx -y prisma migrate deploy
|
||||
prisma migrate deploy
|
||||
echo "[entrypoint] Migrations complete."
|
||||
|
||||
# Generate self-signed SSL certificates for local HTTPS bridging if they don't exist
|
||||
if [ ! -f "./data/localhost.crt" ] || [ ! -f "./data/localhost.key" ]; then
|
||||
echo "[entrypoint] Generating self-signed SSL certificates for port 3001..."
|
||||
mkdir -p ./data
|
||||
openssl req -nodes -new -x509 -keyout ./data/localhost.key -out ./data/localhost.crt -days 365 -subj "/CN=localhost" 2>/dev/null || echo "[entrypoint] Warning: Failed to generate SSL certs"
|
||||
fi
|
||||
|
||||
# Start the HTTPS proxy in the background
|
||||
if [ -f "./scripts/https-proxy.mjs" ]; then
|
||||
node ./scripts/https-proxy.mjs &
|
||||
fi
|
||||
|
||||
exec node server.js
|
||||
+193
-26
@@ -1,33 +1,200 @@
|
||||
<!-- Generated: 2026-04-23 06:11:00 UTC -->
|
||||
# Architecture
|
||||
|
||||
## Overview
|
||||
WorldWideView operates on a decoupled, plugin-based architecture designed for real-time visualization of geospatial data. The system is split between a Next.js 16 frontend that handles UI and CesiumJS 3D rendering, and a network of plugin data seeders that stream live updates via WebSockets.
|
||||
WorldWideView is a **real-time geospatial intelligence engine**: a Next.js 16 frontend that renders live global data on a CesiumJS 3D globe, fed by a network of independent data seeders streaming over WebSockets. The whole platform is built on an "All-Bundle" plugin architecture, so data sources are decoupled from the core viewer and can be added, removed, or hot-swapped without touching rendering code.
|
||||
|
||||
The core design philosophy is the "All-Bundle Model," where plugins are dynamically imported at runtime as ES module bundles (`Dynamic CDN Loaded`). The frontend maintains a modular state architecture using Zustand, routing high-frequency data updates through a custom `DataBus` singleton to avoid React render cycle bottlenecks.
|
||||
This document is the deep-dive companion to the [README](../README.md). It is intended for human contributors who want to understand how the pieces fit before opening their first PR. For agent-facing rules and conventions, see [`AGENTS.md`](../AGENTS.md) at the repo root and the documents under [`.agents/rules/`](../.agents/rules/).
|
||||
|
||||
## Component Map
|
||||
- **Frontend App Shell:** Next.js App Router providing layout and base API routes (in `src/app/`).
|
||||
- **Globe Rendering Engine:** CesiumJS wrapped in Resium, responsible for 3D primitive and model rendering (in `src/core/globe/`).
|
||||
- **State Management:** Zustand slice-based architecture (in `src/core/state/`).
|
||||
- **Data Pipeline:** Custom event bus (`DataBus`) and WebSocket clients (`DataBusSubscriber`) routing live data to state (in `src/core/data/`).
|
||||
- **Plugin System:** Registration, lifecycle management, and ES module loaders (in `src/core/plugins/`).
|
||||
- **Database Layer:** Prisma ORM connecting to local SQLite or cloud PostgreSQL (in `prisma/`).
|
||||
## System Overview
|
||||
|
||||
## Key Files
|
||||
- `src/core/plugins/PluginManager.ts` - The PluginManager class. Core registry that instantiates plugins, calls `initialize()`, and handles lifecycle events.
|
||||
- `src/core/plugins/loaders/InstalledPluginsLoader.ts` - Dynamically fetches and imports `import(/* webpackIgnore: true */ ...)` marketplace plugins into the environment.
|
||||
- `src/core/data/DataBus.ts` - Custom typed event bus singleton that routes high-frequency data around the application.
|
||||
- `src/core/globe/GlobeView.tsx` - The main Cesium viewer container, handling imagery layers, cameras, and primitive collections.
|
||||
- `src/core/state/store.ts` - The main Zustand store registry linking the nine state slices (globe, layers, timeline, ui, filter, data, config, favorites, geojson).
|
||||
```mermaid
|
||||
flowchart TD
|
||||
subgraph "Data Sources"
|
||||
A[Public APIs] -->|Poll| B[Data Engine Seeders]
|
||||
C[Custom Microservices] -->|Stream| B
|
||||
end
|
||||
|
||||
## Data Flow
|
||||
Real-time data follows a strict unidirectional stream optimized for sub-second updates:
|
||||
subgraph "Engine Tier"
|
||||
B -->|WebSocket /stream| D[WsClient]
|
||||
end
|
||||
|
||||
1. **Engine Push:** A remote data engine pushes state over WebSocket (`/stream`) from either local seeders (`ws://localhost:5001/stream`) or the cloud fallback (`wss://dataengine.worldwideview.dev/stream`).
|
||||
2. **WebSocket Client Router:** `WsClient.handleMessage()` receives the payload and pipes it to the event bus.
|
||||
3. **DataBus Emission:** The bus fires `DataBus.emit("websocketData", WsStreamPayload)`.
|
||||
4. **State Hydration:** The `DataBusSubscriber` component listens to the bus and calls `_hydrateSnapshot()` to update the Zustand store's `entitiesByPlugin` cache.
|
||||
5. **Memoized Selection:** `GlobeView` selects the visible entities from the store.
|
||||
6. **Primitive Rendering:** The `EntityRenderer` translates store entities into Cesium `PointPrimitiveCollection` and `BillboardCollection` arrays for GPU rendering.
|
||||
7. **Animation & LOD:** `AnimationLoop` handles horizon culling and hover effects, while `useModelRendering` promotes close-range entities to 3D glTF models.
|
||||
subgraph "Frontend Pipeline"
|
||||
D --> E[DataBus<br/>typed pub/sub]
|
||||
E -->|"_hydrateSnapshot()"| F[Zustand Store<br/>9 slices]
|
||||
F -->|Memoized visible entities| G[EntityRenderer]
|
||||
G -->|Primitive collections| H[CesiumJS Globe]
|
||||
H --> I[AnimationLoop<br/>horizon culling + LOD]
|
||||
end
|
||||
|
||||
subgraph "Plugin Layer"
|
||||
J[PluginRegistry] -->|"loadPluginFromManifest"| K[Dynamic ES module imports]
|
||||
J -.->|register| E
|
||||
end
|
||||
```
|
||||
|
||||
The strict unidirectional flow — engine → bus → store → renderer — is what lets the system push sub-second updates for thousands of entities without React render-cycle bottlenecks.
|
||||
|
||||
## Plugin System (Core Abstraction)
|
||||
|
||||
Every data source in WorldWideView is a **plugin** implementing the `WorldPlugin` interface from [`@worldwideview/wwv-plugin-sdk`](../packages/wwv-plugin-sdk/). The plugin's lifecycle plugs into a real-time WebSocket firehose:
|
||||
|
||||
```text
|
||||
PluginRegistry.register() → PluginManager.registerPlugin()
|
||||
→ plugin.initialize(context)
|
||||
|
||||
Visibility Toggle → DataBusSubscriber subscribes to layer via WsClient
|
||||
→ Engine responds with instantaneous WebSocket snapshots over /stream
|
||||
→ WsClient pipes to DataBus.emit("dataUpdated", WsStreamPayload)
|
||||
→ Store → EntityRenderer → Globe
|
||||
```
|
||||
|
||||
Four plugin architectures coexist under the "All-Bundle Model":
|
||||
|
||||
1. **Data Engine Seeder** — A lightweight `seeder.mjs` script run by the dynamic `wwv-data-engine` runner. (Previously a standalone microservice container; the runner replaces that.)
|
||||
2. **Dynamic CDN Loaded (Bundle)** — Externally developed plugins, dynamically imported at runtime via ES module CDNs (e.g. version-pinned `unpkg.com` URLs).
|
||||
3. **Static Compiled (Bundle)** — Static GeoJSON data wrapped into JS bundles via `wwvStaticCompiler` during build/sync. (Previously `StaticDataPlugin`.)
|
||||
4. **Active Proxied (Bundle)** — Next.js API routes bundled to mediate frontend interactions. (Previously `DeclarativePlugin`.)
|
||||
|
||||
All four are now dynamically imported at runtime as ES module bundles via `loadPluginFromManifest`, which uses `import(/* webpackIgnore: true */ entry)`. The legacy `StaticDataPlugin` and `DeclarativePlugin` runtimes are fully deprecated.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Plugin types are re-exported from the SDK through `src/core/plugins/PluginTypes.ts` and `src/core/plugins/PluginManifest.ts`. The **source of truth is always `@worldwideview/wwv-plugin-sdk`** — never define plugin types locally.
|
||||
|
||||
For the contributor checklist when authoring a plugin, see [`.agents/skills/worldwideview-plugin-creation/`](../.agents/skills/) and the [Plugin Quickstart](plugin-quickstart.md).
|
||||
|
||||
## State Management
|
||||
|
||||
WorldWideView uses a Zustand store split into **nine slices**, each in its own file under [`src/core/state/`](../src/core/state/):
|
||||
|
||||
| Slice | Responsibility |
|
||||
|---|---|
|
||||
| `globe` | Camera position, imagery layers, scene settings |
|
||||
| `layers` | Per-plugin visibility toggles |
|
||||
| `timeline` | Playback range, current time, play/pause |
|
||||
| `ui` | Panel open/closed states, selected entity |
|
||||
| `filter` | Plugin filter expressions, applied via `filterEngine` |
|
||||
| `data` | Entity cache (`entitiesByPlugin`), websocket connection state |
|
||||
| `config` | Plugin settings, polling intervals, API keys |
|
||||
| `favorites` | User-bookmarked entities |
|
||||
| `geojson` | Custom GeoJSON overlays |
|
||||
|
||||
Access patterns:
|
||||
|
||||
- React components: `const camera = useStore((s) => s.camera);`
|
||||
- Outside React (animation loop, hooks setup): `const state = useStore.getState();`
|
||||
- Plugin settings: `configSlice.dataConfig.pluginSettings[pluginId]`
|
||||
- Polling intervals: `configSlice.dataConfig.pollingIntervals[pluginId]`
|
||||
|
||||
The animation loop deliberately snapshots state once per frame via `getState()` rather than subscribing — `requestAnimationFrame` is the loop driver, so adding a Zustand subscription would just duplicate ticks.
|
||||
|
||||
## Data Pipeline
|
||||
|
||||
Real-time data follows a strict unidirectional path optimised for sub-second updates:
|
||||
|
||||
```text
|
||||
Engine push /stream → DataBusSubscriber WsClient router
|
||||
→ WsClient.handleMessage() → DataBus.emit("websocketData", WsStreamPayload)
|
||||
→ DataBusSubscriber → _hydrateSnapshot() → Store.entitiesByPlugin
|
||||
→ GlobeView (memoised visible entities)
|
||||
→ EntityRenderer (billboard/point primitives)
|
||||
→ AnimationLoop (horizon culling, hover/selection)
|
||||
→ StackManager (co-located entity grouping)
|
||||
```
|
||||
|
||||
The `DataBus` is a custom typed pub/sub singleton (see [`src/core/data/DataBus.ts`](../src/core/data/DataBus.ts)). It exists specifically to bypass React's render cycle for high-frequency events — store updates are batched into the Zustand store, but raw stream events ride the bus directly.
|
||||
|
||||
## Data Engine & Seeders
|
||||
|
||||
The data engine ([`wwv-data-engine`](https://github.com/silvertakana/wwv-data-engine), public) is a **content-agnostic runner**. It discovers and executes seeder scripts from a configurable directory; the engine itself knows nothing about specific data sources.
|
||||
|
||||
- **Local development**: The engine runs via Docker Compose on port 5001, reading seeders dynamically from `local-seeders/` (split into `community` and `private` tiers).
|
||||
- **Production**: The engine container on Coolify downloads release bundles from `wwv-seeders-community` and `wwv-seeders-private` on startup, unzipping them into `/app/seeders`.
|
||||
- **Split-routing**: `resolveEngineUrl` prioritises the local dev engine (`ws://localhost:5001/stream`) for local testing — 12-Factor App methodology — and falls back to cloud-hosted endpoints (e.g. `wss://dataenginev2.worldwideview.dev/stream`) when nothing local is available.
|
||||
|
||||
### Agnostic Frontend
|
||||
|
||||
WorldWideView's frontend is a **completely agnostic renderer**. It has no concept of a "unified" data engine. If 30 plugins each declare a different `streamUrl`, the application opens 30 WebSocket connections; it just so happens that the default plugin set shares `wwv-data-engine`, but the platform is 100% decentralised.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Each plugin is a self-contained package and **MUST explicitly declare its own `streamUrl` in its manifest or config.** Do not assume the frontend acts as a unified pipe.
|
||||
|
||||
### Dual-Output Engine
|
||||
|
||||
Each seeder automatically exposes both a WebSocket stream (`/stream`) and a REST API endpoint (`/api/[plugin-id]`). Plugins can consume either depending on their data shape — bursty / live → stream, slow-moving / on-demand → REST.
|
||||
|
||||
### Scope Boundary (the 99 / 1 Rule)
|
||||
|
||||
The engine handles standard caching and broadcasting — the 99% case. Plugins that require complex on-demand compute (the 1%) must host their own custom backend; the engine intentionally does not grow features for them.
|
||||
|
||||
## Rendering Pipeline
|
||||
|
||||
The renderer is where most of WorldWideView's engineering depth lives. Three design choices drive the performance envelope:
|
||||
|
||||
### Primitive-based rendering
|
||||
|
||||
We use [`PointPrimitiveCollection`](https://cesium.com/learn/cesiumjs/ref-doc/PointPrimitiveCollection.html), `BillboardCollection`, `LabelCollection`, and `PolylineCollection` directly — **not** the Cesium Entity API. The Entity API is convenient but allocates per-entity ECS-style state that gets expensive past a few thousand entities. Primitive collections batch their state into typed GPU buffers, so 10k+ live entities still hold 60 fps on a moderate laptop.
|
||||
|
||||
Collections are tracked per-viewer via a module-level `WeakMap<CesiumViewer, PrimitiveCollections>` in [`src/core/globe/EntityRenderer.ts`](../src/core/globe/EntityRenderer.ts), keeping the renderer multi-viewer-capable and ensuring collections GC cleanly when a viewer is torn down.
|
||||
|
||||
### Chunked processing
|
||||
|
||||
Large datasets (10k+ entities) are rendered via [`ChunkedProcessor`](../src/core/globe/ChunkedProcessor.ts) in 500-entity chunks across multiple microtasks, so adding a new plugin layer never blocks the main thread long enough to drop a frame.
|
||||
|
||||
### Horizon culling and LOD
|
||||
|
||||
The animation loop performs **manual horizon culling** in [`AnimationLoop.ts`](../src/core/globe/AnimationLoop.ts) using a single dot-product against the Earth radius — much cheaper than depth-testing thousands of primitives every frame, and tunable for "entities just below the horizon should still be visible" semantics that depth-testing can't express.
|
||||
|
||||
Entities of `type: "model"` are promoted to full 3D glTF models at close range via the LOD system in [`useModelRendering.ts`](../src/core/globe/hooks/useModelRendering.ts) — so an aircraft at 50 nm range is a tinted billboard, but at 5 nm it's a textured plane model with the right wing geometry.
|
||||
|
||||
### Stack / Spiderifier
|
||||
|
||||
When multiple entities share a screen-space cluster (busy ports, busy airspaces), [`StackManager`](../src/core/globe/StackManager.ts) groups them and [`stackAnimation`](../src/core/globe/stackAnimation.ts) handles the spiderification expansion when a stack is clicked.
|
||||
|
||||
### Entity-type rules
|
||||
|
||||
> [!WARNING]
|
||||
> When returning `CesiumEntityOptions` from a plugin's `renderEntity()`:
|
||||
>
|
||||
> - **Points**: Use `type: "point"` with `color`, `size`, `outlineColor`, `outlineWidth`.
|
||||
> - **Billboards**: Use `type: "billboard"` with `iconUrl`, `color`, `iconScale`.
|
||||
> - **NEVER mix**: Do not set `size` / `outlineWidth` / `outlineColor` on a billboard — Cesium silently clips the GPU upload and the icon disappears.
|
||||
|
||||
## Edition System
|
||||
|
||||
WorldWideView ships in three editions, controlled by the `NEXT_PUBLIC_WWV_EDITION` environment variable. Feature flags are derived from this in [`src/core/edition.ts`](../src/core/edition.ts).
|
||||
|
||||
| Edition | Auth | Use case |
|
||||
|---|---|---|
|
||||
| `local` | Enabled (NextAuth credentials) | Self-hosted single-user / small-team deployments |
|
||||
| `cloud` | Enabled | Managed cloud instance with multi-tenancy |
|
||||
| `demo` | Disabled (optional admin via `WWV_DEMO_ADMIN_SECRET`) | Public demo deployments |
|
||||
|
||||
Edition isn't just an auth toggle — it also gates which marketplace endpoints are queried, which default plugins boot, and whether destructive admin actions are reachable.
|
||||
|
||||
## Key Source Files
|
||||
|
||||
Quick map of the load-bearing modules:
|
||||
|
||||
| Path | Role |
|
||||
|---|---|
|
||||
| [`src/core/plugins/PluginManager.ts`](../src/core/plugins/PluginManager.ts) | Core plugin registry. Instantiates plugins, calls `initialize()`, manages lifecycle. |
|
||||
| [`src/core/plugins/loaders/InstalledPluginsLoader.ts`](../src/core/plugins/loaders/InstalledPluginsLoader.ts) | Dynamic ES module loader for marketplace plugins (`import(/* webpackIgnore: true */ entry)`). |
|
||||
| [`src/core/data/DataBus.ts`](../src/core/data/DataBus.ts) | Typed pub/sub singleton — the high-frequency event channel. |
|
||||
| [`src/core/data/WsClient.ts`](../src/core/data/WsClient.ts) | WebSocket router. Pipes engine `/stream` messages onto the DataBus. |
|
||||
| [`src/core/globe/GlobeView.tsx`](../src/core/globe/GlobeView.tsx) | The Cesium viewer container. Imagery layers, camera setup, primitive collection wiring. |
|
||||
| [`src/core/globe/EntityRenderer.ts`](../src/core/globe/EntityRenderer.ts) | Translates store entities into Cesium primitives. Hot path for 10k+ entities. |
|
||||
| [`src/core/globe/AnimationLoop.ts`](../src/core/globe/AnimationLoop.ts) | Per-frame update: horizon culling, hover/selection, model LOD promotion. |
|
||||
| [`src/core/state/store.ts`](../src/core/state/store.ts) | Zustand store registry linking the nine slices. |
|
||||
|
||||
## Further Reading
|
||||
|
||||
For deeper coverage of specific subsystems, see the rule files under [`.agents/rules/`](../.agents/rules/):
|
||||
|
||||
- [`platform-architecture.md`](../.agents/rules/platform-architecture.md) — high-level platform goals, product vision, Edition System
|
||||
- [`application-architecture.md`](../.agents/rules/application-architecture.md) — Next.js frontend, Zustand, CesiumJS integration
|
||||
- [`plugin-architecture.md`](../.agents/rules/plugin-architecture.md) — plugin lifecycle, capability declarations, seeders
|
||||
- [`marketplace-architecture.md`](../.agents/rules/marketplace-architecture.md) — dynamic plugin installation, DB sync, CDN loading
|
||||
- [`cesium-rendering.md`](../.agents/rules/cesium-rendering.md) — globe rendering, entity types, primitives, LOD, culling
|
||||
- [`state-management.md`](../.agents/rules/state-management.md) — slice access patterns, plugin settings
|
||||
- [`data-engine-architecture.md`](../.agents/rules/data-engine-architecture.md) — engine internals, seeder loading, workspace dependencies
|
||||
|
||||
For getting started as a contributor, see [Development](development.md), [Plugin Quickstart](plugin-quickstart.md), and [Plugin Advanced](plugin-advanced.md).
|
||||
@@ -0,0 +1,166 @@
|
||||
# Agent Bus — driving WWV from external tools
|
||||
|
||||
## Overview
|
||||
|
||||
The Agent Bus is an opt-in HTTP+SSE surface that lets a trusted external process — most commonly a [Model Context Protocol](https://modelcontextprotocol.io) (MCP) server fronting an LLM agent — drive the running WWV browser session. The agent can fly the globe, toggle layers, focus entities, and select things by posting JSON actions to a server endpoint, which fans them out over SSE to every browser tab belonging to the same logged-in user.
|
||||
|
||||
Read-only camera and engine queries already work via the existing REST API. The Agent Bus is the missing **write path**.
|
||||
|
||||
```
|
||||
LLM client ──MCP──▶ szski/wwv-mcp ──HTTP──▶ /api/agent/publish ──SSE──▶ browser
|
||||
(Claude, Cursor, …) (separate repo) (this PR adds these) (Cesium flies)
|
||||
```
|
||||
|
||||
## Enabling the bus
|
||||
|
||||
The bus is **off by default**. The subscriber early-returns and no SSE connection is opened. You explicitly opt in via a build-time environment variable.
|
||||
|
||||
### In Docker
|
||||
|
||||
Pass the ARG at build time:
|
||||
|
||||
```sh
|
||||
docker build \
|
||||
--build-arg NEXT_PUBLIC_WWV_AGENT_BUS_ENABLED=true \
|
||||
-t worldwideview .
|
||||
```
|
||||
|
||||
### In a Coolify / hosted build
|
||||
|
||||
Set `NEXT_PUBLIC_WWV_AGENT_BUS_ENABLED=true` in the build environment. Because it's a `NEXT_PUBLIC_*` variable, it is inlined into the JavaScript bundle at `next build` time — runtime-only env changes will not enable it.
|
||||
|
||||
### Verifying it's on
|
||||
|
||||
On a fresh page load, open the browser DevTools console. You should see a one-line build banner:
|
||||
|
||||
```
|
||||
[wwv build] id=1714572934123 built_at=2026-05-13T18:35:34Z agent_bus=on
|
||||
```
|
||||
|
||||
If `agent_bus=off` after enabling the env var, the build did not pick up the variable — re-check that it was passed as `--build-arg` (Docker) or set before `next build` ran (other hosts).
|
||||
|
||||
You can also hit `/api/build` to confirm the served bundle's build id and flag state.
|
||||
|
||||
## Using it — quick smoke test with curl
|
||||
|
||||
To verify the bus end-to-end without an MCP server, log into WWV in your browser, grab your `__Secure-authjs.session-token` cookie value from DevTools, and POST an action:
|
||||
|
||||
```sh
|
||||
curl -X POST https://your-wwv-host/api/agent/publish \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "Cookie: __Secure-authjs.session-token=PASTE_TOKEN_HERE" \
|
||||
-d '{"action":"fly_to","lat":35.7796,"lon":-78.6382,"distance":50000}'
|
||||
```
|
||||
|
||||
If the bus is enabled and the cookie is valid, the open tab will fly to Raleigh and the response will be:
|
||||
|
||||
```json
|
||||
{ "ok": true, "delivered": 1, "subscribers": 1 }
|
||||
```
|
||||
|
||||
`subscribers: 0` means the bus is off in the build, the cookie's user has no open tabs, or the env var wasn't applied — see *Verifying* above.
|
||||
|
||||
## Using it — wiring an MCP server
|
||||
|
||||
The reference MCP server for WWV is published at **[szski/wwv-mcp](https://github.com/szski/wwv-mcp)**. It exposes 15 tools (`globe_fly_to`, `layer_toggle`, `engine_query`, `geocode`, `system_status`, etc.) and works with any MCP-aware client (Claude Code, Claude Desktop, Cursor, Continue, Cline).
|
||||
|
||||
> [!NOTE]
|
||||
> `szski/wwv-mcp` lives in a contributor's namespace today and may move under the project's own organization later. Update the install URL accordingly when that happens.
|
||||
|
||||
### Install (Node)
|
||||
|
||||
```sh
|
||||
git clone https://github.com/szski/wwv-mcp
|
||||
cd wwv-mcp
|
||||
npm install
|
||||
npm run build
|
||||
```
|
||||
|
||||
Then store credentials so the MCP server can auto-login at startup:
|
||||
|
||||
```sh
|
||||
mkdir -p ~/.config/wwv-mcp
|
||||
cat > ~/.config/wwv-mcp/credentials <<'EOF'
|
||||
[email protected]
|
||||
WWV_PASSWORD=your-password
|
||||
EOF
|
||||
chmod 600 ~/.config/wwv-mcp/credentials
|
||||
```
|
||||
|
||||
### Install (Docker)
|
||||
|
||||
If a published image exists at `szski/wwv-mcp` (or wherever the maintainer mirrors it), no install step is needed — the MCP client config below uses `docker run` to launch the server on demand.
|
||||
|
||||
### Client config — Claude Code
|
||||
|
||||
Edit `~/.claude/settings.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"wwv": {
|
||||
"command": "node",
|
||||
"args": ["/absolute/path/to/wwv-mcp/dist/index.js"],
|
||||
"env": {
|
||||
"WWV_BASE_URL": "https://your-wwv-host.example",
|
||||
"WWV_ENGINE_URL": "http://localhost:5001"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Or, with Docker:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"wwv": {
|
||||
"command": "docker",
|
||||
"args": [
|
||||
"run", "-i", "--rm",
|
||||
"-e", "WWV_BASE_URL=http://host.docker.internal:3000",
|
||||
"-e", "WWV_ENGINE_URL=http://host.docker.internal:5001",
|
||||
"szski/wwv-mcp:latest"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Then `/mcp` in Claude Code should list `wwv` with all 15 tools.
|
||||
|
||||
### Client config — Claude Desktop
|
||||
|
||||
Edit `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows). The `mcpServers.wwv` block is identical to Claude Code above.
|
||||
|
||||
### Client config — Cursor, Continue, Cline
|
||||
|
||||
Each of these reads an MCP server list in its own settings UI but the shape of the entry — `command` + `args` + `env` — is the same as Claude Code's. See your client's MCP docs for the exact location of its config file.
|
||||
|
||||
### Verifying the wiring
|
||||
|
||||
Once configured, ask the agent something like *"What's the status of the WWV system?"* — it should call `system_status` and report back. If you see `agent_bus_enabled: false`, the bus is off in the WWV build; fix that before trying write tools like `globe_fly_to`.
|
||||
|
||||
## Security and multi-tenancy
|
||||
|
||||
- **Default off.** Without the env var, the subscriber doesn't open a connection, the publish endpoint exists but has no subscribers, and the bundle's dead-code elimination removes the `EventSource` constructor entirely.
|
||||
- **Auth gated.** Both `/api/agent/publish` and `/api/agent/stream` use the same `auth()` helper as the rest of the marketplace API. No tokens — just the existing Auth.js session cookie.
|
||||
- **Per-user scoping.** Subscriptions live in `Map<userId, …>`, so a publish from user A's session never reaches user B's stream, even though both sit on the same Node process. Multi-tenant deployments are safe.
|
||||
- **Same trust model as a browser tab.** An MCP server "acts as the user" by holding the user's session cookie. If you wouldn't trust a browser tab on the same machine, don't give an MCP server the cookie.
|
||||
- **Single-process only.** The `AgentBus` is in-memory and process-local. Multi-instance deployments behind a load balancer would need a Redis pub/sub adapter — about 30 lines of additional code, not included here.
|
||||
|
||||
## Endpoint reference
|
||||
|
||||
| Method | Path | Purpose |
|
||||
|---|---|---|
|
||||
| `GET` | `/api/agent/stream` | SSE channel. Auth-gated. Streams `AgentAction` JSON events for the connected user. Heartbeat every 25s. |
|
||||
| `POST` | `/api/agent/publish` | Accept an `AgentAction` JSON body, broadcast to the publishing user's subscribers, return `{ok, delivered, subscribers}`. |
|
||||
| `GET` | `/api/build` | Build id + ISO timestamp + `NEXT_PUBLIC_*` flag state. Used by `AgentBusSubscriber` to print the build banner. |
|
||||
|
||||
`AgentAction` is currently a six-verb union: `fly_to`, `face_towards`, `layer_toggle`, `highlight_layer`, `select_entity`, `ping`. The shape is `{action: string, …payload}` JSON, so additive changes are backwards-compatible.
|
||||
|
||||
## Companion repos
|
||||
|
||||
- **[szski/wwv-mcp](https://github.com/szski/wwv-mcp)** — reference MCP server. 15 tools. Required for any LLM-driven use of the bus.
|
||||
- **[silvertakana/wwv-data-engine](https://github.com/silvertakana/wwv-data-engine)** — separate repo, supplies the read-only `engine_query` data that the MCP server's read tools wrap.
|
||||
+152
@@ -0,0 +1,152 @@
|
||||
# ADR-001: Decentralized Plugin Authentication & SSRF Mitigation
|
||||
|
||||
## Status
|
||||
Proposed *(Pending Review)*
|
||||
|
||||
## Date
|
||||
2026-05-14
|
||||
|
||||
## Related
|
||||
- **Dependencies:** `docs/ARCHITECTURE.md` (Agnostic Client principle), `prisma/schema.prisma` (existing Local App Postgres integration).
|
||||
|
||||
---
|
||||
|
||||
## Context
|
||||
|
||||
The WorldWideView ecosystem faces four interlocking security and scalability problems:
|
||||
|
||||
1. **The SSRF Liability:** The Local App uses generic proxy routes (`/api/camera/proxy`) to bypass browser CORS restrictions. These lack robust SSRF hardening (no DNS rebinding defense, no private IP blocking), exposing the host LAN.
|
||||
2. **The CORS Barrier:** Browser-enforced Cross-Origin Resource Sharing (CORS) prevents the agnostic frontend from connecting directly to independent Data Engines via standard HTTP.
|
||||
3. **The Centralization Bottleneck:** If every Data Engine queries the Marketplace database to verify a user's subscription on every frame, the Marketplace becomes a catastrophic bottleneck.
|
||||
4. **The Credential Interception Threat:** Passing credentials via simple URL redirects during setup exposes them to browser history theft and MITM attacks.
|
||||
|
||||
To resolve these, we are adopting an umbrella "Token Exchange" architecture, broken down into four specific decisions.
|
||||
|
||||
---
|
||||
|
||||
## Decisions
|
||||
|
||||
### ADR-001A: Direct WebSocket Data Plane
|
||||
We mandate that heavy data streams utilize WebSockets (`wss://`). Browsers do not apply CORS preflight to WebSockets, allowing direct connections.
|
||||
* **Security Constraint:** Because CORS is bypassed, Data Engines MUST explicitly validate the `Origin`, `Host`, TLS state, and expected tenant/plugin metadata upon connection.
|
||||
|
||||
### ADR-001B: Marketplace-Issued JWT Tickets
|
||||
To enforce monetization without centralized database queries, we implement a stateless Token Exchange via Asymmetric Cryptography (Ed25519).
|
||||
* **The JWT Contract:** The token MUST contain the following claims:
|
||||
* `iss`: `https://marketplace.worldwideview.dev`
|
||||
* `sub`: The user's unique ID.
|
||||
* `aud`: **Crucial.** The specific Data Engine or plugin ID. Tokens MUST be audience-bound to prevent a valid token for Engine A being replayed against Engine B.
|
||||
* `exp`: Expiration (exactly 5 minutes from issuance).
|
||||
* `iat`: Issued at.
|
||||
* `jti`: Unique token identifier.
|
||||
* `tier`: Subscription level (e.g., "pro").
|
||||
* `scope`: Specific entitlements.
|
||||
|
||||
### ADR-001C: PKCE Bootstrap (The API Key)
|
||||
The Local App acts as the credential holder. It uses the OAuth 2.0 Authorization Code flow with PKCE to securely acquire a **long-lived refresh credential** (The API Key).
|
||||
* **API Key Lifetime:** The API Key does not expire automatically but is bound to the specific device/installation. It rotates manually via the Marketplace UI or automatically upon suspicion of compromise.
|
||||
|
||||
### ADR-001D: SSRF Proxy Hardening
|
||||
For legacy plugins (e.g., Webcams) that *cannot* use WebSockets, the local proxy must be hardened.
|
||||
* **Constraints:** We will remove generic proxying where possible. Where proxying remains, we enforce:
|
||||
1. Exact HTTPS origin allowlists.
|
||||
2. Blocking of private / link-local / loopback IPs *after* DNS resolution.
|
||||
3. Re-resolving or pinning DNS to defend against DNS rebinding.
|
||||
4. Rejecting redirects to non-allowlisted hosts.
|
||||
5. Strict payload size and time limits.
|
||||
|
||||
---
|
||||
|
||||
## Threat Model & Non-Goals
|
||||
|
||||
**In Scope:**
|
||||
* Defending against external attackers on the user's LAN (via SSRF hardening).
|
||||
* Preventing interception of the long-lived API key during setup (via PKCE).
|
||||
* Preventing URL/Header credential leakage (via First-Message Auth).
|
||||
|
||||
**Non-Goals (Accepted Residual Risks):**
|
||||
* Defending against compromised Local App hosts (root OS access).
|
||||
* Defending against XSS in the Local App frontend (token theft via JS).
|
||||
* Defending against malicious browser extensions (full session access).
|
||||
* Real-time subscription revocation for *already issued* 5-minute tickets.
|
||||
|
||||
---
|
||||
|
||||
## 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.
|
||||
* **`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.
|
||||
|
||||
### 2. Hardened First-Message Auth
|
||||
Data Engines MUST enforce strict WebSocket handshake rules:
|
||||
1. **Silence until Auth:** The server MUST accept no subscription or data messages before auth succeeds.
|
||||
2. **Timeout:** Auth MUST complete within a short timeout (e.g., 3 seconds of connection).
|
||||
3. **Drop on Failure:** A failed auth immediately closes the socket with a `4003` code.
|
||||
4. **No Re-Auth:** Re-authentication on the same socket is forbidden.
|
||||
5. **Log Redaction:** All server logs MUST redact the JWT payload from capture.
|
||||
|
||||
### 3. API Key Encryption at Rest (Local App)
|
||||
The Local App stores the API Key in PostgreSQL. It MUST NOT be stored in plaintext.
|
||||
* **Algorithm:** AES-256-GCM.
|
||||
* **Key Derivation (KDF):** The encryption key is derived from `AUTH_SECRET` using PBKDF2 (100,000+ iterations) and a unique salt per installation.
|
||||
* **Nonce/Salt Storage:** The 96-bit nonce and the KDF salt are stored alongside the encrypted payload in the DB.
|
||||
* **Versioning:** The DB column must support key versioning (e.g., `v1:base64_nonce:base64_ciphertext`) to allow future `AUTH_SECRET` rotation without permanently bricking the DB.
|
||||
|
||||
---
|
||||
|
||||
## Failure-Mode Behavior
|
||||
|
||||
| Scenario | System Behavior |
|
||||
| :--- | :--- |
|
||||
| **Marketplace is down** | Local App cannot get new JWTs. Existing streams continue until the 5-min JWT expires. |
|
||||
| **Data Engine Cold Start (Marketplace down)** | Engine cannot fetch `jwks.json`. Engine **fails closed** and rejects all connections. |
|
||||
| **JWKS Cache expires (Marketplace down)** | Data Engine retains stale cache for a grace period, but eventually **fails closed**. |
|
||||
| **Redis is down (Marketplace)** | Ticket issuance falls back to PostgreSQL (slower, but functional). |
|
||||
| **Unknown `kid` arrives** | Data Engine immediately triggers a background re-fetch of `jwks.json`. If still unknown, rejects token. |
|
||||
| **Clocks drift beyond leeway** | Token is rejected (Next.js and Fastify default to 60s leeway). NTP sync is a hard operational requirement. |
|
||||
|
||||
---
|
||||
|
||||
## Revocation Latency
|
||||
|
||||
| Event | Time to take effect |
|
||||
| :--- | :--- |
|
||||
| **User cancels subscription** | Up to 5 minutes (bounded strictly by active JWT lifetime). |
|
||||
| **Admin rotates Ed25519 key** | Zero downtime (handled via key overlap in JWKS array). |
|
||||
| **User revokes API Key** | Immediate for *new* issuances, up to 5 minutes for active streams. |
|
||||
|
||||
---
|
||||
|
||||
## The End-to-End Auth Flow
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant U as User Browser
|
||||
participant L as Local App
|
||||
participant M as Marketplace
|
||||
participant E as Data Engine
|
||||
|
||||
Note over U,M: ADR-001C: PKCE bootstrap (once)
|
||||
U->>L: Click "Connect to Marketplace"
|
||||
L->>L: Generate code_verifier + challenge
|
||||
L->>U: Redirect to Marketplace with challenge
|
||||
U->>M: Authorize
|
||||
M->>U: Redirect with temp code
|
||||
U->>L: Forward temp code
|
||||
L->>M: POST temp code + code_verifier
|
||||
M->>L: API Key (Long-lived)
|
||||
L->>L: PBKDF2 + AES-GCM Encrypt & Store
|
||||
|
||||
Note over L,E: ADR-001B & A: Ongoing Data Plane
|
||||
loop every 4.5 minutes
|
||||
L->>M: POST API Key (Request audience: Engine A)
|
||||
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
|
||||
E->>U: Stream
|
||||
end
|
||||
```
|
||||
@@ -11,7 +11,7 @@ The core build configuration resides in `package.json` and `next.config.ts`. A c
|
||||
### Standard Development
|
||||
- **Install Dependencies:** `pnpm install` (Installs all workspace packages defined in `pnpm-workspace.yaml`).
|
||||
- **Initial Setup:** `pnpm run setup` (Executes `scripts/setup.mjs` to generate a `.env.local` with a fresh `AUTH_SECRET`).
|
||||
- **Run Development Server (All):** `pnpm dev:all` (Concurrently starts the Next.js frontend and the local `wwv-data-engine` backends).
|
||||
- **Run Development Server (All):** `pnpm dev:all` (Concurrently starts the Next.js frontend and the local `wwv-data-engine-v2` + Redis containers via Docker Compose).
|
||||
|
||||
### Production Build
|
||||
- **Build Command:** `pnpm build` (Executes `next build --webpack`).
|
||||
@@ -20,8 +20,8 @@ The core build configuration resides in `package.json` and `next.config.ts`. A c
|
||||
|
||||
## Platform Setup
|
||||
|
||||
- **Database Migrations:** Prisma schema is located at `prisma/schema.prisma`. During development, `pnpm dev` triggers a `predev` hook running `npx prisma migrate deploy` to ensure SQLite tables exist in `data/wwv.db`.
|
||||
- **Microservices:** Data engine seeders and standalone Fastify backend plugins (like `wwv-plugin-iranwarlive/backend`) are started via `pnpm start:backends` and managed locally inside `packages/*/backend`.
|
||||
- **Database Migrations:** Prisma schema is located at `prisma/schema.prisma`. During development, `pnpm dev` triggers a `predev` hook running `npx prisma migrate deploy` to ensure PostgreSQL tables are initialized.
|
||||
- **Data Engine:** The generic data engine runner and Redis cache are started via `docker compose up wwv-data-engine-v2 wwv-redis`. Custom data seeders are placed in the `local-seeders/community/` or `local-seeders/private/` sandboxes and dynamically loaded by the engine.
|
||||
- **Plugin Packages:** Internal plugin packages must be properly listed in `tsconfig.json` paths and `next.config.ts`'s `transpilePackages` array.
|
||||
|
||||
## Reference
|
||||
|
||||
+38
-6
@@ -10,25 +10,57 @@ WorldWideView utilizes a containerized deployment strategy based on Docker's mul
|
||||
- **Build Output:** Located at `.next/standalone/`.
|
||||
- **Static Assets:** Cesium static workers are injected at build time via `scripts/copy-cesium.mjs`.
|
||||
|
||||
### Plugin Microservices
|
||||
- Standalone plugin backends (e.g., `wwv-plugin-iranwarlive/backend`) are isolated via individual `Dockerfile` configurations and orchestrated together in production using `docker-compose.yml`.
|
||||
### Data Engine Runner
|
||||
- The generic `wwv-data-engine-v2` runner is deployed as a single Coolify service, orchestrating telemetry data by executing lightweight scripts from volume-mounted seeder directories. It features a dual-output architecture, exposing both WebSocket streams and REST APIs natively.
|
||||
|
||||
## Platform Deployment
|
||||
|
||||
### Coolify Integration
|
||||
WorldWideView deploys optimally to Coolify using a Dockerfile builder.
|
||||
- **Environment Variables:** Must be explicitly mapped in the Coolify UI (e.g., `DATABASE_URL`, `AUTH_SECRET`).
|
||||
- **Persistent Storage:** SQLite requires a persistent volume mounted to `/app/data` to ensure the frontend registry (installed plugins, user configs) survives container rebuilds.
|
||||
- **Microservices Deployment:** The `wwv-data-engine-internal` and associated plugin seeders are deployed as separate Coolify services communicating over private internal networks.
|
||||
- **Persistent Storage:** PostgreSQL databases must be hosted externally or mounted via persistent volumes to ensure the frontend registry (installed plugins, user configs) survives container rebuilds.
|
||||
- **Seeder Deployment:** The generic `wwv-data-engine-v2` runner is deployed as a Coolify service, reading plugin seeders dynamically from a volume-mounted directory. Seeders are pulled from private/community repositories via GitHub releases, maintaining strict namespace separation between community and private plugins.
|
||||
|
||||
### Docker Structure
|
||||
- **Dockerfile:** Found at the project root (`Dockerfile`). Uses an Extractor Pattern (`deps` → `builder` → `runner`). The `.git` and `node_modules` folders must be explicitly untracked to prevent cache overlap.
|
||||
- **Compose:** Local multi-container emulation is handled via `docker-compose.yml`.
|
||||
|
||||
## Reverse Proxies (Nginx Proxy Manager)
|
||||
|
||||
When deploying WorldWideView behind a reverse proxy like Nginx Proxy Manager (NPM), you must configure both the proxy and the container environment correctly to prevent NextAuth from hanging during login, and to allow the real-time Cesium data stream to function.
|
||||
|
||||
### Container Environment Variables
|
||||
NextAuth v5 requires strict host trust when placed behind a proxy. Add the following to your Docker `.env` file or Coolify environment variables:
|
||||
|
||||
```bash
|
||||
# Required: Tells NextAuth to trust the reverse proxy headers
|
||||
AUTH_TRUST_HOST=true
|
||||
|
||||
# Required: The exact external URL your users visit
|
||||
NEXTAUTH_URL=https://your-domain.com
|
||||
```
|
||||
|
||||
### Nginx Proxy Manager Configuration
|
||||
In the NPM UI for your WorldWideView Proxy Host:
|
||||
1. **Details Tab:** Ensure **Websockets Support** is toggled **ON** (Required for the live `/stream` telemetry).
|
||||
2. **Details Tab:** Ensure **Force SSL** is toggled **ON**. NextAuth will often refuse authentication flows over plain HTTP.
|
||||
3. **Advanced Tab:** Nginx Proxy Manager sometimes fails to pass the correct host headers required by Next.js. Add the following to the Custom Nginx Configuration box:
|
||||
|
||||
```nginx
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
proxy_set_header X-Forwarded-Host $host;
|
||||
proxy_set_header Host $host;
|
||||
|
||||
# Optional: Disable proxy buffering if 3D tiles load slowly
|
||||
proxy_buffering off;
|
||||
proxy_request_buffering off;
|
||||
```
|
||||
|
||||
## Reference
|
||||
- **Standalone Config:** `next.config.ts` (sets `output: "standalone"`).
|
||||
- **Prisma Export:** `prisma.config.ts` ensures no CLI wrappers are invoked inside the standalone container, preventing fatal `MODULE_NOT_FOUND` runtime crashes.
|
||||
- **Docker Mounts:**
|
||||
- Main App: `/app/data` (SQLite DB)
|
||||
- Data Engine: `/app/packages/wwv-data-engine/data` (SQLite DB)
|
||||
- Main App: PostgreSQL data volume (if running in-cluster)
|
||||
- Data Engine: PostgreSQL data volume (if running in-cluster)
|
||||
- Cache: `/data` (Redis)
|
||||
@@ -14,6 +14,7 @@ Development on WorldWideView prioritizes modularity, high performance, and stric
|
||||
- **Global Styles:** Located at `src/app/globals.css`.
|
||||
- **Component Styles:** Use CSS Modules (`.module.css`) or co-locate `.css` files directly next to their components.
|
||||
- **HUD Animations:** Specialized interface animations are stored in `src/styles/hud-animations.css`.
|
||||
- **Color Theming & Design Tokens:** Defined in `src/styles/theme-tokens.css` via CSS variables (e.g., `[data-theme='black']`).
|
||||
|
||||
### Import Aliases
|
||||
- Application core: `@/*` → `./src/*`
|
||||
@@ -63,6 +64,9 @@ const toggleLayer = useStore((state) => state.layers.toggle);
|
||||
Whenever generating temporary debugging scripts, testing REST endpoints via `.mjs`, or dumping traces/JSON outputs, **save these exclusively inside `/local-scripts/`**.
|
||||
- *Reference:* The root directory is strictly for production configuration files.
|
||||
|
||||
### Local Plugin & Seeder Testing
|
||||
When developing a custom seeder for a plugin, place the seeder directory inside `local-seeders/community/` or `local-seeders/private/`. The local `wwv-data-engine-v2` Docker container automatically mounts this folder and discovers scripts on startup, providing a seamless sandbox.
|
||||
|
||||
### Scaffold a New Component
|
||||
1. Create a new directory under `src/components/{category}/MyComponent`.
|
||||
2. Add `MyComponent.tsx` and `MyComponent.module.css`.
|
||||
|
||||
+4
-4
@@ -21,13 +21,13 @@ The system is highly modularized to separate React UI rendering from heavy Cesiu
|
||||
## Build System
|
||||
- `package.json` - Root monorepo configuration with `pnpm` workspace bindings.
|
||||
- `next.config.ts` - Next.js compiler settings, security headers, and standalone output configuration.
|
||||
- `docker-compose.yml` - Defines the orchestration of the frontend, Redis cache, and all local plugin microservice backends (`wwv-data-engine`).
|
||||
- `docker-compose.yml` - Defines the orchestration of the frontend, Redis cache, and the DataEngineV2 runner (`wwv-data-engine-v2`) loaded with local seeders.
|
||||
|
||||
## Configuration
|
||||
- `prisma/schema.prisma` - Local SQLite and cloud PostgreSQL database schema for storing user settings and installed plugin manifests.
|
||||
- `prisma/schema.prisma` - PostgreSQL database schema for storing user settings and installed plugin manifests.
|
||||
- `scripts/copy-cesium.mjs` - Crucial build-time script that extracts and copies CesiumJS static web workers to `public/cesium/`.
|
||||
- `public/` - Static assets, plugin icons, and compiled Cesium workers.
|
||||
|
||||
## Reference
|
||||
- **Plugins Directory:** All plugins conform to the `@worldwideview/wwv-plugin-sdk` interface and are developed inside `packages/wwv-plugin-<name>/`.
|
||||
- **Microservices Directory:** Standalone Fastify backends are nested within `packages/wwv-plugin-<name>/backend/`.
|
||||
- **Plugins Directory:** All frontend plugins conform to the `@worldwideview/wwv-plugin-sdk` interface and are developed inside `packages/wwv-plugin-<name>/` or `local-plugins/<name>/`.
|
||||
- **Seeders Directory:** Backend telemetry scripts are developed in the `local-seeders/community/<name>/` or `local-seeders/private/<name>/` directories and are mounted directly into the data engine at runtime.
|
||||
@@ -0,0 +1,116 @@
|
||||
# GeoJSON Data Guide
|
||||
|
||||
WorldWideView supports visualizing external datasets and local static files by interpreting GeoJSON files. When using the built-in GeoJSON parser (for instance, via declarative configs, static plugins, or user-uploaded files), the data is automatically normalized into our internal `GeoEntity` format so it seamlessly displays on the globe and the UI's detail panels.
|
||||
|
||||
This guide outlines exactly what structures are supported, what isn't, and how you can map your data into the UI.
|
||||
|
||||
---
|
||||
|
||||
## What is Supported?
|
||||
|
||||
Our parser enforces a subset of the **RFC 7946** standard. To be successfully interpreted, your JSON file must meet the following criteria:
|
||||
|
||||
### 1. Root Level
|
||||
The root of your JSON document must be a `FeatureCollection`. It must contain a `features` array.
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "FeatureCollection",
|
||||
"features": [ ... ]
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Supported Geometry: Points
|
||||
WorldWideView's declarative parser strictly supports **Point** geometries. Your coordinates must be a flat array of numbers: `[longitude, latitude]` or optionally `[longitude, latitude, altitude]`.
|
||||
|
||||
```json
|
||||
"geometry": {
|
||||
"type": "Point",
|
||||
"coordinates": [-83.74088, 42.27756, 150.0]
|
||||
}
|
||||
```
|
||||
*Note: Altitude (the 3rd coordinate) is optional. If omitted, the entity will be clamped to the ground.*
|
||||
|
||||
### 3. Properties and Metadata
|
||||
You can include any arbitrary metadata inside the `properties` object. The parser maps these properties to the UI using a `FieldMapping` configuration.
|
||||
|
||||
```json
|
||||
"properties": {
|
||||
"stream": "http://example.com/video.mjpg",
|
||||
"country": "United States",
|
||||
"is_static": false,
|
||||
"nested_data": {
|
||||
"speed": 45,
|
||||
"heading": 180
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Field Mapping
|
||||
When configuring your data source, you can define how your GeoJSON properties map to standard WorldWideView `GeoEntity` fields. This is done via dot-notation:
|
||||
|
||||
| GeoEntity Field | Description | Example Path |
|
||||
| --- | --- | --- |
|
||||
| `id` | Unique identifier | Automatically maps to `Feature.id` if present, otherwise uses array index. |
|
||||
| `heading` | Rotation angle (degrees) | `properties.nested_data.heading` |
|
||||
| `speed` | Speed value | `properties.nested_data.speed` |
|
||||
| `timestamp` | Time of the event (string or epoch) | `properties.last_updated` |
|
||||
| `label` | Primary text label shown on map | `properties.city` |
|
||||
| `properties` | Custom fields mapped to the UI panel | `properties.stream` |
|
||||
|
||||
Any property extracted via mapping will appear automatically in the Entity Info Card when a user clicks the point on the map.
|
||||
|
||||
---
|
||||
|
||||
## What is NOT Supported?
|
||||
|
||||
To ensure extreme performance (60 FPS with 10k+ entities) and a unified UI experience, the following GeoJSON structures are **not supported** by the automatic data parser:
|
||||
|
||||
### 1. Complex Geometries
|
||||
The declarative parser will fail to render the following geometry types:
|
||||
- `Polygon`
|
||||
- `MultiPolygon`
|
||||
- `LineString`
|
||||
- `MultiLineString`
|
||||
- `GeometryCollection`
|
||||
|
||||
*Why?* The automatic parser maps features to single point entities (billboards or 3D models). If you supply a `Polygon`, the parser will read the nested coordinate arrays (`[[lon, lat], ...]`) as invalid numbers, resulting in a silent failure (`NaN` clamping).
|
||||
|
||||
If you need to render borders, heatmaps, or route lines, you must build a **Code Bundle Plugin** and interact with the Cesium primitives (`PolygonHierarchy`, `PolylineCollection`) directly via the `renderEntity` API.
|
||||
|
||||
### 2. Top-Level Features
|
||||
A single isolated `Feature` object at the root of the document will not be parsed. The data must be wrapped in a `FeatureCollection`.
|
||||
|
||||
### 3. Non-Standard Coordinate Orders
|
||||
Cesium and GeoJSON strictly require `[longitude, latitude]`. If your system outputs `[latitude, longitude]`, you must transform the data before passing it to WorldWideView.
|
||||
|
||||
---
|
||||
|
||||
## Example: Perfect GeoJSON Structure
|
||||
|
||||
Here is a fully supported and optimized example demonstrating cameras mounted globally:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "FeatureCollection",
|
||||
"features": [
|
||||
{
|
||||
"type": "Feature",
|
||||
"id": "cam-001",
|
||||
"geometry": {
|
||||
"type": "Point",
|
||||
"coordinates": [-83.74088, 42.27756]
|
||||
},
|
||||
"properties": {
|
||||
"stream": "http://173.167.10.225:80/mjpg/video.mjpg",
|
||||
"country": "United States",
|
||||
"city": "Ann Arbor",
|
||||
"categories": ["traffic"],
|
||||
"is_static": false
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
By ensuring your data matches this structure, WorldWideView can effortlessly stream, render, and display your intelligence layers on the interactive 3D globe.
|
||||
+98
-145
@@ -23,29 +23,20 @@ Ensure you have the following installed on your machine:
|
||||
npm install -g pnpm
|
||||
```
|
||||
|
||||
### 1.2 Clone the Repositories
|
||||
### 1.2 Clone the Repository
|
||||
|
||||
You need both the frontend application and the backend data engine. Open your terminal and navigate to the folder where you want to store your code (e.g., `C:\dev`).
|
||||
You only need the main WorldWideView application. The data engine backend will run automatically via Docker. Open your terminal and navigate to the folder where you want to store your code (e.g., `C:\dev`).
|
||||
|
||||
Run these commands to download the code:
|
||||
Run this command to download the code:
|
||||
```bash
|
||||
git clone https://github.com/silvertakana/worldwideview.git
|
||||
git clone https://github.com/silvertakana/wwv-data-engine.git
|
||||
```
|
||||
|
||||
### 1.3 Install Dependencies
|
||||
|
||||
Next, we need to install the libraries that these projects depend on.
|
||||
|
||||
First, install dependencies for the Data Engine:
|
||||
Next, install dependencies for the main WorldWideView application:
|
||||
```bash
|
||||
cd wwv-data-engine
|
||||
pnpm install
|
||||
```
|
||||
|
||||
Second, install dependencies for the main WorldWideView application:
|
||||
```bash
|
||||
cd ../worldwideview
|
||||
cd worldwideview
|
||||
pnpm install
|
||||
```
|
||||
|
||||
@@ -62,133 +53,113 @@ Your workspace is now ready!
|
||||
|
||||
---
|
||||
|
||||
## Step 2: Creating the Data Engine Seeder (Backend)
|
||||
## Step 2: Scaffold the Plugin and Backend Seeder
|
||||
|
||||
The ISS moves incredibly fast. If our frontend tries to ask for its location every second, it will lag. Instead, we use the **Bring Your Own Backend (BYOB)** pattern. We will write a "Seeder" script in the Data Engine that fetches the ISS location and instantly broadcasts it to the frontend via WebSockets.
|
||||
|
||||
### 2.1 Create the Seeder File
|
||||
We will use the workspace CLI tool to generate a blank plugin template and its associated backend seeder in one go. In your terminal, navigate to your main `worldwideview` folder and run:
|
||||
|
||||
Navigate to your data engine repository and create a new file named `iss.ts` in the `src/seeders` folder:
|
||||
`c:\dev\wwv-data-engine\src\seeders\iss.ts`
|
||||
|
||||
### 2.2 Write the Polling Logic
|
||||
|
||||
Open `iss.ts` in your text editor and paste the following code. This script reaches out to the free WhereTheISS.at API every 5 seconds and saves the data to the engine's memory (Redis).
|
||||
|
||||
```typescript
|
||||
import { setLiveSnapshot } from '../core/redis';
|
||||
import axios from 'axios';
|
||||
|
||||
const WTIA_URL = 'https://api.wheretheiss.at/v1/satellites/25544';
|
||||
const POLLING_INTERVAL = 5000; // 5 seconds
|
||||
|
||||
async function pollISS() {
|
||||
try {
|
||||
// 1. Fetch data from the API
|
||||
const response = await axios.get(WTIA_URL);
|
||||
const data = response.data;
|
||||
|
||||
// 2. Format the data into a GeoEntity object
|
||||
const stateObj = {
|
||||
id: 25544,
|
||||
name: "International Space Station",
|
||||
latitude: data.latitude,
|
||||
longitude: data.longitude,
|
||||
altitude: data.altitude * 1000, // Convert kilometers to meters
|
||||
velocity: data.velocity,
|
||||
visibility: data.visibility,
|
||||
footprint: data.footprint
|
||||
};
|
||||
|
||||
// 3. Save to Redis under the 'iss' namespace for 60 seconds
|
||||
await setLiveSnapshot('iss', { "25544": stateObj }, 60);
|
||||
console.log(`[ISS] Poll OK: updated position to ${data.latitude}, ${data.longitude}`);
|
||||
|
||||
} catch (error) {
|
||||
console.error(`[ISS] Polling error:`, error.message);
|
||||
} finally {
|
||||
// 4. Repeat the process after 5 seconds
|
||||
setTimeout(pollISS, POLLING_INTERVAL);
|
||||
}
|
||||
}
|
||||
|
||||
// Start the loop
|
||||
pollISS();
|
||||
```bash
|
||||
node packages/wwv-cli/dist/index.js create
|
||||
```
|
||||
|
||||
### 2.3 Register the Seeder
|
||||
The CLI will launch an interactive survey. Answer as follows:
|
||||
1. **Unique ID**: `iss`
|
||||
2. **Display Name**: `ISS Live Tracker`
|
||||
3. **Description**: `Real-time International Space Station tracking.`
|
||||
4. **Category**: `Space`
|
||||
5. **Data Architecture**: `Real-Time WebSockets (Generates backend seeder)`
|
||||
6. **Globe Rendering**: `2D Billboard`
|
||||
7. **Community Sharing**: `Yes, public community seeder`
|
||||
|
||||
The engine needs to know your seeder exists. Open `c:\dev\wwv-data-engine\src\seeders\index.ts` and add this line at the bottom:
|
||||
This automatically creates:
|
||||
- Your frontend plugin at `local-plugins/wwv-plugin-iss`
|
||||
- Your backend seeder at `local-seeders/community/iss`
|
||||
|
||||
```typescript
|
||||
import './iss';
|
||||
Now install the dependencies to finalize the setup:
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> **Dependency Management:** You do *not* need to create a `package.json` or manually install standard dependencies (like `axios`) for your backend seeder. The `wwv-data-engine-v2` runner dynamically resolves these via the pnpm workspace, keeping your seeder lightweight.
|
||||
|
||||
---
|
||||
|
||||
## Step 3: Testing the Data Engine
|
||||
## Step 3: Write the Polling Logic (Backend Seeder)
|
||||
|
||||
Before we build the frontend, let's prove that our backend is actually fetching the ISS data.
|
||||
Open the newly generated seeder file in your text editor: `local-seeders/community/iss/seeder.mjs`.
|
||||
|
||||
### 3.1 Start the Engine
|
||||
|
||||
In your terminal, navigate to the `wwv-data-engine` folder and start the backend:
|
||||
```bash
|
||||
pnpm dev:backends
|
||||
```
|
||||
You should see `[ISS] Poll OK: updated position` appearing in your console every 5 seconds. Leave this terminal running.
|
||||
|
||||
### 3.2 Write a Quick Test Script
|
||||
|
||||
Open a *new* terminal window. Let's write a tiny script to peek into the engine's memory. Create a file called `test_iss.mjs` in the `wwv-data-engine` folder:
|
||||
The Data Engine Runner will dynamically discover this script and execute its `fetch(ctx)` function based on the interval you define. Replace its contents with this code:
|
||||
|
||||
```javascript
|
||||
// test_iss.mjs
|
||||
import Redis from 'ioredis';
|
||||
const redis = new Redis();
|
||||
// seeder.mjs
|
||||
const WTIA_URL = 'https://api.wheretheiss.at/v1/satellites/25544';
|
||||
|
||||
async function verify() {
|
||||
const data = await redis.get('data:iss:live');
|
||||
if (data) {
|
||||
console.log("Success! We found the ISS:", JSON.parse(data));
|
||||
} else {
|
||||
console.log("No data found yet.");
|
||||
export default {
|
||||
// Required: the unique namespace used by your plugin
|
||||
id: "iss",
|
||||
|
||||
// Define polling interval inside the seeder
|
||||
intervalMs: 5000,
|
||||
|
||||
// The Data Engine will call this function every intervalMs
|
||||
async fetch(ctx) {
|
||||
const { axios, logger } = ctx;
|
||||
|
||||
try {
|
||||
// 1. Fetch data from the API
|
||||
const response = await axios.get(WTIA_URL);
|
||||
const data = response.data;
|
||||
|
||||
// 2. Format the data into a GeoEntity array
|
||||
const entities = [{
|
||||
id: "25544",
|
||||
name: "International Space Station",
|
||||
latitude: data.latitude,
|
||||
longitude: data.longitude,
|
||||
altitude: data.altitude * 1000, // Convert kilometers to meters
|
||||
velocity: data.velocity,
|
||||
visibility: data.visibility,
|
||||
footprint: data.footprint
|
||||
}];
|
||||
|
||||
logger.info(`[ISS] Poll OK: updated position to ${data.latitude}, ${data.longitude}`);
|
||||
|
||||
// 3. Return the array of entities, the engine runner will broadcast it over WebSockets
|
||||
return entities;
|
||||
|
||||
} catch (error) {
|
||||
logger.error(`[ISS] Polling error: ${error.message}`);
|
||||
return [];
|
||||
}
|
||||
}
|
||||
process.exit(0);
|
||||
}
|
||||
verify();
|
||||
};
|
||||
```
|
||||
|
||||
Run the script:
|
||||
```bash
|
||||
node test_iss.mjs
|
||||
```
|
||||
If you see a large block of data containing coordinates and altitude, your backend is working perfectly!
|
||||
|
||||
---
|
||||
|
||||
## Step 4: Creating the WorldWideView Plugin (Frontend)
|
||||
## Step 4: Testing the Data Engine
|
||||
|
||||
Now we will build the visual part of the plugin that connects to our backend stream and draws the ISS on the 3D globe.
|
||||
Before we modify the frontend, let's prove that our backend is actually fetching the ISS data.
|
||||
|
||||
### 4.1 Scaffold the Plugin
|
||||
|
||||
In your terminal, navigate back to your main `c:\dev` folder. We will use the official CLI tool to generate a blank plugin template. Run:
|
||||
### 4.1 Start the Engine
|
||||
|
||||
In your terminal, navigate to the `worldwideview` folder and start the entire stack using Docker Compose:
|
||||
```bash
|
||||
npx @worldwideview/create-plugin@latest wwv-plugin-iss
|
||||
pnpm dev:all
|
||||
```
|
||||
When prompted, name the folder `wwv-plugin-iss`.
|
||||
Wait for the Data Engine Docker container to start. You should see `[ISS] Poll OK: updated position` appearing in the terminal logs every 5 seconds. Leave this terminal running.
|
||||
|
||||
Move into your new plugin folder and install its dependencies:
|
||||
```bash
|
||||
cd wwv-plugin-iss
|
||||
npm install
|
||||
```
|
||||
---
|
||||
|
||||
### 4.2 Write the Plugin Logic
|
||||
## Step 5: Write the Plugin Logic (Frontend)
|
||||
|
||||
Open `c:\dev\wwv-plugin-iss\src\index.ts` in your text editor. Replace everything in the file with this code:
|
||||
Now we will finalize the visual part of the plugin that connects to our backend stream and draws the ISS on the 3D globe.
|
||||
|
||||
### 5.1 Update the Plugin Code
|
||||
|
||||
Open `local-plugins/wwv-plugin-iss/src/index.ts` in your text editor. The CLI generated a boilerplate for you, but we want to customize the rendering with a 3D model. Replace everything in the file with this code:
|
||||
|
||||
```typescript
|
||||
import type { WorldPlugin, GeoEntity, PluginContext, LayerConfig, CesiumEntityOptions } from "@worldwideview/wwv-plugin-sdk";
|
||||
@@ -242,37 +213,18 @@ export class IssPlugin implements WorldPlugin {
|
||||
|
||||
---
|
||||
|
||||
## Step 5: Connecting and Testing Everything
|
||||
## Step 6: Connecting and Testing Everything
|
||||
|
||||
Now we will link your new plugin to your local WorldWideView application to see it in action.
|
||||
|
||||
### 5.1 Link the Plugin
|
||||
### 6.1 Develop Your Plugin
|
||||
|
||||
In your `wwv-plugin-iss` terminal, tell the CLI where your main WorldWideView folder is:
|
||||
```bash
|
||||
npx wwv config set wwv-path C:\dev\worldwideview
|
||||
```
|
||||
Because your plugin is located in `local-plugins/wwv-plugin-iss`, it is automatically detected by the workspace.
|
||||
You do not need to link it manually.
|
||||
|
||||
Now, link the plugin. This creates a shortcut so WorldWideView can see your code:
|
||||
```bash
|
||||
npm run link
|
||||
```
|
||||
Since you already started the whole stack (`pnpm dev:all`) in Step 4, the `dev:plugins` watcher is already running in the background. It will automatically build your frontend plugin code whenever you save changes.
|
||||
|
||||
Start the plugin watcher. This will automatically update your plugin if you make any changes to the code:
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
Leave this terminal running.
|
||||
|
||||
### 5.2 Start WorldWideView
|
||||
|
||||
Open a third, final terminal window. Navigate to your main `worldwideview` folder and start the frontend application:
|
||||
```bash
|
||||
cd C:\dev\worldwideview
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
### 5.3 View the ISS
|
||||
### 6.2 View the ISS
|
||||
|
||||
1. Open your web browser and go to `http://localhost:3000`.
|
||||
2. Click the **Layers** icon on the left sidebar.
|
||||
@@ -281,19 +233,19 @@ pnpm dev
|
||||
|
||||
> [!TIP]
|
||||
> **Troubleshooting missing points:**
|
||||
> - Ensure your Data Engine terminal (`pnpm dev:backends`) is still running.
|
||||
> - Ensure your `pnpm dev:all` terminal is still running without errors.
|
||||
> - Press `F12` in your browser to open Developer Tools. Check the `Console` tab for any red errors.
|
||||
> - Ensure the `id` in your plugin (`"iss"`) exactly matches the name you used in the backend `setLiveSnapshot('iss', ...)`.
|
||||
> - Ensure the `id` in your plugin (`"iss"`) exactly matches the `id` defined in `seeder.mjs`.
|
||||
|
||||
---
|
||||
|
||||
## Step 6: Publishing Your Plugin
|
||||
## Step 7: Publishing Your Plugin
|
||||
|
||||
You've built it, now share it with the world!
|
||||
|
||||
### 6.1 Update package.json
|
||||
### 7.1 Update package.json
|
||||
|
||||
Open `c:\dev\wwv-plugin-iss\package.json`. You must add a `"worldwideview"` metadata block so the marketplace knows how to read your plugin. Ensure your file looks like this:
|
||||
Open `c:\dev\worldwideview\local-plugins\wwv-plugin-iss\package.json`. You must add a `"worldwideview"` metadata block so the marketplace knows how to read your plugin. Ensure your file looks like this:
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -311,15 +263,16 @@ Open `c:\dev\wwv-plugin-iss\package.json`. You must add a `"worldwideview"` meta
|
||||
}
|
||||
```
|
||||
|
||||
### 6.2 Publish to NPM
|
||||
### 7.2 Publish to NPM
|
||||
|
||||
In your plugin terminal, log in to NPM and publish your package:
|
||||
Log in to NPM and publish your package using the WWV CLI from the project root (you can also use the `--org` flag to publish under your own NPM organization):
|
||||
```bash
|
||||
npm login
|
||||
npm publish --access public
|
||||
node packages/wwv-cli/dist/index.js publish iss [--org <your-org>]
|
||||
```
|
||||
*(Or `npx wwv publish iss [--org <your-org>]` if installed globally)*
|
||||
|
||||
### 6.3 Submit to the Marketplace
|
||||
### 7.3 Submit to the Marketplace
|
||||
|
||||
1. Go to the official marketplace at `https://marketplace.worldwideview.dev/submit`.
|
||||
2. Type in your package name (`wwv-plugin-iss`) and click submit.
|
||||
|
||||
+23
-13
@@ -18,23 +18,30 @@ WorldWideView operates on a strict **Dynamic CDN Loaded (Bundle)** architecture.
|
||||
|
||||
## Real-Time Data: Bring Your Own Backend (BYOB)
|
||||
|
||||
Relying on the frontend `fetch()` method is insufficient for high-frequency real-time tracking (like aviation or maritime). For continuous telemetry, you must build a **Data Engine Seeder** — a containerized backend microservice.
|
||||
Relying on the frontend `fetch()` method is insufficient for high-frequency real-time tracking (like aviation or maritime). For continuous telemetry, you must build a **Data Engine Seeder** — a lightweight Javascript data polling script.
|
||||
|
||||
### Microservice Seeder Architecture
|
||||
Instead of the frontend fetching data, your backend container connects to an upstream source, normalizes the data, and publishes it to the central Redis stream managed by `wwv-data-engine`.
|
||||
WorldWideView is a completely agnostic renderer. It has absolutely no concept of a "unified" Data Engine. If 30 plugins require 30 different WebSocket servers, the application will blindly open 30 connections. Each plugin is a self-contained package and **MUST explicitly declare its own `streamUrl` in its manifest or config**. Do NOT assume the frontend acts as a unified pipe.
|
||||
|
||||
1. **Scaffold a Backend:** Use the CLI to generate a backend template.
|
||||
```bash
|
||||
npx @worldwideview/cli create-backend my-plugin-backend
|
||||
```
|
||||
2. **Containerize:** This generates a Fastify Node.js server with a `Dockerfile` and `docker-compose.yml`.
|
||||
3. **Publish to Redis:** Your backend polls the external API (e.g., ADS-B Exchange) and pushes snapshots to the WorldWideView Redis pipeline.
|
||||
4. **WebSocket Delivery:** The central `wwv-data-engine` immediately broadcasts these updates over WebSockets to all connected clients.
|
||||
While you can host your own backend, we provide the `DataEngineV2` runner as a standardized environment for seeders.
|
||||
|
||||
### Data Engine V2 Seeder Architecture
|
||||
Instead of the frontend fetching data, you write a lightweight seeder script that connects to an upstream source, normalizes the data, and is executed by the central `wwv-data-engine-v2` host runner.
|
||||
|
||||
1. **Create a Seeder Directory:** Inside your WorldWideView project, create a folder under `local-seeders/` (e.g., `local-seeders/community/my-plugin/`). Note that seeders are split into `community` and `private` tiers to prevent namespace collisions.
|
||||
2. **Write the Seeder Script:** Create a `seeder.mjs` file that exports a `fetch(ctx)` function.
|
||||
3. **Engine Auto-Discovery:** The local Docker-based `wwv-data-engine-v2` automatically mounts this directory, discovers your script, and runs it on the defined interval.
|
||||
4. **WebSocket & REST Delivery:** Seeders in V2 expose both a WebSocket stream (`/stream`) for real-time instantaneous updates, and a REST API endpoint (`/api/:id`) for fetching live data snapshots directly from Redis.
|
||||
|
||||
### Dependency Management & Monorepo Hoisting
|
||||
Seeders within `local-seeders/` are strictly orchestrated within the pnpm workspace. They are executed by the central runner, not as standalone applications.
|
||||
- **Keep `package.json` clean**: Do not include bulky `dependencies` in your seeder's local `package.json` (unless it's an exceptional, bespoke library).
|
||||
- **Workspace Resolution**: Standard packages (e.g., `zod`, `ws`, `node-cron`, `undici`) are provided by the engine. At runtime, `wwv-data-engine-v2` leverages native Node.js module resolution to fetch the required dependencies directly from the root workspace or its own containerized runtime. Seeders MUST NOT bundle these dependencies.
|
||||
- **Lightweight by Design**: This dependency orchestration guarantees that seeders remain extremely lightweight, hot-reloading takes milliseconds, and Docker container size stays optimized.
|
||||
|
||||
> [!TIP]
|
||||
> **Debugging WebSockets:** If your frontend isn't receiving data from your backend seeder:
|
||||
> 1. Check the `wwv-data-engine` logs to ensure your seeder is publishing to Redis successfully.
|
||||
> 2. Verify the frontend is connected to the correct WebSocket endpoint. Local instances default to `ws://localhost:5001/stream`, while unrecognized seeders fall back to the cloud at `wss://dataengine.worldwideview.dev/stream`.
|
||||
> 1. Check the `wwv-data-engine-v2` logs to ensure your seeder is publishing to Redis successfully.
|
||||
> 2. Verify the frontend is connected to the correct WebSocket endpoint. Local instances default to `ws://localhost:5001/stream`, while unrecognized plugins should explicitly define their own `streamUrl`, or fallback to the cloud at `wss://dataenginev2.worldwideview.dev/stream`.
|
||||
|
||||
## Advanced Cesium Rendering
|
||||
|
||||
@@ -68,9 +75,12 @@ renderEntity(entity: GeoEntity): CesiumEntityOptions {
|
||||
To distribute your plugin globally:
|
||||
|
||||
1. **Publish to NPM:**
|
||||
Log in to NPM and publish your package using the WWV CLI from the project root (you can also use the `--org` flag to publish under your own NPM organization):
|
||||
```bash
|
||||
npm publish --access public
|
||||
npm login
|
||||
node packages/wwv-cli/dist/index.js publish <plugin-name> [--org <your-org>]
|
||||
```
|
||||
*(Or `npx wwv publish <plugin-name> [--org <your-org>]` if installed globally)*
|
||||
2. **Submit:** Navigate to `https://marketplace.worldwideview.dev/submit`.
|
||||
3. **Register:** Enter your NPM package name. The marketplace automatically scrapes your `package.json` for the required `"worldwideview"` object block (containing your `id`, `icon`, and `category`).
|
||||
4. **Review:** Once approved, your plugin's ES Module bundle will be served via CDN to all WorldWideView instances worldwide.
|
||||
|
||||
+22
-20
@@ -14,39 +14,41 @@ Before you start, ensure you have:
|
||||
|
||||
## 2. Scaffold Your Plugin
|
||||
|
||||
WorldWideView plugins are built as standard NPM packages. They are entirely decoupled from the core application, allowing you to develop and publish them independently.
|
||||
|
||||
To generate a new plugin template, use the official CLI:
|
||||
WorldWideView plugins are built as standard packages within the monorepo workspace. To generate a new plugin sandbox, use the official interactive CLI from the root of your `worldwideview` repository:
|
||||
|
||||
```bash
|
||||
npx @worldwideview/create-plugin@latest my-first-plugin
|
||||
cd my-first-plugin
|
||||
npm install
|
||||
node packages/wwv-cli/dist/index.js create --local
|
||||
```
|
||||
|
||||
This creates a lightweight Vite-based project pre-configured with the `@worldwideview/wwv-plugin-sdk`.
|
||||
The CLI will launch an interactive survey to configure your plugin:
|
||||
1. **Unique ID**: `my-first-plugin`
|
||||
2. **Display Name**: `My First Data Layer`
|
||||
3. **Description**: `A simple example plugin.`
|
||||
4. **Category**: `Custom`
|
||||
5. **Data Architecture**: `REST Polling / Static Data (Frontend only)`
|
||||
6. **Globe Rendering**: `Map Point`
|
||||
|
||||
## 3. Link Your Plugin to WorldWideView
|
||||
This automatically creates a lightweight Vite-based project pre-configured with the `@worldwideview/wwv-plugin-sdk` inside the `local-plugins/wwv-plugin-my-first-plugin/` directory.
|
||||
|
||||
To see your plugin live on the globe while you develop, you need to link it to your local WorldWideView instance.
|
||||
|
||||
First, tell the CLI where your WorldWideView repository is located:
|
||||
Once the scaffolding completes, install the dependencies:
|
||||
```bash
|
||||
npx wwv config set wwv-path C:\path\to\your\worldwideview
|
||||
pnpm install
|
||||
```
|
||||
|
||||
Next, link the plugin. This creates a symlink so your local WorldWideView instance can dynamically load your code:
|
||||
## 3. Develop Your Plugin
|
||||
|
||||
Because your plugin is created inside the `local-plugins/` directory, it is automatically recognized by the pnpm workspace.
|
||||
|
||||
To see your plugin live on the globe while you develop, simply start the standard development servers from the repository root:
|
||||
|
||||
```bash
|
||||
npm run link
|
||||
pnpm dev:all
|
||||
```
|
||||
|
||||
Finally, start the plugin watcher. This will automatically rebuild your plugin whenever you save a file:
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
The `dev:all` command automatically starts the frontend, the data engine, and the `dev:plugins` watcher. This watcher will automatically rebuild your plugin whenever you save a file in `local-plugins/`.
|
||||
|
||||
> [!TIP]
|
||||
> **Debugging Link Issues:** If your plugin doesn't appear in the WorldWideView "Installed Plugins" list after linking, check your `package.json`. The `"worldwideview"` object block is strictly required. Ensure `id`, `name`, and `version` are populated correctly.
|
||||
> **Debugging Registration Issues:** If your plugin doesn't appear in the WorldWideView "Installed Plugins" list, check your `package.json` inside your local plugin folder. Ensure `id`, `name`, and `version` are populated correctly. Also verify that you ran `pnpm install` from the workspace root.
|
||||
|
||||
## 4. Explore the Code
|
||||
|
||||
@@ -123,4 +125,4 @@ export class MyFirstPlugin implements WorldPlugin {
|
||||
|
||||
Congratulations! You've successfully built and linked your first plugin.
|
||||
|
||||
For advanced features—like real-time WebSocket streaming, containerizing your own backend microservices, or publishing your plugin to the global Marketplace—proceed to the **[Advanced Plugin Guide](docs/plugin-advanced.md)**.
|
||||
For advanced features—like real-time WebSocket streaming, creating backend seeders using the `local-seeders` sandbox, or publishing your plugin to the global Marketplace—proceed to the **[Advanced Plugin Guide](docs/plugin-advanced.md)**.
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
WorldWideView is a real-time geospatial intelligence engine that visualizes live global data on an interactive 3D globe. It leverages a modern frontend stack to render high-density datasets synchronously, including aircraft, maritime vessels, conflict events, satellites, and environmental data.
|
||||
|
||||
The core value proposition of WorldWideView is mapping diverse, decoupled intelligence streams onto a central geographic interface using a dynamically loaded plugin architecture. Data sources operate completely decoupled from the display platform, streaming observations via WebSockets for sub-second visual updates. The ecosystem consists of multiple repositories, including the main app (`worldwideview`), the plugin marketplace (`worldwideview-marketplace`), and the WebSocket push server (`wwv-data-engine`).
|
||||
The core value proposition of WorldWideView is mapping diverse, decoupled intelligence streams onto a central geographic interface using a dynamically loaded plugin architecture. Data sources operate completely decoupled from the display platform, streaming observations via WebSockets for sub-second visual updates. The ecosystem consists of multiple repositories, including the main app (`worldwideview`), the plugin marketplace (`worldwideview-marketplace`), and our default data provider runners like the `DataEngineV2` (`wwv-data-engine-v2`). Note that WorldWideView itself acts as an agnostic client, and any plugin can seamlessly point to its own independent backend WebSocket stream.
|
||||
|
||||
## Key Files
|
||||
- `package.json` (Lines 1-76) - Core dependencies and project metadata for the monorepo workspace.
|
||||
@@ -17,8 +17,8 @@ The core value proposition of WorldWideView is mapping diverse, decoupled intell
|
||||
- **3D Engine:** CesiumJS + Resium (Google Photorealistic 3D Tiles) — `src/core/globe/GlobeView.tsx`
|
||||
- **State Management:** Zustand — `src/core/state/` (slice-based store)
|
||||
- **Event Bus:** Custom typed `DataBus` — `src/core/data/DataBus.ts`
|
||||
- **Database:** SQLite via Prisma (local), PostgreSQL (cloud) — `prisma/schema.prisma`
|
||||
- **Styling:** Vanilla CSS (no Tailwind) — `src/app/globals.css`
|
||||
- **Database:** PostgreSQL via Prisma 7 — `prisma/schema.prisma`
|
||||
- **Styling:** Vanilla CSS (no Tailwind) — `src/app/globals.css` and `src/styles/theme-tokens.css`
|
||||
|
||||
## Platform Support
|
||||
Built as a highly portable Next.js container, it supports multiple deployment profiles controlled by `NEXT_PUBLIC_WWV_EDITION` (default: `local`).
|
||||
|
||||
@@ -1,216 +0,0 @@
|
||||
# Plugin Architecture Migration Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Migrate the WorldWideView plugin architecture from compile-time hardcoded imports to a dynamic, runtime-loaded ecosystem where external developers can build, host, and distribute plugins without touching the core repository.
|
||||
|
||||
**Architecture:** We will introduce a bundler (`tsup`) to the SDK to compile `bundle` plugins into browser-ready ECMAScript Modules (ESM). We will expose shared dependencies (`react`, `cesium`, `lucide-react`) via a global `window.__WWV_SHARED__` object. Finally, we will refactor `AppShell.tsx` to dynamically load all plugins at runtime via `import(/* webpackIgnore: true */)`, removing the hardcoded imports, and we will update `loadPluginFromManifest.ts` to seamlessly handle the global dependency injection.
|
||||
|
||||
**Tech Stack:** Next.js, React, CesiumJS, tsup.
|
||||
|
||||
---
|
||||
|
||||
## User Review Required
|
||||
|
||||
> [!WARNING]
|
||||
> **Breaking Change**: This migration will decouple your built-in plugins from `AppShell.tsx`. They will now act as true "external" plugins that are loaded at runtime. During the transition, if the build steps aren't executed, the plugins will temporarily stop appearing on the globe. We will mitigate this by ensuring the build step runs before `next dev`.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **Static GeoJSON Files**: Since static `.geojson` files currently live in `public/data`, we will leave them there during phase 1 of this migration to ensure the app doesn't break, but we will point the plugin manifests to load them via absolute or absolute-relative URLs (`/data/...`). In phase 2, we will introduce a symlink script to move them out of `public` entirely.
|
||||
|
||||
## Open Questions
|
||||
|
||||
1. **Build Tool Choice**: I am proposing `tsup` because it requires zero configuration to output multiple formats, automatically externalizes dependencies, and natively transpiles TypeScript/React. Are you comfortable adding `tsup` to the `wwv-plugin-sdk` package?
|
||||
2. **Local Serving**: To test "built-in" plugins using the dynamic loading method, we need the Next.js app to serve their compiled `plugin.js` bundles. My plan adds a quick copy script to the root `package.json` that copies their `dist` folders into `public/builtin-plugins/` so they can be fetched locally via HTTP. Does this sound good?
|
||||
|
||||
## Proposed Changes
|
||||
|
||||
### Task 1: Initialize Global Shared Dependencies
|
||||
|
||||
**Files:**
|
||||
- Modify: `c:\dev\worldwideview\src\components\layout\AppShell.tsx`
|
||||
- Create: `c:\dev\worldwideview\src\core\plugins\PluginGlobals.ts`
|
||||
|
||||
- [ ] **Step 1: Create the PluginGlobals initializer**
|
||||
|
||||
```typescript
|
||||
import React from "react";
|
||||
import ReactDOM from "react-dom";
|
||||
import * as ReactDomServer from "react-dom/server";
|
||||
import { Plane, Ship, Camera, Shield, Flame, Map, Swords, Atom, Landmark, Mountain, PlaneTakeoff, Anchor, Lamp, Rocket, SunMoon, Cable, Pickaxe, ShieldAlert, Crosshair, SatelliteDish, Hand, Radar, Scale } from "lucide-react";
|
||||
import * as Cesium from "cesium";
|
||||
import * as WWVPluginSDK from "@worldwideview/wwv-plugin-sdk";
|
||||
|
||||
export function initPluginGlobals() {
|
||||
if (typeof window === "undefined") return;
|
||||
|
||||
// Create a registry of Lucide icons commonly used by plugins to prevent them from bundling the massive icon library
|
||||
const lucideIcons = {
|
||||
Plane, Ship, Camera, Shield, Flame, Map, Swords, Atom, Landmark, Mountain,
|
||||
PlaneTakeoff, Anchor, Lamp, Rocket, SunMoon, Cable, Pickaxe, ShieldAlert,
|
||||
Crosshair, SatelliteDish, Hand, Radar, Scale
|
||||
};
|
||||
|
||||
(window as any).__WWV_SHARED__ = {
|
||||
"react": React,
|
||||
"react-dom": ReactDOM,
|
||||
"react-dom/server": ReactDomServer,
|
||||
"cesium": Cesium,
|
||||
"@worldwideview/wwv-plugin-sdk": WWVPluginSDK,
|
||||
"lucide-react": lucideIcons
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Inject globals in AppShell before anything loads**
|
||||
|
||||
In `AppShell.tsx`, import and call `initPluginGlobals()` at the top of the file, outside of any React components.
|
||||
|
||||
```tsx
|
||||
import { initPluginGlobals } from "@/core/plugins/PluginGlobals";
|
||||
import dynamic from "next/dynamic";
|
||||
|
||||
// Initialize globals immediately so they exist before any dynamic imports
|
||||
if (typeof window !== "undefined") {
|
||||
initPluginGlobals();
|
||||
}
|
||||
//... rest of the file
|
||||
```
|
||||
|
||||
### Task 2: Configure SDK Build Tool (`tsup`)
|
||||
|
||||
**Files:**
|
||||
- Modify: `c:\dev\worldwideview\packages\wwv-plugin-sdk\package.json`
|
||||
- Create: `c:\dev\worldwideview\packages\wwv-plugin-sdk\bin\wwv-plugin-build.js`
|
||||
|
||||
- [ ] **Step 1: Add tsup dependency**
|
||||
|
||||
Run: `pnpm --filter @worldwideview/wwv-plugin-sdk add -D tsup`
|
||||
|
||||
- [ ] **Step 2: Create the wwv-plugin-build CLI wrapper**
|
||||
|
||||
Add this to `wwv-plugin-sdk/bin/wwv-plugin-build.js`:
|
||||
|
||||
```javascript
|
||||
#!/usr/bin/env node
|
||||
const { build } = require("tsup");
|
||||
const path = require("path");
|
||||
|
||||
async function run() {
|
||||
const cwd = process.cwd();
|
||||
await build({
|
||||
entry: ["src/index.ts"],
|
||||
outDir: "dist",
|
||||
format: ["esm"],
|
||||
target: "es2022",
|
||||
clean: true,
|
||||
dts: false,
|
||||
minify: false,
|
||||
sourcemap: true,
|
||||
// Mark all these as externals so they aren't bundled
|
||||
external: ["react", "react-dom", "cesium", "@worldwideview/wwv-plugin-sdk", "lucide-react"],
|
||||
// Provide a shim that converts bare imports into global lookups
|
||||
esbuildPlugins: [{
|
||||
name: "wwv-globals",
|
||||
setup(build) {
|
||||
build.onResolve({ filter: /^(react|react-dom|cesium|@worldwideview\/wwv-plugin-sdk|lucide-react)$/ }, args => {
|
||||
return { path: args.path, namespace: "wwv-global" };
|
||||
});
|
||||
build.onLoad({ filter: /.*/, namespace: "wwv-global" }, args => {
|
||||
let globalKey = args.path;
|
||||
if (args.path === "lucide-react") return { contents: `module.exports = window.__WWV_SHARED__["lucide-react"];` };
|
||||
return { contents: `module.exports = window.__WWV_SHARED__["${globalKey}"];` };
|
||||
});
|
||||
}
|
||||
}]
|
||||
});
|
||||
}
|
||||
run();
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Update SDK package.json to expose the bin**
|
||||
|
||||
```json
|
||||
"bin": {
|
||||
"wwv-plugin-build": "./bin/wwv-plugin-build.js"
|
||||
},
|
||||
```
|
||||
|
||||
### Task 3: Refactor Plugins to use Build Tool and Manifests
|
||||
|
||||
**Files:**
|
||||
- Modify: `wwv-plugin-aviation/package.json`
|
||||
- Modify: `wwv-plugin-aviation/plugin.json` (Create)
|
||||
|
||||
- [ ] **Step 1: Add build script to aviation plugin**
|
||||
|
||||
```json
|
||||
"scripts": {
|
||||
"build": "wwv-plugin-build"
|
||||
},
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Create plugin.json for aviation**
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "aviation",
|
||||
"name": "Aviation",
|
||||
"version": "1.0.7",
|
||||
"type": "data-layer",
|
||||
"format": "bundle",
|
||||
"trust": "built-in",
|
||||
"capabilities": ["data:own", "network:fetch"],
|
||||
"category": "aviation",
|
||||
"icon": "Plane",
|
||||
"entry": "/builtin-plugins/aviation/index.mjs"
|
||||
}
|
||||
```
|
||||
|
||||
*(Repeat for all other built-in plugins)*
|
||||
|
||||
### Task 4: Dynamic Initial Loader
|
||||
|
||||
**Files:**
|
||||
- Modify: `c:\dev\worldwideview\src\components\layout\AppShell.tsx`
|
||||
- Modify: `c:\dev\worldwideview\package.json`
|
||||
|
||||
- [ ] **Step 1: Remove Hardcoded Plugins**
|
||||
|
||||
In `AppShell.tsx`, delete the `builtIns` array and `import` statements at the top.
|
||||
|
||||
- [ ] **Step 2: Fetch and load all plugins via manifest**
|
||||
|
||||
Modify `AppShell.tsx` `startPlatform`:
|
||||
|
||||
```typescript
|
||||
// Fetch the unified list of ALL installed plugins (both built-in and dynamic)
|
||||
const res = await fetch("/api/marketplace/load");
|
||||
if (res.ok) {
|
||||
const data = await res.json();
|
||||
for (const manifest of data.manifests) {
|
||||
if (disabledIds.has(manifest.id)) continue;
|
||||
try {
|
||||
await pluginManager.loadFromManifest(manifest);
|
||||
initLayer(manifest.id);
|
||||
} catch (e) {
|
||||
console.error("Failed to load plugin", manifest.id, e);
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Add predev copy-script**
|
||||
|
||||
Modify `package.json` to copy compiled plugin `dist` folders to `public/builtin-plugins` so the Next.js server can serve them at the `/builtin-plugins/...` path.
|
||||
|
||||
## Verification Plan
|
||||
|
||||
### Automated Tests
|
||||
- Run `pnpm --filter wwv-plugin-aviation build` to ensure `tsup` generates a valid ES Module with no bundled React.
|
||||
- Verify `dist/index.mjs` contains `window.__WWV_SHARED__["react"]` lookups.
|
||||
|
||||
### Manual Verification
|
||||
- Start the Next.js server.
|
||||
- Open network tab in browser and verify `GET /builtin-plugins/aviation/index.mjs` succeeds.
|
||||
- Verify the Aviation plugin appears on the globe and renders planes successfully, indicating that it successfully retrieved Cesium and React from the global shared context.
|
||||
@@ -1,475 +0,0 @@
|
||||
# Demo Google AdSense Panel Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Add a Google AdSense vertical ad strip to the right side of the demo instance, with a dismissible banner explaining it's temporary to fund hosting.
|
||||
|
||||
**Architecture:** Three layers: (1) load the AdSense script conditionally in the root layout only when `isDemo` is true, (2) a reusable `AdUnit` client component that calls `adsbygoogle.push({})`, (3) a `DemoAdStrip` shell component that wraps the ad unit + a "why ads?" dismissible message, positioned as a fixed vertical strip on the right edge. CSP headers in `next.config.ts` must be updated to allow the AdSense domains.
|
||||
|
||||
**Tech Stack:** Next.js 16 (App Router, `next/script`), Google AdSense, vanilla CSS, Vitest
|
||||
|
||||
---
|
||||
|
||||
## File Structure
|
||||
|
||||
| File | Action | Responsibility |
|
||||
|---|---|---|
|
||||
| `src/app/layout.tsx` | MODIFY | Conditionally load AdSense `<Script>` for demo |
|
||||
| `next.config.ts` | MODIFY | Add AdSense domains to CSP `script-src` and `frame-src` |
|
||||
| `.env` | MODIFY | Add `NEXT_PUBLIC_ADSENSE_CLIENT_ID` placeholder |
|
||||
| `src/components/ads/AdUnit.tsx` | CREATE | Generic reusable AdSense unit component |
|
||||
| `src/components/ads/DemoAdStrip.tsx` | CREATE | Demo-only vertical strip: ad + "why ads?" message |
|
||||
| `src/components/ads/DemoAdStrip.css` | CREATE | Styles for the vertical ad strip |
|
||||
| `src/components/layout/AppShell.tsx` | MODIFY | Import and render `<DemoAdStrip />` |
|
||||
| `src/types/adsense.d.ts` | CREATE | TypeScript ambient declaration for `window.adsbygoogle` |
|
||||
|
||||
---
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **Before starting:** You need a Google AdSense publisher ID (`ca-pub-XXXXXXXXXXXXXXXX`) and an ad slot ID. These go into `.env` as `NEXT_PUBLIC_ADSENSE_CLIENT_ID` and are passed to the ad unit component. You can get these from [Google AdSense](https://www.google.com/adsense/). Without them the ads will not render, but the component framework will still work.
|
||||
|
||||
---
|
||||
|
||||
### Task 1: TypeScript Ambient Declaration for AdSense
|
||||
|
||||
**Files:**
|
||||
- Create: `src/types/adsense.d.ts`
|
||||
|
||||
- [ ] **Step 1: Create the ambient type declaration**
|
||||
|
||||
```ts
|
||||
// src/types/adsense.d.ts
|
||||
interface Window {
|
||||
adsbygoogle: Array<Record<string, unknown>>;
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Commit**
|
||||
|
||||
```bash
|
||||
git add src/types/adsense.d.ts
|
||||
git commit -m "chore: add adsense ambient type declaration"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 2: Environment Variable
|
||||
|
||||
**Files:**
|
||||
- Modify: `.env`
|
||||
|
||||
- [ ] **Step 1: Add the AdSense client ID placeholder**
|
||||
|
||||
Add the following line to the end of `.env`:
|
||||
|
||||
```
|
||||
# Google AdSense — only used on demo edition
|
||||
NEXT_PUBLIC_ADSENSE_CLIENT_ID=
|
||||
```
|
||||
|
||||
The actual value (`ca-pub-XXXXXXXXXXXXXXXX`) should be set in `.env.local` for local testing or in the deployment environment. The ad slot IDs will be hardcoded in the component since there's only one placement.
|
||||
|
||||
- [ ] **Step 2: Commit**
|
||||
|
||||
```bash
|
||||
git add .env
|
||||
git commit -m "chore: add NEXT_PUBLIC_ADSENSE_CLIENT_ID env var"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 3: CSP Headers Update
|
||||
|
||||
**Files:**
|
||||
- Modify: `next.config.ts:29-52`
|
||||
|
||||
- [ ] **Step 1: Update CSP in next.config.ts**
|
||||
|
||||
In the `headers()` function, modify the `script-src` and `frame-src` directives to allow AdSense domains.
|
||||
|
||||
```ts
|
||||
// Change this line (line 39):
|
||||
"script-src 'self' 'unsafe-eval' 'unsafe-inline' blob: https://analytics.worldwideview.dev https://va.vercel-scripts.com",
|
||||
|
||||
// To this:
|
||||
"script-src 'self' 'unsafe-eval' 'unsafe-inline' blob: https://analytics.worldwideview.dev https://va.vercel-scripts.com https://pagead2.googlesyndication.com https://adservice.google.com https://www.googletagservices.com",
|
||||
```
|
||||
|
||||
```ts
|
||||
// Change this line (line 49):
|
||||
"frame-src 'self' *.youtube.com *.youtube-nocookie.com *.twitch.tv *.vimeo.com *.webcamera.pl *.ivideon.com *.rtsp.me *.bnu.tv",
|
||||
|
||||
// To this:
|
||||
"frame-src 'self' *.youtube.com *.youtube-nocookie.com *.twitch.tv *.vimeo.com *.webcamera.pl *.ivideon.com *.rtsp.me *.bnu.tv https://googleads.g.doubleclick.net https://tpc.googlesyndication.com",
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Commit**
|
||||
|
||||
```bash
|
||||
git add next.config.ts
|
||||
git commit -m "feat: add Google AdSense domains to CSP headers"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 4: AdSense Script in Root Layout
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/app/layout.tsx:24-39`
|
||||
|
||||
- [ ] **Step 1: Conditionally load AdSense script for demo edition**
|
||||
|
||||
Add the AdSense `<Script>` tag inside `<head>`, using the `NEXT_PUBLIC_` env var for the client ID and the `NEXT_PUBLIC_WWV_EDITION` env var to gate loading.
|
||||
|
||||
```tsx
|
||||
// src/app/layout.tsx — updated <head> section
|
||||
<head>
|
||||
{/* Load CesiumJS base styles (optional, but helps with UI widgets if used later) */}
|
||||
<link rel="stylesheet" href="/cesium/Widgets/widgets.css" />
|
||||
</head>
|
||||
<body suppressHydrationWarning>
|
||||
{children}
|
||||
<Analytics />
|
||||
<Script
|
||||
src="https://analytics.worldwideview.dev/script.js"
|
||||
data-website-id="2c8f6c09-2651-4a2a-af99-b8cee1612b9a"
|
||||
strategy="afterInteractive"
|
||||
/>
|
||||
{process.env.NEXT_PUBLIC_WWV_EDITION === "demo" &&
|
||||
process.env.NEXT_PUBLIC_ADSENSE_CLIENT_ID && (
|
||||
<Script
|
||||
src={`https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=${process.env.NEXT_PUBLIC_ADSENSE_CLIENT_ID}`}
|
||||
crossOrigin="anonymous"
|
||||
strategy="afterInteractive"
|
||||
/>
|
||||
)}
|
||||
</body>
|
||||
```
|
||||
|
||||
> **Note:** We use the raw env var at the layout level (Server Component) rather than importing `isDemo` which uses `process.env.NEXT_PUBLIC_WWV_EDITION` anyway. This avoids importing the edition module into the root layout.
|
||||
|
||||
- [ ] **Step 2: Commit**
|
||||
|
||||
```bash
|
||||
git add src/app/layout.tsx
|
||||
git commit -m "feat: conditionally load AdSense script on demo edition"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 5: Reusable AdUnit Component
|
||||
|
||||
**Files:**
|
||||
- Create: `src/components/ads/AdUnit.tsx`
|
||||
|
||||
- [ ] **Step 1: Create the generic AdSense unit component**
|
||||
|
||||
```tsx
|
||||
// src/components/ads/AdUnit.tsx
|
||||
"use client";
|
||||
|
||||
import { useEffect, useRef } from "react";
|
||||
|
||||
interface AdUnitProps {
|
||||
adSlot: string;
|
||||
adFormat?: string;
|
||||
style?: React.CSSProperties;
|
||||
className?: string;
|
||||
}
|
||||
|
||||
export function AdUnit({ adSlot, adFormat = "auto", style, className }: AdUnitProps) {
|
||||
const pushed = useRef(false);
|
||||
const clientId = process.env.NEXT_PUBLIC_ADSENSE_CLIENT_ID;
|
||||
|
||||
useEffect(() => {
|
||||
if (pushed.current || !clientId) return;
|
||||
try {
|
||||
(window.adsbygoogle = window.adsbygoogle || []).push({});
|
||||
pushed.current = true;
|
||||
} catch (err) {
|
||||
console.error("[AdUnit] AdSense push error:", err);
|
||||
}
|
||||
}, [clientId]);
|
||||
|
||||
if (!clientId) return null;
|
||||
|
||||
return (
|
||||
<div className={className} style={style}>
|
||||
<ins
|
||||
className="adsbygoogle"
|
||||
style={{ display: "block" }}
|
||||
data-ad-client={clientId}
|
||||
data-ad-slot={adSlot}
|
||||
data-ad-format={adFormat}
|
||||
data-full-width-responsive="false"
|
||||
/>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
> **Key detail:** The `pushed` ref prevents double-push on React strict mode / hot reload. `data-full-width-responsive="false"` prevents the ad from expanding beyond the container — critical for a fixed-width vertical strip.
|
||||
|
||||
- [ ] **Step 2: Commit**
|
||||
|
||||
```bash
|
||||
git add src/components/ads/AdUnit.tsx
|
||||
git commit -m "feat: add reusable AdUnit component"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 6: DemoAdStrip Component + Styles
|
||||
|
||||
**Files:**
|
||||
- Create: `src/components/ads/DemoAdStrip.tsx`
|
||||
- Create: `src/components/ads/DemoAdStrip.css`
|
||||
|
||||
- [ ] **Step 1: Create the CSS for the vertical ad strip**
|
||||
|
||||
```css
|
||||
/* src/components/ads/DemoAdStrip.css */
|
||||
|
||||
.demo-ad-strip {
|
||||
position: fixed;
|
||||
right: 0;
|
||||
top: 0;
|
||||
bottom: 0;
|
||||
width: 160px;
|
||||
z-index: 45;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
gap: var(--space-md);
|
||||
padding: var(--space-sm);
|
||||
pointer-events: none;
|
||||
transition: transform var(--duration-slow) var(--ease-smooth),
|
||||
opacity var(--duration-slow) var(--ease-smooth);
|
||||
}
|
||||
|
||||
.demo-ad-strip--hidden {
|
||||
transform: translateX(200px);
|
||||
opacity: 0;
|
||||
}
|
||||
|
||||
.demo-ad-strip__ad {
|
||||
pointer-events: auto;
|
||||
width: 160px;
|
||||
min-height: 600px;
|
||||
}
|
||||
|
||||
.demo-ad-strip__banner {
|
||||
pointer-events: auto;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
align-items: center;
|
||||
gap: var(--space-xs);
|
||||
padding: var(--space-sm) var(--space-md);
|
||||
background: var(--bg-glass);
|
||||
backdrop-filter: blur(var(--glass-blur));
|
||||
-webkit-backdrop-filter: blur(var(--glass-blur));
|
||||
border: 1px solid var(--border-subtle);
|
||||
border-radius: var(--radius-md);
|
||||
max-width: 160px;
|
||||
text-align: center;
|
||||
cursor: pointer;
|
||||
transition: all var(--duration-fast) var(--ease-smooth);
|
||||
}
|
||||
|
||||
.demo-ad-strip__banner:hover {
|
||||
border-color: rgba(var(--accent-rgb), 0.3);
|
||||
box-shadow: var(--glow-cyan);
|
||||
}
|
||||
|
||||
.demo-ad-strip__banner-label {
|
||||
font-size: 9px;
|
||||
font-weight: 700;
|
||||
letter-spacing: 0.12em;
|
||||
text-transform: uppercase;
|
||||
color: var(--text-muted);
|
||||
}
|
||||
|
||||
.demo-ad-strip__banner-text {
|
||||
font-size: 11px;
|
||||
line-height: 1.4;
|
||||
color: var(--text-secondary);
|
||||
}
|
||||
|
||||
.demo-ad-strip__close {
|
||||
position: absolute;
|
||||
top: var(--space-xs);
|
||||
right: var(--space-xs);
|
||||
width: 20px;
|
||||
height: 20px;
|
||||
border-radius: 50%;
|
||||
background: transparent;
|
||||
border: none;
|
||||
color: var(--text-muted);
|
||||
font-size: 12px;
|
||||
cursor: pointer;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
transition: color var(--duration-fast) var(--ease-smooth);
|
||||
}
|
||||
|
||||
.demo-ad-strip__close:hover {
|
||||
color: var(--text-primary);
|
||||
}
|
||||
|
||||
/* Hide on mobile — ads shouldn't overlay the full-screen globe */
|
||||
@media (max-width: 768px) {
|
||||
.demo-ad-strip {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Create the DemoAdStrip component**
|
||||
|
||||
```tsx
|
||||
// src/components/ads/DemoAdStrip.tsx
|
||||
"use client";
|
||||
|
||||
import { useState } from "react";
|
||||
import { isDemo } from "@/core/edition";
|
||||
import { AdUnit } from "./AdUnit";
|
||||
import { X } from "lucide-react";
|
||||
import "./DemoAdStrip.css";
|
||||
|
||||
/** The ad slot ID for the vertical skyscraper unit — set this in AdSense dashboard. */
|
||||
const VERTICAL_AD_SLOT = "REPLACE_WITH_YOUR_AD_SLOT_ID";
|
||||
|
||||
export function DemoAdStrip() {
|
||||
const [showMessage, setShowMessage] = useState(false);
|
||||
const [closed, setClosed] = useState(false);
|
||||
|
||||
if (!isDemo || closed) return null;
|
||||
|
||||
return (
|
||||
<aside className="demo-ad-strip" aria-label="Sponsored content">
|
||||
<AdUnit
|
||||
adSlot={VERTICAL_AD_SLOT}
|
||||
adFormat="vertical"
|
||||
className="demo-ad-strip__ad"
|
||||
/>
|
||||
|
||||
<div
|
||||
className="demo-ad-strip__banner"
|
||||
onClick={() => setShowMessage((prev) => !prev)}
|
||||
role="button"
|
||||
tabIndex={0}
|
||||
onKeyDown={(e) => { if (e.key === "Enter") setShowMessage((prev) => !prev); }}
|
||||
>
|
||||
<button
|
||||
className="demo-ad-strip__close"
|
||||
onClick={(e) => { e.stopPropagation(); setClosed(true); }}
|
||||
aria-label="Dismiss ad panel"
|
||||
>
|
||||
<X size={12} />
|
||||
</button>
|
||||
<span className="demo-ad-strip__banner-label">Why ads?</span>
|
||||
{showMessage ? (
|
||||
<span className="demo-ad-strip__banner-text">
|
||||
This isn't permanent — it's temporary because I'm a single
|
||||
dev and need to cover hosting costs. Thank you for understanding.
|
||||
</span>
|
||||
) : (
|
||||
<span className="demo-ad-strip__banner-text">
|
||||
Click to learn more
|
||||
</span>
|
||||
)}
|
||||
</div>
|
||||
</aside>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Commit**
|
||||
|
||||
```bash
|
||||
git add src/components/ads/DemoAdStrip.tsx src/components/ads/DemoAdStrip.css
|
||||
git commit -m "feat: add DemoAdStrip with Google AdSense vertical unit"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 7: Integrate into AppShell
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/components/layout/AppShell.tsx:8-9,168`
|
||||
|
||||
- [ ] **Step 1: Add import**
|
||||
|
||||
After the existing `CameraStatsPanel` import (line 8), add:
|
||||
|
||||
```tsx
|
||||
import CameraStatsPanel from "@/components/panels/CameraStatsPanel";
|
||||
import { DemoAdStrip } from "@/components/ads/DemoAdStrip"; // ADD THIS
|
||||
import { Timeline } from "@/components/timeline/Timeline";
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Add the JSX**
|
||||
|
||||
After `<EntityInfoCard />` (line 168), add:
|
||||
|
||||
```tsx
|
||||
<EntityInfoCard />
|
||||
<DemoAdStrip />
|
||||
<Timeline />
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Commit**
|
||||
|
||||
```bash
|
||||
git add src/components/layout/AppShell.tsx
|
||||
git commit -m "feat: integrate DemoAdStrip into AppShell"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 8: ads.txt for AdSense Verification
|
||||
|
||||
**Files:**
|
||||
- Create: `public/ads.txt`
|
||||
|
||||
- [ ] **Step 1: Create ads.txt**
|
||||
|
||||
```
|
||||
google.com, ca-pub-XXXXXXXXXXXXXXXX, DIRECT, f08c47fec0942fa0
|
||||
```
|
||||
|
||||
> Replace `ca-pub-XXXXXXXXXXXXXXXX` with your actual publisher ID. This file is required by AdSense for domain verification.
|
||||
|
||||
- [ ] **Step 2: Commit**
|
||||
|
||||
```bash
|
||||
git add public/ads.txt
|
||||
git commit -m "chore: add ads.txt for AdSense domain verification"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Open Questions
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **Do you have a Google AdSense publisher ID yet?** If not, you'll need to sign up at https://www.google.com/adsense/ and get your `ca-pub-XXXX` ID and create a 160x600 "Wide Skyscraper" ad unit to get the slot ID. The code will render nothing gracefully until these are configured.
|
||||
|
||||
> [!WARNING]
|
||||
> **CSP changes are required for AdSense to work.** The current CSP is restrictive and blocks `pagead2.googlesyndication.com` and `googleads.g.doubleclick.net`. Task 3 adds them. Without this, ads will be silently blocked by the browser.
|
||||
|
||||
---
|
||||
|
||||
## Verification Plan
|
||||
|
||||
### Manual Verification
|
||||
|
||||
1. Set `NEXT_PUBLIC_WWV_EDITION=demo` and `NEXT_PUBLIC_ADSENSE_CLIENT_ID=ca-pub-XXXX` in `.env.local`
|
||||
2. Run `pnpm dev`
|
||||
3. Verify: A 160px vertical strip appears on the right edge of the screen
|
||||
4. Verify: The "Why ads?" banner is clickable and toggles the explanation message
|
||||
5. Verify: Clicking the X dismisses the entire strip
|
||||
6. Verify: On mobile viewport widths (< 768px), the strip is hidden
|
||||
7. Verify: Set `NEXT_PUBLIC_WWV_EDITION=local` → strip does not render at all
|
||||
8. Verify: Browser console shows no CSP violations related to AdSense domains
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,145 +0,0 @@
|
||||
# Expand OSM Chips Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Expand the available OSM search chips to include a curated list of ~30 pre-loaded OSINT-relevant tags, and add a live Taginfo API autocomplete search to dynamically find and select any of the millions of other OSM tags.
|
||||
|
||||
**Architecture:** We will replace the current small `COMMON_TAGS` array with a richer, categorized list inside the `OSMSidebar` file. To allow access to "all" tags without crashing the UI, we will add a debounced fetch hook that hits `https://taginfo.openstreetmap.org/api/4/tags/popular` (or the equivalent search endpoint) when the user types in the filter box. These dynamically fetched tags will temporarily populate the chip list.
|
||||
|
||||
**Tech Stack:** React, TypeScript, Taginfo API
|
||||
|
||||
---
|
||||
|
||||
### Task 1: Update Pre-Loaded COMMON_TAGS
|
||||
|
||||
**Files:**
|
||||
- Modify: `c:\dev\worldwideview\packages\wwv-plugin-osm-search\src\components\OSMSidebar.tsx:6-11`
|
||||
|
||||
- [ ] **Step 1: Replace existing COMMON_TAGS array**
|
||||
|
||||
```tsx
|
||||
const COMMON_TAGS = [
|
||||
// Military & Security
|
||||
"military=base", "military=bunker", "amenity=police", "amenity=prison",
|
||||
// Aviation & Maritime
|
||||
"aeroway=aerodrome", "aeroway=helipad", "aeroway=hangar", "man_made=pier", "harbour=yes",
|
||||
// Infrastructure & Utilities
|
||||
"power=plant", "power=substation", "telecom=antenna", "man_made=communications_tower", "man_made=water_tower",
|
||||
// Transport
|
||||
"highway=bus_stop", "railway=station", "amenity=fuel", "amenity=parking",
|
||||
// Medical & Emergency
|
||||
"amenity=hospital", "amenity=fire_station", "amenity=clinic",
|
||||
// General Commercial & Industrial
|
||||
"shop=supermarket", "tourism=hotel", "industrial=factory", "landuse=industrial",
|
||||
// Education & Amenities
|
||||
"amenity=school", "amenity=university", "amenity=cafe", "building=house"
|
||||
];
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Commit**
|
||||
|
||||
```bash
|
||||
git add packages/wwv-plugin-osm-search/src/components/OSMSidebar.tsx
|
||||
git commit -m "feat(osm-search): expand quick preset tags with OSINT categories"
|
||||
```
|
||||
|
||||
### Task 2: Implement Taginfo Dynamic Autocomplete
|
||||
|
||||
**Files:**
|
||||
- Modify: `c:\dev\worldwideview\packages\wwv-plugin-osm-search\src\components\OSMSidebar.tsx`
|
||||
|
||||
- [ ] **Step 1: Add state and debounced fetch logic inside OSMSidebar component**
|
||||
|
||||
```tsx
|
||||
const [searchText, setSearchText] = useState("");
|
||||
const [activeTags, setActiveTags] = useState<string[]>([]);
|
||||
const [dynamicTags, setDynamicTags] = useState<string[]>([]);
|
||||
const [isSearchingApi, setIsSearchingApi] = useState(false);
|
||||
|
||||
// Add this useEffect below the useState hooks
|
||||
React.useEffect(() => {
|
||||
if (searchText.length < 3) {
|
||||
setDynamicTags([]);
|
||||
return;
|
||||
}
|
||||
|
||||
const timer = setTimeout(async () => {
|
||||
setIsSearchingApi(true);
|
||||
try {
|
||||
// Fetch tags matching the search term from OSM Taginfo
|
||||
const res = await fetch(`https://taginfo.openstreetmap.org/api/4/search/by_keyword?query=${encodeURIComponent(searchText)}`);
|
||||
const data = await res.json();
|
||||
if (data && data.data) {
|
||||
// Extract exact key=value pairs or just keys, format as "key=value"
|
||||
const tags = data.data
|
||||
.filter((item: any) => item.key && item.value)
|
||||
.map((item: any) => `${item.key}=${item.value}`)
|
||||
.slice(0, 15); // Limit to top 15 results
|
||||
setDynamicTags(tags);
|
||||
}
|
||||
} catch (err) {
|
||||
console.error("Taginfo fetch failed", err);
|
||||
} finally {
|
||||
setIsSearchingApi(false);
|
||||
}
|
||||
}, 500); // 500ms debounce
|
||||
|
||||
return () => clearTimeout(timer);
|
||||
}, [searchText]);
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Update rendering logic to merge static and dynamic tags**
|
||||
|
||||
Look for the `renderedTags` definition and replace it:
|
||||
|
||||
```tsx
|
||||
// Combine filtered common tags with newly fetched dynamic tags, removing duplicates
|
||||
const filteredCommon = searchText
|
||||
? COMMON_TAGS.filter(t => t.toLowerCase().includes(searchText.toLowerCase()))
|
||||
: COMMON_TAGS;
|
||||
|
||||
const renderedTags = Array.from(new Set([...filteredCommon, ...dynamicTags]));
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Add loading indicator to the search input area**
|
||||
|
||||
Look for the `<input>` element for `searchText` and wrap it/add a loading indicator:
|
||||
|
||||
```tsx
|
||||
<div style={{ position: "relative" }}>
|
||||
<input
|
||||
style={{
|
||||
width: "100%",
|
||||
padding: "8px",
|
||||
paddingRight: "24px",
|
||||
backgroundColor: "rgba(0,0,0,0.3)",
|
||||
color: "#fff",
|
||||
border: "1px solid var(--border-subtle)",
|
||||
borderRadius: "4px",
|
||||
fontSize: "13px"
|
||||
}}
|
||||
placeholder="Filter or search OSM for tags..."
|
||||
value={searchText}
|
||||
onChange={e => setSearchText(e.target.value)}
|
||||
/>
|
||||
{isSearchingApi && (
|
||||
<span style={{
|
||||
position: "absolute",
|
||||
right: "8px",
|
||||
top: "50%",
|
||||
transform: "translateY(-50%)",
|
||||
fontSize: "10px",
|
||||
color: "var(--text-muted)"
|
||||
}}>
|
||||
⏳
|
||||
</span>
|
||||
)}
|
||||
</div>
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Commit**
|
||||
|
||||
```bash
|
||||
git add packages/wwv-plugin-osm-search/src/components/OSMSidebar.tsx
|
||||
git commit -m "feat(osm-search): add live Taginfo autocomplete for unlisted tags"
|
||||
```
|
||||
@@ -1,139 +0,0 @@
|
||||
# Plugin Versioning Streamlining Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Refactor all WorldWideView plugin classes to derive their `version` property dynamically from their local `package.json` file rather than hardcoding string literals.
|
||||
|
||||
**Architecture:** We will replace the hardcoded `version = "x.y.z"` strings in the core `WorldPlugin` interface implementations across all monorepo packages. We will utilize TypeScript's JSON module resolution feature to `import pkg from "../package.json"` and map `version = pkg.version`. This ensures that `pnpm version patch` is the single source of truth and eliminates the double-bookkeeping that previously made CI fixes tedious.
|
||||
|
||||
**Tech Stack:** TypeScript, Next.js / bundler (JSON module resolution), pnpm workspaces.
|
||||
|
||||
---
|
||||
|
||||
## Task 1: Verify TypeScript Configuration
|
||||
|
||||
**Files:**
|
||||
- Modify: N/A (Verification step)
|
||||
|
||||
- [ ] **Step 1: Check `tsconfig.json` for JSON resolution**
|
||||
|
||||
Run: `cat tsconfig.json | grep resolveJsonModule`
|
||||
Expected: `"resolveJsonModule": true`
|
||||
|
||||
- [ ] **Step 2: Check compiler compatibility**
|
||||
|
||||
Run: `pnpm exec tsc --noEmit`
|
||||
Expected: PASS (exit code 0)
|
||||
|
||||
## Task 2: Refactor Group A Plugins (Core Infrastructure)
|
||||
|
||||
**Files:**
|
||||
- Modify: `packages/wwv-plugin-aviation/src/index.ts`
|
||||
- Modify: `packages/wwv-plugin-maritime/src/index.ts`
|
||||
- Modify: `packages/wwv-plugin-military-aviation/src/index.ts`
|
||||
|
||||
- [ ] **Step 1: Update plugin classes**
|
||||
|
||||
For each file above, modify the imports and the class body:
|
||||
|
||||
```typescript
|
||||
import pkg from "../package.json";
|
||||
// ...
|
||||
export class AviationPlugin implements WorldPlugin { // (or extends BasePlugin)
|
||||
// ...
|
||||
version = pkg.version;
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Verify compilation**
|
||||
|
||||
Run: `pnpm exec tsc --noEmit`
|
||||
Expected: PASS
|
||||
|
||||
- [ ] **Step 3: Commit**
|
||||
|
||||
```bash
|
||||
git commit -am "refactor(plugins): derive version dynamically for core infrastructure plugins [Patch]"
|
||||
```
|
||||
|
||||
## Task 3: Refactor Group B Plugins (Facilities & Infrastructure)
|
||||
|
||||
**Files:**
|
||||
- Modify: `packages/wwv-plugin-airports/src/index.ts`
|
||||
- Modify: `packages/wwv-plugin-seaports/src/index.ts`
|
||||
- Modify: `packages/wwv-plugin-spaceports/src/index.ts`
|
||||
- Modify: `packages/wwv-plugin-embassies/src/index.ts`
|
||||
- Modify: `packages/wwv-plugin-lighthouses/src/index.ts`
|
||||
- Modify: `packages/wwv-plugin-nuclear/src/index.ts`
|
||||
- Modify: `packages/wwv-plugin-undersea-cables/src/index.ts`
|
||||
- Modify: `packages/wwv-plugin-mineral-mines/src/index.ts`
|
||||
|
||||
- [ ] **Step 1: Update plugin classes**
|
||||
|
||||
For each file above, replace `version = "..."` with `version = pkg.version` and add `import pkg from "../package.json";`.
|
||||
|
||||
- [ ] **Step 2: Verify compilation**
|
||||
|
||||
Run: `pnpm exec tsc --noEmit`
|
||||
Expected: PASS
|
||||
|
||||
- [ ] **Step 3: Commit**
|
||||
|
||||
```bash
|
||||
git commit -am "refactor(plugins): derive version dynamically for facility plugins [Patch]"
|
||||
```
|
||||
|
||||
## Task 4: Refactor Group C Plugins (Hazards & Events)
|
||||
|
||||
**Files:**
|
||||
- Modify: `packages/wwv-plugin-earthquakes/src/index.ts`
|
||||
- Modify: `packages/wwv-plugin-volcanoes/src/index.ts`
|
||||
- Modify: `packages/wwv-plugin-wildfire/src/index.ts`
|
||||
- Modify: `packages/wwv-plugin-conflict-events/src/index.tsx`
|
||||
- Modify: `packages/wwv-plugin-conflict-zones/src/index.tsx`
|
||||
- Modify: `packages/wwv-plugin-civil-unrest/src/index.tsx`
|
||||
- Modify: `packages/wwv-plugin-cyber-attacks/src/index.tsx`
|
||||
- Modify: `packages/wwv-plugin-international-sanctions/src/index.tsx`
|
||||
|
||||
- [ ] **Step 1: Update plugin classes**
|
||||
|
||||
For each file above, replace `version = "..."` with `version = pkg.version` and add `import pkg from "../package.json";`. Note that some files are `.tsx`.
|
||||
|
||||
- [ ] **Step 2: Verify compilation**
|
||||
|
||||
Run: `pnpm exec tsc --noEmit`
|
||||
Expected: PASS
|
||||
|
||||
- [ ] **Step 3: Commit**
|
||||
|
||||
```bash
|
||||
git commit -am "refactor(plugins): derive version dynamically for event and hazard plugins [Patch]"
|
||||
```
|
||||
|
||||
## Task 5: Refactor Group D Plugins (Misc & Utilities)
|
||||
|
||||
**Files:**
|
||||
- Modify: `packages/wwv-plugin-satellite/src/index.ts`
|
||||
- Modify: `packages/wwv-plugin-surveillance-satellites/src/index.tsx`
|
||||
- Modify: `packages/wwv-plugin-osm-search/src/index.ts`
|
||||
- Modify: `packages/wwv-plugin-iranwarlive/src/index.ts`
|
||||
- Modify: `packages/wwv-plugin-daynight/src/index.ts`
|
||||
- Modify: `packages/wwv-plugin-camera/src/index.ts`
|
||||
- Modify: `packages/wwv-plugin-borders/src/index.ts`
|
||||
- Modify: `packages/wwv-plugin-gps-jamming/src/index.tsx`
|
||||
- Modify: `packages/wwv-plugin-air-defense/src/index.tsx`
|
||||
|
||||
- [ ] **Step 1: Update plugin classes**
|
||||
|
||||
For each file above, replace `version = "..."` with `version = pkg.version` and add `import pkg from "../package.json";`.
|
||||
|
||||
- [ ] **Step 2: Verify compilation and tests**
|
||||
|
||||
Run: `pnpm exec tsc --noEmit`
|
||||
Run: `pnpm test`
|
||||
Expected: PASS
|
||||
|
||||
- [ ] **Step 3: Commit**
|
||||
|
||||
```bash
|
||||
git commit -am "refactor(plugins): derive version dynamically for utility plugins [Patch]"
|
||||
```
|
||||
@@ -1,124 +0,0 @@
|
||||
# Demo Default Plugins Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Enable specific plugins by default on the demo edition via environment variables so the user is immediately impressed.
|
||||
|
||||
**Architecture:** Update `layersSlice.ts` to accept an optional `defaultEnabled` parameter in `initLayer`. In `AppShell.tsx`, look up `NEXT_PUBLIC_DEMO_DEFAULT_PLUGINS` when the edition is `demo`, and pass the flag true to `initLayer` for matching plugins during registration. Document the variable in `.env.example`.
|
||||
|
||||
**Tech Stack:** Next.js, Zustand, TypeScript.
|
||||
|
||||
---
|
||||
|
||||
### Task 1: Update layer slice definition
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/core/state/layersSlice.ts`
|
||||
|
||||
- [ ] **Step 1: Write the implementation**
|
||||
|
||||
Update `initLayer` in `src/core/state/layersSlice.ts` to accept a second parameter:
|
||||
|
||||
```typescript
|
||||
// Add defaultEnabled parameter to the interface
|
||||
export interface LayersSlice {
|
||||
// ...
|
||||
initLayer: (pluginId: string, defaultEnabled?: boolean) => void;
|
||||
}
|
||||
|
||||
// ...
|
||||
|
||||
// Use the parameter in the state updater
|
||||
initLayer: (pluginId, defaultEnabled = false) =>
|
||||
set((state) => ({
|
||||
layers: {
|
||||
...state.layers,
|
||||
[pluginId]: state.layers[pluginId] || { enabled: defaultEnabled, entityCount: 0, loading: false },
|
||||
},
|
||||
})),
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Commit**
|
||||
|
||||
```bash
|
||||
git add src/core/state/layersSlice.ts
|
||||
npm run commit -- "feat: add defaultEnabled param to initLayer in layers slice"
|
||||
```
|
||||
|
||||
### Task 2: Apply default configuration in AppShell
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/components/layout/AppShell.tsx`
|
||||
|
||||
- [ ] **Step 1: Write the implementation**
|
||||
|
||||
Add `isDemo` import at the top of `src/components/layout/AppShell.tsx`:
|
||||
|
||||
```typescript
|
||||
import { isDemo } from "@/core/edition";
|
||||
```
|
||||
|
||||
In `AppShell.tsx`, around line 71, inside `startPlatform()`, fetch the value from the environment if the instance is demo:
|
||||
|
||||
```typescript
|
||||
// Fetch disabled built-in plugins before registration
|
||||
let disabledIds = new Set<string>();
|
||||
// ... (keep existing try/catch block)
|
||||
|
||||
// Setup demo defaults
|
||||
const demoDefaultPlugins = new Set<string>();
|
||||
if (isDemo) {
|
||||
const envVar = process.env.NEXT_PUBLIC_DEMO_DEFAULT_PLUGINS || "";
|
||||
envVar.split(",").forEach(s => {
|
||||
const clean = s.trim();
|
||||
if (clean) demoDefaultPlugins.add(clean);
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
Then update the `pluginManager` registration loop to inject the boolean for `initLayer`:
|
||||
|
||||
```typescript
|
||||
for (const plugin of pluginRegistry.getAll()) {
|
||||
await pluginManager.registerPlugin(plugin);
|
||||
initLayer(plugin.id, demoDefaultPlugins.has(plugin.id));
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Run test to verify it passes**
|
||||
|
||||
Run type checks to verify no compilation issues:
|
||||
`npx tsc --noEmit`
|
||||
|
||||
- [ ] **Step 3: Commit**
|
||||
|
||||
```bash
|
||||
git add src/components/layout/AppShell.tsx
|
||||
npm run commit -- "feat: parse and apply default demo plugins via NEXT_PUBLIC_DEMO_DEFAULT_PLUGINS"
|
||||
```
|
||||
|
||||
### Task 3: Document environment definitions
|
||||
|
||||
**Files:**
|
||||
- Modify: `.env.example`
|
||||
- Modify: `.env`
|
||||
|
||||
- [ ] **Step 1: Write the implementation**
|
||||
|
||||
Update `.env.example` and `.env` around the `NEXT_PUBLIC_WWV_EDITION=local` definition:
|
||||
|
||||
```dotenv
|
||||
# Default plugins enabled on boot for demo edition
|
||||
# Comma-separated list of plugin IDs (e.g. aviation,maritime,iranwarlive)
|
||||
NEXT_PUBLIC_DEMO_DEFAULT_PLUGINS=
|
||||
|
||||
# Edition: "local" | "cloud" | "demo"
|
||||
NEXT_PUBLIC_WWV_EDITION=local
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Commit**
|
||||
|
||||
```bash
|
||||
git add .env.example .env
|
||||
npm run commit -- "docs: add NEXT_PUBLIC_DEMO_DEFAULT_PLUGINS to env templates"
|
||||
```
|
||||
@@ -1,177 +0,0 @@
|
||||
# Decouple Plugin Proxies Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Strip out hardcoded proxy endpoints from the `worldwideview` core repository to enforce a fully decoupled plugin ecosystem, replacing them with direct browser fetching or a universal CORS proxy.
|
||||
|
||||
**Architecture:** Remove preferential API routes (`/api/earthquake`, `/api/undersea-cables`, `/api/camera/*`) from the `worldwideview` core app. Promote the existing camera proxy to a universal `/api/proxy` with strict SSRF defenses. Provide direct browser-fetch code for the `wwv-plugin-earthquakes` where CORS permits, and migrate traffic camera fetchers directly into the `wwv-plugin-camera` package to fetch via the universal proxy.
|
||||
|
||||
**Tech Stack:** Next.js 16 (App Router), TypeScript, pnpm workspace
|
||||
|
||||
---
|
||||
|
||||
### Task 1: Promote Universal Proxy in Core Repository
|
||||
|
||||
**Files:**
|
||||
- Create (Move): `src/app/api/proxy/route.ts`
|
||||
- Delete: `src/app/api/camera/proxy/route.ts`
|
||||
|
||||
- [ ] **Step 1: Relocate the proxy route and update logs**
|
||||
|
||||
Move the existing camera proxy to act as a system-wide universal proxy.
|
||||
|
||||
Run: `mkdir -p src/app/api/proxy`
|
||||
Run: `mv src/app/api/camera/proxy/route.ts src/app/api/proxy/route.ts`
|
||||
|
||||
- [ ] **Step 2: Update the error logging prefix in the new file**
|
||||
|
||||
Modify `src/app/api/proxy/route.ts` near line 97:
|
||||
|
||||
```json
|
||||
{
|
||||
"instruction": "Update the error logging prefix",
|
||||
"replace_chunks": [
|
||||
{
|
||||
"start_line": 96,
|
||||
"end_line": 98,
|
||||
"target_content": " } catch (error: any) {\n console.error(\"[CameraProxy] Error fetching target URL:\", error);\n return NextResponse.json(",
|
||||
"replacement_content": " } catch (error: any) {\n console.error(\"[UniversalProxy] Error fetching target URL:\", error);\n return NextResponse.json("
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Commit the Universal Proxy**
|
||||
|
||||
```bash
|
||||
git add src/app/api/proxy/route.ts src/app/api/camera/proxy/route.ts
|
||||
git commit -m "refactor: promote camera proxy to universal proxy"
|
||||
```
|
||||
|
||||
### Task 2: Strip Preferential Proxy Routes From Core Application
|
||||
|
||||
**Files:**
|
||||
- Delete: `src/app/api/earthquake/route.ts`
|
||||
- Delete: `src/app/api/undersea-cables/route.ts`
|
||||
- Delete: everything in `src/app/api/camera` codebase (`caltrans`, `extract`, `gdot`, `test`, `tfl`, `traffic`)
|
||||
|
||||
- [ ] **Step 1: Delete all plugin-specific Next.js API routes**
|
||||
|
||||
Run: `rm -rf src/app/api/earthquake`
|
||||
Run: `rm -rf src/app/api/undersea-cables`
|
||||
|
||||
**WAIT**: For `src/app/api/camera`, we must physically copy the fetchers into `worldwideview-plugins` before we delete them.
|
||||
|
||||
Run: `cp -r src/app/api/camera/caltrans ../worldwideview-plugins/packages/wwv-plugin-camera/src/`
|
||||
Run: `cp -r src/app/api/camera/gdot ../worldwideview-plugins/packages/wwv-plugin-camera/src/`
|
||||
Run: `cp -r src/app/api/camera/tfl ../worldwideview-plugins/packages/wwv-plugin-camera/src/`
|
||||
Run: `rm -rf src/app/api/camera`
|
||||
|
||||
- [ ] **Step 2: Commit the deleted API routes**
|
||||
|
||||
```bash
|
||||
git add src/app/api/earthquake src/app/api/undersea-cables src/app/api/camera
|
||||
git commit -m "refactor!: strip preferential plugin APIs from core"
|
||||
```
|
||||
|
||||
### Task 3: Migrate Earthquakes and Undersea Cables Plugins
|
||||
|
||||
**Files:**
|
||||
- Modify: `../worldwideview-plugins/packages/wwv-plugin-earthquakes/src/index.ts`
|
||||
- Modify: `../worldwideview-plugins/packages/wwv-plugin-undersea-cables/src/index.ts`
|
||||
|
||||
- [ ] **Step 1: Update Earthquakes plugin to direct browser fetch (Option A)**
|
||||
|
||||
In `../worldwideview-plugins/packages/wwv-plugin-earthquakes/src/index.ts`, replace the `/api/earthquake` fetch with the USGS direct URL.
|
||||
|
||||
```json
|
||||
{
|
||||
"instruction": "Replace the API fetch with direct USGS fetch and remove apiBasePath",
|
||||
"replace_chunks": [
|
||||
{
|
||||
"start_line": 38,
|
||||
"end_line": 40,
|
||||
"target_content": " try {\n const res = await globalThis.fetch(`/api/earthquake`);\n if (!res.ok) {",
|
||||
"replacement_content": " try {\n const res = await globalThis.fetch(`https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/all_day.geojson`);\n if (!res.ok) {"
|
||||
},
|
||||
{
|
||||
"start_line": 94,
|
||||
"end_line": 96,
|
||||
"target_content": " getServerConfig(): ServerPluginConfig {\n return { apiBasePath: \"/api/earthquake\", pollingIntervalMs: 120000, historyEnabled: false };\n }",
|
||||
"replacement_content": " getServerConfig(): ServerPluginConfig {\n return { pollingIntervalMs: 120000, historyEnabled: false };\n }"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Update Undersea Cables plugin to use Universal Proxy (Option B)**
|
||||
|
||||
In `../worldwideview-plugins/packages/wwv-plugin-undersea-cables/src/index.ts`:
|
||||
|
||||
```json
|
||||
{
|
||||
"instruction": "Proxy route to universal proxy",
|
||||
"replace_chunks": [
|
||||
{
|
||||
"start_line": 35,
|
||||
"end_line": 37,
|
||||
"target_content": " // Proxy route to bypass CORS for Telegeography submarine cable map API\n const url = \"/api/undersea-cables\";\n ",
|
||||
"replacement_content": " // Proxy route to bypass CORS for Telegeography submarine cable map API\n const targetUrl = encodeURIComponent(\"https://www.submarinecablemap.com/api/v3/cable/cable-geo.json\");\n const url = `/api/proxy?url=${targetUrl}`;\n "
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Commit the plugin migrations**
|
||||
|
||||
```bash
|
||||
cd ../worldwideview-plugins
|
||||
git add packages/wwv-plugin-earthquakes/src/index.ts packages/wwv-plugin-undersea-cables/src/index.ts
|
||||
git commit -m "refactor: transition earthquake and undersea cables to decoupled fetching"
|
||||
cd ../worldwideview
|
||||
```
|
||||
|
||||
### Task 4: Refactor Camera Plugin to Fetch Natively
|
||||
|
||||
**Files:**
|
||||
- Modify: `../worldwideview-plugins/packages/wwv-plugin-camera/src/index.ts`
|
||||
- Delete: `caltrans`, `gdot`, `tfl` previously copied components (combine into `trafficFetchers.ts`)
|
||||
|
||||
- [ ] **Step 1: Consolidate the camera fetchers**
|
||||
|
||||
Create `../worldwideview-plugins/packages/wwv-plugin-camera/src/trafficFetchers.ts`.
|
||||
Migrate the code from the `caltransFetcher.ts`, `gdotFetcher.ts`, and `tflFetcher.ts` files that we copied in Task 2.
|
||||
Crucially, when doing `fetch(...)` in these fetchers, if the endpoint doesn't support CORS, wrap it in `/api/proxy?url=${encodeURIComponent(...) }` so the browser can fetch it. Ensure the data models align.
|
||||
|
||||
- [ ] **Step 2: Update `wwv-plugin-camera/src/index.ts` to call the fetchers natively**
|
||||
|
||||
In `../worldwideview-plugins/packages/wwv-plugin-camera/src/index.ts` function `loadTrafficCameras()`:
|
||||
|
||||
```json
|
||||
{
|
||||
"instruction": "Replace API fetch with native client-side parallel fetching",
|
||||
"replace_chunks": [
|
||||
{
|
||||
"start_line": 106,
|
||||
"end_line": 118,
|
||||
"target_content": " private async loadTrafficCameras(): Promise<void> {\n try {\n const res = await fetch(\"/api/camera/traffic\");\n if (!res.ok) throw new Error(`API returned ${res.status}`);\n const data = await res.json();\n if (data.cameras && Array.isArray(data.cameras)) {\n this.sourceBuckets[\"default\"] = data.cameras.map(\n (f: unknown, i: number) => mapGeoJsonFeature(f, i, \"traffic\"),\n );\n }\n } catch (err) {\n console.warn(\"[CameraPlugin] Traffic cameras API failed:\", err);\n }",
|
||||
"replacement_content": " private async loadTrafficCameras(): Promise<void> {\n try {\n const { fetchCaltrans, fetchGdot, fetchTfl } = await import(\"./trafficFetchers\");\n const [caltrans, gdot, tfl] = await Promise.allSettled([\n fetchCaltrans(), fetchGdot(), fetchTfl()\n ]);\n \n const cameras = [];\n if (caltrans.status === \"fulfilled\") cameras.push(...caltrans.value);\n if (gdot.status === \"fulfilled\") cameras.push(...gdot.value);\n if (tfl.status === \"fulfilled\") cameras.push(...tfl.value);\n\n if (cameras.length > 0) {\n this.sourceBuckets[\"default\"] = cameras.map(\n (f: unknown, i: number) => mapGeoJsonFeature(f, i, \"traffic\"),\n );\n }\n } catch (err) {\n console.warn(\"[CameraPlugin] Traffic cameras API failed:\", err);\n }"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Remove the extra node API files from the plugin source tree**
|
||||
|
||||
Run: `rm -rf ../worldwideview-plugins/packages/wwv-plugin-camera/src/caltrans`
|
||||
Run: `rm -rf ../worldwideview-plugins/packages/wwv-plugin-camera/src/gdot`
|
||||
Run: `rm -rf ../worldwideview-plugins/packages/wwv-plugin-camera/src/tfl`
|
||||
|
||||
- [ ] **Step 4: Commit Camera plugin refactoring**
|
||||
|
||||
```bash
|
||||
cd ../worldwideview-plugins
|
||||
git add packages/wwv-plugin-camera/src
|
||||
git commit -m "feat: migrate traffic camera fetchers to client-side plugin bundle"
|
||||
cd ../worldwideview
|
||||
```
|
||||
+41
-1
@@ -38,5 +38,45 @@ Execute the following commands from the root `worldwideview` directory:
|
||||
```
|
||||
|
||||
## Reference
|
||||
- **Coverage Scope:** The Vitest configuration primarily targets tests located inside `src/lib/**`, `src/core/**`, and `src/plugins/**`.
|
||||
- **Coverage Scope:** The Vitest configuration targets tests located inside `src/lib/**`, `src/core/**`, `src/plugins/**`, `src/app/**`, and `packages/**`.
|
||||
- **Environment:** The test environment is configured as `jsdom` via `vite.config.ts` or `vitest.config.ts`, ensuring that DOM-specific API calls function outside of a real browser.
|
||||
|
||||
## Patterns
|
||||
|
||||
### Plain function — no mocks needed
|
||||
Pull in the function, call it with representative inputs, assert the output. See `src/lib/marketplace/cors.test.ts` or `src/app/api/camera/adapters/registry.test.ts` for examples.
|
||||
|
||||
### Stateful singleton — reset in `afterEach`
|
||||
Most of the data layer (`dataBus`, `cacheLayer`, `pollingManager`) is exported as a singleton instance. Tests pass when run alone but fail when run together if state leaks. `DataBus.test.ts` shows the canonical cleanup:
|
||||
|
||||
```typescript
|
||||
import { dataBus } from "./DataBus";
|
||||
|
||||
afterEach(() => {
|
||||
dataBus.removeAllListeners();
|
||||
});
|
||||
```
|
||||
|
||||
### Module-level dependency — mock with `vi.mock`
|
||||
When the module under test pulls in something heavy (the store, the database, Cesium), mock that module before the import. `vi.mock` calls are hoisted, so they take effect even when written below the import in source order. See `src/lib/marketplace/repository.test.ts` (Prisma client) or `src/core/data/PollingManager.test.ts` (Zustand store).
|
||||
|
||||
### Timers — fake them per test
|
||||
`vi.useFakeTimers()` in `beforeEach`, `vi.useRealTimers()` in `afterEach`. Advance time explicitly with `vi.advanceTimersByTimeAsync(ms)`.
|
||||
|
||||
> [!CAUTION]
|
||||
> `vi.runOnlyPendingTimersAsync()` ticks `setInterval`s scheduled on the same tick as the call. For tests where a function runs once synchronously and then schedules a recurring interval, this double-counts the first call. To drain microtasks without advancing the clock, use `await Promise.resolve()` a few times — see `PollingManager.test.ts` for the `flushMicrotasks()` helper.
|
||||
|
||||
## What NOT to Test (Yet)
|
||||
|
||||
- **Cesium-heavy components.** Anything that mounts a `<Viewer>` or renders entities to the globe needs WebGL, which jsdom doesn't provide. These belong in Playwright-style E2E tests rather than unit tests.
|
||||
- **Live database round-trips.** Mock the Prisma client at the module boundary — `repository.test.ts` is the reference pattern. Spinning up a real Postgres in CI is expensive and unreliable.
|
||||
- **Dynamic-import plugin bundles.** The loader uses `import(/* webpackIgnore: true */ entry)` at runtime against a real URL. Test the loader's pre-import logic with a fake module object, not a real dynamic import.
|
||||
|
||||
## Philosophy
|
||||
|
||||
A small focused suite is more valuable than a large one that's expensive to maintain. Each test should answer: *what specific regression does this catch that I'd otherwise discover from a user bug report?*
|
||||
|
||||
Two practical rules:
|
||||
|
||||
1. **Prefer testing pure logic over orchestration.** If a function takes inputs and returns outputs, test it directly. If it coordinates a half-dozen other things (the globe, the store, Cesium primitives), either refactor the pure parts out or use an integration test.
|
||||
2. **Add a test when you fix a bug.** A one-line test that fails today and passes after the fix is enough to prevent the bug from coming back. Land the test in the same PR as the fix.
|
||||
@@ -1,6 +0,0 @@
|
||||
const { PrismaClient } = require('./src/generated/prisma');
|
||||
const prisma = new PrismaClient();
|
||||
prisma.installedPlugin.findMany().then(r => console.log(JSON.stringify(r.map(record => {
|
||||
const manifest = JSON.parse(record.config);
|
||||
return { id: manifest.id, entry: manifest.entry, format: manifest.format };
|
||||
}), null, 2))).catch(console.error).finally(() => prisma.$disconnect());
|
||||
@@ -1,9 +0,0 @@
|
||||
import sqlite3
|
||||
import json
|
||||
conn = sqlite3.connect('data/wwv.db')
|
||||
cursor = conn.cursor()
|
||||
cursor.execute('SELECT id, dataSource FROM installed_plugins')
|
||||
rows = cursor.fetchall()
|
||||
for r in rows:
|
||||
if r[1]:
|
||||
print(f"plugin={r[0]}, dataSource={r[1]}")
|
||||
@@ -0,0 +1,47 @@
|
||||
import nextCoreWebVitals from "eslint-config-next/core-web-vitals";
|
||||
import nextTypeScript from "eslint-config-next/typescript";
|
||||
|
||||
export default [
|
||||
{
|
||||
ignores: [
|
||||
"node_modules/**",
|
||||
".next/**",
|
||||
"out/**",
|
||||
"src/generated/**",
|
||||
"public/cesium/**",
|
||||
"packages/*/dist/**",
|
||||
".worktrees/**",
|
||||
"local-scripts/**",
|
||||
"local-plugins/**",
|
||||
"local-seeders/**",
|
||||
".agents/**",
|
||||
".claude/**",
|
||||
],
|
||||
},
|
||||
...nextCoreWebVitals,
|
||||
...nextTypeScript,
|
||||
{
|
||||
rules: {
|
||||
// ─── Demoted on first introduction ─────────────────────────────
|
||||
// The existing codebase has hundreds of violations across these
|
||||
// rules. To make the lint job runnable in CI without blocking on
|
||||
// pre-existing debt, every rule that currently fires errors is
|
||||
// demoted to `warn`. Promote back to `error` once the backlog
|
||||
// is addressed (recommended in this order: prefer-const,
|
||||
// no-unescaped-entities, ban-ts-comment, then the react-hooks
|
||||
// family once the team agrees on the React 19 hook-purity rules).
|
||||
|
||||
// Pre-existing — flagged in the original code review (#96):
|
||||
"@typescript-eslint/no-explicit-any": "warn",
|
||||
"no-console": "off",
|
||||
|
||||
// React 19 hook-purity rules from eslint-plugin-react-hooks 7+:
|
||||
// (These were previously hallucinated or require extra plugins)
|
||||
|
||||
// Misc one-offs across the codebase:
|
||||
"@typescript-eslint/ban-ts-comment": "warn",
|
||||
"@next/next/no-assign-module-variable": "warn",
|
||||
"prefer-const": "warn",
|
||||
},
|
||||
},
|
||||
];
|
||||
@@ -15,6 +15,9 @@ pnpm install
|
||||
Write-Host "[*] Running initial setup (generating secrets)..."
|
||||
pnpm run setup
|
||||
|
||||
Write-Host "[*] Generating Prisma client..."
|
||||
npx prisma generate
|
||||
|
||||
# Check for the sibling Data Engine repository
|
||||
if (-not (Test-Path "../wwv-data-engine")) {
|
||||
Write-Host ""
|
||||
@@ -32,6 +35,21 @@ if (-not (Test-Path "../wwv-data-engine")) {
|
||||
Write-Host ""
|
||||
}
|
||||
|
||||
Write-Host ""
|
||||
Write-Host "=====================================================================" -ForegroundColor Cyan
|
||||
Write-Host "[!] DATABASE SETUP REQUIRED" -ForegroundColor Cyan
|
||||
Write-Host ""
|
||||
Write-Host "WorldWideView uses PostgreSQL. Choose one option:" -ForegroundColor White
|
||||
Write-Host ""
|
||||
Write-Host " Option A (Easiest): Run Prisma's built-in local database:" -ForegroundColor Green
|
||||
Write-Host " npx prisma dev" -ForegroundColor Yellow
|
||||
Write-Host " (Copy the DATABASE_URL it prints into your .env.local file)" -ForegroundColor Gray
|
||||
Write-Host ""
|
||||
Write-Host " Option B: Use your own PostgreSQL or Supabase instance:" -ForegroundColor Green
|
||||
Write-Host " Set DATABASE_URL in .env.local to your connection string" -ForegroundColor Gray
|
||||
Write-Host "=====================================================================" -ForegroundColor Cyan
|
||||
Write-Host ""
|
||||
|
||||
Write-Host "[*] Starting local Next.js frontend server..."
|
||||
Write-Host " (To run the data engine backends concurrently, run: pnpm dev:all)"
|
||||
pnpm run dev
|
||||
@@ -0,0 +1 @@
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
# Local Plugins
|
||||
|
||||
This directory is a **pnpm workspace** for developing plugins locally without committing them to the main repository.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Scaffold a new plugin
|
||||
node packages/wwv-cli/dist/index.js create
|
||||
|
||||
# Start dev server (auto-discovers local plugins)
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
## How It Works
|
||||
|
||||
1. Plugins here get full SDK type support via `workspace:*` linking
|
||||
2. The pre-dev script auto-builds each plugin with Vite
|
||||
3. Built bundles are copied to `public/plugins-local/`
|
||||
4. The marketplace load API auto-discovers them in dev mode
|
||||
5. Everything in this directory is gitignored
|
||||
|
||||
## Publishing to NPM
|
||||
|
||||
When your plugin is ready to share, you can publish it directly to NPM from the root directory:
|
||||
|
||||
```bash
|
||||
node packages/wwv-cli/dist/index.js publish <plugin-name> [--org <your-org>]
|
||||
```
|
||||
Whitespace-only changes.
+17
-26
@@ -2,14 +2,17 @@ import type { NextConfig } from "next";
|
||||
|
||||
const nextConfig: NextConfig = {
|
||||
output: "standalone",
|
||||
serverExternalPackages: ["better-sqlite3", "@prisma/adapter-better-sqlite3", "@prisma/client", "prisma"],
|
||||
transpilePackages: ["@worldwideview/wwv-plugin-sdk", "resium", "react-player", "satellite.js"],
|
||||
serverExternalPackages: ["@prisma/client", "prisma"],
|
||||
transpilePackages: ["@worldwideview/wwv-plugin-sdk", "resium", "react-player", "satellite.js", "@worldwideview/wwv-plugin-fortiguard", "@worldwideview/wwv-plugin-nz-traffic-cameras"],
|
||||
allowedDevOrigins: process.env.ALLOWED_DEV_ORIGIN ? [process.env.ALLOWED_DEV_ORIGIN] : undefined,
|
||||
experimental: {
|
||||
memoryBasedWorkersCount: true,
|
||||
cpus: 2,
|
||||
optimizePackageImports: ["lucide-react"],
|
||||
},
|
||||
outputFileTracingIncludes: {
|
||||
"/*": ["./scripts/**/*"],
|
||||
},
|
||||
typescript: {
|
||||
ignoreBuildErrors: true,
|
||||
},
|
||||
@@ -32,8 +35,8 @@ const nextConfig: NextConfig = {
|
||||
"connect-src 'self' http: https: ws: wss:",
|
||||
// HLS video streams from arbitrary camera sources
|
||||
"media-src 'self' blob: http: https:",
|
||||
// Embeddable video platforms for camera iframes
|
||||
"frame-src 'self' *.youtube.com *.youtube-nocookie.com *.twitch.tv *.vimeo.com *.webcamera.pl *.ivideon.com *.rtsp.me *.bnu.tv https://googleads.g.doubleclick.net https://tpc.googlesyndication.com https://ep2.adtrafficquality.google https://*.google.com",
|
||||
// Embeddable video platforms for camera iframes — needs to support arbitrary domains
|
||||
"frame-src 'self' http: https: blob:",
|
||||
"worker-src 'self' blob:",
|
||||
"frame-ancestors 'none'",
|
||||
].join("; "),
|
||||
@@ -52,12 +55,20 @@ const nextConfig: NextConfig = {
|
||||
},
|
||||
|
||||
outputFileTracingExcludes: {
|
||||
"*": ["./public/cesium/**"],
|
||||
"*": [
|
||||
"./public/cesium/**"
|
||||
],
|
||||
},
|
||||
env: {
|
||||
CESIUM_BASE_URL: "/cesium",
|
||||
},
|
||||
webpack: (config, { isServer, webpack }) => {
|
||||
config.ignoreWarnings = [
|
||||
{ module: /node_modules[\\/]@opentelemetry/ },
|
||||
{ module: /node_modules[\\/]require-in-the-middle/ },
|
||||
{ module: /node_modules[\\/]@sentry/ },
|
||||
];
|
||||
|
||||
if (!isServer) {
|
||||
// Define CESIUM_BASE_URL for Cesium's worker resolution
|
||||
config.plugins?.push(
|
||||
@@ -82,24 +93,4 @@ const nextConfig: NextConfig = {
|
||||
},
|
||||
};
|
||||
|
||||
import { withSentryConfig } from "@sentry/nextjs";
|
||||
|
||||
export default withSentryConfig(nextConfig, {
|
||||
// For all available options, see:
|
||||
// https://github.com/getsentry/sentry-webpack-plugin#options
|
||||
org: process.env.SENTRY_ORG,
|
||||
project: process.env.SENTRY_PROJECT,
|
||||
sentryUrl: process.env.GLITCHTIP_SERVER_URL,
|
||||
authToken: process.env.SENTRY_AUTH_TOKEN,
|
||||
|
||||
// Automatically tree-shake Sentry logger statements to reduce bundle size
|
||||
disableLogger: true,
|
||||
|
||||
// Hides source maps from generated client bundles
|
||||
sourcemaps: {
|
||||
disable: true,
|
||||
},
|
||||
|
||||
// Upload a larger set of source maps for prettier stack traces (increases build time)
|
||||
widenClientFileUpload: true,
|
||||
});
|
||||
export default nextConfig;
|
||||
+74
-27
@@ -1,75 +1,122 @@
|
||||
{
|
||||
"name": "worldwideview",
|
||||
"version": "1.19.7",
|
||||
"version": "2.15.8",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"packageManager": "[email protected]",
|
||||
"scripts": {
|
||||
"setup": "node scripts/setup.mjs",
|
||||
"test-worktree": "node scripts/test-worktree.mjs",
|
||||
"clean": "node -e \"const fs=require('fs');fs.rmSync('.next',{recursive:true,force:true})\"",
|
||||
"dev": "next dev --webpack",
|
||||
"dev:all": "concurrently -n \"next,backends\" -c \"magenta,blue\" \"pnpm dev\" \"pnpm dev:backends\"",
|
||||
"dev:backends": "cd ../wwv-data-engine && pnpm dev",
|
||||
"predev": "npx prisma migrate deploy && node scripts/copy-cesium.mjs",
|
||||
"dev": "node scripts/dev.mjs",
|
||||
"dev:all": "concurrently -n \"dev,backends\" -c \"magenta,blue\" \"pnpm dev\" \"pnpm dev:backends\"",
|
||||
"dev:backends": "docker compose --profile engine up wwv-data-engine wwv-redis",
|
||||
"dev:plugins": "node scripts/watch-local-plugins.mjs",
|
||||
"predev": "node scripts/boot-db.mjs && npx dotenv-cli -c -- node scripts/safe-db-push.mjs && npx prisma generate && node scripts/copy-cesium.mjs && node scripts/sync-local-plugins.mjs",
|
||||
"copy-cesium": "node scripts/copy-cesium.mjs",
|
||||
"prebuild": "node scripts/check-build-env.mjs",
|
||||
"build": "next build --webpack",
|
||||
"start": "next start",
|
||||
"test": "vitest run",
|
||||
"db:reset": "npx prisma migrate reset --force"
|
||||
"test:e2e": "playwright test",
|
||||
"test:mutate": "stryker run",
|
||||
"lint": "eslint .",
|
||||
"db:reset": "npx prisma migrate reset --force",
|
||||
"db:prune": "node scripts/db-prune.mjs",
|
||||
"generate": "prisma generate"
|
||||
},
|
||||
"dependencies": {
|
||||
"@auth/prisma-adapter": "^2.11.1",
|
||||
"@prisma/adapter-better-sqlite3": "^7.5.0",
|
||||
"@prisma/client": "^7.5.0",
|
||||
"@sentry/nextjs": "^10.48.0",
|
||||
"@supabase/supabase-js": "^2.98.0",
|
||||
"@auth/prisma-adapter": "^2.11.2",
|
||||
"@auth/supabase-adapter": "^1.11.2",
|
||||
"@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",
|
||||
"@types/pg": "^8.20.0",
|
||||
"@vercel/analytics": "^1.6.1",
|
||||
"@worldwideview/wwv-plugin-sdk": "workspace:*",
|
||||
"bcryptjs": "^3.0.3",
|
||||
"cesium": "^1.139.0",
|
||||
"cesium": "^1.141.0",
|
||||
"cheerio": "^1.2.0",
|
||||
"hls.js": "^1.6.15",
|
||||
"hls.js": "^1.6.16",
|
||||
"insecam-api": "^0.0.3",
|
||||
"jose": "^6.2.2",
|
||||
"lucide-react": "^0.576.0",
|
||||
"next": "16.2.3",
|
||||
"jose": "^6.2.3",
|
||||
"lucide-react": "^1.14.0",
|
||||
"next": "16.2.6",
|
||||
"next-auth": "^5.0.0-beta.30",
|
||||
"prisma": "^7.5.0",
|
||||
"react": "19.2.3",
|
||||
"react-dom": "19.2.3",
|
||||
"openid-client": "^6.8.4",
|
||||
"pg": "^8.20.0",
|
||||
"prisma": "^7.8.0",
|
||||
"react": "19.2.6",
|
||||
"react-dom": "19.2.6",
|
||||
"react-player": "^3.4.0",
|
||||
"resium": "1.19.4",
|
||||
"resium": "1.21.0",
|
||||
"satellite.js": "^7.0.0",
|
||||
"stripe": "^22.1.1",
|
||||
"tslib": "^2.8.1",
|
||||
"undici": "^8.2.0",
|
||||
"ws": "^8.14.2",
|
||||
"zustand": "^5.0.11"
|
||||
"zod": "^4.4.3",
|
||||
"zustand": "^5.0.13"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@eslint/compat": "^2.1.0",
|
||||
"@eslint/eslintrc": "^3.3.5",
|
||||
"@playwright/test": "^1.60.0",
|
||||
"@stryker-mutator/core": "^9.6.1",
|
||||
"@stryker-mutator/vitest-runner": "^9.6.1",
|
||||
"@testing-library/dom": "^10.4.1",
|
||||
"@testing-library/react": "^16.3.2",
|
||||
"@types/bcryptjs": "^3.0.0",
|
||||
"@types/cesium": "^1.70.4",
|
||||
"@types/node": "^20",
|
||||
"@types/node": "^25",
|
||||
"@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",
|
||||
"@vitest/coverage-v8": "4.1.6",
|
||||
"concurrently": "^9.2.1",
|
||||
"copy-webpack-plugin": "^14.0.0",
|
||||
"eslint": "^9",
|
||||
"eslint-config-airbnb": "^19.0.4",
|
||||
"eslint-config-airbnb-typescript": "^18.0.0",
|
||||
"eslint-config-next": "^16.2.6",
|
||||
"eslint-plugin-import": "^2.32.0",
|
||||
"eslint-plugin-jsx-a11y": "^6.10.2",
|
||||
"eslint-plugin-react": "^7.37.5",
|
||||
"eslint-plugin-react-hooks": "^7.1.1",
|
||||
"fast-check": "^4.8.0",
|
||||
"jsdom": "^28.1.0",
|
||||
"rollup-plugin-external-globals": "^0.13.0",
|
||||
"tree-kill": "^1.2.2",
|
||||
"tsx": "^4.21.0",
|
||||
"typescript": "^5",
|
||||
"vite": "^8.0.8",
|
||||
"vitest": "^4.0.18"
|
||||
"vite": "^8.0.12",
|
||||
"vitest": "^4.1.6"
|
||||
},
|
||||
"pnpm": {
|
||||
"overrides": {
|
||||
"@spz-loader/core": "0.3.0",
|
||||
"form-data@<2.5.4": "^2.5.5",
|
||||
"form-data@>=3.0.0 <3.0.4": "^3.0.4",
|
||||
"form-data@>=4.0.0 <4.0.4": "^4.0.5",
|
||||
"fast-uri@<3.1.2": "^3.1.2"
|
||||
},
|
||||
"onlyBuiltDependencies": [
|
||||
"@prisma/engines",
|
||||
"better-sqlite3",
|
||||
"esbuild",
|
||||
"@sentry/cli",
|
||||
"prisma",
|
||||
"protobufjs",
|
||||
"sharp",
|
||||
"unrs-resolver"
|
||||
"esbuild",
|
||||
"better-sqlite3"
|
||||
]
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=20.0.0",
|
||||
"pnpm": ">=9.0.0"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,47 @@
|
||||
# @worldwideview/wwv-cli
|
||||
|
||||
The official Command Line Interface for scaffolding and publishing WorldWideView plugins.
|
||||
|
||||
## Usage
|
||||
|
||||
This CLI is designed to be run from within the `worldwideview` monorepo.
|
||||
|
||||
### 1. Scaffold a new plugin
|
||||
```bash
|
||||
node packages/wwv-cli/dist/index.js create
|
||||
```
|
||||
This command generates a new plugin directory with a boilerplate `index.ts` and `package.json` configured for the WorldWideView plugin architecture inside the `local-plugins/` directory.
|
||||
|
||||
*(Note: To create a built-in plugin inside `packages/` instead, use the `--core` flag).*
|
||||
|
||||
### 2. Publish a plugin
|
||||
Once your plugin is ready for release, you can publish it to NPM. You can do this from within the plugin directory or directly from the project root.
|
||||
|
||||
**From the plugin directory:**
|
||||
```bash
|
||||
cd local-plugins/<plugin-name>
|
||||
npm login
|
||||
node ../../packages/wwv-cli/dist/index.js publish
|
||||
```
|
||||
|
||||
**From the project root:**
|
||||
You can also run the CLI from the root by providing the plugin name:
|
||||
```bash
|
||||
node packages/wwv-cli/dist/index.js publish <plugin-name>
|
||||
```
|
||||
|
||||
**Custom NPM Organizations:**
|
||||
By default, plugins are scaffolded under the `@worldwideview` NPM scope. To publish to your own organization, use the `--org` flag:
|
||||
```bash
|
||||
node packages/wwv-cli/dist/index.js publish <plugin-name> --org my-username
|
||||
```
|
||||
This will permanently update your `package.json` to use `@my-username` and publish the package.
|
||||
|
||||
The publish command verifies that your `package.json` contains the required `"worldwideview"` manifest block and invokes `npm publish --access public`.
|
||||
|
||||
## Development
|
||||
|
||||
To re-compile the CLI during development:
|
||||
```bash
|
||||
pnpm --filter @worldwideview/wwv-cli run build
|
||||
```
|
||||
@@ -0,0 +1,24 @@
|
||||
{
|
||||
"name": "@worldwideview/wwv-cli",
|
||||
"version": "1.2.0",
|
||||
"type": "module",
|
||||
"description": "WorldWideView CLI",
|
||||
"main": "dist/index.js",
|
||||
"bin": {
|
||||
"wwv": "dist/index.js"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "tsc",
|
||||
"dev": "tsc --watch",
|
||||
"clean": "rm -rf dist"
|
||||
},
|
||||
"dependencies": {
|
||||
"commander": "^12.1.0",
|
||||
"prompts": "^2.4.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^20.0.0",
|
||||
"@types/prompts": "^2.4.9",
|
||||
"typescript": "^5.0.0"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
import { Command } from 'commander';
|
||||
import { saveConfig } from '../utils/config.js';
|
||||
|
||||
export const configCommand = new Command('config')
|
||||
.description('Manage WWV CLI configuration')
|
||||
.argument('<action>', 'Action to perform (e.g., set)')
|
||||
.argument('<key>', 'Config key (e.g., org)')
|
||||
.argument('<value>', 'Config value (e.g., your-username)')
|
||||
.action((action, key, value) => {
|
||||
if (action !== 'set') {
|
||||
console.error(`[wwv-cli] Unknown config action: ${action}`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
if (key === 'org') {
|
||||
saveConfig({ org: value });
|
||||
console.log(`[wwv-cli] Successfully set default organization to @${value}`);
|
||||
} else {
|
||||
console.error(`[wwv-cli] Unknown config key: ${key}. Valid keys: org`);
|
||||
process.exit(1);
|
||||
}
|
||||
});
|
||||
@@ -0,0 +1,234 @@
|
||||
import { Command } from 'commander';
|
||||
import fs from 'fs';
|
||||
import path from 'path';
|
||||
import prompts from 'prompts';
|
||||
|
||||
export const createCommand = new Command('create')
|
||||
.description('Interactively scaffold a new WorldWideView plugin')
|
||||
.option('-c, --core', 'Create inside packages instead of local-plugins (for core contributors)')
|
||||
.action(async (options) => {
|
||||
const response = await prompts([
|
||||
{
|
||||
type: 'text',
|
||||
name: 'pluginId',
|
||||
message: 'What is the unique ID for your plugin? (e.g. my-tracker)',
|
||||
validate: value => value.length > 0 ? true : 'Plugin ID is required'
|
||||
},
|
||||
{
|
||||
type: 'text',
|
||||
name: 'displayName',
|
||||
message: 'What is the display name? (e.g. My Live Tracker)',
|
||||
initial: (prev: string) => prev.replace(/-/g, ' ').replace(/\b\w/g, (l: string) => l.toUpperCase())
|
||||
},
|
||||
{
|
||||
type: 'text',
|
||||
name: 'description',
|
||||
message: 'Enter a short description:'
|
||||
},
|
||||
{
|
||||
type: 'select',
|
||||
name: 'category',
|
||||
message: 'Which category does this plugin belong to?',
|
||||
choices: [
|
||||
{ title: 'Aviation (Plane icon)', value: 'aviation' },
|
||||
{ title: 'Maritime (Ship icon)', value: 'maritime' },
|
||||
{ title: 'Space (Satellite icon)', value: 'space' },
|
||||
{ title: 'Weather (Cloud icon)', value: 'weather' },
|
||||
{ title: 'Custom (Box icon)', value: 'custom' }
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'select',
|
||||
name: 'architecture',
|
||||
message: 'How will your plugin receive data?',
|
||||
choices: [
|
||||
{ title: 'REST Polling / Static Data (Frontend only)', value: 'polling' },
|
||||
{ title: 'Real-Time WebSockets (Generates backend seeder)', value: 'websocket' }
|
||||
]
|
||||
},
|
||||
{
|
||||
type: (prev: string) => prev === 'websocket' ? 'select' : null,
|
||||
name: 'seederTier',
|
||||
message: 'Which tier should your backend seeder belong to?',
|
||||
choices: [
|
||||
{ title: 'Community (Open data, shared)', value: 'community' },
|
||||
{ title: 'Private (Requires API keys, restricted)', value: 'private' }
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'select',
|
||||
name: 'renderStyle',
|
||||
message: 'How should entities be rendered on the 3D globe?',
|
||||
choices: [
|
||||
{ title: '2D Billboard (Great for static icons)', value: 'billboard' },
|
||||
{ title: '3D Model with LOD (Transitions 2D to 3D)', value: 'model' },
|
||||
{ title: 'Simple Point (High performance dots)', value: 'point' }
|
||||
]
|
||||
}
|
||||
]);
|
||||
|
||||
if (!response.pluginId) {
|
||||
console.log('Plugin creation cancelled.');
|
||||
return;
|
||||
}
|
||||
|
||||
const { pluginId, displayName, description, category, architecture, seederTier, renderStyle } = response;
|
||||
|
||||
const targetBaseDir = options.core ? 'packages' : 'local-plugins';
|
||||
const pluginDir = path.join(process.cwd(), targetBaseDir, `wwv-plugin-${pluginId}`);
|
||||
|
||||
if (fs.existsSync(pluginDir)) {
|
||||
console.error(`Error: Directory ${pluginDir} already exists.`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
fs.mkdirSync(pluginDir, { recursive: true });
|
||||
|
||||
// Determine category icon
|
||||
const iconMap: Record<string, string> = {
|
||||
aviation: 'Plane',
|
||||
maritime: 'Ship',
|
||||
space: 'Satellite',
|
||||
weather: 'Cloud',
|
||||
custom: 'Box'
|
||||
};
|
||||
const defaultIcon = iconMap[category] || 'Box';
|
||||
|
||||
// Package.json boilerplate
|
||||
const streamUrlField = architecture === 'websocket'
|
||||
? `\n "streamUrl": "wss://dataenginev2.worldwideview.dev/stream",`
|
||||
: '';
|
||||
|
||||
const packageJsonContent = `{
|
||||
"name": "@worldwideview/wwv-plugin-${pluginId}",
|
||||
"version": "1.0.0",
|
||||
"description": "${description}",
|
||||
"main": "dist/frontend.mjs",
|
||||
"module": "dist/frontend.mjs",
|
||||
"exports": {
|
||||
".": {
|
||||
"import": "./dist/frontend.mjs",
|
||||
"require": "./dist/frontend.mjs"
|
||||
}
|
||||
},
|
||||
"scripts": {
|
||||
"build": "tsc"
|
||||
},
|
||||
"dependencies": {
|
||||
"@worldwideview/wwv-plugin-sdk": "latest"
|
||||
},
|
||||
"worldwideview": {
|
||||
"pluginId": "${pluginId}",
|
||||
"name": "${displayName}",
|
||||
"description": "${description}",
|
||||
"icon": "${defaultIcon}",
|
||||
"category": "${category}",${streamUrlField}
|
||||
"author": "Your Name",
|
||||
"dev_entry": "src/index.ts",
|
||||
"format": "bundle"
|
||||
}
|
||||
}
|
||||
`;
|
||||
|
||||
// index.ts boilerplate
|
||||
const renderBoilerplate = {
|
||||
billboard: `return {
|
||||
type: 'billboard',
|
||||
iconUrl: '/icons/default.png',
|
||||
iconScale: 1.0,
|
||||
color: '#ffffff'
|
||||
};`,
|
||||
model: `return {
|
||||
type: 'billboard', // Placeholder for LOD logic, update to 3D model path when zoomed
|
||||
iconUrl: '/icons/default.png',
|
||||
iconScale: 1.0,
|
||||
modelUrl: '/models/default.glb', // Advanced LOD
|
||||
color: '#ffffff'
|
||||
};`,
|
||||
point: `return {
|
||||
type: 'point',
|
||||
color: '#ff0000',
|
||||
size: 8,
|
||||
outlineColor: '#ffffff',
|
||||
outlineWidth: 2
|
||||
};`
|
||||
}[renderStyle as string] || `return {};`;
|
||||
|
||||
const fetchBoilerplate = architecture === 'polling'
|
||||
? `\n async fetch(): Promise<GeoEntity[]> {
|
||||
// Implement REST polling logic here
|
||||
return [];
|
||||
}\n`
|
||||
: '';
|
||||
|
||||
const indexTsContent = `import { WorldPlugin, GeoEntity, CesiumEntityOptions } from '@worldwideview/wwv-plugin-sdk';
|
||||
|
||||
export default class ${pluginId.replace(/-/g, '')}Plugin implements WorldPlugin {
|
||||
id = '${pluginId}';
|
||||
name = '${displayName}';
|
||||
|
||||
async initialize(context: any): Promise<void> {
|
||||
console.log('${displayName} initialized.');
|
||||
}
|
||||
|
||||
getPollingInterval(): number {
|
||||
return ${architecture === 'polling' ? '10000' : '0'}; // ${architecture === 'polling' ? '10 seconds' : '0 for WebSockets'}
|
||||
}
|
||||
${fetchBoilerplate}
|
||||
renderEntity(entity: GeoEntity): CesiumEntityOptions {
|
||||
${renderBoilerplate}
|
||||
}
|
||||
|
||||
renderHUD(entity: GeoEntity): string {
|
||||
return \`<div>
|
||||
<h3>\${entity.id}</h3>
|
||||
<p>Data provided by ${displayName}</p>
|
||||
</div>\`;
|
||||
}
|
||||
}
|
||||
`;
|
||||
|
||||
fs.writeFileSync(path.join(pluginDir, 'package.json'), packageJsonContent);
|
||||
fs.mkdirSync(path.join(pluginDir, 'src'), { recursive: true });
|
||||
fs.writeFileSync(path.join(pluginDir, 'src', 'index.ts'), indexTsContent);
|
||||
|
||||
console.log(`\n✅ Successfully created plugin frontend at ${pluginDir}`);
|
||||
|
||||
// Generate seeder backend if requested
|
||||
if (architecture === 'websocket' && seederTier) {
|
||||
const seederDir = path.join(process.cwd(), 'local-seeders', seederTier, pluginId);
|
||||
|
||||
if (!fs.existsSync(seederDir)) {
|
||||
fs.mkdirSync(seederDir, { recursive: true });
|
||||
|
||||
const seederContent = `// WWV Data Engine Seeder for ${pluginId}
|
||||
export default async function run(context) {
|
||||
console.log('Starting ${displayName} seeder...');
|
||||
|
||||
// Example: Emit a mock entity to the engine
|
||||
setInterval(() => {
|
||||
context.emit({
|
||||
id: '${pluginId}-mock-1',
|
||||
lat: 0,
|
||||
lng: 0,
|
||||
alt: 10000,
|
||||
heading: 0,
|
||||
velocity: 250,
|
||||
properties: {
|
||||
status: 'active'
|
||||
}
|
||||
});
|
||||
}, 1000);
|
||||
}
|
||||
`;
|
||||
fs.writeFileSync(path.join(seederDir, 'seeder.mjs'), seederContent);
|
||||
console.log(`✅ Successfully created plugin seeder at ${seederDir}`);
|
||||
}
|
||||
}
|
||||
|
||||
console.log(`\nNext steps:
|
||||
1. Run \`pnpm install\` from the project root.
|
||||
2. Edit \`index.ts\` in your plugin directory.
|
||||
${architecture === 'websocket' ? '3. Edit `seeder.mjs` in your local-seeders directory.' : ''}
|
||||
`);
|
||||
});
|
||||
@@ -0,0 +1,121 @@
|
||||
/* eslint-disable no-console */
|
||||
import { Command } from 'commander';
|
||||
import { execSync } from 'child_process';
|
||||
import path from 'path';
|
||||
import fs from 'fs';
|
||||
import prompts from 'prompts';
|
||||
import { getConfig, saveConfig } from '../utils/config.js';
|
||||
|
||||
export const publishCommand = new Command('publish')
|
||||
.description('Publish the plugin to NPM and notify the WWV Marketplace')
|
||||
.argument('[pluginName]', 'Name of the plugin to publish (if running from root)')
|
||||
.option('--org <orgName>', 'NPM organization to publish to (e.g., your-username)')
|
||||
.action(async (pluginName, options) => {
|
||||
console.log('[wwv-cli] Preparing to publish plugin...');
|
||||
let cwd = process.cwd();
|
||||
|
||||
// If pluginName is provided, try to find the plugin directory
|
||||
if (pluginName) {
|
||||
const rootLocalPath = path.join(cwd, 'local-plugins', pluginName);
|
||||
const rootWwvLocalPath = path.join(cwd, 'local-plugins', `wwv-plugin-${pluginName}`);
|
||||
const packagesPath = path.join(cwd, 'packages', pluginName);
|
||||
const packagesWwvPath = path.join(cwd, 'packages', `wwv-plugin-${pluginName}`);
|
||||
|
||||
if (fs.existsSync(rootWwvLocalPath)) {
|
||||
cwd = rootWwvLocalPath;
|
||||
} else if (fs.existsSync(rootLocalPath)) {
|
||||
cwd = rootLocalPath;
|
||||
} else if (fs.existsSync(packagesWwvPath)) {
|
||||
cwd = packagesWwvPath;
|
||||
} else if (fs.existsSync(packagesPath)) {
|
||||
cwd = packagesPath;
|
||||
} else {
|
||||
console.error(`[wwv-cli] Error: Could not find plugin '${pluginName}' in local-plugins or packages.`);
|
||||
process.exit(1);
|
||||
}
|
||||
console.log(`[wwv-cli] Found plugin at: ${cwd}`);
|
||||
}
|
||||
|
||||
const pkgPath = path.join(cwd, 'package.json');
|
||||
|
||||
if (!fs.existsSync(pkgPath)) {
|
||||
console.error('[wwv-cli] Error: No package.json found in directory: ' + cwd);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
try {
|
||||
const pkgContent = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
|
||||
|
||||
if (!pkgContent.worldwideview) {
|
||||
console.error('[wwv-cli] Error: package.json is missing the "worldwideview" manifest block. Is this a WWV plugin?');
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
let originalName = pkgContent.name;
|
||||
let publishedName = originalName;
|
||||
|
||||
// Determine organization
|
||||
let targetOrg = options.org;
|
||||
const config = getConfig();
|
||||
|
||||
if (!targetOrg) {
|
||||
if (config.org) {
|
||||
targetOrg = config.org;
|
||||
console.log(`[wwv-cli] Using default organization from config: @${targetOrg}`);
|
||||
} else {
|
||||
// Fallback to NPM whoami if possible
|
||||
try {
|
||||
const whoami = execSync('npm whoami', { stdio: 'pipe' }).toString().trim();
|
||||
targetOrg = whoami;
|
||||
} catch (_e) {
|
||||
// Not logged in or errored, ignore
|
||||
}
|
||||
|
||||
const response = await prompts({
|
||||
type: 'text',
|
||||
name: 'org',
|
||||
message: 'What NPM organization/username do you want to publish under?',
|
||||
initial: targetOrg || '',
|
||||
validate: value => value.length > 0 ? true : 'Organization is required'
|
||||
});
|
||||
|
||||
if (!response.org) {
|
||||
console.log('Publish cancelled.');
|
||||
return;
|
||||
}
|
||||
|
||||
targetOrg = response.org;
|
||||
saveConfig({ org: targetOrg });
|
||||
console.log(`[wwv-cli] Saved @${targetOrg} as your default organization.`);
|
||||
}
|
||||
} else {
|
||||
// Save the explicitly passed org as the new default
|
||||
saveConfig({ org: targetOrg });
|
||||
}
|
||||
|
||||
if (targetOrg) {
|
||||
const orgPrefix = targetOrg.startsWith('@') ? targetOrg : `@${targetOrg}`;
|
||||
const baseName = originalName.startsWith('@') ? originalName.split('/')[1] : originalName;
|
||||
publishedName = `${orgPrefix}/${baseName}`;
|
||||
|
||||
if (originalName !== publishedName) {
|
||||
pkgContent.name = publishedName;
|
||||
fs.writeFileSync(pkgPath, JSON.stringify(pkgContent, null, 2) + '\n');
|
||||
console.log(`[wwv-cli] Updated package name to ${publishedName}`);
|
||||
}
|
||||
}
|
||||
|
||||
console.log(`[wwv-cli] Publishing ${publishedName}@${pkgContent.version} to NPM...`);
|
||||
|
||||
// Execute npm publish
|
||||
execSync('npm publish --access public', { stdio: 'inherit', cwd });
|
||||
|
||||
console.log('[wwv-cli] Successfully published to NPM!');
|
||||
console.log('[wwv-cli] To submit this plugin to the WorldWideView Marketplace, please visit: https://marketplace.worldwideview.dev/submit');
|
||||
console.log(`[wwv-cli] Package Name: ${publishedName}`);
|
||||
|
||||
} catch (err: any) {
|
||||
console.error('[wwv-cli] Error during publish:', err.message);
|
||||
process.exit(1);
|
||||
}
|
||||
});
|
||||
@@ -0,0 +1,18 @@
|
||||
#!/usr/bin/env node
|
||||
import { Command } from 'commander';
|
||||
import { createCommand } from './commands/create.js';
|
||||
import { publishCommand } from './commands/publish.js';
|
||||
import { configCommand } from './commands/config.js';
|
||||
|
||||
const program = new Command();
|
||||
|
||||
program
|
||||
.name('wwv')
|
||||
.description('WorldWideView Plugin CLI')
|
||||
.version('1.1.2');
|
||||
|
||||
program.addCommand(createCommand);
|
||||
program.addCommand(publishCommand);
|
||||
program.addCommand(configCommand);
|
||||
|
||||
program.parse(process.argv);
|
||||
@@ -0,0 +1,27 @@
|
||||
import fs from 'fs';
|
||||
import path from 'path';
|
||||
import os from 'os';
|
||||
|
||||
const CONFIG_PATH = path.join(os.homedir(), '.wwvrc');
|
||||
|
||||
export interface WwvConfig {
|
||||
org?: string;
|
||||
}
|
||||
|
||||
export function getConfig(): WwvConfig {
|
||||
if (!fs.existsSync(CONFIG_PATH)) {
|
||||
return {};
|
||||
}
|
||||
try {
|
||||
const raw = fs.readFileSync(CONFIG_PATH, 'utf8');
|
||||
return JSON.parse(raw);
|
||||
} catch (e) {
|
||||
return {};
|
||||
}
|
||||
}
|
||||
|
||||
export function saveConfig(config: WwvConfig): void {
|
||||
const current = getConfig();
|
||||
const next = { ...current, ...config };
|
||||
fs.writeFileSync(CONFIG_PATH, JSON.stringify(next, null, 2), 'utf8');
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"extends": "../../tsconfig.base.json",
|
||||
"compilerOptions": {
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"outDir": "./dist",
|
||||
"rootDir": "./src",
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"skipLibCheck": true,
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"noEmit": false
|
||||
},
|
||||
"include": ["src/**/*"]
|
||||
}
|
||||
Loaded 100 of 887 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user