Merge branch 'develop'

Author: Peter-Simpson

ASCOM.Utilities/ASCOM.Utilities/Log.cs

@@ -220,7 +220,7 @@ private Timer ASCOMTimer
 
         #endregion
 
-        #region Initialisation, Form load and overall process
+        #region Initialisation and form load
 
         /// <summary>
         /// Diagnostics form initiator
@@ -290,11 +290,16 @@ private void DiagnosticsForm_Load(object sender, EventArgs e)
             }
         }
 
+        #endregion
+
+        #region Main Diagnostics test process
+
         private void RunDiagnostics(object sender, EventArgs e)
         {
             string ASCOMPath;
             string ApplicationPath = "Path Not Set!";
             string SuccessMessage;
+            DateTime startTime = DateTime.Now;
 
             try
             {
@@ -445,8 +450,9 @@ private void RunDiagnostics(object sender, EventArgs e)
                 // Log the enabled / disabled state of the traceLogger mutex mechanic
                 try
                 {
-                    TL.LogMessage("Environment", $"TraceLogger is {(Utilities.Global.GetBool(USE_TRACELOGGER_MUTEX, USE_TRACELOGGER_MUTEX_DEFAULT) ? "" : "not ")}using the Mutex mechanic");
+                    TL.LogMessage("Environment", $"TraceLogger is using the {(Utilities.Global.GetBool(USE_TRACELOGGER_MUTEX, USE_TRACELOGGER_MUTEX_DEFAULT) ? "Mutex" : "lock()")} mechanic");
                     TL.LogMessage("Environment", $"TraceLogger debug is {(Utilities.Global.GetBool(TRACELOGGER_DEBUG, TRACELOGGER_DEBUG_DEFAULT) ? "enabled" : "disabled")}.");
+                    TL.LogMessage("Environment", $".NET component use logging is {(Utilities.Global.GetBool(DOTNET35_COMPONENT_USE_LOGGING, DOTNET35_COMPONENT_USE_LOGGING_DEFAULT) ? "enabled" : "disabled")}.");
                     TL.LogMessage("", "");
                 }
                 catch (Exception ex)
@@ -455,6 +461,8 @@ private void RunDiagnostics(object sender, EventArgs e)
                 }
 
                 LastLogFile = TL.LogFileName;
+
+                // Run diagnostic tests
                 try
                 {
                     try
@@ -917,6 +925,8 @@ private void RunDiagnostics(object sender, EventArgs e)
                     }
                     transform = null;
 
+                    TL.BlankLine();
+                    TL.LogMessage("Diagnostics", $"Time for diagnostics run: {DateTime.Now.Subtract(startTime):mm\\:ss\\.fff}");
                     TL.BlankLine();
                     TL.LogMessage("Diagnostics", SuccessMessage);
                     TL.Enabled = false;

ASCOM.Utilities/ASCOM.Utilities/TraceLogger.cs

@@ -1,11 +1,11 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Topics>
-  <Topic id="7d9253c2-fdfd-4c0d-8225-a96bddb49731" visible="True" isDefault="true" title="ASCOM Platform 7.1 Update 2" tocTitle="Introduction" />
+  <Topic id="7d9253c2-fdfd-4c0d-8225-a96bddb49731" visible="True" isDefault="true" isSelected="true" title="ASCOM Platform 7.1 Update 3" tocTitle="Introduction" />
   <Topic id="6cdc126a-3b1a-4a55-836f-aaf704740a33" visible="True" title="Introduction - ASCOM Platform 7  For Developers" tocTitle="Introduction - Developers" />
   <Topic id="174fff87-9bd7-442e-98e1-9fe2ac09bac6" visible="True" />
   <Topic id="3d17234a-c873-4f65-af0f-52f182081a44" visible="True" title="ASCOM Platform for .NET Developers" />
   <Topic id="bfd53b69-9f13-489b-9a98-50c60d2a633b" visible="True" isExpanded="true" title="Version History">
-    <Topic id="Version_7.1.3" visible="True" isSelected="true" />
+    <Topic id="Version_7.1.3" visible="True" />
     <Topic id="Version_7.1.2" visible="True" />
     <Topic id="1d9c9d1e-1980-45a6-b7f9-4f4bcb752b80" visible="True" title="Version 7.1 Update 1" />
     <Topic id="1cff238c-4522-4730-ae94-a82f9666654e" visible="True" title="Version 7.1" />

Diagnostics/ASCOM Diagnostics/DiagnosticsForm.cs

@@ -16,7 +16,6 @@ here <link xlink:href="7d9253c2-fdfd-4c0d-8225-a96bddb49731#PreReqs70">Platform
 * Alpaca Dynamic Driver log files are now named ASCOM.DynamicDriver... rather than ASCOM.AlpacaSim...
 * Update checker messages now refer to 'Updates' rather than 'Service Packs'.
 
-
 ## Issues Fixed in 7.1 Update 2 - For Everyone
 * Fixed an issue, introduced in Platform 7.1, that caused drivers that use ASCOM COM objects to fail in some environments, including Windows ARM 64bit.
 The issue also caused the 64bit Platform installer validation test to report a -1073741819 error.

Help/ASCOMDeveloper.content

@@ -11,8 +11,31 @@ In line with previous Platform installers, Platform 7.1 Update 3 is a cumulative
 Platform releases and service packs. The Platform environment pre-requisites are listed 
 here <link xlink:href="7d9253c2-fdfd-4c0d-8225-a96bddb49731#PreReqs70">Platform Prerequisites</link>.
 
+## Changes in 7.1 Update 3 - For Everyone
+* Logging is now more reliable and slightly faster.
+* A new option has been added to the Diagnostics application (`Use TraceLogger mutex synchronisation`) so you can revert to previous 
+logging behaviour if necessary.
+
 ## Issues Fixed in 7.1 Update 3 - For Everyone
-* Fixed - TraceLogger occasionally threw `ProfilePersistenceException - Timed out waiting for TraceLogger mutex` exceptions.
+* Fixed - Widely reported issues where TraceLogger returned `ProfilePersistenceException - Timed out waiting for TraceLogger mutex` exceptions
+causing many clients and drivers to fail. This issue first appeared in Platform 7.1 Update 2.
+
+## Changes in 7.1 Update 3 - For Developers
+* The default locking mechanic in TraceLogger has been changed to use an instance local lock() instead of a global mutex.
+  * Since its introduction in 2009, TraceLogger has used a global Windows mutex to synchronise writing to log files. 
+The impact was that only one log message could be written at a time across all instances of TraceLogger and all applications.
+  * The default locking mechanic has been changed to an instance local lock() because this is sufficient to protect the file being written and allows concurrent writing of log files.
+  * It is strongly recommended that the new default lock() synchronisation is used as it is faster and does not cause application issues due to mutex timeouts.
+* A new TraceLogger property <codeEntityReference linkText="TraceLogger.UseMutexSynchronisation">P:ASCOM.Utilities.TraceLogger.UseMutexSynchronisation</codeEntityReference>
+has been added so the original global mutex synchronisation can be re-enabled if required for use cases where logging synchronisation between processes is required.
+* A new option has been added to the Diagnostics application that enables end-users to revert all ASCOM TraceLogger activity to the original 
+global mutex synchronisation without requiring code changes.
+
+## Issues Fixed in 7.1 Update 3 - For Developers
+* None
+
+## Breaking Changes (For Developers) in Platform 7.1 Update 3
+* None are expected, but developers should be aware of the change to the default locking mechanic in TraceLogger described above.
 
-## Changes in 7.1 Update 2
+## Changes in the previous update
 See this link for changes and fixes in <link xlink:href="Version_7.1.2">Platform 7.1 Update 2</link>.

Help/Version History/Version 7.1 Update 2.md

@@ -1,7 +1,7 @@
 7
 1
 3
-Release
+3
 
 The first line of this file must contain the major Platform version number
 The second line of this file must contain the minor Platform version number

Help/Version History/Version 7.1 Update 3.md

@@ -46,6 +46,7 @@
     <Compile Include="ComDeviceStateTests.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="SwitchAsync.cs" />
+    <Compile Include="TraceLoggerTests.cs" />
     <Compile Include="Utilities.Util EdgeCaseTests.cs" />
   </ItemGroup>
   <ItemGroup>

Installer/MasterPlatformVersion.txt

@@ -0,0 +1,53 @@
+using ASCOM.Utilities;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace PlatformUnitTests
+{
+    public class TraceLoggerTests
+    {
+        private readonly ITestOutputHelper output;
+
+        public TraceLoggerTests(ITestOutputHelper output)
+        {
+            this.output = output;
+        }
+
+        [Fact]
+        public void UseMutexSynchronisationDefault()
+        {
+            TraceLogger TL = new TraceLogger();
+            Assert.False(TraceLogger.UseMutexSynchronisation);
+            output.WriteLine($"UseMutexSynchronisation: {TraceLogger.UseMutexSynchronisation}");
+        }
+
+        [Fact]
+        public void UseMutexSynchronisationFalse()
+        {
+            TraceLogger TL = new TraceLogger("","UseMutexSynchronisationFalse");
+            TL.Enabled= true; 
+            TraceLogger.UseMutexSynchronisation = false;
+
+            TL.LogMessage("", $"UseMutexSynchronisation is {TraceLogger.UseMutexSynchronisation}");
+            Assert.False(TraceLogger.UseMutexSynchronisation);
+            TL.Dispose();
+        }
+
+        [Fact]
+        public void UseMutexSynchronisationTrue()
+        {
+            TraceLogger TL = new TraceLogger("", "UseMutexSynchronisationTrue");
+            TL.Enabled = true;
+            TraceLogger.UseMutexSynchronisation = true;
+
+            TL.LogMessage("", $"UseMutexSynchronisation is {TraceLogger.UseMutexSynchronisation}");
+            Assert.True(TraceLogger.UseMutexSynchronisation);
+            TL.Dispose();
+        }
+    }
+}