Support for creating and displaying edits in the preview tool

bwilkerson · commit-bot@chromium.org · commit 1ae6f1b031a3 · 2019-11-18T16:14:43.000Z
Change-Id: I2284ceeb0229d7111022eb3759e39752264f1bc6 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/125492 Reviewed-by: Samuel Rawlins <srawlins@google.com> Commit-Queue: Brian Wilkerson <brianwilkerson@google.com>
diff --git a/pkg/analysis_server/lib/src/edit/nnbd_migration/info_builder.dart b/pkg/analysis_server/lib/src/edit/nnbd_migration/info_builder.dart
@@ -324,6 +324,19 @@ class InfoBuilder {
     return details;
   }
 
+  /// Return a list of edits that can be applied.
+  List<EditDetail> _computeEdits(FixInfo fixInfo) {
+    // TODO(brianwilkerson) Add other kinds of edits, such as adding an assert.
+    List<EditDetail> edits = [];
+    SingleNullabilityFix fix = fixInfo.fix;
+    if (fix.description.kind == NullabilityFixKind.makeTypeNullable) {
+      Location location = fix.location;
+      edits.add(EditDetail(
+          'Force type to be non-nullable.', location.offset, 0, '/*!*/'));
+    }
+    return edits;
+  }
+
   /// Return the navigation sources for the unit associated with the [result].
   List<NavigationSource> _computeNavigationSources(ResolvedUnitResult result) {
     NavigationCollectorImpl collector = new NavigationCollectorImpl();
@@ -443,12 +456,15 @@ class InfoBuilder {
       if (fixInfo != null) {
         String explanation = '${fixInfo.fix.description.appliedMessage}.';
         List<RegionDetail> details = _computeDetails(fixInfo);
+        List<EditDetail> edits = _computeEdits(fixInfo);
         if (length > 0) {
-          regions.add(RegionInfo(RegionType.fix, mapper.map(offset), length,
-              explanation, details));
+          regions.add(RegionInfo(
+              RegionType.fix, mapper.map(offset), length, explanation, details,
+              edits: edits));
         }
         regions.add(RegionInfo(RegionType.fix, mapper.map(end),
-            replacement.length, explanation, details));
+            replacement.length, explanation, details,
+            edits: edits));
       }
     }
     if (explainNonNullableTypes) {
diff --git a/pkg/analysis_server/lib/src/edit/nnbd_migration/instrumentation_renderer.dart b/pkg/analysis_server/lib/src/edit/nnbd_migration/instrumentation_renderer.dart
@@ -401,7 +401,22 @@ class InstrumentationRenderer {
       // Write out any edits.
       //
       if (supportsIncrementalWorkflow && region.edits.isNotEmpty) {
-        // TODO(brianwilkerson) Implement this.
+        for (EditDetail edit in region.edits) {
+          int offset = edit.offset;
+          String targetUri = Uri(
+              scheme: 'http',
+              path: pathContext.basename(unitInfo.path),
+              queryParameters: {
+                'offset': offset.toString(),
+                'end': (offset + edit.length).toString(),
+                'replacement': edit.replacement
+              }).toString();
+          regions.write('<p>');
+          regions.write('<a href="$targetUri">');
+          regions.write(edit.description);
+          regions.write('</a>');
+          regions.write('</p>');
+        }
       }
       regions.write('</span></span>');
     }
diff --git a/pkg/analysis_server/lib/src/edit/nnbd_migration/migration_info.dart b/pkg/analysis_server/lib/src/edit/nnbd_migration/migration_info.dart
@@ -116,7 +116,7 @@ class RegionInfo {
   /// Initialize a newly created region.
   RegionInfo(
       this.regionType, this.offset, this.length, this.explanation, this.details,
-      {this.edits});
+      {this.edits = const []});
 }
 
 /// Different types of regions that are called out.

Original file line number	Diff line number	Diff line change
`@@ -116,7 +116,7 @@ class RegionInfo {`
`116`	`116`	`/// Initialize a newly created region.`
`117`	`117`	`RegionInfo(`
`118`	`118`	`this.regionType, this.offset, this.length, this.explanation, this.details,`
`119`		`- {this.edits});`
	`119`	`+ {this.edits = const []});`
`120`	`120`	`}`
`121`	`121`
`122`	`122`	`/// Different types of regions that are called out.`