Integrate the Navie context panel

[dustinbyrne]

• @appland/components is updated in the Navie view
  • A new event is emitted, open-location, which indicates the user has requested to open contextual information in the editor, directly from the source.
  • The first (and only) argument passed along with this event is the location. This is a path (either relative or absolute), with an optional starting line number and optional ending line number in the following format: path:startingLine-endingLine. Below are all valid examples:

    C:\\Users\\example.appmap.json:35
    C:\\Users\\Default\\MyProject\\example.rb:35-99
    MyProject/example.rb:35-99
    MyProject/example.appmap.json
    /home/user/dev/appmap/example.java:56

  • If the path is an appmap.json, the starting line is actually an event ID. The AppMap should be opened with the following state, where `${startLine} is substituted with the starting line or event ID.

    {
    "currentView": "viewSequence",
    "selectedObject": "event:${startLine}"
    }

  • Otherwise, the location should be opened as a text document.
  • If a start and end line are provided, once open, the document should scroll to the range of text provided.
  • If only a start line is provided, the document should scroll to the start line
  • If neither are provided, the document simply opens and no scrolling takes place.
• ~Keep in mind, if the location is a relative path, it may match more than one module. For now, simply select the first match. We'll fix this in a future revision.~
  • A directory property will indicate where the file is located. It may still need to be searched for (i.e., a partial path), though the directory will identify the correct root directory. See this source for more information.

Sample context data is available here: https://raw.githubusercontent.com/getappmap/appmap-js/main/packages/components/src/stories/data/navie_context.json

[jansorg]

@dustinbyrne Are lines 1-based or 0-based? Update: 1-based, it seems.

[jansorg]

@dustinbyrne Is VSCode displaying an error if no file for a given relative path was found?

[kgilpin]

Context item should have a directory; this may be something we can fix now.

The file may still need to be located though, because the Java agent can’t always determine full file paths.

On Fri, Apr 26, 2024 at 06:24 Joachim Ansorg @.***> wrote:

@dustinbyrne https://github.com/dustinbyrne Are lines 1-based or 0-based?

— Reply to this email directly, view it on GitHub https://github.com/getappmap/appmap-intellij-plugin/issues/677#issuecomment-2079111554, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAVC63ANUR6QZVERQKZJGTY7ITMHAVCNFSM6AAAAABGZLYF32VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDANZZGEYTCNJVGQ . You are receiving this because you are subscribed to this thread.Message ID: @.***>

[dustinbyrne]

@dustinbyrne Are lines 1-based or 0-based? Update: 1-based, it seems.

This is correct, they are 1-based.

Regarding the location of relative paths, a directory will indicate the root directory of a particular location. As Kevin mentioned, some paths may still be partial, but they should be able to be located within the directory given.

https://github.com/getappmap/appmap-js/blob/a51cb16f8f81a240d7662ff23ff2a175d1a8c39b/packages/navie/src/context.ts#L48-L54

[dustinbyrne]

@dustinbyrne Is VSCode displaying an error if no file for a given relative path was found?

At the moment nothing happens.

[appland-release]

:tada: This issue has been resolved in version 0.65.0 :tada:

The release is available on:

• v0.65.0
• GitHub release

Your semantic-release bot :package::rocket: