Run a binary server #316

datho7561 · 2020-08-27T20:55:40Z

If the user has no Java installed, run a binary version of LemMinX. There is a setting xml.server.preferBinary, which, when set to true, causes the binary LemMinX to be used even if Java is installed. If LemMinX extensions (lemminx-maven, etc.) are present, Java is present, and the xml.server.preferBinary preference is enabled, the Java version will be run anyways. If LemMinX extensions are present and no Java is detected, a warning is displayed saying that the extensions can't be used.

The binary server is downloaded when it is needed by the extension, instead of being packaged into the extension. This reduces the size of the extension and total download size for the user. The extension packages the SHA256 hash of the server binaries in order to verify their integrity. The extension falls back to the Java server if the binary server download or integrity check fail.

Additionally, this PR contains modifications to the existing Jenkins pipeline so that the correct download link for the binary server is packaged into the package.json, and the hashes for the binary server are packaged into ./server/*.sha256. There is also a new pipeline file that can be used to build the LemMinX binary under Windows, macOS, and RHEL 8 for the x64_86 architecture.

This PR is a rebase of PR 256 with additional features.

datho7561 · 2020-09-01T14:33:15Z

Notes on testing this PR:

Set the setting xml.server.binary.enabled to true
Build the LemMinX binary using Generate native binary eclipse/lemminx#860
Move the binary to ./server/lemminx-(darwin/linux/win32) (depending on your os)
Create a sha256 hash for the binary and put it under ./server/lemminx-(darwin/linux/win32)-hash
- (e.g. sha256sum lemminx-linux > ./server/lemminx-linux-hash)

fbricon · 2020-09-01T16:28:20Z

needs to handle download errors. I had the wrong name on the server and absolutely nothing was reported in vscode.

http server reported:
[2020-09-01T16:26:10.073Z] "GET /lemminx-binary/lemminx-darwin" "undefined"
[2020-09-01T16:26:10.080Z] "GET /lemminx-binary/lemminx-darwin" Error (404): "Not found"

the extension created an empty binary under [vscode-xml]/server, so then it didn't retry to download the proper binary the next time

src/javaServerStarter.ts

fbricon · 2020-09-30T15:03:04Z

I can't rebase it cleanly against master

src/javaServerStarter.ts

package.json

fbricon · 2020-09-30T15:19:57Z

Testing with the server downloaded from https:/datho7561/lemminx/actions/runs/279271890, OSX is not happy about it and will repeatedly show the same error message 5 times in less than 3 min, if you press cancel every time.

New challenge: how to notarize the app so that macOS shuts the fuck up?

datho7561 · 2020-09-30T18:39:39Z

That's odd. I rebased, but for some reason it still says its in conflict here.

datho7561

I refactored some of the code I wrote because it was a mess. It should now work without Java. Some other changes I made:

It will try to use the binary if no Java is installed
It will give a warning if there are LemMinX extensions but no Java installed
It will always use the Java server if it there are LemMinX extensions and Java is set up

src/requirements.ts

src/serverStarter.ts

src/binaryServerStarter.ts

datho7561 · 2021-01-14T22:04:09Z

I personally don't think we should add a setting to silence this warning. Maybe we could add an entry to the internal documentation that explains why the binary is not trusted, and how to generate the hash file for the binary if its trusted. Then we could link from the warning to the documentation with a button.

fbricon · 2021-01-15T19:46:17Z

I personally don't think we should add a setting to silence this warning. Maybe we could add an entry to the internal documentation that explains why the binary is not trusted, and how to generate the hash file for the binary if its trusted. Then we could link from the warning to the documentation with a button.

I believe things should be as easy/streamlined as possible, and consistent across Red Hat extensions. vscode-java does store trusted checksums, to avoid nagging users: https:/redhat-developer/vscode-java/blob/15dae347c8b0f3badf0273f3bfc4bb4b1c22935d/src/settings.ts#L209-L240

datho7561 · 2021-01-15T19:49:30Z

Okay. I will implement this.

fbricon · 2021-01-15T19:51:52Z

one important part of the vscode-java implem, is the setting is stored at the global level, to avoid malicious actors allowing shas of malicious binaries in the workspace settings.json

datho7561 · 2021-01-15T21:34:46Z

Should be added now.

NativeImage.jenkins

README.md

package.json

datho7561 · 2021-01-18T16:57:00Z

The pipeline will not work until the new parameter GRAALVM_VERSION is set up in the Jenkins job configuration

src/binaryServerStarter.ts

Download a binary lemminx, check its integrity, then run it. Includes: * Setting to specify a binary, `xml.server.binary.path` * Setting to specify args for the binary, `xml.server.binary.args` Defaults to java server in cases such as: * The binary can't be downloaded * The file containing the expected hash of the binary is missing * The hash of the binary doesn't match the expected hash * Binary specified in setting can't be located and the above three fail Signed-off-by: David Thompson <[email protected]>

fbricon reviewed Sep 1, 2020

View reviewed changes

src/javaServerStarter.ts Outdated Show resolved Hide resolved

fbricon requested changes Sep 1, 2020

View reviewed changes

src/javaServerStarter.ts Outdated Show resolved Hide resolved

src/javaServerStarter.ts Outdated Show resolved Hide resolved

datho7561 force-pushed the native-binary branch 2 times, most recently from 9c1cc6e to 10667a1 Compare September 2, 2020 20:28

fbricon mentioned this pull request Sep 8, 2020

[WIP] run a binary server #256

Closed

datho7561 force-pushed the native-binary branch 2 times, most recently from 8eff7af to 2bd0840 Compare September 11, 2020 20:29