docs(roadmap): mark Phases 2 and 3.1 complete
- Phase 2.1: TypeScript SDK (21 tests) - Phase 2.2: Swift SDK (20+ tests, iOS 15+) - Phase 2.3: Kotlin SDK (16+ tests, API 26+) - Phase 3.1: Admin Debug Sessions UI Screenshot capture deferred to Phase 4 for all platforms Session Detail View (3.2) marked as next priority
This commit is contained in:
saravanakumardb1
parent
2e697a13db
commit
e955668e6a
@ -159,79 +159,71 @@ This roadmap delivers a **Datadog/Sentry-grade remote diagnostics system** for t
|
||||
- [x] **2.1.8** Tests (`src/__tests__/client.test.ts`)
|
||||
- [x] 21 Vitest tests passing
|
||||
|
||||
### 2.2 Swift Client SDK (iOS)
|
||||
### 2.2 Swift Client SDK (iOS) — COMPLETE [`abcf817`](https://github.com/saravanakumardb1/learning_ai_common_plat/commit/abcf817)
|
||||
|
||||
- [ ] **2.2.1** Create `ByteLystDiagnostics` Swift package
|
||||
- [ ] `Package.swift` with iOS 15+ target
|
||||
- [ ] Module structure: Core, Network, UI, Device
|
||||
- [ ] **2.2.2** Core client (`Sources/Core/DiagnosticsClient.swift`)
|
||||
- [ ] `DiagnosticsClient` actor (thread-safe)
|
||||
- [ ] `start()` — polling with `Timer`
|
||||
- [ ] `trace<T>(name, operation)` — async span wrapper
|
||||
- [ ] `log(level, message, metadata)` — os_log integration
|
||||
- [ ] `breadcrumb(category, message)` — timeline
|
||||
- [ ] **2.2.3** Network interception (`Sources/Network/URLSessionInterceptor.swift`)
|
||||
- [ ] `URLProtocol` subclass for automatic capture
|
||||
- [ ] Swizzle `URLSession` or use protocol registration
|
||||
- [ ] Capture: request/response, timing, bytes
|
||||
- [ ] **2.2.4** Device state (`Sources/Device/DeviceState.swift`)
|
||||
- [ ] `UIDevice` integration (battery, thermal)
|
||||
- [ ] `ProcessInfo` (memory pressure)
|
||||
- [ ] `NetworkMonitor` (path status)
|
||||
- [ ] **2.2.5** Screenshot (`Sources/UI/ScreenshotCapture.swift`)
|
||||
- [ ] `UIApplication` key window capture
|
||||
- [ ] Privacy: blur sensitive views (configurable)
|
||||
- [ ] **2.2.6** Tests (`Tests/DiagnosticsClientTests.swift`)
|
||||
- [ ] Unit tests (12)
|
||||
- [ ] Integration tests (8)
|
||||
- [x] **2.2.1** Create `ByteLystDiagnostics` Swift package
|
||||
- [x] `Package.swift` with iOS 15+ target
|
||||
- [x] Module structure: Core, Network, Device
|
||||
- [x] **2.2.2** Core client (`Sources/Core/DiagnosticsClient.swift`)
|
||||
- [x] `DiagnosticsClient` actor (thread-safe)
|
||||
- [x] `start()` — polling with `Timer`
|
||||
- [x] `trace<T>(name, operation)` — async span wrapper
|
||||
- [x] `log(level, message, metadata)` — structured logging
|
||||
- [x] `breadcrumb(category, message)` — timeline
|
||||
- [x] **2.2.3** Network interception (`Sources/Network/NetworkInterceptor.swift`)
|
||||
- [x] `URLProtocol` subclass for automatic capture
|
||||
- [x] Capture: request/response, timing, bytes
|
||||
- [x] **2.2.4** Device state (`Sources/Device/DeviceState.swift`)
|
||||
- [x] `UIDevice` integration (battery, thermal)
|
||||
- [x] `ProcessInfo` (memory pressure)
|
||||
- [x] `NetworkMonitor` (path status)
|
||||
- [x] **2.2.5** Screenshot — deferred to Phase 4
|
||||
- [x] **2.2.6** Tests (`Tests/DiagnosticsClientTests.swift`)
|
||||
- [x] 20+ XCTest unit tests
|
||||
|
||||
### 2.3 Kotlin Client SDK (Android)
|
||||
### 2.3 Kotlin Client SDK (Android) — COMPLETE [`fc8f8d3`](https://github.com/saravanakumardb1/learning_ai_common_plat/commit/fc8f8d3)
|
||||
|
||||
- [ ] **2.3.1** Create `diagnostics` module in `kotlin-platform-sdk`
|
||||
- [ ] `build.gradle.kts` dependencies
|
||||
- [ ] Coroutines + OkHttp + WorkManager
|
||||
- [ ] **2.3.2** Core client (`diagnostics/DiagnosticsClient.kt`)
|
||||
- [ ] Singleton with `StateFlow<DiagnosticsState>`
|
||||
- [ ] `start()` — foreground service for polling
|
||||
- [ ] `trace()` — suspend function with span
|
||||
- [ ] `log()` — Logcat + structured queue
|
||||
- [ ] **2.3.3** Network interceptor (`diagnostics/OkHttpInterceptor.kt`)
|
||||
- [ ] `Interceptor` implementation
|
||||
- [ ] Capture: request/response chain
|
||||
- [ ] **2.3.4** Device state (`diagnostics/DeviceStateCollector.kt`)
|
||||
- [ ] `BatteryManager`, `ActivityManager`, `StorageStatsManager`
|
||||
- [ ] **2.3.5** Screenshot (`diagnostics/ScreenshotCapture.kt`)
|
||||
- [ ] `MediaProjection` API (with permission)
|
||||
- [ ] `PixelCopy` for surface capture
|
||||
- [ ] **2.3.6** Tests (`diagnostics/DiagnosticsClientTest.kt`)
|
||||
- [ ] Unit tests (10)
|
||||
- [ ] Integration tests (6)
|
||||
- [x] **2.3.1** Create `diagnostics` module in `kotlin-platform-sdk`
|
||||
- [x] Module structure with Coroutines + OkHttp
|
||||
- [x] **2.3.2** Core client (`diagnostics/DiagnosticsClient.kt`)
|
||||
- [x] Singleton with `StateFlow<DiagnosticsState>`
|
||||
- [x] `start()` — polling with coroutines
|
||||
- [x] `trace()` — suspend function with span
|
||||
- [x] `log()` — structured queue
|
||||
- [x] **2.3.3** Network interceptor (`diagnostics/NetworkInterceptor.kt`)
|
||||
- [x] `Interceptor` implementation
|
||||
- [x] Capture: request/response chain
|
||||
- [x] **2.3.4** Device state (`diagnostics/DeviceStateCollector.kt`)
|
||||
- [x] `BatteryManager`, `ActivityManager`, `StorageStatsManager`
|
||||
- [x] **2.3.5** Screenshot — deferred to Phase 4
|
||||
- [x] **2.3.6** Tests (`diagnostics/DiagnosticsTypesTest.kt`)
|
||||
- [x] 16+ JUnit tests
|
||||
|
||||
**Phase 2 Exit Criteria:**
|
||||
|
||||
- [ ] TS SDK builds + 20 tests passing
|
||||
- [ ] Swift SDK builds + 20 tests passing
|
||||
- [ ] Kotlin SDK builds + 16 tests passing
|
||||
- [ ] All SDKs can poll config endpoint
|
||||
- [x] TS SDK builds + 20 tests passing
|
||||
- [x] Swift SDK builds + 20 tests passing
|
||||
- [x] Kotlin SDK builds + 16 tests passing
|
||||
- [x] All SDKs can poll config endpoint
|
||||
|
||||
---
|
||||
|
||||
## Phase 3: Admin Dashboard UI (Week 2)
|
||||
|
||||
### 3.1 Debug Sessions Page
|
||||
### 3.1 Debug Sessions Page — COMPLETE [`2e697a1`](https://github.com/saravanakumardb1/learning_ai_common_plat/commit/2e697a1)
|
||||
|
||||
- [ ] **3.1.1** Create `/ops/debug-sessions/page.tsx`
|
||||
- [ ] Session list table (columns: ID, user, device, status, started, duration)
|
||||
- [ ] Filters: status, product, date range
|
||||
- [ ] Pagination
|
||||
- [ ] "New Session" button → modal
|
||||
- [ ] **3.1.2** New Session Modal
|
||||
- [ ] Target user (email/userId search)
|
||||
- [ ] Target device (dropdown from sessions)
|
||||
- [ ] Collection level (standard, debug, trace)
|
||||
- [ ] Duration slider (5min → 24hr)
|
||||
- [ ] Screenshot on error (toggle)
|
||||
- [ ] "Start Session" → POST API
|
||||
- [x] **3.1.1** Create `/ops/debug-sessions/page.tsx`
|
||||
- [x] Session list table (columns: ID, user, device, status, started, duration)
|
||||
- [x] Filters: status, product, date range
|
||||
- [x] Auto-refresh every 5 seconds
|
||||
- [x] "New Session" button → modal
|
||||
- [x] **3.1.2** New Session Modal
|
||||
- [x] Target user (email/userId)
|
||||
- [x] Target device (input)
|
||||
- [x] Collection level (standard, debug, trace)
|
||||
- [x] Duration slider (5min → 24hr)
|
||||
- [x] Screenshot on error (toggle)
|
||||
- [x] "Start Session" → POST API
|
||||
|
||||
### 3.2 Session Detail View
|
||||
|
||||
@ -267,21 +259,21 @@ This roadmap delivers a **Datadog/Sentry-grade remote diagnostics system** for t
|
||||
- [ ] Auto-refresh session status every 5 seconds
|
||||
- [ ] Toast notification on new logs/traces
|
||||
|
||||
### 3.4 Client Library
|
||||
### 3.4 Client Library — COMPLETE
|
||||
|
||||
- [ ] **3.4.1** Create `lib/diagnostics-client.ts`
|
||||
- [ ] `querySessions()`
|
||||
- [ ] `createSession()`
|
||||
- [ ] `getSession()`
|
||||
- [ ] `updateSession()`
|
||||
- [ ] `getTraces()`
|
||||
- [ ] `getLogs()`
|
||||
- [x] **3.4.1** Create `lib/diagnostics-client.ts`
|
||||
- [x] `querySessions()`
|
||||
- [x] `createSession()`
|
||||
- [x] `getSession()`
|
||||
- [x] `updateSession()`
|
||||
- [x] `getTraces()`
|
||||
- [x] `getLogs()`
|
||||
|
||||
**Phase 3 Exit Criteria:**
|
||||
|
||||
- [ ] Admin can create session from UI
|
||||
- [ ] Session detail shows live data
|
||||
- [ ] All 4 tabs functional
|
||||
- [x] Admin can create session from UI
|
||||
- [ ] Session detail shows live data (Phase 3.2 pending)
|
||||
- [ ] All 4 tabs functional (Phase 3.2 pending)
|
||||
|
||||
---
|
||||
|
||||
@ -580,9 +572,16 @@ interface DebugScreenshotDoc {
|
||||
- Audit logging for all session lifecycle events
|
||||
- Rate limiting keys configured
|
||||
- 4 email templates ready for notifications
|
||||
- [x] **Phase 2: Client SDKs** — TypeScript SDK COMPLETE, Swift+Kotlin in progress
|
||||
- [ ] **Phase 3: Admin UI** — Next after SDKs
|
||||
- [ ] **Phase 4: Advanced Features**
|
||||
- [x] **Phase 2: Client SDKs** — COMPLETE — 2026-03-03
|
||||
- TypeScript SDK: 21 tests passing
|
||||
- Swift SDK: 20+ tests, iOS 15+ support
|
||||
- Kotlin SDK: 16+ tests, API 26+ support
|
||||
- [x] **Phase 3: Admin UI** — 3.1 COMPLETE — 2026-03-03
|
||||
- Debug Sessions list page with filters
|
||||
- New Session modal with all fields
|
||||
- Real-time auto-refresh (5s polling)
|
||||
- [ ] **Phase 3.2: Session Detail View** — Next
|
||||
- [ ] **Phase 4: Advanced Features** — Future
|
||||
|
||||
**Total Tasks:** 140+ checkboxes across 4 phases
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user