139 lines
10 KiB
Markdown
139 lines
10 KiB
Markdown
---
|
|
phase: 07-weight-unit-selection
|
|
verified: 2026-03-16T12:00:00Z
|
|
status: human_needed
|
|
score: 7/8 must-haves verified
|
|
human_verification:
|
|
- test: "Navigate to Collection page and verify unit toggle is visible in TotalsBar"
|
|
expected: "A segmented g/oz/lb/kg pill toggle appears in the top bar between the title and stats"
|
|
why_human: "Cannot verify visual rendering or UI element presence without a browser"
|
|
- test: "Click 'oz' in the toggle, verify all weight badges update to ounces"
|
|
expected: "ItemCards, CategoryHeaders, TotalsBar total, SetupCard weights all update to e.g. '15.9 oz'"
|
|
why_human: "React Query invalidation and re-render behavior requires runtime verification"
|
|
- test: "Navigate to Dashboard, then to a Setup detail page, verify weights use selected unit"
|
|
expected: "All weight displays across pages reflect the chosen unit after selecting 'oz', 'lb', or 'kg'"
|
|
why_human: "Cross-page state propagation via settings API requires runtime verification"
|
|
- test: "Select 'kg', then refresh the page"
|
|
expected: "After refresh, weights still display in kg (unit persists)"
|
|
why_human: "Settings persistence across sessions requires runtime verification"
|
|
---
|
|
|
|
# Phase 7: Weight Unit Selection Verification Report
|
|
|
|
**Phase Goal:** Users see all weights in their preferred unit across the entire app
|
|
**Verified:** 2026-03-16T12:00:00Z
|
|
**Status:** human_needed
|
|
**Re-verification:** No - initial verification
|
|
|
|
## Goal Achievement
|
|
|
|
### Observable Truths
|
|
|
|
| # | Truth | Status | Evidence |
|
|
|---|-------|--------|----------|
|
|
| 1 | formatWeight converts grams to g, oz, lb, kg with correct precision | VERIFIED | `src/client/lib/formatters.ts` switch statement with `toFixed(1)` oz, `toFixed(2)` lb/kg. 21 tests all pass. |
|
|
| 2 | formatWeight defaults to grams when no unit is specified (backward compatible) | VERIFIED | Signature `unit: WeightUnit = "g"`. Test: `formatWeight(100)` returns `"100g"`. |
|
|
| 3 | formatWeight handles null/undefined input for all units | VERIFIED | Null guard `if (grams == null) return "--"` fires before switch. 7 null/undefined tests pass. |
|
|
| 4 | useWeightUnit hook returns a valid WeightUnit from settings, defaulting to 'g' | VERIFIED | `useWeightUnit.ts` validates against `VALID_UNITS` array and returns `"g"` fallback. |
|
|
| 5 | User can see a unit toggle (g/oz/lb/kg) in the TotalsBar | ? NEEDS HUMAN | Toggle code exists in TotalsBar.tsx (lines 70-90), but visual rendering requires browser. |
|
|
| 6 | Clicking a unit in the toggle changes all weight displays across the app | ? NEEDS HUMAN | `useUpdateSetting.mutate({ key: "weightUnit", value: u })` wired. React Query invalidation behavior requires runtime. |
|
|
| 7 | Weight unit selection persists after page refresh | ? NEEDS HUMAN | Persistence via `GET /api/settings/weightUnit` in `useSetting`. Requires runtime verification. |
|
|
| 8 | Every weight display in the app uses the selected unit | VERIFIED | All 9 formatWeight call sites in `src/client/` pass `unit` argument. Grep confirms no bare `formatWeight(grams)` calls remain in components. |
|
|
|
|
**Score:** 5/5 automated truths verified, 3/3 runtime truths require human verification
|
|
|
|
### Required Artifacts
|
|
|
|
#### Plan 01 Artifacts
|
|
|
|
| Artifact | Expected | Status | Details |
|
|
|----------|----------|--------|---------|
|
|
| `src/client/lib/formatters.ts` | WeightUnit type export and parameterized formatWeight | VERIFIED | Exports `WeightUnit`, `formatWeight`, `formatPrice`. Contains switch for all 4 units. 28 lines, substantive. |
|
|
| `src/client/hooks/useWeightUnit.ts` | Convenience hook wrapping useSetting for weight unit | VERIFIED | Exports `useWeightUnit`. Imports `WeightUnit` from formatters, `useSetting` from useSettings. 13 lines, substantive. |
|
|
| `tests/lib/formatters.test.ts` | Unit tests for formatWeight with all 4 units and edge cases | VERIFIED | 98 lines (min_lines=30 satisfied). 21 tests across 7 describe blocks covering g/oz/lb/kg, null/undefined, backward compat, zero, edge cases. All pass. |
|
|
|
|
#### Plan 02 Artifacts
|
|
|
|
| Artifact | Expected | Status | Details |
|
|
|----------|----------|--------|---------|
|
|
| `src/client/components/TotalsBar.tsx` | Unit toggle UI and unit-aware weight display | VERIFIED | Contains `useWeightUnit`, `useUpdateSetting`, UNITS array, segmented pill toggle JSX. `formatWeight` calls pass `unit`. |
|
|
| `src/client/components/ItemCard.tsx` | Unit-aware item weight display | VERIFIED | Contains `useWeightUnit`. `formatWeight(weightGrams, unit)` on line 127. |
|
|
| `src/client/components/CandidateCard.tsx` | Unit-aware candidate weight display | VERIFIED | Contains `useWeightUnit`. `formatWeight(weightGrams, unit)` on line 93. |
|
|
| `src/client/components/CategoryHeader.tsx` | Unit-aware category total weight display | VERIFIED | Contains `useWeightUnit`. `formatWeight(totalWeight, unit)` on line 90. |
|
|
| `src/client/components/SetupCard.tsx` | Unit-aware setup weight display | VERIFIED | Contains `useWeightUnit`. `formatWeight(totalWeight, unit)` on line 35. |
|
|
| `src/client/components/ItemPicker.tsx` | Unit-aware item picker weight display | VERIFIED | Contains `useWeightUnit`. `formatWeight(item.weightGrams, unit)` on line 119. |
|
|
| `src/client/routes/index.tsx` | Unit-aware dashboard weight display | VERIFIED | Contains `useWeightUnit`. `formatWeight(global?.totalWeight ?? null, unit)` on line 34. |
|
|
| `src/client/routes/setups/$setupId.tsx` | Unit-aware setup detail weight display | VERIFIED | Contains `useWeightUnit`. `formatWeight(totalWeight, unit)` on line 110. |
|
|
|
|
### Key Link Verification
|
|
|
|
| From | To | Via | Status | Details |
|
|
|------|----|-----|--------|---------|
|
|
| `useWeightUnit.ts` | `useSettings.ts` | `useSetting('weightUnit')` | WIRED | Line 7: `const { data } = useSetting("weightUnit");` |
|
|
| `useWeightUnit.ts` | `formatters.ts` | imports WeightUnit type | WIRED | Line 1: `import type { WeightUnit } from "../lib/formatters";` |
|
|
| `TotalsBar.tsx` | `/api/settings/weightUnit` | useUpdateSetting mutation | WIRED | Line 76-79: `updateSetting.mutate({ key: "weightUnit", value: u })` |
|
|
| `ItemCard.tsx` | `useWeightUnit.ts` | useWeightUnit hook import | WIRED | Line 1: `import { useWeightUnit } from "../hooks/useWeightUnit";` — called at line 29, used at line 127 |
|
|
| `TotalsBar.tsx` | `formatters.ts` | formatWeight(grams, unit) | WIRED | Lines 33, 39: both calls pass `unit` from `useWeightUnit()` |
|
|
|
|
### Requirements Coverage
|
|
|
|
| Requirement | Source Plan(s) | Description | Status | Evidence |
|
|
|-------------|---------------|-------------|--------|----------|
|
|
| UNIT-01 | 07-02-PLAN | User can select preferred weight unit (g, oz, lb, kg) from settings | VERIFIED (automated) / NEEDS HUMAN (runtime) | Segmented toggle code in TotalsBar.tsx lines 70-90. Runtime: needs human to confirm visual and click behavior. |
|
|
| UNIT-02 | 07-01-PLAN, 07-02-PLAN | All weight displays across the app reflect the selected unit | VERIFIED | All 9 formatWeight call sites in components pass `unit`. No bare `formatWeight(grams)` calls remain. |
|
|
| UNIT-03 | 07-01-PLAN, 07-02-PLAN | Weight unit preference persists across sessions | VERIFIED (mechanism) / NEEDS HUMAN (runtime) | `useSetting("weightUnit")` reads from `/api/settings/weightUnit`. `useUpdateSetting` writes to same endpoint. Persistence across refresh requires runtime verification. |
|
|
|
|
No orphaned requirements. REQUIREMENTS.md marks all three as complete for Phase 7. All three requirement IDs appear in at least one plan's `requirements` field.
|
|
|
|
### Anti-Patterns Found
|
|
|
|
| File | Line | Pattern | Severity | Impact |
|
|
|------|------|---------|----------|--------|
|
|
| — | — | None found | — | — |
|
|
|
|
Scanned all 11 modified files. No TODOs, FIXMEs, placeholder comments, empty implementations, or stub returns found. All `formatWeight` calls outside `formatters.ts` carry the `unit` argument.
|
|
|
|
### Human Verification Required
|
|
|
|
#### 1. Unit Toggle Visibility
|
|
|
|
**Test:** Start `bun run dev:client` and `bun run dev:server`, navigate to http://localhost:5173/collection
|
|
**Expected:** A segmented pill toggle showing g / oz / lb / kg is visible in the sticky top bar, positioned between the GearBox title and the stats (items / total / spent)
|
|
**Why human:** Visual rendering cannot be verified programmatically
|
|
|
|
#### 2. Unit Toggle Click Behavior
|
|
|
|
**Test:** With the app running, click "oz" in the toggle on the Collection page
|
|
**Expected:** All weight badges on ItemCards, CategoryHeader totals, and the TotalsBar total update immediately to ounce values (e.g., "15.9 oz"). No page reload required.
|
|
**Why human:** React Query cache invalidation and live re-render require runtime observation
|
|
|
|
#### 3. Cross-Page Unit Consistency
|
|
|
|
**Test:** Select "lb" on the Collection page, then navigate to the Dashboard (/), then navigate to a Setup detail page
|
|
**Expected:** The Dashboard Collection card weight shows in lb; all weights in the Setup detail sticky bar and ItemCards show in lb
|
|
**Why human:** Cross-page state propagation via TanStack Router and shared React Query cache requires runtime verification
|
|
|
|
#### 4. Persistence Across Refresh
|
|
|
|
**Test:** Select "kg", then hard-refresh the page (Ctrl+R or F5)
|
|
**Expected:** After refresh, all weights still display in kg. The kg button appears active/highlighted in the toggle.
|
|
**Why human:** Browser session handling and settings API round-trip require runtime verification
|
|
|
|
### Gaps Summary
|
|
|
|
No automated gaps found. All artifacts exist, are substantive, and are correctly wired. The 3 human verification items are standard runtime behaviors (visual rendering, live updates, persistence) that cannot be verified statically.
|
|
|
|
The implementation is complete and correct based on static analysis:
|
|
- `formatWeight` conversion math is verified by 21 passing tests
|
|
- All 8 component call sites pass `unit` from `useWeightUnit()` — confirmed by exhaustive grep
|
|
- TotalsBar contains the full toggle UI with `useUpdateSetting` wired to `weightUnit` key
|
|
- `useWeightUnit` correctly wraps `useSetting("weightUnit")` with type validation and "g" default
|
|
- Full test suite (108 tests) passes with no regressions
|
|
- Lint clean (78 files, no issues)
|
|
- All 4 phase commits verified in git history (431c179, 6cac0a3, ada3791, faa4378)
|
|
|
|
---
|
|
|
|
_Verified: 2026-03-16T12:00:00Z_
|
|
_Verifier: Claude (gsd-verifier)_
|