CPLAT-7393 Add logic to handle components with mixin(s)

lib/src/component2_suggestors/class_name_and_annotation_migrator.dart

@@ -18,7 +18,6 @@ import 'package:codemod/codemod.dart';
 import 'package:over_react_codemod/src/react16_suggestors/react16_utilities.dart';
 
 import '../constants.dart';
-import 'component2_constants.dart';
 import 'component2_utilities.dart';
 
 /// Suggestor that replaces `UiComponent` with `UiComponent2` in extends clauses
@@ -139,10 +138,7 @@ class ClassNameAndAnnotationMigrator extends GeneralizingAstVisitor
         wasUpdated = true;
       });
 
-      if (extendsName.name == 'UiComponent' ||
-          extendsName.name == 'UiStatefulComponent' ||
-          extendsName.name == 'FluxUiComponent' ||
-          extendsName.name == 'FluxUiStatefulComponent') {
+      if (upgradableV1ComponentClassNames.contains(extendsName.name)) {
         // Update `UiComponent` or `UiStatefulComponent` extends clause.
         yieldPatch(
           extendsName.end,
@@ -154,15 +150,55 @@ class ClassNameAndAnnotationMigrator extends GeneralizingAstVisitor
       }
     }
 
-    // Add comment for abstract components that are updated
-    if (wasUpdated &&
-        canBeExtendedFrom(node) &&
-        !hasComment(node, sourceFile, abstractClassMessage)) {
-      yieldPatch(
-        node.offset,
-        node.offset,
-        '$abstractClassMessage\n',
-      );
+    if (wasUpdated) {
+      _addFixMeCommentPatches(node, extendsName);
     }
   }
+
+  void _addFixMeCommentPatches(ClassDeclaration node, Identifier extendsName) {
+    final extendsNameStr = extendsName.toString().replaceAll('2', '');
+    final classToUpgradeTo =
+        upgradableV1ComponentClassNames.contains(extendsNameStr)
+            ? '`${extendsNameStr}2`'
+            : 'a class that now extends from `UiComponent2`';
+
+    [
+      _FixMeCommentPatch(hasOneOrMoreMixins, () => node,
+          'FIXME: Before upgrading this component to $classToUpgradeTo, verify that none of the mixin(s) contain implementations of any React lifecycle methods that are not supported in $classToUpgradeTo.'),
+      _FixMeCommentPatch(
+          (node) => shouldUpgradeAbstractComponents && canBeExtendedFrom(node),
+          () => node,
+          'FIXME: Abstract class has been updated to $classToUpgradeTo. This is a breaking change if this class is exported.'),
+    ].forEach((patch) {
+      if (!patch.shouldYieldPatch(node) ||
+          hasMultilineDocComment(node, sourceFile, patch.commentSrc)) {
+        return;
+      }
+
+      final patchOffset = node.metadata?.beginToken?.offset ??
+          node.firstTokenAfterCommentAndMetadata.offset;
+      yieldPatch(patchOffset, patchOffset, patch.commentSrc);
+    });
+  }
+}
+
+class _FixMeCommentPatch {
+  final bool Function(ClassDeclaration node) shouldYieldPatch;
+  final ClassDeclaration Function() getNode;
+
+  _FixMeCommentPatch(this.shouldYieldPatch, this.getNode, String commentSrc) {
+    final node = getNode();
+    final indentationLevel = node.beginToken.charOffset;
+    final fixmeCommentLineStart =
+        indentationLevel == 0 ? '///' : (' ' * indentationLevel) + '///';
+    final fixmeCommentStart = node.documentationComment != null
+        ? '$fixmeCommentLineStart\n$fixmeCommentLineStart'
+        : fixmeCommentLineStart;
+    final fixmeCommentEnd = '\n';
+
+    _commentSrc = '$fixmeCommentStart $commentSrc$fixmeCommentEnd';
+  }
+
+  String _commentSrc;
+  String get commentSrc => _commentSrc;
 }

lib/src/component2_suggestors/component2_constants.dart

@@ -35,6 +35,3 @@ String getDeperecationMessage(String methodName) {
   ///
   $revertInstructions''';
 }
-
-const abstractClassMessage =
-    '/// FIXME: Abstract class has been updated to Component2. This is a breaking change if this class is exported.';

lib/src/component2_suggestors/component2_utilities.dart

@@ -50,10 +50,15 @@ bool extendsComponent2(ClassDeclaration classNode) {
   }
 }
 
+/// Returns whether or not [classNode] has one or more mixins.
+bool hasOneOrMoreMixins(ClassDeclaration classNode) =>
+    classNode?.withClause != null;
+
 /// Returns whether or not [classNode] can be fully upgraded to Component2.
 ///
 /// In order for a component to be fully upgradable, the component must:
 ///
+/// * not have a `with` clause
 /// * extend directly from `UiComponent`, `UiStatefulComponent`,
 /// `FluxUiComponent`, `FluxUiStatefulComponent`, or `react.Component`
 /// * contain only the lifecycle methods that the codemod updates:
@@ -66,6 +71,10 @@ bool fullyUpgradableToComponent2(ClassDeclaration classNode) {
     return false;
   }
 
+  if (hasOneOrMoreMixins(classNode)) {
+    return false;
+  }
+
   // Check that class extends directly from Component classes.
   String reactImportName =
       getImportNamespace(classNode, 'package:react/react.dart');

lib/src/constants.dart

@@ -72,6 +72,14 @@ const List<String> overReactMixinAnnotationNames = [
   'StateMixin',
 ];
 
+/// A list of the names of the core component classes that can be upgraded to a "v2" version.
+const List<String> upgradableV1ComponentClassNames = [
+  'UiComponent',
+  'UiStatefulComponent',
+  'FluxUiComponent',
+  'FluxUiStatefulComponent',
+];
+
 /// Dart type for the static meta field on props classes.
 const String propsMetaType = 'PropsMeta';
 

lib/src/react16_suggestors/react16_utilities.dart

@@ -51,13 +51,53 @@ bool hasComment(AstNode node, SourceFile sourceFile, String comment) {
   return commentText?.contains(comment) ?? false;
 }
 
+/// Whether the [node] has a documentation comment that has
+/// any lines that match lines found within the provided [comment].
+bool hasMultilineDocComment(
+    AnnotatedNode node, SourceFile sourceFile, String comment) {
+  final nodeComments = nodeCommentSpan(node, sourceFile)
+      .text
+      .replaceAll('///', '')
+      .split('\n')
+      .map((line) => line.replaceAll('\n', '').trim())
+      .toList()
+        ..removeWhere((line) => line.isEmpty);
+  final commentLines = comment
+      .replaceAll('///', '')
+      .trimLeft()
+      .split('\n')
+      .map((line) => line.replaceAll('\n', '').trim())
+      .toList()
+        ..removeWhere((line) => line.isEmpty);
+
+  bool match = false;
+
+  for (var i = 0; i < commentLines.length; i++) {
+    final potentialMatch = commentLines[i];
+    if (nodeComments.any((line) => line == potentialMatch)) {
+      match = true;
+      break;
+    }
+  }
+
+  return match;
+}
+
+/// Returns the `SourceSpan` value of any comments on the provided [node] within the [sourceFile].
+SourceSpan nodeCommentSpan(AnnotatedNode node, SourceFile sourceFile) {
+  return sourceFile.span(
+      node.beginToken.offset,
+      node.metadata?.beginToken?.offset ??
+          node.firstTokenAfterCommentAndMetadata.offset);
+}
+
 /// Returns an iterable of all the comments from [beginToken] to the end of the
 /// file.
 ///
 /// Comments are part of the normal stream, and need to be accessed via
 /// [Token.precedingComments], so it's difficult to iterate over them without
 /// this method.
-Iterable allComments(Token beginToken) sync* {
+Iterable<Token> allComments(Token beginToken) sync* {
   var currentToken = beginToken;
   while (!currentToken.isEof) {
     var currentComment = currentToken.precedingComments;