Skip to content

Commit a92f494

Browse files
leecampbell-codeagentLeeCampbell
leecampbell-codeagent
authored and
LeeCampbell
committed
plan(#132): create task breakdown
1 parent b8c744f commit a92f494

1 file changed

Lines changed: 139 additions & 0 deletions

File tree

‎plan/ready/task.md‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
# Task List: Upgrade BenchmarkDotNet from 0.13.12 to 0.15.8 (Issue #132)
2+
3+
## Context
4+
5+
The `HdrHistogram.Benchmarking` project must have both `BenchmarkDotNet` and `BenchmarkDotNet.Diagnostics.Windows` upgraded from `0.13.12` to `0.15.8`.
6+
The upgrade spans two minor versions and may introduce breaking API changes or new Roslyn analyser diagnostics.
7+
Verification is build-based — no unit test changes are required.
8+
9+
---
10+
11+
## Tasks
12+
13+
### 1. Update package references in the project file
14+
15+
- [ ] **Task 1** — In `HdrHistogram.Benchmarking/HdrHistogram.Benchmarking.csproj` line 9, change `Version="0.13.12"` to `Version="0.15.8"` for the `BenchmarkDotNet` `<PackageReference>`.
16+
- File: `HdrHistogram.Benchmarking/HdrHistogram.Benchmarking.csproj`
17+
- Why: This is the primary package that provides the benchmarking framework.
18+
- Verify: The element reads `<PackageReference Include="BenchmarkDotNet" Version="0.15.8" />`.
19+
20+
- [ ] **Task 2** — In `HdrHistogram.Benchmarking/HdrHistogram.Benchmarking.csproj` lines 10–12, change `<Version>0.13.12</Version>` to `<Version>0.15.8</Version>` for the `BenchmarkDotNet.Diagnostics.Windows` `<PackageReference>`.
21+
- File: `HdrHistogram.Benchmarking/HdrHistogram.Benchmarking.csproj`
22+
- Why: Companion package; must always match the main `BenchmarkDotNet` version exactly.
23+
- Verify: The element reads `<PackageReference Include="BenchmarkDotNet.Diagnostics.Windows"><Version>0.15.8</Version></PackageReference>`.
24+
25+
---
26+
27+
### 2. Restore packages
28+
29+
- [ ] **Task 3** — Run `dotnet restore HdrHistogram.Benchmarking/HdrHistogram.Benchmarking.csproj` and confirm it exits with code 0.
30+
- File: `HdrHistogram.Benchmarking/HdrHistogram.Benchmarking.csproj`
31+
- Why: Pulls the `0.15.8` NuGet packages from the feed before attempting compilation.
32+
- Verify: Command output shows no errors; `BenchmarkDotNet 0.15.8` appears in restored packages.
33+
34+
---
35+
36+
### 3. Attempt first build and capture diagnostics
37+
38+
- [ ] **Task 4** — Run `dotnet build HdrHistogram.Benchmarking/HdrHistogram.Benchmarking.csproj -c Release` and capture the full compiler output.
39+
- File: `HdrHistogram.Benchmarking/HdrHistogram.Benchmarking.csproj` (and referenced source files)
40+
- Why: Surfaces any compilation errors or new analyser warnings-as-errors introduced by the version bump before attempting fixes.
41+
- Verify: Output is captured and reviewed for error codes and messages.
42+
43+
---
44+
45+
### 4. Investigate and fix breaking changes in `Program.cs`
46+
47+
`Program.cs` configures jobs targeting several runtimes that may have been removed or renamed in BenchmarkDotNet 0.14/0.15.
48+
49+
- [ ] **Task 5** — Check whether `ClrRuntime.Net481` still exists in `BenchmarkDotNet.Environments` in 0.15.8; if it has been removed or renamed, update `Program.cs` accordingly.
50+
- File: `HdrHistogram.Benchmarking/Program.cs` line 19–20
51+
- Why: `ClrRuntime.Net481` and `Jit.LegacyJit` were historically only supported on Windows; BenchmarkDotNet 0.15.x may have removed or deprecated support for these.
52+
- Verify: No `CS0117` / `CS0103` compiler error referencing `ClrRuntime` or `Jit.LegacyJit`.
53+
54+
- [ ] **Task 6** — Check whether `CoreRuntime.Core21`, `CoreRuntime.Core31`, `CoreRuntime.Core50` still exist in 0.15.8; if any have been removed as EOL runtimes, remove or replace those `.AddJob(...)` calls in `Program.cs`.
55+
- File: `HdrHistogram.Benchmarking/Program.cs` lines 21–23
56+
- Why: BenchmarkDotNet may drop constants for end-of-life .NET versions; compilation will fail if the symbols no longer exist.
57+
- Verify: No `CS0117` compiler error referencing `CoreRuntime.Core21`, `CoreRuntime.Core31`, or `CoreRuntime.Core50`.
58+
59+
- [ ] **Task 7** — Check whether `StatisticColumn.P0`, `StatisticColumn.Q1`, `StatisticColumn.P67`, `StatisticColumn.Q3`, `StatisticColumn.P80`, `StatisticColumn.P90`, `StatisticColumn.P95`, `StatisticColumn.P100` still exist in `BenchmarkDotNet.Columns` in 0.15.8; if any have been renamed or removed, update `Program.cs`.
60+
- File: `HdrHistogram.Benchmarking/Program.cs` line 18
61+
- Why: Column name constants occasionally change between minor versions.
62+
- Verify: No `CS0117` compiler error referencing any `StatisticColumn.*` member.
63+
64+
- [ ] **Task 8** — Check whether `ManualConfig.Create`, `DefaultConfig.Instance`, `BenchmarkSwitcher`, and `switcher.Run` APIs remain present and have the same signatures in 0.15.8; fix any signature mismatches if they do not.
65+
- File: `HdrHistogram.Benchmarking/Program.cs` lines 13, 29, 34
66+
- Why: Core configuration and runner APIs are historically stable but could have changed in two minor versions.
67+
- Verify: No `CS1061`, `CS0246`, or overload-resolution errors on these call sites.
68+
69+
---
70+
71+
### 5. Investigate and fix breaking changes in benchmark source files
72+
73+
- [ ] **Task 9** — Check whether `[BenchmarkDotNet.Attributes.GlobalSetup]` and `[Benchmark]` attributes remain unchanged in the BenchmarkDotNet 0.15.8 `Attributes` namespace; fix any namespace or attribute-name changes if present.
74+
- File: `HdrHistogram.Benchmarking/LeadingZeroCount/LeadingZeroCountBenchmarkBase.cs` line 49 and benchmark methods
75+
- Why: Attributes are the primary extension point used in this file; a rename would cause compilation failure.
76+
- Verify: No `CS0246` errors referencing `GlobalSetup` or `Benchmark` attributes.
77+
78+
- [ ] **Task 10** — Confirm `[Benchmark(Baseline = true, OperationsPerInvoke = ...)]` constructor parameters are still valid in 0.15.8; fix any parameter changes if present.
79+
- File: `HdrHistogram.Benchmarking/Recording/Recording32BitBenchmark.cs` (all `[Benchmark]` attribute usages)
80+
- Why: Named constructor parameters can be removed or renamed across minor versions.
81+
- Verify: No `CS0246`, `CS1739`, or `CS1503` errors on `[Benchmark(...)]` usages.
82+
83+
---
84+
85+
### 6. Fix new Roslyn analyser diagnostics
86+
87+
- [ ] **Task 11** — After the first successful compilation pass, review all warnings and determine whether any are promoted to errors under `<EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>` and `<AnalysisLevel>latest-recommended</AnalysisLevel>` (set in `Directory.Build.props`); fix any new violations in the benchmarking source files.
88+
- Files: `HdrHistogram.Benchmarking/Program.cs`, `HdrHistogram.Benchmarking/LeadingZeroCount/LeadingZeroCountBenchmarkBase.cs`, `HdrHistogram.Benchmarking/Recording/Recording32BitBenchmark.cs`
89+
- Why: BenchmarkDotNet 0.15.x ships new Roslyn analysers; existing code may trigger rules that are elevated to errors by the project's global settings.
90+
- Verify: Build output contains zero `error` lines.
91+
92+
---
93+
94+
### 7. Verify benchmarking project build succeeds
95+
96+
- [ ] **Task 12** — Run `dotnet build HdrHistogram.Benchmarking/HdrHistogram.Benchmarking.csproj -c Release` and confirm exit code 0 with no errors and no warnings treated as errors.
97+
- File: `HdrHistogram.Benchmarking/HdrHistogram.Benchmarking.csproj`
98+
- Why: Directly satisfies acceptance criterion 3.
99+
- Verify: Terminal output ends with `Build succeeded` and `0 Error(s)`.
100+
101+
---
102+
103+
### 8. Verify full solution build succeeds
104+
105+
- [ ] **Task 13** — Run `dotnet build HdrHistogram.sln -c Release` and confirm exit code 0 with no errors across all four projects (`HdrHistogram`, `HdrHistogram.Examples`, `HdrHistogram.UnitTests`, `HdrHistogram.Benchmarking`).
106+
- File: `HdrHistogram.sln`
107+
- Why: Directly satisfies acceptance criterion 4; catches regressions in sibling projects caused by shared `Directory.Build.props` changes, if any.
108+
- Verify: Terminal output ends with `Build succeeded` and `0 Error(s)`.
109+
110+
---
111+
112+
### 9. Dry-run benchmark discovery
113+
114+
- [ ] **Task 14** — Run `dotnet run --project HdrHistogram.Benchmarking/HdrHistogram.Benchmarking.csproj -c Release -- --list flat` and confirm BenchmarkDotNet enumerates all benchmarks without crashing.
115+
- File: `HdrHistogram.Benchmarking/Program.cs`
116+
- Why: Validates runtime initialisation — a build success does not guarantee that BenchmarkDotNet can discover and enumerate benchmarks at start-up.
117+
- Verify: Output lists at least the `LeadingZeroCount` and `Recording` benchmark classes; process exits with code 0.
118+
119+
---
120+
121+
### 10. Update documentation
122+
123+
- [ ] **Task 15** — In `spec/tech-standards/build-system.md`, replace both occurrences of `0.13.12` in the BenchmarkDotNet `<PackageReference>` XML block with `0.15.8`.
124+
- File: `spec/tech-standards/build-system.md` lines 66–67
125+
- Why: Directly satisfies acceptance criterion 5; prevents stale documentation drift.
126+
- Verify: `grep "0.13.12" spec/tech-standards/build-system.md` returns no matches; `grep "0.15.8" spec/tech-standards/build-system.md` returns the updated lines.
127+
128+
---
129+
130+
## Acceptance Criteria Cross-Reference
131+
132+
| Acceptance criterion (from brief) | Covered by task(s) |
133+
|---|---|
134+
| `BenchmarkDotNet` version in `.csproj` is `0.15.8` | Task 1 |
135+
| `BenchmarkDotNet.Diagnostics.Windows` version in `.csproj` is `0.15.8` | Task 2 |
136+
| `dotnet build HdrHistogram.Benchmarking/...csproj -c Release` exits 0, no errors | Tasks 3–12 |
137+
| `dotnet build HdrHistogram.sln -c Release` exits 0 | Task 13 |
138+
| `spec/tech-standards/build-system.md` references `0.15.8`, not `0.13.12` | Task 15 |
139+
| No existing benchmark class logic changed unless forced by breaking change | Tasks 5–10 (scope-limited fixes only) |

0 commit comments

Comments
 (0)