Prioritize DNS-SD results from the network on tvOS. (project-chip#32513)

* Prioritize DNS-SD results from the network on tvOS.

Since we can only deliver results from one interface given the current state of
Matter SDK APIs (see
project-chip#32512), prioritize the
interfaces that are more likely to have up-to-date results, not stale caches.

* Address review comments, fix CI to use right SDK name.

Author: bzbarsky-apple

.github/workflows/darwin.yaml

@@ -54,6 +54,11 @@ jobs:
               # Disable availability annotations, since we are not building a system
               # Matter.framework.
               run: xcodebuild -target "Matter" -sdk watchos -configuration Debug GCC_PREPROCESSOR_DEFINITIONS='${inherited} MTR_NO_AVAILABILITY=1'
+            - name: Run tvOS Build Debug
+              working-directory: src/darwin/Framework
+              # Disable availability annotations, since we are not building a system
+              # Matter.framework.
+              run: xcodebuild -target "Matter" -sdk appletvos -configuration Debug GCC_PREPROCESSOR_DEFINITIONS='${inherited} MTR_NO_AVAILABILITY=1'
             - name: Run iOS Build Debug
               working-directory: src/darwin/Framework
               # Disable availability annotations, since we are not building a system

src/platform/Darwin/DnssdContexts.cpp

@@ -21,6 +21,8 @@
 #include <lib/support/CHIPMemString.h>
 #include <platform/CHIPDeviceLayer.h>
 
+#include <net/if.h>
+
 using namespace chip::Dnssd;
 using namespace chip::Dnssd::Internal;
 
@@ -516,32 +518,40 @@ void ResolveContext::DispatchSuccess()
     // ChipDnssdResolveNoLongerNeeded don't find us and try to also remove us.
     bool needDelete = MdnsContexts::GetInstance().RemoveWithoutDeleting(this);
 
-    for (auto & interface : interfaces)
-    {
-        auto & ips = interface.second.addresses;
+#if TARGET_OS_TV
+    // On tvOS, prioritize results from en0, en1, ir0 in that order, if those
+    // interfaces are present, since those will generally have more up-to-date
+    // information.
+    static const unsigned int priorityInterfaceIndices[] = {
+        if_nametoindex("en0"),
+        if_nametoindex("en1"),
+        if_nametoindex("ir0"),
+    };
+#else
+    // Elsewhere prioritize "lo0" over other interfaces.
+    static const unsigned int priorityInterfaceIndices[] = {
+        if_nametoindex("lo0"),
+    };
+#endif // TARGET_OS_TV
 
-        // Some interface may not have any ips, just ignore them.
-        if (ips.size() == 0)
+    for (auto interfaceIndex : priorityInterfaceIndices)
+    {
+        if (TryReportingResultsForInterfaceIndex(static_cast<uint32_t>(interfaceIndex)))
         {
-            continue;
+            if (needDelete)
+            {
+                MdnsContexts::GetInstance().Delete(this);
+            }
+            return;
         }
+    }
 
-        ChipLogProgress(Discovery, "Mdns: Resolve success on interface %" PRIu32, interface.first);
-
-        auto & service = interface.second.service;
-        auto addresses = Span<Inet::IPAddress>(ips.data(), ips.size());
-        if (nullptr == callback)
-        {
-            auto delegate = static_cast<CommissioningResolveDelegate *>(context);
-            DiscoveredNodeData nodeData;
-            service.ToDiscoveredNodeData(addresses, nodeData);
-            delegate->OnNodeDiscovered(nodeData);
-        }
-        else
+    for (auto & interface : interfaces)
+    {
+        if (TryReportingResultsForInterfaceIndex(interface.first))
         {
-            callback(context, &service, addresses, CHIP_NO_ERROR);
+            break;
         }
-        break;
     }
 
     if (needDelete)
@@ -550,6 +560,42 @@ void ResolveContext::DispatchSuccess()
     }
 }
 
+bool ResolveContext::TryReportingResultsForInterfaceIndex(uint32_t interfaceIndex)
+{
+    if (interfaceIndex == 0)
+    {
+        // Not actually an interface we have.
+        return false;
+    }
+
+    auto & interface = interfaces[interfaceIndex];
+    auto & ips       = interface.addresses;
+
+    // Some interface may not have any ips, just ignore them.
+    if (ips.size() == 0)
+    {
+        return false;
+    }
+
+    ChipLogProgress(Discovery, "Mdns: Resolve success on interface %" PRIu32, interfaceIndex);
+
+    auto & service = interface.service;
+    auto addresses = Span<Inet::IPAddress>(ips.data(), ips.size());
+    if (nullptr == callback)
+    {
+        auto delegate = static_cast<CommissioningResolveDelegate *>(context);
+        DiscoveredNodeData nodeData;
+        service.ToDiscoveredNodeData(addresses, nodeData);
+        delegate->OnNodeDiscovered(nodeData);
+    }
+    else
+    {
+        callback(context, &service, addresses, CHIP_NO_ERROR);
+    }
+
+    return true;
+}
+
 CHIP_ERROR ResolveContext::OnNewAddress(uint32_t interfaceId, const struct sockaddr * address)
 {
     // If we don't have any information about this interfaceId, just ignore the

src/platform/Darwin/DnssdImpl.h

@@ -251,6 +251,14 @@ struct ResolveContext : public GenericContext
                         const unsigned char * txtRecord);
     bool HasInterface();
     bool Matches(const char * otherInstanceName) const { return instanceName == otherInstanceName; }
+
+private:
+    /**
+     * Try reporting the results we got on the provided interface index.
+     * Returns true if information was reported, false if not (e.g. if there
+     * were no IP addresses, etc).
+     */
+    bool TryReportingResultsForInterfaceIndex(uint32_t interfaceIndex);
 };
 
 } // namespace Dnssd