VS Code Outline sometimes doesn't show for newly-opened files

[clarktank]

On Android Studio, on the left side, there is a section called "Structure" where it shows a Top Level of all your classes and methods. Could you bring it to VS code?

[DanTup]

I found some screenshots of it, but couldn't figure out exactly what it's showing. Is it not the same as the Outline view?

[clarktank]

@DanTup Yes, that's exactly what I want. How did you enable that feature with Dart or Flutter extension? I have installed the Flutter 2.15.0 extension, but it doesn't have an outline section...

[DanTup]

It's a VS Code feature - on the Explorer sidebar, right-click and tick Outline :) It uses the data we already supplied for the Document Symbol list.

It's currently a preview feature, so it may move - see microsoft/vscode#49923.

[clarktank]

I got it thanks :) It does work on my local files, but for example when I press F12 on StatefulWidget to go to its implementation, in this case framework.dart file, the outline doesn't show anything!

[DanTup]

@clarktank Hmmm, that should work - and seems to here:

Could you try capturing a log? Close framework.dart, Run the Dart: Capture Logs command, then F12 into the file, give it a few seconds, and then click Stop Logging and attach the log (after reviewing it for any sensitive info/code).

[clarktank]

I don't know if it is useful, but here is a screenshot of my VS code...

[DanTup]

@scheglov Not sure if this is a race (or whether it should work). We opened a file (framework.dart inside Flutter) and called setPriorityFiles then immediately called search.getElementDeclarations (this is VS Code's new Outline feature - I guess it immediately requests the symbols when you open a file). That request happened before the server had started analyzing (from the new file being added as priority) so we ended up with an empty result.

[11:47:24 GMT-0400 (Eastern Daylight Time)] [Analyzer] ==> {"id":"121","method":"analysis.setPriorityFiles","params":{"files":["C:\\Users\\clarktank\\Desktop\\Apps\\Flutter\\flutter\\packages\\flutter\\lib\\src\\widgets\\framework.dart","C:\\Users\\clarktank\\Apps\\stephen_1\\lib\\src\\app.dart"]}}
[11:47:24 GMT-0400 (Eastern Daylight Time)] [Analyzer] ==> {"id":"122","method":"analysis.setSubscriptions","params":{"subscriptions":{"CLOSING_LABELS":["C:\\Users\\clarktank\\Desktop\\Apps\\Flutter\\flutter\\packages\\flutter\\lib\\src\\widgets\\framework.dart","C:\\Users\\clarktank\\Apps\\stephen_1\\lib\\src\\app.dart"],"FOLDING":["C:\\Users\\clarktank\\Desktop\\Apps\\Flutter\\flutter\\packages\\flutter\\lib\\src\\widgets\\framework.dart","C:\\Users\\clarktank\\Apps\\stephen_1\\lib\\src\\app.dart"],"OCCURRENCES":["C:\\Users\\clarktank\\Desktop\\Apps\\Flutter\\flutter\\packages\\flutter\\lib\\src\\widgets\\framework.dart","C:\\Users\\clarktank\\Apps\\stephen_1\\lib\\src\\app.dart"],"OUTLINE":["C:\\Users\\clarktank\\Desktop\\Apps\\Flutter\\flutter\\packages\\flutter\\lib\\src\\widgets\\framework.dart","C:\\Users\\clarktank\\Apps\\stephen_1\\lib\\src\\app.dart"]}}}
[11:47:24 GMT-0400 (Eastern Daylight Time)] [Analyzer] ==> {"id":"123","method":"search.getElementDeclarations","params":{"file":"C:\\Users\\clarktank\\Desktop\\Apps\\Flutter\\flutter\\packages\\flutter\\lib\\src\\widgets\\framework.dart"}}
[11:47:24 GMT-0400 (Eastern Daylight Time)] [Analyzer] <== {"id":"121"}
[11:47:24 GMT-0400 (Eastern Daylight Time)] [Analyzer] <== {"id":"122"}
[11:47:24 GMT-0400 (Eastern Daylight Time)] [Analyzer] <== {"event":"server.status","params":{"analysis":{"isAnalyzing":true}}}
[11:47:24 GMT-0400 (Eastern Daylight Time)] [Analyzer] <== {"id":"123","result":{"declarations":[],"files":[]}}

I think it would be better if the setPriorityFiles request had somehow delayed the getElementDeclarations processing until after the re-analysis (though I don't know the complexity or impact of that)?

[scheglov]

I don't understand why this might happen.

search.getElementDeclarations does not depend on resolution, so it does not need the file to be a priority one. We just need that the file is "known" in one of the drivers / analysis roots, e.g. it is in a root, or in a package in dependencies.

[DanTup]

Hmmm, that is strange then. The file must be reachable as it was returned in getNavigation. Maybe an instrumentation log will reveal more?

@clarktank Could you try enabling the Analaysis Server Instrumentation Log, restarting VS Code, reproducing, then providing the log?

Note: That log may include a lot more of your code than the previous log so do review if there might be anything sensitive in there (or you can email it if you don't want to post here - logs @ dartcode .org).

[clarktank]

This time I didn't wait as much as last time, after pressing F12. Please, let men know, if you want me wait more...

[DanTup]

@clarktank That's fine, it includes the important part showing the request/response for the data:

1530755229674:Req:{"id"::"30","method"::"search.getElementDeclarations","params"::{"file"::"C::\\Users\\clarktank\\Desktop\\Apps\\Flutter\\flutter\\packages\\flutter\\lib\\src\\widgets\\framework.dart"}}
1530755229676:Res:{"id"::"30","result"::{"declarations"::[],"files"::[]}}

@scheglov There's less in that log than I remembered; I thought it showed the files being analyzed. Anything more we can do debug?

[clarktank]

I have upgraded to v2.6 and this problem is solved.

[DanTup]

Great! I guess it was fixed by 623dcc9. We switched over to Outline information for the Document symbol list so that we could more easily map it to a tree and we'll wait up to 60 seconds after you open the file for the data to come through.