From b8cc5a8e869ba7b49397cacb3716f72501b53d22 Mon Sep 17 00:00:00 2001
From: Ben Olden-Cooligan <ben.cyanfish@gmail.com>
Date: Mon, 11 Dec 2023 22:20:03 -0800
Subject: [PATCH] Escl: Continuous mDNS querying and duplicate prevention

---
 NAPS2.Escl/Client/EsclServiceLocator.cs | 46 +++++++++++++++----------
 1 file changed, 28 insertions(+), 18 deletions(-)

diff --git a/NAPS2.Escl/Client/EsclServiceLocator.cs b/NAPS2.Escl/Client/EsclServiceLocator.cs
index 7f70fb3ed0..bb26ee59f9 100644
--- a/NAPS2.Escl/Client/EsclServiceLocator.cs
+++ b/NAPS2.Escl/Client/EsclServiceLocator.cs
@@ -8,7 +8,9 @@ namespace NAPS2.Escl.Client;
 public class EsclServiceLocator : IDisposable
 {
     private readonly ServiceDiscovery _discovery;
+    private readonly HashSet<ServiceKey> _locatedServices = new();
     private bool _started;
+    private int _nextQueryInterval = 1000;
 
     public EsclServiceLocator(Action<EsclService> serviceCallback)
     {
@@ -18,6 +20,12 @@ public EsclServiceLocator(Action<EsclService> serviceCallback)
             try
             {
                 var service = ParseService(args);
+                var serviceKey = new ServiceKey(service.ScannerName, service.Uuid, service.Port, service.IpV4, service.IpV6);
+                if (!_locatedServices.Add(serviceKey))
+                {
+                    // Don't callback for duplicates
+                    return;
+                }
                 Logger.LogDebug("Discovered ESCL Service: {Name}, instance {Instance}, endpoint {Endpoint}, ipv4 {Ipv4}, ipv6 {IpV6}, host {Host}, port {Port}, uuid {Uuid}",
                     service.ScannerName, args.ServiceInstanceName, args.RemoteEndPoint, service.IpV4, service.IpV6, service.Host, service.Port, service.Uuid);
                 serviceCallback(service);
@@ -36,33 +44,33 @@ public void Start()
         if (_started) throw new InvalidOperationException("Already started");
         _started = true;
 
+        Query();
+    }
+
+    private void Query()
+    {
+        if (_discovery.Mdns == null)
+        {
+            return;
+        }
+        // TODO: De-duplicate http/https services?
+        _discovery.QueryServiceInstances("_uscan._tcp");
+        _discovery.QueryServiceInstances("_uscans._tcp");
 
-        // We query once when we start, then once again after 1s to account for race conditions where there was a
+        // We query once when we start, then again after 1s, 2s, etc. to account for race conditions where there was a
         // previous query/answer on the network just before we started listening, which would prevent us from receiving
         // a response. See the following:
         //
         // "When retransmitting Multicast DNS queries to implement continuous monitoring, the interval between the first
-        // two queries MUST be at least one second."
+        // two queries MUST be at least one second, and the intervals between successive queries MUST increase by at
+        // least a factor of two."
         // https://datatracker.ietf.org/doc/html/rfc6762#section-5.2
         //
         // "A Multicast DNS responder MUST NOT multicast a record on a given interface until at least one second has
         // elapsed since the last time that record was multicast on that particular interface."
         // https://datatracker.ietf.org/doc/html/rfc6762#section-6
-        Query();
-        Task.Delay(1000).ContinueWith(_ =>
-        {
-            if (_discovery.Mdns != null)
-            {
-                Query();
-            }
-        });
-    }
-
-    private void Query()
-    {
-        // TODO: De-duplicate http/https services?
-        _discovery.QueryServiceInstances("_uscan._tcp");
-        _discovery.QueryServiceInstances("_uscans._tcp");
+        Task.Delay(_nextQueryInterval).ContinueWith(_ => Query());
+        _nextQueryInterval *= 2;
     }
 
     private EsclService ParseService(ServiceInstanceDiscoveryEventArgs args)
@@ -140,4 +148,6 @@ public void Dispose()
     {
         _discovery.Dispose();
     }
-}
\ No newline at end of file
+
+    private record ServiceKey(string? ScannerName, string? Uuid, int Port, IPAddress? IpV4, IPAddress? IpV6);
+}