Run a binary server

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*.ts]
+[*.js]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = false

.vscodeignore

@@ -0,0 +1,5 @@
+.vscode
+node_modules
+src/
+tsconfig.json
+webpack.config.js

Jenkinsfile

@@ -12,8 +12,13 @@ def buildVscodeExtension(){
 	sh "npm run vscode:prepublish"
 }
 
+def buildLemMinXBinary() {
+	sh "curl -Lo NativeImage.jenkins https://raw.githubusercontent.com/${params.FORK}/vscode-xml/${params.BRANCH}/NativeImage.jenkins"
+	load "NativeImage.jenkins"
+}
+
 node('rhel7'){
-	sh "curl -Lo package.json https://raw.githubusercontent.com/redhat-developer/vscode-xml/master/package.json"
+	sh "curl -Lo package.json https://raw.githubusercontent.com/${params.FORK}/vscode-xml/${params.BRANCH}/package.json"
 	def packageJson = readJSON file: 'package.json'
 	def serverVersion = packageJson?.xmlServer?.version
 	def files = []
@@ -24,6 +29,8 @@ node('rhel7'){
 		files = findFiles(glob: 'org.eclipse.lemminx*-uber.jar')
 	}
 
+	buildLemMinXBinary()
+
 	if (!files[0]) {
 		stage 'Build XML LS'
 		git url: 'https://github.com/eclipse/lemminx.git'
@@ -39,7 +46,22 @@ node('rhel7'){
 	deleteDir()
 	def gitUrl = "${GIT_REPO}"
 
-	git url: gitUrl?:'https://github.com/redhat-developer/vscode-xml.git'
+	git url: gitUrl?:'https://github.com/redhat-developer/vscode-xml.git', branch: params.BRANCH?: 'master'
+
+	stage 'set the link to download the binary server'
+	def packageJson = readJSON file: 'package.json'
+	def binaryUploadFolder = 'snapshots'
+	if (publishToMarketPlace.equals('true')) {
+		binaryUploadFolder = 'stable'
+	}
+	def downloadLocation = 'https://download.jboss.org/jbosstools'
+	sh "sed -i -e 's|${downloadLocation}/vscode/snapshots/lemminx-binary/LATEST|${downloadLocation}/vscode/${binaryUploadFolder}/lemminx-binary/${packageJson.version}-${env.BUILD_NUMBER}|g' package.json"
+
+	stage 'package binary hashes'
+	sh "mkdir ./server"
+	sh "wget ${downloadLocation}/vscode/${binaryUploadFolder}/lemminx-binary/${packageJson.version}-${env.BUILD_NUMBER}/lemminx-linux.sha256 -O ./server/lemminx-linux.sha256"
+	sh "wget ${downloadLocation}/vscode/${binaryUploadFolder}/lemminx-binary/${packageJson.version}-${env.BUILD_NUMBER}/lemminx-win32.sha256 -O ./server/lemminx-win32.sha256"
+	sh "wget ${downloadLocation}/vscode/${binaryUploadFolder}/lemminx-binary/${packageJson.version}-${env.BUILD_NUMBER}/lemminx-osx-x86_64.sha256 -O ./server/lemminx-osx-x86_64.sha256"
 
 	stage 'install vscode-xml build requirements'
 	installBuildRequirements()
@@ -48,11 +70,9 @@ node('rhel7'){
 	buildVscodeExtension()
 	unstash 'server_distro'
 	def files = findFiles(glob: '**/org.eclipse.lemminx*-uber.jar')
-	sh "mkdir ./server"
 	sh "mv ${files[0].path} ./server"
 
 	stage "Package vscode-xml"
-	def packageJson = readJSON file: 'package.json'
 	sh "vsce package -o vscode-xml-${packageJson.version}-${env.BUILD_NUMBER}.vsix"
 
 	//stage 'Test vscode-xml for staging'

NativeImage.jenkins

@@ -0,0 +1,139 @@
+// Parameters that need to be declared for this pipeline:
+// * GRAALVM_VERSION: The version of GraalVM to download in the Windows an macOS builds
+// * publishToMarketPlace: Upload to the "stable" folder if true, upload to the "snapshots" folder if false
+// * UPLOAD_LOCATION: The base location where the artifacts (binaries and sha256 hashes) will be uploaded
+// * FORK: The fork of vscode-xml that is being built for
+// * BRANCH: The branch of vscode-xml that is being built for
+pipeline {
+  agent none
+  stages {
+    stage("native-image") {
+      parallel {
+        // Assumes GraalVM is set up on the rhel8 agent, and the environment variable "GRAALVM_PATH" points to its location
+        stage("Linux native-image") {
+          agent {
+            label "rhel8"
+          }
+          steps {
+            sh "rm -f lemminx-linux"
+            sh "cd lemminx && git pull && cd .. || git clone https://github.com/eclipse/lemminx.git"
+            sh "cd lemminx && JAVA_HOME=\$GRAALVM_PATH ./mvnw clean package -B -Dnative -DskipTests && cd .."
+            sh "cp lemminx/org.eclipse.lemminx/target/lemminx-linux* lemminx-linux"
+            stash name: 'lemminx-linux', includes: 'lemminx-linux'
+          }
+        }
+        stage("Windows native-image") {
+          agent {
+            label "win10"
+          }
+          steps {
+            powershell "if (Test-Path lemminx-win32.exe) { Remove-Item lemminx-win32.exe }"
+            powershell """
+              [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
+              if (Test-Path lemminx) {
+                cd lemminx
+                git pull
+                cd ..
+              } else {
+                git clone https://github.com/eclipse/lemminx.git
+              }
+            """
+            powershell """
+              [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
+              if (-not (Test-Path graalvm-windows-${params.GRAALVM_VERSION}.zip)) {
+                Invoke-WebRequest https://github.com/graalvm/graalvm-ce-builds/releases/download/vm-${params.GRAALVM_VERSION}/graalvm-ce-java11-windows-amd64-${params.GRAALVM_VERSION}.zip -OutFile graalvm-windows-${params.GRAALVM_VERSION}.zip
+                Expand-Archive graalvm-windows-${params.GRAALVM_VERSION}.zip
+                .\\graalvm-windows-${params.GRAALVM_VERSION}\\graalvm-ce-java11-${params.GRAALVM_VERSION}\\bin\\gu install native-image
+              }
+            """
+            bat """
+              pushd .
+              setlocal
+              set JAVA_HOME="%cd%\\graalvm-windows-${params.GRAALVM_VERSION}\\graalvm-ce-java11-${params.GRAALVM_VERSION}"
+              call "C:\\Program Files (x86)\\Microsoft Visual Studio 14.0\\VC\\vcvarsall.bat" x86_amd64
+              popd
+              cd lemminx
+              .\\mvnw.cmd clean package -B -Dnative -DskipTests
+              endlocal
+              cd ..
+            """
+            powershell "mv lemminx\\org.eclipse.lemminx\\target\\lemminx-windows*.exe lemminx-win32.exe"
+            stash name: 'lemminx-win32.exe', includes: 'lemminx-win32.exe'
+          }
+        }
+        stage("macOS native-image") {
+          agent {
+            label "mac"
+          }
+          steps {
+            sh "rm -f lemminx-osx-x86_64.zip lemminx-osx-x86_64.sha256"
+            sh "cd lemminx && git pull && cd .. || git clone https://github.com/eclipse/lemminx.git"
+            sh """
+              if [ ! -f graalvm-darwin-${params.GRAALVM_VERSION}.tar.gz ]; then
+                curl https://github.com/graalvm/graalvm-ce-builds/releases/download/vm-${params.GRAALVM_VERSION}/graalvm-ce-java8-darwin-amd64-${params.GRAALVM_VERSION}.tar.gz -L --output graalvm-darwin-${params.GRAALVM_VERSION}.tar.gz
+                tar -xzf graalvm-darwin-${params.GRAALVM_VERSION}.tar.gz
+                ./graalvm-ce-java8-${params.GRAALVM_VERSION}/Contents/Home/bin/gu install native-image
+              fi
+            """
+            sh "cd lemminx && JAVA_HOME=../graalvm-ce-java8-${params.GRAALVM_VERSION}/Contents/Home ./mvnw clean package -B -Dnative -DskipTests && cd .."
+            sh "cp lemminx/org.eclipse.lemminx/target/lemminx-osx-x86_64* lemminx-osx-x86_64"
+
+            stash name: 'lemminx-osx-x86_64', includes: 'lemminx-osx-x86_64'
+          }
+        }
+      }
+    }
+    stage ("UPX and upload") {
+      agent {
+        label "rhel8"
+      }
+      steps {
+        unstash name: 'lemminx-linux'
+        unstash name: 'lemminx-win32.exe'
+        unstash name: 'lemminx-osx-x86_64'
+
+        // Run UPX to reduce binary size
+        sh "upx lemminx-linux"
+        sh "upx lemminx-win32.exe"
+        sh "upx lemminx-osx-x86_64"
+
+        // get the sha256 hash of the files
+        sh "sha256sum lemminx-linux > lemminx-linux.sha256"
+        sh "sha256sum lemminx-win32.exe > lemminx-win32.sha256"
+        sh "sha256sum lemminx-osx-x86_64 > lemminx-osx-x86_64.sha256"
+
+        // Move artifacts into a folder name unique to this build
+        sh "curl -Lo package.json https://raw.githubusercontent.com/${params.FORK}/vscode-xml/${params.BRANCH}/package.json"
+        script {
+          def packageJson = readJSON file: 'package.json'
+          def vscodeXmlVersion = packageJson?.version
+          def uploadFolderName = 'snapshots'
+          if (params.publishToMarketPlace.equals('true')) {
+            uploadFolderName = 'stable'
+          }
+          sh "mkdir ${vscodeXmlVersion}-${env.BUILD_NUMBER}"
+          sh """
+            cp lemminx-linux ${vscodeXmlVersion}-${env.BUILD_NUMBER}/lemminx-linux
+            cp lemminx-linux.sha256 ${vscodeXmlVersion}-${env.BUILD_NUMBER}/lemminx-linux.sha256
+            cp lemminx-win32.exe ${vscodeXmlVersion}-${env.BUILD_NUMBER}/lemminx-win32.exe
+            cp lemminx-win32.sha256 ${vscodeXmlVersion}-${env.BUILD_NUMBER}/lemminx-win32.sha256
+            cp lemminx-osx-x86_64 ${vscodeXmlVersion}-${env.BUILD_NUMBER}/lemminx-osx-x86_64
+            cp lemminx-osx-x86_64.sha256 ${vscodeXmlVersion}-${env.BUILD_NUMBER}/lemminx-osx-x86_64.sha256
+          """
+          if (!params.publishToMarketPlace.equals('true')){
+            sh """
+              ln  --symbolic ${vscodeXmlVersion}-${env.BUILD_NUMBER} LATEST
+              rsync -Pzrlt --rsh=ssh --protocol=28 LATEST ${params.UPLOAD_LOCATION}/vscode/snapshots/lemminx-binary
+            """
+          }
+          // Upload the uniquely named folder to JBossTools
+          sh """
+            rsync -Pzrlt --rsh=ssh --protocol=28 ${vscodeXmlVersion}-${env.BUILD_NUMBER} ${params.UPLOAD_LOCATION}/vscode/${uploadFolderName}/lemminx-binary
+            rm -rf ${vscodeXmlVersion}-${env.BUILD_NUMBER}
+            rm -f LATEST
+          """
+        }
+      }
+    }
+  }
+}

README.md

@@ -41,6 +41,11 @@ or you can read this documentation inside vscode with the command `Open XML Docu
 
 ## Requirements
 
+For running the binary version:
+  * Windows, macOS, or Linux, on a x86_64 CPU
+    * We don't make a binary specific for Apple ARM (Apple Silicon), but the x86_64 binary seems to work through the Rosetta 2 translation layer.
+
+For running the Java version (required if you want to run [extensions](./docs/Extensions#custom-xml-extensions) to the base XML features):
   * Java JDK (or JRE) 8 or more recent
   * Ensure Java path is set in either:
     * `xml.java.home` in VSCode preferences
@@ -60,6 +65,11 @@ The following settings are supported:
 * [`xml.server.vmargs`](https://github.com/redhat-developer/vscode-xml/blob/master/docs/Preferences.md#server-vm-arguments): Specifies extra VM arguments used to launch the XML Language Server.
    Eg. use `-Xmx1G  -XX:+UseG1GC -XX:+UseStringDeduplication` to bypass class verification, increase the heap size to 1GB and enable String deduplication with the G1 Garbage collector.
 * [`xml.server.workDir`](https://github.com/redhat-developer/vscode-xml/blob/master/docs/Preferences.md#server-cache-path): Set a custom folder path for cached XML Schemas. An absolute path is expected, although the `~` prefix (for the user home directory) is supported. Default is `~/.lemminx`.
+* [`xml.server.preferBinary`](https://github.com/redhat-developer/vscode-xml/blob/master/docs/Preferences.md#server-binary-mode): If this setting is enabled, a binary version of the server will be launched even if Java is installed.
+* [`xml.server.binary.path`](https://github.com/redhat-developer/vscode-xml/blob/master/docs/Preferences.md#server-binary-mode): Specify the path of a custom binary version of the XML server to use. A binary will be downloaded if this is not set.
+* [`xml.server.binary.args`](https://github.com/redhat-developer/vscode-xml/blob/master/docs/Preferences.md#server-binary-mode): Command line arguments to supply to the binary server when the binary server is being used. Takes into effect after relaunching VSCode. Please refer to [this website for the available options](https://www.graalvm.org/reference-manual/native-image/HostedvsRuntimeOptions/). For example, you can increase the maximum memory that the server can use to 1 GB by adding `-Xmx1g`
+* [`xml.server.silenceExtensionWarning`](https://github.com/redhat-developer/vscode-xml/blob/master/docs/Preferences.md#server-binary-mode): If this setting is enabled, do not warn about launching the binary server when there are extensions to the XML language server installed.
+* [`xml.server.binary.trustedHashes`](https://github.com/redhat-developer/vscode-xml/blob/master/docs/Preferences.md#server-binary-mode): List of the SHA256 hashes of trusted copies of the lemminx (XML language server) binary.
 * `xml.trace.server`: Trace the communication between VS Code and the XML language server in the Output view. Default is `off`.
 * `xml.logs.client`: Enable/disable logging to the Output view. Default is `true`.
 * [`xml.catalogs`](https://github.com/redhat-developer/vscode-xml/blob/master/docs/Preferences.md#catalogs): Register XML catalog files.

docs/Extensions.md

@@ -194,6 +194,12 @@ You can debug your Java LemMinX extension in any Java IDE that supports remote d
 8. Debug
 
    ![](images/Extensions/DebugLemMinXExtensionInEclipse.png)
+## Binary Server
+
+Unfortunately, classes cannot be loaded dynamically through SPI in the binary version of the LemMinX language server.
+This means that you can't use LemMinX extensions with the binary server.
+vscode-xml will always launch the Java version of the server if LemMinX extensions are detected and Java is present.
+If you launch vscode-xml in binary mode with LemMinX extensions installed, a warning will be displayed that extensions are found but can't be used without Java.
 
 ## XML extension API (TypeScript)
 

docs/Preferences.md

@@ -34,6 +34,32 @@
   -Dhttp.proxyPassword= <password> -Dhttps.proxyHost=<proxy_host> -Dhttps.proxyPort=<proxy_port>
   ```
 
+## Server Binary Mode
+
+  By default, if Java is not installed, a binary version of the LemMinX language server will be downloaded and run.
+  If you want to use the binary version even if Java is installed, enable the `xml.server.preferBinary` option.
+  If something goes wrong with downloading the binary, then vscode-xml will fall back to trying to use the Java server.
+
+  Unfortunately, extensions to LemMinX such as lemminx-maven, liquibase-lsp, and lemminx-liberty cannot be used with the binary version of the server.
+  vscode-xml will always launch the Java version of the server if extensions are detected and the user has Java installed.
+  A warning will be displayed if you launch vscode-xml in binary server mode with extensions installed.
+  This warning can be disabled with the `xml.server.silenceExtensionWarning` setting.
+  Please see the [extensions page](./Extensions.md) for more information.
+
+  You can set a path for a custom binary with the `xml.server.binary.path` setting.
+
+  Like with the Java version of the server, you can set memory limits and other command line arguments to the server through the `xml.server.binary.args` setting.
+  These will take into effect after relaunching VSCode.
+  Please refer to [this website for the available options](https://www.graalvm.org/reference-manual/native-image/HostedvsRuntimeOptions/).
+  For example, you can increase the maximum memory that the server can use to 1 GB by adding `-Xmx1g`.
+
+## Trusted binary hashes
+
+  The `xml.server.binary.trustedHashes` setting contains a list of all the hashes of LemMinX (the XML language server) binaries that you have selected to trust.
+  An entry will be added to this list every time you run an unrecognized binary and choose to trust and run it.
+  If you use the `xml.server.binary.path` setting to set the path to a custom LemMinX binary,
+  you can add the SHA256 hash of the binary as an entry in this list in order to prevent warnings about the binary not being recognized.
+
 ## Server Cache Path
 
   vscode-xml maintains a cache of the schemas (eg: XSD, DTD) that are referenced using an internet URL.
@@ -81,9 +107,9 @@ Please see [XSD file associations](Validation.md#xml-file-association-with-xsd)
     "catalog2.xml"
   ]
   ```
-  
+
 Please see [XML catalog with XSD](Validation.md#XML-catalog-with-XSD) and [XML catalog with DTD](Validation.md#XML-catalog-with-DTD) for more information.
-  
+
 ## Grammar
 
   Can be accessed through: `xml.problems.noGrammar`

docs/Troubleshooting.md

@@ -1,6 +1,6 @@
 # Troubleshooting
 
-## Issues 
+## Issues
 
 Please create [vscode-xml issues](https://github.com/redhat-developer/vscode-xml/issues) for any problem.
 
@@ -13,11 +13,11 @@ You can check if the server is not working in VSCode by going to:
  2) `View -> Output -> XML Support` (drop down menu top right)
     If it is not working it will indicate the server has Shutdown.
 
-You can kill the process by: 
+You can kill the process by:
 
  1) Run `jps` command in terminal
  2) Check if multiple instances of `org.eclipse.lemminx-uber.jar` or `XMLServerLauncher`
  3) According to your OS:
- 
+
   * on Windows OS: run `taskkill /F /PID ...` all instances
-  * on other OS: run `kill -9 ...` all instances
+  * on other OS: run `kill -9 ...` all instances