|
4 | 4 |
|
5 | 5 | import 'package:analysis_server/lsp_protocol/protocol_generated.dart'; |
6 | 6 | import 'package:analysis_server/src/lsp/constants.dart'; |
| 7 | +import 'package:meta/meta.dart'; |
7 | 8 | import 'package:test/test.dart'; |
8 | 9 | import 'package:test_reflective_loader/test_reflective_loader.dart'; |
9 | 10 |
|
| 11 | +import '../tool/lsp_spec/matchers.dart'; |
10 | 12 | import 'server_abstract.dart'; |
11 | 13 |
|
12 | 14 | void main() { |
@@ -130,6 +132,84 @@ class RenameTest extends AbstractLspAnalysisServerTest { |
130 | 132 | content, 'MyNewClass', expectedContent); |
131 | 133 | } |
132 | 134 |
|
| 135 | + Future<void> test_rename_duplicateName_applyAfterDocumentChanges() async { |
| 136 | + // Perform a refactor that results in a prompt to the user, but then modify |
| 137 | + // the document before accepting/rejecting to make the rename invalid. |
| 138 | + const content = ''' |
| 139 | + class MyOtherClass {} |
| 140 | + class MyClass {} |
| 141 | + final a = n^ew MyClass(); |
| 142 | + '''; |
| 143 | + final result = await _test_rename_prompt( |
| 144 | + content, |
| 145 | + 'MyOtherClass', |
| 146 | + expectedMessage: |
| 147 | + 'Library already declares class with name \'MyOtherClass\'.', |
| 148 | + action: UserPromptActions.renameAnyway, |
| 149 | + beforeResponding: () => replaceFile(999, mainFileUri, 'Updated content'), |
| 150 | + ); |
| 151 | + expect(result.result, isNull); |
| 152 | + expect(result.error, isNotNull); |
| 153 | + expect(result.error, isResponseError(ErrorCodes.ContentModified)); |
| 154 | + } |
| 155 | + |
| 156 | + Future<void> test_rename_duplicateName_applyAnyway() async { |
| 157 | + const content = ''' |
| 158 | + class MyOtherClass {} |
| 159 | + class MyClass {} |
| 160 | + final a = n^ew MyClass(); |
| 161 | + '''; |
| 162 | + const expectedContent = ''' |
| 163 | + class MyOtherClass {} |
| 164 | + class MyOtherClass {} |
| 165 | + final a = new MyOtherClass(); |
| 166 | + '''; |
| 167 | + final response = await _test_rename_prompt( |
| 168 | + content, |
| 169 | + 'MyOtherClass', |
| 170 | + expectedMessage: |
| 171 | + 'Library already declares class with name \'MyOtherClass\'.', |
| 172 | + action: UserPromptActions.renameAnyway, |
| 173 | + ); |
| 174 | + |
| 175 | + if (response.error != null) { |
| 176 | + throw response.error; |
| 177 | + } |
| 178 | + |
| 179 | + final result = WorkspaceEdit.fromJson(response.result); |
| 180 | + |
| 181 | + // Ensure applying the changes will give us the expected content. |
| 182 | + final contents = { |
| 183 | + mainFilePath: withoutMarkers(content), |
| 184 | + }; |
| 185 | + applyDocumentChanges( |
| 186 | + contents, |
| 187 | + result.documentChanges, |
| 188 | + ); |
| 189 | + expect(contents[mainFilePath], equals(expectedContent)); |
| 190 | + } |
| 191 | + |
| 192 | + Future<void> test_rename_duplicateName_reject() async { |
| 193 | + const content = ''' |
| 194 | + class MyOtherClass {} |
| 195 | + class MyClass {} |
| 196 | + final a = n^ew MyClass(); |
| 197 | + '''; |
| 198 | + final response = await _test_rename_prompt( |
| 199 | + content, |
| 200 | + 'MyOtherClass', |
| 201 | + expectedMessage: |
| 202 | + 'Library already declares class with name \'MyOtherClass\'.', |
| 203 | + action: UserPromptActions.cancel, |
| 204 | + ); |
| 205 | + // Expect a successful empty response if cancelled. |
| 206 | + expect(response.error, isNull); |
| 207 | + expect( |
| 208 | + WorkspaceEdit.fromJson(response.result), |
| 209 | + equals(emptyWorkspaceEdit), |
| 210 | + ); |
| 211 | + } |
| 212 | + |
133 | 213 | Future<void> test_rename_importPrefix() { |
134 | 214 | const content = ''' |
135 | 215 | import 'dart:async' as myPr^efix; |
@@ -237,17 +317,6 @@ class RenameTest extends AbstractLspAnalysisServerTest { |
237 | 317 | expect(error.message, contains('name must not contain')); |
238 | 318 | } |
239 | 319 |
|
240 | | - Future<void> test_rename_rejectedForDuplicateName() async { |
241 | | - const content = ''' |
242 | | - class MyOtherClass {} |
243 | | - class MyClass {} |
244 | | - final a = n^ew MyClass(); |
245 | | - '''; |
246 | | - final error = await _test_rename_failure(content, 'MyOtherClass'); |
247 | | - expect(error.code, equals(ServerErrorCodes.RenameNotValid)); |
248 | | - expect(error.message, contains('already declares class with name')); |
249 | | - } |
250 | | - |
251 | 320 | Future<void> test_rename_rejectedForSameName() async { |
252 | 321 | const content = ''' |
253 | 322 | class My^Class {} |
@@ -413,6 +482,55 @@ class RenameTest extends AbstractLspAnalysisServerTest { |
413 | 482 | return result.error; |
414 | 483 | } |
415 | 484 |
|
| 485 | + /// Tests a rename that is expected to cause an error, which will trigger |
| 486 | + /// a ShowMessageRequest from the server to the client to allow the refactor |
| 487 | + /// to be continued or rejected. |
| 488 | + Future<ResponseMessage> _test_rename_prompt( |
| 489 | + String content, |
| 490 | + String newName, { |
| 491 | + @required String expectedMessage, |
| 492 | + Future<void> Function() beforeResponding, |
| 493 | + @required String action, |
| 494 | + int openFileVersion = 222, |
| 495 | + int renameRequestFileVersion = 222, |
| 496 | + }) async { |
| 497 | + await initialize( |
| 498 | + workspaceCapabilities: |
| 499 | + withDocumentChangesSupport(emptyWorkspaceClientCapabilities), |
| 500 | + ); |
| 501 | + await openFile(mainFileUri, withoutMarkers(content), |
| 502 | + version: openFileVersion); |
| 503 | + |
| 504 | + // Expect the server to call us back with a ShowMessageRequest prompt about |
| 505 | + // the errors for us to accept/reject. |
| 506 | + return handleExpectedRequest( |
| 507 | + Method.window_showMessageRequest, |
| 508 | + ShowMessageRequestParams.fromJson, |
| 509 | + () => renameRaw( |
| 510 | + mainFileUri, |
| 511 | + renameRequestFileVersion, |
| 512 | + positionFromMarker(content), |
| 513 | + newName, |
| 514 | + ), |
| 515 | + handler: (ShowMessageRequestParams params) async { |
| 516 | + // Ensure the warning prompt is as expected. |
| 517 | + expect(params.type, equals(MessageType.Warning)); |
| 518 | + expect(params.message, equals(expectedMessage)); |
| 519 | + expect(params.actions, hasLength(2)); |
| 520 | + expect(params.actions[0], |
| 521 | + equals(MessageActionItem(title: UserPromptActions.renameAnyway))); |
| 522 | + expect(params.actions[1], |
| 523 | + equals(MessageActionItem(title: UserPromptActions.cancel))); |
| 524 | + |
| 525 | + // Allow the test to run some code before we send the response. |
| 526 | + await beforeResponding?.call(); |
| 527 | + |
| 528 | + // Respond to the request with the required action. |
| 529 | + return MessageActionItem(title: action); |
| 530 | + }, |
| 531 | + ); |
| 532 | + } |
| 533 | + |
416 | 534 | Future<void> _test_rename_withDocumentChanges( |
417 | 535 | String content, |
418 | 536 | String newName, |
|
0 commit comments