dart-sdk/pkg/dds
Dan Chevalier 4981cbffe2 [ VM Service / DDS ] Add custom service stream support
Setting the `stream` parameter on `developer.postEvent` will now forward those events to a custom stream inside DDS.


The first use of this will be for widget inspection. A navigation event will be posted to a custom stream. Our IDE DAP can listen for the Event and react to it by navigating to the desired location in the code.

TEST=Updated observatory tests. Created new developer test to check assertions. Added DDS tests for new custom stream behaviour. Manually tested the postEvent and StreamListen with multiple clients

https://github.com/flutter/devtools/issues/4533

Change-Id: I870dc634c9a9a7d2ee3a6605319c2a18517ad197
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/274061
Reviewed-by: Ben Konyi <bkonyi@google.com>
Commit-Queue: Dan Chevalier <danchevalier@google.com>
2022-12-09 20:18:30 +00:00
..
bin Reland "[ Service / DDS ] Remove VM service polling logic, add --enable-service-fallback-port support to DDS" 2022-03-15 18:14:42 +00:00
example
lib [ VM Service / DDS ] Add custom service stream support 2022-12-09 20:18:30 +00:00
test [ VM Service / DDS ] Add custom service stream support 2022-12-09 20:18:30 +00:00
tool [dds/dap] Support sending standard and custom progress notifications 2022-09-26 15:26:47 +00:00
.gitignore
analysis_options.yaml [devtools] Ping browsers running DevTools before trying to reuse them 2022-09-07 17:38:57 +00:00
CHANGELOG.md [dds/dap] Allow debug adapters to register multiple mappings for org-dartland-sdk URIs 2022-10-26 14:26:01 +00:00
dds_protocol.md master branch to main 2021-09-15 06:22:23 +00:00
LICENSE
OWNERS [infra] Add OWNERS to the Dart SDK 2022-02-14 14:06:34 +00:00
pubspec.yaml [dds/dap] Allow debug adapters to register multiple mappings for org-dartland-sdk URIs 2022-10-26 14:26:01 +00:00
README.md Fix typos 2022-07-12 19:35:22 +00:00

pub package package publisher

A package used to spawn the Dart Developer Service (DDS), which is used to communicate with a Dart VM Service instance and provide extended functionality to the core VM Service Protocol.

Functionality

Existing VM Service clients can issue both HTTP, websocket, and SSE requests to a running DDS instance as if it were an instance of the VM Service itself. If a request corresponds to an RPC defined in the VM Service Protocol, DDS will forward the request and return the response from the VM Service. Requests corresponding to an RPC defined in the DDS Protocol will be handled directly by the DDS instance.

SSE Support

For certain web clients it may be preferable or required to communicate with DDS using server-sent events (SSE). DDS has an SSE handler listening for requests on /$debugHandler.

SSE and package:vm_service example

import 'package:sse/sse.dart';
import 'package:vm_service/vm_service.dart';

void main() {
  // Establish connection with DDS using SSE.
  final ddsChannel = SseClient('${ddsUri}\$debugHandler');

  // Wait for ddsChannel to be established
  await ddsChannel.onOpen.first;

  // Initialize VmService using the sink and stream from ddsChannel.
  final vmService = VmService(
    ddsChannel.stream,
    (e) => ddsChannel.sink.add(e),
  );

  // You're ready to query DDS and the VM service!
  print(await vmService.getVersion());
}