Add flag to not publish the observatory port over mDNS

Author: jmagman

common/settings.cc

@@ -46,6 +46,8 @@ std::string Settings::ToString() const {
   stream << "enable_dart_profiling: " << enable_dart_profiling << std::endl;
   stream << "disable_dart_asserts: " << disable_dart_asserts << std::endl;
   stream << "enable_observatory: " << enable_observatory << std::endl;
+  stream << "enable_observatory_publication: " << enable_observatory_publication
+         << std::endl;
   stream << "observatory_host: " << observatory_host << std::endl;
   stream << "observatory_port: " << observatory_port << std::endl;
   stream << "use_test_fonts: " << use_test_fonts << std::endl;

common/settings.h

@@ -126,6 +126,11 @@ struct Settings {
   // Whether the Dart VM service should be enabled.
   bool enable_observatory = false;
 
+  // Whether to publish the observatory URL over mDNS.
+  // On iOS 14 this prompts a local network permission dialog,
+  // which cannot be accepted or dismissed in a CI environment.
+  bool enable_observatory_publication = false;
+
   // The IP address to which the Dart VM service is bound.
   std::string observatory_host;
 

shell/common/switches.cc

@@ -221,6 +221,10 @@ Settings SettingsFromCommandLine(const fml::CommandLine& command_line) {
   settings.enable_observatory =
       !command_line.HasOption(FlagForSwitch(Switch::DisableObservatory));
 
+  // Enable mDNS Observatory Publication
+  settings.enable_observatory_publication = !command_line.HasOption(
+      FlagForSwitch(Switch::DisableObservatoryPublication));
+
   // Set Observatory Host
   if (command_line.HasOption(FlagForSwitch(Switch::DeviceObservatoryHost))) {
     command_line.GetOptionValue(FlagForSwitch(Switch::DeviceObservatoryHost),

shell/common/switches.h

@@ -79,6 +79,9 @@ DEF_SWITCH(DisableObservatory,
            "disable-observatory",
            "Disable the Dart Observatory. The observatory is never available "
            "in release mode.")
+DEF_SWITCH(DisableObservatoryPublication,
+           "disable-observatory-publication",
+           "Disable mDNS Dart Observatory publication.")
 DEF_SWITCH(IPv6,
            "ipv6",
            "Bind to the IPv6 localhost address for the Dart Observatory. "

shell/platform/darwin/ios/framework/Source/FlutterObservatoryPublisher.mm

@@ -43,6 +43,8 @@ @implementation FlutterObservatoryPublisher
 #include "flutter/fml/platform/darwin/scoped_nsobject.h"
 #include "flutter/fml/task_runner.h"
 #include "flutter/runtime/dart_service_isolate.h"
+#include "flutter/shell/common/switches.h"
+#include "flutter/shell/platform/darwin/common/command_line.h"
 
 @protocol FlutterObservatoryPublisherDelegate
 - (instancetype)initWithOwner:(FlutterObservatoryPublisher*)owner;
@@ -219,27 +221,32 @@ - (instancetype)init {
   self = [super init];
   NSAssert(self, @"Super must not return null on init.");
 
-  if (@available(iOS 9.3, *)) {
-    _delegate.reset([[ObservatoryDNSServiceDelegate alloc] initWithOwner:self]);
+  auto command_line = flutter::CommandLineFromNSProcessInfo();
+  auto settings = flutter::SettingsFromCommandLine(command_line);
+  if (settings.enable_observatory_publication) {
+    if (@available(iOS 9.3, *)) {
+      _delegate.reset([[ObservatoryDNSServiceDelegate alloc] initWithOwner:self]);
+    } else {
+      _delegate.reset([[ObservatoryNSNetServiceDelegate alloc] initWithOwner:self]);
+    }
+    _weakFactory = std::make_unique<fml::WeakPtrFactory<FlutterObservatoryPublisher>>(self);
+
+    fml::MessageLoop::EnsureInitializedForCurrentThread();
+    _callbackHandle = flutter::DartServiceIsolate::AddServerStatusCallback(
+        [weak = _weakFactory->GetWeakPtr(),
+         runner = fml::MessageLoop::GetCurrent().GetTaskRunner()](const std::string& uri) {
+          if (!uri.empty()) {
+            runner->PostTask([weak, uri]() {
+              if (weak) {
+                [[weak.get() delegate]
+                    publishServiceProtocolPort:[NSString stringWithUTF8String:uri.c_str()]];
+              }
+            });
+          }
+        });
   } else {
-    _delegate.reset([[ObservatoryNSNetServiceDelegate alloc] initWithOwner:self]);
+    FML_LOG(INFO) << "Skipping mDNS obsesrvatory publishing";
   }
-  _weakFactory = std::make_unique<fml::WeakPtrFactory<FlutterObservatoryPublisher>>(self);
-
-  fml::MessageLoop::EnsureInitializedForCurrentThread();
-
-  _callbackHandle = flutter::DartServiceIsolate::AddServerStatusCallback(
-      [weak = _weakFactory->GetWeakPtr(),
-       runner = fml::MessageLoop::GetCurrent().GetTaskRunner()](const std::string& uri) {
-        if (!uri.empty()) {
-          runner->PostTask([weak, uri]() {
-            if (weak) {
-              [[weak.get() delegate]
-                  publishServiceProtocolPort:[NSString stringWithUTF8String:uri.c_str()]];
-            }
-          });
-        }
-      });
 
   return self;
 }
@@ -262,7 +269,9 @@ - (NSData*)createTxtData:(NSURL*)url {
 - (void)dealloc {
   [_delegate stopService];
 
-  flutter::DartServiceIsolate::RemoveServerStatusCallback(std::move(_callbackHandle));
+  if (_callbackHandle) {
+    flutter::DartServiceIsolate::RemoveServerStatusCallback(std::move(_callbackHandle));
+  }
   [super dealloc];
 }
 @end