Andy Dixon
630636b3af
A 14 m concrete wall now encloses the city 24 m beyond its outermost blocks. It is in the collision index (not the pick index), blocked on the navigation grid so residents and routes stay inside, and walk/fly positions are clamped within it so nobody leaves by flying over. Posters are pasted on the city side at random spots, sizes and tilts (up to 25 degrees), one per ~35 m, overlapping like a real hoarding. They are painted into one atlas from civic slogans plus facts about the loaded codebase (welcome, tallest tower, largest district, most connected file), seeded by the repository name so each city's wall is stable. The wall shader draws concrete courses and joints with a lit coping, and the minimap outlines the wall. README covers routes, residents, the wall and security alerts.
CodeNavigator
A single binary that serves the WebGL frontend and the indexing API (jobs, SSE progress, snapshots, search, source) on one origin. No dependencies beyond the Go standard library.
go run . # http://127.0.0.1:4177
go test -race ./...
node --test webtest/*.test.mjs # frontend maths: camera, city layout, collision, signs, links
go test -run x -bench Index # indexes $CODENAV_BENCH_DIR (default: Go's stdlib source)
./build.sh [tag] # Docker image, tests run during the build
docker run --rm -p 4177:4177 codenavigator:latest
Configuration:
PORT(default4177, or--port),CORS_ORIGIN(default*)GITHUB_CLIENT_ID,GITHUB_CLIENT_SECRET: a GitHub App's credentials; enables sign-in for private repositoriesGITHUB_APP_SLUG: the app's URL name, for the "grant repository access" link
git must be on PATH to load GitHub repositories (the image includes it).
Views
- 2D map: squarified treemap of files, sized by lines or references.
- 3D landscape: the same map extruded, orbit with drag, pan with Shift+drag, scroll to dolly.
- City: folders become districts and blocks separated by roads, files become buildings
(footprint from lines, height from complexity, lit windows from definitions).
1Helicopter,2Walk,3Fly. In walk/fly: click for mouse-look, WASD, Shift to run, Space/C up and down when flying,Einspects the building in the crosshair.- Double-click a street to drop in; the minimap shows your heading and teleports on click.
- Selecting a file draws import trails (cyan known, amber inferred); search hits raise beacons.
Tor Tour flies over the largest districts. Copy link shares the repository, view, camera and selected file as a URL fragment (GitHub repositories only).- Touch: left thumb joystick, right thumb look, pinch to zoom.
- Selecting a file also lays glowing routes along the streets to each file it imports.
- Residents wander the streets (toggle in Settings). A wall with posters encloses the city.
- Signed in with GitHub, files with open code scanning or Dependabot alerts smoke (and burn for critical/high) and are wrapped in hazard tape. The GitHub App needs read access to code scanning alerts and Dependabot alerts.
Frontend modules (plain ES modules, no build step): camera.js (matrices and orbit pose),
city.js (layout, collision, picking, sign placement, tour and links), labels.js (text atlas),
renderer.js (WebGL2 passes) and app.js (UI and input).
Multiple users
Every browser gets an HttpOnly session cookie. Jobs, snapshots and GitHub sign-ins belong to that session and are invisible (404) to others. Each session keeps its latest snapshot; snapshots idle for an hour are deleted, at most 8 are held (least recently used evicted), and two indexes run at once while the rest queue. State is in memory, so a restart signs everyone out.
Private GitHub repositories
Uses a GitHub App's user authorisation. When an anonymous clone fails, the frontend offers
Sign in with GitHub; the callback (/api/github/callback) stores an 8-hour user token in
memory for the session. Clones send it as an HTTP header via environment git config, never in
the URL or arguments, and host git config and credential helpers are ignored. A signed-in user
can only open repositories where the app is installed and they have access, otherwise the
frontend links to the app's installation page.
GitHub App settings: callback URL https://<host>/api/github/callback, setup URL https://<host>/
with "Redirect on update", token expiry on, no webhook, repository permission Contents: read-only.
The browser frontend in web/ is plain JavaScript (it has to run in the browser) and
is embedded into the binary; web/config.js points it at the same origin.
Notes:
GET /serves the frontend instead of a JSON service description.- Jobs and snapshots are private to the browser session that created them (see above).
- Search queries are percent-decoded properly.
.gitignoresupport covers standard globs but not global excludes or.git/info/exclude.