|
| 1 | +# Project Plan |
| 2 | + |
| 3 | +## Cleanup (done) |
| 4 | + |
| 5 | +### 1. Gitignore `package-lock.json` — done |
| 6 | + |
| 7 | +Added `package-lock.json` to `.gitignore` and removed it from git tracking. |
| 8 | + |
| 9 | +### 2. Clean stale remote branches — done |
| 10 | + |
| 11 | +Deleted 15 stale remote branches. Only `main` and one active dependabot branch remain. |
| 12 | + |
| 13 | +### 3. Move `@changesets/cli` to devDependencies — done |
| 14 | + |
| 15 | +Moved from `dependencies` to `devDependencies` in `package.json`. |
| 16 | + |
| 17 | +### 4. Add `packageManager` field to `package.json` — done |
| 18 | + |
| 19 | +Added `"packageManager": "pnpm@9.15.9"` to enforce correct package manager via corepack. |
| 20 | + |
| 21 | +## Code Improvements (done) |
| 22 | + |
| 23 | +### 5. Fetch timeout protection — done |
| 24 | + |
| 25 | +Added `AbortSignal.timeout(30_000)` to all 4 fetch calls in `compass-api.ts`. |
| 26 | + |
| 27 | +### 6. Consolidate duplicate `sanitizeText` — done |
| 28 | + |
| 29 | +Extracted shared HTML entity escaping into `src/sanitize.ts` (`sanitizeHtml`, `sanitizeId`). Updated `compass-api.ts`, `index.ts`, and `service.ts` to import from the shared module. |
| 30 | + |
| 31 | +### 7. Cherry-pick `updateComponentOwner` from feature branch — done |
| 32 | + |
| 33 | +Added `updateComponentOwner` GraphQL mutation and 3 tests directly to `compass-api.ts` (with timeout included). Feature branch deleted. |
| 34 | + |
| 35 | +## Features |
| 36 | + |
| 37 | +### 8. Team enrichment in service markdown |
| 38 | + |
| 39 | +The generator fetches team display names via `fetchTeamById()`, but the team data could be richer: team members, team lead, contact channels. Compass exposes this through the Teams API. Richer team data would make EventCatalog service pages more actionable for on-call and ownership discovery. |
| 40 | + |
| 41 | +### 9. Event discovery from AsyncAPI/OpenAPI specs |
| 42 | + |
| 43 | +The generator produces services and domains, but EventCatalog's core concept is events. If Compass components reference AsyncAPI specs in their links, the generator could parse those specs and auto-create event entries linked to producing/consuming services. This would be the highest-value feature addition. |
| 44 | + |
| 45 | +### 10. Incremental/diff mode |
| 46 | + |
| 47 | +The generator rewrites everything on each run. For large catalogs (100+ components), an incremental mode that only updates services whose Compass config has changed (based on hash or timestamp) would improve performance and reduce unnecessary git diffs. |
| 48 | + |
| 49 | +### 11. Component relationship visualisation |
| 50 | + |
| 51 | +The generator resolves `DEPENDS_ON` relationships and writes them into markdown. A dedicated dependency graph page using EventCatalog's visualisation capabilities would give a bird's-eye view of service interdependencies pulled from Compass. |
| 52 | + |
| 53 | +### 12. Multi-site support |
| 54 | + |
| 55 | +The current `ApiConfig` targets a single Atlassian site. Organisations with multiple Compass instances could benefit from aggregating into a single EventCatalog. Supporting an array of API configs would enable that. |
0 commit comments