prevent tool crash when IntelliJValidatorOnMac encounters an installation with a missing CFBundleIdentifier (flutter#138095)

Fixes flutter#138029 (see my comment there for more info)

Author: andrewkolos

packages/flutter_tools/lib/src/doctor.dart

@@ -53,17 +53,20 @@ abstract class DoctorValidatorsProvider {
   // [FeatureFlags].
   factory DoctorValidatorsProvider.test({
     Platform? platform,
+    Logger? logger,
     required FeatureFlags featureFlags,
   }) {
     return _DefaultDoctorValidatorsProvider(
       featureFlags: featureFlags,
       platform: platform ?? FakePlatform(),
+      logger: logger ?? BufferLogger.test(),
     );
   }
   /// The singleton instance, pulled from the [AppContext].
   static DoctorValidatorsProvider get _instance => context.get<DoctorValidatorsProvider>()!;
 
   static final DoctorValidatorsProvider defaultInstance = _DefaultDoctorValidatorsProvider(
+    logger: globals.logger,
     platform: globals.platform,
     featureFlags: featureFlags,
   );
@@ -76,12 +79,14 @@ class _DefaultDoctorValidatorsProvider implements DoctorValidatorsProvider {
   _DefaultDoctorValidatorsProvider({
     required this.platform,
     required this.featureFlags,
-  });
+    required Logger logger,
+  }) : _logger = logger;
 
   List<DoctorValidator>? _validators;
   List<Workflow>? _workflows;
   final Platform platform;
   final FeatureFlags featureFlags;
+  final Logger _logger;
 
   late final LinuxWorkflow linuxWorkflow = LinuxWorkflow(
     platform: platform,
@@ -117,6 +122,7 @@ class _DefaultDoctorValidatorsProvider implements DoctorValidatorsProvider {
         userMessages: userMessages,
         plistParser: globals.plistParser,
         processManager: globals.processManager,
+        logger: _logger,
       ),
       ...VsCodeValidator.installedValidators(globals.fs, platform, globals.processManager),
     ];

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

@@ -7,6 +7,7 @@ import 'package:process/process.dart';
 
 import '../base/file_system.dart';
 import '../base/io.dart';
+import '../base/logger.dart';
 import '../base/platform.dart';
 import '../base/user_messages.dart' hide userMessages;
 import '../base/version.dart';
@@ -50,6 +51,7 @@ abstract class IntelliJValidator extends DoctorValidator {
   static Iterable<DoctorValidator> installedValidators({
     required FileSystem fileSystem,
     required Platform platform,
+    required Logger logger,
     required UserMessages userMessages,
     required PlistParser plistParser,
     required ProcessManager processManager,
@@ -77,6 +79,7 @@ abstract class IntelliJValidator extends DoctorValidator {
         userMessages: userMessages,
         plistParser: plistParser,
         processManager: processManager,
+        logger: logger,
       );
     }
     return <DoctorValidator>[];
@@ -364,6 +367,7 @@ class IntelliJValidatorOnMac extends IntelliJValidator {
     required UserMessages userMessages,
     required PlistParser plistParser,
     required String? homeDirPath,
+
   }) : _plistParser = plistParser,
        _homeDirPath = homeDirPath,
        super(title, installPath, fileSystem: fileSystem, userMessages: userMessages);
@@ -382,6 +386,7 @@ class IntelliJValidatorOnMac extends IntelliJValidator {
   static Iterable<DoctorValidator> installed({
     required FileSystem fileSystem,
     required FileSystemUtils fileSystemUtils,
+    required Logger logger,
     required UserMessages userMessages,
     required PlistParser plistParser,
     required ProcessManager processManager,
@@ -490,10 +495,16 @@ class IntelliJValidatorOnMac extends IntelliJValidator {
       if (validator is! IntelliJValidatorOnMac) {
         return false;
       }
-      final String identifierKey = plistParser.getValueFromFile(
+      final String? identifierKey = plistParser.getValueFromFile<String>(
         validator.plistFile,
         PlistParser.kCFBundleIdentifierKey,
-      ) as String;
+      );
+      if (identifierKey == null) {
+        logger.printTrace('Android Studio/IntelliJ installation at '
+          '${validator.installPath} has a null CFBundleIdentifierKey, '
+          'which is a required field.');
+        return false;
+      }
       return identifierKey.contains('com.jetbrains.toolbox.linkapp');
     });
 

packages/flutter_tools/test/general.shard/intellij/intellij_validator_test.dart

@@ -5,6 +5,7 @@
 import 'package:archive/archive.dart';
 import 'package:file/memory.dart';
 import 'package:flutter_tools/src/base/file_system.dart';
+import 'package:flutter_tools/src/base/logger.dart';
 import 'package:flutter_tools/src/base/platform.dart';
 import 'package:flutter_tools/src/base/user_messages.dart';
 import 'package:flutter_tools/src/convert.dart';
@@ -308,6 +309,7 @@ void main() {
         PlistParser.kCFBundleShortVersionStringKey: '2020.10',
         PlistParser.kCFBundleIdentifierKey: 'com.jetbrains.intellij',
       }),
+      logger: BufferLogger.test(),
     ).whereType<IntelliJValidatorOnMac>();
     expect(validators.length, 2);
 
@@ -389,6 +391,7 @@ void main() {
         'CFBundleIdentifier': 'com.jetbrains.toolbox.linkapp',
       }),
       processManager: processManager,
+      logger: BufferLogger.test(),
     );
 
     expect(validators.length, 1);
@@ -431,11 +434,56 @@ void main() {
         'CFBundleIdentifier': 'com.jetbrains.toolbox.linkapp',
       }),
       processManager: processManager,
+      logger: BufferLogger.test(),
     );
 
     expect(installed.length, 0);
     expect(processManager, hasNoRemainingExpectations);
   });
+
+  testWithoutContext('Does not crash when installation is missing its CFBundleIdentifier property', () async {
+    final BufferLogger logger = BufferLogger.test();
+    final FileSystem fileSystem = MemoryFileSystem.test();
+    final String ultimatePath = fileSystem.path.join('/', 'foo', 'bar', 'Applications',
+          'JetBrains Toolbox', 'IntelliJ IDEA Ultimate.app');
+    final String communityEditionPath = fileSystem.path.join('/', 'foo', 'bar', 'Applications',
+          'JetBrains Toolbox', 'IntelliJ IDEA Community Edition.app');
+    final List<String> installPaths = <String>[
+      ultimatePath,
+      communityEditionPath
+    ];
+
+    for (final String installPath in installPaths) {
+      fileSystem.directory(installPath).createSync(recursive: true);
+    }
+
+    final FakeProcessManager processManager =
+    FakeProcessManager.list(<FakeCommand>[
+      FakeCommand(command: const <String>[
+        'mdfind',
+        'kMDItemCFBundleIdentifier="com.jetbrains.intellij.ce"',
+      ], stdout: communityEditionPath),
+      FakeCommand(command: const <String>[
+        'mdfind',
+        'kMDItemCFBundleIdentifier="com.jetbrains.intellij*"',
+      ], stdout: ultimatePath)
+    ]);
+
+    final Iterable<DoctorValidator> installed = IntelliJValidatorOnMac.installed(
+      fileSystem: fileSystem,
+      fileSystemUtils: FileSystemUtils(fileSystem: fileSystem, platform: macPlatform),
+      userMessages: UserMessages(),
+      plistParser: FakePlistParser(<String, String>{
+        'JetBrainsToolboxApp': '/path/to/JetBrainsToolboxApp',
+      }),
+      processManager: processManager,
+      logger: logger,
+    );
+
+    expect(installed.length, 2);
+    expect(logger.traceText, contains('installation at $ultimatePath has a null CFBundleIdentifierKey'));
+    expect(processManager, hasNoRemainingExpectations);
+  });
 }
 
 class IntelliJValidatorTestTarget extends IntelliJValidator {