Merge pull request #105 from webfirmframework/dev-12.x.x

wffweb-12.0.10 release changes

Author: webfirmframework

wffweb/pom.xml

@@ -4,7 +4,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>com.webfirmframework</groupId>
 	<artifactId>wffweb</artifactId>
-	<version>12.0.9</version>
+	<version>12.0.10</version>
 
 	<properties>
 		<maven.build.timestamp.format>yyyyMMddHHmmss</maven.build.timestamp.format>
@@ -49,7 +49,7 @@
 					<plugin>
 						<groupId>org.sonatype.central</groupId>
 						<artifactId>central-publishing-maven-plugin</artifactId>
-						<version>0.9.0</version>
+						<version>0.10.0</version>
 						<extensions>true</extensions>
 						<configuration>
 							<publishingServerId>central</publishingServerId>
@@ -88,7 +88,7 @@
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
 						<artifactId>maven-source-plugin</artifactId>
-						<version>3.3.1</version>
+						<version>3.4.0</version>
 						<executions>
 							<execution>
 								<id>attach-sources</id>

wffweb/src/main/java/com/webfirmframework/wffweb/internal/tag/html/listener/ChildTagRemoveListener.java

@@ -31,6 +31,6 @@ public static record Event(AbstractHtml parentTag, AbstractHtml removedChildTag,
 
     public void childrenRemoved(Event event);
 
-    public void allChildrenRemoved(Event event);
+    public boolean allChildrenRemoved(Event event);
 
 }

wffweb/src/main/java/com/webfirmframework/wffweb/server/page/BrowserPage.java

@@ -190,13 +190,13 @@ public abstract class BrowserPage implements Serializable {
 
     private static final int INITIAL_WS_DEFAULT_HEARTBEAT_INTERVAL = 25_000;
 
-    private static final int INITIAL_WS_DEFAULT_HEARTBEAT_TIMEOUT = INITIAL_WS_DEFAULT_HEARTBEAT_INTERVAL;
+    private static final int INITIAL_WS_DEFAULT_HEARTBEAT_TIMEOUT = 10_000;
 
     private static volatile int wsDefaultHeartbeatInterval = INITIAL_WS_DEFAULT_HEARTBEAT_INTERVAL;
 
     private static volatile int wsDefaultReconnectInterval = 2_000;
 
-    private static volatile int wsDefaultHeartbeatTimeout = 10_000;
+    private static volatile int wsDefaultHeartbeatTimeout = INITIAL_WS_DEFAULT_HEARTBEAT_TIMEOUT;
 
     private final LongAdder pushQueueSize = new LongAdder();
 
@@ -247,6 +247,8 @@ public abstract class BrowserPage implements Serializable {
 
     private final AtomicInteger clientSidePayloadIdGenerator = new AtomicInteger();
 
+    private final AtomicBoolean hasHitBufferOutOfMemory = new AtomicBoolean();
+
     private static final long DEFAULT_IO_BUFFER_TIMEOUT = TimeUnit.MILLISECONDS
             .toNanos(INITIAL_WS_DEFAULT_HEARTBEAT_INTERVAL);
 
@@ -606,9 +608,9 @@ public final WebSocketPushListener getWsListener() {
         return wsListenerHolder != null ? wsListenerHolder.webSocketPushListener : null;
     }
 
-    final void push(final NameValue... nameValues) {
+    final boolean push(final NameValue... nameValues) {
         final ByteBuffer payload = buildPayload(WffBinaryMessageUtil.VERSION_1.getWffBinaryMessageBytes(nameValues));
-        push(new ClientTasksWrapper(payload));
+        return push(new ClientTasksWrapper(payload));
     }
 
     /**
@@ -631,8 +633,10 @@ final ClientTasksWrapper pushAndGetWrapper(final Queue<Collection<NameValue>> mu
         }
 
         final ClientTasksWrapper clientTasks = new ClientTasksWrapper(tasks);
-        push(clientTasks);
-        return clientTasks;
+        if (push(clientTasks)) {
+            return clientTasks;
+        }
+        return null;
     }
 
     private void pushLockless(final ClientTasksWrapper clientTasks) {
@@ -652,23 +656,40 @@ private void pushLockless(final ClientTasksWrapper clientTasks) {
         }
     }
 
-    private void push(final ClientTasksWrapper clientTasks) {
+    private boolean push(final ClientTasksWrapper clientTasks) {
         if (outputBufferLimitLock != null) {
             final WebSocketPushListenerHolder wsListenerCurrent = wsListener;
             if (wsListenerCurrent == null || (!wsListenerCurrent.serverSideActionPerformed.get()
                     && !wsListenerCurrent.clientSideJSExecuted.get())) {
                 try {
+                    // if wsListenerCurrent is null there is no advantage of waiting
+                    final boolean acquired = isQuickTryAcquireApplicableWithNoBOMCheck(wsListenerCurrent)
+                            ? outputBufferLimitLock.tryAcquire(clientTasks.getCurrentSize())
+                            : outputBufferLimitLock.tryAcquire(clientTasks.getCurrentSize(),
+                                    settings.outputBufferTimeout, TimeUnit.NANOSECONDS);
                     // onPayloadLoss check should be second
-                    if (outputBufferLimitLock.tryAcquire(clientTasks.getCurrentSize(), settings.outputBufferTimeout,
-                            TimeUnit.NANOSECONDS) || onPayloadLoss == null) {
+                    if (acquired || onPayloadLoss == null) {
                         pushLockless(clientTasks);
+                        return true;
                     } else {
-                        if (LOGGER.isLoggable(Level.SEVERE)) {
-                            LOGGER.severe(
-                                    """
-                                            Buffer timeout reached while preparing server event for client so further changes will not be pushed to client.
-                                             Increase Settings.outputBufferLimit or Settings.outputBufferTimeout to solve this issue.
-                                             NB: Settings.outputBufferTimeout should be <= maxIdleTimeout by BrowserPageContent.enableAutoClean method.""");
+                        if (LOGGER.isLoggable(Level.SEVERE) || LOGGER.isLoggable(Level.FINEST)) {
+                            if (wsListenerCurrent != null) {
+                                if (LOGGER.isLoggable(Level.SEVERE)) {
+                                    LOGGER.severe(
+                                            """
+                                                    Buffer timeout reached while preparing server event for client so further changes will not be pushed to client.
+                                                    Increase Settings.outputBufferLimit or Settings.outputBufferTimeout to solve this issue.
+                                                    NB: Settings.outputBufferTimeout should be <= maxIdleTimeout by BrowserPageContent.enableAutoClean method.""");
+                                }
+                            } else {
+                                if (LOGGER.isLoggable(Level.FINEST)) {
+                                    LOGGER.finest(
+                                            """
+                                                    Buffer timeout reached while preparing server event for client so further changes will not be pushed to client and there is no active websocket connection available at the moment.
+                                                    Increase Settings.outputBufferLimit or Settings.outputBufferTimeout to solve this issue.
+                                                    NB: Settings.outputBufferTimeout should be <= maxIdleTimeout by BrowserPageContent.enableAutoClean method.""");
+                                }
+                            }
                         }
                         if (wsListenerCurrent != null && !wsListenerCurrent.clientSideJSExecuted.get()
                                 && onPayloadLoss.javaScript != null && !onPayloadLoss.javaScript.isBlank()) {
@@ -691,6 +712,7 @@ private void push(final ClientTasksWrapper clientTasks) {
                                 wffBMBytesQueue.offerFirst(new ClientTasksWrapper(clientAction));
                             }
                             wsListenerCurrent.clientSideJSExecuted.set(true);
+                            hasHitBufferOutOfMemory.set(true);
                         }
 
                     }
@@ -702,7 +724,9 @@ private void push(final ClientTasksWrapper clientTasks) {
             }
         } else {
             pushLockless(clientTasks);
+            return true;
         }
+        return false;
     }
 
     private void pushWffBMBytesQueue() {
@@ -783,7 +807,7 @@ private void pushWffBMBytesQueue() {
 
                             if (pushWffBMBytesQueueLock.hasQueuedThreads()) {
                                 final Thread waitingThread = waitingThreadRef.get();
-                                if (waitingThread != null && !waitingThread.equals(taskThread)
+                                if (waitingThread != null && waitingThread != taskThread
                                         && waitingThread.getPriority() >= taskThread.getPriority()) {
                                     break;
                                 }
@@ -911,22 +935,34 @@ final void webSocketMessagedWithoutLosslessCheck(final byte[] message) {
 
         if (inputBufferLimitLock != null) {
             try {
+                final WebSocketPushListenerHolder wsListenerCurrent = wsListener;
+                final boolean acquired = isQuickTryAcquireApplicable(wsListenerCurrent)
+                        ? inputBufferLimitLock.tryAcquire(message.length)
+                        : inputBufferLimitLock.tryAcquire(message.length, settings.inputBufferTimeout,
+                                TimeUnit.NANOSECONDS);
                 // onPayloadLoss check should be second
-                if (inputBufferLimitLock.tryAcquire(message.length, settings.inputBufferTimeout, TimeUnit.NANOSECONDS)
-                        || onPayloadLoss == null) {
+                if (acquired || onPayloadLoss == null) {
                     taskFromClientQ.offer(message);
                 } else {
-                    if (LOGGER.isLoggable(Level.SEVERE)) {
-                        LOGGER.severe(
-                                """
-                                        Buffer timeout reached while processing event from client so further client events will not be received at server side.
-                                         Increase Settings.inputBufferLimit or Settings.inputBufferTimeout to solve this issue.
-                                         NB: Settings.inputBufferTimeout should be <= maxIdleTimeout by BrowserPageContent.enableAutoClean method.""");
+                    if (LOGGER.isLoggable(Level.SEVERE) || LOGGER.isLoggable(Level.FINEST)) {
+                        final String msg = """
+                                Buffer timeout reached while processing event from client so further client events will not be received at server side.
+                                Increase Settings.inputBufferLimit or Settings.inputBufferTimeout to solve this issue.
+                                NB: Settings.inputBufferTimeout should be <= maxIdleTimeout by BrowserPageContent.enableAutoClean method.""";
+                        if (wsListenerCurrent != null) {
+                            if (LOGGER.isLoggable(Level.SEVERE)) {
+                                LOGGER.severe(msg);
+                            }
+                        } else {
+                            if (LOGGER.isLoggable(Level.FINEST)) {
+                                LOGGER.finest(msg);
+                            }
+                        }
                     }
-                    final WebSocketPushListenerHolder wsListenerCurrent = wsListener;
                     if (wsListenerCurrent != null && onPayloadLoss.serverSideAction != null) {
                         onPayloadLoss.serverSideAction.perform();
                         wsListenerCurrent.serverSideActionPerformed.set(true);
+                        hasHitBufferOutOfMemory.set(true);
                     }
                 }
             } catch (final InterruptedException e) {
@@ -968,6 +1004,7 @@ final boolean checkLosslessCommunication(final byte[] message) {
                 }
                 onPayloadLoss.serverSideAction.perform();
                 wsListenerCurrent.serverSideActionPerformed.set(true);
+                hasHitBufferOutOfMemory.set(true);
                 return false;
             }
         }
@@ -3481,4 +3518,23 @@ private int getClientSidePayloadId() {
         return id;
     }
 
+    private boolean isQuickTryAcquireApplicable(final WebSocketPushListenerHolder wsListenerCurrent) {
+        return wsListenerCurrent == null || hasHitBufferOutOfMemory.get() || (wsHeartbeatInterval > 0
+                && wsHeartbeatTimeout > 0
+                && (System.currentTimeMillis() - lastClientAccessedTime) > (wsHeartbeatInterval + wsHeartbeatTimeout));
+    }
+
+    private boolean isQuickTryAcquireApplicableWithNoBOMCheck(final WebSocketPushListenerHolder wsListenerCurrent) {
+        return wsListenerCurrent == null || (wsHeartbeatInterval > 0 && wsHeartbeatTimeout > 0
+                && (System.currentTimeMillis() - lastClientAccessedTime) > (wsHeartbeatInterval + wsHeartbeatTimeout));
+    }
+
+    /**
+     * @return true if the browser page has hit out of memory.
+     * @since 12.0.10
+     */
+    public final boolean hasHitBufferOutOfMemory() {
+        return hasHitBufferOutOfMemory.get();
+    }
+
 }

wffweb/src/main/java/com/webfirmframework/wffweb/server/page/BrowserPageContext.java

@@ -26,7 +26,6 @@
 import java.util.Queue;
 import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
-import java.util.concurrent.ConcurrentLinkedQueue;
 import java.util.concurrent.Executor;
 import java.util.concurrent.Executors;
 import java.util.concurrent.ScheduledExecutorService;
@@ -86,13 +85,6 @@ public enum BrowserPageContext {
 
     private transient final ReferenceQueue<BrowserPage> browserPageRQ;
 
-    private transient final Queue<BrowserPageGCTask> browserPageGCTasksQ;
-
-    // NB: this caching is required trigger to enqueue to ReferenceQueue when
-    // BrowserPageGCTask object is GCed
-    // also remove it from this cache when polled from browserPageRQ
-    private transient final Set<BrowserPageGCTask> browserPageGCTasksCache;
-
     /**
      * Note: Only for internal use.
      *
@@ -120,8 +112,6 @@ private BrowserPageSessionWrapper(final String httpSessionId) {
         instanceIdBPForWS = new ConcurrentHashMap<>();
         instanceIdHttpSessionId = new ConcurrentHashMap<>();
         browserPageRQ = new ReferenceQueue<>();
-        browserPageGCTasksQ = new ConcurrentLinkedQueue<>();
-        browserPageGCTasksCache = ConcurrentHashMap.newKeySet(2);
 
         initConfig();
     }
@@ -170,10 +160,8 @@ public BrowserPageSession addBrowserPage(final String httpSessionId, final Brows
         }
 
         if (browserPage.getExternalDrivePath() != null) {
-            // NB: this caching is required trigger to enqueue to ReferenceQueue when
-            // BrowserPageGCTask object is GCed
-            // also remove it from this cache when polled from browserPageRQ
-            browserPageGCTasksCache.add(new BrowserPageGCTask(browserPage, browserPageRQ));
+            // the object is registered in Cleaner object in the constructor.
+            new BrowserPageGCTask(browserPage, browserPageRQ);
         }
 
         runAutoClean();
@@ -579,20 +567,18 @@ public void clean(final long maxIdleTimeout) {
             });
         }
 
-        Reference<? extends BrowserPage> gcTask;
-        while ((gcTask = browserPageRQ.poll()) != null) {
-            gcTask.clear();
-            browserPageGCTasksQ.offer((BrowserPageGCTask) gcTask);
-        }
-
         runGCTasksForBrowserPage();
     }
 
     private void runGCTasksForBrowserPage() {
-        BrowserPageGCTask gcTask;
-        while ((gcTask = browserPageGCTasksQ.poll()) != null) {
-            browserPageGCTasksCache.remove(gcTask);
-            gcTask.run();
+        // Never call gcTask.clear(), it may lead to potential race condition (We faced
+        // similar bug.).
+        // Read javadoc for more details.
+        Reference<? extends BrowserPage> gcTask;
+        while ((gcTask = browserPageRQ.poll()) != null) {
+            if (gcTask instanceof final BrowserPageGCTask browserPageGCTask) {
+                browserPageGCTask.clean();
+            }
         }
     }
 
@@ -687,11 +673,7 @@ public boolean isAutoCleanEnabled() {
      * @since 12.0.1
      */
     public void runAutoClean() {
-        Reference<? extends BrowserPage> gcTask;
-        while ((gcTask = browserPageRQ.poll()) != null) {
-            gcTask.clear();
-            browserPageGCTasksQ.offer((BrowserPageGCTask) gcTask);
-        }
+        runGCTasksForBrowserPage();
         final MinIntervalExecutor autoCleanTaskExecutor = this.autoCleanTaskExecutor;
         if (autoCleanTaskExecutor != null) {
             autoCleanTaskExecutor.runAsync();
@@ -954,9 +936,10 @@ public boolean exists(final BrowserPage browserPage) throws NullValueException {
      * Checks the existence of valid {@code browserPage} in this context.
      *
      * <br>
-     * Note: this operation is not atomic. The validity is time dependent, even if
+     * Note: this operation is not atomic. The validity is time-dependent, even if
      * the method returns true {@code browserPage} could be invalid in the next
-     * moment. However, if it returns false it is trust worthy.
+     * moment. However, if it returns false it is trustworthy. Even if the browser
+     * page has hit buffer out of memory then also it will return false.
      *
      * @param browserPage
      * @return true if the given browserPage exists in the BrowserPageContext and
@@ -972,7 +955,9 @@ public boolean existsAndValid(final BrowserPage browserPage) throws NullValueExc
         if (browserPage == null) {
             throw new NullValueException("browserPage instance cannot be null");
         }
-
+        if (browserPage.hasHitBufferOutOfMemory()) {
+            return false;
+        }
         final MinIntervalExecutor autoCleanTaskExecutor = this.autoCleanTaskExecutor;
         if (autoCleanTaskExecutor != null) {
             if ((System.currentTimeMillis() - browserPage.getLastClientAccessedTime()) >= autoCleanTaskExecutor

wffweb/src/main/java/com/webfirmframework/wffweb/server/page/BrowserPageGCTask.java

@@ -15,30 +15,43 @@
  */
 package com.webfirmframework.wffweb.server.page;
 
+import java.lang.ref.Cleaner;
 import java.lang.ref.ReferenceQueue;
 import java.lang.ref.WeakReference;
 
+import com.webfirmframework.wffweb.settings.WffConfiguration;
 import com.webfirmframework.wffweb.util.FileUtil;
 
 /**
  * @author WFF
  * @since 3.0.18
  *
  */
-class BrowserPageGCTask extends WeakReference<BrowserPage> {
+class BrowserPageGCTask extends WeakReference<BrowserPage> implements Runnable {
 
     private final String externalDrivePath;
 
     private final String subDirName;
 
+    private final Cleaner.Cleanable cleanable;
+
     BrowserPageGCTask(final BrowserPage referent, final ReferenceQueue<? super BrowserPage> q) {
         super(referent, q);
         externalDrivePath = referent.getExternalDrivePath();
         subDirName = referent.getInstanceId();
+        cleanable = WffConfiguration.secondaryCleaner().register(referent, this);
     }
 
-    void run() {
+    @Override
+    public void run() {
         FileUtil.removeDirRecursively(externalDrivePath, subDirName);
     }
 
+    /**
+     * @since 12.0.10
+     */
+    void clean() {
+        cleanable.clean();
+    }
+
 }