chore: complete v1.0 milestone
All checks were successful
Release zip package / release (push) Successful in 10s
All checks were successful
Release zip package / release (push) Successful in 10s
Archive 5 phases (36 plans) to milestones/v1.0-phases/. Archive roadmap, requirements, and audit to milestones/. Evolve PROJECT.md with shipped state and validated requirements. Collapse ROADMAP.md to one-line milestone summary. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Dev
226
.planning/milestones/v1.0-phases/01-foundation/01-01-PLAN.md
Normal file
226
.planning/milestones/v1.0-phases/01-foundation/01-01-PLAN.md
Normal file
@@ -0,0 +1,226 @@
|
||||
---
|
||||
phase: 01-foundation
|
||||
plan: 01
|
||||
type: execute
|
||||
wave: 1
|
||||
depends_on: []
|
||||
files_modified:
|
||||
- SharepointToolbox/SharepointToolbox.csproj
|
||||
- SharepointToolbox/App.xaml
|
||||
- SharepointToolbox/App.xaml.cs
|
||||
- SharepointToolbox.Tests/SharepointToolbox.Tests.csproj
|
||||
- SharepointToolbox.Tests/Services/ProfileServiceTests.cs
|
||||
- SharepointToolbox.Tests/Services/SettingsServiceTests.cs
|
||||
- SharepointToolbox.Tests/Auth/MsalClientFactoryTests.cs
|
||||
- SharepointToolbox.Tests/Auth/SessionManagerTests.cs
|
||||
- SharepointToolbox.Tests/ViewModels/FeatureViewModelBaseTests.cs
|
||||
- SharepointToolbox.Tests/Localization/TranslationSourceTests.cs
|
||||
- SharepointToolbox.Tests/Integration/LoggingIntegrationTests.cs
|
||||
- SharepointToolbox.sln
|
||||
autonomous: true
|
||||
requirements:
|
||||
- FOUND-01
|
||||
must_haves:
|
||||
truths:
|
||||
- "dotnet build produces zero errors"
|
||||
- "dotnet test produces zero test failures (all tests pending/skipped)"
|
||||
- "Solution contains two projects: SharepointToolbox (WPF) and SharepointToolbox.Tests (xUnit)"
|
||||
- "App.xaml has no StartupUri — Generic Host entry point is wired"
|
||||
artifacts:
|
||||
- path: "SharepointToolbox/SharepointToolbox.csproj"
|
||||
provides: "WPF .NET 10 project with all NuGet packages"
|
||||
contains: "PublishTrimmed>false"
|
||||
- path: "SharepointToolbox/App.xaml.cs"
|
||||
provides: "Generic Host entry point with [STAThread]"
|
||||
contains: "Host.CreateDefaultBuilder"
|
||||
- path: "SharepointToolbox.Tests/SharepointToolbox.Tests.csproj"
|
||||
provides: "xUnit test project"
|
||||
contains: "xunit"
|
||||
- path: "SharepointToolbox.sln"
|
||||
provides: "Solution file with both projects"
|
||||
key_links:
|
||||
- from: "SharepointToolbox/App.xaml.cs"
|
||||
to: "SharepointToolbox/App.xaml"
|
||||
via: "x:Class reference + StartupUri removed"
|
||||
pattern: "StartupUri"
|
||||
- from: "SharepointToolbox/SharepointToolbox.csproj"
|
||||
to: "App.xaml"
|
||||
via: "Page include replacing ApplicationDefinition"
|
||||
pattern: "ApplicationDefinition"
|
||||
---
|
||||
|
||||
<objective>
|
||||
Create the solution scaffold: WPF .NET 10 project with all NuGet packages wired, Generic Host entry point, and xUnit test project with stub test files that compile but have no passing tests yet.
|
||||
|
||||
Purpose: Every subsequent plan builds on a compiling, test-wired foundation. Getting the Generic Host + WPF STA threading right here prevents the most common startup crash.
|
||||
Output: SharepointToolbox.sln with two projects, zero build errors, zero test failures on first run.
|
||||
</objective>
|
||||
|
||||
<execution_context>
|
||||
@C:/Users/SebastienQUEROL/.claude/get-shit-done/workflows/execute-plan.md
|
||||
@C:/Users/SebastienQUEROL/.claude/get-shit-done/templates/summary.md
|
||||
</execution_context>
|
||||
|
||||
<context>
|
||||
@.planning/PROJECT.md
|
||||
@.planning/ROADMAP.md
|
||||
@.planning/STATE.md
|
||||
@.planning/phases/01-foundation/01-CONTEXT.md
|
||||
@.planning/phases/01-foundation/01-RESEARCH.md
|
||||
</context>
|
||||
|
||||
<tasks>
|
||||
|
||||
<task type="auto">
|
||||
<name>Task 1: Create solution and WPF project with all NuGet packages</name>
|
||||
<files>
|
||||
SharepointToolbox.sln,
|
||||
SharepointToolbox/SharepointToolbox.csproj,
|
||||
SharepointToolbox/App.xaml,
|
||||
SharepointToolbox/App.xaml.cs,
|
||||
SharepointToolbox/MainWindow.xaml,
|
||||
SharepointToolbox/MainWindow.xaml.cs
|
||||
</files>
|
||||
<action>
|
||||
Run from the repo root:
|
||||
|
||||
```
|
||||
dotnet new sln -n SharepointToolbox
|
||||
dotnet new wpf -n SharepointToolbox -f net10.0-windows
|
||||
dotnet sln add SharepointToolbox/SharepointToolbox.csproj
|
||||
```
|
||||
|
||||
Edit SharepointToolbox/SharepointToolbox.csproj:
|
||||
- Set `<TargetFramework>net10.0-windows</TargetFramework>`
|
||||
- Add `<Nullable>enable</Nullable>`, `<ImplicitUsings>enable</ImplicitUsings>`
|
||||
- Add `<PublishTrimmed>false</PublishTrimmed>` (critical — PnP.Framework + MSAL use reflection)
|
||||
- Add `<StartupObject>SharepointToolbox.App</StartupObject>`
|
||||
- Add NuGet packages:
|
||||
- `CommunityToolkit.Mvvm` version 8.4.2
|
||||
- `Microsoft.Extensions.Hosting` version 10.x (latest 10.x)
|
||||
- `Microsoft.Identity.Client` version 4.83.1
|
||||
- `Microsoft.Identity.Client.Extensions.Msal` version 4.83.3
|
||||
- `Microsoft.Identity.Client.Broker` version 4.82.1
|
||||
- `PnP.Framework` version 1.18.0
|
||||
- `Serilog` version 4.3.1
|
||||
- `Serilog.Sinks.File` (latest)
|
||||
- `Serilog.Extensions.Hosting` (latest)
|
||||
- Change `<ApplicationDefinition Remove="App.xaml" />` and `<Page Include="App.xaml" />` to demote App.xaml from ApplicationDefinition
|
||||
|
||||
Edit App.xaml: Remove `StartupUri="MainWindow.xaml"`. Keep `x:Class="SharepointToolbox.App"`.
|
||||
|
||||
Edit App.xaml.cs: Replace default App class with Generic Host entry point pattern:
|
||||
```csharp
|
||||
public partial class App : Application
|
||||
{
|
||||
[STAThread]
|
||||
public static void Main(string[] args)
|
||||
{
|
||||
using IHost host = Host.CreateDefaultBuilder(args)
|
||||
.UseSerilog((ctx, cfg) => cfg
|
||||
.WriteTo.File(
|
||||
Path.Combine(
|
||||
Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData),
|
||||
"SharepointToolbox", "logs", "app-.log"),
|
||||
rollingInterval: RollingInterval.Day,
|
||||
retainedFileCountLimit: 30))
|
||||
.ConfigureServices(RegisterServices)
|
||||
.Build();
|
||||
|
||||
host.Start();
|
||||
App app = new();
|
||||
app.InitializeComponent();
|
||||
app.MainWindow = host.Services.GetRequiredService<MainWindow>();
|
||||
app.MainWindow.Visibility = Visibility.Visible;
|
||||
app.Run();
|
||||
}
|
||||
|
||||
private static void RegisterServices(HostBuilderContext ctx, IServiceCollection services)
|
||||
{
|
||||
// Placeholder — services registered in subsequent plans
|
||||
services.AddSingleton<MainWindow>();
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Leave MainWindow.xaml and MainWindow.xaml.cs as the default WPF template output — they will be replaced in plan 01-06.
|
||||
|
||||
Run `dotnet build SharepointToolbox/SharepointToolbox.csproj` and fix any errors before moving to Task 2.
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd "C:\Users\dev\Documents\projets\Sharepoint" && dotnet build SharepointToolbox/SharepointToolbox.csproj --no-incremental 2>&1 | tail -5</automated>
|
||||
</verify>
|
||||
<done>Build output shows "Build succeeded" with 0 errors. App.xaml has no StartupUri. csproj contains PublishTrimmed=false and StartupObject.</done>
|
||||
</task>
|
||||
|
||||
<task type="auto">
|
||||
<name>Task 2: Create xUnit test project with stub test files</name>
|
||||
<files>
|
||||
SharepointToolbox.Tests/SharepointToolbox.Tests.csproj,
|
||||
SharepointToolbox.Tests/Services/ProfileServiceTests.cs,
|
||||
SharepointToolbox.Tests/Services/SettingsServiceTests.cs,
|
||||
SharepointToolbox.Tests/Auth/MsalClientFactoryTests.cs,
|
||||
SharepointToolbox.Tests/Auth/SessionManagerTests.cs,
|
||||
SharepointToolbox.Tests/ViewModels/FeatureViewModelBaseTests.cs,
|
||||
SharepointToolbox.Tests/Localization/TranslationSourceTests.cs,
|
||||
SharepointToolbox.Tests/Integration/LoggingIntegrationTests.cs
|
||||
</files>
|
||||
<action>
|
||||
Run from the repo root:
|
||||
```
|
||||
dotnet new xunit -n SharepointToolbox.Tests -f net10.0
|
||||
dotnet sln add SharepointToolbox.Tests/SharepointToolbox.Tests.csproj
|
||||
dotnet add SharepointToolbox.Tests/SharepointToolbox.Tests.csproj reference SharepointToolbox/SharepointToolbox.csproj
|
||||
```
|
||||
|
||||
Edit SharepointToolbox.Tests/SharepointToolbox.Tests.csproj:
|
||||
- Add `Moq` (latest) NuGet package
|
||||
- Add `Microsoft.NET.Test.Sdk` (already included in xunit template)
|
||||
- Add `<Nullable>enable</Nullable>`, `<ImplicitUsings>enable</ImplicitUsings>`
|
||||
|
||||
Create stub test files — each file compiles but has a single `[Fact(Skip = "Not implemented yet")]` test so the suite passes (no failures, just skips):
|
||||
|
||||
**SharepointToolbox.Tests/Services/ProfileServiceTests.cs**
|
||||
```csharp
|
||||
namespace SharepointToolbox.Tests.Services;
|
||||
public class ProfileServiceTests
|
||||
{
|
||||
[Fact(Skip = "Wave 0 stub — implemented in plan 01-03")]
|
||||
public void SaveAndLoad_RoundTrips_Profiles() { }
|
||||
}
|
||||
```
|
||||
|
||||
Create identical stub pattern for:
|
||||
- `SettingsServiceTests.cs` — class `SettingsServiceTests`, skip reason "plan 01-03"
|
||||
- `MsalClientFactoryTests.cs` — class `MsalClientFactoryTests`, skip reason "plan 01-04"
|
||||
- `SessionManagerTests.cs` — class `SessionManagerTests`, skip reason "plan 01-04"
|
||||
- `FeatureViewModelBaseTests.cs` — class `FeatureViewModelBaseTests`, skip reason "plan 01-06"
|
||||
- `TranslationSourceTests.cs` — class `TranslationSourceTests`, skip reason "plan 01-05"
|
||||
- `LoggingIntegrationTests.cs` — class `LoggingIntegrationTests`, skip reason "plan 01-05"
|
||||
|
||||
Run `dotnet test SharepointToolbox.Tests/SharepointToolbox.Tests.csproj --no-build` after building to confirm all tests are skipped (0 failed).
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd "C:\Users\dev\Documents\projets\Sharepoint" && dotnet test SharepointToolbox.Tests/SharepointToolbox.Tests.csproj 2>&1 | tail -10</automated>
|
||||
</verify>
|
||||
<done>dotnet test shows 0 failed, 7 skipped (or similar). All stub test files exist in correct subdirectories.</done>
|
||||
</task>
|
||||
|
||||
</tasks>
|
||||
|
||||
<verification>
|
||||
- `dotnet build SharepointToolbox.sln` succeeds with 0 errors
|
||||
- `dotnet test SharepointToolbox.Tests/SharepointToolbox.Tests.csproj` shows 0 failures
|
||||
- App.xaml contains no StartupUri attribute
|
||||
- SharepointToolbox.csproj contains `<PublishTrimmed>false</PublishTrimmed>`
|
||||
- SharepointToolbox.csproj contains `<StartupObject>SharepointToolbox.App</StartupObject>`
|
||||
- App.xaml.cs Main method is decorated with `[STAThread]`
|
||||
</verification>
|
||||
|
||||
<success_criteria>
|
||||
Solution compiles cleanly. Both projects in the solution. Test runner executes without failures. Generic Host wiring is correct (most critical risk for this plan — wrong STA threading causes runtime crash).
|
||||
</success_criteria>
|
||||
|
||||
<output>
|
||||
After completion, create `.planning/phases/01-foundation/01-01-SUMMARY.md`
|
||||
</output>
|
||||
161
.planning/milestones/v1.0-phases/01-foundation/01-01-SUMMARY.md
Normal file
161
.planning/milestones/v1.0-phases/01-foundation/01-01-SUMMARY.md
Normal file
@@ -0,0 +1,161 @@
|
||||
---
|
||||
phase: 01-foundation
|
||||
plan: 01
|
||||
subsystem: infra
|
||||
tags: [wpf, dotnet10, msal, pnp-framework, serilog, xunit, generic-host, csharp]
|
||||
|
||||
# Dependency graph
|
||||
requires: []
|
||||
provides:
|
||||
- WPF .NET 10 solution scaffold (SharepointToolbox.slnx)
|
||||
- Generic Host entry point with [STAThread] Main and Serilog rolling file sink
|
||||
- All NuGet packages pre-wired (CommunityToolkit.Mvvm, MSAL, PnP.Framework, Serilog)
|
||||
- xUnit test project with 7 stub test files (0 failed, 7 skipped)
|
||||
affects:
|
||||
- 01-02 (folder structure builds on this scaffold)
|
||||
- 01-03 (ProfileService/SettingsService tests stubbed here)
|
||||
- 01-04 (MsalClientFactory/SessionManager tests stubbed here)
|
||||
- 01-05 (TranslationSource/LoggingIntegration tests stubbed here)
|
||||
- 01-06 (FeatureViewModelBase tests stubbed here)
|
||||
|
||||
# Tech tracking
|
||||
tech-stack:
|
||||
added:
|
||||
- CommunityToolkit.Mvvm 8.4.2
|
||||
- Microsoft.Extensions.Hosting 10.0.0
|
||||
- Microsoft.Identity.Client 4.83.3
|
||||
- Microsoft.Identity.Client.Extensions.Msal 4.83.3
|
||||
- Microsoft.Identity.Client.Broker 4.82.1
|
||||
- PnP.Framework 1.18.0
|
||||
- Serilog 4.3.1
|
||||
- Serilog.Sinks.File 7.0.0
|
||||
- Serilog.Extensions.Hosting 10.0.0
|
||||
- Moq 4.20.72 (test project)
|
||||
- xunit 2.9.3 (test project)
|
||||
patterns:
|
||||
- Generic Host entry point via static [STAThread] Main (not Application.Run override)
|
||||
- App.xaml demoted from ApplicationDefinition to Page (enables custom Main)
|
||||
- PublishTrimmed=false enforced to support PnP.Framework + MSAL reflection usage
|
||||
- net10.0-windows + UseWPF=true in both main and test projects for compatibility
|
||||
|
||||
key-files:
|
||||
created:
|
||||
- SharepointToolbox.slnx
|
||||
- SharepointToolbox/SharepointToolbox.csproj
|
||||
- SharepointToolbox/App.xaml
|
||||
- SharepointToolbox/App.xaml.cs
|
||||
- SharepointToolbox/MainWindow.xaml
|
||||
- SharepointToolbox/MainWindow.xaml.cs
|
||||
- SharepointToolbox.Tests/SharepointToolbox.Tests.csproj
|
||||
- SharepointToolbox.Tests/Services/ProfileServiceTests.cs
|
||||
- SharepointToolbox.Tests/Services/SettingsServiceTests.cs
|
||||
- SharepointToolbox.Tests/Auth/MsalClientFactoryTests.cs
|
||||
- SharepointToolbox.Tests/Auth/SessionManagerTests.cs
|
||||
- SharepointToolbox.Tests/ViewModels/FeatureViewModelBaseTests.cs
|
||||
- SharepointToolbox.Tests/Localization/TranslationSourceTests.cs
|
||||
- SharepointToolbox.Tests/Integration/LoggingIntegrationTests.cs
|
||||
modified: []
|
||||
|
||||
key-decisions:
|
||||
- "Upgraded MSAL from 4.83.1 to 4.83.3 — Extensions.Msal 4.83.3 requires MSAL >= 4.83.3; minor patch bump with no behavioral difference"
|
||||
- "Test project targets net10.0-windows with UseWPF=true — required to reference main WPF project; plain net10.0 is framework-incompatible"
|
||||
- "Solution uses .slnx format (new .NET 10 XML solution format) — dotnet new sln creates .slnx in .NET 10 SDK, fully supported"
|
||||
|
||||
patterns-established:
|
||||
- "Generic Host + [STAThread] Main: App.xaml.cs owns static Main, App.xaml has no StartupUri, App.xaml is Page not ApplicationDefinition"
|
||||
- "Stub test pattern: [Fact(Skip = reason)] with plan reference — ensures test suite passes from day one while tracking future implementation"
|
||||
|
||||
requirements-completed:
|
||||
- FOUND-01
|
||||
|
||||
# Metrics
|
||||
duration: 4min
|
||||
completed: 2026-04-02
|
||||
---
|
||||
|
||||
# Phase 1 Plan 01: Solution Scaffold Summary
|
||||
|
||||
**WPF .NET 10 solution with Generic Host entry point, all NuGet packages (MSAL 4.83.3, PnP.Framework 1.18.0, Serilog 4.3.1), and xUnit test project with 7 stub tests (0 failures)**
|
||||
|
||||
## Performance
|
||||
|
||||
- **Duration:** 4 min
|
||||
- **Started:** 2026-04-02T09:58:26Z
|
||||
- **Completed:** 2026-04-02T10:02:35Z
|
||||
- **Tasks:** 2
|
||||
- **Files modified:** 14
|
||||
|
||||
## Accomplishments
|
||||
|
||||
- Solution scaffold compiles with 0 errors and 0 warnings on dotnet build
|
||||
- Generic Host entry point correctly wired with [STAThread] Main, App.xaml demoted from ApplicationDefinition to Page
|
||||
- All 9 NuGet packages added with compatible versions; PublishTrimmed=false enforced
|
||||
- xUnit test project references main project; dotnet test shows 7 skipped, 0 failed
|
||||
|
||||
## Task Commits
|
||||
|
||||
Each task was committed atomically:
|
||||
|
||||
1. **Task 1: Create solution and WPF project with all NuGet packages** - `f469804` (feat)
|
||||
2. **Task 2: Create xUnit test project with stub test files** - `eac34e3` (feat)
|
||||
|
||||
**Plan metadata:** (docs commit follows)
|
||||
|
||||
## Files Created/Modified
|
||||
|
||||
- `SharepointToolbox.slnx` - Solution file with both projects
|
||||
- `SharepointToolbox/SharepointToolbox.csproj` - WPF .NET 10 with all packages, PublishTrimmed=false, StartupObject
|
||||
- `SharepointToolbox/App.xaml` - StartupUri removed, App.xaml as Page not ApplicationDefinition
|
||||
- `SharepointToolbox/App.xaml.cs` - [STAThread] Main with Host.CreateDefaultBuilder + Serilog rolling file sink
|
||||
- `SharepointToolbox/MainWindow.xaml` + `MainWindow.xaml.cs` - Default WPF template (replaced in plan 01-06)
|
||||
- `SharepointToolbox.Tests/SharepointToolbox.Tests.csproj` - xUnit + Moq, net10.0-windows, references main project
|
||||
- 7 stub test files across Services/, Auth/, ViewModels/, Localization/, Integration/
|
||||
|
||||
## Decisions Made
|
||||
|
||||
- Upgraded MSAL from 4.83.1 to 4.83.3 — Extensions.Msal 4.83.3 pulls MSAL >= 4.83.3 as a transitive dependency; pinning 4.83.1 caused NU1605 downgrade error. Minor patch bump, no behavioral change.
|
||||
- Test project targets net10.0-windows with UseWPF=true — framework incompatibility prevented `dotnet add reference` with net10.0; WPF test host is required anyway for any UI-layer testing.
|
||||
- Solution file is .slnx (new .NET 10 XML format) — dotnet new sln in .NET 10 SDK creates .slnx by default; fully functional with dotnet build/test.
|
||||
|
||||
## Deviations from Plan
|
||||
|
||||
### Auto-fixed Issues
|
||||
|
||||
**1. [Rule 1 - Bug] MSAL version bumped from 4.83.1 to 4.83.3**
|
||||
- **Found during:** Task 1 (NuGet package installation)
|
||||
- **Issue:** `Microsoft.Identity.Client.Extensions.Msal 4.83.3` requires `Microsoft.Identity.Client >= 4.83.3`; plan specified 4.83.1 causing NU1605 downgrade error and failed restore
|
||||
- **Fix:** Updated MSAL pin to 4.83.3 to satisfy transitive dependency constraint
|
||||
- **Files modified:** SharepointToolbox/SharepointToolbox.csproj
|
||||
- **Verification:** `dotnet restore` succeeded; build 0 errors
|
||||
- **Committed in:** f469804 (Task 1 commit)
|
||||
|
||||
**2. [Rule 3 - Blocking] Test project changed to net10.0-windows + UseWPF=true**
|
||||
- **Found during:** Task 2 (adding project reference to test project)
|
||||
- **Issue:** `dotnet add reference` rejected with "incompatible targeted frameworks" — net10.0 test cannot reference net10.0-windows WPF project
|
||||
- **Fix:** Updated test project TargetFramework to net10.0-windows and added UseWPF=true
|
||||
- **Files modified:** SharepointToolbox.Tests/SharepointToolbox.Tests.csproj
|
||||
- **Verification:** `dotnet test` succeeded; 7 skipped, 0 failed
|
||||
- **Committed in:** eac34e3 (Task 2 commit)
|
||||
|
||||
---
|
||||
|
||||
**Total deviations:** 2 auto-fixed (1 bug — version conflict, 1 blocking — framework incompatibility)
|
||||
**Impact on plan:** Both fixes required for the build to succeed. No scope creep. MSAL functionality identical at 4.83.3.
|
||||
|
||||
## Issues Encountered
|
||||
|
||||
- dotnet new wpf rejects `-f net10.0-windows` as framework flag (only accepts short TFM like `net10.0`) but the generated csproj correctly sets `net10.0-windows`. Template limitation, not a runtime issue.
|
||||
|
||||
## User Setup Required
|
||||
|
||||
None - no external service configuration required.
|
||||
|
||||
## Next Phase Readiness
|
||||
|
||||
- Solution scaffold ready for plan 01-02 (folder structure and namespace layout)
|
||||
- All packages pre-installed — subsequent plans add code, not packages
|
||||
- Test infrastructure wired — stub files will be implemented in their respective plans (01-03 through 01-06)
|
||||
|
||||
---
|
||||
*Phase: 01-foundation*
|
||||
*Completed: 2026-04-02*
|
||||
341
.planning/milestones/v1.0-phases/01-foundation/01-02-PLAN.md
Normal file
341
.planning/milestones/v1.0-phases/01-foundation/01-02-PLAN.md
Normal file
@@ -0,0 +1,341 @@
|
||||
---
|
||||
phase: 01-foundation
|
||||
plan: 02
|
||||
type: execute
|
||||
wave: 2
|
||||
depends_on:
|
||||
- 01-01
|
||||
files_modified:
|
||||
- SharepointToolbox/Core/Models/TenantProfile.cs
|
||||
- SharepointToolbox/Core/Models/OperationProgress.cs
|
||||
- SharepointToolbox/Core/Messages/TenantSwitchedMessage.cs
|
||||
- SharepointToolbox/Core/Messages/LanguageChangedMessage.cs
|
||||
- SharepointToolbox/Core/Helpers/SharePointPaginationHelper.cs
|
||||
- SharepointToolbox/Core/Helpers/ExecuteQueryRetryHelper.cs
|
||||
- SharepointToolbox/Infrastructure/Logging/LogPanelSink.cs
|
||||
autonomous: true
|
||||
requirements:
|
||||
- FOUND-05
|
||||
- FOUND-06
|
||||
- FOUND-07
|
||||
- FOUND-08
|
||||
must_haves:
|
||||
truths:
|
||||
- "OperationProgress record is usable by all feature services for IProgress<T> reporting"
|
||||
- "TenantSwitchedMessage and LanguageChangedMessage are broadcast-ready via WeakReferenceMessenger"
|
||||
- "SharePointPaginationHelper iterates past 5,000 items using ListItemCollectionPosition"
|
||||
- "ExecuteQueryRetryHelper surfaces retry events as IProgress messages"
|
||||
- "LogPanelSink writes to a RichTextBox-targeted dispatcher-safe callback"
|
||||
artifacts:
|
||||
- path: "SharepointToolbox/Core/Models/OperationProgress.cs"
|
||||
provides: "Shared progress record used by all feature services"
|
||||
contains: "record OperationProgress"
|
||||
- path: "SharepointToolbox/Core/Models/TenantProfile.cs"
|
||||
provides: "Profile model matching JSON schema"
|
||||
contains: "TenantUrl"
|
||||
- path: "SharepointToolbox/Core/Helpers/SharePointPaginationHelper.cs"
|
||||
provides: "CSOM list pagination wrapping CamlQuery + ListItemCollectionPosition"
|
||||
contains: "ListItemCollectionPosition"
|
||||
- path: "SharepointToolbox/Core/Helpers/ExecuteQueryRetryHelper.cs"
|
||||
provides: "Retry wrapper for CSOM calls with throttle detection"
|
||||
contains: "ExecuteQueryRetryAsync"
|
||||
- path: "SharepointToolbox/Infrastructure/Logging/LogPanelSink.cs"
|
||||
provides: "Custom Serilog sink that writes to UI log panel"
|
||||
contains: "ILogEventSink"
|
||||
key_links:
|
||||
- from: "SharepointToolbox/Core/Helpers/SharePointPaginationHelper.cs"
|
||||
to: "Microsoft.SharePoint.Client.ListItemCollectionPosition"
|
||||
via: "PnP.Framework CSOM"
|
||||
pattern: "ListItemCollectionPosition"
|
||||
- from: "SharepointToolbox/Infrastructure/Logging/LogPanelSink.cs"
|
||||
to: "Application.Current.Dispatcher"
|
||||
via: "InvokeAsync for thread safety"
|
||||
pattern: "Dispatcher.InvokeAsync"
|
||||
---
|
||||
|
||||
<objective>
|
||||
Build the Core layer — models, messages, and infrastructure helpers — that every subsequent plan depends on. These are the contracts: no business logic, just types and patterns.
|
||||
|
||||
Purpose: All feature phases import OperationProgress, TenantProfile, the pagination helper, and the retry helper. Getting these right here means no rework in Phases 2-4.
|
||||
Output: Core/Models, Core/Messages, Core/Helpers, Infrastructure/Logging directories with 7 files.
|
||||
</objective>
|
||||
|
||||
<execution_context>
|
||||
@C:/Users/SebastienQUEROL/.claude/get-shit-done/workflows/execute-plan.md
|
||||
@C:/Users/SebastienQUEROL/.claude/get-shit-done/templates/summary.md
|
||||
</execution_context>
|
||||
|
||||
<context>
|
||||
@.planning/PROJECT.md
|
||||
@.planning/ROADMAP.md
|
||||
@.planning/phases/01-foundation/01-CONTEXT.md
|
||||
@.planning/phases/01-foundation/01-RESEARCH.md
|
||||
@.planning/phases/01-foundation/01-01-SUMMARY.md
|
||||
</context>
|
||||
|
||||
<tasks>
|
||||
|
||||
<task type="auto">
|
||||
<name>Task 1: Core models and WeakReferenceMessenger messages</name>
|
||||
<files>
|
||||
SharepointToolbox/Core/Models/TenantProfile.cs,
|
||||
SharepointToolbox/Core/Models/OperationProgress.cs,
|
||||
SharepointToolbox/Core/Messages/TenantSwitchedMessage.cs,
|
||||
SharepointToolbox/Core/Messages/LanguageChangedMessage.cs
|
||||
</files>
|
||||
<action>
|
||||
Create directories: `Core/Models/`, `Core/Messages/`
|
||||
|
||||
**TenantProfile.cs**
|
||||
```csharp
|
||||
namespace SharepointToolbox.Core.Models;
|
||||
|
||||
public class TenantProfile
|
||||
{
|
||||
public string Name { get; set; } = string.Empty;
|
||||
public string TenantUrl { get; set; } = string.Empty;
|
||||
public string ClientId { get; set; } = string.Empty;
|
||||
}
|
||||
```
|
||||
Note: Plain class (not record) — mutable for JSON deserialization with System.Text.Json. Field names `Name`, `TenantUrl`, `ClientId` must match existing JSON schema exactly (case-insensitive by default in STJ but preserve casing for compatibility).
|
||||
|
||||
**OperationProgress.cs**
|
||||
```csharp
|
||||
namespace SharepointToolbox.Core.Models;
|
||||
|
||||
public record OperationProgress(int Current, int Total, string Message)
|
||||
{
|
||||
public static OperationProgress Indeterminate(string message) =>
|
||||
new(0, 0, message);
|
||||
}
|
||||
```
|
||||
|
||||
**TenantSwitchedMessage.cs**
|
||||
```csharp
|
||||
using CommunityToolkit.Mvvm.Messaging.Messages;
|
||||
using SharepointToolbox.Core.Models;
|
||||
|
||||
namespace SharepointToolbox.Core.Messages;
|
||||
|
||||
public sealed class TenantSwitchedMessage : ValueChangedMessage<TenantProfile>
|
||||
{
|
||||
public TenantSwitchedMessage(TenantProfile profile) : base(profile) { }
|
||||
}
|
||||
```
|
||||
|
||||
**LanguageChangedMessage.cs**
|
||||
```csharp
|
||||
using CommunityToolkit.Mvvm.Messaging.Messages;
|
||||
|
||||
namespace SharepointToolbox.Core.Messages;
|
||||
|
||||
public sealed class LanguageChangedMessage : ValueChangedMessage<string>
|
||||
{
|
||||
public LanguageChangedMessage(string cultureCode) : base(cultureCode) { }
|
||||
}
|
||||
```
|
||||
|
||||
Run `dotnet build SharepointToolbox/SharepointToolbox.csproj` to verify no errors.
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd "C:\Users\dev\Documents\projets\Sharepoint" && dotnet build SharepointToolbox/SharepointToolbox.csproj 2>&1 | tail -5</automated>
|
||||
</verify>
|
||||
<done>Build succeeds. Four files created. TenantProfile fields match JSON schema. OperationProgress is a record with Indeterminate factory.</done>
|
||||
</task>
|
||||
|
||||
<task type="auto">
|
||||
<name>Task 2: SharePointPaginationHelper, ExecuteQueryRetryHelper, LogPanelSink</name>
|
||||
<files>
|
||||
SharepointToolbox/Core/Helpers/SharePointPaginationHelper.cs,
|
||||
SharepointToolbox/Core/Helpers/ExecuteQueryRetryHelper.cs,
|
||||
SharepointToolbox/Infrastructure/Logging/LogPanelSink.cs
|
||||
</files>
|
||||
<action>
|
||||
Create directories: `Core/Helpers/`, `Infrastructure/Logging/`
|
||||
|
||||
**SharePointPaginationHelper.cs**
|
||||
```csharp
|
||||
using Microsoft.SharePoint.Client;
|
||||
using SharepointToolbox.Core.Models;
|
||||
|
||||
namespace SharepointToolbox.Core.Helpers;
|
||||
|
||||
public static class SharePointPaginationHelper
|
||||
{
|
||||
/// <summary>
|
||||
/// Enumerates all items in a SharePoint list, bypassing the 5,000-item threshold.
|
||||
/// Uses CamlQuery with RowLimit=2000 and ListItemCollectionPosition for pagination.
|
||||
/// Never call ExecuteQuery directly on a list — always use this helper.
|
||||
/// </summary>
|
||||
public static async IAsyncEnumerable<ListItem> GetAllItemsAsync(
|
||||
ClientContext ctx,
|
||||
List list,
|
||||
CamlQuery? baseQuery = null,
|
||||
CancellationToken ct = default)
|
||||
{
|
||||
var query = baseQuery ?? CamlQuery.CreateAllItemsQuery();
|
||||
query.ViewXml = BuildPagedViewXml(query.ViewXml, rowLimit: 2000);
|
||||
query.ListItemCollectionPosition = null;
|
||||
|
||||
do
|
||||
{
|
||||
ct.ThrowIfCancellationRequested();
|
||||
var items = list.GetItems(query);
|
||||
ctx.Load(items);
|
||||
await ctx.ExecuteQueryAsync();
|
||||
|
||||
foreach (var item in items)
|
||||
yield return item;
|
||||
|
||||
query.ListItemCollectionPosition = items.ListItemCollectionPosition;
|
||||
}
|
||||
while (query.ListItemCollectionPosition != null);
|
||||
}
|
||||
|
||||
private static string BuildPagedViewXml(string? existingXml, int rowLimit)
|
||||
{
|
||||
// Inject or replace RowLimit in existing CAML, or create minimal view
|
||||
if (string.IsNullOrWhiteSpace(existingXml))
|
||||
return $"<View><RowLimit>{rowLimit}</RowLimit></View>";
|
||||
|
||||
// Simple replacement approach — adequate for Phase 1
|
||||
if (existingXml.Contains("<RowLimit>", StringComparison.OrdinalIgnoreCase))
|
||||
{
|
||||
return System.Text.RegularExpressions.Regex.Replace(
|
||||
existingXml, @"<RowLimit[^>]*>\d+</RowLimit>",
|
||||
$"<RowLimit>{rowLimit}</RowLimit>",
|
||||
System.Text.RegularExpressions.RegexOptions.IgnoreCase);
|
||||
}
|
||||
return existingXml.Replace("</View>", $"<RowLimit>{rowLimit}</RowLimit></View>",
|
||||
StringComparison.OrdinalIgnoreCase);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**ExecuteQueryRetryHelper.cs**
|
||||
```csharp
|
||||
using Microsoft.SharePoint.Client;
|
||||
using SharepointToolbox.Core.Models;
|
||||
|
||||
namespace SharepointToolbox.Core.Helpers;
|
||||
|
||||
public static class ExecuteQueryRetryHelper
|
||||
{
|
||||
private const int MaxRetries = 5;
|
||||
|
||||
/// <summary>
|
||||
/// Executes a SharePoint query with automatic retry on throttle (429/503).
|
||||
/// Surfaces retry events via progress for user visibility ("Throttled — retrying in 30s…").
|
||||
/// </summary>
|
||||
public static async Task ExecuteQueryRetryAsync(
|
||||
ClientContext ctx,
|
||||
IProgress<OperationProgress>? progress = null,
|
||||
CancellationToken ct = default)
|
||||
{
|
||||
int attempt = 0;
|
||||
while (true)
|
||||
{
|
||||
ct.ThrowIfCancellationRequested();
|
||||
try
|
||||
{
|
||||
await ctx.ExecuteQueryAsync();
|
||||
return;
|
||||
}
|
||||
catch (Exception ex) when (IsThrottleException(ex) && attempt < MaxRetries)
|
||||
{
|
||||
attempt++;
|
||||
int delaySeconds = (int)Math.Pow(2, attempt) * 5; // 10, 20, 40, 80, 160s
|
||||
progress?.Report(OperationProgress.Indeterminate(
|
||||
$"Throttled by SharePoint — retrying in {delaySeconds}s (attempt {attempt}/{MaxRetries})…"));
|
||||
await Task.Delay(TimeSpan.FromSeconds(delaySeconds), ct);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private static bool IsThrottleException(Exception ex)
|
||||
{
|
||||
var msg = ex.Message;
|
||||
return msg.Contains("429") || msg.Contains("503") ||
|
||||
msg.Contains("throttl", StringComparison.OrdinalIgnoreCase);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**LogPanelSink.cs**
|
||||
```csharp
|
||||
using Serilog.Core;
|
||||
using Serilog.Events;
|
||||
using System.Windows;
|
||||
using System.Windows.Documents;
|
||||
using System.Windows.Media;
|
||||
using System.Windows.Controls;
|
||||
|
||||
namespace SharepointToolbox.Infrastructure.Logging;
|
||||
|
||||
/// <summary>
|
||||
/// Custom Serilog sink that writes timestamped, color-coded entries to a WPF RichTextBox.
|
||||
/// Format: HH:mm:ss [LEVEL] Message — green=info/success, orange=warning, red=error.
|
||||
/// All writes dispatch to the UI thread via Application.Current.Dispatcher.
|
||||
/// </summary>
|
||||
public class LogPanelSink : ILogEventSink
|
||||
{
|
||||
private readonly RichTextBox _richTextBox;
|
||||
|
||||
public LogPanelSink(RichTextBox richTextBox)
|
||||
{
|
||||
_richTextBox = richTextBox;
|
||||
}
|
||||
|
||||
public void Emit(LogEvent logEvent)
|
||||
{
|
||||
var message = logEvent.RenderMessage();
|
||||
var timestamp = logEvent.Timestamp.ToString("HH:mm:ss");
|
||||
var level = logEvent.Level.ToString().ToUpperInvariant()[..4]; // INFO, WARN, ERRO, FATL
|
||||
var text = $"{timestamp} [{level}] {message}";
|
||||
var color = GetColor(logEvent.Level);
|
||||
|
||||
Application.Current?.Dispatcher.InvokeAsync(() =>
|
||||
{
|
||||
var para = new Paragraph(new Run(text) { Foreground = new SolidColorBrush(color) })
|
||||
{
|
||||
Margin = new Thickness(0)
|
||||
};
|
||||
_richTextBox.Document.Blocks.Add(para);
|
||||
_richTextBox.ScrollToEnd();
|
||||
});
|
||||
}
|
||||
|
||||
private static Color GetColor(LogEventLevel level) => level switch
|
||||
{
|
||||
LogEventLevel.Warning => Colors.Orange,
|
||||
LogEventLevel.Error or LogEventLevel.Fatal => Colors.Red,
|
||||
_ => Colors.LimeGreen
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
Run `dotnet build SharepointToolbox/SharepointToolbox.csproj` to verify no errors.
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd "C:\Users\dev\Documents\projets\Sharepoint" && dotnet build SharepointToolbox/SharepointToolbox.csproj 2>&1 | tail -5</automated>
|
||||
</verify>
|
||||
<done>Build succeeds. SharePointPaginationHelper uses ListItemCollectionPosition. ExecuteQueryRetryHelper detects throttle exceptions. LogPanelSink dispatches to UI thread via Dispatcher.InvokeAsync.</done>
|
||||
</task>
|
||||
|
||||
</tasks>
|
||||
|
||||
<verification>
|
||||
- `dotnet build SharepointToolbox.sln` passes with 0 errors
|
||||
- `SharepointToolbox/Core/Models/TenantProfile.cs` contains `TenantUrl` (not `TenantURL` or `Url`) to match JSON schema
|
||||
- `SharePointPaginationHelper.cs` contains `ListItemCollectionPosition` and loop condition checking for null
|
||||
- `ExecuteQueryRetryHelper.cs` contains exponential backoff and progress reporting
|
||||
- `LogPanelSink.cs` contains `Dispatcher.InvokeAsync`
|
||||
</verification>
|
||||
|
||||
<success_criteria>
|
||||
All 7 Core/Infrastructure files created and compiling. Models match JSON schema field names. Pagination helper correctly loops until ListItemCollectionPosition is null.
|
||||
</success_criteria>
|
||||
|
||||
<output>
|
||||
After completion, create `.planning/phases/01-foundation/01-02-SUMMARY.md`
|
||||
</output>
|
||||
143
.planning/milestones/v1.0-phases/01-foundation/01-02-SUMMARY.md
Normal file
143
.planning/milestones/v1.0-phases/01-foundation/01-02-SUMMARY.md
Normal file
@@ -0,0 +1,143 @@
|
||||
---
|
||||
phase: 01-foundation
|
||||
plan: 02
|
||||
subsystem: core
|
||||
tags: [wpf, dotnet10, csom, pnp-framework, serilog, sharepoint, pagination, retry, messaging, csharp]
|
||||
|
||||
# Dependency graph
|
||||
requires:
|
||||
- 01-01 (solution scaffold, NuGet packages)
|
||||
provides:
|
||||
- TenantProfile model matching JSON schema (Name/TenantUrl/ClientId)
|
||||
- OperationProgress record with Indeterminate factory for IProgress<T> pattern
|
||||
- TenantSwitchedMessage and LanguageChangedMessage broadcast-ready via WeakReferenceMessenger
|
||||
- SharePointPaginationHelper: async iterator bypassing 5k item limit via ListItemCollectionPosition
|
||||
- ExecuteQueryRetryHelper: exponential backoff on 429/503 with IProgress<OperationProgress> surfacing
|
||||
- LogPanelSink: custom Serilog ILogEventSink writing to RichTextBox via Dispatcher.InvokeAsync
|
||||
affects:
|
||||
- 01-03 (ProfileService uses TenantProfile)
|
||||
- 01-04 (MsalClientFactory uses TenantProfile.ClientId/TenantUrl)
|
||||
- 01-05 (TranslationSource sends LanguageChangedMessage; LoggingIntegration uses LogPanelSink)
|
||||
- 01-06 (FeatureViewModelBase uses OperationProgress + IProgress<T> pattern)
|
||||
- 02-xx (all SharePoint feature services use pagination and retry helpers)
|
||||
|
||||
# Tech tracking
|
||||
tech-stack:
|
||||
added: []
|
||||
patterns:
|
||||
- IAsyncEnumerable<ListItem> with [EnumeratorCancellation] for correct WithCancellation support
|
||||
- ListItemCollectionPosition loop (do/while until null) for CSOM pagination past 5k items
|
||||
- Exponential backoff: delay = 2^attempt * 5s (10, 20, 40, 80, 160s) up to MaxRetries=5
|
||||
- WeakReferenceMessenger messages via ValueChangedMessage<T> base class
|
||||
- Dispatcher.InvokeAsync for thread-safe UI writes from Serilog background thread
|
||||
|
||||
key-files:
|
||||
created:
|
||||
- SharepointToolbox/Core/Models/TenantProfile.cs
|
||||
- SharepointToolbox/Core/Models/OperationProgress.cs
|
||||
- SharepointToolbox/Core/Messages/TenantSwitchedMessage.cs
|
||||
- SharepointToolbox/Core/Messages/LanguageChangedMessage.cs
|
||||
- SharepointToolbox/Core/Helpers/SharePointPaginationHelper.cs
|
||||
- SharepointToolbox/Core/Helpers/ExecuteQueryRetryHelper.cs
|
||||
- SharepointToolbox/Infrastructure/Logging/LogPanelSink.cs
|
||||
modified: []
|
||||
|
||||
key-decisions:
|
||||
- "TenantProfile is a plain class (not record) — mutable for System.Text.Json deserialization; fields Name/TenantUrl/ClientId match existing JSON schema casing"
|
||||
- "SharePointPaginationHelper uses [EnumeratorCancellation] on ct parameter — required for correct cancellation forwarding when callers use WithCancellation(ct)"
|
||||
- "ExecuteQueryRetryHelper uses catch-when filter with IsThrottleException — matches 429/503 status codes and 'throttl' text in message, covers PnP.Framework exception surfaces"
|
||||
|
||||
requirements-completed:
|
||||
- FOUND-05
|
||||
- FOUND-06
|
||||
- FOUND-07
|
||||
- FOUND-08
|
||||
|
||||
# Metrics
|
||||
duration: 1min
|
||||
completed: 2026-04-02
|
||||
---
|
||||
|
||||
# Phase 1 Plan 02: Core Models, Messages, and Infrastructure Helpers Summary
|
||||
|
||||
**7 Core/Infrastructure files providing typed contracts (TenantProfile, OperationProgress, messages, CSOM pagination helper, throttle-aware retry helper, RichTextBox Serilog sink) — 0 errors, 0 warnings**
|
||||
|
||||
## Performance
|
||||
|
||||
- **Duration:** 1 min
|
||||
- **Started:** 2026-04-02T10:04:59Z
|
||||
- **Completed:** 2026-04-02T10:06:00Z
|
||||
- **Tasks:** 2
|
||||
- **Files modified:** 7
|
||||
|
||||
## Accomplishments
|
||||
|
||||
- All 7 Core/Infrastructure files created and compiling with 0 errors, 0 warnings
|
||||
- TenantProfile fields match JSON schema exactly (Name/TenantUrl/ClientId)
|
||||
- OperationProgress record with Indeterminate factory, usable by all feature services via IProgress<T>
|
||||
- TenantSwitchedMessage and LanguageChangedMessage correctly inherit ValueChangedMessage<T> for WeakReferenceMessenger broadcast
|
||||
- SharePointPaginationHelper iterates past 5,000 items using ListItemCollectionPosition do/while loop; RowLimit=2000
|
||||
- ExecuteQueryRetryHelper surfaces retry events via IProgress<OperationProgress> with exponential backoff (10s, 20s, 40s, 80s, 160s)
|
||||
- LogPanelSink writes color-coded, timestamped entries to RichTextBox via Dispatcher.InvokeAsync for thread safety
|
||||
|
||||
## Task Commits
|
||||
|
||||
Each task was committed atomically:
|
||||
|
||||
1. **Task 1: Core models and WeakReferenceMessenger messages** - `ddb216b` (feat)
|
||||
2. **Task 2: SharePointPaginationHelper, ExecuteQueryRetryHelper, LogPanelSink** - `c297801` (feat)
|
||||
|
||||
**Plan metadata:** (docs commit follows)
|
||||
|
||||
## Files Created/Modified
|
||||
|
||||
- `SharepointToolbox/Core/Models/TenantProfile.cs` - Plain class; Name/TenantUrl/ClientId match JSON schema
|
||||
- `SharepointToolbox/Core/Models/OperationProgress.cs` - Record with Indeterminate factory; IProgress<T> contract
|
||||
- `SharepointToolbox/Core/Messages/TenantSwitchedMessage.cs` - ValueChangedMessage<TenantProfile>; WeakReferenceMessenger broadcast
|
||||
- `SharepointToolbox/Core/Messages/LanguageChangedMessage.cs` - ValueChangedMessage<string>; WeakReferenceMessenger broadcast
|
||||
- `SharepointToolbox/Core/Helpers/SharePointPaginationHelper.cs` - Async iterator; ListItemCollectionPosition loop; [EnumeratorCancellation]
|
||||
- `SharepointToolbox/Core/Helpers/ExecuteQueryRetryHelper.cs` - Retry on 429/503/throttle; exponential backoff; IProgress surfacing
|
||||
- `SharepointToolbox/Infrastructure/Logging/LogPanelSink.cs` - ILogEventSink; Dispatcher.InvokeAsync; color-coded by level
|
||||
|
||||
## Decisions Made
|
||||
|
||||
- TenantProfile is a plain mutable class (not a record) — System.Text.Json deserialization requires a parameterless constructor and settable properties; field names match the existing JSON schema exactly to avoid serialization mismatches.
|
||||
- SharePointPaginationHelper.GetAllItemsAsync decorates `ct` with `[EnumeratorCancellation]` — without this attribute, cancellation tokens passed via `WithCancellation()` on the async enumerable are silently ignored. This is a correctness requirement for callers who use the cancellation pattern.
|
||||
- ExecuteQueryRetryHelper.IsThrottleException checks for "429", "503", and "throttl" (case-insensitive) — PnP.Framework surfaces HTTP errors in the exception message rather than a dedicated exception type; this covers all known throttle surfaces.
|
||||
|
||||
## Deviations from Plan
|
||||
|
||||
### Auto-fixed Issues
|
||||
|
||||
**1. [Rule 2 - Missing critical functionality] Added [EnumeratorCancellation] attribute to SharePointPaginationHelper**
|
||||
- **Found during:** Task 2 (dotnet build)
|
||||
- **Issue:** CS8425 warning — async iterator with `CancellationToken ct` parameter missing `[EnumeratorCancellation]`; without it, cancellation via `WithCancellation(ct)` on the `IAsyncEnumerable<T>` is silently dropped, breaking cancellation for all callers
|
||||
- **Fix:** Added `using System.Runtime.CompilerServices;` and `[EnumeratorCancellation]` attribute on the `ct` parameter
|
||||
- **Files modified:** `SharepointToolbox/Core/Helpers/SharePointPaginationHelper.cs`
|
||||
- **Verification:** Build 0 warnings, 0 errors after fix
|
||||
- **Committed in:** c297801 (Task 2 commit)
|
||||
|
||||
---
|
||||
|
||||
**Total deviations:** 1 auto-fixed (Rule 2 — missing critical functionality for correct cancellation behavior)
|
||||
**Impact on plan:** Fix required for correct operation. One line change, no scope creep.
|
||||
|
||||
## Issues Encountered
|
||||
|
||||
None beyond the auto-fixed deviation above.
|
||||
|
||||
## User Setup Required
|
||||
|
||||
None - no external service configuration required.
|
||||
|
||||
## Next Phase Readiness
|
||||
|
||||
- All contracts in place for plan 01-03 (ProfileService uses TenantProfile)
|
||||
- All contracts in place for plan 01-04 (MsalClientFactory uses TenantProfile.ClientId/TenantUrl)
|
||||
- All contracts in place for plan 01-05 (LoggingIntegration uses LogPanelSink; LanguageChangedMessage for TranslationSource)
|
||||
- All contracts in place for plan 01-06 (FeatureViewModelBase uses OperationProgress + IProgress<T>)
|
||||
- All Phase 2+ SharePoint feature services can use pagination and retry helpers immediately
|
||||
|
||||
---
|
||||
*Phase: 01-foundation*
|
||||
*Completed: 2026-04-02*
|
||||
254
.planning/milestones/v1.0-phases/01-foundation/01-03-PLAN.md
Normal file
254
.planning/milestones/v1.0-phases/01-foundation/01-03-PLAN.md
Normal file
@@ -0,0 +1,254 @@
|
||||
---
|
||||
phase: 01-foundation
|
||||
plan: 03
|
||||
type: execute
|
||||
wave: 3
|
||||
depends_on:
|
||||
- 01-01
|
||||
- 01-02
|
||||
files_modified:
|
||||
- SharepointToolbox/Infrastructure/Persistence/ProfileRepository.cs
|
||||
- SharepointToolbox/Infrastructure/Persistence/SettingsRepository.cs
|
||||
- SharepointToolbox/Services/ProfileService.cs
|
||||
- SharepointToolbox/Services/SettingsService.cs
|
||||
- SharepointToolbox.Tests/Services/ProfileServiceTests.cs
|
||||
- SharepointToolbox.Tests/Services/SettingsServiceTests.cs
|
||||
autonomous: true
|
||||
requirements:
|
||||
- FOUND-02
|
||||
- FOUND-10
|
||||
- FOUND-12
|
||||
must_haves:
|
||||
truths:
|
||||
- "ProfileService reads Sharepoint_Export_profiles.json without migration — field names are the contract"
|
||||
- "SettingsService reads Sharepoint_Settings.json preserving dataFolder and lang fields"
|
||||
- "Write operations use write-then-replace (file.tmp → validate → File.Move) with SemaphoreSlim(1)"
|
||||
- "ProfileService unit tests: SaveAndLoad round-trips, corrupt file recovery, concurrent write safety"
|
||||
- "SettingsService unit tests: SaveAndLoad round-trips, default settings when file missing"
|
||||
artifacts:
|
||||
- path: "SharepointToolbox/Infrastructure/Persistence/ProfileRepository.cs"
|
||||
provides: "File I/O for profiles JSON with write-then-replace"
|
||||
contains: "SemaphoreSlim"
|
||||
- path: "SharepointToolbox/Services/ProfileService.cs"
|
||||
provides: "CRUD operations on TenantProfile collection"
|
||||
exports: ["AddProfile", "RenameProfile", "DeleteProfile", "GetProfiles"]
|
||||
- path: "SharepointToolbox/Services/SettingsService.cs"
|
||||
provides: "Read/write for app settings including data folder and language"
|
||||
exports: ["GetSettings", "SaveSettings"]
|
||||
- path: "SharepointToolbox.Tests/Services/ProfileServiceTests.cs"
|
||||
provides: "Unit tests covering FOUND-02 and FOUND-10"
|
||||
key_links:
|
||||
- from: "SharepointToolbox/Infrastructure/Persistence/ProfileRepository.cs"
|
||||
to: "Sharepoint_Export_profiles.json"
|
||||
via: "System.Text.Json deserialization of { profiles: [...] } wrapper"
|
||||
pattern: "profiles"
|
||||
- from: "SharepointToolbox/Infrastructure/Persistence/SettingsRepository.cs"
|
||||
to: "Sharepoint_Settings.json"
|
||||
via: "System.Text.Json deserialization of { dataFolder, lang }"
|
||||
pattern: "dataFolder"
|
||||
---
|
||||
|
||||
<objective>
|
||||
Build the persistence layer: ProfileRepository and SettingsRepository (Infrastructure) plus ProfileService and SettingsService (Services layer). Implement write-then-replace safety. Write unit tests that validate the round-trip and edge cases.
|
||||
|
||||
Purpose: Profiles and settings are the first user-visible data. Corrupt files or wrong field names would break existing users' data on migration. Unit tests lock in the JSON schema contract.
|
||||
Output: 4 production files + 2 test files with passing unit tests.
|
||||
</objective>
|
||||
|
||||
<execution_context>
|
||||
@C:/Users/SebastienQUEROL/.claude/get-shit-done/workflows/execute-plan.md
|
||||
@C:/Users/SebastienQUEROL/.claude/get-shit-done/templates/summary.md
|
||||
</execution_context>
|
||||
|
||||
<context>
|
||||
@.planning/PROJECT.md
|
||||
@.planning/phases/01-foundation/01-CONTEXT.md
|
||||
@.planning/phases/01-foundation/01-RESEARCH.md
|
||||
@.planning/phases/01-foundation/01-02-SUMMARY.md
|
||||
|
||||
<interfaces>
|
||||
<!-- From Core/Models/TenantProfile.cs (plan 01-02) -->
|
||||
```csharp
|
||||
namespace SharepointToolbox.Core.Models;
|
||||
public class TenantProfile
|
||||
{
|
||||
public string Name { get; set; } = string.Empty;
|
||||
public string TenantUrl { get; set; } = string.Empty;
|
||||
public string ClientId { get; set; } = string.Empty;
|
||||
}
|
||||
```
|
||||
|
||||
<!-- JSON schema contracts (live user data — field names are frozen) -->
|
||||
// Sharepoint_Export_profiles.json
|
||||
{ "profiles": [{ "name": "...", "tenantUrl": "...", "clientId": "..." }] }
|
||||
|
||||
// Sharepoint_Settings.json
|
||||
{ "dataFolder": "...", "lang": "en" }
|
||||
</interfaces>
|
||||
</context>
|
||||
|
||||
<tasks>
|
||||
|
||||
<task type="auto" tdd="true">
|
||||
<name>Task 1: ProfileRepository and ProfileService with write-then-replace</name>
|
||||
<files>
|
||||
SharepointToolbox/Infrastructure/Persistence/ProfileRepository.cs,
|
||||
SharepointToolbox/Services/ProfileService.cs,
|
||||
SharepointToolbox.Tests/Services/ProfileServiceTests.cs
|
||||
</files>
|
||||
<behavior>
|
||||
- Test: SaveAsync then LoadAsync round-trips a list of TenantProfiles with correct field values
|
||||
- Test: LoadAsync on missing file returns empty list (no exception)
|
||||
- Test: LoadAsync on corrupt JSON throws InvalidDataException (not silently returns empty)
|
||||
- Test: Concurrent SaveAsync calls don't corrupt the file (SemaphoreSlim ensures ordering)
|
||||
- Test: ProfileService.AddProfile assigns the new profile and persists immediately
|
||||
- Test: ProfileService.RenameProfile changes Name, persists, throws if profile not found
|
||||
- Test: ProfileService.DeleteProfile removes by Name, throws if not found
|
||||
- Test: Saved JSON wraps profiles in { "profiles": [...] } root object (schema compatibility)
|
||||
</behavior>
|
||||
<action>
|
||||
Create `Infrastructure/Persistence/` and `Services/` directories.
|
||||
|
||||
**ProfileRepository.cs** — handles raw file I/O:
|
||||
```csharp
|
||||
namespace SharepointToolbox.Infrastructure.Persistence;
|
||||
|
||||
public class ProfileRepository
|
||||
{
|
||||
private readonly string _filePath;
|
||||
private readonly SemaphoreSlim _writeLock = new(1, 1);
|
||||
|
||||
public ProfileRepository(string filePath)
|
||||
{
|
||||
_filePath = filePath;
|
||||
}
|
||||
|
||||
public async Task<IReadOnlyList<TenantProfile>> LoadAsync()
|
||||
{
|
||||
if (!File.Exists(_filePath))
|
||||
return Array.Empty<TenantProfile>();
|
||||
|
||||
var json = await File.ReadAllTextAsync(_filePath, Encoding.UTF8);
|
||||
var root = JsonSerializer.Deserialize<ProfilesRoot>(json,
|
||||
new JsonSerializerOptions { PropertyNameCaseInsensitive = true });
|
||||
return root?.Profiles ?? Array.Empty<TenantProfile>();
|
||||
}
|
||||
|
||||
public async Task SaveAsync(IReadOnlyList<TenantProfile> profiles)
|
||||
{
|
||||
await _writeLock.WaitAsync();
|
||||
try
|
||||
{
|
||||
var root = new ProfilesRoot { Profiles = profiles.ToList() };
|
||||
var json = JsonSerializer.Serialize(root,
|
||||
new JsonSerializerOptions { WriteIndented = true,
|
||||
PropertyNamingPolicy = JsonNamingPolicy.CamelCase });
|
||||
var tmpPath = _filePath + ".tmp";
|
||||
Directory.CreateDirectory(Path.GetDirectoryName(_filePath)!);
|
||||
await File.WriteAllTextAsync(tmpPath, json, Encoding.UTF8);
|
||||
// Validate round-trip before replacing
|
||||
JsonDocument.Parse(await File.ReadAllTextAsync(tmpPath)).Dispose();
|
||||
File.Move(tmpPath, _filePath, overwrite: true);
|
||||
}
|
||||
finally { _writeLock.Release(); }
|
||||
}
|
||||
|
||||
private sealed class ProfilesRoot
|
||||
{
|
||||
public List<TenantProfile> Profiles { get; set; } = new();
|
||||
}
|
||||
}
|
||||
```
|
||||
Note: Use `PropertyNamingPolicy = JsonNamingPolicy.CamelCase` to serialize `Name`→`name`, `TenantUrl`→`tenantUrl`, `ClientId`→`clientId` matching the existing JSON schema.
|
||||
|
||||
**ProfileService.cs** — CRUD on top of repository:
|
||||
- Constructor takes `ProfileRepository` (inject via DI later; for now accept in constructor)
|
||||
- `Task<IReadOnlyList<TenantProfile>> GetProfilesAsync()`
|
||||
- `Task AddProfileAsync(TenantProfile profile)` — validates Name not empty, TenantUrl valid URL, ClientId not empty; throws `ArgumentException` for invalid inputs
|
||||
- `Task RenameProfileAsync(string existingName, string newName)` — throws `KeyNotFoundException` if not found
|
||||
- `Task DeleteProfileAsync(string name)` — throws `KeyNotFoundException` if not found
|
||||
- All mutations load → modify in-memory list → save (single-load-modify-save to preserve order)
|
||||
|
||||
**ProfileServiceTests.cs** — Replace the stub with real tests using temp file paths:
|
||||
```csharp
|
||||
public class ProfileServiceTests : IDisposable
|
||||
{
|
||||
private readonly string _tempFile = Path.GetTempFileName();
|
||||
// Dispose deletes temp file
|
||||
|
||||
[Fact]
|
||||
public async Task SaveAndLoad_RoundTrips_Profiles() { ... }
|
||||
// etc.
|
||||
}
|
||||
```
|
||||
Tests must use a temp file, not the real user data file. All tests in `[Trait("Category", "Unit")]`.
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd "C:\Users\dev\Documents\projets\Sharepoint" && dotnet test SharepointToolbox.Tests/SharepointToolbox.Tests.csproj --filter "FullyQualifiedName~ProfileServiceTests" 2>&1 | tail -10</automated>
|
||||
</verify>
|
||||
<done>All ProfileServiceTests pass (no skips). JSON output uses camelCase field names matching existing schema. Write-then-replace with SemaphoreSlim implemented.</done>
|
||||
</task>
|
||||
|
||||
<task type="auto" tdd="true">
|
||||
<name>Task 2: SettingsRepository and SettingsService</name>
|
||||
<files>
|
||||
SharepointToolbox/Infrastructure/Persistence/SettingsRepository.cs,
|
||||
SharepointToolbox/Services/SettingsService.cs,
|
||||
SharepointToolbox.Tests/Services/SettingsServiceTests.cs
|
||||
</files>
|
||||
<behavior>
|
||||
- Test: LoadAsync returns default settings (dataFolder = empty string, lang = "en") when file missing
|
||||
- Test: SaveAsync then LoadAsync round-trips dataFolder and lang values exactly
|
||||
- Test: Serialized JSON contains "dataFolder" and "lang" keys (not DataFolder/Lang — schema compatibility)
|
||||
- Test: SaveAsync uses write-then-replace (tmp file created, then moved)
|
||||
- Test: SettingsService.SetLanguageAsync("fr") persists lang="fr"
|
||||
- Test: SettingsService.SetDataFolderAsync("C:\\Exports") persists dataFolder path
|
||||
</behavior>
|
||||
<action>
|
||||
**AppSettings model** (add to `Core/Models/AppSettings.cs`):
|
||||
```csharp
|
||||
namespace SharepointToolbox.Core.Models;
|
||||
public class AppSettings
|
||||
{
|
||||
public string DataFolder { get; set; } = string.Empty;
|
||||
public string Lang { get; set; } = "en";
|
||||
}
|
||||
```
|
||||
Note: STJ with `PropertyNamingPolicy.CamelCase` will serialize `DataFolder`→`dataFolder`, `Lang`→`lang`.
|
||||
|
||||
**SettingsRepository.cs** — same write-then-replace pattern as ProfileRepository:
|
||||
- `Task<AppSettings> LoadAsync()` — returns `new AppSettings()` if file missing; throws `InvalidDataException` on corrupt JSON
|
||||
- `Task SaveAsync(AppSettings settings)` — write-then-replace with `SemaphoreSlim(1)` and camelCase serialization
|
||||
|
||||
**SettingsService.cs**:
|
||||
- Constructor takes `SettingsRepository`
|
||||
- `Task<AppSettings> GetSettingsAsync()`
|
||||
- `Task SetLanguageAsync(string cultureCode)` — validates "en" or "fr"; throws `ArgumentException` otherwise
|
||||
- `Task SetDataFolderAsync(string path)` — saves path (empty string allowed — means default)
|
||||
|
||||
**SettingsServiceTests.cs** — Replace stub with real tests using temp file.
|
||||
All tests in `[Trait("Category", "Unit")]`.
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd "C:\Users\dev\Documents\projets\Sharepoint" && dotnet test SharepointToolbox.Tests/SharepointToolbox.Tests.csproj --filter "FullyQualifiedName~SettingsServiceTests" 2>&1 | tail -10</automated>
|
||||
</verify>
|
||||
<done>All SettingsServiceTests pass. AppSettings serializes to dataFolder/lang (camelCase). Default settings returned when file is absent.</done>
|
||||
</task>
|
||||
|
||||
</tasks>
|
||||
|
||||
<verification>
|
||||
- `dotnet test SharepointToolbox.Tests/SharepointToolbox.Tests.csproj --filter "Category=Unit"` — all pass
|
||||
- JSON output from ProfileRepository contains `"profiles"` root key with `"name"`, `"tenantUrl"`, `"clientId"` field names
|
||||
- JSON output from SettingsRepository contains `"dataFolder"` and `"lang"` field names
|
||||
- Both repositories use `SemaphoreSlim(1)` write lock
|
||||
- Both repositories use write-then-replace (`.tmp` file then `File.Move`)
|
||||
</verification>
|
||||
|
||||
<success_criteria>
|
||||
Unit tests green for ProfileService and SettingsService. JSON schema compatibility verified by test assertions on serialized output. Write-then-replace pattern protects against crash-corruption.
|
||||
</success_criteria>
|
||||
|
||||
<output>
|
||||
After completion, create `.planning/phases/01-foundation/01-03-SUMMARY.md`
|
||||
</output>
|
||||
142
.planning/milestones/v1.0-phases/01-foundation/01-03-SUMMARY.md
Normal file
142
.planning/milestones/v1.0-phases/01-foundation/01-03-SUMMARY.md
Normal file
@@ -0,0 +1,142 @@
|
||||
---
|
||||
phase: 01-foundation
|
||||
plan: 03
|
||||
subsystem: persistence
|
||||
tags: [dotnet10, csharp, system-text-json, semaphoreslim, write-then-replace, unit-tests, xunit]
|
||||
|
||||
# Dependency graph
|
||||
requires:
|
||||
- 01-01 (solution scaffold, test project)
|
||||
- 01-02 (TenantProfile model)
|
||||
provides:
|
||||
- ProfileRepository: file I/O for profiles JSON with SemaphoreSlim write lock and write-then-replace
|
||||
- ProfileService: CRUD (GetProfiles/AddProfile/RenameProfile/DeleteProfile) with input validation
|
||||
- SettingsRepository: file I/O for settings JSON with same write-then-replace safety pattern
|
||||
- SettingsService: GetSettings/SetLanguage/SetDataFolder with supported-language validation
|
||||
- AppSettings model: DataFolder + Lang with camelCase JSON compatibility
|
||||
affects:
|
||||
- 01-04 (MsalClientFactory may use ProfileService for tenant list)
|
||||
- 01-05 (TranslationSource uses SettingsService for lang)
|
||||
- 01-06 (FeatureViewModelBase may use ProfileService/SettingsService)
|
||||
- all feature plans (profile and settings are the core data contracts)
|
||||
|
||||
# Tech tracking
|
||||
tech-stack:
|
||||
added: []
|
||||
patterns:
|
||||
- Write-then-replace: write to .tmp, validate JSON round-trip via JsonDocument.Parse, then File.Move(overwrite:true)
|
||||
- SemaphoreSlim(1,1) for async exclusive write access on per-repository basis
|
||||
- System.Text.Json with PropertyNamingPolicy.CamelCase for schema-compatible serialization
|
||||
- PropertyNameCaseInsensitive=true for deserialization to handle both old and new JSON
|
||||
- TDD with IDisposable temp file pattern for isolated unit tests
|
||||
|
||||
key-files:
|
||||
created:
|
||||
- SharepointToolbox/Core/Models/AppSettings.cs
|
||||
- SharepointToolbox/Infrastructure/Persistence/ProfileRepository.cs
|
||||
- SharepointToolbox/Infrastructure/Persistence/SettingsRepository.cs
|
||||
- SharepointToolbox/Services/ProfileService.cs
|
||||
- SharepointToolbox/Services/SettingsService.cs
|
||||
- SharepointToolbox.Tests/Services/ProfileServiceTests.cs
|
||||
- SharepointToolbox.Tests/Services/SettingsServiceTests.cs
|
||||
modified: []
|
||||
|
||||
key-decisions:
|
||||
- "Explicit System.IO using required in WPF project — WPF temp build project does not include System.IO in implicit usings; all file I/O classes need explicit namespace import"
|
||||
- "SettingsService validates only 'en' and 'fr' — matches app's supported locales; throws ArgumentException for any other code"
|
||||
- "LoadAsync on corrupt JSON throws InvalidDataException (not silent empty) — explicit failure is safer than silently discarding user data"
|
||||
|
||||
patterns-established:
|
||||
- "Write-then-replace: all file persistence uses .tmp write + JsonDocument.Parse validation + File.Move(overwrite:true) to protect against crash-corruption"
|
||||
- "IDisposable test pattern: unit tests use Path.GetTempFileName() + Dispose() for clean isolated file I/O tests"
|
||||
|
||||
requirements-completed:
|
||||
- FOUND-02
|
||||
- FOUND-10
|
||||
- FOUND-12
|
||||
|
||||
# Metrics
|
||||
duration: 8min
|
||||
completed: 2026-04-02
|
||||
---
|
||||
|
||||
# Phase 1 Plan 03: Persistence Layer Summary
|
||||
|
||||
**ProfileRepository + SettingsRepository with write-then-replace safety, ProfileService + SettingsService with validation, 18 unit tests covering round-trips, corrupt-file recovery, concurrency, and JSON schema compatibility**
|
||||
|
||||
## Performance
|
||||
|
||||
- **Duration:** 8 min
|
||||
- **Started:** 2026-04-02T10:09:13Z
|
||||
- **Completed:** 2026-04-02T10:17:00Z
|
||||
- **Tasks:** 2
|
||||
- **Files modified:** 7
|
||||
|
||||
## Accomplishments
|
||||
|
||||
- ProfileRepository and SettingsRepository both implement write-then-replace (tmp file → JSON validation → File.Move) with SemaphoreSlim(1,1) preventing concurrent write corruption
|
||||
- JSON serialization uses camelCase (PropertyNamingPolicy.CamelCase) — preserves existing user data field names: `profiles`, `name`, `tenantUrl`, `clientId`, `dataFolder`, `lang`
|
||||
- ProfileService provides full CRUD with input validation (Name not empty, TenantUrl valid absolute URL, ClientId not empty)
|
||||
- SettingsService validates language codes against supported set (en/fr only), allows empty dataFolder
|
||||
- All 18 unit tests pass (10 ProfileServiceTests + 8 SettingsServiceTests); no skips
|
||||
|
||||
## Task Commits
|
||||
|
||||
Each task was committed atomically:
|
||||
|
||||
1. **Task 1: ProfileRepository and ProfileService with write-then-replace** - `769196d` (feat)
|
||||
2. **Task 2: SettingsRepository and SettingsService** - `ac3fa5c` (feat)
|
||||
|
||||
**Plan metadata:** (docs commit follows)
|
||||
|
||||
## Files Created/Modified
|
||||
|
||||
- `SharepointToolbox/Core/Models/AppSettings.cs` - AppSettings model; DataFolder + Lang with camelCase JSON
|
||||
- `SharepointToolbox/Infrastructure/Persistence/ProfileRepository.cs` - File I/O; SemaphoreSlim; write-then-replace; camelCase
|
||||
- `SharepointToolbox/Infrastructure/Persistence/SettingsRepository.cs` - Same pattern as ProfileRepository for settings
|
||||
- `SharepointToolbox/Services/ProfileService.cs` - CRUD on profiles; validates Name/TenantUrl/ClientId; throws KeyNotFoundException
|
||||
- `SharepointToolbox/Services/SettingsService.cs` - Get/SetLanguage/SetDataFolder; validates language codes
|
||||
- `SharepointToolbox.Tests/Services/ProfileServiceTests.cs` - 10 tests: round-trip, missing file, corrupt JSON, concurrency, schema keys
|
||||
- `SharepointToolbox.Tests/Services/SettingsServiceTests.cs` - 8 tests: defaults, round-trip, JSON keys, tmp file, language/folder persistence
|
||||
|
||||
## Decisions Made
|
||||
|
||||
- Explicit `using System.IO;` required in WPF main project — the WPF temp build project does not include `System.IO` in its implicit usings, unlike the standard non-WPF SDK. All repositories need explicit namespace imports.
|
||||
- `SettingsService.SetLanguageAsync` validates only "en" and "fr" using a case-insensitive `HashSet<string>`. Other codes throw `ArgumentException` immediately.
|
||||
- `LoadAsync` on corrupt JSON throws `InvalidDataException` (not silent empty list/default) — this is an explicit safety decision: silently discarding corrupt data could mask accidental overwrites.
|
||||
|
||||
## Deviations from Plan
|
||||
|
||||
### Auto-fixed Issues
|
||||
|
||||
**1. [Rule 3 - Blocking] Added explicit System.IO using to WPF project files**
|
||||
- **Found during:** Task 1 (dotnet test — first GREEN attempt)
|
||||
- **Issue:** WPF temporary build project does not include `System.IO` in its implicit usings. `File`, `Path`, `Directory`, `IOException`, `InvalidDataException` all unresolved in the main project and test project.
|
||||
- **Fix:** Added `using System.IO;` at the top of ProfileRepository.cs, SettingsRepository.cs, ProfileServiceTests.cs, and SettingsServiceTests.cs
|
||||
- **Files modified:** All 4 implementation and test files
|
||||
- **Verification:** Build succeeded with 0 errors, 18/18 tests pass
|
||||
- **Committed in:** 769196d and ac3fa5c (inline with respective task commits)
|
||||
|
||||
---
|
||||
|
||||
**Total deviations:** 1 auto-fixed (Rule 3 — blocking build issue)
|
||||
**Impact on plan:** One-line fix per file, no logic changes, no scope creep.
|
||||
|
||||
## Issues Encountered
|
||||
|
||||
None beyond the auto-fixed deviation above.
|
||||
|
||||
## User Setup Required
|
||||
|
||||
None - no external service configuration required.
|
||||
|
||||
## Next Phase Readiness
|
||||
|
||||
- ProfileService and SettingsService ready for injection in plan 01-04 (MsalClientFactory may need tenant list from ProfileService)
|
||||
- SettingsService.SetLanguageAsync ready for TranslationSource in plan 01-05
|
||||
- Both services follow the same constructor injection pattern — ready for DI container registration in plan 01-06 or 01-07
|
||||
- JSON schema contracts locked: field names are tested and verified camelCase
|
||||
|
||||
---
|
||||
*Phase: 01-foundation*
|
||||
*Completed: 2026-04-02*
|
||||
266
.planning/milestones/v1.0-phases/01-foundation/01-04-PLAN.md
Normal file
266
.planning/milestones/v1.0-phases/01-foundation/01-04-PLAN.md
Normal file
@@ -0,0 +1,266 @@
|
||||
---
|
||||
phase: 01-foundation
|
||||
plan: 04
|
||||
type: execute
|
||||
wave: 4
|
||||
depends_on:
|
||||
- 01-02
|
||||
- 01-03
|
||||
files_modified:
|
||||
- SharepointToolbox/Infrastructure/Auth/MsalClientFactory.cs
|
||||
- SharepointToolbox/Services/SessionManager.cs
|
||||
- SharepointToolbox.Tests/Auth/MsalClientFactoryTests.cs
|
||||
- SharepointToolbox.Tests/Auth/SessionManagerTests.cs
|
||||
autonomous: true
|
||||
requirements:
|
||||
- FOUND-03
|
||||
- FOUND-04
|
||||
must_haves:
|
||||
truths:
|
||||
- "MsalClientFactory creates one IPublicClientApplication per ClientId — never shares instances across tenants"
|
||||
- "MsalCacheHelper persists token cache to %AppData%\\SharepointToolbox\\auth\\msal_{clientId}.cache"
|
||||
- "SessionManager.GetOrCreateContextAsync returns a cached ClientContext on second call without interactive login"
|
||||
- "SessionManager.ClearSessionAsync removes MSAL accounts and disposes ClientContext for the specified tenant"
|
||||
- "SessionManager is the only class in the codebase holding ClientContext instances"
|
||||
artifacts:
|
||||
- path: "SharepointToolbox/Infrastructure/Auth/MsalClientFactory.cs"
|
||||
provides: "Per-ClientId IPublicClientApplication with MsalCacheHelper"
|
||||
contains: "MsalCacheHelper"
|
||||
- path: "SharepointToolbox/Services/SessionManager.cs"
|
||||
provides: "Singleton holding all ClientContext instances and auth state"
|
||||
exports: ["GetOrCreateContextAsync", "ClearSessionAsync", "IsAuthenticated"]
|
||||
key_links:
|
||||
- from: "SharepointToolbox/Services/SessionManager.cs"
|
||||
to: "SharepointToolbox/Infrastructure/Auth/MsalClientFactory.cs"
|
||||
via: "Injected dependency — SessionManager calls MsalClientFactory.GetOrCreateAsync(clientId)"
|
||||
pattern: "GetOrCreateAsync"
|
||||
- from: "SharepointToolbox/Services/SessionManager.cs"
|
||||
to: "PnP.Framework AuthenticationManager"
|
||||
via: "CreateWithInteractiveLogin using MSAL PCA"
|
||||
pattern: "AuthenticationManager"
|
||||
---
|
||||
|
||||
<objective>
|
||||
Build the authentication layer: MsalClientFactory (per-tenant MSAL client with persistent cache) and SessionManager (singleton holding all live ClientContext instances). This is the security-critical component — one IPublicClientApplication per ClientId, never shared.
|
||||
|
||||
Purpose: Every SharePoint operation in Phases 2-4 goes through SessionManager. Getting the per-tenant isolation and token cache correct now prevents auth token bleed between client tenants — a critical security property for MSP use.
|
||||
Output: MsalClientFactory + SessionManager + unit tests validating per-tenant isolation.
|
||||
</objective>
|
||||
|
||||
<execution_context>
|
||||
@C:/Users/SebastienQUEROL/.claude/get-shit-done/workflows/execute-plan.md
|
||||
@C:/Users/SebastienQUEROL/.claude/get-shit-done/templates/summary.md
|
||||
</execution_context>
|
||||
|
||||
<context>
|
||||
@.planning/PROJECT.md
|
||||
@.planning/phases/01-foundation/01-CONTEXT.md
|
||||
@.planning/phases/01-foundation/01-RESEARCH.md
|
||||
@.planning/phases/01-foundation/01-02-SUMMARY.md
|
||||
@.planning/phases/01-foundation/01-03-SUMMARY.md
|
||||
|
||||
<interfaces>
|
||||
<!-- From Core/Models/TenantProfile.cs (plan 01-02) -->
|
||||
```csharp
|
||||
public class TenantProfile
|
||||
{
|
||||
public string Name { get; set; }
|
||||
public string TenantUrl { get; set; }
|
||||
public string ClientId { get; set; }
|
||||
}
|
||||
```
|
||||
</interfaces>
|
||||
</context>
|
||||
|
||||
<tasks>
|
||||
|
||||
<task type="auto" tdd="true">
|
||||
<name>Task 1: MsalClientFactory — per-ClientId PCA with MsalCacheHelper</name>
|
||||
<files>
|
||||
SharepointToolbox/Infrastructure/Auth/MsalClientFactory.cs,
|
||||
SharepointToolbox.Tests/Auth/MsalClientFactoryTests.cs
|
||||
</files>
|
||||
<behavior>
|
||||
- Test: GetOrCreateAsync("clientA") and GetOrCreateAsync("clientA") return the same instance (no duplicate creation)
|
||||
- Test: GetOrCreateAsync("clientA") and GetOrCreateAsync("clientB") return different instances (per-tenant isolation)
|
||||
- Test: Concurrent calls to GetOrCreateAsync with same clientId do not create duplicate instances (SemaphoreSlim)
|
||||
- Test: Cache directory path resolves to %AppData%\SharepointToolbox\auth\ (not a hardcoded path)
|
||||
</behavior>
|
||||
<action>
|
||||
Create `Infrastructure/Auth/` directory.
|
||||
|
||||
**MsalClientFactory.cs** — implement exactly as per research Pattern 3:
|
||||
```csharp
|
||||
namespace SharepointToolbox.Infrastructure.Auth;
|
||||
|
||||
public class MsalClientFactory
|
||||
{
|
||||
private readonly Dictionary<string, IPublicClientApplication> _clients = new();
|
||||
private readonly SemaphoreSlim _lock = new(1, 1);
|
||||
private readonly string _cacheDir = Path.Combine(
|
||||
Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData),
|
||||
"SharepointToolbox", "auth");
|
||||
|
||||
public async Task<IPublicClientApplication> GetOrCreateAsync(string clientId)
|
||||
{
|
||||
await _lock.WaitAsync();
|
||||
try
|
||||
{
|
||||
if (_clients.TryGetValue(clientId, out var existing))
|
||||
return existing;
|
||||
|
||||
var storageProps = new StorageCreationPropertiesBuilder(
|
||||
$"msal_{clientId}.cache", _cacheDir)
|
||||
.Build();
|
||||
|
||||
var pca = PublicClientApplicationBuilder
|
||||
.Create(clientId)
|
||||
.WithDefaultRedirectUri()
|
||||
.WithLegacyCacheCompatibility(false)
|
||||
.Build();
|
||||
|
||||
var helper = await MsalCacheHelper.CreateAsync(storageProps);
|
||||
helper.RegisterCache(pca.UserTokenCache);
|
||||
|
||||
_clients[clientId] = pca;
|
||||
return pca;
|
||||
}
|
||||
finally { _lock.Release(); }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**MsalClientFactoryTests.cs** — Replace stub. Tests for per-ClientId isolation and idempotency.
|
||||
Since MsalCacheHelper creates real files, tests must use a temp directory and clean up.
|
||||
Use `[Trait("Category", "Unit")]` on all tests.
|
||||
Mock or subclass `MsalClientFactory` for the concurrent test to avoid real MSAL overhead.
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd "C:\Users\dev\Documents\projets\Sharepoint" && dotnet test SharepointToolbox.Tests/SharepointToolbox.Tests.csproj --filter "FullyQualifiedName~MsalClientFactoryTests" 2>&1 | tail -10</automated>
|
||||
</verify>
|
||||
<done>MsalClientFactoryTests pass. Different clientIds produce different instances. Same clientId produces same instance on second call.</done>
|
||||
</task>
|
||||
|
||||
<task type="auto" tdd="true">
|
||||
<name>Task 2: SessionManager — singleton ClientContext holder</name>
|
||||
<files>
|
||||
SharepointToolbox/Services/SessionManager.cs,
|
||||
SharepointToolbox.Tests/Auth/SessionManagerTests.cs
|
||||
</files>
|
||||
<behavior>
|
||||
- Test: IsAuthenticated(tenantUrl) returns false before any authentication
|
||||
- Test: After GetOrCreateContextAsync succeeds, IsAuthenticated(tenantUrl) returns true
|
||||
- Test: ClearSessionAsync removes authentication state for the specified tenant
|
||||
- Test: ClearSessionAsync on unknown tenantUrl does not throw (idempotent)
|
||||
- Test: ClientContext is disposed on ClearSessionAsync (verify via mock/wrapper)
|
||||
- Test: GetOrCreateContextAsync throws ArgumentException for null/empty tenantUrl or clientId
|
||||
</behavior>
|
||||
<action>
|
||||
**SessionManager.cs** — singleton, owns all ClientContext instances:
|
||||
```csharp
|
||||
namespace SharepointToolbox.Services;
|
||||
|
||||
public class SessionManager
|
||||
{
|
||||
private readonly MsalClientFactory _msalFactory;
|
||||
private readonly Dictionary<string, ClientContext> _contexts = new();
|
||||
private readonly SemaphoreSlim _lock = new(1, 1);
|
||||
|
||||
public SessionManager(MsalClientFactory msalFactory)
|
||||
{
|
||||
_msalFactory = msalFactory;
|
||||
}
|
||||
|
||||
public bool IsAuthenticated(string tenantUrl) =>
|
||||
_contexts.ContainsKey(NormalizeUrl(tenantUrl));
|
||||
|
||||
/// <summary>
|
||||
/// Returns existing ClientContext or creates a new one via interactive MSAL login.
|
||||
/// Only SessionManager holds ClientContext instances — never return to callers for storage.
|
||||
/// </summary>
|
||||
public async Task<ClientContext> GetOrCreateContextAsync(
|
||||
TenantProfile profile,
|
||||
CancellationToken ct = default)
|
||||
{
|
||||
ArgumentException.ThrowIfNullOrEmpty(profile.TenantUrl);
|
||||
ArgumentException.ThrowIfNullOrEmpty(profile.ClientId);
|
||||
|
||||
var key = NormalizeUrl(profile.TenantUrl);
|
||||
|
||||
await _lock.WaitAsync(ct);
|
||||
try
|
||||
{
|
||||
if (_contexts.TryGetValue(key, out var existing))
|
||||
return existing;
|
||||
|
||||
var pca = await _msalFactory.GetOrCreateAsync(profile.ClientId);
|
||||
var authManager = AuthenticationManager.CreateWithInteractiveLogin(
|
||||
profile.ClientId,
|
||||
(url, port) =>
|
||||
{
|
||||
// WAM/browser-based interactive login
|
||||
return pca.AcquireTokenInteractive(
|
||||
new[] { "https://graph.microsoft.com/.default" })
|
||||
.ExecuteAsync(ct);
|
||||
});
|
||||
|
||||
var ctx = await authManager.GetContextAsync(profile.TenantUrl);
|
||||
_contexts[key] = ctx;
|
||||
return ctx;
|
||||
}
|
||||
finally { _lock.Release(); }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Clears MSAL accounts and disposes the ClientContext for the given tenant.
|
||||
/// Called by "Clear Session" button and on tenant profile deletion.
|
||||
/// </summary>
|
||||
public async Task ClearSessionAsync(string tenantUrl)
|
||||
{
|
||||
var key = NormalizeUrl(tenantUrl);
|
||||
await _lock.WaitAsync();
|
||||
try
|
||||
{
|
||||
if (_contexts.TryGetValue(key, out var ctx))
|
||||
{
|
||||
ctx.Dispose();
|
||||
_contexts.Remove(key);
|
||||
}
|
||||
}
|
||||
finally { _lock.Release(); }
|
||||
}
|
||||
|
||||
private static string NormalizeUrl(string url) =>
|
||||
url.TrimEnd('/').ToLowerInvariant();
|
||||
}
|
||||
```
|
||||
|
||||
Note on PnP AuthenticationManager: The exact API for `CreateWithInteractiveLogin` with MSAL PCA may vary in PnP.Framework 1.18.0. The implementation above is a skeleton — executor should verify the PnP API surface and adjust accordingly. The key invariant is: `MsalClientFactory.GetOrCreateAsync` is called first, then PnP creates the context using the returned PCA. Do NOT call `PublicClientApplicationBuilder.Create` directly in SessionManager.
|
||||
|
||||
**SessionManagerTests.cs** — Replace stub. Use Moq to mock `MsalClientFactory`.
|
||||
Test `IsAuthenticated`, `ClearSessionAsync` idempotency, and argument validation.
|
||||
Interactive login cannot be tested in unit tests — mark `GetOrCreateContextAsync_CreatesContext` as `[Fact(Skip = "Requires interactive MSAL — integration test only")]`.
|
||||
All other tests in `[Trait("Category", "Unit")]`.
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd "C:\Users\dev\Documents\projets\Sharepoint" && dotnet test SharepointToolbox.Tests/SharepointToolbox.Tests.csproj --filter "FullyQualifiedName~SessionManagerTests" 2>&1 | tail -10</automated>
|
||||
</verify>
|
||||
<done>SessionManagerTests pass (interactive login test skipped). IsAuthenticated, ClearSessionAsync, and argument validation tests are green. SessionManager is the only holder of ClientContext.</done>
|
||||
</task>
|
||||
|
||||
</tasks>
|
||||
|
||||
<verification>
|
||||
- `dotnet test --filter "Category=Unit"` passes
|
||||
- MsalClientFactory._clients dictionary holds one entry per unique clientId
|
||||
- SessionManager.ClearSessionAsync calls ctx.Dispose() (verified via test)
|
||||
- No class outside SessionManager stores a ClientContext reference
|
||||
</verification>
|
||||
|
||||
<success_criteria>
|
||||
Auth layer unit tests green. Per-tenant isolation (one PCA per ClientId, one context per tenantUrl) confirmed by tests. SessionManager is the single source of truth for authenticated connections.
|
||||
</success_criteria>
|
||||
|
||||
<output>
|
||||
After completion, create `.planning/phases/01-foundation/01-04-SUMMARY.md`
|
||||
</output>
|
||||
135
.planning/milestones/v1.0-phases/01-foundation/01-04-SUMMARY.md
Normal file
135
.planning/milestones/v1.0-phases/01-foundation/01-04-SUMMARY.md
Normal file
@@ -0,0 +1,135 @@
|
||||
---
|
||||
phase: 01-foundation
|
||||
plan: 04
|
||||
subsystem: auth
|
||||
tags: [dotnet10, csharp, msal, msal-cache-helper, pnp-framework, sharepoint, csom, unit-tests, xunit, semaphoreslim, tdd]
|
||||
|
||||
# Dependency graph
|
||||
requires:
|
||||
- 01-01 (solution scaffold, NuGet packages — Microsoft.Identity.Client, Microsoft.Identity.Client.Extensions.Msal, PnP.Framework)
|
||||
- 01-02 (TenantProfile model with ClientId/TenantUrl fields)
|
||||
- 01-03 (ProfileService/SettingsService — injection pattern)
|
||||
provides:
|
||||
- MsalClientFactory: per-ClientId IPublicClientApplication with MsalCacheHelper persistent cache
|
||||
- MsalClientFactory.GetCacheHelper(clientId): exposes MsalCacheHelper for PnP tokenCacheCallback wiring
|
||||
- SessionManager: singleton owning all live ClientContext instances with IsAuthenticated/GetOrCreateContextAsync/ClearSessionAsync
|
||||
affects:
|
||||
- 01-05 (TranslationSource/app setup — SessionManager ready for DI registration)
|
||||
- 01-06 (FeatureViewModelBase — SessionManager is the auth gateway for all feature commands)
|
||||
- 02-xx (all SharePoint feature services call SessionManager.GetOrCreateContextAsync)
|
||||
|
||||
# Tech tracking
|
||||
tech-stack:
|
||||
added: []
|
||||
patterns:
|
||||
- MsalClientFactory: per-clientId Dictionary<string, IPublicClientApplication> + SemaphoreSlim(1,1) for concurrent-safe lazy creation
|
||||
- MsalCacheHelper stored per-clientId alongside PCA — exposed via GetCacheHelper() for PnP tokenCacheCallback wiring
|
||||
- SessionManager: per-tenantUrl Dictionary<string, ClientContext> + SemaphoreSlim(1,1); NormalizeUrl (TrimEnd + ToLowerInvariant) for key consistency
|
||||
- PnP tokenCacheCallback pattern: cacheHelper.RegisterCache(tokenCache) wires persistent cache to PnP's internal MSAL token cache
|
||||
- ArgumentException.ThrowIfNullOrEmpty on all public method entry points requiring string arguments
|
||||
|
||||
key-files:
|
||||
created:
|
||||
- SharepointToolbox/Infrastructure/Auth/MsalClientFactory.cs
|
||||
- SharepointToolbox/Services/SessionManager.cs
|
||||
- SharepointToolbox.Tests/Auth/MsalClientFactoryTests.cs
|
||||
- SharepointToolbox.Tests/Auth/SessionManagerTests.cs
|
||||
modified: []
|
||||
|
||||
key-decisions:
|
||||
- "MsalClientFactory stores both IPublicClientApplication and MsalCacheHelper per clientId — GetCacheHelper() exposes helper for PnP's tokenCacheCallback; PnP creates its own internal PCA so we cannot pass ours directly"
|
||||
- "SessionManager uses tokenCacheCallback to wire MsalCacheHelper to PnP's token cache — both PCA and PnP share the same persistent msal_{clientId}.cache file, preventing token duplication"
|
||||
- "CacheDirectory is a constructor parameter with a no-arg default — enables test isolation without real %AppData% writes"
|
||||
- "Interactive login test marked Skip in unit test suite — GetOrCreateContextAsync integration requires browser/WAM flow that cannot run in CI"
|
||||
|
||||
patterns-established:
|
||||
- "Auth token cache wiring: Always call MsalClientFactory.GetOrCreateAsync first, then use GetCacheHelper() in PnP's tokenCacheCallback — ensures per-clientId cache isolation"
|
||||
- "SessionManager is the single source of truth for ClientContext: callers must not store returned contexts"
|
||||
|
||||
requirements-completed:
|
||||
- FOUND-03
|
||||
- FOUND-04
|
||||
|
||||
# Metrics
|
||||
duration: 4min
|
||||
completed: 2026-04-02
|
||||
---
|
||||
|
||||
# Phase 1 Plan 04: Authentication Layer Summary
|
||||
|
||||
**Per-tenant MSAL PCA with MsalCacheHelper persistent cache (one file per clientId in %AppData%) and SessionManager singleton owning all live PnP ClientContext instances — per-tenant isolation verified by 12 unit tests**
|
||||
|
||||
## Performance
|
||||
|
||||
- **Duration:** 4 min
|
||||
- **Started:** 2026-04-02T10:20:49Z
|
||||
- **Completed:** 2026-04-02T10:25:05Z
|
||||
- **Tasks:** 2
|
||||
- **Files modified:** 4
|
||||
|
||||
## Accomplishments
|
||||
|
||||
- MsalClientFactory creates one IPublicClientApplication per unique clientId (never shared across tenants); SemaphoreSlim prevents duplicate creation under concurrent calls
|
||||
- MsalCacheHelper registered on each PCA's UserTokenCache; persistent cache files at `%AppData%\SharepointToolbox\auth\msal_{clientId}.cache`
|
||||
- SessionManager is the sole holder of ClientContext instances; IsAuthenticated/ClearSessionAsync/GetOrCreateContextAsync with full argument validation
|
||||
- ClearSessionAsync calls ctx.Dispose() and removes from internal dictionary; idempotent for unknown tenants
|
||||
- 12 unit tests pass (4 MsalClientFactory + 8 SessionManager), 1 integration test correctly skipped
|
||||
- PnP tokenCacheCallback pattern established: `cacheHelper.RegisterCache(tokenCache)` wires the factory-managed helper to PnP's internal MSAL token cache
|
||||
|
||||
## Task Commits
|
||||
|
||||
Each task was committed atomically:
|
||||
|
||||
1. **Task 1: MsalClientFactory — per-ClientId PCA with MsalCacheHelper** - `0295519` (feat)
|
||||
2. **Task 2: SessionManager — singleton ClientContext holder** - `158aab9` (feat)
|
||||
|
||||
**Plan metadata:** (docs commit follows)
|
||||
|
||||
## Files Created/Modified
|
||||
|
||||
- `SharepointToolbox/Infrastructure/Auth/MsalClientFactory.cs` - Per-clientId PCA + MsalCacheHelper; CacheDirectory constructor param; GetCacheHelper() for PnP wiring
|
||||
- `SharepointToolbox/Services/SessionManager.cs` - Singleton; IsAuthenticated/GetOrCreateContextAsync/ClearSessionAsync; NormalizeUrl; tokenCacheCallback wiring
|
||||
- `SharepointToolbox.Tests/Auth/MsalClientFactoryTests.cs` - 4 unit tests: same-instance, different-instances, concurrent-safe, AppData path; IDisposable temp dir cleanup
|
||||
- `SharepointToolbox.Tests/Auth/SessionManagerTests.cs` - 8 unit tests + 1 skipped: IsAuthenticated before/after, ClearSessionAsync idempotency, ArgumentException on null/empty TenantUrl and ClientId
|
||||
|
||||
## Decisions Made
|
||||
|
||||
- `MsalClientFactory` stores `MsalCacheHelper` per clientId alongside the `IPublicClientApplication`. Added `GetCacheHelper(clientId)` to expose it. This is required because PnP.Framework's `CreateWithInteractiveLogin` creates its own internal PCA — we cannot pass our PCA to PnP directly. The `tokenCacheCallback` (`Action<ITokenCache>`) is the bridge: we call `cacheHelper.RegisterCache(tokenCache)` so PnP's internal cache uses the same persistent file.
|
||||
- `CacheDirectory` is a public constructor parameter with a no-arg default pointing to `%AppData%\SharepointToolbox\auth`. Tests inject a temp directory to avoid real AppData writes and ensure cleanup.
|
||||
- Interactive login test (`GetOrCreateContextAsync_CreatesContext`) is marked `[Fact(Skip = "Requires interactive MSAL — integration test only")]`. Browser/WAM flow cannot run in automated unit tests.
|
||||
|
||||
## Deviations from Plan
|
||||
|
||||
### Auto-fixed Issues
|
||||
|
||||
**1. [Rule 2 - Missing Critical] Added GetCacheHelper() to MsalClientFactory**
|
||||
- **Found during:** Task 2 (SessionManager implementation)
|
||||
- **Issue:** Plan's skeleton used a non-existent PnP overload that accepts `IPublicClientApplication` directly. PnP.Framework 1.18.0's `CreateWithInteractiveLogin` does not accept a PCA parameter — only `tokenCacheCallback: Action<ITokenCache>`. Without `GetCacheHelper()`, there was no way to wire the same MsalCacheHelper to PnP's internal token cache.
|
||||
- **Fix:** Added `_helpers` dictionary to `MsalClientFactory`, stored `MsalCacheHelper` alongside PCA, exposed via `GetCacheHelper(clientId)`. `SessionManager` calls `GetOrCreateAsync` first, then `GetCacheHelper`, then uses it in `tokenCacheCallback`.
|
||||
- **Files modified:** `SharepointToolbox/Infrastructure/Auth/MsalClientFactory.cs`, `SharepointToolbox/Services/SessionManager.cs`
|
||||
- **Verification:** 12/12 unit tests pass, 0 build warnings
|
||||
- **Committed in:** 158aab9 (Task 2 commit)
|
||||
|
||||
---
|
||||
|
||||
**Total deviations:** 1 auto-fixed (Rule 2 — PnP API surface mismatch required bridge method)
|
||||
**Impact on plan:** The key invariant is preserved: MsalClientFactory is called first, the per-clientId MsalCacheHelper is wired to PnP before any token acquisition. One method added to factory, no scope creep.
|
||||
|
||||
## Issues Encountered
|
||||
|
||||
None beyond the auto-fixed deviation above.
|
||||
|
||||
## User Setup Required
|
||||
|
||||
None — MSAL cache files are created on demand in %AppData%. No external service configuration required.
|
||||
|
||||
## Next Phase Readiness
|
||||
|
||||
- `SessionManager` ready for DI registration in plan 01-05 or 01-06 (singleton lifetime)
|
||||
- `MsalClientFactory` ready for DI (singleton lifetime)
|
||||
- Auth layer complete: every SharePoint operation in Phases 2-4 can call `SessionManager.GetOrCreateContextAsync(profile)` to get a live `ClientContext`
|
||||
- Per-tenant isolation (one PCA + cache file per ClientId) confirmed by unit tests — token bleed between MSP client tenants is prevented
|
||||
|
||||
---
|
||||
*Phase: 01-foundation*
|
||||
*Completed: 2026-04-02*
|
||||
253
.planning/milestones/v1.0-phases/01-foundation/01-05-PLAN.md
Normal file
253
.planning/milestones/v1.0-phases/01-foundation/01-05-PLAN.md
Normal file
@@ -0,0 +1,253 @@
|
||||
---
|
||||
phase: 01-foundation
|
||||
plan: 05
|
||||
type: execute
|
||||
wave: 3
|
||||
depends_on:
|
||||
- 01-02
|
||||
files_modified:
|
||||
- SharepointToolbox/Localization/TranslationSource.cs
|
||||
- SharepointToolbox/Localization/Strings.resx
|
||||
- SharepointToolbox/Localization/Strings.fr.resx
|
||||
- SharepointToolbox.Tests/Localization/TranslationSourceTests.cs
|
||||
- SharepointToolbox.Tests/Integration/LoggingIntegrationTests.cs
|
||||
autonomous: true
|
||||
requirements:
|
||||
- FOUND-08
|
||||
- FOUND-09
|
||||
must_haves:
|
||||
truths:
|
||||
- "TranslationSource.Instance[key] returns the EN string for English culture"
|
||||
- "Setting TranslationSource.Instance.CurrentCulture to 'fr' changes string lookup without app restart"
|
||||
- "PropertyChanged fires with empty string key (signals all properties changed) on culture switch"
|
||||
- "Serilog writes to rolling daily log file at %AppData%\\SharepointToolbox\\logs\\app-{date}.log"
|
||||
- "Serilog ILogger<T> is injectable via DI — does not use static Log.Logger directly in services"
|
||||
- "LoggingIntegrationTests verify a log file is created and contains the written message"
|
||||
artifacts:
|
||||
- path: "SharepointToolbox/Localization/TranslationSource.cs"
|
||||
provides: "Singleton INotifyPropertyChanged string lookup for runtime culture switching"
|
||||
contains: "PropertyChangedEventArgs(string.Empty)"
|
||||
- path: "SharepointToolbox/Localization/Strings.resx"
|
||||
provides: "EN default resource file with all Phase 1 UI strings"
|
||||
- path: "SharepointToolbox/Localization/Strings.fr.resx"
|
||||
provides: "FR overlay — all keys present, values stubbed with EN text"
|
||||
key_links:
|
||||
- from: "SharepointToolbox/Localization/TranslationSource.cs"
|
||||
to: "SharepointToolbox/Localization/Strings.resx"
|
||||
via: "ResourceManager from Strings class"
|
||||
pattern: "Strings.ResourceManager"
|
||||
- from: "MainWindow.xaml (plan 01-06)"
|
||||
to: "SharepointToolbox/Localization/TranslationSource.cs"
|
||||
via: "XAML binding: Source={x:Static loc:TranslationSource.Instance}, Path=[key]"
|
||||
pattern: "TranslationSource.Instance"
|
||||
---
|
||||
|
||||
<objective>
|
||||
Build the logging infrastructure and dynamic localization system. Serilog wired into Generic Host. TranslationSource singleton enabling runtime culture switching without restart.
|
||||
|
||||
Purpose: Every feature phase needs ILogger<T> injection and localizable strings. The TranslationSource pattern (INotifyPropertyChanged indexer binding) is the only approach that refreshes WPF bindings at runtime — standard x:Static resx bindings are evaluated once at startup.
|
||||
Output: TranslationSource + EN/FR resx files + Serilog integration + unit/integration tests.
|
||||
</objective>
|
||||
|
||||
<execution_context>
|
||||
@C:/Users/SebastienQUEROL/.claude/get-shit-done/workflows/execute-plan.md
|
||||
@C:/Users/SebastienQUEROL/.claude/get-shit-done/templates/summary.md
|
||||
</execution_context>
|
||||
|
||||
<context>
|
||||
@.planning/PROJECT.md
|
||||
@.planning/phases/01-foundation/01-CONTEXT.md
|
||||
@.planning/phases/01-foundation/01-RESEARCH.md
|
||||
@.planning/phases/01-foundation/01-02-SUMMARY.md
|
||||
|
||||
<interfaces>
|
||||
<!-- From Core/Messages/LanguageChangedMessage.cs (plan 01-02) -->
|
||||
```csharp
|
||||
public sealed class LanguageChangedMessage : ValueChangedMessage<string>
|
||||
{
|
||||
public LanguageChangedMessage(string cultureCode) : base(cultureCode) { }
|
||||
}
|
||||
```
|
||||
</interfaces>
|
||||
</context>
|
||||
|
||||
<tasks>
|
||||
|
||||
<task type="auto" tdd="true">
|
||||
<name>Task 1: TranslationSource singleton + EN/FR resx files</name>
|
||||
<files>
|
||||
SharepointToolbox/Localization/TranslationSource.cs,
|
||||
SharepointToolbox/Localization/Strings.resx,
|
||||
SharepointToolbox/Localization/Strings.fr.resx,
|
||||
SharepointToolbox.Tests/Localization/TranslationSourceTests.cs
|
||||
</files>
|
||||
<behavior>
|
||||
- Test: TranslationSource.Instance["app.title"] returns "SharePoint Toolbox" (EN default)
|
||||
- Test: After setting CurrentCulture to fr-FR, TranslationSource.Instance["app.title"] returns FR value (or EN fallback if FR not defined)
|
||||
- Test: Changing CurrentCulture fires PropertyChanged with EventArgs having empty string PropertyName
|
||||
- Test: Setting same culture twice does NOT fire PropertyChanged (equality check)
|
||||
- Test: Missing key returns "[key]" not null (prevents NullReferenceException in bindings)
|
||||
- Test: TranslationSource.Instance is same instance on multiple accesses (singleton)
|
||||
</behavior>
|
||||
<action>
|
||||
Create `Localization/` directory.
|
||||
|
||||
**TranslationSource.cs** — implement exactly as per research Pattern 4:
|
||||
```csharp
|
||||
namespace SharepointToolbox.Localization;
|
||||
|
||||
public class TranslationSource : INotifyPropertyChanged
|
||||
{
|
||||
public static readonly TranslationSource Instance = new();
|
||||
private ResourceManager _resourceManager = Strings.ResourceManager;
|
||||
private CultureInfo _currentCulture = CultureInfo.CurrentUICulture;
|
||||
|
||||
public string this[string key] =>
|
||||
_resourceManager.GetString(key, _currentCulture) ?? $"[{key}]";
|
||||
|
||||
public CultureInfo CurrentCulture
|
||||
{
|
||||
get => _currentCulture;
|
||||
set
|
||||
{
|
||||
if (Equals(_currentCulture, value)) return;
|
||||
_currentCulture = value;
|
||||
Thread.CurrentThread.CurrentUICulture = value;
|
||||
PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(string.Empty));
|
||||
}
|
||||
}
|
||||
|
||||
public event PropertyChangedEventHandler? PropertyChanged;
|
||||
}
|
||||
```
|
||||
|
||||
**Strings.resx** — Create with ResXResourceWriter or manually as XML. Include ALL Phase 1 UI strings. Key naming mirrors existing PowerShell convention (see CONTEXT.md).
|
||||
|
||||
Required keys (minimum set for Phase 1 — add more as needed during shell implementation):
|
||||
```
|
||||
app.title = SharePoint Toolbox
|
||||
toolbar.connect = Connect
|
||||
toolbar.manage = Manage Profiles...
|
||||
toolbar.clear = Clear Session
|
||||
tab.permissions = Permissions
|
||||
tab.storage = Storage
|
||||
tab.search = File Search
|
||||
tab.duplicates = Duplicates
|
||||
tab.templates = Templates
|
||||
tab.bulk = Bulk Operations
|
||||
tab.structure = Folder Structure
|
||||
tab.settings = Settings
|
||||
tab.comingsoon = Coming soon
|
||||
btn.cancel = Cancel
|
||||
settings.language = Language
|
||||
settings.lang.en = English
|
||||
settings.lang.fr = French
|
||||
settings.folder = Data output folder
|
||||
settings.browse = Browse...
|
||||
profile.name = Profile name
|
||||
profile.url = Tenant URL
|
||||
profile.clientid = Client ID
|
||||
profile.add = Add
|
||||
profile.rename = Rename
|
||||
profile.delete = Delete
|
||||
status.ready = Ready
|
||||
status.cancelled = Operation cancelled
|
||||
err.auth.failed = Authentication failed. Check tenant URL and Client ID.
|
||||
err.generic = An error occurred. See log for details.
|
||||
```
|
||||
|
||||
**Strings.fr.resx** — All same keys, values stubbed with EN text. A comment `<!-- FR stub — Phase 5 -->` on each value is acceptable. FR completeness is Phase 5.
|
||||
|
||||
**TranslationSourceTests.cs** — Replace stub with real tests.
|
||||
All tests in `[Trait("Category", "Unit")]`.
|
||||
TranslationSource.Instance is a static singleton — reset culture to EN in test teardown to avoid test pollution.
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd "C:\Users\dev\Documents\projets\Sharepoint" && dotnet test SharepointToolbox.Tests/SharepointToolbox.Tests.csproj --filter "FullyQualifiedName~TranslationSourceTests" 2>&1 | tail -10</automated>
|
||||
</verify>
|
||||
<done>TranslationSourceTests pass. Missing key returns "[key]". Culture switch fires PropertyChanged with empty property name. Strings.resx contains all required keys.</done>
|
||||
</task>
|
||||
|
||||
<task type="auto">
|
||||
<name>Task 2: Serilog integration tests and App.xaml.cs logging wiring verification</name>
|
||||
<files>
|
||||
SharepointToolbox.Tests/Integration/LoggingIntegrationTests.cs
|
||||
</files>
|
||||
<action>
|
||||
The Serilog file sink is already wired in App.xaml.cs (plan 01-01). This task writes an integration test to verify the wiring produces an actual log file and that the LogPanelSink (from plan 01-02) can be instantiated without errors.
|
||||
|
||||
**LoggingIntegrationTests.cs** — Replace stub:
|
||||
```csharp
|
||||
[Trait("Category", "Integration")]
|
||||
public class LoggingIntegrationTests : IDisposable
|
||||
{
|
||||
private readonly string _tempLogDir = Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString());
|
||||
|
||||
[Fact]
|
||||
public async Task Serilog_WritesLogFile_WhenMessageLogged()
|
||||
{
|
||||
Directory.CreateDirectory(_tempLogDir);
|
||||
var logFile = Path.Combine(_tempLogDir, "test-.log");
|
||||
|
||||
var logger = new LoggerConfiguration()
|
||||
.WriteTo.File(logFile, rollingInterval: RollingInterval.Day)
|
||||
.CreateLogger();
|
||||
|
||||
logger.Information("Test log message {Value}", 42);
|
||||
await logger.DisposeAsync();
|
||||
|
||||
var files = Directory.GetFiles(_tempLogDir, "*.log");
|
||||
Assert.Single(files);
|
||||
var content = await File.ReadAllTextAsync(files[0]);
|
||||
Assert.Contains("Test log message 42", content);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void LogPanelSink_CanBeInstantiated_WithRichTextBox()
|
||||
{
|
||||
// Verify the sink type instantiates without throwing
|
||||
// Cannot test actual UI writes without STA thread — this is structural smoke only
|
||||
var sinkType = typeof(LogPanelSink);
|
||||
Assert.NotNull(sinkType);
|
||||
Assert.True(typeof(ILogEventSink).IsAssignableFrom(sinkType));
|
||||
}
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
if (Directory.Exists(_tempLogDir))
|
||||
Directory.Delete(_tempLogDir, recursive: true);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Note: `LogPanelSink` instantiation test avoids creating a real `RichTextBox` (requires STA thread). It only verifies the type implements `ILogEventSink`. Full UI-thread integration is verified in the manual checkpoint (plan 01-08).
|
||||
|
||||
Also update `App.xaml.cs` RegisterServices to add `LogPanelSink` registration comment for plan 01-06:
|
||||
```csharp
|
||||
// LogPanelSink registered in plan 01-06 after MainWindow is created
|
||||
// (requires RichTextBox reference from MainWindow)
|
||||
```
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd "C:\Users\dev\Documents\projets\Sharepoint" && dotnet test SharepointToolbox.Tests/SharepointToolbox.Tests.csproj --filter "FullyQualifiedName~LoggingIntegrationTests" 2>&1 | tail -10</automated>
|
||||
</verify>
|
||||
<done>LoggingIntegrationTests pass. Log file created in temp directory with expected content. LogPanelSink type check passes.</done>
|
||||
</task>
|
||||
|
||||
</tasks>
|
||||
|
||||
<verification>
|
||||
- `dotnet test --filter "Category=Unit"` and `--filter "Category=Integration"` both pass
|
||||
- Strings.resx contains all keys listed in the action section
|
||||
- Strings.fr.resx contains same key set (verified by comparing key counts)
|
||||
- TranslationSource.Instance is not null
|
||||
- PropertyChanged fires with `string.Empty` PropertyName on culture change
|
||||
</verification>
|
||||
|
||||
<success_criteria>
|
||||
Localization system supports runtime culture switching confirmed by tests. All Phase 1 UI strings defined in EN resx. FR resx has same key set (stubbed). Serilog integration test verifies log file creation.
|
||||
</success_criteria>
|
||||
|
||||
<output>
|
||||
After completion, create `.planning/phases/01-foundation/01-05-SUMMARY.md`
|
||||
</output>
|
||||
167
.planning/milestones/v1.0-phases/01-foundation/01-05-SUMMARY.md
Normal file
167
.planning/milestones/v1.0-phases/01-foundation/01-05-SUMMARY.md
Normal file
@@ -0,0 +1,167 @@
|
||||
---
|
||||
phase: 01-foundation
|
||||
plan: 05
|
||||
subsystem: localization
|
||||
tags: [wpf, dotnet10, serilog, localization, resx, i18n, csharp, tdd]
|
||||
|
||||
# Dependency graph
|
||||
requires:
|
||||
- 01-02 (LogPanelSink, LanguageChangedMessage)
|
||||
provides:
|
||||
- TranslationSource singleton with INotifyPropertyChanged indexer for runtime culture switching
|
||||
- Strings.resx with 27 Phase 1 EN UI strings
|
||||
- Strings.fr.resx with same 27 keys stubbed for Phase 5 FR translation
|
||||
- LoggingIntegrationTests verifying Serilog rolling file sink and LogPanelSink type
|
||||
affects:
|
||||
- 01-06 (MainWindow.xaml binds via TranslationSource.Instance[key])
|
||||
- 01-07 (SettingsViewModel sets TranslationSource.Instance.CurrentCulture)
|
||||
- 02-xx (all feature views use localized strings via TranslationSource)
|
||||
|
||||
# Tech tracking
|
||||
tech-stack:
|
||||
added: []
|
||||
patterns:
|
||||
- TranslationSource singleton with INotifyPropertyChanged empty-string key (signals all bindings refresh)
|
||||
- WPF binding: Source={x:Static loc:TranslationSource.Instance}, Path=[key]
|
||||
- ResourceManager from Strings.Designer.cs — manually maintained for dotnet build (no ResXFileCodeGenerator at build time)
|
||||
- EmbeddedResource Update (not Include) in SDK-style project — avoids NETSDK1022 duplicate error
|
||||
- IDisposable test teardown with TranslationSource culture reset — prevents test pollution
|
||||
|
||||
key-files:
|
||||
created:
|
||||
- SharepointToolbox/Localization/TranslationSource.cs
|
||||
- SharepointToolbox/Localization/Strings.resx
|
||||
- SharepointToolbox/Localization/Strings.fr.resx
|
||||
- SharepointToolbox/Localization/Strings.Designer.cs
|
||||
modified:
|
||||
- SharepointToolbox/SharepointToolbox.csproj
|
||||
- SharepointToolbox/App.xaml.cs
|
||||
- SharepointToolbox.Tests/Localization/TranslationSourceTests.cs
|
||||
- SharepointToolbox.Tests/Integration/LoggingIntegrationTests.cs
|
||||
|
||||
key-decisions:
|
||||
- "Strings.Designer.cs is maintained manually — ResXFileCodeGenerator is a VS-only tool; dotnet build requires the designer file to pre-exist; only the ResourceManager accessor is needed (no per-key typed properties)"
|
||||
- "EmbeddedResource uses Update not Include — SDK-style projects auto-include all .resx as EmbeddedResource; using Include causes NETSDK1022 duplicate error"
|
||||
- "System.IO using added explicitly in test project — xunit test project implicit usings do not cover System.IO; consistent with existing pattern in main project"
|
||||
|
||||
requirements-completed:
|
||||
- FOUND-08
|
||||
- FOUND-09
|
||||
|
||||
# Metrics
|
||||
duration: 4min
|
||||
completed: 2026-04-02
|
||||
---
|
||||
|
||||
# Phase 1 Plan 05: Logging Infrastructure and Dynamic Localization Summary
|
||||
|
||||
**TranslationSource singleton + EN/FR resx + Serilog integration tests — 26 tests pass (24 Unit, 2 Integration), 0 errors, 0 warnings**
|
||||
|
||||
## Performance
|
||||
|
||||
- **Duration:** 4 min
|
||||
- **Started:** 2026-04-02T10:14:23Z
|
||||
- **Completed:** 2026-04-02T10:18:08Z
|
||||
- **Tasks:** 2
|
||||
- **Files modified:** 8
|
||||
|
||||
## Accomplishments
|
||||
|
||||
- TranslationSource singleton implements INotifyPropertyChanged; indexer `[key]` uses ResourceManager for runtime culture switching without restart
|
||||
- PropertyChanged fires with `string.Empty` PropertyName on culture change — WPF re-evaluates all bindings to TranslationSource.Instance
|
||||
- Missing key returns `[key]` placeholder — prevents NullReferenceException in WPF bindings
|
||||
- Same-culture assignment is no-op — equality check prevents spurious PropertyChanged events
|
||||
- Strings.resx: 27 Phase 1 UI strings (EN): app, toolbar, tab, button, settings, profile, status, and error keys
|
||||
- Strings.fr.resx: same 27 keys, EN values stubbed, marked `<!-- FR stub — Phase 5 -->`
|
||||
- Strings.Designer.cs: ResourceManager accessor for dotnet build compatibility (no VS ResXFileCodeGenerator dependency)
|
||||
- LoggingIntegrationTests: verifies Serilog creates a rolling log file and writes message content; verifies LogPanelSink implements ILogEventSink
|
||||
- App.xaml.cs: comment added documenting deferred LogPanelSink DI registration (plan 01-06)
|
||||
|
||||
## Task Commits
|
||||
|
||||
1. **Task 1 RED: Failing tests for TranslationSource** - `8a58140` (test)
|
||||
2. **Task 1 GREEN: TranslationSource + resx files implementation** - `a287ed8` (feat)
|
||||
3. **Task 2: Serilog integration tests + App.xaml.cs comment** - `1c532d1` (feat)
|
||||
|
||||
## Files Created/Modified
|
||||
|
||||
- `SharepointToolbox/Localization/TranslationSource.cs` — Singleton; INotifyPropertyChanged indexer; empty-string PropertyChanged; culture equality guard
|
||||
- `SharepointToolbox/Localization/Strings.resx` — 27 Phase 1 EN string resources
|
||||
- `SharepointToolbox/Localization/Strings.fr.resx` — 27 keys stubbed with EN values; Phase 5 FR completion
|
||||
- `SharepointToolbox/Localization/Strings.Designer.cs` — ResourceManager accessor; manually maintained for dotnet build
|
||||
- `SharepointToolbox/SharepointToolbox.csproj` — EmbeddedResource Update metadata for resx files
|
||||
- `SharepointToolbox/App.xaml.cs` — LogPanelSink registration comment deferred to plan 01-06
|
||||
- `SharepointToolbox.Tests/Localization/TranslationSourceTests.cs` — 6 unit tests; IDisposable teardown for culture reset
|
||||
- `SharepointToolbox.Tests/Integration/LoggingIntegrationTests.cs` — 2 integration tests; temp dir cleanup in Dispose
|
||||
|
||||
## Decisions Made
|
||||
|
||||
- Strings.Designer.cs maintained manually: `ResXFileCodeGenerator` is a Visual Studio design-time tool not available in `dotnet build`. The designer file only needs the `ResourceManager` property accessor — no per-key typed properties are needed since TranslationSource uses `ResourceManager.GetString(key, culture)` directly.
|
||||
- `EmbeddedResource Update` instead of `Include`: SDK-style projects implicitly include all `.resx` files as `EmbeddedResource`. Using `Include` causes `NETSDK1022` duplicate build error. `Update` sets metadata on the already-included item.
|
||||
- Explicit `System.IO` using in test file: test project implicit usings do not cover `System.IO`; consistent with the established pattern for the main project (prior decision FOUND-10).
|
||||
|
||||
## Deviations from Plan
|
||||
|
||||
### Auto-fixed Issues
|
||||
|
||||
**1. [Rule 3 - Blocking] Added explicit System.IO using to LoggingIntegrationTests.cs**
|
||||
- **Found during:** Task 2 (dotnet build)
|
||||
- **Issue:** CS0103 — `Path`, `Directory`, `File` not found; test project implicit usings do not include System.IO
|
||||
- **Fix:** Added `using System.IO;` to the test file
|
||||
- **Files modified:** `SharepointToolbox.Tests/Integration/LoggingIntegrationTests.cs`
|
||||
- **Verification:** Build 0 errors, 0 warnings after fix
|
||||
- **Committed in:** 1c532d1 (Task 2 commit)
|
||||
|
||||
**2. [Rule 3 - Blocking] Used EmbeddedResource Update (not Include) for resx metadata**
|
||||
- **Found during:** Task 1 GREEN (dotnet build)
|
||||
- **Issue:** NETSDK1022 duplicate EmbeddedResource — SDK auto-includes all .resx files; explicit Include causes duplicate error
|
||||
- **Fix:** Changed `<EmbeddedResource Include=...>` to `<EmbeddedResource Update=...>` in SharepointToolbox.csproj
|
||||
- **Files modified:** `SharepointToolbox/SharepointToolbox.csproj`
|
||||
- **Verification:** Build 0 errors, 0 warnings after fix
|
||||
- **Committed in:** a287ed8 (Task 1 commit)
|
||||
|
||||
**3. [Rule 3 - Blocking] Created Strings.Designer.cs manually**
|
||||
- **Found during:** Task 1 GREEN (dotnet build)
|
||||
- **Issue:** `Strings` class does not exist in context — ResXFileCodeGenerator is VS-only, not run by dotnet build CLI
|
||||
- **Fix:** Created Strings.Designer.cs with ResourceManager accessor manually; only the `ResourceManager` property is needed (TranslationSource uses it directly)
|
||||
- **Files modified:** `SharepointToolbox/Localization/Strings.Designer.cs`
|
||||
- **Verification:** Build 0 errors after fix; TranslationSourceTests pass
|
||||
- **Committed in:** a287ed8 (Task 1 commit)
|
||||
|
||||
---
|
||||
|
||||
**Total deviations:** 3 auto-fixed (all Rule 3 — blocking build issues)
|
||||
**Impact on plan:** All fixes minor; no scope creep; no behavior change from plan intent.
|
||||
|
||||
## Issues Encountered
|
||||
|
||||
None beyond the auto-fixed deviations above.
|
||||
|
||||
## User Setup Required
|
||||
|
||||
None — no external service configuration required.
|
||||
|
||||
## Next Phase Readiness
|
||||
|
||||
- TranslationSource.Instance ready for WPF XAML binding in plan 01-06 (MainWindow)
|
||||
- All 27 Phase 1 UI string keys defined in EN resx
|
||||
- FR resx keyset matches EN — Phase 5 can add translations without key changes
|
||||
- Serilog rolling file sink verified working; LogPanelSink type verified ILogEventSink-compatible
|
||||
- Plan 01-06 can proceed immediately
|
||||
|
||||
## Self-Check: PASSED
|
||||
|
||||
- FOUND: SharepointToolbox/Localization/TranslationSource.cs
|
||||
- FOUND: SharepointToolbox/Localization/Strings.resx
|
||||
- FOUND: SharepointToolbox/Localization/Strings.fr.resx
|
||||
- FOUND: SharepointToolbox/Localization/Strings.Designer.cs
|
||||
- FOUND: SharepointToolbox.Tests/Localization/TranslationSourceTests.cs
|
||||
- FOUND: SharepointToolbox.Tests/Integration/LoggingIntegrationTests.cs
|
||||
- FOUND: .planning/phases/01-foundation/01-05-SUMMARY.md
|
||||
- Commit 8a58140: test(01-05): add failing tests for TranslationSource singleton
|
||||
- Commit a287ed8: feat(01-05): implement TranslationSource singleton + EN/FR resx files
|
||||
- Commit 1c532d1: feat(01-05): add Serilog integration tests and App.xaml.cs LogPanelSink comment
|
||||
|
||||
---
|
||||
*Phase: 01-foundation*
|
||||
*Completed: 2026-04-02*
|
||||
515
.planning/milestones/v1.0-phases/01-foundation/01-06-PLAN.md
Normal file
515
.planning/milestones/v1.0-phases/01-foundation/01-06-PLAN.md
Normal file
@@ -0,0 +1,515 @@
|
||||
---
|
||||
phase: 01-foundation
|
||||
plan: 06
|
||||
type: execute
|
||||
wave: 5
|
||||
depends_on:
|
||||
- 01-03
|
||||
- 01-04
|
||||
- 01-05
|
||||
files_modified:
|
||||
- SharepointToolbox/Core/Messages/ProgressUpdatedMessage.cs
|
||||
- SharepointToolbox/ViewModels/FeatureViewModelBase.cs
|
||||
- SharepointToolbox/ViewModels/MainWindowViewModel.cs
|
||||
- SharepointToolbox/ViewModels/ProfileManagementViewModel.cs
|
||||
- SharepointToolbox/ViewModels/Tabs/SettingsViewModel.cs
|
||||
- SharepointToolbox/Views/Controls/FeatureTabBase.xaml
|
||||
- SharepointToolbox/Views/Controls/FeatureTabBase.xaml.cs
|
||||
- SharepointToolbox/Views/MainWindow.xaml
|
||||
- SharepointToolbox/Views/MainWindow.xaml.cs
|
||||
- SharepointToolbox/App.xaml.cs
|
||||
- SharepointToolbox.Tests/ViewModels/FeatureViewModelBaseTests.cs
|
||||
autonomous: true
|
||||
requirements:
|
||||
- FOUND-01
|
||||
- FOUND-05
|
||||
- FOUND-06
|
||||
- FOUND-07
|
||||
must_haves:
|
||||
truths:
|
||||
- "MainWindow displays: top toolbar, center TabControl with 8 feature tabs, bottom RichTextBox log panel (150px), bottom StatusBar"
|
||||
- "Toolbar ComboBox bound to TenantProfiles ObservableCollection; selecting a different item triggers TenantSwitchedMessage"
|
||||
- "FeatureViewModelBase provides CancellationTokenSource lifecycle, IsRunning, IProgress<OperationProgress>, OperationCanceledException handling"
|
||||
- "Global exception handlers (DispatcherUnhandledException + TaskScheduler.UnobservedTaskException) funnel to log panel + MessageBox"
|
||||
- "LogPanelSink wired to MainWindow RichTextBox after Generic Host starts"
|
||||
- "FeatureViewModelBaseTests: progress reporting, cancellation, and error handling all green"
|
||||
- "All 7 stub feature tabs use FeatureTabBase UserControl — ProgressBar + TextBlock + Cancel button shown only when IsRunning"
|
||||
- "StatusBar middle item shows live operation status text (ProgressStatus from ProgressUpdatedMessage), not static ConnectionStatus"
|
||||
artifacts:
|
||||
- path: "SharepointToolbox/ViewModels/FeatureViewModelBase.cs"
|
||||
provides: "Base class for all feature ViewModels with canonical async command pattern"
|
||||
contains: "CancellationTokenSource"
|
||||
- path: "SharepointToolbox/ViewModels/MainWindowViewModel.cs"
|
||||
provides: "Shell ViewModel with TenantProfiles and connection state"
|
||||
contains: "ObservableCollection"
|
||||
- path: "SharepointToolbox/Views/Controls/FeatureTabBase.xaml"
|
||||
provides: "Reusable UserControl with ProgressBar + TextBlock + Cancel button strip"
|
||||
contains: "ProgressBar"
|
||||
- path: "SharepointToolbox/Views/MainWindow.xaml"
|
||||
provides: "WPF shell with toolbar, TabControl, log panel, StatusBar"
|
||||
contains: "RichTextBox"
|
||||
key_links:
|
||||
- from: "SharepointToolbox/Views/MainWindow.xaml"
|
||||
to: "SharepointToolbox/ViewModels/MainWindowViewModel.cs"
|
||||
via: "DataContext binding in MainWindow.xaml.cs constructor"
|
||||
pattern: "DataContext"
|
||||
- from: "SharepointToolbox/App.xaml.cs"
|
||||
to: "SharepointToolbox/Infrastructure/Logging/LogPanelSink.cs"
|
||||
via: "LoggerConfiguration.WriteTo.Sink(new LogPanelSink(mainWindow.LogPanel))"
|
||||
pattern: "LogPanelSink"
|
||||
- from: "SharepointToolbox/ViewModels/MainWindowViewModel.cs"
|
||||
to: "SharepointToolbox/Core/Messages/TenantSwitchedMessage.cs"
|
||||
via: "WeakReferenceMessenger.Default.Send on ComboBox selection change"
|
||||
pattern: "TenantSwitchedMessage"
|
||||
- from: "SharepointToolbox/ViewModels/MainWindowViewModel.cs"
|
||||
to: "SharepointToolbox/Core/Messages/ProgressUpdatedMessage.cs"
|
||||
via: "Messenger.Register<ProgressUpdatedMessage> in OnActivated — updates ProgressStatus + ProgressPercentage"
|
||||
pattern: "ProgressUpdatedMessage"
|
||||
- from: "SharepointToolbox/Views/MainWindow.xaml StatusBar middle item"
|
||||
to: "SharepointToolbox/ViewModels/MainWindowViewModel.cs ProgressStatus"
|
||||
via: "Binding Content={Binding ProgressStatus}"
|
||||
pattern: "ProgressStatus"
|
||||
- from: "SharepointToolbox/Views/MainWindow.xaml stub TabItems"
|
||||
to: "SharepointToolbox/Views/Controls/FeatureTabBase.xaml"
|
||||
via: "TabItem Content contains <controls:FeatureTabBase />"
|
||||
pattern: "FeatureTabBase"
|
||||
---
|
||||
|
||||
<objective>
|
||||
Build the WPF shell — MainWindow XAML + all ViewModels. Wire LogPanelSink to the RichTextBox. Implement FeatureViewModelBase with the canonical async pattern. Create FeatureTabBase UserControl (per-tab progress/cancel strip). Register global exception handlers.
|
||||
|
||||
Purpose: This is the first time the application visually exists. All subsequent feature plans add TabItems to the already-wired TabControl. FeatureTabBase gives Phase 2+ a XAML template to extend rather than stub TextBlocks.
|
||||
Output: Runnable WPF application showing the shell with placeholder tabs (using FeatureTabBase), log panel, and status bar with live operation text.
|
||||
</objective>
|
||||
|
||||
<execution_context>
|
||||
@C:/Users/SebastienQUEROL/.claude/get-shit-done/workflows/execute-plan.md
|
||||
@C:/Users/SebastienQUEROL/.claude/get-shit-done/templates/summary.md
|
||||
</execution_context>
|
||||
|
||||
<context>
|
||||
@.planning/PROJECT.md
|
||||
@.planning/phases/01-foundation/01-CONTEXT.md
|
||||
@.planning/phases/01-foundation/01-RESEARCH.md
|
||||
@.planning/phases/01-foundation/01-03-SUMMARY.md
|
||||
@.planning/phases/01-foundation/01-04-SUMMARY.md
|
||||
@.planning/phases/01-foundation/01-05-SUMMARY.md
|
||||
|
||||
<interfaces>
|
||||
<!-- From Core/Models (plan 01-02) -->
|
||||
```csharp
|
||||
public class TenantProfile { string Name; string TenantUrl; string ClientId; }
|
||||
public record OperationProgress(int Current, int Total, string Message)
|
||||
```
|
||||
|
||||
<!-- From Core/Messages (plan 01-02) -->
|
||||
```csharp
|
||||
public sealed class TenantSwitchedMessage : ValueChangedMessage<TenantProfile>
|
||||
public sealed class LanguageChangedMessage : ValueChangedMessage<string>
|
||||
```
|
||||
|
||||
<!-- From Services (plans 01-03, 01-04) -->
|
||||
```csharp
|
||||
// ProfileService: GetProfilesAsync(), AddProfileAsync(), RenameProfileAsync(), DeleteProfileAsync()
|
||||
// SessionManager: IsAuthenticated(url), GetOrCreateContextAsync(profile, ct), ClearSessionAsync(url)
|
||||
// SettingsService: GetSettingsAsync(), SetLanguageAsync(code), SetDataFolderAsync(path)
|
||||
```
|
||||
|
||||
<!-- From Localization (plan 01-05) -->
|
||||
```csharp
|
||||
// TranslationSource.Instance[key] — binding: Source={x:Static loc:TranslationSource.Instance}, Path=[key]
|
||||
```
|
||||
|
||||
<!-- Shell layout (locked in CONTEXT.md) -->
|
||||
// Toolbar (L→R): ComboBox (220px) → Button "Connect" → Button "Manage Profiles..." → separator → Button "Clear Session"
|
||||
// TabControl: 8 tabs (Permissions, Storage, File Search, Duplicates, Templates, Bulk Operations, Folder Structure, Settings)
|
||||
// Log panel: RichTextBox, 150px tall, always visible, x:Name="LogPanel"
|
||||
// StatusBar: tenant name | operation status text | progress %
|
||||
// Per-tab layout: ProgressBar + TextBlock + Button "Cancel" — shown only when IsRunning (CONTEXT.md Gray Areas, locked)
|
||||
</interfaces>
|
||||
</context>
|
||||
|
||||
<tasks>
|
||||
|
||||
<task type="auto" tdd="true">
|
||||
<name>Task 1: FeatureViewModelBase + unit tests</name>
|
||||
<files>
|
||||
SharepointToolbox/Core/Messages/ProgressUpdatedMessage.cs,
|
||||
SharepointToolbox/ViewModels/FeatureViewModelBase.cs,
|
||||
SharepointToolbox.Tests/ViewModels/FeatureViewModelBaseTests.cs
|
||||
</files>
|
||||
<behavior>
|
||||
- Test: IsRunning is true while operation executes, false after completion
|
||||
- Test: ProgressValue and StatusMessage update via IProgress<OperationProgress> on UI thread
|
||||
- Test: Calling CancelCommand during operation causes StatusMessage to show cancellation message
|
||||
- Test: OperationCanceledException is caught gracefully — IsRunning becomes false, no exception propagates
|
||||
- Test: Exception during operation sets StatusMessage to error text — IsRunning becomes false
|
||||
- Test: RunCommand cannot be invoked while IsRunning (CanExecute returns false)
|
||||
</behavior>
|
||||
<action>
|
||||
Create `ViewModels/` directory.
|
||||
|
||||
**FeatureViewModelBase.cs** — implement exactly as per research Pattern 2:
|
||||
```csharp
|
||||
namespace SharepointToolbox.ViewModels;
|
||||
|
||||
public abstract class FeatureViewModelBase : ObservableRecipient
|
||||
{
|
||||
private CancellationTokenSource? _cts;
|
||||
private readonly ILogger<FeatureViewModelBase> _logger;
|
||||
|
||||
[ObservableProperty]
|
||||
[NotifyCanExecuteChangedFor(nameof(CancelCommand))]
|
||||
private bool _isRunning;
|
||||
|
||||
[ObservableProperty]
|
||||
private string _statusMessage = string.Empty;
|
||||
|
||||
[ObservableProperty]
|
||||
private int _progressValue;
|
||||
|
||||
public IAsyncRelayCommand RunCommand { get; }
|
||||
public RelayCommand CancelCommand { get; }
|
||||
|
||||
protected FeatureViewModelBase(ILogger<FeatureViewModelBase> logger)
|
||||
{
|
||||
_logger = logger;
|
||||
RunCommand = new AsyncRelayCommand(ExecuteAsync, () => !IsRunning);
|
||||
CancelCommand = new RelayCommand(() => _cts?.Cancel(), () => IsRunning);
|
||||
IsActive = true; // Activates ObservableRecipient for WeakReferenceMessenger
|
||||
}
|
||||
|
||||
private async Task ExecuteAsync()
|
||||
{
|
||||
_cts = new CancellationTokenSource();
|
||||
IsRunning = true;
|
||||
StatusMessage = string.Empty;
|
||||
ProgressValue = 0;
|
||||
try
|
||||
{
|
||||
var progress = new Progress<OperationProgress>(p =>
|
||||
{
|
||||
ProgressValue = p.Total > 0 ? (int)(100.0 * p.Current / p.Total) : 0;
|
||||
StatusMessage = p.Message;
|
||||
WeakReferenceMessenger.Default.Send(new ProgressUpdatedMessage(p));
|
||||
});
|
||||
await RunOperationAsync(_cts.Token, progress);
|
||||
}
|
||||
catch (OperationCanceledException)
|
||||
{
|
||||
StatusMessage = TranslationSource.Instance["status.cancelled"];
|
||||
_logger.LogInformation("Operation cancelled by user.");
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
StatusMessage = $"{TranslationSource.Instance["err.generic"]} {ex.Message}";
|
||||
_logger.LogError(ex, "Operation failed.");
|
||||
}
|
||||
finally
|
||||
{
|
||||
IsRunning = false;
|
||||
_cts?.Dispose();
|
||||
_cts = null;
|
||||
}
|
||||
}
|
||||
|
||||
protected abstract Task RunOperationAsync(CancellationToken ct, IProgress<OperationProgress> progress);
|
||||
|
||||
protected override void OnActivated()
|
||||
{
|
||||
Messenger.Register<TenantSwitchedMessage>(this, (r, m) => r.OnTenantSwitched(m.Value));
|
||||
}
|
||||
|
||||
protected virtual void OnTenantSwitched(TenantProfile profile)
|
||||
{
|
||||
// Derived classes override to reset their state
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Also create `Core/Messages/ProgressUpdatedMessage.cs` (needed for StatusBar update):
|
||||
```csharp
|
||||
public sealed class ProgressUpdatedMessage : ValueChangedMessage<OperationProgress>
|
||||
{
|
||||
public ProgressUpdatedMessage(OperationProgress progress) : base(progress) { }
|
||||
}
|
||||
```
|
||||
|
||||
**FeatureViewModelBaseTests.cs** — Replace stub. Use a concrete test subclass:
|
||||
```csharp
|
||||
private class TestViewModel : FeatureViewModelBase
|
||||
{
|
||||
public TestViewModel(ILogger<FeatureViewModelBase> logger) : base(logger) { }
|
||||
public Func<CancellationToken, IProgress<OperationProgress>, Task>? OperationFunc { get; set; }
|
||||
protected override Task RunOperationAsync(CancellationToken ct, IProgress<OperationProgress> p)
|
||||
=> OperationFunc?.Invoke(ct, p) ?? Task.CompletedTask;
|
||||
}
|
||||
```
|
||||
All tests in `[Trait("Category", "Unit")]`.
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd "C:\Users\dev\Documents\projets\Sharepoint" && dotnet test SharepointToolbox.Tests/SharepointToolbox.Tests.csproj --filter "FullyQualifiedName~FeatureViewModelBaseTests" 2>&1 | tail -10</automated>
|
||||
</verify>
|
||||
<done>All FeatureViewModelBaseTests pass. IsRunning lifecycle correct. Cancellation handled gracefully. Exception caught with error message set.</done>
|
||||
</task>
|
||||
|
||||
<task type="auto">
|
||||
<name>Task 2: FeatureTabBase UserControl, MainWindowViewModel, shell ViewModels, and MainWindow XAML</name>
|
||||
<files>
|
||||
SharepointToolbox/Views/Controls/FeatureTabBase.xaml,
|
||||
SharepointToolbox/Views/Controls/FeatureTabBase.xaml.cs,
|
||||
SharepointToolbox/ViewModels/MainWindowViewModel.cs,
|
||||
SharepointToolbox/ViewModels/ProfileManagementViewModel.cs,
|
||||
SharepointToolbox/ViewModels/Tabs/SettingsViewModel.cs,
|
||||
SharepointToolbox/Views/MainWindow.xaml,
|
||||
SharepointToolbox/Views/MainWindow.xaml.cs,
|
||||
SharepointToolbox/App.xaml.cs
|
||||
</files>
|
||||
<action>
|
||||
Create `Views/Controls/`, `ViewModels/Tabs/`, and `Views/` directories.
|
||||
|
||||
**FeatureTabBase.xaml** — UserControl that every stub feature tab uses as its Content.
|
||||
This gives Phase 2+ a concrete XAML template to replace rather than a bare TextBlock.
|
||||
The progress/cancel strip is Visibility-bound to IsRunning per the locked CONTEXT.md decision.
|
||||
|
||||
```xml
|
||||
<UserControl x:Class="SharepointToolbox.Views.Controls.FeatureTabBase"
|
||||
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
|
||||
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
|
||||
<Grid>
|
||||
<Grid.RowDefinitions>
|
||||
<RowDefinition Height="*" /> <!-- Feature content area (Phase 2+ replaces this) -->
|
||||
<RowDefinition Height="Auto" /> <!-- Progress/cancel strip -->
|
||||
</Grid.RowDefinitions>
|
||||
|
||||
<!-- Placeholder content — Phase 2+ replaces Row 0 -->
|
||||
<TextBlock Grid.Row="0"
|
||||
Text="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[tab.comingsoon]}"
|
||||
HorizontalAlignment="Center" VerticalAlignment="Center" />
|
||||
|
||||
<!-- Per-tab progress/cancel strip (locked CONTEXT.md: shown only when IsRunning) -->
|
||||
<Grid Grid.Row="1" Margin="8,4"
|
||||
Visibility="{Binding IsRunning, Converter={StaticResource BoolToVisibilityConverter}}">
|
||||
<Grid.ColumnDefinitions>
|
||||
<ColumnDefinition Width="*" />
|
||||
<ColumnDefinition Width="Auto" />
|
||||
<ColumnDefinition Width="Auto" />
|
||||
</Grid.ColumnDefinitions>
|
||||
<ProgressBar Grid.Column="0" Height="16" Minimum="0" Maximum="100"
|
||||
Value="{Binding ProgressValue}" />
|
||||
<TextBlock Grid.Column="1" Margin="8,0" VerticalAlignment="Center"
|
||||
Text="{Binding StatusMessage}" />
|
||||
<Button Grid.Column="2"
|
||||
Content="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[btn.cancel]}"
|
||||
Command="{Binding CancelCommand}" Width="70" />
|
||||
</Grid>
|
||||
</Grid>
|
||||
</UserControl>
|
||||
```
|
||||
|
||||
**FeatureTabBase.xaml.cs**: Standard code-behind with no extra logic (DataContext is set by the parent TabItem's DataContext chain).
|
||||
|
||||
Add `BoolToVisibilityConverter` to App.xaml resources if not already present:
|
||||
```xml
|
||||
<BooleanToVisibilityConverter x:Key="BoolToVisibilityConverter" />
|
||||
```
|
||||
|
||||
**MainWindowViewModel.cs**:
|
||||
```csharp
|
||||
[ObservableProperty] private TenantProfile? _selectedProfile;
|
||||
[ObservableProperty] private string _connectionStatus = "Not connected";
|
||||
[ObservableProperty] private string _progressStatus = string.Empty;
|
||||
[ObservableProperty] private int _progressPercentage;
|
||||
public ObservableCollection<TenantProfile> TenantProfiles { get; } = new();
|
||||
|
||||
// ConnectCommand: calls SessionManager.GetOrCreateContextAsync(SelectedProfile)
|
||||
// ClearSessionCommand: calls SessionManager.ClearSessionAsync(SelectedProfile.TenantUrl)
|
||||
// ManageProfilesCommand: opens ProfileManagementDialog as modal
|
||||
// OnSelectedProfileChanged (partial): sends TenantSwitchedMessage via WeakReferenceMessenger
|
||||
// LoadProfilesAsync: called on startup, loads from ProfileService
|
||||
```
|
||||
|
||||
Override `OnActivated()` to register for `ProgressUpdatedMessage` from any active feature ViewModel:
|
||||
```csharp
|
||||
protected override void OnActivated()
|
||||
{
|
||||
base.OnActivated();
|
||||
Messenger.Register<ProgressUpdatedMessage>(this, (r, m) =>
|
||||
{
|
||||
r.ProgressStatus = m.Value.Message;
|
||||
r.ProgressPercentage = m.Value.Total > 0
|
||||
? (int)(100.0 * m.Value.Current / m.Value.Total)
|
||||
: 0;
|
||||
});
|
||||
}
|
||||
```
|
||||
This wires the StatusBar operation text and progress % to live updates from any running feature operation.
|
||||
|
||||
**ProfileManagementViewModel.cs**: Wraps ProfileService for dialog binding.
|
||||
- `ObservableCollection<TenantProfile> Profiles`
|
||||
- `AddCommand`, `RenameCommand`, `DeleteCommand`
|
||||
- Validates inputs (non-empty Name, valid URL format, non-empty ClientId)
|
||||
|
||||
**SettingsViewModel.cs** (inherits FeatureViewModelBase):
|
||||
- `string SelectedLanguage` bound to language ComboBox
|
||||
- `string DataFolder` bound to folder TextBox
|
||||
- `BrowseFolderCommand` opens FolderBrowserDialog
|
||||
- On language change: updates `TranslationSource.Instance.CurrentCulture` + calls `SettingsService.SetLanguageAsync`
|
||||
- `RunOperationAsync`: not applicable — stub throws `NotSupportedException` (Settings tab has no long-running operation)
|
||||
|
||||
**MainWindow.xaml** — Full shell layout as locked in CONTEXT.md.
|
||||
|
||||
StatusBar middle item MUST bind to `ProgressStatus` (live operation text from ProgressUpdatedMessage),
|
||||
NOT `ConnectionStatus`. Per locked CONTEXT.md: "operation status text" means the live progress text.
|
||||
|
||||
The 7 stub feature tabs MUST use `<controls:FeatureTabBase />` as their Content,
|
||||
NOT bare TextBlocks. This gives Phase 2 a XAML template to extend.
|
||||
|
||||
```xml
|
||||
<Window Title="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[app.title]}"
|
||||
MinWidth="900" MinHeight="600">
|
||||
<DockPanel>
|
||||
<!-- Toolbar -->
|
||||
<ToolBar DockPanel.Dock="Top">
|
||||
<ComboBox Width="220" ItemsSource="{Binding TenantProfiles}"
|
||||
SelectedItem="{Binding SelectedProfile}"
|
||||
DisplayMemberPath="Name" />
|
||||
<Button Content="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[toolbar.connect]}"
|
||||
Command="{Binding ConnectCommand}" />
|
||||
<Button Content="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[toolbar.manage]}"
|
||||
Command="{Binding ManageProfilesCommand}" />
|
||||
<Separator />
|
||||
<Button Content="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[toolbar.clear]}"
|
||||
Command="{Binding ClearSessionCommand}" />
|
||||
</ToolBar>
|
||||
|
||||
<!-- StatusBar: three fields per locked layout decision.
|
||||
Middle field binds to ProgressStatus (live operation text), NOT ConnectionStatus. -->
|
||||
<StatusBar DockPanel.Dock="Bottom" Height="24">
|
||||
<StatusBarItem Content="{Binding SelectedProfile.Name}" />
|
||||
<Separator />
|
||||
<StatusBarItem Content="{Binding ProgressStatus}" />
|
||||
<Separator />
|
||||
<StatusBarItem Content="{Binding ProgressPercentage, StringFormat={}{0}%}" />
|
||||
</StatusBar>
|
||||
|
||||
<!-- Log Panel -->
|
||||
<RichTextBox x:Name="LogPanel" DockPanel.Dock="Bottom" Height="150"
|
||||
IsReadOnly="True" VerticalScrollBarVisibility="Auto"
|
||||
Background="Black" Foreground="LimeGreen"
|
||||
FontFamily="Consolas" FontSize="11" />
|
||||
|
||||
<!-- TabControl: 7 stub tabs use FeatureTabBase; Settings tab wired in plan 01-07 -->
|
||||
<TabControl>
|
||||
<TabItem Header="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[tab.permissions]}">
|
||||
<controls:FeatureTabBase />
|
||||
</TabItem>
|
||||
<TabItem Header="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[tab.storage]}">
|
||||
<controls:FeatureTabBase />
|
||||
</TabItem>
|
||||
<TabItem Header="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[tab.filesearch]}">
|
||||
<controls:FeatureTabBase />
|
||||
</TabItem>
|
||||
<TabItem Header="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[tab.duplicates]}">
|
||||
<controls:FeatureTabBase />
|
||||
</TabItem>
|
||||
<TabItem Header="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[tab.templates]}">
|
||||
<controls:FeatureTabBase />
|
||||
</TabItem>
|
||||
<TabItem Header="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[tab.bulk]}">
|
||||
<controls:FeatureTabBase />
|
||||
</TabItem>
|
||||
<TabItem Header="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[tab.folderstructure]}">
|
||||
<controls:FeatureTabBase />
|
||||
</TabItem>
|
||||
<!-- Settings tab: placeholder TextBlock replaced by SettingsView in plan 01-07 -->
|
||||
<TabItem x:Name="SettingsTabItem"
|
||||
Header="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[tab.settings]}">
|
||||
<TextBlock Text="Settings (plan 01-07)" HorizontalAlignment="Center" VerticalAlignment="Center" />
|
||||
</TabItem>
|
||||
</TabControl>
|
||||
</DockPanel>
|
||||
</Window>
|
||||
```
|
||||
|
||||
Add namespace in Window opening tag:
|
||||
`xmlns:controls="clr-namespace:SharepointToolbox.Views.Controls"`
|
||||
|
||||
**MainWindow.xaml.cs**: Constructor receives `MainWindowViewModel` via DI constructor injection. Sets `DataContext = viewModel`. Calls `viewModel.LoadProfilesAsync()` in `Loaded` event.
|
||||
|
||||
**App.xaml.cs** — Update RegisterServices:
|
||||
```csharp
|
||||
services.AddSingleton<MsalClientFactory>();
|
||||
services.AddSingleton<SessionManager>();
|
||||
services.AddSingleton<ProfileService>();
|
||||
services.AddSingleton<SettingsService>();
|
||||
services.AddSingleton<MainWindowViewModel>();
|
||||
services.AddTransient<ProfileManagementViewModel>();
|
||||
services.AddTransient<SettingsViewModel>();
|
||||
services.AddSingleton<MainWindow>();
|
||||
```
|
||||
|
||||
Wire LogPanelSink AFTER MainWindow is resolved (it needs the RichTextBox reference):
|
||||
```csharp
|
||||
host.Start();
|
||||
App app = new();
|
||||
app.InitializeComponent();
|
||||
var mainWindow = host.Services.GetRequiredService<MainWindow>();
|
||||
|
||||
// Wire LogPanelSink now that we have the RichTextBox
|
||||
Log.Logger = new LoggerConfiguration()
|
||||
.WriteTo.File(/* rolling file path */)
|
||||
.WriteTo.Sink(new LogPanelSink(mainWindow.LogPanel))
|
||||
.CreateLogger();
|
||||
|
||||
app.MainWindow = mainWindow;
|
||||
app.MainWindow.Visibility = Visibility.Visible;
|
||||
```
|
||||
|
||||
**Global exception handlers** in App.xaml.cs (after app created):
|
||||
```csharp
|
||||
app.DispatcherUnhandledException += (s, e) =>
|
||||
{
|
||||
Log.Fatal(e.Exception, "Unhandled UI exception");
|
||||
MessageBox.Show(
|
||||
$"A fatal error occurred:\n{e.Exception.Message}\n\nCheck log for details.",
|
||||
"Fatal Error", MessageBoxButton.OK, MessageBoxImage.Error);
|
||||
e.Handled = true;
|
||||
};
|
||||
TaskScheduler.UnobservedTaskException += (s, e) =>
|
||||
{
|
||||
Log.Fatal(e.Exception, "Unobserved task exception");
|
||||
e.SetObserved();
|
||||
};
|
||||
```
|
||||
|
||||
Run `dotnet build SharepointToolbox/SharepointToolbox.csproj` — fix any XAML or CS compilation errors.
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd "C:\Users\dev\Documents\projets\Sharepoint" && dotnet build SharepointToolbox/SharepointToolbox.csproj 2>&1 | tail -5</automated>
|
||||
</verify>
|
||||
<done>Build succeeds with 0 errors. MainWindow.xaml contains RichTextBox x:Name="LogPanel". StatusBar middle StatusBarItem binds to ProgressStatus (not ConnectionStatus). All 7 stub feature TabItems contain <controls:FeatureTabBase /> (not bare TextBlocks). Settings TabItem has x:Name="SettingsTabItem". All 8 tab headers use TranslationSource bindings. Global exception handlers registered in App.xaml.cs.</done>
|
||||
</task>
|
||||
|
||||
</tasks>
|
||||
|
||||
<verification>
|
||||
- `dotnet build SharepointToolbox.sln` passes with 0 errors
|
||||
- `dotnet test --filter "Category=Unit"` all pass
|
||||
- MainWindow.xaml contains `x:Name="LogPanel"` RichTextBox
|
||||
- MainWindow.xaml StatusBar middle StatusBarItem binds to `ProgressStatus` (live operation text)
|
||||
- MainWindow.xaml 7 stub TabItems contain `controls:FeatureTabBase` (not TextBlocks)
|
||||
- FeatureTabBase.xaml contains ProgressBar + TextBlock + Button with Visibility bound to IsRunning
|
||||
- App.xaml.cs registers `DispatcherUnhandledException` and `TaskScheduler.UnobservedTaskException`
|
||||
- FeatureViewModelBase contains no `async void` methods (anti-pattern violation)
|
||||
- ObservableCollection is never modified from Task.Run (pattern 7 compliance)
|
||||
- MainWindowViewModel.OnActivated() subscribes to ProgressUpdatedMessage and updates ProgressStatus + ProgressPercentage
|
||||
</verification>
|
||||
|
||||
<success_criteria>
|
||||
Application compiles and launches to a visible WPF shell. FeatureViewModelBase tests green. All ViewModels registered in DI. Log panel wired to Serilog. StatusBar middle field shows live operation status text (ProgressStatus). All 7 stub feature tabs include the progress/cancel strip template via FeatureTabBase.
|
||||
</success_criteria>
|
||||
|
||||
<output>
|
||||
After completion, create `.planning/phases/01-foundation/01-06-SUMMARY.md`
|
||||
</output>
|
||||
212
.planning/milestones/v1.0-phases/01-foundation/01-06-SUMMARY.md
Normal file
212
.planning/milestones/v1.0-phases/01-foundation/01-06-SUMMARY.md
Normal file
@@ -0,0 +1,212 @@
|
||||
---
|
||||
phase: 01-foundation
|
||||
plan: 06
|
||||
subsystem: ui
|
||||
tags: [wpf, dotnet10, csharp, mvvm, community-toolkit-mvvm, xaml, serilog, localization, tdd, xunit]
|
||||
|
||||
# Dependency graph
|
||||
requires:
|
||||
- 01-03 (ProfileService + SettingsService for DI registration)
|
||||
- 01-04 (SessionManager for ConnectCommand + ClearSessionCommand)
|
||||
- 01-05 (TranslationSource.Instance for all XAML bindings and StatusMessage keys)
|
||||
provides:
|
||||
- FeatureViewModelBase: abstract base for all feature ViewModels with CancellationTokenSource lifecycle,
|
||||
IsRunning, IProgress<OperationProgress>, ProgressUpdatedMessage dispatch
|
||||
- MainWindowViewModel: shell ViewModel with TenantProfiles ObservableCollection,
|
||||
TenantSwitchedMessage dispatch, ProgressUpdatedMessage subscription (live StatusBar)
|
||||
- ProfileManagementViewModel: CRUD on TenantProfile with input validation
|
||||
- SettingsViewModel: language + folder settings, OpenFolderDialog
|
||||
- FeatureTabBase UserControl: ProgressBar + TextBlock + Cancel button strip (shown only when IsRunning)
|
||||
- MainWindow.xaml: full WPF shell — Toolbar, TabControl (8 tabs with FeatureTabBase), RichTextBox LogPanel, StatusBar
|
||||
- App.xaml.cs: DI service registration, LogPanelSink wiring, global exception handlers
|
||||
- ProgressUpdatedMessage: ValueChangedMessage enabling StatusBar live update from feature ops
|
||||
affects:
|
||||
- 01-07 (SettingsView replaces Settings TextBlock placeholder; ProfileManagementDialog uses ProfileManagementViewModel)
|
||||
- 02-xx (all feature ViewModels extend FeatureViewModelBase; all feature tabs replace FeatureTabBase row 0)
|
||||
|
||||
# Tech tracking
|
||||
tech-stack:
|
||||
added: []
|
||||
patterns:
|
||||
- FeatureViewModelBase: AsyncRelayCommand + IProgress<OperationProgress> + CancellationToken — canonical async pattern for all feature ops
|
||||
- RunCommand CanExecute guard via () => !IsRunning — prevents double-execution
|
||||
- NotifyCanExecuteChangedFor(nameof(CancelCommand)) on IsRunning — keeps Cancel enabled state in sync
|
||||
- ProgressUpdatedMessage via WeakReferenceMessenger — decouples feature VMs from MainWindowViewModel StatusBar
|
||||
- LogPanelSink wired after MainWindow resolved — RichTextBox reference required before Serilog reconfiguration
|
||||
- OpenFolderDialog from Microsoft.Win32 — WPF-native folder picker; FolderBrowserDialog (WinForms) not available in WPF-only project
|
||||
- FeatureTabBase row 0 as Phase 2 extension point — stub TextBlock replaced by feature content per phase
|
||||
|
||||
key-files:
|
||||
created:
|
||||
- SharepointToolbox/Core/Messages/ProgressUpdatedMessage.cs
|
||||
- SharepointToolbox/ViewModels/FeatureViewModelBase.cs
|
||||
- SharepointToolbox/ViewModels/MainWindowViewModel.cs
|
||||
- SharepointToolbox/ViewModels/ProfileManagementViewModel.cs
|
||||
- SharepointToolbox/ViewModels/Tabs/SettingsViewModel.cs
|
||||
- SharepointToolbox/Views/Controls/FeatureTabBase.xaml
|
||||
- SharepointToolbox/Views/Controls/FeatureTabBase.xaml.cs
|
||||
- SharepointToolbox.Tests/ViewModels/FeatureViewModelBaseTests.cs
|
||||
modified:
|
||||
- SharepointToolbox/MainWindow.xaml
|
||||
- SharepointToolbox/MainWindow.xaml.cs
|
||||
- SharepointToolbox/App.xaml
|
||||
- SharepointToolbox/App.xaml.cs
|
||||
|
||||
key-decisions:
|
||||
- "ObservableRecipient lambda receivers need explicit cast — Messenger.Register<T> lambda (r, m) types r as object; requires ((FeatureViewModelBase)r).Method() for virtual dispatch"
|
||||
- "FeatureViewModelBase and generated source both use partial class — CommunityToolkit.Mvvm source generator requires abstract partial class; plain abstract class causes CS0260"
|
||||
- "OpenFolderDialog (Microsoft.Win32) replaces FolderBrowserDialog (System.Windows.Forms) — WPF-only project does not reference WinForms; OpenFolderDialog available in .NET 8+ Microsoft.Win32"
|
||||
- "LogPanel exposed via GetLogPanel() method — x:Name='LogPanel' generates a field in the XAML partial class; defining a property with same name causes CS0102 duplicate definition"
|
||||
- "StatusBar middle StatusBarItem binds to ProgressStatus (not ConnectionStatus) — live operation text from ProgressUpdatedMessage, per locked CONTEXT.md decision"
|
||||
- "resx keys tab.search and tab.structure used (not tab.filesearch/tab.folderstructure) — actual keys in Strings.resx established in plan 01-05"
|
||||
|
||||
patterns-established:
|
||||
- "FeatureViewModelBase pattern: every feature ViewModel inherits this, overrides RunOperationAsync(CancellationToken, IProgress<OperationProgress>) — no async void anywhere"
|
||||
- "Phase 2 extension point: FeatureTabBase Row 0 is the placeholder — Phase 2 replaces that row with real feature content while keeping the progress/cancel strip in Row 1"
|
||||
- "ObservableCollection only modified on UI thread — LoadProfilesAsync called from Loaded event (UI thread); all collection mutations remain on dispatcher"
|
||||
|
||||
requirements-completed:
|
||||
- FOUND-01
|
||||
- FOUND-05
|
||||
- FOUND-06
|
||||
- FOUND-07
|
||||
|
||||
# Metrics
|
||||
duration: 5min
|
||||
completed: 2026-04-02
|
||||
---
|
||||
|
||||
# Phase 1 Plan 06: WPF Shell Summary
|
||||
|
||||
**FeatureViewModelBase with AsyncRelayCommand/CancellationToken/IProgress pattern + full WPF shell (Toolbar, 8-tab TabControl with FeatureTabBase, LogPanel, live-StatusBar) wired to Serilog, DI, and global exception handlers**
|
||||
|
||||
## Performance
|
||||
|
||||
- **Duration:** 5 min
|
||||
- **Started:** 2026-04-02T10:28:10Z
|
||||
- **Completed:** 2026-04-02T10:33:00Z
|
||||
- **Tasks:** 2
|
||||
- **Files modified:** 12
|
||||
|
||||
## Accomplishments
|
||||
|
||||
- FeatureViewModelBase implements full async operation lifecycle: CancellationTokenSource creation/disposal, IsRunning guard on RunCommand.CanExecute, IProgress<OperationProgress> dispatching ProgressUpdatedMessage, OperationCanceledException caught gracefully, generic Exception caught with error message, finally block ensures IsRunning=false
|
||||
- MainWindowViewModel subscribes to ProgressUpdatedMessage via WeakReferenceMessenger — StatusBar middle item shows live operation status text from any running feature ViewModel
|
||||
- FeatureTabBase UserControl provides the canonical Phase 2 extension point: Row 0 contains the "coming soon" stub, Row 1 contains the progress/cancel strip (Visibility bound to IsRunning)
|
||||
- All 7 stub feature TabItems use `<controls:FeatureTabBase />` — none contain bare TextBlocks
|
||||
- App.xaml.cs registers all services in DI, wires LogPanelSink to the RichTextBox after MainWindow is resolved from the container, and installs both DispatcherUnhandledException and TaskScheduler.UnobservedTaskException handlers
|
||||
- All 42 unit tests pass (6 new FeatureViewModelBase + 36 existing), 1 skipped (interactive MSAL), 0 errors, 0 warnings
|
||||
|
||||
## Task Commits
|
||||
|
||||
1. **Task 1 (TDD): FeatureViewModelBase + ProgressUpdatedMessage + unit tests** - `3c09155` (feat)
|
||||
2. **Task 2: WPF shell — FeatureTabBase, ViewModels, MainWindow, App.xaml.cs** - `5920d42` (feat)
|
||||
|
||||
**Plan metadata:** (docs commit follows)
|
||||
|
||||
## Files Created/Modified
|
||||
|
||||
- `SharepointToolbox/Core/Messages/ProgressUpdatedMessage.cs` — ValueChangedMessage<OperationProgress> for StatusBar live update dispatch
|
||||
- `SharepointToolbox/ViewModels/FeatureViewModelBase.cs` — Abstract partial base with CancellationTokenSource lifecycle, RunCommand/CancelCommand, IProgress<OperationProgress>, TenantSwitchedMessage registration
|
||||
- `SharepointToolbox/ViewModels/MainWindowViewModel.cs` — Shell ViewModel; TenantProfiles ObservableCollection; sends TenantSwitchedMessage on profile selection; subscribes ProgressUpdatedMessage for live StatusBar
|
||||
- `SharepointToolbox/ViewModels/ProfileManagementViewModel.cs` — CRUD on TenantProfile via ProfileService; AddCommand/RenameCommand/DeleteCommand with input validation
|
||||
- `SharepointToolbox/ViewModels/Tabs/SettingsViewModel.cs` — Language + DataFolder settings; OpenFolderDialog; delegates to SettingsService; extends FeatureViewModelBase
|
||||
- `SharepointToolbox/Views/Controls/FeatureTabBase.xaml` — UserControl: Row 0 = "coming soon" stub, Row 1 = ProgressBar + StatusMessage + Cancel button (Visibility=IsRunning)
|
||||
- `SharepointToolbox/Views/Controls/FeatureTabBase.xaml.cs` — Standard code-behind; no extra logic
|
||||
- `SharepointToolbox/MainWindow.xaml` — Full DockPanel shell: Toolbar (ComboBox + 3 buttons), TabControl (8 tabs), LogPanel (150px RichTextBox), StatusBar (SelectedProfile.Name | ProgressStatus | ProgressPercentage%)
|
||||
- `SharepointToolbox/MainWindow.xaml.cs` — DI constructor injection of MainWindowViewModel; DataContext set; LoadProfilesAsync on Loaded; GetLogPanel() accessor for App.xaml.cs
|
||||
- `SharepointToolbox/App.xaml` — Added BoolToVisibilityConverter resource
|
||||
- `SharepointToolbox/App.xaml.cs` — Full DI registration; LogPanelSink wired post-MainWindow-resolve; DispatcherUnhandledException + TaskScheduler.UnobservedTaskException global handlers
|
||||
- `SharepointToolbox.Tests/ViewModels/FeatureViewModelBaseTests.cs` — 6 unit tests: IsRunning lifecycle, IProgress updates, cancellation status message, OperationCanceledException grace, Exception error message, CanExecute guard
|
||||
|
||||
## Decisions Made
|
||||
|
||||
- `ObservableRecipient` lambda receivers need explicit cast: `Messenger.Register<T>` types the `r` parameter as `object` in the lambda signature; calling an instance method requires `((FeatureViewModelBase)r).Method()` for correct virtual dispatch.
|
||||
- `FeatureViewModelBase` declared as `abstract partial class` — CommunityToolkit.Mvvm source generator generates a companion partial class for `[ObservableProperty]` attributes; plain `abstract class` causes CS0260 missing partial modifier.
|
||||
- `OpenFolderDialog` (Microsoft.Win32) used instead of `FolderBrowserDialog` (System.Windows.Forms) — WPF-only project does not reference WinForms; `OpenFolderDialog` available natively in .NET 8+ via `Microsoft.Win32`.
|
||||
- `LogPanel` exposed via `GetLogPanel()` method — `x:Name="LogPanel"` in XAML generates a backing field in the generated partial class; adding a property with the same name causes CS0102 duplicate definition error.
|
||||
|
||||
## Deviations from Plan
|
||||
|
||||
### Auto-fixed Issues
|
||||
|
||||
**1. [Rule 3 - Blocking] Added `partial` modifier to FeatureViewModelBase**
|
||||
- **Found during:** Task 1 (dotnet test — GREEN attempt)
|
||||
- **Issue:** CS0260 — CommunityToolkit.Mvvm source generator produces a companion partial class for `[ObservableProperty]`; class declared without `partial` keyword causes conflict
|
||||
- **Fix:** Changed `public abstract class FeatureViewModelBase` to `public abstract partial class FeatureViewModelBase`
|
||||
- **Files modified:** `SharepointToolbox/ViewModels/FeatureViewModelBase.cs`
|
||||
- **Verification:** Build succeeded, 6/6 FeatureViewModelBaseTests pass
|
||||
- **Committed in:** 3c09155 (Task 1 commit)
|
||||
|
||||
**2. [Rule 1 - Bug] Fixed ObservableRecipient lambda receiver type**
|
||||
- **Found during:** Task 1 (dotnet test — GREEN attempt)
|
||||
- **Issue:** CS1061 — Messenger.Register lambda types `r` as `object`; calling `r.OnTenantSwitched()` fails because method is not defined on `object`
|
||||
- **Fix:** Added explicit cast: `((FeatureViewModelBase)r).OnTenantSwitched(m.Value)`
|
||||
- **Files modified:** `SharepointToolbox/ViewModels/FeatureViewModelBase.cs`
|
||||
- **Verification:** Build succeeded, tests pass
|
||||
- **Committed in:** 3c09155 (Task 1 commit)
|
||||
|
||||
**3. [Rule 3 - Blocking] Replaced FolderBrowserDialog with OpenFolderDialog**
|
||||
- **Found during:** Task 2 (dotnet build)
|
||||
- **Issue:** `System.Windows.Forms` namespace not available in WPF-only project; `FolderBrowserDialog` import fails
|
||||
- **Fix:** Replaced with `Microsoft.Win32.OpenFolderDialog` (available in .NET 8+ natively) and updated method accordingly
|
||||
- **Files modified:** `SharepointToolbox/ViewModels/Tabs/SettingsViewModel.cs`
|
||||
- **Verification:** Build succeeded with 0 errors
|
||||
- **Committed in:** 5920d42 (Task 2 commit)
|
||||
|
||||
**4. [Rule 3 - Blocking] Exposed LogPanel via GetLogPanel() method instead of property**
|
||||
- **Found during:** Task 2 (dotnet build)
|
||||
- **Issue:** CS0102 — `x:Name="LogPanel"` in XAML generates a field in the partial class; defining a property `LogPanel` in code-behind causes duplicate definition
|
||||
- **Fix:** Renamed the accessor to `GetLogPanel()` method; updated App.xaml.cs to call `mainWindow.GetLogPanel()`
|
||||
- **Files modified:** `SharepointToolbox/MainWindow.xaml.cs`, `SharepointToolbox/App.xaml.cs`
|
||||
- **Verification:** Build succeeded with 0 errors
|
||||
- **Committed in:** 5920d42 (Task 2 commit)
|
||||
|
||||
**5. [Rule 1 - Bug] Used correct resx key names (tab.search, tab.structure)**
|
||||
- **Found during:** Task 2 (XAML authoring)
|
||||
- **Issue:** Plan referenced `tab.filesearch` and `tab.folderstructure` but Strings.resx from plan 01-05 defines `tab.search` and `tab.structure`
|
||||
- **Fix:** Used the actual keys from Strings.resx: `tab.search` and `tab.structure`
|
||||
- **Files modified:** `SharepointToolbox/MainWindow.xaml`
|
||||
- **Verification:** Build succeeded; keys resolve correctly via TranslationSource
|
||||
- **Committed in:** 5920d42 (Task 2 commit)
|
||||
|
||||
---
|
||||
|
||||
**Total deviations:** 5 auto-fixed (2 Rule 1 bugs, 3 Rule 3 blocking build issues)
|
||||
**Impact on plan:** All fixes necessary for compilation and correct operation. No scope creep. Plan intent fully preserved.
|
||||
|
||||
## Issues Encountered
|
||||
|
||||
None beyond the auto-fixed deviations above.
|
||||
|
||||
## User Setup Required
|
||||
|
||||
None — no external service configuration required.
|
||||
|
||||
## Next Phase Readiness
|
||||
|
||||
- FeatureViewModelBase ready for all Phase 2 feature ViewModels to inherit — override `RunOperationAsync` and call `RunCommand.ExecuteAsync(null)` from UI
|
||||
- FeatureTabBase Row 0 is the Phase 2 extension point — replace the stub TextBlock row with real feature content
|
||||
- `x:Name="SettingsTabItem"` on Settings TabItem — plan 01-07 can replace the placeholder TextBlock with SettingsView
|
||||
- MainWindowViewModel.ManageProfilesCommand wired — plan 01-07 opens ProfileManagementDialog using ProfileManagementViewModel
|
||||
- All 42 unit tests green; 0 build errors/warnings — foundation ready for Phase 2 feature planning
|
||||
|
||||
## Self-Check: PASSED
|
||||
|
||||
- FOUND: SharepointToolbox/Core/Messages/ProgressUpdatedMessage.cs
|
||||
- FOUND: SharepointToolbox/ViewModels/FeatureViewModelBase.cs
|
||||
- FOUND: SharepointToolbox/ViewModels/MainWindowViewModel.cs
|
||||
- FOUND: SharepointToolbox/ViewModels/ProfileManagementViewModel.cs
|
||||
- FOUND: SharepointToolbox/ViewModels/Tabs/SettingsViewModel.cs
|
||||
- FOUND: SharepointToolbox/Views/Controls/FeatureTabBase.xaml
|
||||
- FOUND: SharepointToolbox/Views/Controls/FeatureTabBase.xaml.cs
|
||||
- FOUND: SharepointToolbox/MainWindow.xaml (contains RichTextBox x:Name="LogPanel")
|
||||
- FOUND: SharepointToolbox/MainWindow.xaml.cs
|
||||
- FOUND: SharepointToolbox/App.xaml (contains BoolToVisibilityConverter)
|
||||
- FOUND: SharepointToolbox/App.xaml.cs (contains DispatcherUnhandledException)
|
||||
- Commit 3c09155: feat(01-06): implement FeatureViewModelBase with async/cancel/progress pattern
|
||||
- Commit 5920d42: feat(01-06): build WPF shell — MainWindow XAML, ViewModels, LogPanelSink wiring
|
||||
|
||||
---
|
||||
*Phase: 01-foundation*
|
||||
*Completed: 2026-04-02*
|
||||
271
.planning/milestones/v1.0-phases/01-foundation/01-07-PLAN.md
Normal file
271
.planning/milestones/v1.0-phases/01-foundation/01-07-PLAN.md
Normal file
@@ -0,0 +1,271 @@
|
||||
---
|
||||
phase: 01-foundation
|
||||
plan: 07
|
||||
type: execute
|
||||
wave: 6
|
||||
depends_on:
|
||||
- 01-06
|
||||
files_modified:
|
||||
- SharepointToolbox/Views/Dialogs/ProfileManagementDialog.xaml
|
||||
- SharepointToolbox/Views/Dialogs/ProfileManagementDialog.xaml.cs
|
||||
- SharepointToolbox/Views/Tabs/SettingsView.xaml
|
||||
- SharepointToolbox/Views/Tabs/SettingsView.xaml.cs
|
||||
- SharepointToolbox/Views/MainWindow.xaml
|
||||
autonomous: true
|
||||
requirements:
|
||||
- FOUND-02
|
||||
- FOUND-09
|
||||
- FOUND-12
|
||||
must_haves:
|
||||
truths:
|
||||
- "ProfileManagementDialog opens as a modal window from the Manage Profiles button"
|
||||
- "User can add a new profile (Name + Tenant URL + Client ID fields) and it appears in the toolbar ComboBox"
|
||||
- "User can rename and delete existing profiles in the dialog"
|
||||
- "SettingsView has a language ComboBox (English / French) and a data folder TextBox with Browse button"
|
||||
- "Changing language in SettingsView switches the UI language immediately without restart"
|
||||
- "Data folder setting persists to Sharepoint_Settings.json"
|
||||
artifacts:
|
||||
- path: "SharepointToolbox/Views/Dialogs/ProfileManagementDialog.xaml"
|
||||
provides: "Modal dialog for profile CRUD"
|
||||
contains: "ProfileManagementViewModel"
|
||||
- path: "SharepointToolbox/Views/Tabs/SettingsView.xaml"
|
||||
provides: "Settings tab content with language and folder controls"
|
||||
contains: "TranslationSource"
|
||||
key_links:
|
||||
- from: "SharepointToolbox/Views/Dialogs/ProfileManagementDialog.xaml"
|
||||
to: "SharepointToolbox/ViewModels/ProfileManagementViewModel.cs"
|
||||
via: "DataContext = viewModel (constructor injected)"
|
||||
pattern: "DataContext"
|
||||
- from: "SharepointToolbox/Views/Tabs/SettingsView.xaml"
|
||||
to: "SharepointToolbox/Localization/TranslationSource.cs"
|
||||
via: "Language ComboBox selection sets TranslationSource.Instance.CurrentCulture"
|
||||
pattern: "TranslationSource"
|
||||
- from: "SharepointToolbox/Views/MainWindow.xaml"
|
||||
to: "SharepointToolbox/Views/Tabs/SettingsView.xaml"
|
||||
via: "Settings TabItem ContentTemplate or direct UserControl reference"
|
||||
pattern: "SettingsView"
|
||||
---
|
||||
|
||||
<objective>
|
||||
Build the two user-facing views completing Phase 1 UX: ProfileManagementDialog (profile CRUD modal) and SettingsView (language + data folder). Wire SettingsView into the MainWindow Settings tab.
|
||||
|
||||
Purpose: These are the last two user-visible pieces before the visual checkpoint. After this plan the application is functional enough for a human to create a tenant profile, connect, and switch language.
|
||||
Output: ProfileManagementDialog + SettingsView wired into the shell.
|
||||
</objective>
|
||||
|
||||
<execution_context>
|
||||
@C:/Users/SebastienQUEROL/.claude/get-shit-done/workflows/execute-plan.md
|
||||
@C:/Users/SebastienQUEROL/.claude/get-shit-done/templates/summary.md
|
||||
</execution_context>
|
||||
|
||||
<context>
|
||||
@.planning/PROJECT.md
|
||||
@.planning/phases/01-foundation/01-CONTEXT.md
|
||||
@.planning/phases/01-foundation/01-06-SUMMARY.md
|
||||
|
||||
<interfaces>
|
||||
<!-- From ProfileManagementViewModel (plan 01-06) -->
|
||||
```csharp
|
||||
public class ProfileManagementViewModel : ObservableObject
|
||||
{
|
||||
public ObservableCollection<TenantProfile> Profiles { get; }
|
||||
public TenantProfile? SelectedProfile { get; set; }
|
||||
public string NewName { get; set; }
|
||||
public string NewTenantUrl { get; set; }
|
||||
public string NewClientId { get; set; }
|
||||
public IAsyncRelayCommand AddCommand { get; }
|
||||
public IAsyncRelayCommand RenameCommand { get; }
|
||||
public IAsyncRelayCommand DeleteCommand { get; }
|
||||
}
|
||||
```
|
||||
|
||||
<!-- From SettingsViewModel (plan 01-06) -->
|
||||
```csharp
|
||||
public class SettingsViewModel : FeatureViewModelBase
|
||||
{
|
||||
public string SelectedLanguage { get; set; } // "en" or "fr"
|
||||
public string DataFolder { get; set; }
|
||||
public RelayCommand BrowseFolderCommand { get; }
|
||||
}
|
||||
```
|
||||
|
||||
<!-- Locked UI spec from CONTEXT.md -->
|
||||
// ProfileManagementDialog: modal Window, fields: Name + Tenant URL + Client ID
|
||||
// Profile fields: { name, tenantUrl, clientId } — JSON schema
|
||||
// SettingsView: language ComboBox (English/French) + DataFolder TextBox + Browse button
|
||||
// Language switch: immediate, no restart, via TranslationSource.Instance.CurrentCulture
|
||||
</interfaces>
|
||||
</context>
|
||||
|
||||
<tasks>
|
||||
|
||||
<task type="auto">
|
||||
<name>Task 1: ProfileManagementDialog XAML and code-behind</name>
|
||||
<files>
|
||||
SharepointToolbox/Views/Dialogs/ProfileManagementDialog.xaml,
|
||||
SharepointToolbox/Views/Dialogs/ProfileManagementDialog.xaml.cs
|
||||
</files>
|
||||
<action>
|
||||
Create `Views/Dialogs/` directory.
|
||||
|
||||
**ProfileManagementDialog.xaml** — modal Window (not UserControl):
|
||||
```xml
|
||||
<Window x:Class="SharepointToolbox.Views.Dialogs.ProfileManagementDialog"
|
||||
Title="Manage Profiles" Width="500" Height="480"
|
||||
WindowStartupLocation="CenterOwner" ShowInTaskbar="False"
|
||||
ResizeMode="NoResize">
|
||||
<Grid Margin="12">
|
||||
<Grid.RowDefinitions>
|
||||
<RowDefinition Height="Auto" /> <!-- Existing profiles list -->
|
||||
<RowDefinition Height="*" />
|
||||
<RowDefinition Height="Auto" /> <!-- Add/Edit fields -->
|
||||
<RowDefinition Height="Auto" /> <!-- Action buttons -->
|
||||
</Grid.RowDefinitions>
|
||||
|
||||
<!-- Profile list -->
|
||||
<Label Content="Profiles" Grid.Row="0" />
|
||||
<ListBox Grid.Row="1" Margin="0,0,0,8"
|
||||
ItemsSource="{Binding Profiles}"
|
||||
SelectedItem="{Binding SelectedProfile}"
|
||||
DisplayMemberPath="Name" />
|
||||
|
||||
<!-- Input fields -->
|
||||
<Grid Grid.Row="2" Margin="0,0,0,8">
|
||||
<Grid.ColumnDefinitions>
|
||||
<ColumnDefinition Width="100" />
|
||||
<ColumnDefinition Width="*" />
|
||||
</Grid.ColumnDefinitions>
|
||||
<Grid.RowDefinitions>
|
||||
<RowDefinition Height="Auto" />
|
||||
<RowDefinition Height="Auto" />
|
||||
<RowDefinition Height="Auto" />
|
||||
</Grid.RowDefinitions>
|
||||
<Label Content="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[profile.name]}"
|
||||
Grid.Row="0" Grid.Column="0" />
|
||||
<TextBox Text="{Binding NewName, UpdateSourceTrigger=PropertyChanged}"
|
||||
Grid.Row="0" Grid.Column="1" Margin="0,2" />
|
||||
<Label Content="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[profile.url]}"
|
||||
Grid.Row="1" Grid.Column="0" />
|
||||
<TextBox Text="{Binding NewTenantUrl, UpdateSourceTrigger=PropertyChanged}"
|
||||
Grid.Row="1" Grid.Column="1" Margin="0,2" />
|
||||
<Label Content="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[profile.clientid]}"
|
||||
Grid.Row="2" Grid.Column="0" />
|
||||
<TextBox Text="{Binding NewClientId, UpdateSourceTrigger=PropertyChanged}"
|
||||
Grid.Row="2" Grid.Column="1" Margin="0,2" />
|
||||
</Grid>
|
||||
|
||||
<!-- Buttons -->
|
||||
<StackPanel Grid.Row="3" Orientation="Horizontal" HorizontalAlignment="Right">
|
||||
<Button Content="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[profile.add]}"
|
||||
Command="{Binding AddCommand}" Width="60" Margin="4,0" />
|
||||
<Button Content="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[profile.rename]}"
|
||||
Command="{Binding RenameCommand}" Width="60" Margin="4,0" />
|
||||
<Button Content="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[profile.delete]}"
|
||||
Command="{Binding DeleteCommand}" Width="60" Margin="4,0" />
|
||||
<Button Content="Close" Width="60" Margin="4,0"
|
||||
Click="CloseButton_Click" IsCancel="True" />
|
||||
</StackPanel>
|
||||
</Grid>
|
||||
</Window>
|
||||
```
|
||||
|
||||
**ProfileManagementDialog.xaml.cs**:
|
||||
- Constructor receives `ProfileManagementViewModel` via DI (register as `Transient` in App.xaml.cs — already done in plan 01-06)
|
||||
- Sets `DataContext = viewModel`
|
||||
- `CloseButton_Click`: calls `this.Close()`
|
||||
- `Owner` set by caller (`MainWindowViewModel.ManageProfilesCommand` opens as `new ProfileManagementDialog { Owner = Application.Current.MainWindow }.ShowDialog()`)
|
||||
|
||||
After adding: the Add command in `ProfileManagementViewModel` must also trigger `MainWindowViewModel.TenantProfiles` refresh. Implement by having `ProfileManagementViewModel` accept a callback or raise an event. The simplest approach: `MainWindowViewModel.ManageProfilesCommand` reloads profiles after the dialog closes (dialog is modal — `ShowDialog()` blocks until closed).
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd "C:\Users\dev\Documents\projets\Sharepoint" && dotnet build SharepointToolbox/SharepointToolbox.csproj 2>&1 | tail -5</automated>
|
||||
</verify>
|
||||
<done>Build succeeds. ProfileManagementDialog.xaml contains all three input fields (Name, Tenant URL, Client ID). All labels use TranslationSource bindings.</done>
|
||||
</task>
|
||||
|
||||
<task type="auto">
|
||||
<name>Task 2: SettingsView XAML and MainWindow Settings tab wiring</name>
|
||||
<files>
|
||||
SharepointToolbox/Views/Tabs/SettingsView.xaml,
|
||||
SharepointToolbox/Views/Tabs/SettingsView.xaml.cs,
|
||||
SharepointToolbox/Views/MainWindow.xaml
|
||||
</files>
|
||||
<action>
|
||||
Create `Views/Tabs/` directory.
|
||||
|
||||
**SettingsView.xaml** — UserControl (embedded in TabItem):
|
||||
```xml
|
||||
<UserControl x:Class="SharepointToolbox.Views.Tabs.SettingsView">
|
||||
<StackPanel Margin="16">
|
||||
<!-- Language -->
|
||||
<Label Content="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[settings.language]}" />
|
||||
<ComboBox Width="200" HorizontalAlignment="Left"
|
||||
SelectedValue="{Binding SelectedLanguage}"
|
||||
SelectedValuePath="Tag">
|
||||
<ComboBoxItem Tag="en"
|
||||
Content="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[settings.lang.en]}" />
|
||||
<ComboBoxItem Tag="fr"
|
||||
Content="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[settings.lang.fr]}" />
|
||||
</ComboBox>
|
||||
|
||||
<Separator Margin="0,12" />
|
||||
|
||||
<!-- Data folder -->
|
||||
<Label Content="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[settings.folder]}" />
|
||||
<DockPanel>
|
||||
<Button DockPanel.Dock="Right"
|
||||
Content="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[settings.browse]}"
|
||||
Command="{Binding BrowseFolderCommand}" Width="80" Margin="8,0,0,0" />
|
||||
<TextBox Text="{Binding DataFolder, UpdateSourceTrigger=PropertyChanged}" />
|
||||
</DockPanel>
|
||||
</StackPanel>
|
||||
</UserControl>
|
||||
```
|
||||
|
||||
**SettingsView.xaml.cs**: Constructor receives `SettingsViewModel` via DI. Sets `DataContext = viewModel`. Calls `viewModel.LoadAsync()` in `Loaded` event to populate current settings.
|
||||
|
||||
Add `LoadAsync()` to SettingsViewModel if not present — loads current settings from SettingsService and sets `SelectedLanguage` and `DataFolder` properties.
|
||||
|
||||
**MainWindow.xaml** — Update Settings TabItem to use SettingsView (replace placeholder TextBlock):
|
||||
```xml
|
||||
<TabItem Header="{Binding Source={x:Static loc:TranslationSource.Instance}, Path=[tab.settings]}">
|
||||
<views:SettingsView />
|
||||
</TabItem>
|
||||
```
|
||||
Add namespace: `xmlns:views="clr-namespace:SharepointToolbox.Views.Tabs"`
|
||||
|
||||
Also register `SettingsView` in DI in App.xaml.cs (if not already):
|
||||
```csharp
|
||||
services.AddTransient<SettingsView>();
|
||||
```
|
||||
And resolve it in MainWindow constructor to inject into the Settings TabItem Content, OR use a DataTemplate approach. The simpler approach for Phase 1: resolve `SettingsView` from DI in `MainWindow.xaml.cs` constructor and set it as the TabItem Content directly:
|
||||
```csharp
|
||||
SettingsTabItem.Content = serviceProvider.GetRequiredService<SettingsView>();
|
||||
```
|
||||
The Settings TabItem already has `x:Name="SettingsTabItem"` from plan 01-06.
|
||||
|
||||
Run `dotnet build` and fix any errors.
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd "C:\Users\dev\Documents\projets\Sharepoint" && dotnet build SharepointToolbox/SharepointToolbox.csproj 2>&1 | tail -5</automated>
|
||||
</verify>
|
||||
<done>Build succeeds. SettingsView.xaml contains language ComboBox with "en"/"fr" options and data folder TextBox with Browse button. MainWindow.xaml Settings tab shows SettingsView (not placeholder TextBlock).</done>
|
||||
</task>
|
||||
|
||||
</tasks>
|
||||
|
||||
<verification>
|
||||
- `dotnet build SharepointToolbox.sln` passes with 0 errors
|
||||
- `dotnet test --filter "Category=Unit"` still passes (no regressions)
|
||||
- ProfileManagementDialog has all three input fields using TranslationSource keys
|
||||
- SettingsView language ComboBox has Tag="en" and Tag="fr" items
|
||||
- MainWindow Settings TabItem Content is SettingsView (not placeholder)
|
||||
</verification>
|
||||
|
||||
<success_criteria>
|
||||
All Phase 1 UI is built. Application runs and shows: shell with 8 tabs, log panel, status bar, language switching, profile management dialog, and settings. Ready for the visual checkpoint in plan 01-08.
|
||||
</success_criteria>
|
||||
|
||||
<output>
|
||||
After completion, create `.planning/phases/01-foundation/01-07-SUMMARY.md`
|
||||
</output>
|
||||
151
.planning/milestones/v1.0-phases/01-foundation/01-07-SUMMARY.md
Normal file
151
.planning/milestones/v1.0-phases/01-foundation/01-07-SUMMARY.md
Normal file
@@ -0,0 +1,151 @@
|
||||
---
|
||||
phase: 01-foundation
|
||||
plan: 07
|
||||
subsystem: ui
|
||||
tags: [wpf, dotnet10, csharp, mvvm, xaml, localization, community-toolkit-mvvm, dependency-injection]
|
||||
|
||||
# Dependency graph
|
||||
requires:
|
||||
- 01-06 (ProfileManagementViewModel + SettingsViewModel + MainWindow shell + FeatureTabBase + App DI registration)
|
||||
- 01-05 (TranslationSource.Instance for all XAML bindings; profile.* and settings.* resx keys)
|
||||
provides:
|
||||
- ProfileManagementDialog: modal Window for profile CRUD (Name/TenantUrl/ClientId fields), wired to ProfileManagementViewModel via DI
|
||||
- SettingsView: UserControl with language ComboBox (en/fr) and data folder TextBox + Browse button, wired to SettingsViewModel via DI
|
||||
- MainWindow Settings tab: SettingsView injected as tab content from code-behind (DI-resolved)
|
||||
- ManageProfilesCommand: now opens ProfileManagementDialog as modal, reloads profiles on close
|
||||
affects:
|
||||
- 01-08 (visual checkpoint — all Phase 1 UI is now complete)
|
||||
- 02-xx (SettingsView provides language switching in production UX; ProfileManagementDialog enables profile management)
|
||||
|
||||
# Tech tracking
|
||||
tech-stack:
|
||||
added: []
|
||||
patterns:
|
||||
- View-layer dialog factory: MainWindowViewModel.OpenProfileManagementDialog Func<Window> delegate set by MainWindow constructor — keeps ViewModel free of Window references
|
||||
- DI-resolved tab content: SettingsTabItem.Content set programmatically from MainWindow constructor via serviceProvider.GetRequiredService<SettingsView>() — enables constructor injection for UserControl
|
||||
- Dialog modal pattern: ProfileManagementDialog opened via factory, Owner=Application.Current.MainWindow, ShowDialog() blocks; LoadProfilesAsync() called after close to refresh ComboBox
|
||||
|
||||
key-files:
|
||||
created:
|
||||
- SharepointToolbox/Views/Dialogs/ProfileManagementDialog.xaml
|
||||
- SharepointToolbox/Views/Dialogs/ProfileManagementDialog.xaml.cs
|
||||
- SharepointToolbox/Views/Tabs/SettingsView.xaml
|
||||
- SharepointToolbox/Views/Tabs/SettingsView.xaml.cs
|
||||
modified:
|
||||
- SharepointToolbox/ViewModels/MainWindowViewModel.cs
|
||||
- SharepointToolbox/MainWindow.xaml
|
||||
- SharepointToolbox/MainWindow.xaml.cs
|
||||
- SharepointToolbox/App.xaml.cs
|
||||
|
||||
key-decisions:
|
||||
- "ProfileManagementViewModel dialog factory pattern — ViewModel exposes Func<Window>? OpenProfileManagementDialog set by View layer; avoids Window/DI coupling in ViewModel"
|
||||
- "IServiceProvider injected into MainWindow constructor — required to resolve DI-registered ProfileManagementDialog and SettingsView at runtime"
|
||||
- "ProfileManagementDialog and SettingsView registered as Transient — each dialog open or tab init creates fresh instance with fresh ViewModel"
|
||||
|
||||
patterns-established:
|
||||
- "Dialog factory via ViewModel delegate: ViewModel exposes Func<Window>? delegate, View layer sets it in constructor — ViewModel stays testable without Window dependency"
|
||||
- "UserControl DI injection: SettingsView receives SettingsViewModel via constructor injection; content set on TabItem from code-behind using serviceProvider"
|
||||
|
||||
requirements-completed:
|
||||
- FOUND-02
|
||||
- FOUND-09
|
||||
- FOUND-12
|
||||
|
||||
# Metrics
|
||||
duration: 3min
|
||||
completed: 2026-04-02
|
||||
---
|
||||
|
||||
# Phase 1 Plan 07: Views (ProfileManagementDialog + SettingsView) Summary
|
||||
|
||||
**ProfileManagementDialog modal and SettingsView UserControl wired into MainWindow via DI factory pattern, completing all Phase 1 user-facing UI**
|
||||
|
||||
## Performance
|
||||
|
||||
- **Duration:** 3 min
|
||||
- **Started:** 2026-04-02T10:36:05Z
|
||||
- **Completed:** 2026-04-02T10:38:57Z
|
||||
- **Tasks:** 2
|
||||
- **Files modified:** 8
|
||||
|
||||
## Accomplishments
|
||||
|
||||
- ProfileManagementDialog is a modal Window with Name / Tenant URL / Client ID input fields, all labels using TranslationSource bindings, wired to ProfileManagementViewModel via DI constructor injection; LoadAsync called on Loaded event
|
||||
- ManageProfilesCommand now fully functional: opens dialog as modal with Owner=MainWindow, reloads TenantProfiles ObservableCollection after ShowDialog() returns
|
||||
- SettingsView UserControl contains language ComboBox with Tag="en"/Tag="fr" items and data folder TextBox + Browse button, bound to SettingsViewModel, LoadAsync on Loaded
|
||||
- Settings TabItem content replaced at runtime with DI-resolved SettingsView (from Transient registration), eliminating the placeholder TextBlock
|
||||
- All 42 unit tests pass (0 regressions), 0 build errors
|
||||
|
||||
## Task Commits
|
||||
|
||||
1. **Task 1: ProfileManagementDialog XAML and code-behind** - `cb7cf93` (feat)
|
||||
2. **Task 2: SettingsView XAML and MainWindow Settings tab wiring** - `0665152` (feat)
|
||||
|
||||
**Plan metadata:** (docs commit follows)
|
||||
|
||||
## Files Created/Modified
|
||||
|
||||
- `SharepointToolbox/Views/Dialogs/ProfileManagementDialog.xaml` — Modal Window with ListBox (profile list), three input fields (Name/TenantUrl/ClientId), Add/Rename/Delete/Close buttons
|
||||
- `SharepointToolbox/Views/Dialogs/ProfileManagementDialog.xaml.cs` — DI constructor injection of ProfileManagementViewModel; LoadAsync on Loaded; CloseButton_Click calls Close()
|
||||
- `SharepointToolbox/Views/Tabs/SettingsView.xaml` — UserControl with language ComboBox (en/fr with TranslationSource bindings) and DockPanel data folder row
|
||||
- `SharepointToolbox/Views/Tabs/SettingsView.xaml.cs` — DI constructor injection of SettingsViewModel; LoadAsync on Loaded
|
||||
- `SharepointToolbox/ViewModels/MainWindowViewModel.cs` — Added OpenProfileManagementDialog Func<Window>? delegate; OpenProfileManagement() now opens dialog, sets Owner, calls ShowDialog(), reloads profiles
|
||||
- `SharepointToolbox/MainWindow.xaml` — Added xmlns:views namespace; removed placeholder TextBlock from SettingsTabItem
|
||||
- `SharepointToolbox/MainWindow.xaml.cs` — Accepts IServiceProvider; sets OpenProfileManagementDialog factory; sets SettingsTabItem.Content to DI-resolved SettingsView
|
||||
- `SharepointToolbox/App.xaml.cs` — Registered ProfileManagementDialog and SettingsView as Transient; added using directives for Views.Dialogs and Views.Tabs
|
||||
|
||||
## Decisions Made
|
||||
|
||||
- `ProfileManagementViewModel` exposes `Func<Window>? OpenProfileManagementDialog` delegate set by `MainWindow.xaml.cs` — keeps ViewModel free from Window/UI references while enabling full dialog lifecycle control (Owner, ShowDialog, post-close reload).
|
||||
- `IServiceProvider` injected into `MainWindow` constructor — automatically resolved by Microsoft.Extensions.DI since `IServiceProvider` is registered as singleton in every host; allows resolving Transient views without `ServiceLocator` antipattern.
|
||||
- `ProfileManagementDialog` and `SettingsView` registered as `Transient` — each invocation produces a fresh instance with a fresh ViewModel, avoiding state leakage between dialog opens.
|
||||
|
||||
## Deviations from Plan
|
||||
|
||||
### Auto-fixed Issues
|
||||
|
||||
**1. [Rule 3 - Blocking] Created SettingsView before Task 1 build verification**
|
||||
- **Found during:** Task 1 (dotnet build after adding SettingsView usings to App.xaml.cs and MainWindow.xaml.cs)
|
||||
- **Issue:** App.xaml.cs and MainWindow.xaml.cs reference `SharepointToolbox.Views.Tabs.SettingsView` which did not exist yet; build failed with CS0234
|
||||
- **Fix:** Created SettingsView.xaml and SettingsView.xaml.cs as part of Task 1 execution before first build verification; committed both tasks as separate commits once both verified clean
|
||||
- **Files modified:** SharepointToolbox/Views/Tabs/SettingsView.xaml, SharepointToolbox/Views/Tabs/SettingsView.xaml.cs
|
||||
- **Verification:** Build succeeded with 0 errors; all 42 unit tests pass
|
||||
- **Committed in:** 0665152 (Task 2 commit)
|
||||
|
||||
---
|
||||
|
||||
**Total deviations:** 1 auto-fixed (1 Rule 3 blocking build issue)
|
||||
**Impact on plan:** Fix necessary for compilation — Tasks 1 and 2 share compile-time dependencies that required creating SettingsView before the first Task 1 build check. Plan intent fully preserved.
|
||||
|
||||
## Issues Encountered
|
||||
|
||||
None beyond the auto-fixed deviation above.
|
||||
|
||||
## User Setup Required
|
||||
|
||||
None — no external service configuration required.
|
||||
|
||||
## Next Phase Readiness
|
||||
|
||||
- All Phase 1 UI is now built: shell (plan 01-06) + ProfileManagementDialog + SettingsView (this plan)
|
||||
- Application is ready for the Phase 1 visual checkpoint (plan 01-08): user can create tenant profile, connect, switch language, configure data folder
|
||||
- Language switching is immediate (TranslationSource.Instance.CurrentCulture) with no restart required
|
||||
- Profile CRUD fully wired: Add/Rename/Delete commands in dialog refresh MainWindow toolbar ComboBox after close
|
||||
- SettingsView language and folder settings persist to Sharepoint_Settings.json via SettingsService
|
||||
|
||||
## Self-Check: PASSED
|
||||
|
||||
- FOUND: SharepointToolbox/Views/Dialogs/ProfileManagementDialog.xaml
|
||||
- FOUND: SharepointToolbox/Views/Dialogs/ProfileManagementDialog.xaml.cs
|
||||
- FOUND: SharepointToolbox/Views/Tabs/SettingsView.xaml
|
||||
- FOUND: SharepointToolbox/Views/Tabs/SettingsView.xaml.cs
|
||||
- FOUND: SharepointToolbox/ViewModels/MainWindowViewModel.cs (contains OpenProfileManagementDialog)
|
||||
- FOUND: SharepointToolbox/MainWindow.xaml (contains xmlns:views)
|
||||
- FOUND: SharepointToolbox/MainWindow.xaml.cs (contains IServiceProvider injection)
|
||||
- FOUND: SharepointToolbox/App.xaml.cs (contains ProfileManagementDialog registration)
|
||||
- Commit cb7cf93: feat(01-07): add ProfileManagementDialog with DI factory wiring
|
||||
- Commit 0665152: feat(01-07): add SettingsView and wire into MainWindow Settings tab
|
||||
|
||||
---
|
||||
*Phase: 01-foundation*
|
||||
*Completed: 2026-04-02*
|
||||
163
.planning/milestones/v1.0-phases/01-foundation/01-08-PLAN.md
Normal file
163
.planning/milestones/v1.0-phases/01-foundation/01-08-PLAN.md
Normal file
@@ -0,0 +1,163 @@
|
||||
---
|
||||
phase: 01-foundation
|
||||
plan: 08
|
||||
type: execute
|
||||
wave: 7
|
||||
depends_on:
|
||||
- 01-07
|
||||
files_modified: []
|
||||
autonomous: false
|
||||
requirements:
|
||||
- FOUND-01
|
||||
- FOUND-02
|
||||
- FOUND-03
|
||||
- FOUND-04
|
||||
- FOUND-05
|
||||
- FOUND-06
|
||||
- FOUND-07
|
||||
- FOUND-08
|
||||
- FOUND-09
|
||||
- FOUND-10
|
||||
- FOUND-12
|
||||
must_haves:
|
||||
truths:
|
||||
- "Application launches without crashing from dotnet run"
|
||||
- "All 8 tabs visible with correct localized headers"
|
||||
- "Language switch from Settings tab changes tab headers immediately without restart"
|
||||
- "Profile management dialog opens, allows adding/renaming/deleting profiles"
|
||||
- "Log panel at bottom shows timestamped messages with color coding"
|
||||
- "Status bar shows tenant name and connection status"
|
||||
- "All unit tests pass (zero failures)"
|
||||
artifacts:
|
||||
- path: "SharepointToolbox/App.xaml.cs"
|
||||
provides: "Running application entry point"
|
||||
- path: "SharepointToolbox/Views/MainWindow.xaml"
|
||||
provides: "Visible shell with all required regions"
|
||||
key_links:
|
||||
- from: "Visual inspection"
|
||||
to: "Phase 1 success criteria (ROADMAP.md)"
|
||||
via: "Manual verification checklist"
|
||||
pattern: "checkpoint"
|
||||
---
|
||||
|
||||
<objective>
|
||||
Run the full test suite, launch the application, and perform visual/functional verification of all Phase 1 success criteria before marking the phase complete.
|
||||
|
||||
Purpose: Automated tests validate logic, but WPF UI can fail visually in ways tests cannot catch (layout wrong, bindings silently failing, log panel invisible, crash on startup).
|
||||
Output: Confirmed working foundation. Green light for Phase 2.
|
||||
</objective>
|
||||
|
||||
<execution_context>
|
||||
@C:/Users/SebastienQUEROL/.claude/get-shit-done/workflows/execute-plan.md
|
||||
@C:/Users/SebastienQUEROL/.claude/get-shit-done/templates/summary.md
|
||||
</execution_context>
|
||||
|
||||
<context>
|
||||
@.planning/ROADMAP.md
|
||||
@.planning/phases/01-foundation/01-CONTEXT.md
|
||||
@.planning/phases/01-foundation/01-07-SUMMARY.md
|
||||
</context>
|
||||
|
||||
<tasks>
|
||||
|
||||
<task type="auto">
|
||||
<name>Task 1: Run full test suite and verify zero failures</name>
|
||||
<files><!-- no files created or modified — test-execution-only task --></files>
|
||||
<action>
|
||||
Run the complete test suite:
|
||||
```
|
||||
dotnet test SharepointToolbox.Tests/SharepointToolbox.Tests.csproj --no-build -v normal
|
||||
```
|
||||
|
||||
Expected result: All Unit and Integration tests pass. The following tests may remain as `Skip`:
|
||||
- `SessionManagerTests.GetOrCreateContextAsync_CreatesContext` (requires interactive MSAL)
|
||||
|
||||
If any tests fail:
|
||||
1. Read the failure message carefully
|
||||
2. Fix the underlying code (do NOT delete or skip a failing test)
|
||||
3. Re-run until all non-interactive tests pass
|
||||
|
||||
Also run a build to confirm zero warnings (treat warnings as potential future failures):
|
||||
```
|
||||
dotnet build SharepointToolbox.sln -warnaserror
|
||||
```
|
||||
If warnings-as-errors produces failures from NuGet or generated code, switch back to `dotnet build SharepointToolbox.sln` and list remaining warnings in the SUMMARY.
|
||||
</action>
|
||||
<verify>
|
||||
<automated>cd "C:\Users\dev\Documents\projets\Sharepoint" && dotnet test SharepointToolbox.Tests/SharepointToolbox.Tests.csproj 2>&1 | tail -15</automated>
|
||||
</verify>
|
||||
<done>Test output shows 0 failed. All non-interactive tests pass. Build produces 0 errors.</done>
|
||||
</task>
|
||||
|
||||
<task type="checkpoint:human-verify" gate="blocking">
|
||||
<what-built>
|
||||
Complete Phase 1 Foundation:
|
||||
- WPF shell with 8-tab layout, log panel (150px, black background, green text), StatusBar
|
||||
- Toolbar: tenant ComboBox (220px), Connect, Manage Profiles, separator, Clear Session
|
||||
- Profile management dialog (modal) — add, rename, delete tenant profiles
|
||||
- Settings tab: language switcher (EN/FR) + data folder picker
|
||||
- Dynamic language switching — changes tab headers without restart
|
||||
- Serilog rolling file log + LogPanelSink writing to in-app RichTextBox
|
||||
- Global exception handlers wired
|
||||
- All infrastructure patterns in place (pagination helper, retry helper, FeatureViewModelBase)
|
||||
- Per-tab FeatureTabBase UserControl with ProgressBar + Cancel strip (shown only when IsRunning)
|
||||
- StatusBar middle field shows live operation status text (ProgressStatus)
|
||||
</what-built>
|
||||
<how-to-verify>
|
||||
Run the application: `dotnet run --project SharepointToolbox/SharepointToolbox.csproj`
|
||||
|
||||
Check each item:
|
||||
|
||||
1. **Shell layout**: Window shows toolbar at top, TabControl in center with 8 tabs (Permissions, Storage, File Search, Duplicates, Templates, Bulk Operations, Folder Structure, Settings), log panel at bottom (black, 150px), status bar below log.
|
||||
|
||||
2. **Tab headers**: All 8 tabs have their English localized text (not "[tab.xxx]" — which would mean missing resx key).
|
||||
|
||||
3. **Language switch**:
|
||||
- Open Settings tab
|
||||
- Change language to French
|
||||
- Verify tab headers change immediately (no restart)
|
||||
- Change back to English to reset
|
||||
|
||||
4. **Profile management**:
|
||||
- Click "Manage Profiles..."
|
||||
- Modal dialog appears
|
||||
- Add a test profile: Name="Test", URL="https://test.sharepoint.com", ClientId="test-id"
|
||||
- Profile appears in the toolbar ComboBox after dialog closes
|
||||
- Rename the profile in the dialog — new name shows in ComboBox
|
||||
- Delete the profile — removed from ComboBox
|
||||
|
||||
5. **Log panel**:
|
||||
- Verify log entries appear (at least startup messages) in `HH:mm:ss [XXXX] message` format
|
||||
- Verify green color for info entries
|
||||
|
||||
6. **Data folder**:
|
||||
- Open Settings tab
|
||||
- Click Browse, select a folder
|
||||
- Verify folder path appears in the TextBox
|
||||
|
||||
7. **Error handler** (optional — skip if risky):
|
||||
- Confirm `%AppData%\SharepointToolbox\logs\` directory exists and contains today's log file
|
||||
|
||||
Report any visual issues, missing strings, or crashes.
|
||||
</how-to-verify>
|
||||
<resume-signal>Type "approved" if all checks pass, or describe specific issues found</resume-signal>
|
||||
</task>
|
||||
|
||||
</tasks>
|
||||
|
||||
<verification>
|
||||
All Phase 1 ROADMAP success criteria met:
|
||||
1. User can create, rename, delete, and switch between tenant profiles via the UI
|
||||
2. MSAL token cache infrastructure ready (interactive login requires a real Azure AD tenant — not testable in this checkpoint)
|
||||
3. Per-tab progress bar + cancel button infrastructure built (FeatureTabBase UserControl wired in all 7 stub tabs; FeatureViewModelBase tests prove the pattern)
|
||||
4. Log panel surfaces errors in red; global exception handlers registered
|
||||
5. Language switches between EN and FR dynamically without restart
|
||||
</verification>
|
||||
|
||||
<success_criteria>
|
||||
Human approves visual checkpoint. All unit tests green. Phase 1 complete — ready to begin Phase 2 (Permissions).
|
||||
</success_criteria>
|
||||
|
||||
<output>
|
||||
After completion, create `.planning/phases/01-foundation/01-08-SUMMARY.md`
|
||||
</output>
|
||||
152
.planning/milestones/v1.0-phases/01-foundation/01-08-SUMMARY.md
Normal file
152
.planning/milestones/v1.0-phases/01-foundation/01-08-SUMMARY.md
Normal file
@@ -0,0 +1,152 @@
|
||||
---
|
||||
phase: 01-foundation
|
||||
plan: 08
|
||||
subsystem: testing
|
||||
tags: [xunit, dotnet, wpf, build-verification, localization, dependency-injection]
|
||||
|
||||
# Dependency graph
|
||||
requires:
|
||||
- phase: 01-foundation plan 07
|
||||
provides: All Phase 1 implementation complete (WPF shell, 8-tab layout, profiles, settings, log panel, MSAL, localization)
|
||||
provides:
|
||||
- Confirmed zero-failure test suite (44 pass, 1 skip)
|
||||
- Confirmed zero-warning, zero-error build with -warnaserror
|
||||
- Human-verified WPF shell: 8 tabs, log panel, language switching, profile CRUD all confirmed working
|
||||
- Phase 1 Foundation complete — green light for Phase 2 (Permissions)
|
||||
affects:
|
||||
- 02-permissions (Phase 1 complete, Phase 2 planning can begin)
|
||||
|
||||
# Tech tracking
|
||||
tech-stack:
|
||||
added: []
|
||||
patterns:
|
||||
- "Test run with --no-build to avoid re-compile overhead on CI-style checks"
|
||||
- "Build verification using -warnaserror as final gate before phase close"
|
||||
|
||||
key-files:
|
||||
created: []
|
||||
modified:
|
||||
- SharepointToolbox/App.xaml.cs (DI registration fixes for ProfileRepository and SettingsRepository)
|
||||
- SharepointToolbox/Localization/Strings.fr.resx (real French translations replacing English stubs)
|
||||
|
||||
key-decisions:
|
||||
- "Solution file is .slnx (not .sln) — dotnet build/test commands must use SharepointToolbox.slnx"
|
||||
- "45 tests total: 44 pass, 1 skip (interactive MSAL GetOrCreateContextAsync_CreatesContext — browser/WAM flow excluded from automated suite)"
|
||||
|
||||
patterns-established:
|
||||
- "Final phase gate: dotnet test --no-build then dotnet build -warnaserror before closing any phase"
|
||||
|
||||
requirements-completed:
|
||||
- FOUND-01
|
||||
- FOUND-02
|
||||
- FOUND-03
|
||||
- FOUND-04
|
||||
- FOUND-05
|
||||
- FOUND-06
|
||||
- FOUND-07
|
||||
- FOUND-08
|
||||
- FOUND-09
|
||||
- FOUND-10
|
||||
- FOUND-12
|
||||
|
||||
# Metrics
|
||||
duration: 15min
|
||||
completed: 2026-04-02
|
||||
---
|
||||
|
||||
# Phase 1 Plan 08: Final Verification Summary
|
||||
|
||||
**Full test suite passes (44/44 non-interactive tests green), build warning-free under -warnaserror, and human visual checkpoint confirmed WPF shell with 8 tabs, log panel, language switching, and profile CRUD all working correctly — Phase 1 complete**
|
||||
|
||||
## Performance
|
||||
|
||||
- **Duration:** ~15 min (including checkpoint fixes)
|
||||
- **Started:** 2026-04-02T10:41:13Z
|
||||
- **Completed:** 2026-04-02T10:52:16Z
|
||||
- **Tasks:** 2 of 2 completed
|
||||
- **Files modified:** 3
|
||||
|
||||
## Accomplishments
|
||||
|
||||
- dotnet build SharepointToolbox.slnx with -warnaserror: 0 warnings, 0 errors
|
||||
- dotnet test: 44 passed, 1 skipped (interactive MSAL — expected), 0 failed
|
||||
- Build time 1.58s, test run 0.87s — fast baseline confirmed
|
||||
- Human visual checkpoint approved: all 7 checklist items verified (shell layout, tab headers, language switch, profile management, log panel, data folder, log file)
|
||||
- Fixed 3 runtime issues discovered during application launch: missing DI registrations and stub French translations
|
||||
|
||||
## Task Commits
|
||||
|
||||
Each task committed atomically:
|
||||
|
||||
1. **Task 1: Run full test suite and verify zero failures** - `334a5f1` (chore)
|
||||
2. **Task 2: Visual/functional verification checkpoint** - Human approved (no code commit — verification task)
|
||||
|
||||
**Fix commits (deviations auto-fixed before checkpoint):**
|
||||
- `c66efda` — fix: register ProfileRepository and SettingsRepository in DI container
|
||||
- `6211f65` — fix: provide file paths to ProfileRepository and SettingsRepository via factory registration
|
||||
- `0b8a86a` — fix: add real French translations (stubs were identical to English)
|
||||
|
||||
**Plan metadata:** pending (this commit)
|
||||
|
||||
## Files Created/Modified
|
||||
|
||||
- `SharepointToolbox/App.xaml.cs` - Added DI registrations for ProfileRepository and SettingsRepository with correct file paths
|
||||
- `SharepointToolbox/Localization/Strings.fr.resx` - Replaced English-copy stubs with actual French translations for all UI strings
|
||||
|
||||
## Decisions Made
|
||||
|
||||
- Solution file is `.slnx` (not `.sln`) — all dotnet commands must reference `SharepointToolbox.slnx`
|
||||
- 45 tests total: 44 pass, 1 deliberate skip for interactive MSAL browser flow
|
||||
|
||||
## Deviations from Plan
|
||||
|
||||
### Auto-fixed Issues
|
||||
|
||||
**1. [Rule 3 - Blocking] ProfileRepository and SettingsRepository not registered in DI container**
|
||||
- **Found during:** Task 2 (application launch for visual verification)
|
||||
- **Issue:** App crashed on startup — IProfileRepository and ISettingsRepository not registered in the DI container; MainWindowViewModel constructor injection failed with a missing service exception
|
||||
- **Fix:** Registered both repositories in App.xaml.cs using factory lambdas that provide the correct AppData file paths for profiles.json and settings.json
|
||||
- **Files modified:** SharepointToolbox/App.xaml.cs
|
||||
- **Verification:** Application launched successfully after fix
|
||||
- **Committed in:** c66efda + 6211f65 (two-step fix — registration then path injection)
|
||||
|
||||
**2. [Rule 1 - Bug] French translations were identical to English (stub copy)**
|
||||
- **Found during:** Task 2 (language switch verification step)
|
||||
- **Issue:** Switching language to French showed English text — Strings.fr.resx contained English strings copied verbatim from Strings.resx with no actual translations
|
||||
- **Fix:** Replaced all 27 stub entries with correct French translations for all UI strings (tab headers, toolbar labels, dialog buttons, settings labels, log messages)
|
||||
- **Files modified:** SharepointToolbox/Localization/Strings.fr.resx
|
||||
- **Verification:** Language switch in Settings tab now shows French tab headers and UI labels correctly
|
||||
- **Committed in:** 0b8a86a
|
||||
|
||||
---
|
||||
|
||||
**Total deviations:** 3 commits auto-fixed (1 Rule 3 blocking crash + 1 Rule 1 bug — stub translations)
|
||||
**Impact on plan:** All fixes were necessary for the application to function correctly. DI registration was a blocking runtime crash; French translations were a correctness bug that would have left FR locale non-functional. No scope creep.
|
||||
|
||||
## Issues Encountered
|
||||
|
||||
None beyond the auto-fixed deviations above.
|
||||
|
||||
## User Setup Required
|
||||
|
||||
None - no external service configuration required.
|
||||
|
||||
## Next Phase Readiness
|
||||
|
||||
- Phase 1 Foundation is complete — all 11 requirements (FOUND-01 through FOUND-12 excluding FOUND-11) delivered
|
||||
- Human visual checkpoint confirmed: shell, tabs, log panel, language switching, profile management all working
|
||||
- Ready to begin Phase 2 (Permissions): PermissionsService, scan logic, CSV/HTML export
|
||||
- FOUND-11 (self-contained EXE packaging) is deferred to Phase 5 as planned
|
||||
|
||||
## Self-Check: PASSED
|
||||
|
||||
- FOUND: SharepointToolbox/App.xaml.cs (contains ProfileRepository + SettingsRepository DI registrations)
|
||||
- FOUND: SharepointToolbox/Localization/Strings.fr.resx (contains real French translations)
|
||||
- Commit 334a5f1: chore(01-08): run full test suite — 44 passed, 1 skipped, 0 failed
|
||||
- Commit c66efda: fix(01-08): register ProfileRepository and SettingsRepository in DI container
|
||||
- Commit 6211f65: fix(01-08): provide file paths to ProfileRepository and SettingsRepository via factory registration
|
||||
- Commit 0b8a86a: fix(01-08): add real French translations (stubs were identical to English)
|
||||
|
||||
---
|
||||
*Phase: 01-foundation*
|
||||
*Completed: 2026-04-02*
|
||||
119
.planning/milestones/v1.0-phases/01-foundation/01-CONTEXT.md
Normal file
119
.planning/milestones/v1.0-phases/01-foundation/01-CONTEXT.md
Normal file
@@ -0,0 +1,119 @@
|
||||
---
|
||||
phase: 1
|
||||
title: Foundation
|
||||
status: ready-for-planning
|
||||
created: 2026-04-02
|
||||
---
|
||||
|
||||
# Phase 1 Context: Foundation
|
||||
|
||||
## Decided Areas (from prior research + STATE.md)
|
||||
|
||||
These are locked — do not re-litigate during planning or execution.
|
||||
|
||||
| Decision | Value |
|
||||
|---|---|
|
||||
| Runtime | .NET 10 LTS + WPF |
|
||||
| MVVM framework | CommunityToolkit.Mvvm 8.4.2 |
|
||||
| SharePoint library | PnP.Framework 1.18.0 |
|
||||
| Auth | MSAL.NET 4.83.1 + Extensions.Msal 4.83.3 + Desktop 4.82.1 |
|
||||
| Token cache | MsalCacheHelper — one `IPublicClientApplication` per ClientId |
|
||||
| DI host | Microsoft.Extensions.Hosting 10.x |
|
||||
| Logging | Serilog 4.3.1 + rolling file sink → `%AppData%\SharepointToolbox\logs\` |
|
||||
| JSON | System.Text.Json (built-in) |
|
||||
| JSON persistence | Write-then-replace (`file.tmp` → validate → `File.Move`) + `SemaphoreSlim(1)` per file |
|
||||
| Async pattern | `AsyncRelayCommand` everywhere — zero `async void` handlers |
|
||||
| Trimming | `PublishTrimmed=false` — accept ~150–200 MB EXE |
|
||||
| Architecture | 4-layer MVVM: View → ViewModel → Service → Infrastructure |
|
||||
| Cross-VM messaging | `WeakReferenceMessenger` for tenant-switched events |
|
||||
| Session holder | Singleton `SessionManager` — only class that holds `ClientContext` objects |
|
||||
| Localization | .resx resource files (EN default, FR overlay) |
|
||||
|
||||
## Gray Areas — Defaults Applied (user skipped discussion)
|
||||
|
||||
### 1. Shell Layout
|
||||
|
||||
**Default:** Mirror the existing tool's spatial contract — users are already trained on it.
|
||||
|
||||
- **Window structure:** `MainWindow` with a top `ToolBar`, a center `TabControl` (feature tabs), and a bottom docked log panel.
|
||||
- **Log panel:** Always visible, 150 px tall, not collapsible in Phase 1 (collapsibility is cosmetic — defer to a later phase). Uses a `RichTextBox`-equivalent (`RichTextBox` XAML control) with color-coded entries.
|
||||
- **Tab strip:** `TabControl` with one `TabItem` per feature area. Phase 1 delivers a shell with placeholder tabs for all features so navigation is wired from day one.
|
||||
- **Tabs to stub out:** Permissions, Storage, File Search, Duplicates, Templates, Bulk Operations, Folder Structure, Settings — all stubbed with a `"Coming soon"` placeholder `TextBlock` except Settings (partially functional in Phase 1 for profile management and language switching).
|
||||
- **Status bar:** `StatusBar` at the very bottom (below the log panel) showing: current tenant display name | operation status text | progress percentage.
|
||||
|
||||
### 2. Tenant Selector Placement
|
||||
|
||||
**Default:** Prominent top-toolbar presence — tenant context is the most critical runtime state.
|
||||
|
||||
- **Toolbar layout (left to right):** `ComboBox` (tenant display name list, ~220 px wide) → `Button "Connect"` → `Button "Manage Profiles..."` → separator → `Button "Clear Session"`.
|
||||
- **ComboBox:** Bound to `MainWindowViewModel.TenantProfiles` ObservableCollection. Selecting a different item triggers a tenant-switch command (WeakReferenceMessenger broadcast to reset all feature VMs).
|
||||
- **"Manage Profiles..." button:** Opens a modal `ProfileManagementDialog` (separate Window) for CRUD — create, rename, delete profiles. Inline editing in the toolbar would be too cramped.
|
||||
- **"Clear Session" button:** Clears the MSAL token cache for the currently selected tenant and resets connection state. Lives in the toolbar (not buried in settings) because MSP users need quick access when switching client accounts mid-session.
|
||||
- **Profile fields:** Name (display label), Tenant URL, Client ID — matches existing `{ name, tenantUrl, clientId }` JSON schema exactly.
|
||||
|
||||
### 3. Progress + Cancel UX
|
||||
|
||||
**Default:** Per-tab pattern — each feature tab owns its progress state. No global progress bar.
|
||||
|
||||
- **Per-tab layout (bottom of each tab's content area):** `ProgressBar` (indeterminate or 0–100) + `TextBlock` (operation description, e.g. "Scanning site 3 of 12…") + `Button "Cancel"` — shown only when an operation is running (`Visibility` bound to `IsRunning`).
|
||||
- **`CancellationTokenSource`:** Owned by each ViewModel, recreated per operation. Cancel button calls `_cts.Cancel()`.
|
||||
- **`IProgress<OperationProgress>`:** `OperationProgress` is a shared record `{ int Current, int Total, string Message }` — defined in the `Core/` layer and used by all feature services. Concrete implementation uses `Progress<T>` which marshals to the UI thread automatically.
|
||||
- **Log panel as secondary channel:** Every progress step that produces a meaningful event also writes a timestamped line to the log panel. The per-tab progress bar is the live indicator; the log is the audit trail.
|
||||
- **Status bar:** `StatusBar` at the bottom updates its operation text from the active tab's progress events via WeakReferenceMessenger — so the user sees progress even if they switch away from the running tab.
|
||||
|
||||
### 4. Error Surface UX
|
||||
|
||||
**Default:** Log panel as primary surface; modal dialog only for blocking errors.
|
||||
|
||||
- **Non-fatal errors** (an operation failed, a SharePoint call returned an error): Written to log panel in red. The per-tab status area shows a brief summary (e.g. "Completed with 2 errors — see log"). No modal.
|
||||
- **Fatal/blocking errors** (auth failure, unhandled exception): `MessageBox.Show` modal with the error message and a "Copy to Clipboard" button for diagnostics. Keep it simple — no custom dialog in Phase 1.
|
||||
- **No toasts in Phase 1:** Toast/notification infrastructure is a cosmetic feature — defer. The log panel is always visible and sufficient.
|
||||
- **Log entry format:** `HH:mm:ss [LEVEL] Message` — color coded: green = info/success, orange = warning, red = error. `LEVEL` maps to Serilog severity.
|
||||
- **Global exception handler:** `Application.DispatcherUnhandledException` and `TaskScheduler.UnobservedTaskException` both funnel to the log panel + a fatal modal. Neither swallows the exception.
|
||||
- **Empty catch block policy:** Any `catch` block must do exactly one of: log-and-recover, log-and-rethrow, or log-and-surface. Empty catch = build defect. Enforce via code review on every PR in Phase 1.
|
||||
|
||||
## JSON Compatibility
|
||||
|
||||
Existing file names and schema must be preserved exactly — users have live data in these files.
|
||||
|
||||
| File | Schema |
|
||||
|---|---|
|
||||
| `Sharepoint_Export_profiles.json` | `{ "profiles": [{ "name": "...", "tenantUrl": "...", "clientId": "..." }] }` |
|
||||
| `Sharepoint_Settings.json` | `{ "dataFolder": "...", "lang": "en" }` |
|
||||
|
||||
The C# `SettingsService` must read these files without migration — the field names are the contract.
|
||||
|
||||
## Localization
|
||||
|
||||
- **EN strings are the default `.resx`** — `Strings.resx` (neutral/EN). FR is `Strings.fr.resx`.
|
||||
- **Key naming:** Mirror existing PowerShell key convention (`tab.perms`, `btn.run.scan`, `menu.language`, etc.) so the EN default content is easily auditable against the existing app.
|
||||
- **Dynamic switching:** `CultureInfo.CurrentUICulture` swap + `WeakReferenceMessenger` broadcast triggers all bound `LocalizedString` markup extensions to re-evaluate. No app restart needed.
|
||||
- **FR completeness:** FR strings will be stubbed with EN fallback in Phase 1 — FR completeness is a Phase 5 concern.
|
||||
|
||||
## Infrastructure Patterns (Phase 1 Deliverables)
|
||||
|
||||
These are shared helpers that all feature phases reuse. They must be built and tested in Phase 1 before any feature work begins.
|
||||
|
||||
1. **`SharePointPaginationHelper`** — static helper that wraps `CamlQuery` with `RowLimit ≤ 2,000` and `ListItemCollectionPosition` looping. All list enumeration in the codebase must call this — never raw `ExecuteQuery` on a list.
|
||||
2. **`AsyncRelayCommand` pattern** — a thin base or example `FeatureViewModel` that demonstrates the canonical async command pattern: create `CancellationTokenSource`, bind `IsRunning`, bind `IProgress<OperationProgress>`, handle `OperationCanceledException` gracefully.
|
||||
3. **`ObservableCollection` threading rule** — results are accumulated in `List<T>` on a background thread, then assigned as `new ObservableCollection<T>(list)` via `Dispatcher.InvokeAsync`. Never modify an `ObservableCollection` from `Task.Run`.
|
||||
4. **`ExecuteQueryRetryAsync` wrapper** — wraps PnP Framework's retry logic. All CSOM calls use this; surface retry events as log + progress messages ("Throttled — retrying in 30s…").
|
||||
5. **`ClientContext` disposal** — always `await using`. Unit tests verify `Dispose()` is called on cancellation.
|
||||
|
||||
## Deferred Ideas (out of scope for Phase 1)
|
||||
|
||||
- Log panel collapsibility (cosmetic, Phase 3+)
|
||||
- Dark/light theme toggle (cosmetic, post-v1)
|
||||
- Toast/notification system (Phase 3+)
|
||||
- FR locale completeness (Phase 5)
|
||||
- User access export, storage charts, simplified permissions view (v1.x features, Phase 5)
|
||||
|
||||
## code_context
|
||||
|
||||
| Asset | Path | Notes |
|
||||
|---|---|---|
|
||||
| Existing profile JSON schema | `Sharepoint_ToolBox.ps1:68–72` | `Save-Profiles` shows exact field names |
|
||||
| Existing settings JSON schema | `Sharepoint_ToolBox.ps1:147–152` | `Save-Settings` shows `dataFolder` + `lang` |
|
||||
| Existing localization keys (EN) | `Sharepoint_ToolBox.ps1:2795–2870` (approx) | Full EN key set for `.resx` migration |
|
||||
| Existing tab names | `Sharepoint_ToolBox.ps1:3824` | 9 tabs: Perms, Storage, Templates, Search, Dupes, Transfer, Bulk, Struct, Versions |
|
||||
| Log panel pattern | `Sharepoint_ToolBox.ps1:6–17` | Color + timestamp format to mirror |
|
||||
842
.planning/milestones/v1.0-phases/01-foundation/01-RESEARCH.md
Normal file
842
.planning/milestones/v1.0-phases/01-foundation/01-RESEARCH.md
Normal file
@@ -0,0 +1,842 @@
|
||||
# Phase 1: Foundation - Research
|
||||
|
||||
**Researched:** 2026-04-02
|
||||
**Domain:** WPF/.NET 10, MVVM, MSAL authentication, multi-tenant session management, structured logging, localization
|
||||
**Confidence:** HIGH
|
||||
|
||||
---
|
||||
|
||||
<user_constraints>
|
||||
## User Constraints (from CONTEXT.md)
|
||||
|
||||
### Locked Decisions
|
||||
|
||||
| Decision | Value |
|
||||
|---|---|
|
||||
| Runtime | .NET 10 LTS + WPF |
|
||||
| MVVM framework | CommunityToolkit.Mvvm 8.4.2 |
|
||||
| SharePoint library | PnP.Framework 1.18.0 |
|
||||
| Auth | MSAL.NET 4.83.1 + Extensions.Msal 4.83.3 + Desktop 4.82.1 |
|
||||
| Token cache | MsalCacheHelper — one `IPublicClientApplication` per ClientId |
|
||||
| DI host | Microsoft.Extensions.Hosting 10.x |
|
||||
| Logging | Serilog 4.3.1 + rolling file sink → `%AppData%\SharepointToolbox\logs\` |
|
||||
| JSON | System.Text.Json (built-in) |
|
||||
| JSON persistence | Write-then-replace (`file.tmp` → validate → `File.Move`) + `SemaphoreSlim(1)` per file |
|
||||
| Async pattern | `AsyncRelayCommand` everywhere — zero `async void` handlers |
|
||||
| Trimming | `PublishTrimmed=false` — accept ~150–200 MB EXE |
|
||||
| Architecture | 4-layer MVVM: View → ViewModel → Service → Infrastructure |
|
||||
| Cross-VM messaging | `WeakReferenceMessenger` for tenant-switched events |
|
||||
| Session holder | Singleton `SessionManager` — only class that holds `ClientContext` objects |
|
||||
| Localization | .resx resource files (EN default, FR overlay) |
|
||||
|
||||
### Shell Layout (defaults applied — not re-litigatable)
|
||||
|
||||
- `MainWindow` with top `ToolBar`, center `TabControl`, bottom docked `RichTextBox` log panel (150 px, always visible)
|
||||
- `StatusBar` at very bottom: tenant name | operation status | progress %
|
||||
- Toolbar (L→R): `ComboBox` (220 px, tenant list) → `Button "Connect"` → `Button "Manage Profiles..."` → separator → `Button "Clear Session"`
|
||||
- Profile fields: Name, Tenant URL, Client ID — matches `{ name, tenantUrl, clientId }` JSON exactly
|
||||
- All feature tabs stubbed with "Coming soon" placeholder except Settings (profile management + language)
|
||||
|
||||
### Progress + Cancel UX (locked)
|
||||
|
||||
- Per-tab: `ProgressBar` + `TextBlock` + `Button "Cancel"` — visible only when `IsRunning`
|
||||
- `CancellationTokenSource` owned by each ViewModel, recreated per operation
|
||||
- `IProgress<OperationProgress>` where `OperationProgress = { int Current, int Total, string Message }`
|
||||
- Log panel writes every meaningful progress event (timestamped)
|
||||
- `StatusBar` updates from active tab via `WeakReferenceMessenger`
|
||||
|
||||
### Error Surface UX (locked)
|
||||
|
||||
- Non-fatal: red log panel entry + per-tab status summary — no modal
|
||||
- Fatal/blocking: `MessageBox.Show` modal + "Copy to Clipboard" button
|
||||
- No toasts in Phase 1
|
||||
- Log format: `HH:mm:ss [LEVEL] Message` — green=info, orange=warning, red=error
|
||||
- Global handlers: `Application.DispatcherUnhandledException` + `TaskScheduler.UnobservedTaskException`
|
||||
- Empty catch block = build defect; enforced in code review
|
||||
|
||||
### JSON Compatibility (locked — live user data)
|
||||
|
||||
| File | Schema |
|
||||
|---|---|
|
||||
| `Sharepoint_Export_profiles.json` | `{ "profiles": [{ "name": "...", "tenantUrl": "...", "clientId": "..." }] }` |
|
||||
| `Sharepoint_Settings.json` | `{ "dataFolder": "...", "lang": "en" }` |
|
||||
|
||||
### Localization (locked)
|
||||
|
||||
- `Strings.resx` (EN/neutral default), `Strings.fr.resx` (FR overlay)
|
||||
- Key naming mirrors existing PowerShell convention: `tab.perms`, `btn.run.scan`, `menu.language`, etc.
|
||||
- Dynamic switching: `CultureInfo.CurrentUICulture` swap + `WeakReferenceMessenger` broadcast
|
||||
- FR strings stubbed with EN fallback in Phase 1
|
||||
|
||||
### Infrastructure Patterns (Phase 1 required deliverables)
|
||||
|
||||
1. `SharePointPaginationHelper` — static helper wrapping `CamlQuery` + `ListItemCollectionPosition` looping, `RowLimit ≤ 2000`
|
||||
2. `AsyncRelayCommand` canonical example — `FeatureViewModel` base showing `CancellationTokenSource` + `IsRunning` + `IProgress<OperationProgress>` + `OperationCanceledException` handling
|
||||
3. `ObservableCollection` threading rule — accumulate in `List<T>` on background, then `Dispatcher.InvokeAsync` with `new ObservableCollection<T>(list)`
|
||||
4. `ExecuteQueryRetryAsync` wrapper — wraps PnP Framework retry; surfaces retry events as log + progress messages
|
||||
5. `ClientContext` disposal — always `await using`; unit tests verify `Dispose()` on cancellation
|
||||
|
||||
### Deferred Ideas (OUT OF SCOPE for Phase 1)
|
||||
|
||||
- Log panel collapsibility
|
||||
- Dark/light theme toggle
|
||||
- Toast/notification system
|
||||
- FR locale completeness (Phase 5)
|
||||
- User access export, storage charts, simplified permissions view
|
||||
</user_constraints>
|
||||
|
||||
---
|
||||
|
||||
<phase_requirements>
|
||||
## Phase Requirements
|
||||
|
||||
| ID | Description | Research Support |
|
||||
|----|-------------|-----------------|
|
||||
| FOUND-01 | Application built with C#/WPF (.NET 10 LTS) using MVVM architecture | Generic Host DI pattern, CommunityToolkit.Mvvm ObservableObject/RelayCommand stack confirmed |
|
||||
| FOUND-02 | Multi-tenant profile registry — create, rename, delete, switch tenant profiles | ProfileService using System.Text.Json + write-then-replace pattern; ComboBox bound to ObservableCollection |
|
||||
| FOUND-03 | Multi-tenant session caching — stay authenticated across tenant switches | MsalCacheHelper per ClientId (one IPublicClientApplication per tenant), AcquireTokenSilent flow |
|
||||
| FOUND-04 | Interactive Azure AD OAuth login via browser — no client secrets | MSAL PublicClientApplicationBuilder + AcquireTokenInteractive; PnP AuthenticationManager.CreateWithInteractiveLogin |
|
||||
| FOUND-05 | All long-running operations report progress to the UI in real-time | IProgress<OperationProgress> + Progress<T> (marshals to UI thread automatically) |
|
||||
| FOUND-06 | User can cancel any long-running operation mid-execution | CancellationTokenSource per ViewModel; AsyncRelayCommand.Cancel(); OperationCanceledException handling |
|
||||
| FOUND-07 | All errors surface to the user with actionable messages — no silent failures | Global DispatcherUnhandledException + TaskScheduler.UnobservedTaskException; empty-catch policy |
|
||||
| FOUND-08 | Structured logging for diagnostics | Serilog 4.3.1 + Serilog.Sinks.File (rolling daily) → %AppData%\SharepointToolbox\logs\ |
|
||||
| FOUND-09 | Localization system supporting English and French with dynamic language switching | Strings.resx + Strings.fr.resx; singleton TranslationSource + WeakReferenceMessenger broadcast |
|
||||
| FOUND-10 | JSON-based local storage compatible with current app format | System.Text.Json; existing field names preserved exactly; write-then-replace with SemaphoreSlim(1) |
|
||||
| FOUND-12 | Configurable data output folder for exports | SettingsService reads/writes `Sharepoint_Settings.json`; FolderBrowserDialog in Settings tab |
|
||||
</phase_requirements>
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
Phase 1 establishes the entire skeleton on which all feature phases build. The technical choices are fully locked and research-validated. The stack (.NET 10 + WPF + CommunityToolkit.Mvvm + MSAL + PnP.Framework + Serilog + System.Text.Json) is internally consistent, widely documented, and has no version conflicts identified.
|
||||
|
||||
The three highest-risk areas for planning are: (1) WPF + Generic Host integration — the WPF STA threading model requires explicit plumbing that is not in the default Host template; (2) MSAL per-tenant token cache scoping — the `MsalCacheHelper` must be instantiated with a unique cache file name per `ClientId`, and the `IPublicClientApplication` instance must be kept alive in `SessionManager` for `AcquireTokenSilent` to work across tenant switches; (3) Dynamic localization without a restart — WPF's standard `x:Static` bindings to generated `.resx` classes are evaluated at startup only, so a `TranslationSource` singleton bound to `INotifyPropertyChanged` (or `MarkupExtension` returning a `Binding`) is required for runtime culture switching.
|
||||
|
||||
**Primary recommendation:** Build the Generic Host wiring, `SessionManager`, and `TranslationSource` in Wave 1 of the plan. All other components depend on DI being up and the culture system being in place.
|
||||
|
||||
---
|
||||
|
||||
## Standard Stack
|
||||
|
||||
### Core
|
||||
|
||||
| Library | Version | Purpose | Why Standard |
|
||||
|---------|---------|---------|--------------|
|
||||
| CommunityToolkit.Mvvm | 8.4.2 | ObservableObject, RelayCommand, AsyncRelayCommand, WeakReferenceMessenger | Microsoft-maintained; source generator MVVM; replaces MVVM Light |
|
||||
| Microsoft.Extensions.Hosting | 10.x | Generic Host — DI container, lifetime, configuration | Official .NET hosting model; Serilog integrates via UseSerilog() |
|
||||
| MSAL.NET (Microsoft.Identity.Client) | 4.83.1 | Public client OAuth2 interactive login | Official Microsoft identity library for desktop |
|
||||
| Microsoft.Identity.Client.Extensions.Msal | 4.83.3 | MsalCacheHelper — cross-platform encrypted file token cache | Required for persistent token cache on desktop |
|
||||
| Microsoft.Identity.Client.Broker | 4.82.1 | WAM (Windows Auth Manager) broker support | Better Windows 11 SSO; falls back gracefully |
|
||||
| PnP.Framework | 1.18.0 | AuthenticationManager, ClientContext, CSOM operations | Only library containing PnP Provisioning Engine |
|
||||
| Serilog | 4.3.1 | Structured logging | De-facto .NET logging library |
|
||||
| Serilog.Sinks.File | (latest) | Rolling daily log file | The modern replacement for deprecated Serilog.Sinks.RollingFile |
|
||||
| Serilog.Extensions.Hosting | (latest) | host.UseSerilog() integration | Wires Serilog into ILogger<T> DI |
|
||||
| System.Text.Json | built-in (.NET 10) | JSON serialization/deserialization | Zero dependency; sufficient for flat profile/settings schemas |
|
||||
|
||||
### Supporting
|
||||
|
||||
| Library | Version | Purpose | When to Use |
|
||||
|---------|---------|---------|-------------|
|
||||
| Microsoft.Extensions.DependencyInjection | 10.x | DI abstractions (bundled with Hosting) | Service registration and resolution |
|
||||
| xUnit | 2.x | Unit testing | ViewModel and service layer tests |
|
||||
| Moq or NSubstitute | latest | Mocking in tests | Isolate services in ViewModel tests |
|
||||
|
||||
### Alternatives Considered
|
||||
|
||||
| Instead of | Could Use | Tradeoff |
|
||||
|------------|-----------|----------|
|
||||
| CommunityToolkit.Mvvm | Prism | Prism is heavier, module-oriented; overkill for single-assembly app |
|
||||
| Serilog.Sinks.File | NLog or log4net | Serilog integrates cleanly with Generic Host; NLog would work but adds config file complexity |
|
||||
| System.Text.Json | Newtonsoft.Json | Newtonsoft handles more edge cases but is unnecessary for the flat schemas here |
|
||||
|
||||
**Installation:**
|
||||
|
||||
```bash
|
||||
dotnet add package CommunityToolkit.Mvvm --version 8.4.2
|
||||
dotnet add package Microsoft.Extensions.Hosting
|
||||
dotnet add package Microsoft.Identity.Client --version 4.83.1
|
||||
dotnet add package Microsoft.Identity.Client.Extensions.Msal --version 4.83.3
|
||||
dotnet add package Microsoft.Identity.Client.Broker --version 4.82.1
|
||||
dotnet add package PnP.Framework --version 1.18.0
|
||||
dotnet add package Serilog
|
||||
dotnet add package Serilog.Sinks.File
|
||||
dotnet add package Serilog.Extensions.Hosting
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Architecture Patterns
|
||||
|
||||
### Recommended Project Structure
|
||||
|
||||
```
|
||||
SharepointToolbox/
|
||||
├── App.xaml / App.xaml.cs # Generic Host entry point, global exception handlers
|
||||
├── Core/
|
||||
│ ├── Models/
|
||||
│ │ ├── TenantProfile.cs # { Name, TenantUrl, ClientId }
|
||||
│ │ └── OperationProgress.cs # record { int Current, int Total, string Message }
|
||||
│ ├── Messages/
|
||||
│ │ ├── TenantSwitchedMessage.cs
|
||||
│ │ └── LanguageChangedMessage.cs
|
||||
│ └── Helpers/
|
||||
│ ├── SharePointPaginationHelper.cs
|
||||
│ └── ExecuteQueryRetryHelper.cs
|
||||
├── Infrastructure/
|
||||
│ ├── Persistence/
|
||||
│ │ ├── ProfileRepository.cs # write-then-replace + SemaphoreSlim(1)
|
||||
│ │ └── SettingsRepository.cs
|
||||
│ ├── Auth/
|
||||
│ │ └── MsalClientFactory.cs # creates and caches IPublicClientApplication per ClientId
|
||||
│ └── Logging/
|
||||
│ └── LogPanelSink.cs # custom Serilog sink → RichTextBox
|
||||
├── Services/
|
||||
│ ├── SessionManager.cs # singleton, owns all ClientContext instances
|
||||
│ ├── ProfileService.cs
|
||||
│ └── SettingsService.cs
|
||||
├── Localization/
|
||||
│ ├── TranslationSource.cs # singleton INotifyPropertyChanged; ResourceManager wrapper
|
||||
│ ├── Strings.resx # EN (neutral default)
|
||||
│ └── Strings.fr.resx # FR overlay
|
||||
├── ViewModels/
|
||||
│ ├── MainWindowViewModel.cs
|
||||
│ ├── ProfileManagementViewModel.cs
|
||||
│ ├── FeatureViewModelBase.cs # canonical async pattern: CTS + IsRunning + IProgress
|
||||
│ └── Tabs/
|
||||
│ └── SettingsViewModel.cs
|
||||
└── Views/
|
||||
├── MainWindow.xaml
|
||||
├── Dialogs/
|
||||
│ └── ProfileManagementDialog.xaml
|
||||
└── Tabs/
|
||||
└── SettingsView.xaml
|
||||
```
|
||||
|
||||
### Pattern 1: Generic Host + WPF Wiring
|
||||
|
||||
**What:** Replace WPF's default `StartupUri`-based startup with a `static Main` that builds a Generic Host, then resolves `MainWindow` from DI.
|
||||
|
||||
**When to use:** Required for all DI-injected ViewModels and services in WPF.
|
||||
|
||||
**Example:**
|
||||
|
||||
```csharp
|
||||
// App.xaml.cs
|
||||
// Source: https://formatexception.com/2024/02/adding-host-to-wpf-for-dependency-injection/
|
||||
public partial class App : Application
|
||||
{
|
||||
[STAThread]
|
||||
public static void Main(string[] args)
|
||||
{
|
||||
using IHost host = Host.CreateDefaultBuilder(args)
|
||||
.UseSerilog((ctx, cfg) => cfg
|
||||
.WriteTo.File(
|
||||
Path.Combine(
|
||||
Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData),
|
||||
"SharepointToolbox", "logs", "app-.log"),
|
||||
rollingInterval: RollingInterval.Day,
|
||||
retainedFileCountLimit: 30))
|
||||
.ConfigureServices(RegisterServices)
|
||||
.Build();
|
||||
|
||||
host.Start();
|
||||
|
||||
App app = new();
|
||||
app.InitializeComponent();
|
||||
app.MainWindow = host.Services.GetRequiredService<MainWindow>();
|
||||
app.MainWindow.Visibility = Visibility.Visible;
|
||||
app.Run();
|
||||
}
|
||||
|
||||
private static void RegisterServices(HostBuilderContext ctx, IServiceCollection services)
|
||||
{
|
||||
services.AddSingleton<SessionManager>();
|
||||
services.AddSingleton<ProfileService>();
|
||||
services.AddSingleton<SettingsService>();
|
||||
services.AddSingleton<MsalClientFactory>();
|
||||
services.AddSingleton<MainWindowViewModel>();
|
||||
services.AddTransient<ProfileManagementViewModel>();
|
||||
services.AddSingleton<MainWindow>();
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
```xml
|
||||
<!-- App.xaml: remove StartupUri, keep x:Class -->
|
||||
<Application x:Class="SharepointToolbox.App"
|
||||
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
|
||||
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
|
||||
<Application.Resources/>
|
||||
</Application>
|
||||
```
|
||||
|
||||
```xml
|
||||
<!-- SharepointToolbox.csproj: override StartupObject, demote App.xaml from ApplicationDefinition -->
|
||||
<PropertyGroup>
|
||||
<StartupObject>SharepointToolbox.App</StartupObject>
|
||||
</PropertyGroup>
|
||||
<ItemGroup>
|
||||
<ApplicationDefinition Remove="App.xaml" />
|
||||
<Page Include="App.xaml" />
|
||||
</ItemGroup>
|
||||
```
|
||||
|
||||
### Pattern 2: AsyncRelayCommand Canonical Pattern (FeatureViewModelBase)
|
||||
|
||||
**What:** Base class for all feature ViewModels demonstrating CancellationTokenSource lifecycle, IsRunning binding, IProgress<OperationProgress> wiring, and graceful OperationCanceledException handling.
|
||||
|
||||
**When to use:** Every feature tab ViewModel inherits from this or replicates the pattern.
|
||||
|
||||
```csharp
|
||||
// Source: https://learn.microsoft.com/en-us/dotnet/communitytoolkit/mvvm/asyncrelaycommand
|
||||
public abstract class FeatureViewModelBase : ObservableRecipient
|
||||
{
|
||||
private CancellationTokenSource? _cts;
|
||||
|
||||
[ObservableProperty]
|
||||
private bool _isRunning;
|
||||
|
||||
[ObservableProperty]
|
||||
private string _statusMessage = string.Empty;
|
||||
|
||||
[ObservableProperty]
|
||||
private int _progressValue;
|
||||
|
||||
public IAsyncRelayCommand RunCommand { get; }
|
||||
public RelayCommand CancelCommand { get; }
|
||||
|
||||
protected FeatureViewModelBase()
|
||||
{
|
||||
RunCommand = new AsyncRelayCommand(ExecuteAsync, () => !IsRunning);
|
||||
CancelCommand = new RelayCommand(() => _cts?.Cancel(), () => IsRunning);
|
||||
}
|
||||
|
||||
private async Task ExecuteAsync()
|
||||
{
|
||||
_cts = new CancellationTokenSource();
|
||||
IsRunning = true;
|
||||
StatusMessage = string.Empty;
|
||||
try
|
||||
{
|
||||
var progress = new Progress<OperationProgress>(p =>
|
||||
{
|
||||
ProgressValue = p.Total > 0 ? (int)(100.0 * p.Current / p.Total) : 0;
|
||||
StatusMessage = p.Message;
|
||||
});
|
||||
await RunOperationAsync(_cts.Token, progress);
|
||||
}
|
||||
catch (OperationCanceledException)
|
||||
{
|
||||
StatusMessage = "Operation cancelled.";
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
StatusMessage = $"Error: {ex.Message}";
|
||||
// Log via Serilog ILogger injected into derived class
|
||||
}
|
||||
finally
|
||||
{
|
||||
IsRunning = false;
|
||||
_cts.Dispose();
|
||||
_cts = null;
|
||||
}
|
||||
}
|
||||
|
||||
protected abstract Task RunOperationAsync(CancellationToken ct, IProgress<OperationProgress> progress);
|
||||
}
|
||||
```
|
||||
|
||||
### Pattern 3: MSAL Per-Tenant Token Cache
|
||||
|
||||
**What:** One `IPublicClientApplication` per ClientId, backed by a per-ClientId `MsalCacheHelper` file. `SessionManager` (singleton) holds the dictionary and performs `AcquireTokenSilent` before falling back to `AcquireTokenInteractive`.
|
||||
|
||||
**When to use:** Every SharePoint authentication flow.
|
||||
|
||||
```csharp
|
||||
// Source: https://learn.microsoft.com/en-us/entra/msal/dotnet/how-to/token-cache-serialization
|
||||
public class MsalClientFactory
|
||||
{
|
||||
private readonly Dictionary<string, IPublicClientApplication> _clients = new();
|
||||
private readonly SemaphoreSlim _lock = new(1, 1);
|
||||
private readonly string _cacheDir = Path.Combine(
|
||||
Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData),
|
||||
"SharepointToolbox", "auth");
|
||||
|
||||
public async Task<IPublicClientApplication> GetOrCreateAsync(string clientId)
|
||||
{
|
||||
await _lock.WaitAsync();
|
||||
try
|
||||
{
|
||||
if (_clients.TryGetValue(clientId, out var existing))
|
||||
return existing;
|
||||
|
||||
var storageProps = new StorageCreationPropertiesBuilder(
|
||||
$"msal_{clientId}.cache", _cacheDir)
|
||||
.Build();
|
||||
|
||||
var pca = PublicClientApplicationBuilder
|
||||
.Create(clientId)
|
||||
.WithDefaultRedirectUri()
|
||||
.WithLegacyCacheCompatibility(false)
|
||||
.Build();
|
||||
|
||||
var helper = await MsalCacheHelper.CreateAsync(storageProps);
|
||||
helper.RegisterCache(pca.UserTokenCache);
|
||||
|
||||
_clients[clientId] = pca;
|
||||
return pca;
|
||||
}
|
||||
finally { _lock.Release(); }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Pattern 4: Dynamic Localization (TranslationSource + MarkupExtension)
|
||||
|
||||
**What:** A singleton `TranslationSource` implements `INotifyPropertyChanged`. XAML binds to it via an indexer `[key]`. When `CurrentCulture` changes, `PropertyChanged` fires for all keys simultaneously, refreshing every bound string in the UI — no restart required.
|
||||
|
||||
**When to use:** All localizable strings in XAML.
|
||||
|
||||
```csharp
|
||||
// TranslationSource.cs — singleton, INotifyPropertyChanged
|
||||
public class TranslationSource : INotifyPropertyChanged
|
||||
{
|
||||
public static readonly TranslationSource Instance = new();
|
||||
private ResourceManager _resourceManager = Strings.ResourceManager;
|
||||
private CultureInfo _currentCulture = CultureInfo.CurrentUICulture;
|
||||
|
||||
public string this[string key] =>
|
||||
_resourceManager.GetString(key, _currentCulture) ?? $"[{key}]";
|
||||
|
||||
public CultureInfo CurrentCulture
|
||||
{
|
||||
get => _currentCulture;
|
||||
set
|
||||
{
|
||||
if (_currentCulture == value) return;
|
||||
_currentCulture = value;
|
||||
Thread.CurrentThread.CurrentUICulture = value;
|
||||
// Raise PropertyChanged with null/empty = "all properties changed"
|
||||
PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(string.Empty));
|
||||
}
|
||||
}
|
||||
|
||||
public event PropertyChangedEventHandler? PropertyChanged;
|
||||
}
|
||||
```
|
||||
|
||||
```xml
|
||||
<!-- XAML usage — no restart needed -->
|
||||
<TextBlock Text="{Binding Source={x:Static loc:TranslationSource.Instance},
|
||||
Path=[tab.perms]}" />
|
||||
```
|
||||
|
||||
```csharp
|
||||
// Language switch handler (in SettingsViewModel)
|
||||
// Broadcasts so StatusBar and other VMs reset any cached strings
|
||||
TranslationSource.Instance.CurrentCulture = new CultureInfo("fr");
|
||||
WeakReferenceMessenger.Default.Send(new LanguageChangedMessage("fr"));
|
||||
```
|
||||
|
||||
### Pattern 5: WeakReferenceMessenger for Tenant Switching
|
||||
|
||||
**What:** When the user selects a different tenant, `MainWindowViewModel` sends a `TenantSwitchedMessage`. All feature ViewModels that inherit `ObservableRecipient` register for this message and reset their state.
|
||||
|
||||
```csharp
|
||||
// Message definition (in Core/Messages/)
|
||||
public sealed class TenantSwitchedMessage : ValueChangedMessage<TenantProfile>
|
||||
{
|
||||
public TenantSwitchedMessage(TenantProfile profile) : base(profile) { }
|
||||
}
|
||||
|
||||
// MainWindowViewModel sends on ComboBox selection change
|
||||
WeakReferenceMessenger.Default.Send(new TenantSwitchedMessage(selectedProfile));
|
||||
|
||||
// FeatureViewModelBase registers in OnActivated (ObservableRecipient lifecycle)
|
||||
protected override void OnActivated()
|
||||
{
|
||||
Messenger.Register<TenantSwitchedMessage>(this, (r, m) =>
|
||||
r.OnTenantSwitched(m.Value));
|
||||
}
|
||||
```
|
||||
|
||||
### Pattern 6: JSON Write-Then-Replace
|
||||
|
||||
**What:** Prevents corrupt files on crash during write. Validate JSON before replacing.
|
||||
|
||||
```csharp
|
||||
// ProfileRepository.cs
|
||||
private readonly SemaphoreSlim _writeLock = new(1, 1);
|
||||
|
||||
public async Task SaveAsync(IReadOnlyList<TenantProfile> profiles)
|
||||
{
|
||||
await _writeLock.WaitAsync();
|
||||
try
|
||||
{
|
||||
var json = JsonSerializer.Serialize(
|
||||
new { profiles },
|
||||
new JsonSerializerOptions { WriteIndented = true });
|
||||
|
||||
var tmpPath = _filePath + ".tmp";
|
||||
await File.WriteAllTextAsync(tmpPath, json, Encoding.UTF8);
|
||||
|
||||
// Validate round-trip before replacing
|
||||
JsonDocument.Parse(await File.ReadAllTextAsync(tmpPath)).Dispose();
|
||||
|
||||
File.Move(tmpPath, _filePath, overwrite: true);
|
||||
}
|
||||
finally { _writeLock.Release(); }
|
||||
}
|
||||
```
|
||||
|
||||
### Pattern 7: ObservableCollection Threading Rule
|
||||
|
||||
**What:** Never modify an `ObservableCollection<T>` from a `Task.Run` background thread. The bound `ItemsControl` will throw or silently malfunction.
|
||||
|
||||
```csharp
|
||||
// In FeatureViewModel — collect on background, assign on UI thread
|
||||
var results = new List<SiteItem>();
|
||||
await Task.Run(async () =>
|
||||
{
|
||||
// ... enumerate, add to results ...
|
||||
}, ct);
|
||||
|
||||
// Switch back to UI thread for collection assignment
|
||||
await Application.Current.Dispatcher.InvokeAsync(() =>
|
||||
{
|
||||
Items = new ObservableCollection<SiteItem>(results);
|
||||
});
|
||||
```
|
||||
|
||||
### Anti-Patterns to Avoid
|
||||
|
||||
- **`async void` event handlers:** Use `AsyncRelayCommand` instead. `async void` swallows exceptions silently and is untestable.
|
||||
- **Direct `ObservableCollection.Add()` from background thread:** Causes cross-thread `InvalidOperationException`. Always use the dispatcher + `new ObservableCollection<T>(list)` pattern.
|
||||
- **Single `IPublicClientApplication` for all tenants:** MSAL's token cache is scoped per app instance. Sharing one instance for multiple ClientIds causes tenant bleed. Each ClientId must have its own PCA.
|
||||
- **Holding `ClientContext` in ViewModels:** `ClientContext` is expensive and not thread-safe. Only `SessionManager` holds it; ViewModels call a service method that takes the URL and returns results.
|
||||
- **`x:Static` bindings to generated resx class:** `Properties.Strings.SomeKey` is resolved once at startup. It will not update when `CurrentUICulture` changes. Use `TranslationSource` binding instead.
|
||||
- **`await using` on `ClientContext` without cancellation check:** PnP CSOM operations do not respect `CancellationToken` at the HTTP level in all paths. Check `ct.ThrowIfCancellationRequested()` before each `ExecuteQuery` call.
|
||||
|
||||
---
|
||||
|
||||
## Don't Hand-Roll
|
||||
|
||||
| Problem | Don't Build | Use Instead | Why |
|
||||
|---------|-------------|-------------|-----|
|
||||
| Token cache file encryption on Windows | Custom DPAPI wrapper | `MsalCacheHelper` (Extensions.Msal) | Handles DPAPI, Mac keychain, Linux SecretService, and fallback; concurrent access safe |
|
||||
| Async command with cancellation | Custom `ICommand` implementation | `AsyncRelayCommand` from CommunityToolkit.Mvvm | Handles re-entrancy, `IsRunning`, `CanExecute` propagation, source-generated attributes |
|
||||
| Cross-VM broadcast | Events on a static class | `WeakReferenceMessenger.Default` | Prevents memory leaks; no strong reference from sender to recipient |
|
||||
| Retry on SharePoint throttle | Custom retry loop | Wrap PnP Framework's built-in retry in `ExecuteQueryRetryAsync` | PnP already handles 429 backoff; wrapper just exposes events for progress reporting |
|
||||
| CSOM list pagination | Manual rowlimit + while loop | `SharePointPaginationHelper` (built in Phase 1) | Forgetting `ListItemCollectionPosition` on large lists causes silent data truncation at 5000 items |
|
||||
| Rolling log file | Custom `ILogger` sink | `Serilog.Sinks.File` with `rollingInterval: RollingInterval.Day` | Note: `Serilog.Sinks.RollingFile` is deprecated — use `Serilog.Sinks.File` |
|
||||
|
||||
**Key insight:** The highest-value "don't hand-roll" is `SharePointPaginationHelper`. The existing PowerShell app likely has silent list threshold failures. Building this helper correctly in Phase 1 is what prevents PERM-07 and every other list-enumeration feature from hitting the 5,000-item wall.
|
||||
|
||||
---
|
||||
|
||||
## Common Pitfalls
|
||||
|
||||
### Pitfall 1: WPF STA Thread + Generic Host Conflict
|
||||
|
||||
**What goes wrong:** `Host.CreateDefaultBuilder` creates a multi-threaded environment. WPF requires the UI thread to be STA. If `Main` is not explicitly marked `[STAThread]`, or if `Application.Run()` is called from the wrong thread, the application crashes at startup with a threading exception.
|
||||
|
||||
**Why it happens:** The default `Program.cs` generated by the WPF template uses `[STAThread]` on `Main` and calls `Application.Run()` directly. When replacing with Generic Host, the entry point changes and the STA attribute must be manually preserved.
|
||||
|
||||
**How to avoid:** Mark `static void Main` with `[STAThread]`. Remove `StartupUri` from `App.xaml`. Add `<StartupObject>` to the csproj. Demote `App.xaml` from `ApplicationDefinition` to `Page`.
|
||||
|
||||
**Warning signs:** `InvalidOperationException: The calling thread must be STA` at startup.
|
||||
|
||||
### Pitfall 2: MSAL Token Cache Sharing Across Tenants
|
||||
|
||||
**What goes wrong:** One `IPublicClientApplication` is created and reused for all tenants. Tokens from tenant A contaminate the cache for tenant B, causing silent auth failures or incorrect user context.
|
||||
|
||||
**Why it happens:** `IPublicClientApplication` has one `UserTokenCache`. The cache keys internally include the ClientId; if multiple tenants use the same ClientId (which is possible in multi-tenant Azure AD apps), the cache is shared and `AcquireTokenSilent` may return a token for the wrong tenant account.
|
||||
|
||||
**How to avoid:** Create one `IPublicClientApplication` per `ClientId`, backed by a cache file named `msal_{clientId}.cache`. If two profiles share a ClientId, they share the PCA (same ClientId = same app registration), but switching requires calling `AcquireTokenSilent` with the correct account from `pca.GetAccountsAsync()`.
|
||||
|
||||
**Warning signs:** User is authenticated as wrong tenant after switch; `MsalUiRequiredException` on switch despite being previously logged in.
|
||||
|
||||
### Pitfall 3: Dynamic Localization Not Updating All Strings
|
||||
|
||||
**What goes wrong:** Language is switched via `CultureInfo`, but 30–40% of strings in the UI still show the old language. Specifically, strings bound via `x:Static` to the generated resource class accessor (e.g., `{x:Static p:Strings.SaveButton}`) are resolved at load time and never re-queried.
|
||||
|
||||
**Why it happens:** The WPF design-time resource designer generates static string properties. `x:Static` retrieves the value once. No `INotifyPropertyChanged` mechanism re-fires.
|
||||
|
||||
**How to avoid:** Use `TranslationSource.Instance[key]` binding pattern for all strings. Never use `x:Static` on the generated Strings class for UI text. The `TranslationSource.PropertyChanged` with an empty string key triggers WPF to re-evaluate all bindings on the source object simultaneously.
|
||||
|
||||
**Warning signs:** Some strings update on language switch, others don't; exactly the strings using `x:Static` are the ones that don't update.
|
||||
|
||||
### Pitfall 4: Empty `catch` Swallows SharePoint Exceptions
|
||||
|
||||
**What goes wrong:** A `catch (Exception)` block with no body (or only a comment) causes SharePoint operations to silently fail. The user sees a blank result grid with no error message, and the log shows nothing.
|
||||
|
||||
**Why it happens:** PnP CSOM throws `ServerException` with SharePoint error codes. Developers add broad `catch` blocks during development to "handle errors later" and forget to complete them.
|
||||
|
||||
**How to avoid:** Enforce the project policy from day one: every `catch` block must log-and-recover, log-and-rethrow, or log-and-surface. Code review rejects any empty or comment-only catch. Serilog's structured logging makes logging trivial.
|
||||
|
||||
**Warning signs:** Operations complete in ~0ms, return zero results, log shows no entry.
|
||||
|
||||
### Pitfall 5: `ClientContext` Not Disposed on Cancellation
|
||||
|
||||
**What goes wrong:** `ClientContext` holds an HTTP connection to SharePoint. If cancellation is requested and the `ClientContext` is abandoned rather than disposed, connections accumulate. Long-running sessions leak sockets.
|
||||
|
||||
**Why it happens:** The `await using` pattern is dropped when developers switch from the canonical pattern to a try/catch block and forget to add the `finally { ctx.Dispose(); }`.
|
||||
|
||||
**How to avoid:** Enforce `await using` in all code touching `ClientContext`. Unit tests verify `Dispose()` is called even when `OperationCanceledException` is thrown (mock `ClientContext` and assert `Dispose` call count).
|
||||
|
||||
**Warning signs:** `SocketException` or connection timeout errors appearing after the application has been running for several hours; memory growth over a long session.
|
||||
|
||||
### Pitfall 6: `ObservableCollection` Modified from Background Thread
|
||||
|
||||
**What goes wrong:** `Add()` or `Clear()` called on an `ObservableCollection` from inside `Task.Run`. WPF's `CollectionView` throws `NotSupportedException: This type of CollectionView does not support changes to its SourceCollection from a thread different from the Dispatcher thread`.
|
||||
|
||||
**Why it happens:** Developers call `Items.Add(item)` inside a `for` loop that runs on a background thread, which feels natural but violates WPF's cross-thread collection rule.
|
||||
|
||||
**How to avoid:** Accumulate results in a plain `List<T>` on the background thread. When the operation completes (or at batch boundaries), `await Application.Current.Dispatcher.InvokeAsync(() => Items = new ObservableCollection<T>(list))`.
|
||||
|
||||
**Warning signs:** `InvalidOperationException` or `NotSupportedException` with "Dispatcher thread" in the message, occurring only when the result set is large enough to trigger background processing.
|
||||
|
||||
---
|
||||
|
||||
## Code Examples
|
||||
|
||||
Verified patterns from official sources:
|
||||
|
||||
### MsalCacheHelper Desktop Setup
|
||||
|
||||
```csharp
|
||||
// Source: https://learn.microsoft.com/en-us/entra/msal/dotnet/how-to/token-cache-serialization
|
||||
var storageProperties = new StorageCreationPropertiesBuilder(
|
||||
$"msal_{clientId}.cache",
|
||||
Path.Combine(Environment.GetFolderPath(
|
||||
Environment.SpecialFolder.ApplicationData), "SharepointToolbox", "auth"))
|
||||
.Build();
|
||||
|
||||
var pca = PublicClientApplicationBuilder
|
||||
.Create(clientId)
|
||||
.WithDefaultRedirectUri()
|
||||
.WithLegacyCacheCompatibility(false)
|
||||
.Build();
|
||||
|
||||
var cacheHelper = await MsalCacheHelper.CreateAsync(storageProperties);
|
||||
cacheHelper.RegisterCache(pca.UserTokenCache);
|
||||
```
|
||||
|
||||
### AcquireTokenSilent with Interactive Fallback
|
||||
|
||||
```csharp
|
||||
// Source: MSAL.NET documentation pattern
|
||||
public async Task<string> GetAccessTokenAsync(
|
||||
IPublicClientApplication pca,
|
||||
string[] scopes,
|
||||
CancellationToken ct)
|
||||
{
|
||||
var accounts = await pca.GetAccountsAsync();
|
||||
AuthenticationResult result;
|
||||
try
|
||||
{
|
||||
result = await pca.AcquireTokenSilent(scopes, accounts.FirstOrDefault())
|
||||
.ExecuteAsync(ct);
|
||||
}
|
||||
catch (MsalUiRequiredException)
|
||||
{
|
||||
result = await pca.AcquireTokenInteractive(scopes)
|
||||
.WithUseEmbeddedWebView(false)
|
||||
.ExecuteAsync(ct);
|
||||
}
|
||||
return result.AccessToken;
|
||||
}
|
||||
```
|
||||
|
||||
### PnP AuthenticationManager Interactive Login
|
||||
|
||||
```csharp
|
||||
// Source: https://pnp.github.io/pnpframework/api/PnP.Framework.AuthenticationManager.html
|
||||
var authManager = AuthenticationManager.CreateWithInteractiveLogin(
|
||||
clientId: profile.ClientId,
|
||||
tenantId: null, // null = common endpoint (multi-tenant)
|
||||
redirectUrl: "http://localhost");
|
||||
|
||||
await using var ctx = await authManager.GetContextAsync(profile.TenantUrl, ct);
|
||||
// ctx is a SharePoint CSOM ClientContext ready for ExecuteQueryAsync
|
||||
```
|
||||
|
||||
### WeakReferenceMessenger Send + Register
|
||||
|
||||
```csharp
|
||||
// Source: https://learn.microsoft.com/en-us/dotnet/communitytoolkit/mvvm/messenger
|
||||
|
||||
// Define message
|
||||
public sealed class TenantSwitchedMessage : ValueChangedMessage<TenantProfile>
|
||||
{
|
||||
public TenantSwitchedMessage(TenantProfile p) : base(p) { }
|
||||
}
|
||||
|
||||
// Send (in MainWindowViewModel)
|
||||
WeakReferenceMessenger.Default.Send(new TenantSwitchedMessage(selected));
|
||||
|
||||
// Register (in ObservableRecipient-derived ViewModel)
|
||||
protected override void OnActivated()
|
||||
{
|
||||
Messenger.Register<TenantSwitchedMessage>(this, (r, m) =>
|
||||
r.HandleTenantSwitch(m.Value));
|
||||
}
|
||||
```
|
||||
|
||||
### Serilog Setup with Rolling File
|
||||
|
||||
```csharp
|
||||
// Source: https://github.com/serilog/serilog-sinks-file
|
||||
// NOTE: Use Serilog.Sinks.File — Serilog.Sinks.RollingFile is DEPRECATED
|
||||
Log.Logger = new LoggerConfiguration()
|
||||
.MinimumLevel.Debug()
|
||||
.WriteTo.File(
|
||||
path: Path.Combine(
|
||||
Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData),
|
||||
"SharepointToolbox", "logs", "app-.log"),
|
||||
rollingInterval: RollingInterval.Day,
|
||||
retainedFileCountLimit: 30,
|
||||
outputTemplate: "{Timestamp:HH:mm:ss} [{Level:u3}] {Message:lj}{NewLine}{Exception}")
|
||||
.CreateLogger();
|
||||
```
|
||||
|
||||
### Global Exception Handlers in App.xaml.cs
|
||||
|
||||
```csharp
|
||||
// App.xaml.cs — wire in Application constructor or OnStartup
|
||||
Application.Current.DispatcherUnhandledException += (_, e) =>
|
||||
{
|
||||
Log.Fatal(e.Exception, "Unhandled dispatcher exception");
|
||||
MessageBox.Show(
|
||||
$"An unexpected error occurred:\n\n{e.Exception.Message}\n\n" +
|
||||
"Check the log file for details.",
|
||||
"Unexpected Error",
|
||||
MessageBoxButton.OK, MessageBoxImage.Error);
|
||||
e.Handled = true; // prevent crash; or set false to let it crash
|
||||
};
|
||||
|
||||
TaskScheduler.UnobservedTaskException += (_, e) =>
|
||||
{
|
||||
Log.Error(e.Exception, "Unobserved task exception");
|
||||
e.SetObserved(); // prevent process termination
|
||||
};
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## State of the Art
|
||||
|
||||
| Old Approach | Current Approach | When Changed | Impact |
|
||||
|--------------|------------------|--------------|--------|
|
||||
| Serilog.Sinks.RollingFile NuGet | Serilog.Sinks.File with `rollingInterval` param | ~2018 | Rolling file is deprecated; same behavior, different package |
|
||||
| MSAL v2 `TokenCacheCallback` | `MsalCacheHelper.RegisterCache()` | MSAL 4.x | Much simpler; handles encryption and cross-platform automatically |
|
||||
| ADAL.NET | MSAL.NET | 2020+ | ADAL is end-of-life; all new auth must use MSAL |
|
||||
| `async void` event handlers | `AsyncRelayCommand` | CommunityToolkit.Mvvm era | `async void` is an anti-pattern; toolkit makes the right thing easy |
|
||||
| `x:Static` on resx | `TranslationSource` binding | No standard date | Required for runtime culture switch without restart |
|
||||
| WPF app without DI | Generic Host + WPF | .NET Core 3+ | Enables testability, Serilog wiring, and lifetime management |
|
||||
|
||||
**Deprecated/outdated:**
|
||||
|
||||
- `Serilog.Sinks.RollingFile`: Deprecated; replaced by `Serilog.Sinks.File`. Do not add this package.
|
||||
- `Microsoft.Toolkit.Mvvm` (old namespace): Superseded by `CommunityToolkit.Mvvm`. Same toolkit, new package ID.
|
||||
- `ADAL.NET` (Microsoft.IdentityModel.Clients.ActiveDirectory): End-of-life. Use MSAL only.
|
||||
- `MvvmLight` (GalaSoft): Unmaintained. CommunityToolkit.Mvvm is the successor.
|
||||
|
||||
---
|
||||
|
||||
## Open Questions
|
||||
|
||||
1. **PnP AuthenticationManager vs raw MSAL for token acquisition**
|
||||
- What we know: `PnP.Framework.AuthenticationManager.CreateWithInteractiveLogin` wraps MSAL internally and produces a `ClientContext`. There is also a constructor accepting an external `IAuthenticationProvider`.
|
||||
- What's unclear: Whether passing an externally-managed `IPublicClientApplication` (from `MsalClientFactory`) into `AuthenticationManager` is officially supported in PnP.Framework 1.18, or if we must create a new PCA inside `AuthenticationManager` and bypass `MsalClientFactory`.
|
||||
- Recommendation: In Wave 1, spike with `CreateWithInteractiveLogin(clientId, ...)` — accept that PnP creates its own internal PCA. If we need to share the token cache with a separately-created PCA, use the `IAuthenticationProvider` constructor overload.
|
||||
|
||||
2. **WAM Broker behavior on Windows 10 LTSC**
|
||||
- What we know: `Microsoft.Identity.Client.Broker` enables WAM on Windows 11. The locked runtime decision includes it.
|
||||
- What's unclear: Behavior on the user's Windows 10 IoT LTSC environment. WAM may not be available or may fall back silently.
|
||||
- Recommendation: Configure MSAL with `.WithDefaultRedirectUri()` as fallback and do not hard-require WAM. Test on Windows 10 LTSC before shipping.
|
||||
|
||||
---
|
||||
|
||||
## Validation Architecture
|
||||
|
||||
### Test Framework
|
||||
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| Framework | xUnit 2.x |
|
||||
| Config file | none — see Wave 0 |
|
||||
| Quick run command | `dotnet test --filter "Category=Unit" --no-build` |
|
||||
| Full suite command | `dotnet test --no-build` |
|
||||
|
||||
### Phase Requirements → Test Map
|
||||
|
||||
| Req ID | Behavior | Test Type | Automated Command | File Exists? |
|
||||
|--------|----------|-----------|-------------------|-------------|
|
||||
| FOUND-01 | App starts, MainWindow resolves from DI | smoke | `dotnet test --filter "FullyQualifiedName~AppStartupTests" -x` | ❌ Wave 0 |
|
||||
| FOUND-02 | ProfileService: create/rename/delete/load profiles; JSON written correctly | unit | `dotnet test --filter "FullyQualifiedName~ProfileServiceTests" -x` | ❌ Wave 0 |
|
||||
| FOUND-03 | MsalClientFactory: unique PCA per ClientId; same ClientId returns cached instance | unit | `dotnet test --filter "FullyQualifiedName~MsalClientFactoryTests" -x` | ❌ Wave 0 |
|
||||
| FOUND-04 | SessionManager: AcquireTokenSilent called before Interactive; MsalUiRequiredException triggers interactive | unit (mock MSAL) | `dotnet test --filter "FullyQualifiedName~SessionManagerTests" -x` | ❌ Wave 0 |
|
||||
| FOUND-05 | FeatureViewModelBase: IProgress<OperationProgress> updates ProgressValue and StatusMessage on UI thread | unit | `dotnet test --filter "FullyQualifiedName~FeatureViewModelBaseTests" -x` | ❌ Wave 0 |
|
||||
| FOUND-06 | FeatureViewModelBase: CancelCommand calls CTS.Cancel(); operation stops; IsRunning resets to false | unit | `dotnet test --filter "FullyQualifiedName~FeatureViewModelBaseTests" -x` | ❌ Wave 0 |
|
||||
| FOUND-07 | Global exception handlers log and surface (verify log written + MessageBox shown) | integration | manual-only (UI dialog) | — |
|
||||
| FOUND-08 | Serilog writes to rolling file in %AppData%\SharepointToolbox\logs\ | integration | `dotnet test --filter "FullyQualifiedName~LoggingIntegrationTests" -x` | ❌ Wave 0 |
|
||||
| FOUND-09 | TranslationSource: switching CurrentCulture fires PropertyChanged with empty key; string lookup uses new culture | unit | `dotnet test --filter "FullyQualifiedName~TranslationSourceTests" -x` | ❌ Wave 0 |
|
||||
| FOUND-10 | ProfileRepository: write-then-replace atomicity; SemaphoreSlim prevents concurrent writes; corrupt JSON on tmp does not replace original | unit | `dotnet test --filter "FullyQualifiedName~ProfileRepositoryTests" -x` | ❌ Wave 0 |
|
||||
| FOUND-12 | SettingsService: reads/writes Sharepoint_Settings.json; dataFolder field round-trips correctly | unit | `dotnet test --filter "FullyQualifiedName~SettingsServiceTests" -x` | ❌ Wave 0 |
|
||||
|
||||
### Sampling Rate
|
||||
|
||||
- **Per task commit:** `dotnet test --filter "Category=Unit" --no-build`
|
||||
- **Per wave merge:** `dotnet test --no-build`
|
||||
- **Phase gate:** Full suite green before `/gsd:verify-work`
|
||||
|
||||
### Wave 0 Gaps
|
||||
|
||||
- [ ] `SharepointToolbox.Tests/SharepointToolbox.Tests.csproj` — xUnit test project, add packages: xunit, xunit.runner.visualstudio, Moq (or NSubstitute), Microsoft.NET.Test.Sdk
|
||||
- [ ] `SharepointToolbox.Tests/Services/ProfileServiceTests.cs` — covers FOUND-02, FOUND-10
|
||||
- [ ] `SharepointToolbox.Tests/Services/SettingsServiceTests.cs` — covers FOUND-12
|
||||
- [ ] `SharepointToolbox.Tests/Auth/MsalClientFactoryTests.cs` — covers FOUND-03
|
||||
- [ ] `SharepointToolbox.Tests/Auth/SessionManagerTests.cs` — covers FOUND-04
|
||||
- [ ] `SharepointToolbox.Tests/ViewModels/FeatureViewModelBaseTests.cs` — covers FOUND-05, FOUND-06
|
||||
- [ ] `SharepointToolbox.Tests/Localization/TranslationSourceTests.cs` — covers FOUND-09
|
||||
- [ ] `SharepointToolbox.Tests/Integration/LoggingIntegrationTests.cs` — covers FOUND-08
|
||||
|
||||
---
|
||||
|
||||
## Sources
|
||||
|
||||
### Primary (HIGH confidence)
|
||||
|
||||
- [AsyncRelayCommand — Microsoft Learn (CommunityToolkit)](https://learn.microsoft.com/en-us/dotnet/communitytoolkit/mvvm/asyncrelaycommand) — AsyncRelayCommand API, IsRunning, CancellationToken, IProgress patterns
|
||||
- [Messenger — Microsoft Learn (CommunityToolkit)](https://learn.microsoft.com/en-us/dotnet/communitytoolkit/mvvm/messenger) — WeakReferenceMessenger, Send/Register patterns, ValueChangedMessage
|
||||
- [Token Cache Serialization — Microsoft Learn (MSAL.NET)](https://learn.microsoft.com/en-us/entra/msal/dotnet/how-to/token-cache-serialization) — MsalCacheHelper desktop setup, StorageCreationPropertiesBuilder, per-user cache
|
||||
- [PnP Framework AuthenticationManager API](https://pnp.github.io/pnpframework/api/PnP.Framework.AuthenticationManager.html) — CreateWithInteractiveLogin overloads, GetContextAsync
|
||||
- [Serilog.Sinks.File GitHub](https://github.com/serilog/serilog-sinks-file) — modern rolling file sink (RollingFile deprecated)
|
||||
- Existing project files: `Sharepoint_Settings.json`, `lang/fr.json`, `Sharepoint_ToolBox.ps1:1-152` — exact JSON schemas and localization keys confirmed
|
||||
|
||||
### Secondary (MEDIUM confidence)
|
||||
|
||||
- [Adding Host to WPF for DI — FormatException (2024)](https://formatexception.com/2024/02/adding-host-to-wpf-for-dependency-injection/) — Generic Host + WPF wiring pattern (verified against Generic Host official docs)
|
||||
- [Custom Resource MarkupExtension — Microsoft DevBlogs](https://devblogs.microsoft.com/ifdef-windows/use-a-custom-resource-markup-extension-to-succeed-at-ui-string-globalization/) — MarkupExtension for resx (verified pattern approach)
|
||||
- [NuGet: CommunityToolkit.Mvvm 8.4.2](https://www.nuget.org/packages/CommunityToolkit.Mvvm/) — version confirmed
|
||||
|
||||
### Tertiary (LOW confidence)
|
||||
|
||||
- Multiple WebSearch results on WPF localization patterns (2012–2020 vintage, not 2025-specific). The `TranslationSource` singleton pattern is consistent across sources but no single authoritative 2025 doc was found. Implementation is straightforward enough to treat as MEDIUM.
|
||||
|
||||
---
|
||||
|
||||
## Metadata
|
||||
|
||||
**Confidence breakdown:**
|
||||
|
||||
- Standard stack: HIGH — all packages are official, versions verified on NuGet, no version conflicts identified
|
||||
- Architecture: HIGH — Generic Host + WPF pattern is well-documented for .NET Core+; MSAL per-tenant pattern verified against official MSAL docs
|
||||
- Pitfalls: HIGH — pitfalls 1–4 are documented in official sources; pitfalls 5–6 are well-known WPF threading behaviors with extensive community documentation
|
||||
- Localization (TranslationSource): MEDIUM — the `INotifyPropertyChanged` singleton approach is the standard community pattern for dynamic resx switching; no single authoritative Microsoft doc covers it end-to-end
|
||||
- PnP Framework auth integration: MEDIUM — `AuthenticationManager.CreateWithInteractiveLogin` API is documented; exact behavior when combining with external `MsalClientFactory` needs a validation spike
|
||||
|
||||
**Research date:** 2026-04-02
|
||||
**Valid until:** 2026-05-02 (30 days — stable libraries, conservative estimate)
|
||||
@@ -0,0 +1,87 @@
|
||||
---
|
||||
phase: 1
|
||||
slug: foundation
|
||||
status: draft
|
||||
nyquist_compliant: false
|
||||
wave_0_complete: false
|
||||
created: 2026-04-02
|
||||
---
|
||||
|
||||
# Phase 1 — Validation Strategy
|
||||
|
||||
> Per-phase validation contract for feedback sampling during execution.
|
||||
|
||||
---
|
||||
|
||||
## Test Infrastructure
|
||||
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| **Framework** | xUnit 2.x |
|
||||
| **Config file** | none — Wave 0 installs |
|
||||
| **Quick run command** | `dotnet test --filter "Category=Unit" --no-build` |
|
||||
| **Full suite command** | `dotnet test --no-build` |
|
||||
| **Estimated runtime** | ~30 seconds |
|
||||
|
||||
---
|
||||
|
||||
## Sampling Rate
|
||||
|
||||
- **After every task commit:** Run `dotnet test --filter "Category=Unit" --no-build`
|
||||
- **After every plan wave:** Run `dotnet test --no-build`
|
||||
- **Before `/gsd:verify-work`:** Full suite must be green
|
||||
- **Max feedback latency:** 30 seconds
|
||||
|
||||
---
|
||||
|
||||
## Per-Task Verification Map
|
||||
|
||||
| Task ID | Plan | Wave | Requirement | Test Type | Automated Command | File Exists | Status |
|
||||
|---------|------|------|-------------|-----------|-------------------|-------------|--------|
|
||||
| 1-xx-01 | TBD | 1 | FOUND-01 | smoke | `dotnet test --filter "FullyQualifiedName~AppStartupTests" -x` | ❌ W0 | ⬜ pending |
|
||||
| 1-xx-02 | TBD | 1 | FOUND-02 | unit | `dotnet test --filter "FullyQualifiedName~ProfileServiceTests" -x` | ❌ W0 | ⬜ pending |
|
||||
| 1-xx-03 | TBD | 1 | FOUND-03 | unit | `dotnet test --filter "FullyQualifiedName~MsalClientFactoryTests" -x` | ❌ W0 | ⬜ pending |
|
||||
| 1-xx-04 | TBD | 1 | FOUND-04 | unit | `dotnet test --filter "FullyQualifiedName~SessionManagerTests" -x` | ❌ W0 | ⬜ pending |
|
||||
| 1-xx-05 | TBD | 2 | FOUND-05 | unit | `dotnet test --filter "FullyQualifiedName~FeatureViewModelBaseTests" -x` | ❌ W0 | ⬜ pending |
|
||||
| 1-xx-06 | TBD | 2 | FOUND-06 | unit | `dotnet test --filter "FullyQualifiedName~FeatureViewModelBaseTests" -x` | ❌ W0 | ⬜ pending |
|
||||
| 1-xx-07 | TBD | 2 | FOUND-07 | manual | — | — | ⬜ pending |
|
||||
| 1-xx-08 | TBD | 2 | FOUND-08 | integration | `dotnet test --filter "FullyQualifiedName~LoggingIntegrationTests" -x` | ❌ W0 | ⬜ pending |
|
||||
| 1-xx-09 | TBD | 2 | FOUND-09 | unit | `dotnet test --filter "FullyQualifiedName~TranslationSourceTests" -x` | ❌ W0 | ⬜ pending |
|
||||
| 1-xx-10 | TBD | 1 | FOUND-10 | unit | `dotnet test --filter "FullyQualifiedName~ProfileRepositoryTests" -x` | ❌ W0 | ⬜ pending |
|
||||
| 1-xx-12 | TBD | 1 | FOUND-12 | unit | `dotnet test --filter "FullyQualifiedName~SettingsServiceTests" -x` | ❌ W0 | ⬜ pending |
|
||||
|
||||
*Status: ⬜ pending · ✅ green · ❌ red · ⚠️ flaky*
|
||||
|
||||
---
|
||||
|
||||
## Wave 0 Requirements
|
||||
|
||||
- [ ] `SharepointToolbox.Tests/SharepointToolbox.Tests.csproj` — xUnit test project; packages: xunit, xunit.runner.visualstudio, Moq, Microsoft.NET.Test.Sdk
|
||||
- [ ] `SharepointToolbox.Tests/Services/ProfileServiceTests.cs` — covers FOUND-02, FOUND-10
|
||||
- [ ] `SharepointToolbox.Tests/Services/SettingsServiceTests.cs` — covers FOUND-12
|
||||
- [ ] `SharepointToolbox.Tests/Auth/MsalClientFactoryTests.cs` — covers FOUND-03
|
||||
- [ ] `SharepointToolbox.Tests/Auth/SessionManagerTests.cs` — covers FOUND-04
|
||||
- [ ] `SharepointToolbox.Tests/ViewModels/FeatureViewModelBaseTests.cs` — covers FOUND-05, FOUND-06
|
||||
- [ ] `SharepointToolbox.Tests/Localization/TranslationSourceTests.cs` — covers FOUND-09
|
||||
- [ ] `SharepointToolbox.Tests/Integration/LoggingIntegrationTests.cs` — covers FOUND-08
|
||||
|
||||
---
|
||||
|
||||
## Manual-Only Verifications
|
||||
|
||||
| Behavior | Requirement | Why Manual | Test Instructions |
|
||||
|----------|-------------|------------|-------------------|
|
||||
| Global exception handler shows MessageBox on unhandled exception | FOUND-07 | UI dialog cannot be asserted in xUnit without a WPF test harness | Launch app; trigger an unhandled exception via debug; verify MessageBox appears and log is written |
|
||||
|
||||
---
|
||||
|
||||
## Validation Sign-Off
|
||||
|
||||
- [ ] All tasks have `<automated>` verify or Wave 0 dependencies
|
||||
- [ ] Sampling continuity: no 3 consecutive tasks without automated verify
|
||||
- [ ] Wave 0 covers all MISSING references
|
||||
- [ ] No watch-mode flags
|
||||
- [ ] Feedback latency < 30s
|
||||
- [ ] `nyquist_compliant: true` set in frontmatter
|
||||
|
||||
**Approval:** pending
|
||||
@@ -0,0 +1,189 @@
|
||||
---
|
||||
phase: 01-foundation
|
||||
verified: 2026-04-02T11:15:00Z
|
||||
status: passed
|
||||
score: 11/11 must-haves verified
|
||||
re_verification: false
|
||||
---
|
||||
|
||||
# Phase 1: Foundation Verification Report
|
||||
|
||||
**Phase Goal:** Establish the complete WPF .NET 10 application skeleton with authentication infrastructure, persistence layer, localization system, and all shared patterns that every subsequent phase will build upon.
|
||||
**Verified:** 2026-04-02T11:15:00Z
|
||||
**Status:** PASSED
|
||||
**Re-verification:** No — initial verification
|
||||
|
||||
## Goal Achievement
|
||||
|
||||
### Observable Truths
|
||||
|
||||
| # | Truth | Status | Evidence |
|
||||
|----|---------------------------------------------------------------------------------------------------|------------|-------------------------------------------------------------------------------------------|
|
||||
| 1 | dotnet test produces zero failures (44 pass, 1 skip for interactive MSAL) | VERIFIED | Live run: Failed=0, Passed=44, Skipped=1, Total=45, Duration=192ms |
|
||||
| 2 | Solution contains two projects (SharepointToolbox WPF + SharepointToolbox.Tests xUnit) | VERIFIED | SharepointToolbox.slnx references both .csproj files; both directories confirmed |
|
||||
| 3 | App.xaml has no StartupUri; Generic Host entry point with [STAThread] Main | VERIFIED | App.xaml confirmed no StartupUri; App.xaml.cs has [STAThread] + Host.CreateDefaultBuilder|
|
||||
| 4 | All NuGet packages present with correct versions; PublishTrimmed=false | VERIFIED | csproj: CommunityToolkit.Mvvm 8.4.2, MSAL 4.83.3, PnP.Framework 1.18.0, Serilog 4.3.1 |
|
||||
| 5 | Core models, messages, and infrastructure helpers provide typed contracts | VERIFIED | TenantProfile, OperationProgress, TenantSwitchedMessage, LanguageChangedMessage, helpers |
|
||||
| 6 | Persistence layer uses write-then-replace with SemaphoreSlim(1); JSON schema matches live data | VERIFIED | ProfileRepository.cs and SettingsRepository.cs both implement .tmp + File.Move pattern |
|
||||
| 7 | Authentication layer provides per-ClientId MSAL PCA isolation; SessionManager is sole holder | VERIFIED | MsalClientFactory has per-clientId Dictionary + SemaphoreSlim; SessionManager confirmed |
|
||||
| 8 | TranslationSource enables runtime culture switching without restart | VERIFIED | TranslationSource.cs: PropertyChangedEventArgs(string.Empty) on culture change |
|
||||
| 9 | Serilog wired to rolling file + LogPanelSink; ILogger<T> injectable via DI | VERIFIED | App.xaml.cs wires LogPanelSink after MainWindow resolved; all services use ILogger<T> |
|
||||
| 10 | WPF shell shows toolbar, 8-tab TabControl with FeatureTabBase, log panel, live StatusBar | VERIFIED | MainWindow.xaml confirmed: ToolBar, 8 TabItems (7 with FeatureTabBase), RichTextBox x:Name="LogPanel", StatusBar with ProgressStatus binding |
|
||||
| 11 | ProfileManagementDialog + SettingsView complete Phase 1 UX; language switch immediate | VERIFIED | Both views exist with DI injection; SettingsTabItem.Content set from code-behind; FR translations confirmed real (Connexion, Annuler, Langue) |
|
||||
|
||||
**Score:** 11/11 truths verified
|
||||
|
||||
---
|
||||
|
||||
### Required Artifacts
|
||||
|
||||
| Artifact | Provides | Status | Details |
|
||||
|-------------------------------------------------------------------|------------------------------------------------|------------|----------------------------------------------------------------------------|
|
||||
| `SharepointToolbox.slnx` | Solution with both projects | VERIFIED | Exists; .slnx format (dotnet new sln in .NET 10 SDK) |
|
||||
| `SharepointToolbox/SharepointToolbox.csproj` | WPF .NET 10 project with all NuGet packages | VERIFIED | Contains PublishTrimmed=false, StartupObject, all 9 packages |
|
||||
| `SharepointToolbox/App.xaml.cs` | Generic Host entry point with [STAThread] | VERIFIED | [STAThread] Main, Host.CreateDefaultBuilder, LogPanelSink wiring, DI reg |
|
||||
| `SharepointToolbox/App.xaml` | No StartupUri; BoolToVisibilityConverter | VERIFIED | No StartupUri; BooleanToVisibilityConverter resource present |
|
||||
| `SharepointToolbox.Tests/SharepointToolbox.Tests.csproj` | xUnit test project referencing main project | VERIFIED | References main project; xunit 2.9.3; Moq 4.20.72; net10.0-windows |
|
||||
| `SharepointToolbox/Core/Models/TenantProfile.cs` | Profile model with TenantUrl field | VERIFIED | Plain class; Name/TenantUrl/ClientId matching JSON schema |
|
||||
| `SharepointToolbox/Core/Models/OperationProgress.cs` | Shared progress record for IProgress<T> | VERIFIED | `record OperationProgress` with Indeterminate factory |
|
||||
| `SharepointToolbox/Core/Models/AppSettings.cs` | Settings model with DataFolder + Lang | VERIFIED | Exists in Core/Models; camelCase-compatible |
|
||||
| `SharepointToolbox/Core/Messages/TenantSwitchedMessage.cs` | WeakReferenceMessenger broadcast message | VERIFIED | Extends ValueChangedMessage<TenantProfile> |
|
||||
| `SharepointToolbox/Core/Messages/LanguageChangedMessage.cs` | Language change broadcast message | VERIFIED | Extends ValueChangedMessage<string> |
|
||||
| `SharepointToolbox/Core/Messages/ProgressUpdatedMessage.cs` | StatusBar live update message | VERIFIED | Extends ValueChangedMessage<OperationProgress> |
|
||||
| `SharepointToolbox/Core/Helpers/SharePointPaginationHelper.cs` | CSOM pagination via ListItemCollectionPosition | VERIFIED | Contains ListItemCollectionPosition do/while loop; [EnumeratorCancellation]|
|
||||
| `SharepointToolbox/Core/Helpers/ExecuteQueryRetryHelper.cs` | Throttle-aware retry with IProgress surfacing | VERIFIED | ExecuteQueryRetryAsync with exponential backoff; IProgress<OperationProgress>|
|
||||
| `SharepointToolbox/Infrastructure/Logging/LogPanelSink.cs` | ILogEventSink writing to RichTextBox via Dispatcher| VERIFIED | Implements ILogEventSink; uses Application.Current?.Dispatcher.InvokeAsync|
|
||||
| `SharepointToolbox/Infrastructure/Auth/MsalClientFactory.cs` | Per-ClientId IPublicClientApplication + cache | VERIFIED | SemaphoreSlim; per-clientId Dictionary; MsalCacheHelper; GetCacheHelper() |
|
||||
| `SharepointToolbox/Infrastructure/Persistence/ProfileRepository.cs`| File I/O with SemaphoreSlim + write-then-replace| VERIFIED | SemaphoreSlim(1,1); .tmp write + JsonDocument.Parse + File.Move |
|
||||
| `SharepointToolbox/Infrastructure/Persistence/SettingsRepository.cs`| Settings file I/O with write-then-replace | VERIFIED | Same pattern as ProfileRepository; camelCase serialization |
|
||||
| `SharepointToolbox/Services/ProfileService.cs` | CRUD on TenantProfile with validation | VERIFIED | 54 lines; GetProfilesAsync/AddProfileAsync/RenameProfileAsync/DeleteProfileAsync|
|
||||
| `SharepointToolbox/Services/SettingsService.cs` | Get/SetLanguage/SetDataFolder with validation | VERIFIED | 39 lines; validates "en"/"fr" only; delegates to SettingsRepository |
|
||||
| `SharepointToolbox/Services/SessionManager.cs` | Singleton holding all ClientContext instances | VERIFIED | IsAuthenticated/GetOrCreateContextAsync/ClearSessionAsync; NormalizeUrl |
|
||||
| `SharepointToolbox/Localization/TranslationSource.cs` | Singleton INotifyPropertyChanged string lookup | VERIFIED | PropertyChangedEventArgs(string.Empty) on culture switch; missing key returns "[key]"|
|
||||
| `SharepointToolbox/Localization/Strings.resx` | 27 EN Phase 1 UI strings | VERIFIED | 29 data entries confirmed; all required keys present (tab.*, toolbar.*, etc.)|
|
||||
| `SharepointToolbox/Localization/Strings.fr.resx` | 27 FR keys with real translations | VERIFIED | 29 data entries; real French strings confirmed: Connexion, Annuler, Langue |
|
||||
| `SharepointToolbox/Localization/Strings.Designer.cs` | ResourceManager accessor for dotnet build | VERIFIED | Exists; manually maintained; no VS ResXFileCodeGenerator dependency |
|
||||
| `SharepointToolbox/ViewModels/FeatureViewModelBase.cs` | Abstract base with CancellationTokenSource lifecycle| VERIFIED| CancellationTokenSource; RunCommand/CancelCommand; IProgress<OperationProgress>|
|
||||
| `SharepointToolbox/ViewModels/MainWindowViewModel.cs` | Shell ViewModel with TenantProfiles + ProgressStatus| VERIFIED| ObservableCollection<TenantProfile>; TenantSwitchedMessage dispatch; ProgressUpdatedMessage subscription|
|
||||
| `SharepointToolbox/ViewModels/ProfileManagementViewModel.cs` | CRUD dialog ViewModel | VERIFIED | Exists; AddCommand/RenameCommand/DeleteCommand |
|
||||
| `SharepointToolbox/ViewModels/Tabs/SettingsViewModel.cs` | Language + folder settings ViewModel | VERIFIED | BrowseFolderCommand; delegates to SettingsService |
|
||||
| `SharepointToolbox/Views/Controls/FeatureTabBase.xaml` | Reusable UserControl with ProgressBar + Cancel | VERIFIED | ProgressBar + TextBlock + Button; Visibility bound to IsRunning via BoolToVisibilityConverter|
|
||||
| `SharepointToolbox/Views/MainWindow.xaml` | WPF shell with toolbar, TabControl, log panel | VERIFIED | RichTextBox x:Name="LogPanel"; 7 FeatureTabBase tabs; StatusBar ProgressStatus binding|
|
||||
| `SharepointToolbox/Views/Dialogs/ProfileManagementDialog.xaml` | Modal dialog for profile CRUD | VERIFIED | Window; 3 input fields (Name/TenantUrl/ClientId); TranslationSource bindings|
|
||||
| `SharepointToolbox/Views/Tabs/SettingsView.xaml` | Settings tab with language + folder controls | VERIFIED | Language ComboBox (en/fr); DataFolder TextBox; BrowseFolderCommand button |
|
||||
| All 7 test files | Unit/integration tests (728 lines total) | VERIFIED | ProfileServiceTests 172L, SettingsServiceTests 123L, MsalClientFactoryTests 75L, SessionManagerTests 103L, FeatureViewModelBaseTests 125L, TranslationSourceTests 83L, LoggingIntegrationTests 47L|
|
||||
|
||||
---
|
||||
|
||||
### Key Link Verification
|
||||
|
||||
| From | To | Via | Status | Details |
|
||||
|---------------------------------|---------------------------------------|-----------------------------------------------|---------|-----------------------------------------------------------------------------|
|
||||
| App.xaml.cs | App.xaml | x:Class + no StartupUri + Page not ApplicationDefinition | VERIFIED | App.xaml has no StartupUri; csproj demotes to Page |
|
||||
| App.xaml.cs | LogPanelSink | LoggerConfiguration.WriteTo.Sink(new LogPanelSink(mainWindow.GetLogPanel())) | VERIFIED | Line 48 of App.xaml.cs confirmed wired |
|
||||
| App.xaml.cs | All DI services | RegisterServices — all 10 services registered | VERIFIED | ProfileRepository, SettingsRepository, MsalClientFactory, SessionManager, ProfileService, SettingsService, MainWindowViewModel, ProfileManagementViewModel, SettingsViewModel, MainWindow, ProfileManagementDialog, SettingsView |
|
||||
| MainWindowViewModel | TenantSwitchedMessage | WeakReferenceMessenger.Default.Send in OnSelectedProfileChanged | VERIFIED | Confirmed in MainWindowViewModel.cs line 72 |
|
||||
| MainWindowViewModel | ProgressUpdatedMessage | Messenger.Register in OnActivated — updates ProgressStatus | VERIFIED | ProgressStatus and ProgressPercentage updated in OnActivated |
|
||||
| MainWindow.xaml StatusBar | ProgressStatus | Binding Content={Binding ProgressStatus} | VERIFIED | Line 31 of MainWindow.xaml confirmed |
|
||||
| MainWindow.xaml stub tabs | FeatureTabBase | TabItem Content = controls:FeatureTabBase | VERIFIED | 7 of 8 tabs use FeatureTabBase; SettingsTabItem uses DI-resolved SettingsView|
|
||||
| MainWindow.xaml.cs | SettingsView (via DI) | SettingsTabItem.Content = serviceProvider.GetRequiredService<SettingsView>() | VERIFIED | Line 24 of MainWindow.xaml.cs confirmed |
|
||||
| MainWindow.xaml.cs | ProfileManagementDialog factory | viewModel.OpenProfileManagementDialog = () => serviceProvider.GetRequiredService<ProfileManagementDialog>() | VERIFIED | Line 21 confirmed |
|
||||
| FeatureViewModelBase | ProgressUpdatedMessage | WeakReferenceMessenger.Default.Send in Progress<T> callback | VERIFIED | Line 49 of FeatureViewModelBase.cs |
|
||||
| SessionManager | MsalClientFactory | _msalFactory.GetOrCreateAsync + GetCacheHelper (tokenCacheCallback) | VERIFIED | SessionManager.cs lines 56-72 confirmed |
|
||||
| ProfileRepository | Sharepoint_Export_profiles.json | { "profiles": [...] } wrapper via camelCase STJ | VERIFIED | ProfilesRoot class with Profiles list; camelCase serialization |
|
||||
| SettingsRepository | Sharepoint_Settings.json | { "dataFolder", "lang" } via camelCase STJ | VERIFIED | SettingsRepository.cs with camelCase serialization |
|
||||
| TranslationSource | Strings.resx | Strings.ResourceManager (via Strings.Designer.cs) | VERIFIED | TranslationSource.cs line 17: `Strings.ResourceManager` |
|
||||
|
||||
---
|
||||
|
||||
### Requirements Coverage
|
||||
|
||||
| Requirement | Plans | Description | Status | Evidence |
|
||||
|-------------|-----------|------------------------------------------------------------------------------------|-----------|-----------------------------------------------------------------------------|
|
||||
| FOUND-01 | 01, 06, 08| WPF .NET 10 + MVVM architecture | SATISFIED | SharepointToolbox.csproj net10.0-windows + UseWPF; CommunityToolkit.Mvvm; FeatureViewModelBase + MainWindowViewModel MVVM pattern |
|
||||
| FOUND-02 | 03, 07, 08| Multi-tenant profile registry (create/rename/delete/switch) | SATISFIED | ProfileService CRUD + ProfileManagementDialog UI; ProfileServiceTests 10 tests pass |
|
||||
| FOUND-03 | 04, 08 | MSAL token cache per tenant; authenticated across tenant switches | SATISFIED | MsalClientFactory per-clientId PCA + MsalCacheHelper; SessionManager caches ClientContext |
|
||||
| FOUND-04 | 04, 08 | Interactive Azure AD OAuth login via browser; no secrets stored | SATISFIED | SessionManager.GetOrCreateContextAsync uses AuthenticationManager.CreateWithInteractiveLogin; no client secrets in code |
|
||||
| FOUND-05 | 02, 06, 08| Long-running operations report progress in real-time | SATISFIED | OperationProgress record; IProgress<T> in FeatureViewModelBase; ProgressUpdatedMessage to StatusBar |
|
||||
| FOUND-06 | 06, 08 | User can cancel any long-running operation | SATISFIED | CancellationTokenSource lifecycle in FeatureViewModelBase; CancelCommand; FeatureTabBase Cancel button |
|
||||
| FOUND-07 | 02, 06, 08| Errors surface with actionable messages; no silent failures | SATISFIED | Global DispatcherUnhandledException + TaskScheduler.UnobservedTaskException; FeatureViewModelBase catches Exception; LogPanelSink colors errors red |
|
||||
| FOUND-08 | 02, 05, 08| Structured logging (Serilog) | SATISFIED | Serilog 4.3.1 + Serilog.Sinks.File + Serilog.Extensions.Hosting; rolling daily log; LogPanelSink for in-app panel |
|
||||
| FOUND-09 | 05, 07, 08| Localization supporting EN and FR with dynamic language switching | SATISFIED | TranslationSource.Instance; PropertyChangedEventArgs(string.Empty); SettingsView language ComboBox; real FR translations |
|
||||
| FOUND-10 | 03, 08 | JSON-based local storage compatible with current app format for migration | SATISFIED | ProfileRepository uses { "profiles": [...] } schema; camelCase field names match existing JSON |
|
||||
| FOUND-11 | Phase 5 | Self-contained single EXE distribution (deferred) | N/A | Explicitly deferred to Phase 5 — not in scope for Phase 1 |
|
||||
| FOUND-12 | 03, 07, 08| Configurable data output folder for exports | SATISFIED | SettingsService.SetDataFolderAsync; SettingsView DataFolder TextBox + Browse button; persists to settings.json |
|
||||
|
||||
**Orphaned requirements:** None — all Phase 1 requirements are claimed by plans. FOUND-11 is correctly assigned to Phase 5.
|
||||
|
||||
---
|
||||
|
||||
### Anti-Patterns Found
|
||||
|
||||
| File | Line | Pattern | Severity | Impact |
|
||||
|------------------------------------------|------|--------------------------------------|----------|---------------------------------------------------------------------------|
|
||||
| `ViewModels/Tabs/SettingsViewModel.cs` | 92 | `throw new NotSupportedException(...)` in RunOperationAsync | INFO | Intentional — Settings tab has no long-running operation; per-plan design decision |
|
||||
|
||||
No blockers or warnings found. The single NotSupportedException is by design — SettingsViewModel extends FeatureViewModelBase but has no long-running operation; the throw is the correct implementation per the plan spec.
|
||||
|
||||
**Build note:** `dotnet build` produces MSB3026/MSB3027 file-lock errors because the application is currently running (process 4480 has the .exe locked). These are environment-state errors, not source code compilation errors. The test suite ran successfully with `--no-build` (44/44 pass), confirming the previously compiled artifacts are correct. Source code itself has 0 C# errors or warnings.
|
||||
|
||||
---
|
||||
|
||||
### Human Verification Required
|
||||
|
||||
The following items were confirmed by human during plan 01-08 visual checkpoint and cannot be re-verified programmatically:
|
||||
|
||||
#### 1. WPF Shell Launch and Layout
|
||||
|
||||
**Test:** Run `dotnet run --project SharepointToolbox/SharepointToolbox.csproj`
|
||||
**Expected:** Window shows toolbar at top, 8-tab TabControl, 150px log panel (black background, green text), status bar at bottom
|
||||
**Why human:** Visual layout cannot be verified by grep; WPF rendering requires runtime
|
||||
**Status:** Confirmed by human in plan 01-08 (2026-04-02)
|
||||
|
||||
#### 2. Dynamic Language Switching
|
||||
|
||||
**Test:** Open Settings tab, change to French, observe tab headers change immediately
|
||||
**Expected:** Tab headers switch to French without restart
|
||||
**Why human:** Runtime WPF binding behavior; TranslationSource.PropertyChanged must actually trigger binding refresh
|
||||
**Status:** Confirmed by human in plan 01-08 (2026-04-02)
|
||||
|
||||
#### 3. Profile Management Dialog
|
||||
|
||||
**Test:** Click "Manage Profiles...", add/rename/delete a profile, verify toolbar ComboBox updates
|
||||
**Expected:** Modal dialog opens; all 3 CRUD operations work; ComboBox refreshes after dialog closes
|
||||
**Why human:** Dialog modal flow; ComboBox refresh timing; runtime interaction required
|
||||
**Status:** Confirmed by human in plan 01-08 (2026-04-02)
|
||||
|
||||
#### 4. Log Panel Rendering
|
||||
|
||||
**Test:** Observe startup messages in log panel
|
||||
**Expected:** Timestamped entries in HH:mm:ss [LEVEL] message format; info=green, warn=orange, error=red
|
||||
**Why human:** WPF RichTextBox rendering; color coding; Dispatcher dispatch timing
|
||||
**Status:** Confirmed by human in plan 01-08 (2026-04-02)
|
||||
|
||||
#### 5. MSAL Interactive Login Flow
|
||||
|
||||
**Test:** Select a profile with real Azure AD ClientId + TenantUrl, click Connect
|
||||
**Expected:** Browser/WAM opens for interactive authentication; on success, connection established
|
||||
**Why human:** Requires real Azure AD tenant; browser interaction; cannot run in automated test
|
||||
**Status:** Intentionally deferred to Phase 2 integration testing — infrastructure in place
|
||||
|
||||
---
|
||||
|
||||
### Gaps Summary
|
||||
|
||||
No gaps found. All 11 observable truths are verified. All 11 requirement IDs (FOUND-01 through FOUND-12, excluding FOUND-11 which is Phase 5) are satisfied. All required artifacts exist and are substantive. All key links are wired and confirmed by code inspection.
|
||||
|
||||
The phase goal is fully achieved: the application has a complete WPF .NET 10 skeleton with:
|
||||
- Generic Host + DI container wired
|
||||
- Per-tenant MSAL authentication infrastructure (no interactive login in tests — expected)
|
||||
- Write-then-replace file persistence with JSON schema compatibility
|
||||
- Runtime culture-switching localization (EN + real FR translations)
|
||||
- FeatureViewModelBase pattern establishing the async/cancel/progress contract for all feature phases
|
||||
- WPF shell with toolbar, 8-tab TabControl, log panel, and live status bar
|
||||
- 44 automated tests green; 1 interactive MSAL test correctly skipped
|
||||
|
||||
---
|
||||
|
||||
_Verified: 2026-04-02T11:15:00Z_
|
||||
_Verifier: Claude (gsd-verifier)_
|
||||
Reference in New Issue
Block a user