Skip to content

Register Service Extension for Events #1330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions dwds/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

- Add global functions to the injected client for `dart.developer.postEvent`
and `dart.developer.registerExtension`.
- Register new service extension `ext.dwds.emitEvent` so clients can emit
events. This is intended to be used for analytics.

## 11.0.2

Expand Down
8 changes: 8 additions & 0 deletions dwds/lib/src/dwds_vm_client.dart
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import 'package:logging/logging.dart';
import 'package:vm_service/vm_service.dart';
import 'package:webkit_inspection_protocol/webkit_inspection_protocol.dart';

import 'events.dart';
import 'services/chrome_proxy_service.dart' show ChromeProxyService;
import 'services/debug_service.dart';

Expand Down Expand Up @@ -153,6 +154,13 @@ class DwdsVmClient {
});
await client.registerService('ext.dwds.screenshot', 'DWDS');

client.registerServiceCallback('ext.dwds.emitEvent', (event) async {
emitEvent(DwdsEvent(
event['type'] as String, event['payload'] as Map<String, dynamic>));
return {'result': Success().toJson()};
});
await client.registerService('ext.dwds.emitEvent', 'DWDS');

client.registerServiceCallback('_yieldControlToDDS', (request) async {
final ddsUri = request['uri'] as String;
if (ddsUri == null) {
Expand Down
14 changes: 14 additions & 0 deletions dwds/test/events_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,20 @@ void main() {
bootstrap = isolate.rootLib;
});

test('can emit event through service extension', () async {
expect(
context.testServer.dwds.events,
emits(predicate((DwdsEvent event) =>
event.type == 'foo-event' && event.payload['data'] == 1234)));

var response = await context.debugConnection.vmService
.callServiceExtension('ext.dwds.emitEvent', args: {
'type': 'foo-event',
'payload': {'data': 1234},
});
expect(response.type, 'Success');
});

test('emits EVALUATE events on evaluation success', () async {
var expression = "helloString('world')";
expect(
Expand Down