-
Notifications
You must be signed in to change notification settings - Fork 58
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #944 from Workiva/FED-2034-required-props-lint-res…
…pect-forwarded FED-2034: Analyzer plugin required props validation: check forwarded props
- Loading branch information
Showing
11 changed files
with
1,576 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
128 changes: 128 additions & 0 deletions
128
tools/analyzer_plugin/lib/src/util/prop_forwarding/forwarded_props.dart
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| import 'package:analyzer/dart/ast/ast.dart'; | ||
| import 'package:analyzer/dart/element/element.dart'; | ||
| import 'package:analyzer/dart/element/type.dart'; | ||
| import 'package:over_react_analyzer_plugin/src/diagnostic_contributor.dart'; | ||
| import 'package:over_react_analyzer_plugin/src/util/ast_util.dart'; | ||
| import 'package:over_react_analyzer_plugin/src/util/is_props_from_render.dart'; | ||
| import 'package:over_react_analyzer_plugin/src/util/prop_forwarding/parse_forwarding_config.dart'; | ||
| import 'package:over_react_analyzer_plugin/src/util/util.dart'; | ||
|
|
||
| import 'forwarding_config.dart'; | ||
| import 'util.dart'; | ||
|
|
||
| /// A representation of props forwarded to a component usage. | ||
| class ForwardedProps { | ||
| /// The props class that props are being forwarded from. | ||
| /// | ||
| /// For example, the type of `props` in `..addUnconsumedProps(props, ...)`. | ||
| final InterfaceElement propsClassBeingForwarded; | ||
|
|
||
| /// The configuration of which props to forward, or null if it could not be resolved. | ||
| final PropForwardingConfig? forwardingConfig; | ||
|
|
||
| /// A node that represents the addition of forwarded props, for use in debug infos only. | ||
| final AstNode debugSourceNode; | ||
|
|
||
| ForwardedProps(this.propsClassBeingForwarded, this.forwardingConfig, this.debugSourceNode); | ||
|
|
||
| /// Returns whether these forwarded props definitely include props from [propsClass], or false | ||
| /// if forwarded props could not be resolved. | ||
| /// | ||
| /// This is true only when all of the following conditions are met: | ||
| /// - [propsClassBeingForwarded] inherits from [propsClass] (i.e., is or mixes in those props) | ||
| /// - [propsClass] is not excluded by [forwardingConfig] | ||
| bool definitelyForwardsPropsFrom(InterfaceElement propsClass) { | ||
| final forwardingConfig = this.forwardingConfig; | ||
| if (forwardingConfig == null) return false; | ||
|
|
||
| // Handle legacy classes being passed in. | ||
| if (propsClass.name.startsWith(r'_$')) { | ||
| // Look up the companion and use that instead, since that's what will be referenced in the forwarding config. | ||
| // E.g., for `_$FooProps`, find `FooProps`, since consumers will be using `FooProps` when setting up prop forwarding. | ||
| final companion = propsClassBeingForwarded.thisAndAllSuperInterfaces | ||
| .whereType<ClassElement>() | ||
| .singleWhereOrNull((c) => c.supertype?.element == propsClass && '_\$${c.name}' == propsClass.name); | ||
| // If we can't find the companion, return false, since it won't show up in the forwarding config. | ||
| if (companion == null) return false; | ||
| propsClass = companion; | ||
| } | ||
|
|
||
| return !forwardingConfig.excludesProps(propsClass) && | ||
| propsClassBeingForwarded.thisAndAllSuperInterfaces.contains(propsClass); | ||
| } | ||
|
|
||
| @override | ||
| String toString() => 'Forwards props from ${propsClassBeingForwarded.name}: ${forwardingConfig ?? '(unresolved)'}'; | ||
| } | ||
|
|
||
| extension on InterfaceElement { | ||
| /// This interface and all its superinterfaces. | ||
| /// | ||
| /// Computed lazily, since [allSupertypes] is expensive. | ||
| Iterable<InterfaceElement> get thisAndAllSuperInterfaces sync* { | ||
| yield this; | ||
| yield* allSupertypes.map((s) => s.element); | ||
| } | ||
| } | ||
|
|
||
| /// Computes and returns forwarded props for a given component [usage], or `null` if the usage does not receive any | ||
| /// forwarded props. | ||
| ForwardedProps? computeForwardedProps(FluentComponentUsage usage) { | ||
| // Lazy variables for potentially expensive values that may get used in multiple loop iterations. | ||
| late final enclosingComponentPropsClass = | ||
| getTypeOfPropsInEnclosingInterface(usage.node)?.typeOrBound.element.tryCast<InterfaceElement>(); | ||
|
|
||
| for (final invocation in usage.cascadedMethodInvocations) { | ||
| final methodName = invocation.methodName.name; | ||
| final arg = invocation.node.argumentList.arguments.firstOrNull; | ||
|
|
||
| if (methodName == 'addProps' || methodName == 'modifyProps') { | ||
| // If props are conditionally forwarded, don't count them. | ||
| final hasConditionArg = invocation.node.argumentList.arguments.length > 1; | ||
| if (hasConditionArg) continue; | ||
| } | ||
|
|
||
| final isAddAllOrAddProps = methodName == 'addProps' || methodName == 'addAll'; | ||
|
|
||
| // ..addProps(props) | ||
| if (isAddAllOrAddProps && arg != null && isPropsFromRender(arg)) { | ||
| final propsType = arg.staticType?.typeOrBound.tryCast<InterfaceType>()?.element; | ||
| if (propsType != null) { | ||
| return ForwardedProps(propsType, PropForwardingConfig.all(), invocation.node); | ||
| } | ||
| } else if ( | ||
| // ..addProps(props.getPropsToForward(...)) | ||
| (isAddAllOrAddProps && arg is MethodInvocation && arg.methodName.name == 'getPropsToForward') || | ||
| // ..modifyProps(props.addPropsToForward(...)) | ||
| (methodName == 'modifyProps' && arg is MethodInvocation && arg.methodName.name == 'addPropsToForward')) { | ||
| final realTarget = arg.realTarget; | ||
| if (realTarget != null && isPropsFromRender(realTarget)) { | ||
| final propsType = realTarget.staticType?.typeOrBound.tryCast<InterfaceType>()?.element; | ||
| if (propsType != null) { | ||
| return ForwardedProps(propsType, parsePropsToForwardMethodArgs(arg.argumentList, propsType), invocation.node); | ||
| } | ||
| } | ||
| } else if ( | ||
| // ..addProps(copyUnconsumedProps()) | ||
| (isAddAllOrAddProps && arg is MethodInvocation && arg.methodName.name == 'copyUnconsumedProps') || | ||
| // ..modifyProps(addUnconsumedProps) | ||
| (methodName == 'modifyProps' && arg is Identifier && arg.name == 'addUnconsumedProps')) { | ||
| if (enclosingComponentPropsClass != null) { | ||
| return ForwardedProps( | ||
| enclosingComponentPropsClass, parseEnclosingClassComponentConsumedProps(usage.node), invocation.node); | ||
| } | ||
| } else if ( | ||
| // ..addUnconsumedProps(props, consumedProps) | ||
| methodName == 'addUnconsumedProps') { | ||
| final consumedPropsArg = invocation.node.argumentList.arguments.elementAtOrNull(1); | ||
| if (arg != null && consumedPropsArg != null && isPropsFromRender(arg)) { | ||
| final propsType = arg.staticType?.typeOrBound.tryCast<InterfaceType>()?.element; | ||
| if (propsType != null) { | ||
| return ForwardedProps(propsType, parseConsumedProps(consumedPropsArg), invocation.node); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return null; | ||
| } |
46 changes: 46 additions & 0 deletions
46
tools/analyzer_plugin/lib/src/util/prop_forwarding/forwarding_config.dart
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| import 'package:analyzer/dart/element/element.dart'; | ||
|
|
||
| /// A representation of an over_react consumer's configuration of which props classes to | ||
| /// include or exclude when forwarding props. | ||
| abstract class PropForwardingConfig { | ||
| const PropForwardingConfig(); | ||
|
|
||
| const factory PropForwardingConfig.all() = _PropForwardingConfig$AllExceptFor; | ||
|
|
||
| const factory PropForwardingConfig.allExceptFor(Set<InterfaceElement> onlyProps) = _PropForwardingConfig$AllExceptFor; | ||
|
|
||
| const factory PropForwardingConfig.only(Set<InterfaceElement> excludedProps) = _PropForwardingConfig$Only; | ||
|
|
||
| /// Whether this configuration might exclude props declared in the props class [e] when forwarding. | ||
| bool excludesProps(InterfaceElement e); | ||
|
|
||
| String get debugDescription; | ||
|
|
||
| @override | ||
| toString() => '$debugDescription'; | ||
| } | ||
|
|
||
| class _PropForwardingConfig$Only extends PropForwardingConfig { | ||
| final Set<InterfaceElement> _onlyProps; | ||
|
|
||
| const _PropForwardingConfig$Only(this._onlyProps); | ||
|
|
||
| @override | ||
| bool excludesProps(InterfaceElement e) => !_onlyProps.contains(e); | ||
|
|
||
| @override | ||
| String get debugDescription => 'only props from ${_onlyProps.map((e) => e.name).toSet()}'; | ||
| } | ||
|
|
||
| class _PropForwardingConfig$AllExceptFor extends PropForwardingConfig { | ||
| final Set<InterfaceElement> _excludedProps; | ||
|
|
||
| const _PropForwardingConfig$AllExceptFor([this._excludedProps = const {}]); | ||
|
|
||
| @override | ||
| bool excludesProps(InterfaceElement e) => _excludedProps.contains(e); | ||
|
|
||
| @override | ||
| String get debugDescription => | ||
| _excludedProps.isEmpty ? 'all props' : 'all except props from ${_excludedProps.map((e) => e.name).toSet()}'; | ||
| } |
Oops, something went wrong.