Merge pull request #930 from Workiva/fix-key-diagnostic-ide-error

FED-2855 Fix Analyzer Plugin error when typing keys

pubspec.yaml

@@ -7,7 +7,7 @@ environment:
 
 dependencies:
   collection: ^1.15.0
-  analyzer: ^5.1.0
+  analyzer: ^5.13.0
   build: '>=1.0.0 <3.0.0'
   dart_style: ^2.0.0
   js: ^0.6.1+1

tools/analyzer_plugin/lib/src/diagnostic/bad_key.dart

@@ -139,21 +139,24 @@ class BadKeyDiagnostic extends ComponentUsageDiagnosticContributor {
     final topLevelKeyType = expression.staticType;
     // Type can't be resolved; bail out.
     if (topLevelKeyType == null) return;
+    // The type is bad because of errors, such as when the user's in the middle of typing an identifier,
+    // or referencing an identifier that doesn't exist yet.
+    if (topLevelKeyType is InvalidType) return;
 
     final typedProvider = result.typeProvider;
 
     // Special-case for Iterables and Maps: check if their (keys and) values are allowed types.
     final isIterableOrMap =
+        topLevelKeyType is! DynamicType &&
         // Need to make sure it's not null since null is a subtype of all nullable-types.
         !topLevelKeyType.isDartCoreNull &&
             [
               typedProvider.iterableType(typedProvider.dynamicType),
               typedProvider.mapType(typedProvider.dynamicType, typedProvider.dynamicType),
             ].any((type) => result.typeSystem.isSubtypeOf(topLevelKeyType, type));
 
-    final keyTypesToProcess = {
-      if (isIterableOrMap) ...(topLevelKeyType as InterfaceType).typeArguments else topLevelKeyType,
-    };
+    final keyTypesToProcess =
+        isIterableOrMap && topLevelKeyType is InterfaceType ? topLevelKeyType.typeArguments : [topLevelKeyType];
 
     for (final type in keyTypesToProcess) {
       // Provide context if this type was derived from a Map/Iterable type argument.
@@ -166,7 +169,7 @@ class BadKeyDiagnostic extends ComponentUsageDiagnosticContributor {
           type.isDartCoreString ||
           type.isDartCoreSymbol) {
         // Ignore core types that have good `Object.toString` implementations values.
-      } else if (type.isDartCoreObject || type.isDynamic) {
+      } else if (type.isDartCoreObject || type is DynamicType) {
         collector.addError(
           dynamicOrObjectCode,
           result.locationFor(expression),

tools/analyzer_plugin/test/integration/diagnostics/bad_key_test.dart

@@ -82,6 +82,7 @@ class BadKeyDiagnosticTest_NoErrors extends BadKeyDiagnosticTest {
         (Dom.div()..key = 'greg')(),
         // Missing RHS
         (Dom.div()..key = )(),
+        (Dom.div()..key = undefinedVariable)(),
         // Missing interpolated expression
         (Dom.div()..key = '${}')(),
         // Weird type 
@@ -94,6 +95,7 @@ class BadKeyDiagnosticTest_NoErrors extends BadKeyDiagnosticTest {
         unorderedEquals(<dynamic>[
           isA<AnalysisError>().havingCode('missing_identifier'),
           isA<AnalysisError>().havingCode('missing_identifier'),
+          isA<AnalysisError>().havingCode('undefined_identifier'),
           isA<AnalysisError>().havingCode('use_of_void_result'),
         ]),
         reason: 'should only have the Dart analysis errors we expect');