Merge pull request #134 from OpenLiberty/staging

Merge staging to prod - Update the guide for Windows compatibility (#132)

Author: gkwan-ibm

.github/workflows/test.yml

@@ -48,10 +48,10 @@ jobs:
         working-directory: finish
     steps:
       - uses: actions/checkout@v2
-      - name: Set up JDK 11
+      - name: Set up JDK 17
         uses: actions/setup-java@v1
         with:
-          java-version: 11
+          java-version: 17
       - run: unset _JAVA_OPTIONS
       - name: Run tests
         run: ../scripts/testApp.sh

README.adoc

@@ -1,4 +1,4 @@
-//  Copyright (c) 2022, 2023 IBM Corporation and others.
+//  Copyright (c) 2022, 2024 IBM Corporation and others.
 // Licensed under Creative Commons Attribution-NoDerivatives
 // 4.0 International (CC BY-ND 4.0)
 //   https://creativecommons.org/licenses/by-nd/4.0/
@@ -13,7 +13,7 @@
 :page-essential: false
 :page-description: Learn how to use Jakarta WebSocket to stream messages between client and server services.
 :guide-author: Open Liberty
-:page-tags: ['Jakarta EE']
+:page-tags: ['jakarta-ee']
 :page-related-guides: ['grpc-intro']
 :page-permalink: /guides/{projectid}
 :imagesdir: /img/guide/{projectid}
@@ -135,7 +135,7 @@ Annotate the `SystemService` class with a [hotspot=serverEndpoint file=0]`@Serve
 
 The [hotspot=onOpenMethod file=0]`onOpen()` method stores up the client sessions. The [hotspot=onCloseMethod file=0]`onClose()` method displays the reason for closing the connection and removes the closing session from the client sessions.
 
-The [hotspot=onMessageMethod file=0]`onMessage()` method is called when receiving a message through the `option` parameter. The [hotspot=loadAverage hotspot=memoryUsageOrBoth file=0]`option` parameter signifies which message to construct, either system load, memory usage data, or both, and sends out the [hotspot=sendToAllSessions file=0]`JsonObject` message. The [hotspot=sendToAllSessionseMethod file=0]`sendToAllSessions()` method uses the WebSocket API to broadcast the message to all client sessions.
+The [hotspot=onMessageMethod file=0]`onMessage()` method is called when receiving a message through the `option` parameter. The [hotspot=cpuLoad hotspot=memoryUsageOrBoth file=0]`option` parameter signifies which message to construct, either system load, memory usage data, or both, and sends out the [hotspot=sendToAllSessions file=0]`JsonObject` message. The [hotspot=sendToAllSessionseMethod file=0]`sendToAllSessions()` method uses the WebSocket API to broadcast the message to all client sessions.
 
 [role="code_command hotspot file=1", subs="quotes"]
 ----
@@ -229,7 +229,7 @@ SystemLoadScheduler.java
 include::finish/client/src/main/java/io/openliberty/guides/client/scheduler/SystemLoadScheduler.java[]
 ----
 
-The `SystemLoadScheduler` class uses the [hotspot=systemClient file=1]`SystemClient` class to establish a connection to the server by the `ws://localhost:9081/systemLoad` URI at the [hotspot=postConstruct file=1]`@PostConstruct` annotated method. The [hotspot=sendSystemLoad file=1]`sendSystemLoad()` method calls the client to send a random string from either [hotspot=messages file=1]`loadAverage`, [hotspot=messages file=1]`memoryUsage`, or [hotspot=messages file=1]`both` to the `system` service. Using the link:https://openliberty.io/docs/latest/reference/javadoc/liberty-jakartaee9.1-javadoc.html?package=jakarta/ejb/package-frame.html&class=jakarta/ejb/TimerService.html[Jakarta Enterprise Beans Timer Service^], annotate the `sendSystemLoad()` method with the [hotspot=schedule file=1]`@Schedule` annotation so that it sends out a message every 10 seconds.
+The `SystemLoadScheduler` class uses the [hotspot=systemClient file=1]`SystemClient` class to establish a connection to the server by the `ws://localhost:9081/systemLoad` URI at the [hotspot=postConstruct file=1]`@PostConstruct` annotated method. The [hotspot=sendSystemLoad file=1]`sendSystemLoad()` method calls the client to send a random string from either [hotspot=messages file=1]`cpuLoad`, [hotspot=messages file=1]`memoryUsage`, or [hotspot=messages file=1]`both` to the `system` service. Using the link:https://openliberty.io/docs/latest/reference/javadoc/liberty-jakartaee9.1-javadoc.html?package=jakarta/ejb/package-frame.html&class=jakarta/ejb/TimerService.html[Jakarta Enterprise Beans Timer Service^], annotate the `sendSystemLoad()` method with the [hotspot=schedule file=1]`@Schedule` annotation so that it sends out a message every 10 seconds.
 
 Now, create the front-end UI. The images and styles for the UI are provided for you. 
 

finish/client/pom.xml

@@ -8,8 +8,8 @@
     <packaging>war</packaging>
 
     <properties>
-        <maven.compiler.source>11</maven.compiler.source>
-        <maven.compiler.target>11</maven.compiler.target>
+        <maven.compiler.source>17</maven.compiler.source>
+        <maven.compiler.target>17</maven.compiler.target>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
         <!-- Liberty configuration -->

finish/client/src/main/java/io/openliberty/guides/client/scheduler/SystemLoadScheduler.java

@@ -25,7 +25,7 @@ public class SystemLoadScheduler {
     private SystemClient client;
     // tag::messages[]
     private static final String[] MESSAGES = new String[] {
-        "loadAverage", "memoryUsage", "both" };
+        "cpuLoad", "memoryUsage", "both" };
     // end::messages[]
 
     // tag::postConstruct[]

finish/client/src/main/webapp/index.html

@@ -19,15 +19,15 @@
 <html>
     <head>
         <meta charset="UTF-8">
-        <title>Open Liberty System Load</title>
+        <title>Open Liberty - Jakarta WebSocket Example</title>
         <link rel="stylesheet" href="css/styles.css">
         <link href="favicon.ico" rel="icon" />
         <link href="favicon.ico" rel="shortcut icon" />
     </head>
     <body>
         <section id="appIntro">
             <div id="titleSection">
-                <h1 id="appTitle">Open Liberty System Load</h1>
+                <h1 id="appTitle">Jakarta WebSocket Example</h1>
                 <div class="line"></div>
                 <div class="headerImage"></div>
             </div>
@@ -45,8 +45,9 @@ <h2>System Loads</h2>
                     <table id="systemLoadsTable">
                         <tbody id="systemLoadsTableBody">
                             <tr>
-                                <th>Time</th><th>System Load</th>
-                                <th>Memory Usage (%)</th>
+                                <th>Time</th>
+                                <th>CPU Load (%)</th>
+                                <th>Heap Memory Usage (%)</th>
                             </tr>
                         </tbody>
                     </table>
@@ -76,10 +77,10 @@ <h2>System Loads</h2>
     webSocket.onmessage = function (event) {
         var data = JSON.parse(event.data);
         var tableRow = document.createElement('tr');
-        var loadAverage = data.loadAverage == null ? '-' : data.loadAverage.toFixed(2);
+        var cpuLoad = data.cpuLoad == null ? '-' : data.cpuLoad.toFixed(7);
         var memoryUsage = data.memoryUsage == null ? '-' : data.memoryUsage.toFixed(2);
         tableRow.innerHTML = '<td>' + data.time + '</td>' +
-                             '<td>' + loadAverage + '</td>' +
+                             '<td>' + cpuLoad + '</td>' +
                              '<td>' + memoryUsage + '</td>';
         document.getElementById('systemLoadsTableBody').appendChild(tableRow);
     };

finish/system/pom.xml

@@ -10,8 +10,8 @@
     <packaging>war</packaging>
 
     <properties>
-        <maven.compiler.source>11</maven.compiler.source>
-        <maven.compiler.target>11</maven.compiler.target>
+        <maven.compiler.source>17</maven.compiler.source>
+        <maven.compiler.target>17</maven.compiler.target>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
         <!-- Liberty configuration -->

finish/system/src/main/java/io/openliberty/guides/system/SystemService.java

@@ -13,7 +13,6 @@
 
 import java.lang.management.ManagementFactory;
 import java.lang.management.MemoryMXBean;
-import java.lang.management.OperatingSystemMXBean;
 import java.util.Calendar;
 import java.util.HashSet;
 import java.util.Set;
@@ -30,6 +29,8 @@
 import jakarta.websocket.Session;
 import jakarta.websocket.server.ServerEndpoint;
 
+import com.sun.management.OperatingSystemMXBean;
+
 // tag::serverEndpoint[]
 @ServerEndpoint(value = "/systemLoad",
                 decoders = { SystemLoadDecoder.class },
@@ -42,7 +43,7 @@ public class SystemService {
     private static Set<Session> sessions = new HashSet<>();
 
     private static final OperatingSystemMXBean OS =
-        ManagementFactory.getOperatingSystemMXBean();
+        (OperatingSystemMXBean) ManagementFactory.getOperatingSystemMXBean();
 
     private static final MemoryMXBean MEM =
         ManagementFactory.getMemoryMXBean();
@@ -79,11 +80,11 @@ public void onMessage(String option, Session session) {
         try {
             JsonObjectBuilder builder = Json.createObjectBuilder();
             builder.add("time", Calendar.getInstance().getTime().toString());
-            // tag::loadAverage[]
-            if (option.equalsIgnoreCase("loadAverage")
+            // tag::cpuLoad[]
+            if (option.equalsIgnoreCase("cpuLoad")
                 || option.equalsIgnoreCase("both")) {
-            // end::loadAverage[]
-                builder.add("loadAverage", Double.valueOf(OS.getSystemLoadAverage()));
+            // end::cpuLoad[]
+                builder.add("cpuLoad", Double.valueOf(OS.getCpuLoad() * 100.0));
             }
             // tag::memoryUsageOrBoth[]
             if (option.equalsIgnoreCase("memoryUsage")

finish/system/src/test/java/it/io/openliberty/guides/system/SystemServiceIT.java

@@ -55,7 +55,7 @@ public void testSystemMultipleSessions() throws Exception {
         SystemClient client1 = new SystemClient(uri);
         SystemClient client2 = new SystemClient(uri);
         SystemClient client3 = new SystemClient(uri);
-        client2.sendMessage("loadAverage");
+        client2.sendMessage("cpuLoad");
         countDown.await(5, TimeUnit.SECONDS);
         client1.close();
         client2.close();
@@ -72,7 +72,7 @@ private static void startCountDown(int count) {
     public static void verify(JsonObject systemLoad) {
         assertNotNull(systemLoad.getString("time"));
         assertTrue(
-            systemLoad.getJsonNumber("loadAverage") != null
+            systemLoad.getJsonNumber("cpuLoad") != null
             || systemLoad.getJsonNumber("memoryUsage") != null
         );
         countDown.countDown();

scripts/dailyBuild.sh

@@ -1,13 +1,19 @@
 #!/bin/bash
-while getopts t:d:b: flag;
+while getopts t:d:j:b: flag;
 do
     case "${flag}" in
         t) DATE="${OPTARG}";;
         d) DRIVER="${OPTARG}";;
-        b) BUILD="${OPTARG}";;
+        j) JDK_LEVEL="${OPTARG}";;
+        *) echo "Invalid option";;
     esac
 done
 
+if [ "$JDK_LEVEL" == "11" ]; then
+    echo "Test skipped because the guide does not support Java 11."
+    exit 0
+fi
+
 sed -i "\#<artifactId>liberty-maven-plugin</artifactId>#a<configuration><install><runtimeUrl>https://public.dhe.ibm.com/ibmdl/export/pub/software/openliberty/runtime/nightly/"$DATE"/"$DRIVER"</runtimeUrl></install></configuration>" client/pom.xml system/pom.xml
 cat query/pom.xml system/pom.xml
 

scripts/testApp.sh

@@ -25,9 +25,9 @@ mvn -Dhttp.keepAlive=false \
     -ntp -pl system failsafe:integration-test
 
 sleep 20
-grep loadAverage client/target/liberty/wlp/usr/servers/defaultServer/logs/messages.log || \
+grep cpuLoad client/target/liberty/wlp/usr/servers/defaultServer/logs/messages.log || \
 sleep 20 || \
-grep loadAverage client/target/liberty/wlp/usr/servers/defaultServer/logs/messages.log || exit 1
+grep cpuLoad client/target/liberty/wlp/usr/servers/defaultServer/logs/messages.log || exit 1
 grep memoryUsage client/target/liberty/wlp/usr/servers/defaultServer/logs/messages.log || \
 sleep 20 || \
 grep memoryUsage client/target/liberty/wlp/usr/servers/defaultServer/logs/messages.log || exit 1