Wire up dart:developer inspect(object) to Dart DevTools
- Dominant language
- Dart
- Stars
- 1.7k
- Forks
- 404
- Avg merge
- 6d 17h
- Merged PRs (30d)
- 18
Description
## Feature request
AngularDart DevTools needs the means to jump to the Dart source for a given class in the Debugger view.
## Context
In the JavaScript world, this is easily achieved by passing a `function` (or class) to the Chrome Console [inspect(object)](https://developers.google.com/web/tools/chrome-devtools/console/utilities#inspect) function. This in turn opens the location of the function definition in the Chrome Sources panel.
This approach is undesirable for AngularDart for two reasons:
1. We want to direct users to the Debugger tab in Dart DevTools over Chrome Sources, because ultimately this is where setting breakpoints will be most useful.
2. `inspect()` is a JavaScript API which requires interacting with the JavaScript representation of a Dart object. The Dart for Web team has explicitly stated that the JavaScript representation of Dart objects is not stable nor intended for use in this manner. Furthermore, the source maps don't accurately map the class definitions and "constructor" functions back to the correct Dart locations.
## Implementation
A possible solution–as suggested by the title–is to have Dart DevTools listen for dart:developer [inspect()](https://api.dart.dev/stable/2.10.4/dart-developer/inspect.html) requests on the VM service protocol. I believe the `Debug` stream emits events with [EventKind](https://github.com/dart-lang/sdk/blob/master/runtime/vm/service/service.md#eventkind) `Inspect` whenever `inspect()` is called. Given a Dart type, it could retrieve the source location from its [Class](https://github.com/dart-lang/sdk/blob/master/runtime/vm/service/service.md#class) and use that to open the Debugger at that location.
@jacob314 @grouma
Contributor guide
Research direction
Start with dart:developer inspect(), the VM service protocol's Debug stream and EventKind Inspect, and the Class source-location data described in service.md. Trace how Dart DevTools opens the Debugger at a source location. Done means an inspect request can direct DevTools to the Dart source for the given class.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- dart
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100