VSCoder insider will discard the containerName of SymbolInformation

[yaohaizh]

• VSCode Version: The latest insider version
• OS Version: Windows 10 18.04

Steps to Reproduce:

1. Install this extension in insider version
2. Show the outline from the explorer context menu
3. Open the project from here: https://github.com/spring-projects/spring-petclinic
4. Open the PetApplication.java file

Expected:

• From the language server side, the containerName of SymbolInformation is returned in the debug scenario. But is is not available on the client side.
• The issue doesn't appear on the VSCode stable 1.23.1

[DanTup]

I just came to report the same thing. There's something really weird about it, it seems to work for some code but not others... I have two document symbol providers, a "legacy" one that I use for old versions of the Dart SDK and a new one for the new versions (this one functions as both a Workspace and Document symbol provider). The returned SymbolInformations look the same to me, yet the newer one is losing the containerNames and the legacy one is not (testing both in insiders). It's not just lost in the UI, if you call vscode.executeDocumentSymbolProvider and examine the results it's not on the objects there either.

[DanTup]

Ok, this one's weird. I return two items with name: name, containerName: containerName and they display like this:

[DanTup]

@jrieken - I wonder if this is related to the hierarchical symbol changes? I haven't updated for that yet; this is the behaviour running the current live version of the extension (so what users would get if insiders released as-is).

[aeschli]

This looks still broken to me:

• Install Java (Redhat) extension
• create file A.java and open in editor

public class A {
    public static void main(String[] args) throws Exception {
    }
}

• show document symbols: (Ctrl+Shift+o) and observe outline
  

-> document symbols don't show container
-> outline is flat

Check the Java LS trace: ( "java.trace.server": "verbose")

[Trace - 12:23:37 PM] Received response 'textDocument/documentSymbol - (117)' in 4ms.
Result: [[
    {
        "name": "main(String[])",
        "kind": 6,
        "location": {
            "uri": "file:///home/aeschli/workspaces/samples/java-samples/spring-petclinic/src/A.java",
            "range": {
                "start": {
                    "line": 2,
                    "character": 23
                },
                "end": {
                    "line": 2,
                    "character": 27
                }
            }
        },
        "containerName": "A"
    },
    {
        "name": "A",
        "kind": 5,
        "location": {
            "uri": "file:///home/aeschli/workspaces/samples/java-samples/spring-petclinic/src/A.java",
            "range": {
                "start": {
                    "line": 1,
                    "character": 13
                },
                "end": {
                    "line": 1,
                    "character": 14
                }
            }
        },
        "containerName": "A.java"
    }
]

[jrieken]

True story. Somehow lost in translation...

[sbatten]

Using @aeschli 's example, I am still seeing the flat outline.

[jrieken]

@sbatten Sure you were using a build that contained 1810448? This came in quite late on Friday

[jrieken]

ping @sbatten

[DanTup]

FWIW, my integration tests for my symbol provider seem to be passing against Insiders now :-)

[jrieken]

Ok, closing based on @DanTup insights.

[sbatten]

maybe I'm misunderstanding what this should look like, but I thought the outline should have class A as a parent of the method main and any other methods.

public class A {
	public static void main(String[] args) throws Exception {
	}

	public int run(){ return 0; }
}

[DanTup]

@sbatten I think it should too, are you using an outdated Insiders build or could it be an issue with the language extension?

I just tried this manually again with my example from above and the containerNames that were previously missing are definitely coming through:

[sbatten]

maybe its just an issue with the outline, container names do show in show symbols

[DanTup]

Ah, I totally missed that your screenshot was outline. I haven't done much testing with that so it might have different issues.

[jrieken]

re #50321 (comment)

Yeah, that's the design. We show container names only in quick outline, not in the outline tree. The whole reason containerName exists is the fact that we have been using a flat list for symbols and they are meant to provide parent context. Since the tree has that by its nature we don't need it anymore.

[DanTup]

@jrieken Is the API for providing this data in a tree finalised, or does the outline currently try to make a tree based on containerName? Last time I checked, it seemed like I could enable the outline, but the API to update the provider was still being tweaked?

[jrieken]

Yeah, we finalise the API this month (see #34968) until then we synthesise trees based on range containment.

[DanTup]

Aha, that's what you're using - I wondered if it was based on container name, but the range makes much more sense! Thanks :)

[jrieken]

For reference (and pride): https://github.com/Microsoft/vscode/blob/master/src/vs/workbench/api/node/extHostLanguageFeatures.ts#L54