chore: align startup message to include port number (#195)

To be compliant with the behavior of glsp-server-node,
the startup message has to include the port of the socket.

Fixes eclipse-glsp/glsp#825

* Print which random available port is used if port 0 is specified

If `-p 0` is specified as command line argument, the GLSP server
uses an available port assigned by the OS.

This patch
- adjusts the startup message accordingly
- adds the startup message to the WebsocketServerLauncher
- jdk17-compatibility: adjust the fatjar to unsign jars,
  because signed jars may not be repacked
- adds a step to the jenkinsfile to build the fatjar

Signed-off-by: Olaf Lessenich <olessenich@eclipsesource.com>

Author: xai

Jenkinsfile

@@ -27,6 +27,14 @@ pipeline {
             }
         }
 
+        stage ('Build: fatjar') {
+            steps {
+                timeout(30) {
+                    sh 'mvn clean verify -Pfatjar -B -Dcheckstyle.skip -DskipTests'
+                }
+            }
+        }
+
         stage('Checkstyle') {
             steps {
                 timeout(30) {

examples/org.eclipse.glsp.example.workflow/pom.xml

@@ -174,6 +174,9 @@
 										<exclude>**/*.mwe2</exclude>
 										<exclude>**/*.xtext</exclude>
 										<exclude>**/*.xtextbin</exclude>
+										<exclude>META-INF/*.SF</exclude>
+										<exclude>META-INF/*.RSA</exclude>
+										<exclude>META-INF/*.INF</exclude>
 									</excludes>
 								</filter>
 							</filters>
@@ -195,4 +198,4 @@
 		</profile>
 	</profiles>
 
-</project>
+</project>

plugins/org.eclipse.glsp.server.websocket/src/org/eclipse/glsp/server/websocket/WebsocketServerLauncher.java

@@ -32,6 +32,7 @@
 import com.google.inject.Module;
 
 public class WebsocketServerLauncher extends GLSPServerLauncher {
+   public static final String START_UP_COMPLETE_MSG = "[GLSP-Server]:Startup completed. Accepting requests on port:";
    private static Logger LOGGER = LogManager.getLogger(WebsocketServerLauncher.class);
    protected Server server;
    protected final String endpointPath;
@@ -50,11 +51,14 @@ public WebsocketServerLauncher(final ServerModule serverModule, final String end
       this.websocketLogLevel = websocketLogLevel;
    }
 
+   protected String getStartupCompleteMessage() { return START_UP_COMPLETE_MSG; }
+
    @Override
    @SuppressWarnings("checkstyle:IllegalCatch")
-   public void start(final String hostname, final int port) {
+   public void start(final String hostname, int port) {
       try {
          Configurator.setLevel("org.eclipse.jetty", this.websocketLogLevel);
+
          // Setup Jetty Server
          server = new Server(new InetSocketAddress(hostname, port));
          ServletContextHandler webAppContext;
@@ -77,7 +81,11 @@ public void start(final String hostname, final int port) {
          // Start the server
          try {
             server.start();
+            if (port == 0) {
+               port = server.getURI().getPort();
+            }
             LOGGER.info("GLSP server is running and listening on Endpoint : " + server.getURI() + endpointPath);
+            System.out.println(getStartupCompleteMessage() + port);
             server.join();
          } catch (Exception exception) {
             LOGGER.warn("Shutting down due to exception", exception);

plugins/org.eclipse.glsp.server/src/org/eclipse/glsp/server/launch/SocketGLSPServerLauncher.java

@@ -45,7 +45,7 @@
 import com.google.inject.Module;
 
 public class SocketGLSPServerLauncher extends GLSPServerLauncher {
-   public static final String START_UP_COMPLETE_MSG = "[GLSP-Server]:Startup completed";
+   public static final String START_UP_COMPLETE_MSG = "[GLSP-Server]:Startup completed. Accepting requests on port:";
    private static Logger LOGGER = LogManager.getLogger(SocketGLSPServerLauncher.class);
 
    private ExecutorService threadPool;
@@ -72,11 +72,15 @@ public void start(final String hostname, final int port) {
 
    protected String getStartupCompleteMessage() { return START_UP_COMPLETE_MSG; }
 
-   public Future<Void> asyncRun(final String hostname, final int port)
+   public Future<Void> asyncRun(final String hostname, int port)
       throws IOException, InterruptedException, ExecutionException {
       onShutdown = new CompletableFuture<>();
 
       serverSocket = AsynchronousServerSocketChannel.open().bind(new InetSocketAddress(hostname, port));
+      if (port == 0) {
+         port = ((InetSocketAddress) serverSocket.getLocalAddress()).getPort();
+      }
+
       threadPool = Executors.newCachedThreadPool();
 
       CompletionHandler<AsynchronousSocketChannel, Void> handler = new CompletionHandler<>() {
@@ -96,7 +100,7 @@ public void failed(final Throwable exc, final Void attachment) {
       LOGGER.info("The GLSP server is ready to accept new client requests on port: " + port);
       // Print a message to the output stream that indicates that the start is completed.
       // This indicates to the client that the sever process is ready (in an embedded scenario).
-      System.out.println(getStartupCompleteMessage());
+      System.out.println(getStartupCompleteMessage() + port);
 
       return onShutdown;
    }