Skip to content

Commit 6d9cb5e

Browse files
committed
Move diagnostics to diagnostics domain (#24931).
Still flagged `experimental` so no docs created. See: #24931 BUG=24931 [email protected] Review URL: https://codereview.chromium.org/1453433002 .
1 parent c295410 commit 6d9cb5e

File tree

9 files changed

+53
-53
lines changed

9 files changed

+53
-53
lines changed

pkg/analysis_server/lib/plugin/protocol/generated_protocol.dart

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7422,39 +7422,39 @@ class ExecutionLaunchDataParams implements HasToJson {
74227422
}
74237423
}
74247424
/**
7425-
* experimental.getDiagnostics params
7425+
* diagnostic.getDiagnostics params
74267426
*
74277427
* Clients may not extend, implement or mix-in this class.
74287428
*/
7429-
class ExperimentalGetDiagnosticsParams {
7429+
class DiagnosticGetDiagnosticsParams {
74307430
Request toRequest(String id) {
7431-
return new Request(id, "experimental.getDiagnostics", null);
7431+
return new Request(id, "diagnostic.getDiagnostics", null);
74327432
}
74337433

74347434
@override
74357435
bool operator==(other) {
7436-
if (other is ExperimentalGetDiagnosticsParams) {
7436+
if (other is DiagnosticGetDiagnosticsParams) {
74377437
return true;
74387438
}
74397439
return false;
74407440
}
74417441

74427442
@override
74437443
int get hashCode {
7444-
return 876666064;
7444+
return 587526202;
74457445
}
74467446
}
74477447

74487448
/**
7449-
* experimental.getDiagnostics result
7449+
* diagnostic.getDiagnostics result
74507450
*
74517451
* {
74527452
* "contexts": List<ContextData>
74537453
* }
74547454
*
74557455
* Clients may not extend, implement or mix-in this class.
74567456
*/
7457-
class ExperimentalGetDiagnosticsResult implements HasToJson {
7457+
class DiagnosticGetDiagnosticsResult implements HasToJson {
74587458
List<ContextData> _contexts;
74597459

74607460
/**
@@ -7470,11 +7470,11 @@ class ExperimentalGetDiagnosticsResult implements HasToJson {
74707470
this._contexts = value;
74717471
}
74727472

7473-
ExperimentalGetDiagnosticsResult(List<ContextData> contexts) {
7473+
DiagnosticGetDiagnosticsResult(List<ContextData> contexts) {
74747474
this.contexts = contexts;
74757475
}
74767476

7477-
factory ExperimentalGetDiagnosticsResult.fromJson(JsonDecoder jsonDecoder, String jsonPath, Object json) {
7477+
factory DiagnosticGetDiagnosticsResult.fromJson(JsonDecoder jsonDecoder, String jsonPath, Object json) {
74787478
if (json == null) {
74797479
json = {};
74807480
}
@@ -7485,14 +7485,14 @@ class ExperimentalGetDiagnosticsResult implements HasToJson {
74857485
} else {
74867486
throw jsonDecoder.missingKey(jsonPath, "contexts");
74877487
}
7488-
return new ExperimentalGetDiagnosticsResult(contexts);
7488+
return new DiagnosticGetDiagnosticsResult(contexts);
74897489
} else {
7490-
throw jsonDecoder.mismatch(jsonPath, "experimental.getDiagnostics result", json);
7490+
throw jsonDecoder.mismatch(jsonPath, "diagnostic.getDiagnostics result", json);
74917491
}
74927492
}
74937493

7494-
factory ExperimentalGetDiagnosticsResult.fromResponse(Response response) {
7495-
return new ExperimentalGetDiagnosticsResult.fromJson(
7494+
factory DiagnosticGetDiagnosticsResult.fromResponse(Response response) {
7495+
return new DiagnosticGetDiagnosticsResult.fromJson(
74967496
new ResponseDecoder(REQUEST_ID_REFACTORING_KINDS.remove(response.id)), "result", response._result);
74977497
}
74987498

@@ -7511,7 +7511,7 @@ class ExperimentalGetDiagnosticsResult implements HasToJson {
75117511

75127512
@override
75137513
bool operator==(other) {
7514-
if (other is ExperimentalGetDiagnosticsResult) {
7514+
if (other is DiagnosticGetDiagnosticsResult) {
75157515
return listEqual(contexts, other.contexts, (ContextData a, ContextData b) => a == b);
75167516
}
75177517
return false;

pkg/analysis_server/lib/src/domain_experimental.dart renamed to pkg/analysis_server/lib/src/domain_diagnostic.dart

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// for details. All rights reserved. Use of this source code is governed by a
33
// BSD-style license that can be found in the LICENSE file.
44

5-
library src.domain_experimental;
5+
library src.domain_diagnostic;
66

77
import 'dart:collection';
88
import 'dart:core' hide Resource;
@@ -57,34 +57,34 @@ ContextData extractData(AnalysisContext context) {
5757
exceptions.toList());
5858
}
5959

60-
/// Instances of the class [ExperimentalDomainHandler] implement a
61-
/// [RequestHandler] that handles requests in the `experimental` domain.
62-
class ExperimentalDomainHandler implements RequestHandler {
60+
/// Instances of the class [DiagnosticDomainHandler] implement a
61+
/// [RequestHandler] that handles requests in the `diagnostic` domain.
62+
class DiagnosticDomainHandler implements RequestHandler {
6363
/// The name of the request used to get diagnostic information.
64-
static const String EXPERIMENTAL_DIAGNOSTICS = 'experimental.getDiagnostics';
64+
static const String DIAGNOSTICS = 'diagnostic.getDiagnostics';
6565

6666
/// The analysis server that is using this handler to process requests.
6767
final AnalysisServer server;
6868

6969
/// Initialize a newly created handler to handle requests for the given
7070
/// [server].
71-
ExperimentalDomainHandler(this.server);
71+
DiagnosticDomainHandler(this.server);
7272

73-
/// Answer the `experimental.diagnostics` request.
73+
/// Answer the `diagnostic.diagnostics` request.
7474
Response computeDiagnostics(Request request) {
7575
List<ContextData> infos = <ContextData>[];
7676
server.folderMap.forEach((Folder folder, AnalysisContext context) {
7777
infos.add(extractData(context));
7878
});
7979

80-
return new ExperimentalGetDiagnosticsResult(infos).toResponse(request.id);
80+
return new DiagnosticGetDiagnosticsResult(infos).toResponse(request.id);
8181
}
8282

8383
@override
8484
Response handleRequest(Request request) {
8585
try {
8686
String requestName = request.method;
87-
if (requestName == EXPERIMENTAL_DIAGNOSTICS) {
87+
if (requestName == DIAGNOSTICS) {
8888
return computeDiagnostics(request);
8989
}
9090
} on RequestFailure catch (exception) {

pkg/analysis_server/lib/src/plugin/server_plugin.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ import 'package:analysis_server/plugin/protocol/protocol.dart';
2020
import 'package:analysis_server/src/analysis_server.dart';
2121
import 'package:analysis_server/src/domain_analysis.dart';
2222
import 'package:analysis_server/src/domain_completion.dart';
23+
import 'package:analysis_server/src/domain_diagnostic.dart';
2324
import 'package:analysis_server/src/domain_execution.dart';
24-
import 'package:analysis_server/src/domain_experimental.dart';
2525
import 'package:analysis_server/src/domain_server.dart';
2626
import 'package:analysis_server/src/domains/analysis/navigation_dart.dart';
2727
import 'package:analysis_server/src/domains/analysis/occurrences_dart.dart';
@@ -316,7 +316,7 @@ class ServerPlugin implements Plugin {
316316
registerExtension(domainId,
317317
(AnalysisServer server) => new ExecutionDomainHandler(server));
318318
registerExtension(domainId,
319-
(AnalysisServer server) => new ExperimentalDomainHandler(server));
319+
(AnalysisServer server) => new DiagnosticDomainHandler(server));
320320
//
321321
// Register fix contributors.
322322
//

pkg/analysis_server/test/domain_experimental_test.dart renamed to pkg/analysis_server/test/domain_diagnostic_test.dart

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
// for details. All rights reserved. Use of this source code is governed by a
33
// BSD-style license that can be found in the LICENSE file.
44

5-
library test.domain.experimental;
5+
library test.domain.diagnostic;
66

77
import 'package:analysis_server/plugin/protocol/protocol.dart';
88
import 'package:analysis_server/src/analysis_server.dart';
9-
import 'package:analysis_server/src/domain_experimental.dart';
9+
import 'package:analysis_server/src/domain_diagnostic.dart';
1010
import 'package:analysis_server/src/plugin/server_plugin.dart';
1111
import 'package:analyzer/file_system/memory_file_system.dart';
1212
import 'package:analyzer/instrumentation/instrumentation.dart';
@@ -19,7 +19,7 @@ import 'utils.dart';
1919

2020
main() {
2121
AnalysisServer server;
22-
ExperimentalDomainHandler handler;
22+
DiagnosticDomainHandler handler;
2323
MemoryResourceProvider resourceProvider;
2424

2525
initializeTestEnvironment();
@@ -39,10 +39,10 @@ main() {
3939
new AnalysisServerOptions(),
4040
new MockSdk(),
4141
InstrumentationService.NULL_SERVICE);
42-
handler = new ExperimentalDomainHandler(server);
42+
handler = new DiagnosticDomainHandler(server);
4343
});
4444

45-
group('ExperimentalDomainHandler', () {
45+
group('DiagnosticDomainHandler', () {
4646
test('getDiagnostics', () async {
4747
String file = '/project/bin/test.dart';
4848
resourceProvider.newFile('/project/pubspec.yaml', 'name: project');
@@ -52,7 +52,7 @@ main() {
5252

5353
await server.onAnalysisComplete;
5454

55-
var request = new ExperimentalGetDiagnosticsParams().toRequest('0');
55+
var request = new DiagnosticGetDiagnosticsParams().toRequest('0');
5656
var response = handler.handleRequest(request);
5757

5858
int fileCount = MockSdk.LIBRARIES.length + 1 /* test.dart */;
@@ -67,7 +67,7 @@ main() {
6767
});
6868

6969
test('getDiagnostics - (no root)', () async {
70-
var request = new ExperimentalGetDiagnosticsParams().toRequest('0');
70+
var request = new DiagnosticGetDiagnosticsParams().toRequest('0');
7171
var response = handler.handleRequest(request);
7272
var json = response.toJson()[Response.RESULT];
7373
expect(json['contexts'], hasLength(0));

pkg/analysis_server/test/integration/integration_test_methods.dart

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1637,11 +1637,11 @@ abstract class IntegrationTestMixin {
16371637
*
16381638
* The list of analysis contexts.
16391639
*/
1640-
Future<ExperimentalGetDiagnosticsResult> sendExperimentalGetDiagnostics() {
1641-
return server.send("experimental.getDiagnostics", null)
1640+
Future<DiagnosticGetDiagnosticsResult> sendDiagnosticGetDiagnostics() {
1641+
return server.send("diagnostic.getDiagnostics", null)
16421642
.then((result) {
16431643
ResponseDecoder decoder = new ResponseDecoder(null);
1644-
return new ExperimentalGetDiagnosticsResult.fromJson(decoder, 'result', result);
1644+
return new DiagnosticGetDiagnosticsResult.fromJson(decoder, 'result', result);
16451645
});
16461646
}
16471647

pkg/analysis_server/test/integration/protocol_matchers.dart

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1007,19 +1007,19 @@ final Matcher isExecutionLaunchDataParams = new LazyMatcher(() => new MatchesJso
10071007
}));
10081008

10091009
/**
1010-
* experimental.getDiagnostics params
1010+
* diagnostic.getDiagnostics params
10111011
*/
1012-
final Matcher isExperimentalGetDiagnosticsParams = isNull;
1012+
final Matcher isDiagnosticGetDiagnosticsParams = isNull;
10131013

10141014
/**
1015-
* experimental.getDiagnostics result
1015+
* diagnostic.getDiagnostics result
10161016
*
10171017
* {
10181018
* "contexts": List<ContextData>
10191019
* }
10201020
*/
1021-
final Matcher isExperimentalGetDiagnosticsResult = new LazyMatcher(() => new MatchesJsonObject(
1022-
"experimental.getDiagnostics result", {
1021+
final Matcher isDiagnosticGetDiagnosticsResult = new LazyMatcher(() => new MatchesJsonObject(
1022+
"diagnostic.getDiagnostics result", {
10231023
"contexts": isListOf(isContextData)
10241024
}));
10251025

pkg/analysis_server/test/test_all.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ import 'channel/test_all.dart' as channel_test;
1010
import 'context_manager_test.dart' as context_manager_test;
1111
import 'domain_analysis_test.dart' as domain_analysis_test;
1212
import 'domain_completion_test.dart' as domain_completion_test;
13+
import 'domain_diagnostic_test.dart' as domain_experimental_test;
1314
import 'domain_execution_test.dart' as domain_execution_test;
14-
import 'domain_experimental_test.dart' as domain_experimental_test;
1515
import 'domain_server_test.dart' as domain_server_test;
1616
import 'edit/test_all.dart' as edit_all;
1717
import 'operation/test_all.dart' as operation_test_all;

pkg/analysis_server/tool/spec/generated/java/AnalysisServer.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,13 @@ public interface AnalysisServer {
272272
*/
273273
public void completion_getSuggestions(String file, int offset, GetSuggestionsConsumer consumer);
274274

275+
/**
276+
* {@code diagnostic.getDiagnostics}
277+
*
278+
* Return server diagnostics.
279+
*/
280+
public void diagnostic_getDiagnostics(GetDiagnosticsConsumer consumer);
281+
275282
/**
276283
* {@code edit.format}
277284
*
@@ -442,13 +449,6 @@ public interface AnalysisServer {
442449
*/
443450
public void execution_setSubscriptions(List<String> subscriptions);
444451

445-
/**
446-
* {@code experimental.getDiagnostics}
447-
*
448-
* Return server diagnostics.
449-
*/
450-
public void experimental_getDiagnostics(GetDiagnosticsConsumer consumer);
451-
452452
/**
453453
* Return {@code true} if the socket is open.
454454
*/

pkg/analysis_server/tool/spec/spec_input.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1959,12 +1959,12 @@ <h4>Options</h4>
19591959
</params>
19601960
</notification>
19611961
</domain>
1962-
<domain name="experimental" experimental="true">
1962+
<domain name="diagnostic" experimental="true">
19631963
<p>
1964-
The experimental domain contains experimental server APIs. Experimental
1965-
APIs are not considered to be part of the analysis server's API, docs are
1966-
not generated for them and they are subject to change without notice.
1967-
Because the experimental domain is not part of the analysis server's API,
1964+
The diagnostic domain contains experimental server diagnostics APIs. Note
1965+
that as an experimental API, docs are not generated for this domain and it
1966+
is subject subject to change without notice.
1967+
Because this experimental domain is not part of the analysis server's API,
19681968
the version number of the API will not be updated when changes are made.
19691969
Caveat emptor!
19701970
</p>

0 commit comments

Comments
 (0)