You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by ta...@apache.org on 2023/07/31 08:52:01 UTC

[myfaces] branch main updated: MYFACES-4612: FacesMessages don't store in different collections (#593)

This is an automated email from the ASF dual-hosted git repository.

tandraschko pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/myfaces.git


The following commit(s) were added to refs/heads/main by this push:
     new ba889620c MYFACES-4612: FacesMessages don't store in different collections (#593)
ba889620c is described below

commit ba889620c057fcb3d8c4050b925f9ede16d46e4e
Author: Melloware <me...@gmail.com>
AuthorDate: Mon Jul 31 04:51:55 2023 -0400

    MYFACES-4612: FacesMessages don't store in different collections (#593)
---
 .../myfaces/context/servlet/FacesContextImpl.java  |  48 ++++-----
 .../context/servlet/FacesMessageIterator.java      | 108 +++++++++++++++++++++
 2 files changed, 132 insertions(+), 24 deletions(-)

diff --git a/impl/src/main/java/org/apache/myfaces/context/servlet/FacesContextImpl.java b/impl/src/main/java/org/apache/myfaces/context/servlet/FacesContextImpl.java
index 76d3e1996..de0a43ca8 100755
--- a/impl/src/main/java/org/apache/myfaces/context/servlet/FacesContextImpl.java
+++ b/impl/src/main/java/org/apache/myfaces/context/servlet/FacesContextImpl.java
@@ -55,12 +55,10 @@ import org.apache.myfaces.core.api.shared.lang.Assert;
  */
 public class FacesContextImpl extends FacesContextImplBase
 {
-    static final String RE_SPLITTER = "[\\s\\t\\r\\n]*\\,[\\s\\t\\r\\n]*";
     
     // ~ Instance fields ----------------------------------------------------------------------------
     
     private Map<String, List<FacesMessage>> _messages = null;
-    private List<FacesMessage> _orderedMessages = null;
     private PhaseId _currentPhaseId;
     private ResponseStream _responseStream = null;
     private ResponseWriter _responseWriter = null;
@@ -87,8 +85,8 @@ public class FacesContextImpl extends FacesContextImplBase
     }
     
     /**
-     * Private constructor used in internal construtor chain.
-     * @param externalContext
+     * Private constructor used in internal constructor chain.
+     * @param externalContext the external context
      */
     private FacesContextImpl(ServletExternalContextImpl externalContext)
     {
@@ -97,10 +95,10 @@ public class FacesContextImpl extends FacesContextImplBase
     
     /**
      * Creates a FacesContextImpl with the given ExternalContext,
-     * ReleaseableExternalContext and ReleaseableFacesContextFactory.
-     * @param externalContext
-     * @param defaultExternalContext
-     * @param facesContextFactory
+     * ReleasableExternalContext and ReleasableFacesContextFactory.
+     * @param externalContext the external context
+     * @param defaultExternalContext the default context if the external context is null
+     * @param facesContextFactory the factory for creating context
      */
     public FacesContextImpl(final ExternalContext externalContext,
             final ExternalContext defaultExternalContext , 
@@ -143,7 +141,6 @@ public class FacesContextImpl extends FacesContextImplBase
         }
 
         _messages = null;
-        _orderedMessages = null;
         _currentPhaseId = null;
         _responseStream = null;
         _responseWriter = null;
@@ -181,13 +178,10 @@ public class FacesContextImpl extends FacesContextImplBase
         if (_messages == null)
         {
             _messages = new LinkedHashMap<>(5, 1f);
-            _orderedMessages = new ArrayList<>();
         }
 
-        List<FacesMessage> lst = _messages.computeIfAbsent(clientId, k -> new ArrayList<>(3));         
+        List<FacesMessage> lst = _messages.computeIfAbsent(clientId, k -> new ArrayList<>(3));
         lst.add(message);
-
-        _orderedMessages.add(message);
         
         FacesMessage.Severity serSeverity = message.getSeverity();
         if (serSeverity != null)
@@ -208,12 +202,17 @@ public class FacesContextImpl extends FacesContextImplBase
     {
         assertNotReleased();
         
-        if (_messages == null)
+        if (_messages == null || _messages.size() == 0)
         {
-            return Collections.unmodifiableList(Collections.emptyList());
+            return Collections.emptyList();
         }
         
-        return Collections.unmodifiableList(_orderedMessages);
+        List<FacesMessage> orderedMessages = new ArrayList<>();
+        for (List<FacesMessage> list : _messages.values())
+        {
+            orderedMessages.addAll(list);
+        }
+        return Collections.unmodifiableList(orderedMessages);
     }
 
     @Override
@@ -223,7 +222,7 @@ public class FacesContextImpl extends FacesContextImplBase
         
         if (_messages == null || !_messages.containsKey(clientId))
         {
-            return Collections.unmodifiableList(Collections.emptyList());
+            return Collections.emptyList();
         }
         
         return _messages.get(clientId);
@@ -234,12 +233,13 @@ public class FacesContextImpl extends FacesContextImplBase
     {
         assertNotReleased();
 
-        if (_messages == null)
+        if (_messages == null || _messages.size() == 0)
         {
-            return Collections.emptyIterator();
+            List<FacesMessage> emptyList = Collections.emptyList();
+            return emptyList.iterator();
         }
-        
-        return _orderedMessages.iterator();
+
+        return new FacesMessageIterator(_messages);
     }
 
     @Override
@@ -253,7 +253,7 @@ public class FacesContextImpl extends FacesContextImplBase
             return Collections.emptyIterator();
         }
         
-        return _messages.get(clientId).iterator();        
+        return _messages.get(clientId).iterator();
     }
     
     @Override
@@ -389,7 +389,7 @@ public class FacesContextImpl extends FacesContextImplBase
             // 
             // Setting a "phantom" UIViewRoot calling facesContext.setViewRoot(viewRoot)
             // to avoid it is bad, because this is work of RestoreViewExecutor,
-            // and theorically ViewHandler.restoreView must return an UIViewRoot
+            // and theoretically ViewHandler.restoreView must return an UIViewRoot
             // instance.
             //
             // The problem with this is if the user changes the renderkit directly
@@ -430,4 +430,4 @@ public class FacesContextImpl extends FacesContextImplBase
         assertNotReleased();
         return _lifecycle;
     }
-}
+}
\ No newline at end of file
diff --git a/impl/src/main/java/org/apache/myfaces/context/servlet/FacesMessageIterator.java b/impl/src/main/java/org/apache/myfaces/context/servlet/FacesMessageIterator.java
new file mode 100644
index 000000000..f71e4ef21
--- /dev/null
+++ b/impl/src/main/java/org/apache/myfaces/context/servlet/FacesMessageIterator.java
@@ -0,0 +1,108 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.myfaces.context.servlet;
+
+import jakarta.faces.application.FacesMessage;
+
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.NoSuchElementException;
+
+/**
+ * Iterator to properly handle iterating and removing FacesMessage records.
+ */
+public class FacesMessageIterator implements Iterator<FacesMessage>
+{
+
+    private final Map<String, List<FacesMessage>> messages;
+    private int outerIndex = -1;
+    private final int messagesSize;
+    private Iterator<FacesMessage> inner;
+    private final Iterator<String> keys;
+
+    FacesMessageIterator(Map<String, List<FacesMessage>> messages)
+    {
+        this.messages = messages;
+        messagesSize = messages.size();
+        keys = messages.keySet().iterator();
+
+    }
+
+    @Override
+    public boolean hasNext()
+    {
+        if (outerIndex == -1)
+        {
+            // pop our first List, if any;
+            outerIndex++;
+            inner = messages.get(keys.next()).iterator();
+
+        }
+        while (!inner.hasNext())
+        {
+            outerIndex++;
+            if (outerIndex < messagesSize)
+            {
+                inner = messages.get(keys.next()).iterator();
+            }
+            else
+            {
+                return false;
+            }
+        }
+        return inner.hasNext();
+    }
+
+    @Override
+    public FacesMessage next()
+    {
+        if (outerIndex >= messagesSize)
+        {
+            throw new NoSuchElementException();
+        }
+        if (inner != null && inner.hasNext())
+        {
+            return inner.next();
+        }
+        else
+        {
+            // call this.hasNext() to properly initialize/position 'inner'
+            if (!hasNext())
+            {
+                throw new NoSuchElementException();
+            }
+            else
+            {
+                return inner.next();
+            }
+        }
+    }
+
+    @Override
+    public void remove()
+    {
+        if (outerIndex == -1)
+        {
+            throw new IllegalStateException();
+        }
+        inner.remove();
+    }
+
+}
\ No newline at end of file