docs(11-02): complete HTML export branding injection plan
- SUMMARY.md created for 11-02 plan - STATE.md updated with decisions and progress - ROADMAP.md updated with phase 11 plan progress (3/4 summaries)
This commit is contained in:
Dev
123
.planning/phases/11-html-export-branding/11-02-SUMMARY.md
Normal file
123
.planning/phases/11-html-export-branding/11-02-SUMMARY.md
Normal file
@@ -0,0 +1,123 @@
|
||||
---
|
||||
phase: 11-html-export-branding
|
||||
plan: 02
|
||||
subsystem: export
|
||||
tags: [html-export, branding, csharp, tdd, dotnet]
|
||||
|
||||
# Dependency graph
|
||||
requires:
|
||||
- phase: 11-01
|
||||
provides: ReportBranding record and BrandingHtmlHelper.BuildBrandingHeader static method
|
||||
provides:
|
||||
- HtmlExportService with optional ReportBranding? branding parameter on BuildHtml and WriteAsync
|
||||
- SearchHtmlExportService with optional ReportBranding? branding parameter
|
||||
- StorageHtmlExportService with optional ReportBranding? branding parameter (both overloads)
|
||||
- DuplicatesHtmlExportService with optional ReportBranding? branding parameter
|
||||
- UserAccessHtmlExportService with optional ReportBranding? branding parameter
|
||||
- 7 new branding tests across all 5 export test files
|
||||
affects:
|
||||
- 11-03 (ViewModels assemble ReportBranding and pass to export services)
|
||||
|
||||
# Tech tracking
|
||||
tech-stack:
|
||||
added: []
|
||||
patterns:
|
||||
- "Optional nullable parameter after CancellationToken ct in WriteAsync for backward compat"
|
||||
- "Raw string literal split at body/h1 boundary to inject branding header between them"
|
||||
- "sb.Append (not AppendLine) for branding header — BrandingHtmlHelper already appends newlines"
|
||||
|
||||
key-files:
|
||||
created: []
|
||||
modified:
|
||||
- SharepointToolbox/Services/Export/HtmlExportService.cs
|
||||
- SharepointToolbox/Services/Export/SearchHtmlExportService.cs
|
||||
- SharepointToolbox/Services/Export/StorageHtmlExportService.cs
|
||||
- SharepointToolbox/Services/Export/DuplicatesHtmlExportService.cs
|
||||
- SharepointToolbox/Services/Export/UserAccessHtmlExportService.cs
|
||||
- SharepointToolbox.Tests/Services/Export/HtmlExportServiceTests.cs
|
||||
- SharepointToolbox.Tests/Services/Export/SearchExportServiceTests.cs
|
||||
- SharepointToolbox.Tests/Services/Export/StorageHtmlExportServiceTests.cs
|
||||
- SharepointToolbox.Tests/Services/Export/DuplicatesHtmlExportServiceTests.cs
|
||||
- SharepointToolbox.Tests/Services/Export/UserAccessHtmlExportServiceTests.cs
|
||||
|
||||
key-decisions:
|
||||
- "branding parameter placed AFTER CancellationToken ct in WriteAsync signatures — existing positional callers unaffected"
|
||||
- "Raw string literals in SearchHtmlExportService, StorageHtmlExportService, DuplicatesHtmlExportService split at body/h1 boundary for injection"
|
||||
- "MakeBranding helper added locally to each test class rather than a shared base class — test files stay self-contained"
|
||||
|
||||
# Metrics
|
||||
duration: 4min
|
||||
completed: 2026-04-08
|
||||
---
|
||||
|
||||
# Phase 11 Plan 02: HTML Export Branding Injection Summary
|
||||
|
||||
**Optional ReportBranding parameter wired into all 5 HTML export services; branding header injected between body and h1 via BrandingHtmlHelper; 7 new tests confirm injection and null-safety**
|
||||
|
||||
## Performance
|
||||
|
||||
- **Duration:** ~4 min
|
||||
- **Started:** 2026-04-08T12:41:44Z
|
||||
- **Completed:** 2026-04-08T12:46:00Z
|
||||
- **Tasks:** 2 (Task 1: implementation, Task 2: TDD tests)
|
||||
- **Files modified:** 10
|
||||
|
||||
## Accomplishments
|
||||
|
||||
- Added `ReportBranding? branding = null` as last parameter to `BuildHtml` on all 5 export services
|
||||
- Added `ReportBranding? branding = null` after `CancellationToken ct` on all `WriteAsync` overloads (9 overloads total)
|
||||
- Inserted `sb.Append(BrandingHtmlHelper.BuildBrandingHeader(branding));` between `<body>` and `<h1>` in every exporter
|
||||
- Split raw string literals in 3 services (SearchHtml, StorageHtml, Duplicates) at the body/h1 boundary to enable injection
|
||||
- StorageHtmlExportService `_togIdx` reset logic left untouched (per plan pitfall guidance)
|
||||
- HtmlExportService both overloads updated (PermissionEntry and SimplifiedPermissionEntry)
|
||||
- StorageHtmlExportService both overloads updated (nodes-only and nodes+fileTypeMetrics)
|
||||
- Added `MakeBranding` helper to all 5 test classes; wrote 7 new tests (3 in HtmlExportServiceTests, 1 each in the other 4)
|
||||
- All 45 export tests pass; full suite: 247 passed / 0 failed / 26 skipped (skips are pre-existing integration tests)
|
||||
|
||||
## Task Commits
|
||||
|
||||
Each task was committed atomically:
|
||||
|
||||
1. **Task 1: Add branding parameter to all 5 HTML export services** - `2233fb8` (feat)
|
||||
2. **Task 2: Extend export tests to verify branding injection** - `d8b6616` (feat)
|
||||
|
||||
## Files Created/Modified
|
||||
|
||||
- `SharepointToolbox/Services/Export/HtmlExportService.cs` - branding param + injection (2 BuildHtml, 2 WriteAsync)
|
||||
- `SharepointToolbox/Services/Export/SearchHtmlExportService.cs` - branding param + injection via raw string split
|
||||
- `SharepointToolbox/Services/Export/StorageHtmlExportService.cs` - branding param + injection (2 BuildHtml, 2 WriteAsync)
|
||||
- `SharepointToolbox/Services/Export/DuplicatesHtmlExportService.cs` - branding param + injection via raw string split
|
||||
- `SharepointToolbox/Services/Export/UserAccessHtmlExportService.cs` - branding param + injection
|
||||
- `SharepointToolbox.Tests/Services/Export/HtmlExportServiceTests.cs` - 3 new branding tests
|
||||
- `SharepointToolbox.Tests/Services/Export/SearchExportServiceTests.cs` - 1 new branding test
|
||||
- `SharepointToolbox.Tests/Services/Export/StorageHtmlExportServiceTests.cs` - 1 new branding test
|
||||
- `SharepointToolbox.Tests/Services/Export/DuplicatesHtmlExportServiceTests.cs` - 1 new branding test
|
||||
- `SharepointToolbox.Tests/Services/Export/UserAccessHtmlExportServiceTests.cs` - 1 new branding test
|
||||
|
||||
## Decisions Made
|
||||
|
||||
- Placed `branding` AFTER `CancellationToken ct` in WriteAsync — avoids breaking any existing positional callers that pass ct by position
|
||||
- Used `sb.Append` (not `sb.AppendLine`) when inserting branding header — BrandingHtmlHelper already ends its output with a newline, so no double blank line
|
||||
- Raw string literals split at body/h1 boundary by closing the first literal after `<body>` then re-opening for `<h1>` — avoids string concatenation or interpolation awkwardness inside raw string blocks
|
||||
|
||||
## Deviations from Plan
|
||||
|
||||
None - plan executed exactly as written.
|
||||
|
||||
## Issues Encountered
|
||||
|
||||
None.
|
||||
|
||||
## User Setup Required
|
||||
|
||||
None.
|
||||
|
||||
## Next Phase Readiness
|
||||
|
||||
- All 5 HTML export services now accept `ReportBranding? branding = null` — Plan 11-03 ViewModels can assemble `ReportBranding` from `IBrandingService` and `TenantProfile` and pass it to any of these services
|
||||
- All existing callers compile unchanged (zero-regression confirmed by full test suite)
|
||||
- Build passes with 0 warnings
|
||||
|
||||
---
|
||||
*Phase: 11-html-export-branding*
|
||||
*Completed: 2026-04-08*
|
||||
Reference in New Issue
Block a user