Skip to content

VSCode launch.json field observatoryUri should match DevTools name. #1642

Closed
Dart-Code/Dart-Code
#2501

Description

@terrylucas

Should be decided by a PM and needs corresponding fixes for Flutter Tool, VSCode and DevTools (if it changes from vm-uri).

When creating a configuration to attach to a running Flutter application the VM URI is called observatoryUri this will be confusing as DevTools is calling this vm-uri and Flutter tool will also be calling something else hopefully 'VM Uri'. We need to coordinate with Flutter too on a name.

  • DevTools CLI uses --vm-uri

  • Flutter tool calls it An Observatory debugger and profiler e.g.,

An Observatory debugger and profiler on AOSP on IA Emulator is available at: http://127.0.0.1:34637/OIt9yrpqmNE=/

Should we call it The VM Uri to attach, debug or profile at http://127.0.0.1:33933/aAqCdEkfG4A=/?

  • In VSCode's launch.json the name is observatoryUri to attach to a running Flutter application:
    "version": "0.2.0",
    "configurations": [
        // Attach to a running test.
        {
            "name": "Dart: Attach to Process",
            "type": "dart",
            "request": "attach",
            "observatoryUri": "http://127.0.0.1:33933/aAqCdEkfG4A=/"
        },

Activity

  1. added this to the On Deck milestone on Feb 18, 2020
  2. terrylucas commented on Feb 18, 2020

    @terrylucas
    ContributorAuthor
  3. DanTup commented on Feb 24, 2020

    @DanTup
    Contributor

    Has there been any decision on this? Right now this URI in VS Code s the Observatory web app and not the VM service URI (we need to change the protocol and add /ws). If we renamed it to vmServiceUri then I think it would be better if we put the exactly VM Service URI there (ws://127.0.0.1:33933/aAqCdEkfG4A=/ws/). We can still support observatoryUri for compatibility, but I think it might get confusing to call the original link a "VM Service URI"?

  4. DanTup commented on May 20, 2020

    @DanTup
    Contributor

    Ping! :-)

  5. devoncarew commented on May 20, 2020

    @devoncarew
    Contributor

    For web apps, flutter tools prints to stdout:

    Debug service listening on ws://127.0.0.1:56732/2Eg-vfZURVA=
    

    I think we should refer to the URI as a 'debug service' url for text presented to users. For more technical areas (json files? source code? protocols?) I think that referring to it as the vmServiceUri / VM service URI (or similar) also makes sense.

  6. DanTup commented on May 20, 2020

    @DanTup
    Contributor

    Thanks!

    While I'm updated references to Observatory, VS Code currently has a command Dart: Open Observatory that opens the web app (as scraped from stdout). Right now this is occasionally useful (though perhaps mostly only for me, often comparing its behaviour with things). Is it likely that web app will cease to exist anytime soon? Should I think about removing it?

  7. DanTup commented on Jun 17, 2020

    @DanTup
    Contributor

    In the next version of VS Code, things that referenced Observatory now generally say "VM Service" (there are a few that do not, for example the "Open Observatory" command remains, as that's still what it does).

    For launch.json, observatoryUri will still work - but will give a warning that it's not supported (the fix is to change it to vmServiceUri).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions