Fix for outline tab not loading in case package-info.java file is present in the workspace in vscode

[Achal1607]

Package range was not being calculated in the object sent to the client from the server due to that error was thrown in the client of undefined range.

Please see:
oracle/javavscode#23

After fix:

---

^Add meaningful description above

By opening a pull request you confirm that, unless explicitly stated otherwise, the changes -

• are all your own work, and you have the right to contribute them.
• are contributed solely under the terms and conditions of the Apache License 2.0 (see section 5 of the license for more information).

Please make sure (eg. git log) that all commits have a valid name and email address for you in the Author field.

If you're a first time contributor, see the Contributing guidelines for more information.

If you're a committer, please label the PR before pressing "Create pull request" so that the right test jobs can run.

[neilcsmith-net]

cc/ @lahodaj @MartinBalin opened against delivery - please take a look with respect to NB20. What is the impact for the IDE here?

[lahodaj]

Let me take a step back. So, the LSP server produces documentSymbols, and when there's a package-info, the document symbols contain also an entry for the package (with sub-elements), with broken positions. The broken positions then cause the Outline view to not work.

So, we need to do something about the package in the Outline. There are three variants:

• variant 1: have the package at the same level as top-level classes. Seems this was the behavior at some point in the past, based on my reading of the history.
• Outline view: ;
• breadcrumbs when the caret is in the main method:
• variant 2: have the package enclose the top-level classes. Would make some sense, but seems to break breadcrumbs. This is actually what the patch in this PR does.
• Outline view:
• breadcrumbs when caret is in the main method:
• variant 3: do not show the package in Outline (this is what basically happens today, if the Outline words)
• Outline view:
• breadcrumbs when caret is in the main method:

I think variant 2 is disqualified, as it breaks the breadcrumbs. I don't have a strong opinion on decision between variant 1 and variant 3 - I wonder if @dbalek or @MartinBalin have some opinions here.

Regarding how does this affect the IDE - the NetBeans Swing UI is not affected at all, AFAIK. The ASF VS Code extension is affected I think, but has been for quite some time, I believe.

I personally don't see a strong need to push for integrating to NB 20. I personally think this can be "backported" to the Java Platform Support extension if needed.

[MartinBalin]

I'm in favour of not showing package in outline view. Just fix it as Dusan found there is some invalid position sent over LSP when there is package-info.java. Fix this and not push it to 20.

[neilcsmith-net]

OK, moved off delivery to master, and removed milestone. That brought in two commits that haven't reached master yet, so depending on what happens with this, please make sure not to merge those commits into master early!

[Achal1607]

If I can add something here, Java Redhat extension which is widely used as language support in vscode is showing code outline as shown in variant 1, since users would already be familiar with that sort of outline pattern, in my opinion it would be great if we can keep variant 1 as code outline pattern which follows redhat style (since users migrating from redhat extension would be in considerable number).

[lahodaj]

@Achal1607, I think I am fine with variant 1, but please note the current patch implements variant 2, as hence needs to be changed to implement variant 1.

[lahodaj]

Looks sensible to me, but please tweak the history to remove the extraneous commits (I thought these would disappear, but they don't seem to - unclear why). Thanks!

[mbien]

VSCodeExt job fails even after restart:

test-vscode-ext:
     [exec] 
     [exec] > apache-netbeans-java@0.1.0 test
     [exec] > node ./out/test/runTest.js
     [exec] 
     [exec] node:events:495
     [exec]       throw er; // Unhandled 'error' event
     [exec]       ^
     [exec] 
     [exec] Error: read ECONNRESET
     [exec]     at TLSWrap.onStreamRead (node:internal/stream_base_commons:217:20)
     [exec] Emitted 'error' event on ClientRequest instance at:
     [exec]     at TLSSocket.socketErrorListener (node:_http_client:501:9)
     [exec]     at TLSSocket.emit (node:events:517:28)
     [exec]     at emitErrorNT (node:internal/streams/destroy:151:8)
     [exec]     at emitErrorCloseNT (node:internal/streams/destroy:116:3)
     [exec]     at process.processTicksAndRejections (node:internal/process/task_queues:82:21) {
     [exec]   errno: -104,
     [exec]   code: 'ECONNRESET',
     [exec]   syscall: 'read'
     [exec] }
     [exec] 
     [exec] Node.js v18.18.2
Error: Process completed with exit code 1.

[lahodaj]

I restarted once more, and the job seems to pass now. I don't see how this patch could cause a failure like this.

[lahodaj]

I'll merge later tonight, unless there are objections.