zwitschi/linearvoid
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 9 Wiki Activity
Files
9178b7b295a854b427d4d80d1edfc03974280491
linearvoid/.github/instructions/TODO.md
T
zwitschi 18459a9811
CI / test (push) Failing after 9s
Details
CI / docker (push) Skipped
Details
Deploy to Cloudflare Pages / deploy (push) Failing after 10s
Details
CD / deploy (push) Successful in 47s
Details
feat: close STREAMING.md production readiness gaps 
- Added run ID + unique segment naming (r-{ISOTIME}/seg-{seq}.m4s)
- Added fsnotify watcher for real-time R2 segment upload (~7s)
- Added atomic manifest publication (temp key → CopyObject)
- Fixed manifest Cache-Control: public, max-age=1, s-maxage=2, must-revalidate
- Added hls.js error recovery: bounded retries (5x), exponential backoff, reconnecting UI
- Enriched /health endpoint: run_id, active_item, last_segment_seq, last_r2_pub, consecutive_failures, unhealthy detection
- Updated tests: HealthHandler (new fields + unhealthy), player error recovery test
- Updated TODO.md, BACKLOG.md, DONE.md, MEMORY.md
2026-08-10 17:20:54 +02:00

7.0 KiB
Raw Blame History

TODO

Completed tasks moved to .github/instructions/DONE.md. Full remaining task list in DEVELOPMENT.md.

Detailed Implementation Plan

  • Phase 1: unblock playout test fixtures and lock down the source-media contract

    • Create small compliant fixture media in backend/playout/testdata/ for the validator and playout tests
    • Create invalid fixture media for codec, framerate, and audio rejection paths
    • Create playlist fixtures for empty, comment-only, mixed-validity, and valid playlists
    • Document the ffmpeg fixture-generation commands in the relevant test headers

  • Phase 2: finish frontend coverage for the live viewer experience

    • Add tests for HLS player startup, manifest resolution, and cross-origin/local fallback behavior
    • Add tests for chat send/receive, presence updates, private DM flow, and reconnect behavior
    • Add responsive-layout and accessibility checks for the viewer shell and chat sidebar
    • Add coverage reporting and enforce a minimum threshold in CI

  • Phase 3: finish admin frontend coverage

    • Add tests for playlist management, moderation flows, and dashboard rendering
    • Add tests for API integration points with mocked backend responses
    • Add responsive-layout and accessibility checks for admin screens
    • Add coverage reporting and enforce a minimum threshold in CI

  • Phase 4: validate the R2 and edge-delivery path

    • Add an integration test for upload and retrieval of HLS objects through the R2 path
    • Verify segment and manifest cache headers, including immutable media and live manifest freshness
    • Validate edge cache hit/miss behavior with repeat requests
    • Document any required stubs or mocks so the test can run in CI (putObject mock pattern documented in test)

  • Phase 5: complete manual Cloudflare and external-service setup

    • Apply Cloudflare Pages, Tiered Cache, WAF, rate limiting, and HTTPS/HSTS settings in the dashboard
    • Create or verify UptimeRobot monitors for health and HLS manifest availability
    • Capture evidence in docs/operations/cloudflare-uptimerobot-checklist.md

  • Phase 6: rehearse production deployment end to end

    • Provision the Hetzner host and prepare the Docker/runtime baseline
    • Configure production secrets, remote deployment, and DNS cutover
    • Run health, HLS, chat, and admin smoke tests against production-like infrastructure
    • Verify backup creation, restore, and integrity checks on the production host

  • Phase 7: baseline scaling and performance

    • Measure manifest TTFB and cache-hit distribution from multiple US regions
    • Prepare WebSocket load-test scaffolding and summary artifacts (ws-chat.yml, run-loadtests.ps1, summarize-artillery.ps1)
    • Execute WebSocket throughput and chat-latency benchmarks under growing connection counts
    • Prepare Admin API benchmark scaffolding and endpoint summary artifacts (admin-api.js, run-loadtests.ps1, summarize-k6.ps1)
    • Execute Admin API benchmarks and identify slow paths
    • Add saturation thresholds to monitoring (chat p95 latency + Redis memory usage)
    • Add cache-hit threshold alert operationalization to monitoring

Status Update (2026-08-10)

  • Phase 1 (test fixtures) complete.
  • Phase 2 (viewer frontend): player startup, URL resolution, chat send/receive, reconnect, presence, DM flow, message rendering all covered (27 tests).
  • Phase 3 (admin frontend): dashboard rendering, API integration, playlist management all covered (31 tests total).
  • Phase 4 (R2 validation) partially complete: SyncToR2 cache headers + integration tests done; edge cache hit/miss remains manual.
  • Phase 5 (Cloudflare): Pages deploy workflow (.gitea/workflows/pages-deploy.yml) created; Pages/Workers setup docs written; manual dashboard tasks remain.
  • Phase 7: Loadtest scaffolding complete; run-loadtests.ps1 auto-generates ws-chat-summary.txt and admin-api-endpoint-summary.txt; live benchmark execution pending.
  • Version tagged 1.0.11; go vet clean.

Remaining (summary)

  • Test Fixtures: media + playlist fixtures created; ffmpeg generation commands documented in test headers
  • User Frontend Tests: video player, chat integration, responsive, accessibility, coverage
  • Admin Frontend Tests: playlist UI, moderation UI, metrics dashboards, coverage
  • Cloudflare R2 Integration Test: upload + cache header validation done (SyncToR2 with CacheControl + ContentType); edge cache hit/miss validation remains manual
  • Cloudflare Config: Cloudflare Pages deploy workflow and setup docs created; manual dashboard setup (Tiered Cache, WAF, rate limiting, HTTPS/HSTS) remains pending; Pages project must be created in dashboard first.
  • External Services: UptimeRobot monitors + alerts
  • Production Deployment: Hetzner provisioning, CD pipeline, DNS cutover, smoke test
  • Scaling & Performance: TTFB baseline and live benchmark runs still pending; loadtest scaffolding now includes Artillery/k6 helpers with auto summaries plus worksheet field mapping; chat p95, Redis saturation, and cache-hit threshold alerting are implemented

See DEVELOPMENT.md for detailed checklist.

Streaming Pipeline Gaps (2026-08-10 audit → 2026-08-10 implemented)

STREAMING.md contract vs playlist.go/main.ts implementation. See Backlog for full details.

  • Continuous R2 sync during playout (HIGH) — implemented: fsnotify watcher uploads segments within ~7s
  • Globally unique segment naming with run ID (HIGH) — implemented: r-{ISOTIME}/seg-{seq}.m4s
  • Atomic manifest publication with temp key (MEDIUM) — implemented: upload to .tmp, then CopyObject
  • Manifest Cache-Control: add must-revalidate + s-maxage split (LOW) — implemented: public, max-age=1, s-maxage=2, must-revalidate
  • CORS headers on HLS responses from media.linearvoid.tv (MEDIUM) — infrastructure, needs Cloudflare R2 CORS config
  • Player error recovery: retries, backoff, reconnecting state (MEDIUM) — implemented: hls.on(ERROR) handler with exponential backoff
  • Health endpoint: add active item, revision, run ID, segment info (LOW) — implemented: full STREAMING.md contract fields

Streaming Pipeline Gaps (2026-08-10 audit — LEGACY)

  • Continuous R2 sync during playout (HIGH) — currently only on FFmpeg exit
  • Globally unique segment naming with run ID (HIGH) — currently strftime only
  • Atomic manifest publication with temp key (MEDIUM)
  • CORS headers on HLS responses from media.linearvoid.tv (MEDIUM)
  • Player error recovery: retries, drift, reconnecting state (MEDIUM)
  • Manifest Cache-Control: add must-revalidate + s-maxage split (LOW)
  • Health endpoint: add active item, revision, run ID, segment info (LOW)

Feature List (Future Enhancements)

  • Admin backend
    • Analytics: implement a settings entry to set matomo url and page id
  • User frontend
    • Chat: add user registration and login flows
    • Chat: private DM history and search
    • Analytics: add javascript snippet to send pageview events to matomo
Reference in new issue View Git Blame Copy Permalink