diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 0000000..3a792a3 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,71 @@ +# SilverCodeAPI - Copilot Instructions + +## Project Overview +This is a .NET 9 API solution providing common infrastructure for data access patterns, including repository pattern and unit of work implementations. + +## Technology Stack +- **Target Framework**: .NET 9 +- **Language**: C# +- **Architecture**: Repository pattern with data services +- **Key Components**: + - Core.Common: Base implementations for repositories and data services + - Core.Common.Contracts: Interfaces and contracts + - Core.Common.DataModels: Data models and entities + +## Coding Standards + +### General Guidelines +- Follow C# naming conventions (PascalCase for public members, camelCase for private fields) +- Use nullable reference types appropriately +- Prefer async/await for I/O operations +- Keep methods focused and single-purpose + +### Architecture Patterns +- **Repository Pattern**: Use generic repository base classes (BaseRepository, BaseRepositoryWithIntId, BaseRepositoryWithGuidId, BaseRepositoryWithStringId) +- **Data Service Pattern**: Implement data services using BaseDataService and its variants +- **Unit of Work**: Use IUnitOfWork for transaction management +- **Database Factory**: Use IDatabaseFactory for database context creation + +### Code Organization +- Interfaces go in Core.Common.Contracts +- Base implementations go in Core.Common +- Use generic type constraints for ID types (int, Guid, string) +- Separate read operations (IReadRepository) from write operations (IRepository) + +### Dependency Injection +- Design all services and repositories for dependency injection +- Use constructor injection +- Register services with appropriate lifetimes + +### Error Handling +- Use appropriate exception types +- Include meaningful error messages +- Consider adding try-catch blocks for external dependencies + +### Testing +- Write unit tests for business logic +- Consider integration tests for repository implementations +- Mock dependencies appropriately + +### Documentation +- Add XML documentation comments for public APIs +- Document complex logic with inline comments +- Keep README files updated + +## Project-Specific Rules +- When creating new repositories, inherit from appropriate base classes +- When creating new data services, inherit from BaseDataService variants +- Maintain consistency with existing ID type patterns (int, Guid, string) +- Follow the established separation between contracts and implementations +- Use IAuditor for audit logging when applicable + +## File Naming +- Interface files: I{Name}.cs (e.g., IRepository.cs) +- Base class files: Base{Name}.cs (e.g., BaseRepository.cs) +- Keep file names consistent with the class names they contain + +## Common Tasks +- **Adding a new repository**: Inherit from BaseRepository or its typed variants, implement required interfaces +- **Adding a new data service**: Inherit from BaseDataService or its typed variants +- **Adding new contracts**: Place interfaces in Core.Common.Contracts project +- **Extending functionality**: Consider adding to base classes when logic is reusable across multiple implementations diff --git a/.github/upgrades/scenarios/new-dotnet-version_a4b017/assessment.csv b/.github/upgrades/scenarios/new-dotnet-version_a4b017/assessment.csv new file mode 100644 index 0000000..fe39106 --- /dev/null +++ b/.github/upgrades/scenarios/new-dotnet-version_a4b017/assessment.csv @@ -0,0 +1,9 @@ +Issue ID,Description,State,Severity,Story Points,Project Path,Location Kind,Path,Line,Column,Incident ID,Help Link,Assembly Name,Assembly Version,Assembly Public Key,Snippet +NuGet.0002,NuGet package upgrade is recommended,Active,Potential,1,Core.Common.Contracts\Core.Common.Contracts.csproj,File,Core.Common.Contracts\Core.Common.Contracts.csproj,,,Microsoft.EntityFrameworkCore 9.0.1,,,,,"Microsoft.EntityFrameworkCore, 9.0.1 Recommendation: Remove Microsoft.EntityFrameworkCore, and replace with new package Microsoft.EntityFrameworkCore 10.0.5" +Project.0002,Project's target framework(s) needs to be changed,Active,Mandatory,1,Core.Common.Contracts\Core.Common.Contracts.csproj,File,Core.Common.Contracts\Core.Common.Contracts.csproj,,,,,,,,Current target framework: net9.0 Recommended target framework: net10.0 +NuGet.0002,NuGet package upgrade is recommended,Active,Potential,1,Core.Common\Core.Common.csproj,File,Core.Common\Core.Common.csproj,,,Microsoft.EntityFrameworkCore 9.0.1,,,,,"Microsoft.EntityFrameworkCore, 9.0.1 Recommendation: Remove Microsoft.EntityFrameworkCore, and replace with new package Microsoft.EntityFrameworkCore 10.0.5" +NuGet.0002,NuGet package upgrade is recommended,Active,Potential,1,Core.Common\Core.Common.csproj,File,Core.Common\Core.Common.csproj,,,Newtonsoft.Json 13.0.3,,,,,"Newtonsoft.Json, 13.0.3 Recommendation: Remove Newtonsoft.Json, and replace with new package Newtonsoft.Json 13.0.4" +NuGet.0004,NuGet package contains security vulnerability,Active,Optional,1,Core.Common\Core.Common.csproj,File,Core.Common\Core.Common.csproj,,,Microsoft.AspNetCore.Identity 2.3.0,,,,,"Microsoft.AspNetCore.Identity, 2.3.0 Recommendation: Microsoft.AspNetCore.Identity, 2.3.9" +Project.0002,Project's target framework(s) needs to be changed,Active,Mandatory,1,Core.Common\Core.Common.csproj,File,Core.Common\Core.Common.csproj,,,,,,,,Current target framework: net9.0 Recommended target framework: net10.0 +NuGet.0002,NuGet package upgrade is recommended,Active,Potential,1,Core.Common.DataModels\Core.Common.DataModels.csproj,File,Core.Common.DataModels\Core.Common.DataModels.csproj,,,Microsoft.AspNetCore.Identity.EntityFrameworkCore 9.0.1,,,,,"Microsoft.AspNetCore.Identity.EntityFrameworkCore, 9.0.1 Recommendation: Remove Microsoft.AspNetCore.Identity.EntityFrameworkCore, and replace with new package Microsoft.AspNetCore.Identity.EntityFrameworkCore 10.0.5" +Project.0002,Project's target framework(s) needs to be changed,Active,Mandatory,1,Core.Common.DataModels\Core.Common.DataModels.csproj,File,Core.Common.DataModels\Core.Common.DataModels.csproj,,,,,,,,Current target framework: net9.0 Recommended target framework: net10.0 diff --git a/.github/upgrades/scenarios/new-dotnet-version_a4b017/assessment.json b/.github/upgrades/scenarios/new-dotnet-version_a4b017/assessment.json new file mode 100644 index 0000000..15d3c38 --- /dev/null +++ b/.github/upgrades/scenarios/new-dotnet-version_a4b017/assessment.json @@ -0,0 +1,344 @@ +{ + "settings": { + "components": { + "code": true, + "binaries": false + }, + "targetId": "net10.0", + "targetDisplayName": ".NETCoreApp,Version=v10.0" + }, + "analysisStartTime": "2026-03-30T21:52:17.6873484Z", + "analysisEndTime": "2026-03-30T21:52:22.3762058Z", + "privacyModeHelpUrl": "https://go.microsoft.com/fwlink/?linkid=2270980", + "stats": { + "summary": { + "projects": 3, + "issues": 3, + "incidents": 8, + "effort": 8 + }, + "charts": { + "severity": { + "Mandatory": 3, + "Optional": 1, + "Potential": 4, + "Information": 0 + }, + "category": { + "NuGet": 5, + "Project": 3 + } + } + }, + "projects": [ + { + "path": "Core.Common.Contracts\\Core.Common.Contracts.csproj", + "startingProject": true, + "issues": 2, + "storyPoints": 2, + "properties": { + "appName": "Core.Common.Contracts", + "projectKind": "ClassLibrary", + "frameworks": [ + "net9.0" + ], + "languages": [ + "C#" + ], + "tools": [ + "MSBuild" + ], + "isSdkStyle": true, + "numberOfFiles": 16, + "numberOfCodeFiles": 16, + "linesTotal": 236, + "linesOfCode": 236, + "totalApiScanned": 67, + "minLinesOfCodeToChange": 0, + "maxLinesOfCodeToChange": 0 + }, + "ruleInstances": [ + { + "incidentId": "5c4218ef-5e87-4907-89e8-40a9a0b58953", + "ruleId": "NuGet.0002", + "projectPath": "Core.Common.Contracts\\Core.Common.Contracts.csproj", + "state": "Active", + "location": { + "snippetModel": { + "unrestricted": "Microsoft.EntityFrameworkCore, 9.0.1\n\nRecommendation:\n\nRemove Microsoft.EntityFrameworkCore, and replace with new package Microsoft.EntityFrameworkCore 10.0.5", + "protected": "Microsoft.EntityFrameworkCore, 9.0.1\n\nRecommendation:\n\nRemove Microsoft.EntityFrameworkCore, and replace with new package Microsoft.EntityFrameworkCore 10.0.5" + }, + "kind": "File", + "path": "Core.Common.Contracts\\Core.Common.Contracts.csproj", + "snippet": "Microsoft.EntityFrameworkCore, 9.0.1\n\nRecommendation:\n\nRemove Microsoft.EntityFrameworkCore, and replace with new package Microsoft.EntityFrameworkCore 10.0.5", + "protectedSnippet": "Microsoft.EntityFrameworkCore, 9.0.1\n\nRecommendation:\n\nRemove Microsoft.EntityFrameworkCore, and replace with new package Microsoft.EntityFrameworkCore 10.0.5", + "label": "Microsoft.EntityFrameworkCore 9.0.1", + "properties": { + "PackageId": "Microsoft.EntityFrameworkCore", + "PackageVersion": "9.0.1", + "PackageNewVersion": "10.0.5", + "PackageReplacements": null + } + } + }, + { + "incidentId": "6dd77c5f-f676-466d-9f78-f73c60263de9", + "ruleId": "Project.0002", + "projectPath": "Core.Common.Contracts\\Core.Common.Contracts.csproj", + "state": "Active", + "location": { + "snippetModel": { + "unrestricted": "Current target framework: net9.0\nRecommended target framework: net10.0", + "protected": "Current target framework: net9.0\nRecommended target framework: net10.0" + }, + "kind": "File", + "path": "Core.Common.Contracts\\Core.Common.Contracts.csproj", + "snippet": "Current target framework: net9.0\nRecommended target framework: net10.0", + "protectedSnippet": "Current target framework: net9.0\nRecommended target framework: net10.0", + "properties": { + "CurrentTargetFramework": "net9.0", + "RecommendedTargetFramework": "net10.0" + } + } + } + ], + "features": [] + }, + { + "path": "Core.Common\\Core.Common.csproj", + "startingProject": true, + "issues": 3, + "storyPoints": 4, + "properties": { + "appName": "Core.Common", + "projectKind": "ClassLibrary", + "frameworks": [ + "net9.0" + ], + "languages": [ + "C#" + ], + "tools": [ + "MSBuild" + ], + "isSdkStyle": true, + "numberOfFiles": 16, + "numberOfCodeFiles": 16, + "linesTotal": 887, + "linesOfCode": 887, + "totalApiScanned": 1130, + "minLinesOfCodeToChange": 0, + "maxLinesOfCodeToChange": 0 + }, + "ruleInstances": [ + { + "incidentId": "a23247e9-fc00-4e66-b4bf-85fffed79774", + "ruleId": "NuGet.0002", + "projectPath": "Core.Common\\Core.Common.csproj", + "state": "Active", + "location": { + "snippetModel": { + "unrestricted": "Microsoft.EntityFrameworkCore, 9.0.1\n\nRecommendation:\n\nRemove Microsoft.EntityFrameworkCore, and replace with new package Microsoft.EntityFrameworkCore 10.0.5", + "protected": "Microsoft.EntityFrameworkCore, 9.0.1\n\nRecommendation:\n\nRemove Microsoft.EntityFrameworkCore, and replace with new package Microsoft.EntityFrameworkCore 10.0.5" + }, + "kind": "File", + "path": "Core.Common\\Core.Common.csproj", + "snippet": "Microsoft.EntityFrameworkCore, 9.0.1\n\nRecommendation:\n\nRemove Microsoft.EntityFrameworkCore, and replace with new package Microsoft.EntityFrameworkCore 10.0.5", + "protectedSnippet": "Microsoft.EntityFrameworkCore, 9.0.1\n\nRecommendation:\n\nRemove Microsoft.EntityFrameworkCore, and replace with new package Microsoft.EntityFrameworkCore 10.0.5", + "label": "Microsoft.EntityFrameworkCore 9.0.1", + "properties": { + "PackageId": "Microsoft.EntityFrameworkCore", + "PackageVersion": "9.0.1", + "PackageNewVersion": "10.0.5", + "PackageReplacements": null + } + } + }, + { + "incidentId": "7b451bb6-a7b5-4e78-9e28-42fc62f46d67", + "ruleId": "NuGet.0002", + "projectPath": "Core.Common\\Core.Common.csproj", + "state": "Active", + "location": { + "snippetModel": { + "unrestricted": "Newtonsoft.Json, 13.0.3\n\nRecommendation:\n\nRemove Newtonsoft.Json, and replace with new package Newtonsoft.Json 13.0.4", + "protected": "Newtonsoft.Json, 13.0.3\n\nRecommendation:\n\nRemove Newtonsoft.Json, and replace with new package Newtonsoft.Json 13.0.4" + }, + "kind": "File", + "path": "Core.Common\\Core.Common.csproj", + "snippet": "Newtonsoft.Json, 13.0.3\n\nRecommendation:\n\nRemove Newtonsoft.Json, and replace with new package Newtonsoft.Json 13.0.4", + "protectedSnippet": "Newtonsoft.Json, 13.0.3\n\nRecommendation:\n\nRemove Newtonsoft.Json, and replace with new package Newtonsoft.Json 13.0.4", + "label": "Newtonsoft.Json 13.0.3", + "properties": { + "PackageId": "Newtonsoft.Json", + "PackageVersion": "13.0.3", + "PackageNewVersion": "13.0.4", + "PackageReplacements": null + } + } + }, + { + "incidentId": "c175ac00-27ae-49ca-9552-a223ab4c6787", + "ruleId": "NuGet.0004", + "projectPath": "Core.Common\\Core.Common.csproj", + "state": "Active", + "location": { + "snippetModel": { + "unrestricted": "Microsoft.AspNetCore.Identity, 2.3.0\n\nRecommendation:\n\nMicrosoft.AspNetCore.Identity, 2.3.9", + "protected": "Microsoft.AspNetCore.Identity, 2.3.0\n\nRecommendation:\n\nMicrosoft.AspNetCore.Identity, 2.3.9" + }, + "kind": "File", + "path": "Core.Common\\Core.Common.csproj", + "snippet": "Microsoft.AspNetCore.Identity, 2.3.0\n\nRecommendation:\n\nMicrosoft.AspNetCore.Identity, 2.3.9", + "protectedSnippet": "Microsoft.AspNetCore.Identity, 2.3.0\n\nRecommendation:\n\nMicrosoft.AspNetCore.Identity, 2.3.9", + "label": "Microsoft.AspNetCore.Identity 2.3.0", + "properties": { + "PackageId": "Microsoft.AspNetCore.Identity", + "PackageVersion": "2.3.0", + "PackageNewVersion": "2.3.9", + "PackageReplacements": null + } + } + }, + { + "incidentId": "d4163b33-cb6e-49f6-9fa3-d13fddde3c8f", + "ruleId": "Project.0002", + "projectPath": "Core.Common\\Core.Common.csproj", + "state": "Active", + "location": { + "snippetModel": { + "unrestricted": "Current target framework: net9.0\nRecommended target framework: net10.0", + "protected": "Current target framework: net9.0\nRecommended target framework: net10.0" + }, + "kind": "File", + "path": "Core.Common\\Core.Common.csproj", + "snippet": "Current target framework: net9.0\nRecommended target framework: net10.0", + "protectedSnippet": "Current target framework: net9.0\nRecommended target framework: net10.0", + "properties": { + "CurrentTargetFramework": "net9.0", + "RecommendedTargetFramework": "net10.0" + } + } + } + ], + "features": [] + }, + { + "path": "Core.Common.DataModels\\Core.Common.DataModels.csproj", + "startingProject": true, + "issues": 2, + "storyPoints": 2, + "properties": { + "appName": "Core.Common.DataModels", + "projectKind": "ClassLibrary", + "frameworks": [ + "net9.0" + ], + "languages": [ + "C#" + ], + "tools": [ + "MSBuild" + ], + "isSdkStyle": true, + "numberOfFiles": 18, + "numberOfCodeFiles": 18, + "linesTotal": 253, + "linesOfCode": 253, + "totalApiScanned": 213, + "minLinesOfCodeToChange": 0, + "maxLinesOfCodeToChange": 0 + }, + "ruleInstances": [ + { + "incidentId": "63cb77c2-264f-4c38-be9c-75c22c824397", + "ruleId": "NuGet.0002", + "projectPath": "Core.Common.DataModels\\Core.Common.DataModels.csproj", + "state": "Active", + "location": { + "snippetModel": { + "unrestricted": "Microsoft.AspNetCore.Identity.EntityFrameworkCore, 9.0.1\n\nRecommendation:\n\nRemove Microsoft.AspNetCore.Identity.EntityFrameworkCore, and replace with new package Microsoft.AspNetCore.Identity.EntityFrameworkCore 10.0.5", + "protected": "Microsoft.AspNetCore.Identity.EntityFrameworkCore, 9.0.1\n\nRecommendation:\n\nRemove Microsoft.AspNetCore.Identity.EntityFrameworkCore, and replace with new package Microsoft.AspNetCore.Identity.EntityFrameworkCore 10.0.5" + }, + "kind": "File", + "path": "Core.Common.DataModels\\Core.Common.DataModels.csproj", + "snippet": "Microsoft.AspNetCore.Identity.EntityFrameworkCore, 9.0.1\n\nRecommendation:\n\nRemove Microsoft.AspNetCore.Identity.EntityFrameworkCore, and replace with new package Microsoft.AspNetCore.Identity.EntityFrameworkCore 10.0.5", + "protectedSnippet": "Microsoft.AspNetCore.Identity.EntityFrameworkCore, 9.0.1\n\nRecommendation:\n\nRemove Microsoft.AspNetCore.Identity.EntityFrameworkCore, and replace with new package Microsoft.AspNetCore.Identity.EntityFrameworkCore 10.0.5", + "label": "Microsoft.AspNetCore.Identity.EntityFrameworkCore 9.0.1", + "properties": { + "PackageId": "Microsoft.AspNetCore.Identity.EntityFrameworkCore", + "PackageVersion": "9.0.1", + "PackageNewVersion": "10.0.5", + "PackageReplacements": null + } + } + }, + { + "incidentId": "875ca8c0-a093-4b15-b21f-280def6276ed", + "ruleId": "Project.0002", + "projectPath": "Core.Common.DataModels\\Core.Common.DataModels.csproj", + "state": "Active", + "location": { + "snippetModel": { + "unrestricted": "Current target framework: net9.0\nRecommended target framework: net10.0", + "protected": "Current target framework: net9.0\nRecommended target framework: net10.0" + }, + "kind": "File", + "path": "Core.Common.DataModels\\Core.Common.DataModels.csproj", + "snippet": "Current target framework: net9.0\nRecommended target framework: net10.0", + "protectedSnippet": "Current target framework: net9.0\nRecommended target framework: net10.0", + "properties": { + "CurrentTargetFramework": "net9.0", + "RecommendedTargetFramework": "net10.0" + } + } + } + ], + "features": [] + } + ], + "rules": { + "NuGet.0002": { + "id": "NuGet.0002", + "isFeature": false, + "description": "NuGet package upgrade is recommended for selected target framework.\n\nStandard .NET packages are recommended to have versions matching version of .NET that project targets.\n\nSome other packages also are known to work better for selected target frameworks.", + "label": "NuGet package upgrade is recommended", + "severity": "Potential", + "effort": 1, + "links": [ + { + "url": "https://go.microsoft.com/fwlink/?linkid=2262530", + "isCustom": false + } + ] + }, + "Project.0002": { + "id": "Project.0002", + "isFeature": false, + "description": "Project\u0027s target framework(s) needs to be changed to the new target framework that you selected for this upgrade.\n\nDuring upgrade target framework will be adjusted to corresponding platform when applicable. In some cases project would result in multiple target frameworks after the upgrade if it was using features that now have their own platforms in modern .NET frameworks (windows, iOS, Android etc).", + "label": "Project\u0027s target framework(s) needs to be changed", + "severity": "Mandatory", + "effort": 1, + "links": [ + { + "title": "Overview of porting from .NET Framework to .NET", + "url": "https://go.microsoft.com/fwlink/?linkid=2265227", + "isCustom": false + }, + { + "title": ".NET project SDKs", + "url": "https://go.microsoft.com/fwlink/?linkid=2265226", + "isCustom": false + } + ] + }, + "NuGet.0004": { + "id": "NuGet.0004", + "isFeature": false, + "description": "NuGet package contains security vulnerabilities.\n\nPackage needs to be upgraded to a newer version that addresses known security vulnerabilities.", + "label": "NuGet package contains security vulnerability", + "severity": "Optional", + "effort": 1 + } + } +} \ No newline at end of file diff --git a/.github/upgrades/scenarios/new-dotnet-version_a4b017/assessment.md b/.github/upgrades/scenarios/new-dotnet-version_a4b017/assessment.md new file mode 100644 index 0000000..01e5bf9 --- /dev/null +++ b/.github/upgrades/scenarios/new-dotnet-version_a4b017/assessment.md @@ -0,0 +1,253 @@ +# Projects and dependencies analysis + +This document provides a comprehensive overview of the projects and their dependencies in the context of upgrading to .NETCoreApp,Version=v10.0. + +## Table of Contents + +- [Executive Summary](#executive-Summary) + - [Highlevel Metrics](#highlevel-metrics) + - [Projects Compatibility](#projects-compatibility) + - [Package Compatibility](#package-compatibility) + - [API Compatibility](#api-compatibility) +- [Aggregate NuGet packages details](#aggregate-nuget-packages-details) +- [Top API Migration Challenges](#top-api-migration-challenges) + - [Technologies and Features](#technologies-and-features) + - [Most Frequent API Issues](#most-frequent-api-issues) +- [Projects Relationship Graph](#projects-relationship-graph) +- [Project Details](#project-details) + + - [Core.Common.Contracts\Core.Common.Contracts.csproj](#corecommoncontractscorecommoncontractscsproj) + - [Core.Common.DataModels\Core.Common.DataModels.csproj](#corecommondatamodelscorecommondatamodelscsproj) + - [Core.Common\Core.Common.csproj](#corecommoncorecommoncsproj) + + +## Executive Summary + +### Highlevel Metrics + +| Metric | Count | Status | +| :--- | :---: | :--- | +| Total Projects | 3 | All require upgrade | +| Total NuGet Packages | 8 | 4 need upgrade | +| Total Code Files | 50 | | +| Total Code Files with Incidents | 3 | | +| Total Lines of Code | 1376 | | +| Total Number of Issues | 8 | | +| Estimated LOC to modify | 0+ | at least 0.0% of codebase | + +### Projects Compatibility + +| Project | Target Framework | Difficulty | Package Issues | API Issues | Est. LOC Impact | Description | +| :--- | :---: | :---: | :---: | :---: | :---: | :--- | +| [Core.Common.Contracts\Core.Common.Contracts.csproj](#corecommoncontractscorecommoncontractscsproj) | net9.0 | 🟒 Low | 1 | 0 | | ClassLibrary, Sdk Style = True | +| [Core.Common.DataModels\Core.Common.DataModels.csproj](#corecommondatamodelscorecommondatamodelscsproj) | net9.0 | 🟒 Low | 1 | 0 | | ClassLibrary, Sdk Style = True | +| [Core.Common\Core.Common.csproj](#corecommoncorecommoncsproj) | net9.0 | 🟒 Low | 3 | 0 | | ClassLibrary, Sdk Style = True | + +### Package Compatibility + +| Status | Count | Percentage | +| :--- | :---: | :---: | +| βœ… Compatible | 4 | 50.0% | +| ⚠️ Incompatible | 0 | 0.0% | +| πŸ”„ Upgrade Recommended | 4 | 50.0% | +| ***Total NuGet Packages*** | ***8*** | ***100%*** | + +### API Compatibility + +| Category | Count | Impact | +| :--- | :---: | :--- | +| πŸ”΄ Binary Incompatible | 0 | High - Require code changes | +| 🟑 Source Incompatible | 0 | Medium - Needs re-compilation and potential conflicting API error fixing | +| πŸ”΅ Behavioral change | 0 | Low - Behavioral changes that may require testing at runtime | +| βœ… Compatible | 1410 | | +| ***Total APIs Analyzed*** | ***1410*** | | + +## Aggregate NuGet packages details + +| Package | Current Version | Suggested Version | Projects | Description | +| :--- | :---: | :---: | :--- | :--- | +| Ardalis.GuardClauses | 5.0.0 | | [Core.Common.csproj](#corecommoncorecommoncsproj) | βœ…Compatible | +| Microsoft.AspNetCore.Identity | 2.3.0 | 2.3.9 | [Core.Common.csproj](#corecommoncorecommoncsproj) | NuGet package contains security vulnerability | +| Microsoft.AspNetCore.Identity.EntityFrameworkCore | 9.0.1 | 10.0.5 | [Core.Common.DataModels.csproj](#corecommondatamodelscorecommondatamodelscsproj) | NuGet package upgrade is recommended | +| Microsoft.AspNetCore.Mvc | 2.3.0 | | [Core.Common.csproj](#corecommoncorecommoncsproj) | βœ…Compatible | +| Microsoft.EntityFrameworkCore | 9.0.1 | 10.0.5 | [Core.Common.Contracts.csproj](#corecommoncontractscorecommoncontractscsproj)
[Core.Common.csproj](#corecommoncorecommoncsproj) | NuGet package upgrade is recommended | +| Newtonsoft.Json | 13.0.3 | 13.0.4 | [Core.Common.csproj](#corecommoncorecommoncsproj) | NuGet package upgrade is recommended | +| REST-Parser | 1.2.5 | | [Core.Common.Contracts.csproj](#corecommoncontractscorecommoncontractscsproj)
[Core.Common.csproj](#corecommoncorecommoncsproj) | βœ…Compatible | +| System.IdentityModel.Tokens.Jwt | 8.3.1 | | [Core.Common.csproj](#corecommoncorecommoncsproj) | βœ…Compatible | + +## Top API Migration Challenges + +### Technologies and Features + +| Technology | Issues | Percentage | Migration Path | +| :--- | :---: | :---: | :--- | + +### Most Frequent API Issues + +| API | Count | Percentage | Category | +| :--- | :---: | :---: | :--- | + +## Projects Relationship Graph + +Legend: +πŸ“¦ SDK-style project +βš™οΈ Classic project + +```mermaid +flowchart LR + P1["πŸ“¦ Core.Common.Contracts.csproj
net9.0"] + P2["πŸ“¦ Core.Common.csproj
net9.0"] + P3["πŸ“¦ Core.Common.DataModels.csproj
net9.0"] + P1 --> P3 + P2 --> P1 + click P1 "#corecommoncontractscorecommoncontractscsproj" + click P2 "#corecommoncorecommoncsproj" + click P3 "#corecommondatamodelscorecommondatamodelscsproj" + +``` + +## Project Details + + +### Core.Common.Contracts\Core.Common.Contracts.csproj + +#### Project Info + +- **Current Target Framework:** net9.0 +- **Proposed Target Framework:** net10.0 +- **SDK-style**: True +- **Project Kind:** ClassLibrary +- **Dependencies**: 1 +- **Dependants**: 1 +- **Number of Files**: 16 +- **Number of Files with Incidents**: 1 +- **Lines of Code**: 236 +- **Estimated LOC to modify**: 0+ (at least 0.0% of the project) + +#### Dependency Graph + +Legend: +πŸ“¦ SDK-style project +βš™οΈ Classic project + +```mermaid +flowchart TB + subgraph upstream["Dependants (1)"] + P2["πŸ“¦ Core.Common.csproj
net9.0"] + click P2 "#corecommoncorecommoncsproj" + end + subgraph current["Core.Common.Contracts.csproj"] + MAIN["πŸ“¦ Core.Common.Contracts.csproj
net9.0"] + click MAIN "#corecommoncontractscorecommoncontractscsproj" + end + subgraph downstream["Dependencies (1"] + P3["πŸ“¦ Core.Common.DataModels.csproj
net9.0"] + click P3 "#corecommondatamodelscorecommondatamodelscsproj" + end + P2 --> MAIN + MAIN --> P3 + +``` + +### API Compatibility + +| Category | Count | Impact | +| :--- | :---: | :--- | +| πŸ”΄ Binary Incompatible | 0 | High - Require code changes | +| 🟑 Source Incompatible | 0 | Medium - Needs re-compilation and potential conflicting API error fixing | +| πŸ”΅ Behavioral change | 0 | Low - Behavioral changes that may require testing at runtime | +| βœ… Compatible | 67 | | +| ***Total APIs Analyzed*** | ***67*** | | + + +### Core.Common.DataModels\Core.Common.DataModels.csproj + +#### Project Info + +- **Current Target Framework:** net9.0 +- **Proposed Target Framework:** net10.0 +- **SDK-style**: True +- **Project Kind:** ClassLibrary +- **Dependencies**: 0 +- **Dependants**: 1 +- **Number of Files**: 18 +- **Number of Files with Incidents**: 1 +- **Lines of Code**: 253 +- **Estimated LOC to modify**: 0+ (at least 0.0% of the project) + +#### Dependency Graph + +Legend: +πŸ“¦ SDK-style project +βš™οΈ Classic project + +```mermaid +flowchart TB + subgraph upstream["Dependants (1)"] + P1["πŸ“¦ Core.Common.Contracts.csproj
net9.0"] + click P1 "#corecommoncontractscorecommoncontractscsproj" + end + subgraph current["Core.Common.DataModels.csproj"] + MAIN["πŸ“¦ Core.Common.DataModels.csproj
net9.0"] + click MAIN "#corecommondatamodelscorecommondatamodelscsproj" + end + P1 --> MAIN + +``` + +### API Compatibility + +| Category | Count | Impact | +| :--- | :---: | :--- | +| πŸ”΄ Binary Incompatible | 0 | High - Require code changes | +| 🟑 Source Incompatible | 0 | Medium - Needs re-compilation and potential conflicting API error fixing | +| πŸ”΅ Behavioral change | 0 | Low - Behavioral changes that may require testing at runtime | +| βœ… Compatible | 213 | | +| ***Total APIs Analyzed*** | ***213*** | | + + +### Core.Common\Core.Common.csproj + +#### Project Info + +- **Current Target Framework:** net9.0 +- **Proposed Target Framework:** net10.0 +- **SDK-style**: True +- **Project Kind:** ClassLibrary +- **Dependencies**: 1 +- **Dependants**: 0 +- **Number of Files**: 16 +- **Number of Files with Incidents**: 1 +- **Lines of Code**: 887 +- **Estimated LOC to modify**: 0+ (at least 0.0% of the project) + +#### Dependency Graph + +Legend: +πŸ“¦ SDK-style project +βš™οΈ Classic project + +```mermaid +flowchart TB + subgraph current["Core.Common.csproj"] + MAIN["πŸ“¦ Core.Common.csproj
net9.0"] + click MAIN "#corecommoncorecommoncsproj" + end + subgraph downstream["Dependencies (1"] + P1["πŸ“¦ Core.Common.Contracts.csproj
net9.0"] + click P1 "#corecommoncontractscorecommoncontractscsproj" + end + MAIN --> P1 + +``` + +### API Compatibility + +| Category | Count | Impact | +| :--- | :---: | :--- | +| πŸ”΄ Binary Incompatible | 0 | High - Require code changes | +| 🟑 Source Incompatible | 0 | Medium - Needs re-compilation and potential conflicting API error fixing | +| πŸ”΅ Behavioral change | 0 | Low - Behavioral changes that may require testing at runtime | +| βœ… Compatible | 1130 | | +| ***Total APIs Analyzed*** | ***1130*** | | + diff --git a/.github/upgrades/scenarios/new-dotnet-version_a4b017/execution-log.md b/.github/upgrades/scenarios/new-dotnet-version_a4b017/execution-log.md new file mode 100644 index 0000000..783ca50 --- /dev/null +++ b/.github/upgrades/scenarios/new-dotnet-version_a4b017/execution-log.md @@ -0,0 +1,10 @@ + +## [2026-03-30 23:31] TASK-001: Verify prerequisites + +Status: Complete + +- **Verified**: .NET 10 SDK is installed (version 10.0.201) +- **Verified**: SDK version meets minimum requirements for net10.0 target + +Success - All prerequisites satisfied + diff --git a/.github/upgrades/scenarios/new-dotnet-version_a4b017/plan.md b/.github/upgrades/scenarios/new-dotnet-version_a4b017/plan.md new file mode 100644 index 0000000..80f0df4 --- /dev/null +++ b/.github/upgrades/scenarios/new-dotnet-version_a4b017/plan.md @@ -0,0 +1,1487 @@ +# .NET 10 Upgrade Plan for SilverCodeAPI + +## Table of Contents + +- [Executive Summary](#executive-summary) +- [Migration Strategy](#migration-strategy) +- [Detailed Dependency Analysis](#detailed-dependency-analysis) +- [Project-by-Project Plans](#project-by-project-plans) + - [Core.Common.DataModels](#corecommondatamodels) + - [Core.Common.Contracts](#corecommoncontracts) + - [Core.Common](#corecommon) +- [Risk Management](#risk-management) +- [Testing & Validation Strategy](#testing--validation-strategy) +- [Complexity & Effort Assessment](#complexity--effort-assessment) +- [Source Control Strategy](#source-control-strategy) +- [Success Criteria](#success-criteria) + +--- + +## Executive Summary + +### Scenario Description +This plan details the upgrade of the SilverCodeAPI solution from .NET 9 to .NET 10 (Long Term Support). The solution consists of 3 class library projects providing common infrastructure for data access patterns, including repository pattern and unit of work implementations. + +### Scope + +**Projects to Upgrade**: 3 projects +- Core.Common.DataModels +- Core.Common.Contracts +- Core.Common + +**Current State**: All projects currently target .NET 9.0 + +**Target State**: All projects will target .NET 10.0 + +### Discovered Metrics + +| Metric | Value | +| :--- | :--- | +| Total Projects | 3 | +| Total Lines of Code | 1,376 | +| Total Code Files | 50 | +| Dependency Depth | 2 levels | +| NuGet Packages Requiring Updates | 4 | +| Security Vulnerabilities | 2 packages | +| API Breaking Changes | 0 detected | + +### Complexity Assessment + +**Classification**: **Simple Solution** + +**Rationale**: +- Small solution with only 3 projects +- Shallow dependency structure (2 levels) +- All projects currently on .NET 9.0 (no framework mixing) +- No API breaking changes detected +- All projects marked as Low complexity +- Clean dependency graph with no circular dependencies + +### Critical Issues + +**Security Vulnerabilities** (Must Address): +1. `Microsoft.AspNetCore.Identity` 2.3.0 β†’ Requires update to 2.3.9 +2. `Microsoft.AspNetCore.Mvc` 2.3.0 β†’ Package contains security vulnerability + +These packages are severely outdated (from .NET Core 2.x era) and contain known security vulnerabilities. They must be updated or removed as part of this upgrade. + +### Selected Strategy + +**All-At-Once Strategy** - All projects upgraded simultaneously in single coordinated operation. + +**Rationale**: +- Small solution (3 projects) - ideal for atomic upgrade +- All projects on same framework version (net9.0) +- Simple, linear dependency structure +- Low overall complexity +- All packages have .NET 10 compatible versions available +- Enables fastest completion time +- Single comprehensive testing phase + +### Iteration Strategy + +**Fast Batch Approach** (2-3 detail iterations): +- All projects will be detailed in batched iterations due to low complexity +- Focus on security vulnerability remediation +- Single atomic upgrade operation across all projects + +### Remaining Iterations +- **Phase 2**: Foundation (3 iterations) - Dependency analysis, strategy details, stubs +- **Phase 3**: Dynamic details (2 iterations) - Batch all project details, final sections +- **Total Expected Iterations**: 8 iterations + +--- + +## Migration Strategy + +### Approach Selection + +**Selected Approach**: **All-At-Once Strategy** + +All projects in the solution will be upgraded simultaneously in a single coordinated operation. All project files are updated to .NET 10.0, all package references updated, and the entire solution built and validated as one atomic change. + +### Justification + +**Why All-At-Once is Appropriate**: + +βœ… **Small Solution**: 3 projects (well under the 30-project threshold) +βœ… **Simple Dependencies**: Linear dependency chain with no cycles +βœ… **Uniform Framework**: All projects currently on .NET 9.0 +βœ… **Low Complexity**: Total 1,376 LOC, all projects marked Low complexity +βœ… **Package Compatibility**: All required packages have .NET 10 versions +βœ… **No Breaking Changes**: Assessment detected 0 API breaking changes +βœ… **Clean History**: All projects already on modern .NET (not mixed .NET Framework) + +**Advantages for This Solution**: +- **Fastest Completion**: Single upgrade operation vs. multiple phases +- **No Multi-Targeting**: Avoid complexity of supporting multiple frameworks +- **Atomic Validation**: Test entire solution in target state once +- **Simple Coordination**: All developers work with same framework simultaneously +- **Clean Package Resolution**: No version conflicts from multi-targeting + +### All-At-Once Strategy Principles + +**Simultaneity**: +- Update all 3 project files to `net10.0` in single operation +- Update all package references across all projects simultaneously +- Single `dotnet restore` and `dotnet build` for entire solution +- Fix all compilation errors in same operation +- No intermediate working states + +**Single Atomic Operation**: +``` +Update Projects β†’ Update Packages β†’ Restore β†’ Build β†’ Fix Errors β†’ Verify β†’ Test +``` + +All steps execute in sequence without intermediate commits until solution builds successfully. + +### Dependency-Based Ordering Principles + +While all projects update simultaneously, understanding dependency order helps with: + +1. **Validation Sequence**: Test leaf nodes (DataModels) before dependent nodes (Contracts, Common) +2. **Troubleshooting**: If issues arise, check dependencies before dependants +3. **Smoke Testing**: Verify foundation projects work before higher-level projects + +**Order for Validation**: +1. Core.Common.DataModels (leaf - no dependencies) +2. Core.Common.Contracts (depends on DataModels) +3. Core.Common (depends on Contracts) + +### Execution Approach + +**Parallel vs. Sequential**: +- **File Updates**: Parallel - all .csproj files updated simultaneously +- **Package Updates**: Parallel - all PackageReferences updated simultaneously +- **Build**: Sequential - dependency order naturally enforced by MSBuild +- **Validation**: Sequential - leaf to root for smoke testing +- **Testing**: Comprehensive - entire solution tested as unit + +### Phase Definition + +**Phase 0: Preparation** (if needed) +- Verify .NET 10 SDK installed +- Verify current branch is `upgrade-to-NET10` +- Ensure clean working directory + +**Phase 1: Atomic Upgrade** (Single Coordinated Operation) +- Update all project TargetFramework properties +- Update all package references +- Restore dependencies +- Build entire solution +- Address compilation errors +- Verify 0 build errors + +**Phase 2: Validation** +- Run all tests (if test projects exist) +- Verify package security vulnerabilities resolved +- Confirm no dependency conflicts + +### Risk Mitigation for All-At-Once + +**Mitigation Strategies**: +1. **Pre-Upgrade Backup**: Working on feature branch `upgrade-to-NET10` +2. **Comprehensive Package List**: All package updates identified in assessment +3. **Security Focus**: Priority on resolving vulnerable packages +4. **Zero Tolerance**: Must achieve 0 build errors before proceeding +5. **Rollback Plan**: Git branch allows instant rollback to `master` + +### Expected Timeline + +**Single Atomic Operation**: +- Project file updates: Low complexity (3 files) +- Package reference updates: Low complexity (4 packages) +- Build and error resolution: Low complexity (0 breaking changes detected) +- Validation: Low complexity (no test projects identified) + +**Overall Complexity**: Low - suitable for completion in single work session + +--- + +## Detailed Dependency Analysis + +### Dependency Graph Summary + +The solution has a clean, linear dependency structure with no circular dependencies: + +``` +Core.Common.DataModels (leaf - no dependencies) + ↑ +Core.Common.Contracts (depends on DataModels) + ↑ +Core.Common (depends on Contracts) +``` + +**Dependency Characteristics**: +- **Depth**: 2 levels +- **Leaf Nodes**: 1 (Core.Common.DataModels) +- **Root Nodes**: 1 (Core.Common - no dependants) +- **Circular Dependencies**: None +- **Total Dependencies**: 2 project references + +### Project Groupings by Migration Phase + +Given the All-At-Once strategy, all projects will be upgraded simultaneously in a single atomic operation. However, for understanding the dependency order: + +**Phase 1: Atomic Upgrade** (All Projects Together) +1. Core.Common.DataModels (236 LOC, 0 dependencies) +2. Core.Common.Contracts (253 LOC, depends on DataModels) +3. Core.Common (887 LOC, depends on Contracts) + +While all projects update simultaneously, testing validation will follow dependency order to ensure leaf nodes work before dependent nodes. + +### Critical Path Identification + +**Critical Path**: Core.Common.DataModels β†’ Core.Common.Contracts β†’ Core.Common + +Since this is an All-At-Once migration, all projects change together, but the critical path helps identify: +- Where to focus initial validation (DataModels first) +- Order of smoke testing (leaf to root) +- Dependency resolution sequence during build + +### Package Dependency Insights + +**Shared Packages** (across multiple projects): +- `Microsoft.EntityFrameworkCore` 9.0.1 β†’ 10.0.5 + - Used by: Core.Common.Contracts, Core.Common + - Impact: 2 projects + +- `REST-Parser` 1.2.5 (compatible) + - Used by: Core.Common.Contracts, Core.Common + - Impact: 2 projects + +**Project-Specific Packages**: +- Core.Common.DataModels: `Microsoft.AspNetCore.Identity.EntityFrameworkCore` 9.0.1 β†’ 10.0.5 +- Core.Common: Multiple packages (see project details) + +### Migration Order Justification + +**All-At-Once Approach Rationale**: +1. **Small Scale**: Only 3 projects with clear dependencies +2. **Uniform State**: All on .NET 9.0, all targeting .NET 10.0 +3. **No Multi-Targeting**: No need for intermediate netstandard compatibility +4. **Package Alignment**: All required packages have .NET 10 versions +5. **Testing Efficiency**: Single comprehensive test pass vs. multiple phases +6. **Minimal Risk**: No breaking API changes detected + +--- + +## Project-by-Project Plans + +### Core.Common.DataModels + +**Current State**: +- Target Framework: net9.0 +- Project Type: ClassLibrary (SDK-style) +- Lines of Code: 253 +- Files: 18 +- Dependencies: 0 project references (leaf node) +- Dependants: 1 (Core.Common.Contracts) +- Packages: 1 +- APIs Analyzed: 213 (all compatible) +- Risk Level: 🟒 Low + +**Target State**: +- Target Framework: net10.0 +- Package Count: 1 (same) + +#### Migration Steps + +**1. Prerequisites** +- βœ… .NET 10 SDK installed +- βœ… Working on `upgrade-to-NET10` branch +- βœ… Core.Common.DataModels is leaf node (no dependencies to migrate first) + +**2. Framework Update** +Update project file: `Core.Common.DataModels\Core.Common.DataModels.csproj` + +Change: +```xml +net9.0 +``` + +To: +```xml +net10.0 +``` + +**3. Package Updates** + +| Package | Current Version | Target Version | Reason | +| :--- | :---: | :---: | :--- | +| Microsoft.AspNetCore.Identity.EntityFrameworkCore | 9.0.1 | 10.0.5 | Framework alignment, recommended upgrade | + +**Update in .csproj**: +```xml + +``` + +**4. Expected Breaking Changes** + +**Assessment Result**: 0 breaking changes detected + +**Entity Framework Core 9 β†’ 10 Considerations**: +- Review EF Core 10 release notes for behavioral changes +- Check identity schema compatibility +- Verify migration compatibility if using EF migrations + +**Low Risk Areas**: +- Identity data models (IdentityUser, IdentityRole, etc.) +- DbContext configurations +- Entity relationships + +**5. Code Modifications** + +**Expected**: No code changes required + +**If Issues Arise**: +- Check for EF Core obsolete API warnings +- Review identity entity base class changes +- Verify IdentityDbContext configuration + +**6. Testing Strategy** + +**Build Validation**: +- [ ] Project builds without errors +- [ ] Project builds without warnings +- [ ] No package dependency conflicts + +**Functional Validation**: +- [ ] Identity entities still properly configured +- [ ] No breaking changes in IdentityDbContext +- [ ] Package vulnerability resolved (verify EF Core 10.0.5) + +**Integration Validation**: +- [ ] Core.Common.Contracts can reference updated DataModels +- [ ] No breaking changes for dependent projects + +**7. Validation Checklist** + +- [ ] TargetFramework updated to net10.0 +- [ ] Microsoft.AspNetCore.Identity.EntityFrameworkCore updated to 10.0.5 +- [ ] `dotnet restore` succeeds +- [ ] `dotnet build` succeeds with 0 errors +- [ ] `dotnet build` produces 0 warnings +- [ ] No NuGet package conflicts +- [ ] All 213 APIs remain compatible (per assessment) +- [ ] Dependent projects (Contracts) still build + +--- + +### Core.Common.Contracts + +**Current State**: +- Target Framework: net9.0 +- Project Type: ClassLibrary (SDK-style) +- Lines of Code: 236 +- Files: 16 +- Dependencies: 1 project reference (Core.Common.DataModels) +- Dependants: 1 (Core.Common) +- Packages: 2 +- APIs Analyzed: 67 (all compatible) +- Risk Level: 🟒 Low + +**Target State**: +- Target Framework: net10.0 +- Package Count: 2 (same) + +#### Migration Steps + +**1. Prerequisites** +- βœ… .NET 10 SDK installed +- βœ… Working on `upgrade-to-NET10` branch +- βœ… Core.Common.DataModels updated to net10.0 (dependency) + +**2. Framework Update** +Update project file: `Core.Common.Contracts\Core.Common.Contracts.csproj` + +Change: +```xml +net9.0 +``` + +To: +```xml +net10.0 +``` + +**3. Package Updates** + +| Package | Current Version | Target Version | Reason | +| :--- | :---: | :---: | :--- | +| Microsoft.EntityFrameworkCore | 9.0.1 | 10.0.5 | Framework alignment, recommended upgrade | +| REST-Parser | 1.2.5 | 1.2.5 | Compatible, no update needed | + +**Update in .csproj**: +```xml + +``` + +**4. Expected Breaking Changes** + +**Assessment Result**: 0 breaking changes detected + +**Entity Framework Core 9 β†’ 10 Considerations**: +- Review EF Core 10 release notes +- Check DbContext configurations +- Verify LINQ query translations +- Review change tracking behavior changes + +**Potential Areas** (low probability): +- IRepository interface using EF Core types +- DbContext factory patterns +- Query expression trees + +**5. Code Modifications** + +**Expected**: No code changes required + +**If Issues Arise**: +- Check for EF Core obsolete API warnings in interfaces +- Review IRepository implementations using EF Core +- Verify DbContext-related interfaces +- Check REST-Parser compatibility with .NET 10 + +**Areas to Review** (contracts/interfaces): +- IRepository, IReadRepository +- IUnitOfWork +- IDatabaseFactory +- Any interfaces using EF Core types + +**6. Testing Strategy** + +**Build Validation**: +- [ ] Project builds without errors +- [ ] Project builds without warnings +- [ ] No package dependency conflicts +- [ ] Core.Common.DataModels reference resolves correctly + +**Functional Validation**: +- [ ] Repository interfaces compile successfully +- [ ] EF Core types in interfaces still valid +- [ ] REST-Parser integration intact + +**Integration Validation**: +- [ ] Core.Common can reference updated Contracts +- [ ] DataModels β†’ Contracts reference chain works +- [ ] No breaking changes for dependent projects + +**7. Validation Checklist** + +- [ ] TargetFramework updated to net10.0 +- [ ] Microsoft.EntityFrameworkCore updated to 10.0.5 +- [ ] REST-Parser remains at 1.2.5 (compatible) +- [ ] ProjectReference to Core.Common.DataModels intact +- [ ] `dotnet restore` succeeds +- [ ] `dotnet build` succeeds with 0 errors +- [ ] `dotnet build` produces 0 warnings +- [ ] No NuGet package conflicts +- [ ] All 67 APIs remain compatible (per assessment) +- [ ] Dependent projects (Core.Common) still build + +--- + +### Core.Common + +**Current State**: +- Target Framework: net9.0 +- Project Type: ClassLibrary (SDK-style) +- Lines of Code: 887 +- Files: 16 +- Dependencies: 1 project reference (Core.Common.Contracts) +- Dependants: 0 (root node) +- Packages: 7 +- APIs Analyzed: 1,130 (all compatible) +- Risk Level: 🟑 Medium (due to security-vulnerable packages) + +**Target State**: +- Target Framework: net10.0 +- Package Count: 7 (same, but 2 require security updates) + +#### Migration Steps + +**1. Prerequisites** +- βœ… .NET 10 SDK installed +- βœ… Working on `upgrade-to-NET10` branch +- βœ… Core.Common.Contracts updated to net10.0 (dependency) +- βœ… Core.Common.DataModels updated to net10.0 (transitive dependency) + +**2. Framework Update** +Update project file: `Core.Common\Core.Common.csproj` + +Change: +```xml +net9.0 +``` + +To: +```xml +net10.0 +``` + +**3. Package Updates** + +**CRITICAL - Security Vulnerabilities** (Priority 1): + +| Package | Current | Target | Reason | Notes | +| :--- | :---: | :---: | :--- | :--- | +| Microsoft.AspNetCore.Identity | 2.3.0 | 2.3.9 | **Security vulnerability** | πŸ”΄ From .NET Core 2.x era (~2018), outdated | +| Microsoft.AspNetCore.Mvc | 2.3.0 | **ASSESS** | **Security vulnerability** | πŸ”΄ May not be needed in class library | + +**Standard Updates** (Priority 2): + +| Package | Current | Target | Reason | +| :--- | :---: | :---: | :--- | +| Microsoft.EntityFrameworkCore | 9.0.1 | 10.0.5 | Framework alignment | +| Newtonsoft.Json | 13.0.3 | 13.0.4 | Recommended patch update | + +**Compatible - Optional Updates** (Priority 3): + +| Package | Current | Available | Status | +| :--- | :---: | :---: | :--- | +| System.IdentityModel.Tokens.Jwt | 8.3.1 | 8.17.0 | Compatible, update recommended | +| Ardalis.GuardClauses | 5.0.0 | - | Compatible, no update needed | +| REST-Parser | 1.2.5 | - | Compatible, no update needed | + +**Recommended .csproj Updates**: +```xml + + + + + + + + + + + + +``` + +**⚠️ IMPORTANT ASSESSMENT REQUIRED**: +Before updating `Microsoft.AspNetCore.Mvc` and `Microsoft.AspNetCore.Identity`: +1. **Determine if Core.Common actually uses these packages** + - Core.Common is a class library providing repository/data service patterns + - ASP.NET Core MVC and Identity are typically needed in web applications, not class libraries + - These may be legacy dependencies from earlier project structure + +2. **If NOT used**: **REMOVE** these packages entirely (safest option) +3. **If USED**: Update to .NET 10 compatible versions: + - Microsoft.AspNetCore.Identity β†’ Consider updating to 10.0.x range + - Microsoft.AspNetCore.Mvc β†’ Consider updating to 10.0.x range + +**4. Expected Breaking Changes** + +**Assessment Result**: 0 breaking changes detected + +**However, given package age (2.3.0 from 2018), potential issues exist**: + +**Microsoft.AspNetCore.Identity 2.3.0 β†’ 2.3.9** (if keeping): +- Stay within 2.3.x range: Low risk +- But package is 6+ years old, from .NET Core 2.x era +- **Consider**: Why does a class library need AspNetCore.Identity? +- **Risk**: API may not be compatible with .NET 10 + +**Microsoft.AspNetCore.Mvc 2.3.0** (if keeping): +- Marked as "Compatible" but contains security vulnerability +- From .NET Core 2.x era +- **Consider**: Why does a class library need AspNetCore.Mvc? +- **Likely candidate for REMOVAL** + +**Entity Framework Core 9 β†’ 10**: +- Low risk, minor version update +- Check for behavioral changes in: + - LINQ query translation + - Change tracking + - DbContext lifecycle + - Repository base class implementations + +**System.IdentityModel.Tokens.Jwt 8.3.1 β†’ 8.17.0**: +- Patch/minor update within v8 +- Low risk +- Check JWT token service implementations + +**5. Code Modifications** + +**Expected**: Minimal to no code changes + +**Areas Requiring Review**: + +**BaseRepository / BaseDataService Classes**: +- Check for EF Core obsolete API usage +- Verify DbContext factory patterns +- Review LINQ queries for translation changes +- Check change tracking behavior + +**Token Services** (if using JWT): +- Verify System.IdentityModel.Tokens.Jwt 8.17.0 compatibility +- Check token generation/validation logic +- Review claims handling + +**If AspNetCore Packages REMOVED**: +- Remove any using statements for AspNetCore.Identity or AspNetCore.Mvc +- Remove any types from these namespaces +- Likely impact: NONE (if not actually used) + +**If AspNetCore Packages KEPT**: +- Update to .NET 10 compatible versions (10.0.x) +- Check for breaking changes in Identity API +- Check for breaking changes in MVC API +- Review authentication/authorization flows + +**Potential Code Pattern Changes**: +```csharp +// Check for patterns like: +using Microsoft.AspNetCore.Identity; +using Microsoft.AspNetCore.Mvc; + +// If found and not needed, remove references +``` + +**6. Testing Strategy** + +**Build Validation**: +- [ ] Project builds without errors +- [ ] Project builds without warnings +- [ ] No package dependency conflicts +- [ ] Core.Common.Contracts reference resolves correctly + +**Security Validation** (CRITICAL): +- [ ] Microsoft.AspNetCore.Identity security vulnerability resolved +- [ ] Microsoft.AspNetCore.Mvc security vulnerability resolved +- [ ] Run `dotnet list package --vulnerable` to verify no vulnerabilities + +**Functional Validation**: +- [ ] Repository base classes compile successfully +- [ ] Data service base classes compile successfully +- [ ] Token service implementations work (if using JWT) +- [ ] EF Core DbContext factory patterns intact +- [ ] Guard clause validations still function + +**Package Assessment Validation**: +- [ ] Confirmed AspNetCore.Identity usage or removed package +- [ ] Confirmed AspNetCore.Mvc usage or removed package +- [ ] All package versions appropriate for .NET 10 + +**API Compatibility**: +- [ ] All 1,130 APIs remain compatible (per assessment) +- [ ] No breaking API changes in updated packages +- [ ] Repository pattern interfaces unchanged +- [ ] Data service pattern interfaces unchanged + +**7. Validation Checklist** + +- [ ] TargetFramework updated to net10.0 +- [ ] **SECURITY**: Microsoft.AspNetCore.Identity vulnerability addressed (updated or removed) +- [ ] **SECURITY**: Microsoft.AspNetCore.Mvc vulnerability addressed (updated or removed) +- [ ] Microsoft.EntityFrameworkCore updated to 10.0.5 +- [ ] Newtonsoft.Json updated to 13.0.4 +- [ ] System.IdentityModel.Tokens.Jwt updated to 8.17.0 (recommended) +- [ ] Ardalis.GuardClauses remains at 5.0.0 +- [ ] REST-Parser remains at 1.2.5 +- [ ] ProjectReference to Core.Common.Contracts intact +- [ ] `dotnet restore` succeeds +- [ ] `dotnet build` succeeds with 0 errors +- [ ] `dotnet build` produces 0 warnings +- [ ] `dotnet list package --vulnerable` shows 0 vulnerabilities +- [ ] No NuGet package conflicts +- [ ] All repository base classes function correctly +- [ ] All data service base classes function correctly + +#### Special Considerations + +**AspNetCore Package Assessment**: + +This is a **class library** providing common infrastructure (repository pattern, data services). Typically, class libraries do NOT need: +- Microsoft.AspNetCore.Identity (for web authentication) +- Microsoft.AspNetCore.Mvc (for web MVC framework) + +**Investigation Required**: +1. Search codebase for actual usage of AspNetCore.Identity types +2. Search codebase for actual usage of AspNetCore.Mvc types +3. If no usage found β†’ **REMOVE packages** (safest, eliminates security risk) +4. If usage found β†’ Understand why a class library needs web framework packages + +**Recommended Approach**: +- Attempt build with AspNetCore packages removed +- If build succeeds β†’ Keep them removed +- If build fails β†’ Assess minimal package needed and update to .NET 10 version + +--- + +## Risk Management + +### High-Level Assessment + +**Overall Risk Level**: **Low to Medium** + +The upgrade presents low technical risk due to small scope and lack of breaking changes, but medium risk exists due to outdated security-vulnerable packages requiring significant version jumps. + +### Risk Table + +| Project/Area | Risk Level | Description | Mitigation | +| :--- | :---: | :--- | :--- | +| Core.Common.DataModels | 🟒 Low | Simple upgrade, 1 package update, no dependencies | Test after upgrade, verify EF Core compatibility | +| Core.Common.Contracts | 🟒 Low | Simple upgrade, 1 package update, 1 project dependency | Verify DataModels reference works, test EF Core | +| Core.Common | 🟑 Medium | 7 packages including 2 with security vulnerabilities | Prioritize security packages, extensive testing, verify API compatibility | +| Microsoft.AspNetCore.Identity | πŸ”΄ High | Version 2.3.0 β†’ 2.3.9 (security vulnerability) | Update immediately, test authentication/authorization flows | +| Microsoft.AspNetCore.Mvc | πŸ”΄ High | Version 2.3.0 (security vulnerability, may need removal) | Assess if needed for class library, consider removal | +| All-At-Once Strategy | 🟑 Medium | All projects change simultaneously, larger test surface | Feature branch isolation, comprehensive validation | + +### Security Vulnerabilities + +**Critical Security Issues** (Must Address): + +1. **Microsoft.AspNetCore.Identity 2.3.0** + - **Severity**: Security vulnerability + - **Current**: 2.3.0 (from .NET Core 2.x era, ~2018) + - **Recommended**: 2.3.9 (assessment recommendation) + - **Remediation**: Update to recommended version immediately + - **Impact**: Used in Core.Common project + - **Concern**: 5+ year old package with known vulnerabilities + +2. **Microsoft.AspNetCore.Mvc 2.3.0** + - **Severity**: Security vulnerability (per assessment) + - **Current**: 2.3.0 (from .NET Core 2.x era, ~2018) + - **Assessment**: Marked as "Compatible" but flagged for security + - **Remediation Options**: + - Option A: Update to latest compatible version + - Option B: **Remove if not needed** (Core.Common is a class library, may not need MVC) + - **Impact**: Used in Core.Common project + - **Recommendation**: Assess necessity first; class libraries typically don't need AspNetCore.Mvc + +### Package Update Risks + +**Moderate Risk Updates**: + +| Package | Current | Target | Risk | Mitigation | +| :--- | :---: | :---: | :--- | :--- | +| Microsoft.EntityFrameworkCore | 9.0.1 | 10.0.5 | 🟑 Medium | Minor version jump, review EF Core 10 breaking changes, test migrations | +| Microsoft.AspNetCore.Identity.EntityFrameworkCore | 9.0.1 | 10.0.5 | 🟑 Medium | Aligns with EF Core version, test identity schema | +| Newtonsoft.Json | 13.0.3 | 13.0.4 | 🟒 Low | Patch update only | + +**Low Risk (Compatible)**: +- Ardalis.GuardClauses 5.0.0 - No update needed +- REST-Parser 1.2.5 - No update needed +- System.IdentityModel.Tokens.Jwt 8.3.1 - Compatible (though 8.17.0 available) + +### Contingency Plans + +**If Build Fails After Framework Update**: +1. Review compilation errors for patterns +2. Check for obsolete API usage in error messages +3. Consult .NET 10 breaking changes documentation +4. Fix errors incrementally, rebuild after each fix +5. If unresolvable, rollback via Git: `git checkout master` + +**If Security Package Updates Cause Issues**: +1. **For Microsoft.AspNetCore.Identity**: + - Try intermediate versions (2.3.5, 2.3.7) if 2.3.9 fails + - Review identity schema compatibility + - Check if authentication flows still work + +2. **For Microsoft.AspNetCore.Mvc**: + - Assess if Core.Common truly needs this package + - Class libraries typically don't require MVC + - Consider removing entirely if not used + - If needed, update to .NET 10 compatible version + +**If Package Conflicts Arise**: +1. Run `dotnet restore --force` to clear cache +2. Check for transitive dependency conflicts +3. Explicitly specify versions in Directory.Packages.props if needed +4. Use `dotnet list package --include-transitive` to diagnose + +**Rollback Strategy**: +- All work on `upgrade-to-NET10` branch +- Master branch remains stable +- Instant rollback: `git checkout master` +- No production impact during upgrade + +### Unknown Risks + +**Items Requiring Investigation**: +- ⚠️ Purpose of AspNetCore.Mvc in class library (Core.Common) +- ⚠️ Purpose of AspNetCore.Identity in class library (Core.Common) +- ⚠️ Whether REST-Parser 1.2.5 fully compatible with .NET 10 (marked compatible but may need testing) +- ⚠️ Behavioral changes in EF Core 10 vs. EF Core 9 + +--- + +## Testing & Validation Strategy + +### Overview + +Since no test projects were identified in the assessment, validation will focus on build success, package vulnerability resolution, and smoke testing of core functionality. + +### Multi-Level Testing Approach + +#### Phase 1: Per-Project Build Validation + +After each project update in the atomic upgrade, verify: + +**Core.Common.DataModels**: +- [ ] `dotnet restore Core.Common.DataModels\Core.Common.DataModels.csproj` succeeds +- [ ] `dotnet build Core.Common.DataModels\Core.Common.DataModels.csproj` succeeds +- [ ] 0 build errors +- [ ] 0 build warnings +- [ ] No package conflicts + +**Core.Common.Contracts**: +- [ ] `dotnet restore Core.Common.Contracts\Core.Common.Contracts.csproj` succeeds +- [ ] `dotnet build Core.Common.Contracts\Core.Common.Contracts.csproj` succeeds +- [ ] 0 build errors +- [ ] 0 build warnings +- [ ] No package conflicts +- [ ] DataModels reference resolves correctly + +**Core.Common**: +- [ ] `dotnet restore Core.Common\Core.Common.csproj` succeeds +- [ ] `dotnet build Core.Common\Core.Common.csproj` succeeds +- [ ] 0 build errors +- [ ] 0 build warnings +- [ ] No package conflicts +- [ ] Contracts reference resolves correctly + +#### Phase 2: Solution-Wide Validation + +After all projects updated in atomic operation: + +**Build Validation**: +- [ ] `dotnet restore SilverCodeAPI.sln` succeeds +- [ ] `dotnet build SilverCodeAPI.sln` succeeds +- [ ] All 3 projects build successfully +- [ ] 0 errors across entire solution +- [ ] 0 warnings across entire solution + +**Package Validation**: +- [ ] `dotnet list package` shows all packages at expected versions +- [ ] `dotnet list package --vulnerable` shows **0 vulnerabilities** +- [ ] `dotnet list package --outdated` checked for awareness +- [ ] No package version conflicts + +**Dependency Validation**: +- [ ] Project references resolve correctly +- [ ] Transitive dependencies align properly +- [ ] No circular dependency issues + +#### Phase 3: Smoke Testing + +**Compilation Smoke Tests**: +- [ ] All interfaces compile (IRepository, IReadRepository, IUnitOfWork, etc.) +- [ ] All base classes compile (BaseRepository, BaseDataService, etc.) +- [ ] All data models compile (IdentityUser extensions, etc.) + +**Security Vulnerability Verification**: +- [ ] Microsoft.AspNetCore.Identity vulnerability **RESOLVED** (updated or removed) +- [ ] Microsoft.AspNetCore.Mvc vulnerability **RESOLVED** (updated or removed) +- [ ] Run vulnerability scan confirms 0 critical/high/medium vulnerabilities + +**Framework Compatibility**: +- [ ] All projects target net10.0 +- [ ] No net9.0 references remain +- [ ] Package versions compatible with .NET 10 + +#### Phase 4: Manual Verification (if applicable) + +If this solution is referenced by consuming applications: + +**Consumer Build Test**: +- [ ] Build consuming application that references these libraries +- [ ] Verify no breaking changes in public APIs +- [ ] Check for runtime compatibility + +**Package Generation Test** (if NuGet package produced): +- [ ] `dotnet pack` succeeds for Core.Common +- [ ] NuGet package targets net10.0 +- [ ] Package dependencies reflect updated versions + +### Testing Checklist by Project + +#### Core.Common.DataModels +- [ ] Builds without errors +- [ ] Builds without warnings +- [ ] Microsoft.AspNetCore.Identity.EntityFrameworkCore 10.0.5 installed +- [ ] Identity data models compile +- [ ] No API breaking changes + +#### Core.Common.Contracts +- [ ] Builds without errors +- [ ] Builds without warnings +- [ ] Microsoft.EntityFrameworkCore 10.0.5 installed +- [ ] REST-Parser 1.2.5 compatible +- [ ] All interface definitions compile +- [ ] Repository interfaces intact + +#### Core.Common +- [ ] Builds without errors +- [ ] Builds without warnings +- [ ] **All security vulnerabilities resolved** +- [ ] Microsoft.EntityFrameworkCore 10.0.5 installed +- [ ] System.IdentityModel.Tokens.Jwt 8.17.0 installed +- [ ] Newtonsoft.Json 13.0.4 installed +- [ ] All base classes compile +- [ ] Repository implementations intact +- [ ] Data service implementations intact + +### Success Criteria for Testing Phase + +**Mandatory** (must pass): +- βœ… All projects build with 0 errors +- βœ… All projects build with 0 warnings +- βœ… **0 security vulnerabilities** reported by `dotnet list package --vulnerable` +- βœ… All project references resolve correctly +- βœ… All package dependencies compatible + +**Recommended** (should verify): +- βœ… Consuming applications still build (if applicable) +- βœ… NuGet packages generate successfully (if applicable) +- βœ… All public APIs remain compatible + +### Validation Commands + +Run these commands to validate the upgrade: + +```bash +# Build entire solution +dotnet restore SilverCodeAPI.sln +dotnet build SilverCodeAPI.sln --no-restore + +# Check for vulnerabilities (MUST show 0) +dotnet list package --vulnerable + +# Check package versions +dotnet list package + +# Check for outdated packages (informational) +dotnet list package --outdated + +# Build each project individually (if solution build fails) +dotnet build Core.Common.DataModels\Core.Common.DataModels.csproj +dotnet build Core.Common.Contracts\Core.Common.Contracts.csproj +dotnet build Core.Common\Core.Common.csproj + +# Generate packages (if applicable) +dotnet pack Core.Common\Core.Common.csproj --configuration Release +``` + +### Rollback Criteria + +If any of these conditions occur, **ROLLBACK** the upgrade: + +- ❌ Build errors cannot be resolved after reasonable effort +- ❌ Security vulnerabilities still present after package updates +- ❌ Breaking changes in public APIs affect consuming applications +- ❌ Critical functionality broken with no clear resolution + +**Rollback Command**: +```bash +git checkout master +# or +git reset --hard origin/master +``` + +--- + +## Complexity & Effort Assessment + +### Overall Complexity: **Low** + +The solution upgrade is straightforward due to small size, clean dependencies, and lack of detected breaking changes. + +### Per-Project Complexity + +| Project | Complexity | LOC | Packages | Dependencies | Risk Factors | +| :--- | :---: | :---: | :---: | :---: | :--- | +| Core.Common.DataModels | 🟒 Low | 253 | 1 | 0 | Leaf node, single package update | +| Core.Common.Contracts | 🟒 Low | 236 | 2 | 1 | Single project dependency, 1 package update | +| Core.Common | 🟑 Medium | 887 | 7 | 1 | 7 packages, 2 security vulnerabilities, largest codebase | + +**Complexity Ratings**: +- 🟒 **Low**: Straightforward upgrade, minimal changes, low risk +- 🟑 **Medium**: Moderate package updates, security vulnerabilities to address +- πŸ”΄ **High**: (none in this solution) + +### Phase Complexity Assessment + +**Phase 1: Atomic Upgrade** +- **Complexity**: 🟑 Medium +- **Factors**: + - 3 project files to update (Low) + - 4 package updates required (Low) + - 2 security-vulnerable packages requiring attention (Medium) + - Severely outdated AspNetCore packages (2.3.0 from 2018) (Medium) + - 0 detected breaking changes (Low) +- **Dependencies**: Must follow dependency order for validation +- **Effort**: Low to Medium - security packages may require investigation + +**Phase 2: Validation** +- **Complexity**: 🟒 Low +- **Factors**: + - No test projects identified in assessment (Low) + - Simple build validation only (Low) + - Package vulnerability verification (Low) +- **Effort**: Low - primarily automated validation + +### Relative Effort by Activity + +| Activity | Complexity | Notes | +| :--- | :---: | :--- | +| Update TargetFramework Properties | 🟒 Low | 3 simple .csproj edits | +| Update Package References | 🟑 Medium | 4 packages, focus on security packages | +| Restore Dependencies | 🟒 Low | Automated `dotnet restore` | +| Build Solution | 🟒 Low | 0 breaking changes detected | +| Fix Compilation Errors | 🟒 Low | Expected 0 errors | +| Address Security Packages | 🟑 Medium | May require version research, compatibility testing | +| Validate AspNetCore Packages | 🟑 Medium | Assess necessity in class library context | +| Test Solution | 🟒 Low | No test projects, basic smoke testing | + +### Resource Requirements + +**Skills Required**: +- .NET framework upgrade experience (Basic) +- NuGet package management (Basic) +- Understanding of project dependencies (Basic) +- Security vulnerability assessment (Intermediate - for AspNetCore packages) +- Entity Framework Core knowledge (Basic - for EF Core 10 update) + +**Parallel Work Capacity**: +- All-At-Once strategy requires sequential execution +- Single developer can complete upgrade +- No parallelization opportunities due to atomic operation + +**Estimated Effort Distribution**: +- Project file updates: 15% (straightforward) +- Package reference updates: 30% (majority of effort, especially security packages) +- Build and error resolution: 20% (expected to be minimal) +- Security package assessment: 25% (determining necessity, compatibility) +- Validation and testing: 10% (no test projects) + +### Key Effort Drivers + +**Primary Effort Drivers**: +1. **Security Package Updates**: Assessing AspNetCore.Identity and AspNetCore.Mvc necessity and compatibility +2. **Package Version Research**: Determining correct versions for severely outdated packages +3. **Validation**: Ensuring security vulnerabilities resolved + +**Secondary Effort Drivers**: +1. Entity Framework Core 10 compatibility verification +2. REST-Parser compatibility testing +3. General smoke testing of repository/data service patterns + +--- + +## Source Control Strategy + +### Branch Strategy + +**Current Branch Structure**: +- **Source Branch**: `master` (stable, pre-upgrade state) +- **Upgrade Branch**: `upgrade-to-NET10` (current working branch, isolated changes) + +**Rationale**: +- Feature branch isolation protects master from in-progress changes +- Easy rollback capability (`git checkout master`) +- Clear separation of .NET 9 (master) vs .NET 10 (upgrade branch) +- Enables PR-based review before merge + +### Commit Strategy + +**All-At-Once Strategy Approach**: Single comprehensive commit + +Given the All-At-Once strategy where all projects update simultaneously, the recommended approach is: + +**Single Atomic Commit** (Preferred): +- All project file updates +- All package reference updates +- All compilation fixes +- Commit only after entire solution builds successfully with 0 errors + +**Commit Message Format**: +``` +feat: Upgrade solution to .NET 10 + +- Update all projects from net9.0 to net10.0 +- Update Microsoft.EntityFrameworkCore 9.0.1 β†’ 10.0.5 +- Update Microsoft.AspNetCore.Identity.EntityFrameworkCore 9.0.1 β†’ 10.0.5 +- Resolve security vulnerabilities: + - Microsoft.AspNetCore.Identity 2.3.0 β†’ 2.3.9 (or removed) + - Microsoft.AspNetCore.Mvc 2.3.0 (resolved/removed) +- Update Newtonsoft.Json 13.0.3 β†’ 13.0.4 +- Update System.IdentityModel.Tokens.Jwt 8.3.1 β†’ 8.17.0 + +Projects updated: +- Core.Common.DataModels +- Core.Common.Contracts +- Core.Common + +Validated: 0 build errors, 0 warnings, 0 security vulnerabilities +``` + +**Alternative: Checkpoint Commits** (if needed): + +If atomic approach becomes unwieldy, consider these checkpoints: + +1. **Checkpoint 1**: Project file updates only + ``` + chore: Update all projects to target net10.0 + ``` + +2. **Checkpoint 2**: Package reference updates + ``` + chore: Update package references for .NET 10 compatibility + ``` + +3. **Checkpoint 3**: Compilation fixes + ``` + fix: Address compilation errors from .NET 10 upgrade + ``` + +4. **Checkpoint 4**: Security resolution + ``` + security: Resolve package vulnerabilities + ``` + +However, **single atomic commit is preferred** for All-At-Once strategy. + +### Commit Best Practices + +**What to Include**: +- βœ… All .csproj file changes +- βœ… All package reference updates +- βœ… Any code changes required for compilation +- βœ… Any configuration file changes +- βœ… Update to package release notes (if maintaining) + +**What to Exclude**: +- ❌ Unrelated code changes +- ❌ Refactoring not required by upgrade +- ❌ New features +- ❌ bin/obj directories (should be in .gitignore) +- ❌ IDE-specific files + +**Verification Before Commit**: +```bash +# Check status +git status + +# Review changes +git diff + +# Verify build succeeds +dotnet build SilverCodeAPI.sln + +# Verify no vulnerabilities +dotnet list package --vulnerable + +# Stage changes +git add Core.Common.DataModels/Core.Common.DataModels.csproj +git add Core.Common.Contracts/Core.Common.Contracts.csproj +git add Core.Common/Core.Common.csproj + +# Include any additional changed files +git add [other-changed-files] + +# Commit +git commit -m "feat: Upgrade solution to .NET 10" +``` + +### Review and Merge Process + +**Pre-Merge Checklist**: + +Before creating PR or merging to master: + +**Build Verification**: +- [ ] `dotnet build SilverCodeAPI.sln` succeeds with 0 errors +- [ ] `dotnet build SilverCodeAPI.sln` succeeds with 0 warnings +- [ ] All 3 projects build successfully + +**Security Verification**: +- [ ] `dotnet list package --vulnerable` shows **0 vulnerabilities** +- [ ] Microsoft.AspNetCore.Identity vulnerability resolved +- [ ] Microsoft.AspNetCore.Mvc vulnerability resolved + +**Package Verification**: +- [ ] All package versions match plan specifications +- [ ] No package conflicts +- [ ] All packages compatible with net10.0 + +**Code Review Criteria** (if using PR): +- [ ] All .csproj files updated to net10.0 +- [ ] Package versions match plan +- [ ] No unrelated changes included +- [ ] Commit message clear and descriptive +- [ ] Security vulnerabilities addressed + +**Merge Command**: +```bash +# Switch to master +git checkout master + +# Merge upgrade branch +git merge upgrade-to-NET10 + +# Push to remote +git push origin master + +# Optionally delete upgrade branch +git branch -d upgrade-to-NET10 +git push origin --delete upgrade-to-NET10 +``` + +### Alternative: Pull Request Workflow + +If using GitHub/Azure DevOps/GitLab: + +1. **Create PR**: `upgrade-to-NET10` β†’ `master` +2. **PR Title**: "Upgrade solution to .NET 10" +3. **PR Description**: Include commit message details + verification checklist +4. **Request Review**: Technical lead or team review +5. **Verify CI/CD**: Ensure automated builds pass (if configured) +6. **Approve and Merge**: Squash commits or merge based on team preference + +**PR Template**: +```markdown +## Summary +Upgrades SilverCodeAPI solution from .NET 9 to .NET 10 (LTS). + +## Changes +- All projects updated to target net10.0 +- Package updates for .NET 10 compatibility +- Security vulnerabilities resolved + +## Projects Affected +- Core.Common.DataModels +- Core.Common.Contracts +- Core.Common + +## Security Fixes +- Microsoft.AspNetCore.Identity: 2.3.0 β†’ 2.3.9 (or removed) +- Microsoft.AspNetCore.Mvc: 2.3.0 (resolved/removed) + +## Verification +- [x] Solution builds with 0 errors +- [x] Solution builds with 0 warnings +- [x] 0 security vulnerabilities (`dotnet list package --vulnerable`) +- [x] All package versions updated per plan +- [x] No breaking API changes + +## Testing +- [x] All projects build individually +- [x] Solution builds successfully +- [x] Package generation succeeds (if applicable) +``` + +### Rollback Strategy + +**If Issues Found After Merge**: + +```bash +# Option 1: Revert the merge commit +git revert -m 1 + +# Option 2: Reset to pre-merge state (if not pushed to remote) +git reset --hard HEAD~1 + +# Option 3: Create new branch from master and cherry-pick fixes +git checkout -b hotfix-net10-issues master +git cherry-pick +``` + +**Protection**: +- Master branch remains stable throughout upgrade +- Upgrade work isolated on feature branch +- Can always return to working state via `git checkout master` + +### Post-Merge Activities + +**After Successful Merge**: +1. Update documentation with .NET 10 target +2. Update CI/CD pipelines to use .NET 10 SDK (if applicable) +3. Notify team of framework change +4. Update any deployment documentation +5. Verify consuming applications still compatible (if applicable) +6. Tag release (optional): `git tag v1.2.10-net10` + +--- + +## Success Criteria + +### The migration is complete when: + +#### Technical Criteria (Mandatory) + +**Framework Migration**: +- βœ… All 3 projects target net10.0 +- βœ… No projects remain on net9.0 +- βœ… All .csproj files updated with `net10.0` + +**Package Updates**: +- βœ… Microsoft.EntityFrameworkCore updated from 9.0.1 to 10.0.5 (2 projects) +- βœ… Microsoft.AspNetCore.Identity.EntityFrameworkCore updated from 9.0.1 to 10.0.5 (1 project) +- βœ… Newtonsoft.Json updated from 13.0.3 to 13.0.4 (1 project) +- βœ… System.IdentityModel.Tokens.Jwt updated from 8.3.1 to 8.17.0 (recommended, 1 project) + +**Security Resolution** (CRITICAL): +- βœ… **Microsoft.AspNetCore.Identity security vulnerability RESOLVED** + - Either updated to 2.3.9+ OR removed from project +- βœ… **Microsoft.AspNetCore.Mvc security vulnerability RESOLVED** + - Either updated to secure version OR removed from project +- βœ… `dotnet list package --vulnerable` reports **0 vulnerabilities** +- βœ… No critical, high, or medium severity vulnerabilities remain + +**Build Success**: +- βœ… `dotnet restore SilverCodeAPI.sln` succeeds +- βœ… `dotnet build SilverCodeAPI.sln` succeeds with **0 errors** +- βœ… `dotnet build SilverCodeAPI.sln` succeeds with **0 warnings** +- βœ… All 3 projects build individually without errors +- βœ… All 3 projects build individually without warnings + +**Dependency Resolution**: +- βœ… No NuGet package dependency conflicts +- βœ… All project references resolve correctly: + - Core.Common β†’ Core.Common.Contracts βœ“ + - Core.Common.Contracts β†’ Core.Common.DataModels βœ“ +- βœ… Transitive dependencies align properly +- βœ… No version conflicts in dependency graph + +**API Compatibility**: +- βœ… All 1,410 APIs analyzed remain compatible (per assessment) +- βœ… No breaking changes in public interfaces +- βœ… Repository pattern APIs unchanged +- βœ… Data service pattern APIs unchanged + +#### Quality Criteria + +**Code Quality**: +- βœ… No compiler warnings introduced by upgrade +- βœ… No obsolete API usage warnings +- βœ… All base classes compile successfully: + - BaseRepository and variants + - BaseDataService and variants + - BaseTokenService (if applicable) +- βœ… All interfaces compile successfully: + - IRepository, IReadRepository + - IUnitOfWork + - IDatabaseFactory + - IAuditor + +**Test Coverage Maintained**: +- βœ… No test projects identified, N/A for this solution +- βœ… If consuming applications exist, their tests still pass + +**Documentation Updated**: +- βœ… README updated with .NET 10 target (if applicable) +- βœ… Package release notes updated (Core.Common.csproj has PackageReleaseNotes) +- βœ… Version numbers incremented appropriately + +#### Process Criteria + +**All-At-Once Strategy Execution**: +- βœ… All 3 projects updated simultaneously in single atomic operation +- βœ… No intermediate multi-targeting states +- βœ… Single comprehensive validation pass +- βœ… All changes coordinated and consistent + +**Source Control**: +- βœ… All changes committed to `upgrade-to-NET10` branch +- βœ… Commit message clear and descriptive +- βœ… No unrelated changes included in upgrade commit +- βœ… Master branch remains stable and unaffected + +**Security-First Approach**: +- βœ… Security-vulnerable packages addressed first +- βœ… AspNetCore.Identity vulnerability resolved +- βœ… AspNetCore.Mvc vulnerability resolved +- βœ… Vulnerability scan confirms 0 issues + +**Validation Complete**: +- βœ… All items in Testing & Validation Strategy checklist completed +- βœ… All project-specific validation checklists completed +- βœ… Build verification passed +- βœ… Package verification passed +- βœ… Security verification passed + +#### Acceptance Criteria + +**Before Merging to Master**: +- βœ… All Technical Criteria met (100%) +- βœ… All Quality Criteria met (100%) +- βœ… All Process Criteria met (100%) +- βœ… Security vulnerabilities = 0 +- βœ… Build errors = 0 +- βœ… Build warnings = 0 +- βœ… Code review completed (if using PR workflow) +- βœ… Team notified of pending framework change + +#### Optional Enhancement Criteria + +**Package Optimization** (Nice-to-have): +- β­• AspNetCore.Identity assessed for necessity in class library +- β­• AspNetCore.Mvc assessed for necessity in class library +- β­• Unused packages removed (if any identified) +- β­• All packages updated to latest compatible versions + +**Tooling Updates** (If applicable): +- β­• CI/CD pipeline updated to use .NET 10 SDK +- β­• Dockerfile updated to use .NET 10 runtime (if applicable) +- β­• Development environment documentation updated +- β­• NuGet package generation verified (Core.Common produces package) + +#### Verification Commands + +Run these commands to verify all success criteria met: + +```bash +# Framework verification +grep -r "net9.0" *.csproj # Should return 0 results +grep -r "net10.0" *.csproj # Should return 3 results + +# Build verification +dotnet clean +dotnet restore SilverCodeAPI.sln +dotnet build SilverCodeAPI.sln --no-restore +# Expected: Build succeeded. 0 Warning(s). 0 Error(s). + +# Security verification (CRITICAL) +dotnet list package --vulnerable +# Expected: No vulnerable packages found + +# Package version verification +dotnet list package +# Verify versions match plan specifications + +# Package generation verification (if applicable) +dotnet pack Core.Common\Core.Common.csproj --configuration Release +# Expected: Successfully created package +``` + +#### Definition of Done + +**The .NET 10 upgrade is DONE when**: + +1. βœ… **All projects target .NET 10** - Verified by build success +2. βœ… **All recommended packages updated** - Verified by `dotnet list package` +3. βœ… **Zero security vulnerabilities** - Verified by `dotnet list package --vulnerable` +4. βœ… **Zero build errors** - Verified by `dotnet build` +5. βœ… **Zero build warnings** - Verified by `dotnet build` +6. βœ… **All tests pass** - N/A (no test projects identified) +7. βœ… **Changes committed** - Verified by `git log` +8. βœ… **Team notified** - Manual confirmation + +At this point, the upgrade branch is ready to merge to master and the solution is successfully upgraded to .NET 10 (LTS). + +--- + +## Summary + +This plan provides a comprehensive roadmap for upgrading the SilverCodeAPI solution from .NET 9 to .NET 10 using an All-At-Once strategy. The key focus areas are: + +1. **Security-First**: Resolving critical vulnerabilities in AspNetCore packages +2. **Atomic Upgrade**: All projects updated simultaneously for efficiency +3. **Dependency-Aware**: Following dependency order for validation +4. **Zero-Tolerance**: Must achieve 0 errors, 0 warnings, 0 vulnerabilities + +The upgrade is low-to-medium complexity with primary challenges around assessing and resolving severely outdated security-vulnerable packages. With proper execution following this plan, the upgrade should complete successfully in a single work session. diff --git a/.github/upgrades/scenarios/new-dotnet-version_a4b017/scenario.json b/.github/upgrades/scenarios/new-dotnet-version_a4b017/scenario.json new file mode 100644 index 0000000..2f648e6 --- /dev/null +++ b/.github/upgrades/scenarios/new-dotnet-version_a4b017/scenario.json @@ -0,0 +1,13 @@ +{ + "scenarioId": "New-DotNet-Version", + "operationId": "a4b017d2-c1ee-407c-8111-e88307c16ccf", + "description": "Upgrade solution or project to new version of .NET", + "startTime": "2026-03-30T21:48:12.6442079Z", + "lastUpdateTime": "2026-03-30T23:25:15.8016521Z", + "stage": "Execution", + "properties": { + "UpgradeTargetFramework": "net10.0", + "SelectedScenarioStrategy": "AllAtOnce" + }, + "folderPath": "" +} \ No newline at end of file diff --git a/.github/upgrades/scenarios/new-dotnet-version_a4b017/tasks.md b/.github/upgrades/scenarios/new-dotnet-version_a4b017/tasks.md new file mode 100644 index 0000000..02dba2a --- /dev/null +++ b/.github/upgrades/scenarios/new-dotnet-version_a4b017/tasks.md @@ -0,0 +1,41 @@ +ye# SilverCodeAPI .NET 10 Upgrade Tasks + +## Overview + +This document tracks the execution of the SilverCodeAPI upgrade from .NET 9.0 to .NET 10.0. All 3 projects will be upgraded simultaneously in a single atomic operation following the All-At-Once strategy. + +**Progress**: 0/2 tasks complete (0%) ![0%](https://progress-bar.xyz/0) + +--- + +## Tasks + +### [ ] TASK-001: Verify prerequisites +**References**: Plan Β§Phase 0 + +- [ ] (1) Verify .NET 10 SDK installed per Plan Β§Prerequisites +- [ ] (2) SDK version meets minimum requirements (**Verify**) + +--- + +### [ ] TASK-002: Atomic framework and package upgrade with security resolution +**References**: Plan Β§Phase 1, Plan Β§Package Update Reference, Plan Β§Core.Common, Plan Β§Security Vulnerabilities + +- [ ] (1) Update TargetFramework to net10.0 in all 3 project files per Plan Β§Project-by-Project Plans (Core.Common.DataModels, Core.Common.Contracts, Core.Common) +- [ ] (2) All project files updated to net10.0 (**Verify**) +- [ ] (3) Assess Microsoft.AspNetCore.Identity and Microsoft.AspNetCore.Mvc necessity in Core.Common (class library context) per Plan Β§Core.Common Special Considerations +- [ ] (4) Update package references per Plan Β§Package Update Reference: Microsoft.EntityFrameworkCore 9.0.1β†’10.0.5 (2 projects), Microsoft.AspNetCore.Identity.EntityFrameworkCore 9.0.1β†’10.0.5 (1 project), Newtonsoft.Json 13.0.3β†’13.0.4 (1 project), System.IdentityModel.Tokens.Jwt 8.3.1β†’8.17.0 (1 project) +- [ ] (5) Resolve security vulnerabilities per Plan Β§Security Vulnerabilities: Microsoft.AspNetCore.Identity 2.3.0β†’2.3.9 or remove, Microsoft.AspNetCore.Mvc 2.3.0 update or remove +- [ ] (6) All package references updated (**Verify**) +- [ ] (7) Restore all dependencies +- [ ] (8) All dependencies restored successfully (**Verify**) +- [ ] (9) Build solution and fix all compilation errors per Plan Β§Breaking Changes Catalog and Plan Β§Core.Common Code Modifications +- [ ] (10) Solution builds with 0 errors (**Verify**) +- [ ] (11) Solution builds with 0 warnings (**Verify**) +- [ ] (12) Run `dotnet list package --vulnerable` to verify security vulnerabilities resolved +- [ ] (13) Zero security vulnerabilities reported (**Verify**) +- [ ] (14) Verify all 1,410 APIs remain compatible per assessment +- [ ] (15) All APIs compatible, no breaking changes (**Verify**) +- [ ] (16) Commit changes with message: "feat: Upgrade solution to .NET 10\n\n- Update all projects from net9.0 to net10.0\n- Update Microsoft.EntityFrameworkCore 9.0.1 β†’ 10.0.5\n- Update Microsoft.AspNetCore.Identity.EntityFrameworkCore 9.0.1 β†’ 10.0.5\n- Resolve security vulnerabilities: Microsoft.AspNetCore.Identity and Microsoft.AspNetCore.Mvc\n- Update Newtonsoft.Json 13.0.3 β†’ 13.0.4\n- Update System.IdentityModel.Tokens.Jwt 8.3.1 β†’ 8.17.0\n\nProjects updated:\n- Core.Common.DataModels\n- Core.Common.Contracts\n- Core.Common\n\nValidated: 0 build errors, 0 warnings, 0 security vulnerabilities" + +--- \ No newline at end of file diff --git a/Core.Common.Contracts/Core.Common.Contracts.csproj b/Core.Common.Contracts/Core.Common.Contracts.csproj index 534858f..449545a 100644 --- a/Core.Common.Contracts/Core.Common.Contracts.csproj +++ b/Core.Common.Contracts/Core.Common.Contracts.csproj @@ -8,7 +8,7 @@ - net9.0 + net10.0 true John McArthur John McArthur @@ -18,7 +18,7 @@ https://github.com/BigBadJock/SilverCodeAPI https://github.com/BigBadJock/SilverCodeAPI API, Interfaces - 1.2025.213.2317 + 1.2026.331.214 1.2.6 - Removed some old code 1.2.5 - Update to dotnet 9 @@ -53,8 +53,8 @@ - - + + diff --git a/Core.Common.DataModels/Core.Common.DataModels.csproj b/Core.Common.DataModels/Core.Common.DataModels.csproj index 9caba76..b8fb9a1 100644 --- a/Core.Common.DataModels/Core.Common.DataModels.csproj +++ b/Core.Common.DataModels/Core.Common.DataModels.csproj @@ -1,7 +1,7 @@ ο»Ώ - net9.0 + net10.0 John McArthur John McArthur true @@ -10,7 +10,7 @@ https://github.com/BigBadJock/SilverCodeAPI API, DataModels, Base Classes 2025 - 1.2025.213.2317 + 1.2026.331.214 1.2.6 - removed some old code 1.2.5 - upgradge to net9.0 @@ -29,7 +29,7 @@ - + diff --git a/Core.Common/Core.Common.csproj b/Core.Common/Core.Common.csproj index 0a5d48c..b787340 100644 --- a/Core.Common/Core.Common.csproj +++ b/Core.Common/Core.Common.csproj @@ -8,12 +8,12 @@ - net9.0 + net10.0 true John McArthur John McArthur 2025 - 1.2025.213.2317 + 1.2026.331.214 1.2.6 - Removed some old code 1.2.5 - Update to dotnet 9 @@ -72,12 +72,10 @@ - - - - - - + + + +