Skip to content

Commit e85e5b6

Browse files
bkonyicommit-bot@chromium.org
authored andcommitted
[ dart:io / package:vm_service ] Add httpEnableTimelineLogging extension and service events
- Added httpEnableTimelineLogging to the dart:io service extensions - Deprecated setHttpEnableTimelineLogging and getHttpEnableTimelineLogging - Send service event when HTTP timeline logging state has changed Change-Id: I56df249fcfb11d7041a40a7749d47f6ef8f97c10 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/163724 Reviewed-by: Kenzie Schmoll <[email protected]> Reviewed-by: Siva Annamalai <[email protected]> Commit-Queue: Ben Konyi <[email protected]>
1 parent 61f1bf9 commit e85e5b6

7 files changed

Lines changed: 99 additions & 9 deletions

File tree

‎pkg/vm_service/CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Changelog
22

3+
## 5.2.0
4+
- Added support for `dart:io` extensions version 1.3.
5+
- Added combination getter/setter `httpEnableTimelineLogging`.
6+
- Deprecated `getHttpEnableTimelineLogging` and `setHttpEnableTimelineLogging`.
7+
38
## 5.1.0
49
- Added support for `dart:io` extensions version 1.2.
510
- Added `getOpenFiles`, `getOpenFileById`, `getSpawnedProcesses`, and `getSpawnedProcessById` RPCs.

‎pkg/vm_service/lib/src/dart_io_extensions.dart‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ extension DartIOExtension on VmService {
4343
///
4444
/// Warning: The returned [Future] will not complete if the target isolate is paused
4545
/// and will only complete when the isolate is resumed.
46+
@Deprecated('Use httpEnableTimelineLogging instead.')
4647
Future<HttpTimelineLoggingState> getHttpEnableTimelineLogging(
4748
String isolateId) =>
4849
_callHelper('ext.dart.io.getHttpEnableTimelineLogging', isolateId);
@@ -51,11 +52,18 @@ extension DartIOExtension on VmService {
5152
///
5253
/// Warning: The returned [Future] will not complete if the target isolate is paused
5354
/// and will only complete when the isolate is resumed.
55+
@Deprecated('Use httpEnableTimelineLogging instead.')
5456
Future<Success> setHttpEnableTimelineLogging(String isolateId, bool enable) =>
5557
_callHelper('ext.dart.io.setHttpEnableTimelineLogging', isolateId, args: {
5658
'enable': enable,
5759
});
5860

61+
Future<HttpTimelineLoggingState> httpEnableTimelineLogging(String isolateId,
62+
[bool enable]) =>
63+
_callHelper('ext.dart.io.httpEnableTimelineLogging', isolateId, args: {
64+
if (enable != null) 'enable': enable,
65+
});
66+
5967
/// The `getOpenFiles` RPC is used to retrieve the list of files currently
6068
/// opened files by `dart:io` from a given isolate.
6169
Future<OpenFileList> getOpenFiles(String isolateId) => _callHelper(

‎pkg/vm_service/pubspec.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: vm_service
22
description: >-
33
A library to communicate with a service implementing the Dart VM
44
service protocol.
5-
version: 5.1.0+1
5+
version: 5.2.0
66

77
homepage: https://github.com/dart-lang/sdk/tree/master/pkg/vm_service
88

‎pkg/vm_service/test/http_enable_timeline_logging_service_test.dart‎

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
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+
import 'dart:async';
6+
57
import 'package:vm_service/vm_service.dart';
68
import 'package:vm_service/src/dart_io_extensions.dart';
79
import 'package:test/test.dart';
@@ -12,8 +14,34 @@ const String kSetHttpEnableTimelineLogging =
1214
'ext.dart.io.setHttpEnableTimelineLogging';
1315
const String kGetHttpEnableTimelineLogging =
1416
'ext.dart.io.getHttpEnableTimelineLogging';
17+
const String kHttpEnableTimelineLogging =
18+
'ext.dart.io.httpEnableTimelineLogging';
1519
Future<void> setup() async {}
1620

21+
Future<void> waitForStreamEvent(
22+
VmService service, IsolateRef isolateRef, bool state,
23+
{bool useSetter = true}) async {
24+
final completer = Completer<void>();
25+
final isolateId = isolateRef.id;
26+
StreamSubscription sub;
27+
sub = service.onExtensionEvent.listen((event) {
28+
expect(event.extensionKind, 'HttpTimelineLoggingStateChange');
29+
expect(event.extensionData.data['isolateId'], isolateRef.id);
30+
expect(event.extensionData.data['enabled'], state);
31+
sub.cancel();
32+
completer.complete();
33+
});
34+
await service.streamListen(EventStreams.kExtension);
35+
36+
if (useSetter) {
37+
await service.setHttpEnableTimelineLogging(isolateId, state);
38+
} else {
39+
await service.httpEnableTimelineLogging(isolateId, state);
40+
}
41+
await completer.future;
42+
await service.streamCancel(EventStreams.kExtension);
43+
}
44+
1745
var tests = <IsolateTest>[
1846
(VmService service, IsolateRef isolateRef) async {
1947
final isolate = await service.getIsolate(isolateRef.id);
@@ -23,22 +51,34 @@ var tests = <IsolateTest>[
2351
isolate.extensionRPCs.contains(kGetHttpEnableTimelineLogging), isTrue);
2452
expect(
2553
isolate.extensionRPCs.contains(kSetHttpEnableTimelineLogging), isTrue);
54+
expect(isolate.extensionRPCs.contains(kHttpEnableTimelineLogging), isTrue);
2655
},
2756
(VmService service, IsolateRef isolateRef) async {
2857
final isolateId = isolateRef.id;
2958
dynamic response = await service.getHttpEnableTimelineLogging(isolateId);
3059
expect(response.enabled, false);
3160

32-
await service.setHttpEnableTimelineLogging(isolateId, true);
33-
61+
await waitForStreamEvent(service, isolateRef, true);
3462
response = await service.getHttpEnableTimelineLogging(isolateId);
3563
expect(response.enabled, true);
3664

37-
await service.setHttpEnableTimelineLogging(isolateId, false);
38-
65+
await waitForStreamEvent(service, isolateRef, false);
3966
response = await service.getHttpEnableTimelineLogging(isolateId);
4067
expect(response.enabled, false);
4168
},
69+
(VmService service, IsolateRef isolateRef) async {
70+
final isolateId = isolateRef.id;
71+
dynamic response = await service.httpEnableTimelineLogging(isolateId, null);
72+
expect(response.enabled, false);
73+
74+
await waitForStreamEvent(service, isolateRef, true, useSetter: false);
75+
response = await service.httpEnableTimelineLogging(isolateId, null);
76+
expect(response.enabled, true);
77+
78+
await waitForStreamEvent(service, isolateRef, false, useSetter: false);
79+
response = await service.httpEnableTimelineLogging(isolateId);
80+
expect(response.enabled, false);
81+
},
4282
];
4383

4484
main([args = const <String>[]]) async =>

‎runtime/vm/service/service_extension.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@ the socket profiler. Only samples collected after the initial [startSocketProfil
108108
### getHttpEnableTimelineLogging
109109

110110
```
111+
@Deprecated
111112
HttpTimelineLoggingState getHttpEnableTimelineLogging(string isolateId)
112113
```
113114

@@ -120,6 +121,7 @@ See [HttpTimelineLoggingState](#httptimelineloggingstate).
120121
### setHttpEnableTimelineLogging
121122

122123
```
124+
@Deprecated
123125
Success setHttpEnableTimelineLogging(string isolateId, bool enable)
124126
```
125127

@@ -130,6 +132,22 @@ timeline logging for the isolate specified by `isolateId`.
130132

131133
See [Success](#success).
132134

135+
### httpEnableTimelineLogging
136+
137+
```
138+
HttpTimelineLoggingState httpEnableTimelineLogging(string isolateId, bool enable [optional])
139+
```
140+
141+
The _httpEnableTimelineLogging_ RPC is used to set and inspect the value of
142+
`HttpClient.enableTimelineLogging`, which determines if HTTP client requests
143+
should be logged to the timeline. If `enable` is provided, the state of
144+
`HttpClient.enableTimelineLogging` will be updated to the value of `enable`.
145+
146+
If the value of `HttpClient.enableTimelineLogging` is changed, a
147+
`HttpTimelineLoggingStateChange` event will be sent on the `Extension` stream.
148+
149+
See [HttpTimelineLoggingState](#httptimelineloggingstate).
150+
133151
## Public Types
134152

135153
### File
@@ -325,3 +343,4 @@ version | comments
325343
1.0 | Initial revision.
326344
1.1 | Added `lastReadTime` and `lastWriteTime` properties to `SocketStatistic`.
327345
1.2 | Added `getOpenFiles`, `getOpenFileById`, `getSpawnedProcesses`, and `getSpawnedProcessById` RPCs and added `OpenFile` and `SpawnedProcess` objects.
346+
1.3 | Added `httpEnableTimelineLogging` RPC and `HttpTimelineLoggingStateChange` event, deprecated `getHttpEnableTimelineLogging` and `setHttpEnableTimelineLogging`.

‎sdk/lib/_http/http.dart‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ import 'dart:convert';
1818
import 'dart:developer' hide log;
1919
import 'dart:_internal'
2020
show Since, valueOfNonNullableParamWithDefault, HttpStatus;
21+
import 'dart:isolate' show Isolate;
2122
import 'dart:math';
2223
import 'dart:io';
2324
import 'dart:typed_data';
@@ -1473,8 +1474,14 @@ abstract class HttpClient {
14731474
///
14741475
/// Default is `false`.
14751476
static set enableTimelineLogging(bool value) {
1476-
_enableTimelineLogging =
1477-
valueOfNonNullableParamWithDefault<bool>(value, false);
1477+
final enabled = valueOfNonNullableParamWithDefault<bool>(value, false);
1478+
if (enabled != _enableTimelineLogging) {
1479+
postEvent('HttpTimelineLoggingStateChange', {
1480+
'isolateId': Service.getIsolateID(Isolate.current),
1481+
'enabled': enabled,
1482+
});
1483+
}
1484+
_enableTimelineLogging = enabled;
14781485
}
14791486

14801487
/// Current state of HTTP request logging from all [HttpClient]s to the

‎sdk/lib/io/network_profiling.dart‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,22 @@ part of dart.io;
66

77
// TODO(bkonyi): refactor into io_resource_info.dart
88
const int _versionMajor = 1;
9-
const int _versionMinor = 2;
9+
const int _versionMinor = 3;
1010

1111
const String _tcpSocket = 'tcp';
1212
const String _udpSocket = 'udp';
1313

1414
@pragma('vm:entry-point', !const bool.fromEnvironment("dart.vm.product"))
1515
abstract class _NetworkProfiling {
1616
// Http relative RPCs
17+
@Deprecated('Use httpEnableTimelineLogging instead')
1718
static const _kGetHttpEnableTimelineLogging =
1819
'ext.dart.io.getHttpEnableTimelineLogging';
20+
@Deprecated('Use httpEnableTimelineLogging instead')
1921
static const _kSetHttpEnableTimelineLogging =
2022
'ext.dart.io.setHttpEnableTimelineLogging';
23+
static const _kHttpEnableTimelineLogging =
24+
'ext.dart.io.httpEnableTimelineLogging';
2125
// Socket relative RPCs
2226
static const _kClearSocketProfileRPC = 'ext.dart.io.clearSocketProfile';
2327
static const _kGetSocketProfileRPC = 'ext.dart.io.getSocketProfile';
@@ -33,6 +37,7 @@ abstract class _NetworkProfiling {
3337
static void _registerServiceExtension() {
3438
registerExtension(_kGetHttpEnableTimelineLogging, _serviceExtensionHandler);
3539
registerExtension(_kSetHttpEnableTimelineLogging, _serviceExtensionHandler);
40+
registerExtension(_kHttpEnableTimelineLogging, _serviceExtensionHandler);
3641
registerExtension(_kGetSocketProfileRPC, _serviceExtensionHandler);
3742
registerExtension(_kStartSocketProfilingRPC, _serviceExtensionHandler);
3843
registerExtension(_kPauseSocketProfilingRPC, _serviceExtensionHandler);
@@ -51,6 +56,12 @@ abstract class _NetworkProfiling {
5156
case _kSetHttpEnableTimelineLogging:
5257
responseJson = _setHttpEnableTimelineLogging(parameters);
5358
break;
59+
case _kHttpEnableTimelineLogging:
60+
if (parameters.containsKey('enable')) {
61+
_setHttpEnableTimelineLogging(parameters);
62+
}
63+
responseJson = _getHttpEnableTimelineLogging();
64+
break;
5465
case _kGetSocketProfileRPC:
5566
responseJson = _SocketProfile.toJson();
5667
break;
@@ -108,7 +119,7 @@ String _setHttpEnableTimelineLogging(Map<String, String> parameters) {
108119
if (enable != 'true' && enable != 'false') {
109120
throw _invalidArgument(kEnable, enable);
110121
}
111-
HttpClient.enableTimelineLogging = (enable == 'true');
122+
HttpClient.enableTimelineLogging = enable == 'true';
112123
return _success();
113124
}
114125

0 commit comments

Comments
 (0)