Adding vmservice to get iOS app settings (#123156)

fixes flutter/flutter#120405

Author: chunhtai

packages/flutter_tools/lib/src/commands/build_ios.dart

@@ -376,11 +376,11 @@ class BuildIOSArchiveCommand extends _BuildIOSSubCommand {
 
     final Map<String, String?> xcodeProjectSettingsMap = <String, String?>{};
 
-    xcodeProjectSettingsMap['Version Number'] = globals.plistParser.getStringValueFromFile(plistPath, PlistParser.kCFBundleShortVersionStringKey);
-    xcodeProjectSettingsMap['Build Number'] = globals.plistParser.getStringValueFromFile(plistPath, PlistParser.kCFBundleVersionKey);
-    xcodeProjectSettingsMap['Display Name'] = globals.plistParser.getStringValueFromFile(plistPath, PlistParser.kCFBundleDisplayNameKey);
-    xcodeProjectSettingsMap['Deployment Target'] = globals.plistParser.getStringValueFromFile(plistPath, PlistParser.kMinimumOSVersionKey);
-    xcodeProjectSettingsMap['Bundle Identifier'] = globals.plistParser.getStringValueFromFile(plistPath, PlistParser.kCFBundleIdentifierKey);
+    xcodeProjectSettingsMap['Version Number'] = globals.plistParser.getValueFromFile<String>(plistPath, PlistParser.kCFBundleShortVersionStringKey);
+    xcodeProjectSettingsMap['Build Number'] = globals.plistParser.getValueFromFile<String>(plistPath, PlistParser.kCFBundleVersionKey);
+    xcodeProjectSettingsMap['Display Name'] = globals.plistParser.getValueFromFile<String>(plistPath, PlistParser.kCFBundleDisplayNameKey);
+    xcodeProjectSettingsMap['Deployment Target'] = globals.plistParser.getValueFromFile<String>(plistPath, PlistParser.kMinimumOSVersionKey);
+    xcodeProjectSettingsMap['Bundle Identifier'] = globals.plistParser.getValueFromFile<String>(plistPath, PlistParser.kCFBundleIdentifierKey);
 
     final List<ValidationMessage> validationMessages = xcodeProjectSettingsMap.entries.map((MapEntry<String, String?> entry) {
       final String title = entry.key;

packages/flutter_tools/lib/src/intellij/intellij_validator.dart

@@ -494,7 +494,7 @@ class IntelliJValidatorOnMac extends IntelliJValidator {
 
   @override
   String get version {
-    return _version ??= _plistParser.getStringValueFromFile(
+    return _version ??= _plistParser.getValueFromFile<String>(
         plistFile,
         PlistParser.kCFBundleShortVersionStringKey,
       ) ?? 'unknown';
@@ -508,7 +508,7 @@ class IntelliJValidatorOnMac extends IntelliJValidator {
     }
 
     final String? altLocation = _plistParser
-      .getStringValueFromFile(plistFile, 'JetBrainsToolboxApp');
+      .getValueFromFile<String>(plistFile, 'JetBrainsToolboxApp');
 
     if (altLocation != null) {
       _pluginsPath = '$altLocation.plugins';

packages/flutter_tools/lib/src/ios/application_package.dart

@@ -58,7 +58,7 @@ abstract class IOSApp extends ApplicationPackage {
       globals.printError('Invalid prebuilt iOS app. Does not contain Info.plist.');
       return null;
     }
-    final String? id = globals.plistParser.getStringValueFromFile(
+    final String? id = globals.plistParser.getValueFromFile<String>(
       plistPath,
       PlistParser.kCFBundleIdentifierKey,
     );

packages/flutter_tools/lib/src/ios/devices.dart

@@ -451,7 +451,7 @@ class IOSDevice extends Device {
         _logger.printError('');
         return LaunchResult.failed();
       }
-      packageId = buildResult.xcodeBuildExecution?.buildSettings['PRODUCT_BUNDLE_IDENTIFIER'];
+      packageId = buildResult.xcodeBuildExecution?.buildSettings[IosProject.kProductBundleIdKey];
     }
 
     packageId ??= package.id;

packages/flutter_tools/lib/src/ios/plist_parser.dart

@@ -24,6 +24,7 @@ class PlistParser {
   final Logger _logger;
   final ProcessUtils _processUtils;
 
+  // info.pList keys
   static const String kCFBundleIdentifierKey = 'CFBundleIdentifier';
   static const String kCFBundleShortVersionStringKey = 'CFBundleShortVersionString';
   static const String kCFBundleExecutableKey = 'CFBundleExecutable';
@@ -32,6 +33,9 @@ class PlistParser {
   static const String kMinimumOSVersionKey = 'MinimumOSVersion';
   static const String kNSPrincipalClassKey = 'NSPrincipalClass';
 
+  // entitlement file keys
+  static const String kAssociatedDomainsKey = 'com.apple.developer.associated-domains';
+
   static const String _plutilExecutable = '/usr/bin/plutil';
 
   /// Returns the content, converted to XML, of the plist file located at
@@ -164,17 +168,17 @@ class PlistParser {
     return null;
   }
 
-  /// Parses the Plist file located at [plistFilePath] and returns the string
-  /// value that's associated with the specified [key] within the property list.
+  /// Parses the Plist file located at [plistFilePath] and returns the value
+  /// that's associated with the specified [key] within the property list.
   ///
   /// If [plistFilePath] points to a non-existent file or a file that's not a
   /// valid property list file, this will return null.
   ///
   /// If [key] is not found in the property list, this will return null.
   ///
   /// The [plistFilePath] and [key] arguments must not be null.
-  String? getStringValueFromFile(String plistFilePath, String key) {
+  T? getValueFromFile<T>(String plistFilePath, String key) {
     final Map<String, dynamic> parsed = parseFile(plistFilePath);
-    return parsed[key] as String?;
+    return parsed[key] as T?;
   }
 }

packages/flutter_tools/lib/src/ios/simulators.dart

@@ -468,7 +468,7 @@ class IOSSimulator extends Device {
       // parsing the xcodeproj or configuration files.
       // See https://github.com/flutter/flutter/issues/31037 for more information.
       final String plistPath = globals.fs.path.join(package.simulatorBundlePath, 'Info.plist');
-      final String? bundleIdentifier = globals.plistParser.getStringValueFromFile(plistPath, PlistParser.kCFBundleIdentifierKey);
+      final String? bundleIdentifier = globals.plistParser.getValueFromFile<String>(plistPath, PlistParser.kCFBundleIdentifierKey);
       if (bundleIdentifier == null) {
         globals.printError('Invalid prebuilt iOS app. Info.plist does not contain bundle identifier');
         return LaunchResult.failed();

packages/flutter_tools/lib/src/ios/xcodeproj.dart

@@ -185,6 +185,7 @@ class XcodeProjectInterpreter {
     final Status status = _logger.startSpinner();
     final String? scheme = buildContext.scheme;
     final String? configuration = buildContext.configuration;
+    final String? target = buildContext.target;
     final String? deviceId = buildContext.deviceId;
     final List<String> showBuildSettingsCommand = <String>[
       ...xcrunCommand(),
@@ -195,6 +196,8 @@ class XcodeProjectInterpreter {
         ...<String>['-scheme', scheme],
       if (configuration != null)
         ...<String>['-configuration', configuration],
+      if (target != null)
+        ...<String>['-target', target],
       if (buildContext.environmentType == EnvironmentType.simulator)
         ...<String>['-sdk', 'iphonesimulator'],
       '-destination',
@@ -380,17 +383,19 @@ class XcodeProjectBuildContext {
     this.configuration,
     this.environmentType = EnvironmentType.physical,
     this.deviceId,
+    this.target,
     this.isWatch = false,
   });
 
   final String? scheme;
   final String? configuration;
   final EnvironmentType environmentType;
   final String? deviceId;
+  final String? target;
   final bool isWatch;
 
   @override
-  int get hashCode => Object.hash(scheme, configuration, environmentType, deviceId);
+  int get hashCode => Object.hash(scheme, configuration, environmentType, deviceId, target);
 
   @override
   bool operator ==(Object other) {
@@ -402,10 +407,26 @@ class XcodeProjectBuildContext {
         other.configuration == configuration &&
         other.deviceId == deviceId &&
         other.environmentType == environmentType &&
-        other.isWatch == isWatch;
+        other.isWatch == isWatch &&
+        other.target == target;
   }
 }
 
+/// The settings that are relevant for setting up universal links
+@immutable
+class XcodeUniversalLinkSettings {
+  const XcodeUniversalLinkSettings({
+    this.bundleIdentifier,
+    this.teamIdentifier,
+    this.associatedDomains = const <String>[],
+  });
+
+  final String? bundleIdentifier;
+  final String? teamIdentifier;
+  final List<String> associatedDomains;
+}
+
+
 /// Information about an Xcode project.
 ///
 /// Represents the output of `xcodebuild -list`.

packages/flutter_tools/lib/src/macos/migrations/flutter_application_migration.dart

@@ -27,7 +27,7 @@ class FlutterApplicationMigration extends ProjectMigrator {
   void migrate() {
     if (_infoPlistFile.existsSync()) {
       final String? principalClass =
-          globals.plistParser.getStringValueFromFile(_infoPlistFile.path, PlistParser.kNSPrincipalClassKey);
+          globals.plistParser.getValueFromFile<String>(_infoPlistFile.path, PlistParser.kNSPrincipalClassKey);
       if (principalClass == null || principalClass == 'NSApplication') {
         // No NSPrincipalClass defined, or already converted. No migration
         // needed.

packages/flutter_tools/lib/src/vmservice.dart

@@ -41,6 +41,7 @@ const String kFlutterMemoryInfoServiceName = 'flutterMemoryInfo';
 const String kFlutterGetSkSLServiceName = 'flutterGetSkSL';
 const String kFlutterGetIOSBuildOptionsServiceName = 'flutterGetIOSBuildOptions';
 const String kFlutterGetAndroidBuildVariantsServiceName = 'flutterGetAndroidBuildVariants';
+const String kFlutterGetIOSDeeplinkSettingsServiceName = 'flutterGetIOSDeeplinkSettings';
 
 /// The error response code from an unrecoverable compilation failure.
 const int kIsolateReloadBarred = 1005;
@@ -337,6 +338,25 @@ Future<vm_service.VmService> setUpVmService({
     registrationRequests.add(
       vmService.registerService(kFlutterGetAndroidBuildVariantsServiceName, kFlutterToolAlias),
     );
+
+    vmService.registerServiceCallback(kFlutterGetIOSDeeplinkSettingsServiceName, (Map<String, Object?> params) async {
+      final XcodeUniversalLinkSettings settings = await flutterProject.ios.universalLinkSettings(
+        configuration: params['configuration']! as String,
+        scheme: params['scheme']! as String,
+        target: params['target']! as String,
+      );
+      return <String, Object>{
+        'result': <String, Object>{
+          kResultType: kResultTypeSuccess,
+          'bundleIdentifier': settings.bundleIdentifier ?? '',
+          'teamIdentifier': settings.teamIdentifier ?? '',
+          'associatedDomains': settings.associatedDomains,
+        },
+      };
+    });
+    registrationRequests.add(
+      vmService.registerService(kFlutterGetIOSDeeplinkSettingsServiceName, 'Flutter Tools'),
+    );
   }
 
   if (printStructuredErrorLogMethod != null) {