Skip to content

Commit 93c9eba

Browse files
bkonyicommit-bot@chromium.org
authored andcommitted
[ VM / dart:io / Service ] Add service extension RPCs to dart:io to allow for HttpClient.enableTimelineLogging to be set remotely.
It isn't possible to do this with evaluate since we are unable to access classes from private libraries exposed through dart:io like dart:_http. Change-Id: I3d4168d919dbcf5008da60b14165fd9b89f22cad Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/129322 Commit-Queue: Ben Konyi <[email protected]> Reviewed-by: Siva Annamalai <[email protected]>
1 parent d045748 commit 93c9eba

6 files changed

Lines changed: 241 additions & 95 deletions

File tree

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
// Copyright (c) 2019, the Dart project authors. Please see the AUTHORS file
2+
// for details. All rights reserved. Use of this source code is governed by a
3+
// BSD-style license that can be found in the LICENSE file.
4+
5+
import 'dart:async';
6+
import 'package:observatory/service_io.dart';
7+
import 'package:unittest/unittest.dart';
8+
import 'service_test_common.dart';
9+
import 'test_helper.dart';
10+
11+
const String kSetHttpEnableTimelineLogging =
12+
'ext.dart.io.setHttpEnableTimelineLogging';
13+
const String kGetHttpEnableTimelineLogging =
14+
'ext.dart.io.getHttpEnableTimelineLogging';
15+
Future<void> setup() async {}
16+
17+
var tests = <IsolateTest>[
18+
(Isolate isolate) async {
19+
await isolate.load();
20+
// Ensure all HTTP service extensions are registered.
21+
expect(isolate.extensionRPCs.length, greaterThanOrEqualTo(2));
22+
expect(
23+
isolate.extensionRPCs.contains(kGetHttpEnableTimelineLogging), isTrue);
24+
expect(
25+
isolate.extensionRPCs.contains(kSetHttpEnableTimelineLogging), isTrue);
26+
},
27+
(Isolate isolate) async {
28+
await isolate.load();
29+
var response =
30+
await isolate.invokeRpcNoUpgrade(kGetHttpEnableTimelineLogging, {});
31+
expect(response['type'], 'HttpTimelineLoggingState');
32+
expect(response['enabled'], false);
33+
34+
response = await isolate
35+
.invokeRpcNoUpgrade(kSetHttpEnableTimelineLogging, {'enable': true});
36+
expect(response['type'], 'Success');
37+
38+
response =
39+
await isolate.invokeRpcNoUpgrade(kGetHttpEnableTimelineLogging, {});
40+
expect(response['type'], 'HttpTimelineLoggingState');
41+
expect(response['enabled'], true);
42+
43+
response = await isolate
44+
.invokeRpcNoUpgrade(kSetHttpEnableTimelineLogging, {'enable': false});
45+
expect(response['type'], 'Success');
46+
47+
response =
48+
await isolate.invokeRpcNoUpgrade(kGetHttpEnableTimelineLogging, {});
49+
expect(response['type'], 'HttpTimelineLoggingState');
50+
expect(response['enabled'], false);
51+
},
52+
(Isolate isolate) async {
53+
// Bad argument.
54+
try {
55+
await isolate
56+
.invokeRpcNoUpgrade(kSetHttpEnableTimelineLogging, {'enable': 'foo'});
57+
} catch (e) {/* expected */}
58+
// Missing argument.
59+
try {
60+
await isolate.invokeRpcNoUpgrade(kSetHttpEnableTimelineLogging, {});
61+
} catch (e) {/* expected */}
62+
},
63+
];
64+
65+
main(args) async => runIsolateTests(args, tests, testeeBefore: setup);

‎runtime/vm/service/service_extension.md‎

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This section describes _version 1.1_ of the dart:io service protocol extensions.
1515
### getVersion
1616

1717
```
18-
Version getVersion()
18+
Version getVersion(string isolateId)
1919
```
2020

2121
The _getVersion_ RPC returns the available version of the dart:io service protocol extensions.
@@ -25,7 +25,7 @@ See [Version](#version).
2525
### startSocketProfiling
2626

2727
```
28-
Success startSocketProfiling()
28+
Success startSocketProfiling(string isolateId)
2929
```
3030

3131
Start profiling new socket connections. Statistics for sockets created before profiling was enabled will not be recorded.
@@ -35,7 +35,7 @@ See [Success](#success).
3535
### pauseSocketProfiling
3636

3737
```
38-
Success pauseSocketProfiling()
38+
Success pauseSocketProfiling(string isolateId)
3939
```
4040

4141
Pause recording socket statistics. [clearSocketProfile](#clearsocketprofile) must be called in order for collected statistics to be cleared.
@@ -45,7 +45,7 @@ See [Success](#success).
4545
### clearSocketProfile
4646

4747
```
48-
Success clearSocketProfile()
48+
Success clearSocketProfile(string isolateId)
4949
```
5050

5151
Removes all statistics associated with prior and current sockets.
@@ -55,12 +55,37 @@ See [Success](#success).
5555
### getSocketProfile
5656

5757
```
58-
SocketProfile getSocketProfile()
58+
SocketProfile getSocketProfile(string isolateId)
5959
```
6060

6161
The _getSocketProfile_ RPC is used to retrieve socket statistics collected by
6262
the socket profiler. Only samples collected after the initial [startSocketProfiling](#startsocketprofiling) or the last call to [clearSocketProfile](#clearsocketprofile) will be reported.
6363

64+
### getHttpEnableTimelineLogging
65+
66+
```
67+
HttpTimelineLoggingState getHttpEnableTimelineLogging(string isolateId)
68+
```
69+
70+
The _getHttpEnableTimelineLogging_ RPC is used to remotely inspect the value of
71+
`HttpClient.enableTimelineLogging`, which determines if HTTP client requests
72+
should be logged to the timeline.
73+
74+
See [HttpTimelineLoggingState](#httptimelineloggingstate).
75+
76+
### setHttpEnableTimelineLogging
77+
78+
```
79+
Success setHttpEnableTimelineLogging(string isolateId, bool enable)
80+
```
81+
82+
The _setHttpEnableTimelineLogging_ RPC is used to remotely set the value of
83+
`HttpClient.enableTimelineLogging`, which determines if HTTP client requests
84+
should be logged to the timeline. Note: this will only change the state of HTTP
85+
timeline logging for the isolate specified by `isolateId`.
86+
87+
See [Success](#success).
88+
6489
## Public Types
6590

6691
### Response
@@ -107,13 +132,13 @@ class SocketStatistic {
107132
int lastWriteTime [optional];
108133
109134
// The address of socket.
110-
String address;
135+
string address;
111136
112137
// The port of socket.
113138
int port;
114139
115140
// The type of socket. The value is `tcp` or `udp`.
116-
String socketType;
141+
string socketType;
117142
118143
// The number of bytes read from this socket.
119144
int readBytes;

‎sdk/lib/io/io.dart‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,7 @@ import 'dart:collection'
193193
show HashMap, HashSet, Queue, ListQueue, MapBase, UnmodifiableMapView;
194194
import 'dart:convert';
195195
import 'dart:developer' hide log;
196+
import 'dart:_http' show HttpClient;
196197
import 'dart:isolate';
197198
import 'dart:math';
198199
import 'dart:typed_data';

‎sdk/lib/io/network_profiling.dart‎

Lines changed: 71 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,19 @@
66

77
part of dart.io;
88

9+
const int _versionMajor = 1;
10+
const int _versionMinor = 1;
11+
912
const String _tcpSocket = 'tcp';
1013
const String _udpSocket = 'udp';
1114

1215
@pragma('vm:entry-point', !const bool.fromEnvironment("dart.vm.product"))
1316
abstract class _NetworkProfiling {
1417
// Http relative RPCs
15-
static const _kGetHttpProfileRPC = 'ext.dart.io.getHttpProfile';
18+
static const _kGetHttpEnableTimelineLogging =
19+
'ext.dart.io.getHttpEnableTimelineLogging';
20+
static const _kSetHttpEnableTimelineLogging =
21+
'ext.dart.io.setHttpEnableTimelineLogging';
1622
// Socket relative RPCs
1723
static const _kClearSocketProfileRPC = 'ext.dart.io.clearSocketProfile';
1824
static const _kGetSocketProfileRPC = 'ext.dart.io.getSocketProfile';
@@ -26,7 +32,8 @@ abstract class _NetworkProfiling {
2632

2733
@pragma('vm:entry-point')
2834
static void _registerServiceExtension() {
29-
registerExtension(_kGetHttpProfileRPC, _serviceExtensionHandler);
35+
registerExtension(_kGetHttpEnableTimelineLogging, _serviceExtensionHandler);
36+
registerExtension(_kSetHttpEnableTimelineLogging, _serviceExtensionHandler);
3037
registerExtension(_kGetSocketProfileRPC, _serviceExtensionHandler);
3138
registerExtension(_kStartSocketProfilingRPC, _serviceExtensionHandler);
3239
registerExtension(_kPauseSocketProfilingRPC, _serviceExtensionHandler);
@@ -36,50 +43,74 @@ abstract class _NetworkProfiling {
3643

3744
static Future<ServiceExtensionResponse> _serviceExtensionHandler(
3845
String method, Map<String, String> parameters) {
39-
String responseJson;
40-
switch (method) {
41-
case _kGetHttpProfileRPC:
42-
responseJson = _HttpProfile.toJson();
43-
break;
44-
case _kGetSocketProfileRPC:
45-
responseJson = _SocketProfile.toJson();
46-
break;
47-
case _kStartSocketProfilingRPC:
48-
responseJson = _SocketProfile.start();
49-
break;
50-
case _kPauseSocketProfilingRPC:
51-
responseJson = _SocketProfile.pause();
52-
break;
53-
case _kClearSocketProfileRPC:
54-
responseJson = _SocketProfile.clear();
55-
break;
56-
case _kGetVersionRPC:
57-
responseJson = getVersion();
58-
break;
59-
default:
60-
return Future.value(ServiceExtensionResponse.error(
61-
ServiceExtensionResponse.extensionError,
62-
'Method $method does not exist'));
46+
try {
47+
String responseJson;
48+
switch (method) {
49+
case _kGetHttpEnableTimelineLogging:
50+
responseJson = _getHttpEnableTimelineLogging();
51+
break;
52+
case _kSetHttpEnableTimelineLogging:
53+
responseJson = _setHttpEnableTimelineLogging(parameters);
54+
break;
55+
case _kGetSocketProfileRPC:
56+
responseJson = _SocketProfile.toJson();
57+
break;
58+
case _kStartSocketProfilingRPC:
59+
responseJson = _SocketProfile.start();
60+
break;
61+
case _kPauseSocketProfilingRPC:
62+
responseJson = _SocketProfile.pause();
63+
break;
64+
case _kClearSocketProfileRPC:
65+
responseJson = _SocketProfile.clear();
66+
break;
67+
case _kGetVersionRPC:
68+
responseJson = getVersion();
69+
break;
70+
default:
71+
return Future.value(ServiceExtensionResponse.error(
72+
ServiceExtensionResponse.extensionError,
73+
'Method $method does not exist'));
74+
}
75+
return Future.value(ServiceExtensionResponse.result(responseJson));
76+
} catch (errorMessage) {
77+
return Future.value(ServiceExtensionResponse.error(
78+
ServiceExtensionResponse.invalidParams, errorMessage));
6379
}
64-
return Future.value(ServiceExtensionResponse.result(responseJson));
6580
}
6681

6782
static String getVersion() => json.encode({
6883
'type': 'Version',
69-
'major': 1,
70-
'minor': 1,
84+
'major': _versionMajor,
85+
'minor': _versionMinor,
7186
});
7287
}
7388

74-
abstract class _HttpProfile {
75-
static const _kType = 'HttpProfile';
76-
// TODO(bkonyi): implement.
77-
static String toJson() {
78-
final response = <String, dynamic>{
79-
'type': _kType,
80-
};
81-
return json.encode(response);
89+
String _success() => json.encode({
90+
'type': 'Success',
91+
});
92+
93+
String _invalidArgument(String argument, dynamic value) =>
94+
"Value for parameter '$argument' is not valid: $value";
95+
96+
String _missingArgument(String argument) => "Parameter '$argument' is required";
97+
98+
String _getHttpEnableTimelineLogging() => json.encode({
99+
'type': 'HttpTimelineLoggingState',
100+
'enabled': HttpClient.enableTimelineLogging,
101+
});
102+
103+
String _setHttpEnableTimelineLogging(Map<String, String> parameters) {
104+
const String kEnable = 'enable';
105+
if (!parameters.containsKey(kEnable)) {
106+
throw _missingArgument(kEnable);
107+
}
108+
final enable = parameters[kEnable].toLowerCase();
109+
if (enable != 'true' && enable != 'false') {
110+
throw _invalidArgument(kEnable, enable);
82111
}
112+
HttpClient.enableTimelineLogging = (enable == 'true');
113+
return _success();
83114
}
84115

85116
abstract class _SocketProfile {
@@ -151,23 +182,19 @@ abstract class _SocketProfile {
151182

152183
static String start() {
153184
_enableSocketProfiling = true;
154-
return success();
185+
return _success();
155186
}
156187

157188
static String pause() {
158189
_enableSocketProfiling = false;
159-
return success();
190+
return _success();
160191
}
161192

162193
// clear the storage if _idToSocketStatistic has been initialized.
163194
static String clear() {
164195
_idToSocketStatistic?.clear();
165-
return success();
196+
return _success();
166197
}
167-
168-
static String success() => json.encode({
169-
'type': 'Success',
170-
});
171198
}
172199

173200
/// The [_SocketProfileType] is used as a parameter for

‎sdk_nnbd/lib/io/io.dart‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,7 @@ import 'dart:collection'
193193
show HashMap, HashSet, Queue, ListQueue, MapBase, UnmodifiableMapView;
194194
import 'dart:convert';
195195
import 'dart:developer' hide log;
196+
import 'dart:_http' show HttpClient;
196197
import 'dart:isolate';
197198
import 'dart:math';
198199
import 'dart:typed_data';

0 commit comments

Comments
 (0)