Add a better error message for worker crashes

cyanfish · Aug 3, 2024 · 4bc82ef · 4bc82ef
1 parent c275304
commit 4bc82ef
Show file tree

Hide file tree

Showing 7 changed files with 92 additions and 14 deletions.
diff --git a/NAPS2.Sdk/Lang/Resources/SdkResources.Designer.cs b/NAPS2.Sdk/Lang/Resources/SdkResources.Designer.cs
diff --git a/NAPS2.Sdk/Lang/Resources/SdkResources.resx b/NAPS2.Sdk/Lang/Resources/SdkResources.resx
@@ -183,4 +183,10 @@
   <data name="OcrTimeout" xml:space="preserve">
     <value>The OCR operation timed out.</value>
   </data>
+  <data name="WorkerCrash" xml:space="preserve">
+    <value>The worker process crashed.</value>
+  </data>
+  <data name="WorkerCrashWindows" xml:space="preserve">
+    <value>The worker process crashed. Check the Windows event viewer.</value>
+  </data>
 </root>
diff --git a/NAPS2.Sdk/Platform/ISystemCompat.cs b/NAPS2.Sdk/Platform/ISystemCompat.cs
@@ -34,6 +34,8 @@ internal interface ISystemCompat
 
     bool SupportsWinX86Worker { get; }
 
+    string WorkerCrashMessage { get; }
+
     string[] ExeSearchPaths { get; }
 
     string[] LibrarySearchPaths { get; }

diff --git a/NAPS2.Sdk/Platform/LinuxSystemCompat.cs b/NAPS2.Sdk/Platform/LinuxSystemCompat.cs
@@ -40,6 +40,8 @@ internal class LinuxSystemCompat : ISystemCompat
 
     public bool SupportsWinX86Worker => false;
 
+    public string WorkerCrashMessage => SdkResources.WorkerCrash;
+
     public string[] ExeSearchPaths => LibrarySearchPaths;
 
     public string[] LibrarySearchPaths => new[]

diff --git a/NAPS2.Sdk/Platform/MacSystemCompat.cs b/NAPS2.Sdk/Platform/MacSystemCompat.cs
@@ -40,6 +40,8 @@ internal class MacSystemCompat : ISystemCompat
 
     public bool SupportsWinX86Worker => false;
 
+    public string WorkerCrashMessage => SdkResources.WorkerCrash;
+
     public string[] ExeSearchPaths => LibrarySearchPaths;
 
     public string[] LibrarySearchPaths

diff --git a/NAPS2.Sdk/Platform/WindowsSystemCompat.cs b/NAPS2.Sdk/Platform/WindowsSystemCompat.cs
@@ -37,6 +37,8 @@ internal abstract class WindowsSystemCompat : ISystemCompat
 
     public bool SupportsWinX86Worker => true;
 
+    public string WorkerCrashMessage => SdkResources.WorkerCrashWindows;
+
     public abstract string[] ExeSearchPaths { get;  }
 
     public abstract string[] LibrarySearchPaths { get;  }

diff --git a/NAPS2.Sdk/Remoting/Worker/WorkerServiceAdapter.cs b/NAPS2.Sdk/Remoting/Worker/WorkerServiceAdapter.cs
@@ -3,6 +3,7 @@
 using NAPS2.ImportExport.Email;
 using NAPS2.ImportExport.Email.Mapi;
 using NAPS2.Scan;
+using NAPS2.Scan.Exceptions;
 using NAPS2.Scan.Internal;
 using NAPS2.Scan.Internal.Twain;
 using NAPS2.Scan.Internal.Wia;
@@ -60,6 +61,10 @@ public async Task GetDevices(ScanOptions options, CancellationToken cancelToken,
         }
         catch (RpcException ex)
         {
+            if (ex.StatusCode == StatusCode.Unavailable)
+            {
+                throw new ScanDriverUnknownException(PlatformCompat.System.WorkerCrashMessage, ex);
+            }
             if (ex.Status.StatusCode != StatusCode.Cancelled)
             {
                 throw;
@@ -69,10 +74,21 @@ public async Task GetDevices(ScanOptions options, CancellationToken cancelToken,
 
     public async Task<ScanCaps> GetCaps(ScanOptions options, CancellationToken cancelToken)
     {
-        var req = new GetCapsRequest { OptionsXml = options.ToXml() };
-        var resp = await _client.GetCapsAsync(req, cancellationToken: cancelToken);
-        RemotingHelper.HandleErrors(resp.Error);
-        return resp.ScanCapsXml.FromXml<ScanCaps>();
+        try
+        {
+            var req = new GetCapsRequest { OptionsXml = options.ToXml() };
+            var resp = await _client.GetCapsAsync(req, cancellationToken: cancelToken);
+            RemotingHelper.HandleErrors(resp.Error);
+            return resp.ScanCapsXml.FromXml<ScanCaps>();
+        }
+        catch (RpcException ex)
+        {
+            if (ex.StatusCode == StatusCode.Unavailable)
+            {
+                throw new ScanDriverUnknownException(PlatformCompat.System.WorkerCrashMessage, ex);
+            }
+            throw;
+        }
     }
 
     public async Task Scan(ScanningContext scanningContext, ScanOptions options, CancellationToken cancelToken,
@@ -107,7 +123,11 @@ public async Task Scan(ScanningContext scanningContext, ScanOptions options, Can
         }
         catch (RpcException ex)
         {
-            if (ex.Status.StatusCode != StatusCode.Cancelled)
+            if (ex.StatusCode == StatusCode.Unavailable)
+            {
+                throw new ScanDriverUnknownException(PlatformCompat.System.WorkerCrashMessage, ex);
+            }
+            if (ex.StatusCode != StatusCode.Cancelled)
             {
                 throw;
             }
@@ -194,7 +214,11 @@ public async Task TwainScan(ScanOptions options, CancellationToken cancelToken,
         }
         catch (RpcException ex)
         {
-            if (ex.Status.StatusCode != StatusCode.Cancelled)
+            if (ex.StatusCode == StatusCode.Unavailable)
+            {
+                throw new ScanDriverUnknownException(PlatformCompat.System.WorkerCrashMessage, ex);
+            }
+            if (ex.StatusCode != StatusCode.Cancelled)
             {
                 throw;
             }
@@ -203,18 +227,40 @@ public async Task TwainScan(ScanOptions options, CancellationToken cancelToken,
 
     public async Task<List<ScanDevice>> TwainGetDeviceList(ScanOptions options)
     {
-        var req = new GetDeviceListRequest { OptionsXml = options.ToXml() };
-        var resp = await _client.TwainGetDeviceListAsync(req);
-        RemotingHelper.HandleErrors(resp.Error);
-        return resp.DeviceListXml.FromXml<List<ScanDevice>>();
+        try
+        {
+            var req = new GetDeviceListRequest { OptionsXml = options.ToXml() };
+            var resp = await _client.TwainGetDeviceListAsync(req);
+            RemotingHelper.HandleErrors(resp.Error);
+            return resp.DeviceListXml.FromXml<List<ScanDevice>>();
+        }
+        catch (RpcException ex)
+        {
+            if (ex.StatusCode == StatusCode.Unavailable)
+            {
+                throw new ScanDriverUnknownException(PlatformCompat.System.WorkerCrashMessage, ex);
+            }
+            throw;
+        }
     }
 
     public async Task<ScanCaps> TwainGetCaps(ScanOptions options)
     {
-        var req = new GetCapsRequest { OptionsXml = options.ToXml() };
-        var resp = await _client.TwainGetCapsAsync(req);
-        RemotingHelper.HandleErrors(resp.Error);
-        return resp.ScanCapsXml.FromXml<ScanCaps>();
+        try
+        {
+            var req = new GetCapsRequest { OptionsXml = options.ToXml() };
+            var resp = await _client.TwainGetCapsAsync(req);
+            RemotingHelper.HandleErrors(resp.Error);
+            return resp.ScanCapsXml.FromXml<ScanCaps>();
+        }
+        catch (RpcException ex)
+        {
+            if (ex.StatusCode == StatusCode.Unavailable)
+            {
+                throw new ScanDriverUnknownException(PlatformCompat.System.WorkerCrashMessage, ex);
+            }
+            throw;
+        }
     }
 
     public ProcessedImage ImportPostProcess(ScanningContext scanningContext, ProcessedImage img, int? thumbnailSize,