Clean up and improve prop forwarding debug infos, add demo

Author: greglittlefield-wf

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

@@ -174,7 +174,7 @@ class MissingRequiredPropDiagnostic extends ComponentUsageDiagnosticContributor
     final debugHelper = AnalyzerDebugHelper(result, collector, enabled: _cachedIsDebugHelperEnabled(result));
     // A flag to help verify during debugging/testing whether propsSetByFactory was computed.
     var hasPropsSetByFactoryBeenComputed = false;
-    final debugInfoByForwardedRequiredProp = <FieldElement, _ForwardedRequiredPropDebugInfo>{};
+    final debugSuppressedRequiredPropsDueToForwarding = <FieldElement>{};
 
     // Use late variables to compute these only when we need to.
     late final propsSetByFactory = () {
@@ -209,7 +209,7 @@ class MissingRequiredPropDiagnostic extends ComponentUsageDiagnosticContributor
       if (sourcePropsClass is InterfaceElement) {
         if (forwardedProps != null && forwardedProps.definitelyForwardsPropsFrom(sourcePropsClass)) {
           if (debugHelper.enabled) {
-            debugInfoByForwardedRequiredProp[field] = _ForwardedRequiredPropDebugInfo(forwardedProps.debugSourceNode);
+            debugSuppressedRequiredPropsDueToForwarding.add(field);
           }
           continue;
         }
@@ -236,19 +236,20 @@ class MissingRequiredPropDiagnostic extends ComponentUsageDiagnosticContributor
       }
     }
 
-    if (debugHelper.enabled) {
-      final fieldsByReasonNode =
-          debugInfoByForwardedRequiredProp.keys.groupListsBy((field) => debugInfoByForwardedRequiredProp[field]!.node);
-      fieldsByReasonNode.forEach((reasonNode, fields) {
-        debugHelper.log(() {
-          return 'Suppressing missing required props warnings due to forwarding here, for the following props:'
-              ' ${fields.map((f) => '${f.enclosingElement.name}.${f.name}').join(', ')}';
-        }, () => result.locationFor(reasonNode));
-      });
+    if (forwardedProps != null) {
+      debugHelper.log(() {
+        var message = StringBuffer()..writeln(forwardedProps);
+        if (debugSuppressedRequiredPropsDueToForwarding.isNotEmpty) {
+          final propsNamesByClassName = <String?, Set<String>>{};
+          for (final field in debugSuppressedRequiredPropsDueToForwarding) {
+            propsNamesByClassName.putIfAbsent(field.enclosingElement.name, () => {}).add(field.name);
+          }
+          message.write('Required props set only via forwarding: ${prettyPrint(propsNamesByClassName)}');
+        } else {}
+        return message.toString();
+      }, () => result.locationFor(forwardedProps.debugSourceNode));
     }
 
-    debugHelper.log(() => 'Forwarded props: $forwardedProps', () => result.locationFor(usage.builder));
-
     // Include debug info for each invocation ahout all the props and their requirednesses.
     debugHelper.log(() {
       final propNamesByRequirednessName = <String, Set<String>>{};
@@ -272,9 +273,3 @@ class MissingRequiredPropDiagnostic extends ComponentUsageDiagnosticContributor
     }, () => result.locationFor(usage.builder));
   }
 }
-
-class _ForwardedRequiredPropDebugInfo {
-  final AstNode node;
-
-  _ForwardedRequiredPropDebugInfo(this.node);
-}

tools/analyzer_plugin/lib/src/util/prop_forwarding/forwarded_props.dart

@@ -52,7 +52,7 @@ class ForwardedProps {
   }
 
   @override
-  String toString() => 'Props from ${propsClassBeingForwarded.name}: ${forwardingConfig ?? '(unresolved)'}';
+  String toString() => 'Forwards props from ${propsClassBeingForwarded.name}: ${forwardingConfig ?? '(unresolved)'}';
 }
 
 extension on InterfaceElement {

tools/analyzer_plugin/lib/src/util/prop_forwarding/forwarding_config.dart

@@ -29,7 +29,7 @@ class _PropForwardingConfig$Only extends PropForwardingConfig {
   bool excludesProps(InterfaceElement e) => !_onlyProps.contains(e);
 
   @override
-  String get debugDescription => 'only ${_onlyProps.map((e) => e.name).toSet()}';
+  String get debugDescription => 'only props from ${_onlyProps.map((e) => e.name).toSet()}';
 }
 
 class _PropForwardingConfig$AllExceptFor extends PropForwardingConfig {
@@ -41,5 +41,6 @@ class _PropForwardingConfig$AllExceptFor extends PropForwardingConfig {
   bool excludesProps(InterfaceElement e) => _excludedProps.contains(e);
 
   @override
-  String get debugDescription => 'all except ${_excludedProps.map((e) => e.name).toSet()}';
+  String get debugDescription =>
+      _excludedProps.isEmpty ? 'all props' : 'all except props from ${_excludedProps.map((e) => e.name).toSet()}';
 }

tools/analyzer_plugin/playground/web/missing_required_props.dart

@@ -120,6 +120,8 @@ UiFactory<WrapsInheritsLateRequiredProps> WrapsInheritsLateRequired = uiFunction
         // InheritsLateRequiredPropsMixin,
       }))
     )();
+    // de bug:over_react_required_props
+    //   ^ Also, try deleting this space to enable prop forwarding debug infos on lines where props are forwarded
   },
   _$WrapsInheritsLateRequiredConfig, // ignore: undefined_identifier
 );