Merge pull request #5566 from eclipse-ee4j/issue__5552

Add clue to error log when flash is unavailable after server restart without session persistence

Author: BalusC

impl/src/main/java/com/sun/faces/context/flash/ELFlash.java

@@ -37,12 +37,6 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
-import com.sun.faces.config.WebConfiguration;
-import com.sun.faces.config.WebConfiguration.WebContextInitParameter;
-import com.sun.faces.facelets.tag.ui.UIDebug;
-import com.sun.faces.util.ByteArrayGuardAESCTR;
-import com.sun.faces.util.FacesLogger;
-
 import jakarta.faces.application.FacesMessage;
 import jakarta.faces.component.UIViewRoot;
 import jakarta.faces.context.ExternalContext;
@@ -56,6 +50,12 @@
 import jakarta.servlet.http.Cookie;
 import jakarta.servlet.http.HttpServletRequest;
 
+import com.sun.faces.config.WebConfiguration;
+import com.sun.faces.config.WebConfiguration.WebContextInitParameter;
+import com.sun.faces.facelets.tag.ui.UIDebug;
+import com.sun.faces.util.ByteArrayGuardAESCTR;
+import com.sun.faces.util.FacesLogger;
+
 /**
  * <p>
  * How this implementation works
@@ -156,7 +156,7 @@ public class ELFlash extends Flash {
      */
     static final String FLASH_NOW_REQUEST_KEY = FLASH_ATTRIBUTE_NAME + "n";
 
-    private enum CONSTANTS {
+    enum CONSTANTS {
 
         /**
          * The key in the FacesContext attributes map (hereafter referred to as contextMap) for the request scoped
@@ -209,7 +209,7 @@ private enum CONSTANTS {
     // <editor-fold defaultstate="collapsed" desc="Constructors and instance accessors">
 
     /** Creates a new instance of ELFlash */
-    private ELFlash(ExternalContext extContext) {
+    ELFlash(ExternalContext extContext) {
         flashInnerMap = new ConcurrentHashMap<>();
         WebConfiguration config = WebConfiguration.getInstance(extContext);
         String value;
@@ -721,7 +721,7 @@ boolean isKeepFlagSet(FacesContext context) {
         return Boolean.TRUE == context.getAttributes().get(CONSTANTS.KeepFlagAttributeName);
     }
 
-    private long getNewSequenceNumber() {
+    long getNewSequenceNumber() {
         long result = sequenceNumber.incrementAndGet();
 
         if (0 == result % numberOfFlashesBetweenFlashReapings) {
@@ -1174,7 +1174,7 @@ private PreviousNextFlashInfoManager getCurrentFlashManager(FacesContext context
      * </p>
      */
 
-    private static final class PreviousNextFlashInfoManager {
+    static final class PreviousNextFlashInfoManager {
 
         private FlashInfo previousRequestFlashInfo;
 
@@ -1190,7 +1190,7 @@ private PreviousNextFlashInfoManager(ByteArrayGuardAESCTR guard) {
             this.guard = guard;
         }
 
-        private PreviousNextFlashInfoManager(ByteArrayGuardAESCTR guard, Map<String, Map<String, Object>> innerMap) {
+        PreviousNextFlashInfoManager(ByteArrayGuardAESCTR guard, Map<String, Map<String, Object>> innerMap) {
             this.guard = guard;
             this.innerMap = innerMap;
         }
@@ -1366,6 +1366,8 @@ void decode(FacesContext context, ELFlash flash, Cookie cookie) throws InvalidKe
                     nextRequestFlashInfo.setFlashMap(flashMap);
                 }
             } catch (Throwable t) {
+                previousRequestFlashInfo = new FlashInfo();
+                previousRequestFlashInfo.setFlashMap(new HashMap<>(1));
                 context.getAttributes().put(CONSTANTS.ForceSetMaxAgeZero, Boolean.TRUE);
                 if (LOGGER.isLoggable(Level.SEVERE)) {
                     LOGGER.log(Level.SEVERE, "faces.externalcontext.flash.bad.cookie", new Object[] { value });
@@ -1441,7 +1443,7 @@ void setIncomingCookieCameFromRedirect(boolean incomingCookieCameFromRedirect) {
      * Encapsulate one of the two maps that back the flash for the current request.
      * </p>
      */
-    private static final class FlashInfo {
+    static final class FlashInfo {
 
         /**
          * <p>

impl/src/main/resources/com/sun/faces/LogStrings.properties

@@ -119,7 +119,7 @@ faces.config.legacy.facelet.warning=JSF1029:  Application is versioned at 2.0 (e
 faces.view.cannot.render.response.committed=JSF1030: Unable to render view ''{0}'' as the response has already been committed.
 faces.compcomp.unecessary.targets.attribute=JSF1092: {0} : Unnecessary specification of the ''targets'' attribute for composite attribute ''{1}''.  The ''targets'' attribute is only necessary when the composite attribute is named ''action'', ''actionListener'', ''validator'', or ''valueChangeListener''.
 faces.compcomp.binding.eval.non.compcomp=JSF1093: {0} : UIComponent returned by expression evaluation is not a valid composite component.  Value will be ignored.
-faces.externalcontext.flash.bad.cookie=JSF1094: Could not decode flash data from incoming cookie value {0}.  Processing will continue, but the flash is unavailable for this request.
+faces.externalcontext.flash.bad.cookie=JSF1094: Could not decode flash data from incoming cookie value {0}.  Processing will continue, but the flash is unavailable for this request.  Most probably server was restarted without session persistence.  One solution is to set java:comp/env/faces/FlashSecretKey with a fixed AES256 key. 
 faces.externalcontext.flash.response.already.committed=JSF1095: The response was already committed by the time we tried to set the outgoing cookie for the flash.  Any values stored to the flash will not be available on the next request.
 faces.metadata.uiviewroot.unavailable=JSF1096: UIViewRoot unavailable at the time view metadata was being processed.  Metadata will be unavailable.
 faces.application.resource.invalid_if_modified_since_header=JSF1097: Unable to parse date sent by User Agent for If-Modified-Since header, {0}.