Merge pull request #97 from TechnologyEnhancedLearning/refactor-logging

Refactor logging

Author: Phil-NHS

.github/workflows/workflow-readme.md

@@ -83,4 +83,4 @@ The individual steps also automatically pass so can see if any error at the end
 - for tests use the run-tests-and-report-with-env-values.ps1 file
 
 ## Versioning
-
+Via semantic release and recorded as a generate c# file used by a blazor component

.gitignore

@@ -208,3 +208,31 @@ CHANGELOG.md
 /.runsettings
 /nuget.config
 /nuget.config
+
+
+AllTestResults/*
+!AllTestResults/gitinclude.txt
+
+CICDPackageLocation/*
+!CICDPackageLocation/gitinclude.txt
+
+CoverageReport/*
+!CoverageReport/gitinclude.txt
+
+docs/css/*
+!docs/css/gitinclude.txt
+
+TELBlazor.Components.ShowCase.E2ETests/Reports/*
+!TELBlazor.Components.ShowCase.E2ETests/Reports/gitinclude.txt
+
+TELBlazor.Components.ShowCase.E2ETests.WasmServerHost/Logs/*
+!TELBlazor.Components.ShowCase.E2ETests.WasmServerHost/Logs/gitinclude.txt
+
+**/wwwroot/css/*
+!**/wwwroot/css/app.css
+
+/tools/
+**/wwwroot/TELBlazorPackageVersion.txt
+
+# Generated version info files
+TELBlazor.Components/TELBlazorPackageVersion/VersionInfo*.cs

Directory.Packages.props

@@ -58,6 +58,6 @@
     <PackageVersion Include="Microsoft.Playwright.Xunit" Version="1.50.0" />
     <PackageVersion Include="Verify.Playwright" Version="3.0.0" />
     <!-- Internal packages -->
-    <PackageVersion Include="TELBlazor.Components" Version="$(TELBlazorPackageVersion)" />
+    <PackageVersion Include="TELBlazor.Components" Version="$(TELBlazorPackageVersion)" IncludePrerelease="true"/>
   </ItemGroup>
 </Project>

PackageSettings.props

@@ -50,7 +50,9 @@
 
 	  <!--Building the components project makes the package publish isnt needed-->
     <DisablePackageGeneration>$(DISABLE_PACKAGE_GENERATION)</DisablePackageGeneration>
-	
+
+		<!--So updates prerelease versions-->
+	<RestorePrerelease>true</RestorePrerelease>
   </PropertyGroup>
 
 </Project>

README.md

@@ -173,7 +173,10 @@ It is recommended you check setup by reading this section and making sure packag
 - **packagesettings.props** sets thresholds
 - running at solution level **./run-tests-and-report-with-env-values.ps1** (see in the file for specific arguments you may want to set)
 	- will produce a test coverage site **[your repo folder]/TELBlazor/CoverageReport/index.html**
-
+	- then look at CoverageReport in solution root and you can bookmark index.html to see your coverage
+	- E2E project has a Reports folder for tracings
+- Similarly run-tests-and-report-using-local-props.ps1 runs just using your local props file
+- appsettings.Development can be set in the E2E Host to log to the Logs folder at project route, see template
 
 
 #### Tips
@@ -186,7 +189,7 @@ It is recommended you check setup by reading this section and making sure packag
 		```
 			npm install -g @commitlint/cli @commitlint/config-angular
 		```
-	-	You can put into your pre-push, pre-commit hook, or into the gitguardian hooks some logic like the below.
+	-	You can put into your pre-push, pre-commit hook, commit-ms, or into the gitguardian hooks some logic like the below.
 	```
 			#### --- Commitlint Logic (force local config) ---
 			REPO_ROOT=$(git rev-parse --show-toplevel)
@@ -270,6 +273,7 @@ It is recommended you check setup by reading this section and making sure packag
 - if still not working delete **bin** and **obj**
 - if still not working, restart Visual Studio
 - if there are still issues its easier to problem solve by using a random very high **TELBlazor.Components** package version number and ensuring it fails and says it found the source but not the version
+
 #### Git commit names
 - git commit names can be caught locally
 - if they are not

TELBlazor.Components.ShowCase.E2ETests.WasmServerHost/TELBlazor.Components.ShowCase.E2ETests.WasmServerHost.Client/Program.cs

@@ -49,7 +49,7 @@
     .CreateLogger();
 
 // Add Serilog to logging providers
-builder.Logging.AddSerilog(Log.Logger, dispose: true);//qqqq may not need dispose for client
+builder.Logging.AddSerilog(Log.Logger);
 
 //for really bad fails
 try

TELBlazor.Components.ShowCase.E2ETests.WasmServerHost/TELBlazor.Components.ShowCase.E2ETests.WasmServerHost.Client/TELBlazor.Components.ShowCase.E2ETests.WasmServerHost.Client.csproj

@@ -35,7 +35,6 @@
 
 	<ItemGroup>
 		<ProjectReference Include="..\..\TELBlazor.Components.ShowCase.Shared\TELBlazor.Components.ShowCase.Shared.csproj" />
-		<ProjectReference Include="..\..\TELBlazor.Components\TELBlazor.Components.csproj" />
   </ItemGroup>
 
   <ItemGroup>

TELBlazor.Components.ShowCase.E2ETests.WasmServerHost/TELBlazor.Components.ShowCase.E2ETests.WasmServerHost.Client/packages.lock.json

@@ -40,15 +40,15 @@
       },
       "Microsoft.NET.ILLink.Tasks": {
         "type": "Direct",
-        "requested": "[8.0.18, )",
-        "resolved": "8.0.18",
-        "contentHash": "OiXqr2YIBEV9dsAWEtasK470ALyJ0VxJ9k4MotOxlWV6HeEgrJKYMW4HHj1OCCXvqE0/A25wEKPkpfiBARgDZA=="
+        "requested": "[8.0.19, )",
+        "resolved": "8.0.19",
+        "contentHash": "IhHf+zeZiaE5EXRyxILd4qM+Hj9cxV3sa8MpzZgeEhpvaG3a1VEGF6UCaPFLO44Kua3JkLKluE0SWVamS50PlA=="
       },
       "Microsoft.NET.Sdk.WebAssembly.Pack": {
         "type": "Direct",
-        "requested": "[8.0.18, )",
-        "resolved": "8.0.18",
-        "contentHash": "SoVkRwFwnaX39J1uaI72PTilSJ6OoonIG+2VMpazEaAA9t+aJt2Caf49q76SYv3x9iU8hu1axlMWSkR9rt8nIg=="
+        "requested": "[8.0.19, )",
+        "resolved": "8.0.19",
+        "contentHash": "Cm/sq4ET7XGU7jBSfSh+s+eV0faJ1RnErpImRYN7+d5loWISBwl22qsM6sn9StUWKJao+xGvF0IxgyPVnY20Vw=="
       },
       "Serilog": {
         "type": "Direct",
@@ -321,7 +321,7 @@
           "Markdig": "[0.41.3, )",
           "Microsoft.AspNetCore.Components.Web": "[8.0.14, )",
           "Serilog": "[4.2.0, )",
-          "TELBlazor.Components": "[1.9.3-local, )"
+          "TELBlazor.Components": "[1.2.6-local, )"
         }
       },
       "Markdig": {