Commit cab2bd8
authored
test(StudentProfileModel-timezone-boundaries): verify Timezone Normalization & Calendar Data Boundary Alignment (Variation 8) (JhaSourav07#3177)
## Description
Closes JhaSourav07#2910
Adds the missing timezone normalisation and calendar data boundary
alignment coverage for `models/StudentProfile.ts`. The new test file
verifies the visual date mapping for `createdAt` / `updatedAt`, the
streak and monthly math across UTC, EST, IST, and JST, leap year
boundaries, localised date part ordering, DST transitions, and invalid
offset fallback behaviour.
## Pillar
- [x] 🛠️ Other (Test coverage for timezone normalisation & calendar data
boundary alignment)
## What changed
- Added `models/StudentProfile.timezone-boundaries.test.ts` with 5 test
cases covering:
- `createdAt` / `updatedAt` round-trip and visual date mapping for UTC,
America/New_York, Asia/Kolkata, and Asia/Tokyo
- Leap year boundary preservation (2024-02-29) across UTC and Asia/Tokyo
- Localised calendar date part ordering across en-US, en-GB, and ja-JP
- DST transition offsets (2024-03-10 in America/New_York) and streak
continuity
- Invalid and zero-offset timezone labels normalised to UTC without
breaking calculation loops
## Checklist before requesting a review:
- [x] I have read the `CONTRIBUTING.md` file.
- [x] I have tested these changes locally (`npx vitest run
models/StudentProfile.timezone-boundaries.test.ts`).
- [x] I have run `npm run format` and `npm run lint` locally and
resolved all errors (CI will fail otherwise).
- [x] My commits follow the Conventional Commits format (e.g.,
`feat(themes): ...`, `fix(calculate): ...`).
- [x] I have made sure that I have only one commit to merge in this PR.
## What this fixes
`models/StudentProfile.ts` did not have any test coverage verifying that
the timestamps attached to a profile (and the contribution calendar math
that depends on them) stay aligned when rendered in different timezones.
A profile created at the end of the day in UTC currently looks like it
was created the next day for viewers in IST or JST, and the
streak/monthly calculation routines in `lib/calculate.ts` are exactly
what power those visualisations, so any boundary shift there propagates
into the student profile surface.
## Root cause
The timezone offset handling only existed inside `calculateStreak`,
`calculateMonthlyStats`, and `findTodayIndex` in `lib/calculate.ts`. The
`StudentProfile` model itself does not perform any timezone
normalisation — it stores `createdAt` / `updatedAt` as raw `Date`
instances. That means the rendering layer (and any consumer that calls
the calendar helpers) is fully responsible for picking the right offset,
and the model had no regression net to catch a future change that moved
a date onto the wrong visual day (e.g. 2024-01-15 23:30 UTC being shown
as 2024-01-16 in Asia/Kolkata).
## How to verify
1. Checkout the branch: `git fetch && git checkout
test/student-profile-timezone-boundaries`
2. Install dependencies if needed: `npm install`
3. Run the new test file in isolation: `npx vitest run
models/StudentProfile.timezone-boundaries.test.ts`
4. Run the full suite to make sure nothing regresses: `npm test`
5. Run the lint/format gate: `npm run lint && npm run format:check`
## Edge cases considered
- **DST spring-forward**: covered via the `America/New_York` transition
on 2024-03-10. `calculateStreak` is expected to keep the streak alive
across the missing hour and report the same `todayDate` on both sides of
the transition.
- **Invalid timezone label**: `UTC+25`, `0`, `+00:00`, `-00:00`, and
empty strings are all normalised to `UTC` before being handed to the
calendar helpers so the streak/monthly routines do not throw.
- **Leap year boundary**: 2024-02-29 is included in the calendar and the
month name is asserted to remain `February` even when the viewer is in
`Asia/Tokyo`.
- **Localised date order**: `en-US` (`month/day/year`), `en-GB`
(`day/month/year`), and `ja-JP` (`year/month/day`) are all asserted so a
future i18n change is caught.
- **Out of scope**: The fix does not introduce any normalisation on the
model itself (e.g. writing back a timezone-normalised `createdAt`). That
is intentional — timezone is a presentation concern and the helpers in
`lib/calculate.ts` already accept it as a parameter.1 file changed
Lines changed: 284 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
| 271 | + | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
| 284 | + | |
0 commit comments