Refactor publish mode logic remove unused code (#947)

* Remove diagnostic file writing from AppEnvironment

Eliminate ApplicationDiagnosticPath and all file-writing logic for diagnostics. Diagnostics are now stored only in memory, and AddDiagnostics no longer supports writing to disk. Cleans up related properties and methods.

* Remove unused writable options infrastructure

Removed IWritableOptions<T> interface, its WritableOptions<T> implementation, and the AddWritableOptions<T> DI extension.

* Remove custom MSAL webview HTML and loader class

Removed MsalSystemWebViewOptions.cs and the associated auth-msalsuccess.html and auth-msalerror.html files. This eliminates the use of custom HTML pages for MSAL authentication success and error states, along with the code that loaded and provided these pages.

* Remove Debug_wwwroot config and related conditionals

Clean up project files by removing the Debug_wwwroot configuration and all associated conditional logic.

* Remove publishmode variable from build scripts

Simplified build-bravo.yaml and publish.cmd by removing the publishmode variable and related AdditionalConstants property. The publish mode is now determined solely by the --self-contained parameter, reducing redundancy and streamlining the build process.

Author: albertospelta

.azure/pipelines/build-bravo.yaml

@@ -16,12 +16,10 @@ strategy:
     bravo-x64:
       arch: 'x64'
       selfcontained: 'true'
-      publishmode: 'SELFCONTAINED'
       artifact: 'Bravo.$(AppVersionMajor).$(AppVersionMinor).$(AppVersionPatch).x64'
     bravo-x64-frameworkdependent:
       arch: 'x64'
       selfcontained: 'false'
-      publishmode: 'FRAMEWORKDEPENDENT'
       artifact: 'Bravo.$(AppVersionMajor).$(AppVersionMinor).$(AppVersionPatch).x64-frameworkdependent'
 
 pool:
@@ -75,7 +73,7 @@ steps:
   displayName: dotnet info
 - script: dotnet restore "$(csproj)" --runtime "win-$(arch)" --verbosity "${{ parameters.verbosity }}"
   displayName: dotnet restore
-- script: dotnet publish "$(csproj)" --configuration "$(configuration)" --no-restore --runtime "win-$(arch)" --self-contained "$(selfcontained)" --output "$(Build.BinariesDirectory)" --verbosity "${{ parameters.verbosity }}" /p:ContinuousIntegrationBuild="true" /p:AdditionalConstants="$(publishmode)"
+- script: dotnet publish "$(csproj)" --configuration "$(configuration)" --no-restore --runtime "win-$(arch)" --self-contained "$(selfcontained)" --output "$(Build.BinariesDirectory)" --verbosity "${{ parameters.verbosity }}" /p:ContinuousIntegrationBuild="true"
   displayName: dotnet publish
 - script: dotnet tool install --global AzureSignTool
   displayName: dotnet install AzureSignTool

Bravo.sln

@@ -9,19 +9,14 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Bravo.Tests", "test\Bravo.T
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
-		Debug_wwwroot|Any CPU = Debug_wwwroot|Any CPU
 		Debug|Any CPU = Debug|Any CPU
 		Release|Any CPU = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{3D49664E-E100-4EFF-A709-A59D03F4663E}.Debug_wwwroot|Any CPU.ActiveCfg = Debug_wwwroot|Any CPU
-		{3D49664E-E100-4EFF-A709-A59D03F4663E}.Debug_wwwroot|Any CPU.Build.0 = Debug_wwwroot|Any CPU
 		{3D49664E-E100-4EFF-A709-A59D03F4663E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{3D49664E-E100-4EFF-A709-A59D03F4663E}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{3D49664E-E100-4EFF-A709-A59D03F4663E}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{3D49664E-E100-4EFF-A709-A59D03F4663E}.Release|Any CPU.Build.0 = Release|Any CPU
-		{6EECEE30-9DD6-4CF4-8E0E-7773C2DED2CF}.Debug_wwwroot|Any CPU.ActiveCfg = Debug_wwwroot|Any CPU
-		{6EECEE30-9DD6-4CF4-8E0E-7773C2DED2CF}.Debug_wwwroot|Any CPU.Build.0 = Debug_wwwroot|Any CPU
 		{6EECEE30-9DD6-4CF4-8E0E-7773C2DED2CF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{6EECEE30-9DD6-4CF4-8E0E-7773C2DED2CF}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{6EECEE30-9DD6-4CF4-8E0E-7773C2DED2CF}.Release|Any CPU.ActiveCfg = Release|Any CPU

publish.cmd

@@ -16,7 +16,6 @@ IF %ERRORLEVEL% NEQ 0 (
 
 SET arch=x64
 SET selfcontained=true
-SET publishmode=SELFCONTAINED
 SET configuration=Release
 SET version="0.0.0.999-DEV"& :: Do not change, see also <InformationalVersion> on Bravo.csproj 
 SET verbosity="Minimal"& :: Minimal,Normal,Diagnostic,Detailed
@@ -31,7 +30,7 @@ REM  ***
 SET publishfolder=%~dp0src\bin\_publish
 CD /d "%~dp0src"
 IF EXIST %publishfolder% RMDIR /s /q %publishfolder%
-dotnet publish Bravo.csproj --configuration %configuration% --output %publishfolder% --runtime win-%arch% --self-contained %selfcontained% --verbosity %verbosity% --nologo /p:AdditionalConstants=%publishmode% || GOTO :error
+dotnet publish Bravo.csproj --configuration %configuration% --output %publishfolder% --runtime win-%arch% --self-contained %selfcontained% --verbosity %verbosity% --nologo || GOTO :error
 
 REM  ***
 ECHO *** BRAVO INSTALLER ***

src/Bravo.csproj

@@ -15,7 +15,6 @@
     <GenerateDocumentationFile>True</GenerateDocumentationFile>
     <NoWarn>$(NoWarn);1591</NoWarn>
     <TypeScriptCompileBlocked>true</TypeScriptCompileBlocked>
-    <Configurations>$(Configurations);Debug_wwwroot</Configurations>
     <AnalysisLevel>latest</AnalysisLevel>
     <IncludeOpenAPIAnalyzers>true</IncludeOpenAPIAnalyzers>
     <IsPackable>false</IsPackable>
@@ -31,18 +30,9 @@
     <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
   </PropertyGroup>
 
-  <Choose>
-    <When Condition=" '$(Configuration)' == 'Debug_wwwroot' ">
-      <PropertyGroup>
-        <DefineConstants>$(AdditionalConstants);DEBUG</DefineConstants>
-      </PropertyGroup>
-    </When>
-    <Otherwise>
-      <PropertyGroup>
-        <DefineConstants>$(AdditionalConstants)</DefineConstants>
-      </PropertyGroup>
-    </Otherwise>
-  </Choose>
+  <PropertyGroup Condition="'$(SelfContained)' == 'true'">
+    <DefineConstants>$(DefineConstants);PUBLISHMODE_SELFCONTAINED</DefineConstants>
+  </PropertyGroup>
 
   <PropertyGroup>
     <!-- Don't change version here -->
@@ -131,7 +121,7 @@
     <ClientAssetsDirectory Condition="'$(ClientAssetsDirectory)' == ''">Scripts\</ClientAssetsDirectory>
     <ClientAssetsRestoreInputs Condition="'$(ClientAssetsRestoreInputs)' == ''">$(ClientAssetsDirectory)package-lock.json;$(ClientAssetsDirectory)package.json</ClientAssetsRestoreInputs>
     <ClientAssetsRestoreOutputs Condition="'$(ClientAssetsRestoreOutputs)' == ''">$(ClientAssetsDirectory)node_modules\.package-lock.json</ClientAssetsRestoreOutputs>
-    <ClientAssetsEnabled Condition="'$(Configuration)' != 'Debug_wwwroot'">true</ClientAssetsEnabled>
+    <ClientAssetsEnabled>true</ClientAssetsEnabled>
   </PropertyGroup>
 
   <ItemGroup>

src/Infrastructure/AppEnvironment.cs

@@ -92,7 +92,6 @@ static AppEnvironment()
 
             ApplicationDataPath = Path.Combine(Environment.GetFolderPath(DeploymentMode == AppDeploymentMode.Packaged ? Environment.SpecialFolder.UserProfile : Environment.SpecialFolder.LocalApplicationData, Environment.SpecialFolderOption.DoNotVerify), ApplicationName);
             ApplicationTempPath = Path.Combine(ApplicationDataPath, ".temp");
-            ApplicationDiagnosticPath = Path.Combine(ApplicationDataPath, ".diagnostic");
             UserSettingsFilePath = Path.Combine(ApplicationDataPath, "usersettings.json");
             MsalTokenCacheFilePath = Path.Combine(ApplicationDataPath, ".msalcache");
             WebView2VersionInfo = WebView2Helper.GetRuntimeVersionInfo();
@@ -120,12 +119,10 @@ public static AppPublishMode PublishMode
         {
             get
             {
-#if SELFCONTAINED
+#if PUBLISHMODE_SELFCONTAINED
                 return AppPublishMode.SelfContained;
-#elif FRAMEWORKDEPENDENT
-                return AppPublishMode.FrameworkDependent;
 #else
-                return AppPublishMode.None;
+                return AppPublishMode.FrameworkDependent;
 #endif
             }
         }
@@ -160,8 +157,6 @@ public static RegistryKey? ApplicationInstallerRegistryHKey
 
         public static string ApplicationTempPath { get; }
 
-        public static string ApplicationDiagnosticPath { get; }
-
         public static string UserSettingsFilePath { get; }
 
         public static string MsalTokenCacheFilePath { get; }
@@ -182,16 +177,11 @@ public static void AddDiagnostics(string name, Exception exception, DiagnosticMe
             AddDiagnostics(DiagnosticMessageType.Text, name, content, severity);
         }
 
-        public static void AddDiagnostics(DiagnosticMessageType type, string name, string content, DiagnosticMessageSeverity severity = DiagnosticMessageSeverity.None, bool writeFile = false)
+        public static void AddDiagnostics(DiagnosticMessageType type, string name, string content, DiagnosticMessageSeverity severity = DiagnosticMessageSeverity.None)
         {
             var message = DiagnosticMessage.Create(type, severity, name, content);
 
             _= Diagnostics.TryAdd(message, message);
-
-            if (writeFile)
-            {
-                WriteDiagnosticFile(message);
-            }
         }
 
         private static void AddEnvironmentDiagnosticInfo()
@@ -220,44 +210,13 @@ private static void AddEnvironmentDiagnosticInfo()
                 ApplicationProductVersion,
                 ApplicationDataPath,
                 ApplicationTempPath,
-                ApplicationDiagnosticPath,
                 ApplicationUserSettingsFilePath = UserSettingsFilePath,
                 //ApplicationFileVersionInfo = VersionInfo,
             };
 
             AddDiagnostics(DiagnosticMessageType.Json, name: $"{nameof(AppEnvironment)}.EnvironmentInfo", content: JsonSerializer.Serialize(info));
         }
 
-        private static void WriteDiagnosticFile(DiagnosticMessage message)
-        {
-            if (IsDiagnosticLevelVerbose)
-            {
-                try
-                {
-                    Directory.CreateDirectory(ApplicationDiagnosticPath);
-
-                    var extension = message.Type switch
-                    {
-                        DiagnosticMessageType.Text => "txt",
-                        DiagnosticMessageType.Json => "json",
-                        _ => "bin",
-                    };
-
-                    BravoUnexpectedException.ThrowIfNull(message.Name);
-
-                    var name = Path.ChangeExtension(message.Name, extension);
-                    var safeName = name.ReplaceInvalidFileNameChars();
-                    var path = Path.Combine(ApplicationDiagnosticPath, safeName);
-
-                    File.WriteAllText(path, message.Content);
-                }
-                catch (Exception ex)
-                {
-                    ExceptionHelper.WriteToEventLog(ex, EventLogEntryType.Warning, throwOnError: false);
-                }
-            }
-        }
-
         private static AppDeploymentMode GetDeploymentMode()
         {
             if (DesktopBridgeHelper.IsRunningAsMsixPackage())
@@ -308,8 +267,18 @@ public enum AppDeploymentMode
 
     public enum AppPublishMode
     {
-        None = 0,
+        /// <summary>
+        /// Published as a framework-dependent application that relies on a shared system-wide
+        /// version of the .NET runtime. The application will not include the .NET runtime and
+        /// will require it to be installed on the host machine to run.
+        /// </summary>
+        FrameworkDependent = 0,
+
+        /// <summary>
+        /// Published as a self-contained application that includes a private copy of the .NET runtime.
+        /// The application will not rely on a shared system-wide version of the .NET runtime and
+        /// can run on a host machine even if the .NET runtime is not installed.
+        /// </summary>
         SelfContained = 1,
-        FrameworkDependent = 2,
     }
 }

src/Infrastructure/AppWindow.cs

@@ -113,15 +113,15 @@ private async void InitializeWebViewAsync()
             /* ICoreWebView2Settings4   */ WebView2Helper.TryAndIgnoreUnsupportedError(() => WebView.CoreWebView2.Settings.IsGeneralAutofillEnabled = false);
             /* ICoreWebView2Settings5   */ WebView2Helper.TryAndIgnoreUnsupportedError(() => WebView.CoreWebView2.Settings.IsPinchZoomEnabled = false);
             /* ICoreWebView2Settings6   */ WebView2Helper.TryAndIgnoreUnsupportedError(() => WebView.CoreWebView2.Settings.IsSwipeNavigationEnabled = false);
-#if DEBUG_WWWROOT
-            WebView.CoreWebView2.OpenDevToolsWindow();
+
+            //WebView.CoreWebView2.OpenDevToolsWindow();
             //WebView.CoreWebView2.OpenTaskManagerWindow();
             //WebView.CoreWebView2.NavigationStarting += OnWebViewNavigationStarting;
             //WebView.CoreWebView2.NavigationCompleted += OnWebViewNavigationCompleted;
             //WebView.CoreWebView2.ContentLoading += OnWebViewContentLoading;
             //WebView.CoreWebView2.WebMessageReceived += OnWebViewWebWebMessageReceived;
             //WebView.CoreWebView2.WebResourceResponseReceived += OnWebViewWebResourceResponseReceived;
-#endif
+
             /* ICoreWebView2_2  */ WebView.CoreWebView2.DOMContentLoaded += OnWebViewDOMContentLoaded;
             /* ICoreWebView2    */ WebView.CoreWebView2.WebResourceRequested += OnWebViewWebResourceRequested;
             /* ICoreWebView2    */ WebView.CoreWebView2.PermissionRequested += OnWebViewPermissionRequested;

src/Infrastructure/Authentication/MsalSystemWebViewOptions.cs

@@ -34,9 +34,7 @@ private static void ConfigureProxy()
 
         private static void ConfigureDirectories()
         {
-#if !DEBUG_WWWROOT
-            Directory.SetCurrentDirectory(System.AppContext.BaseDirectory);
-#endif
+            Directory.SetCurrentDirectory(AppContext.BaseDirectory);
             Directory.CreateDirectory(AppEnvironment.ApplicationDataPath);
             Directory.CreateDirectory(AppEnvironment.ApplicationTempPath);
         }