Merge pull request #4998 from eclipse-ee4j/mojarra-issue-4977_improved-fix

Flash doPostPhaseActions() should be done before endDocument()

Author: arjantijms

impl/src/main/java/com/sun/faces/application/view/FaceletViewHandlingStrategy.java

@@ -128,7 +128,6 @@
 import com.sun.faces.application.ApplicationAssociate;
 import com.sun.faces.config.WebConfiguration;
 import com.sun.faces.context.StateContext;
-import com.sun.faces.context.flash.ELFlash;
 import com.sun.faces.facelets.el.ContextualCompositeMethodExpression;
 import com.sun.faces.facelets.el.VariableMapperWrapper;
 import com.sun.faces.facelets.impl.DefaultFaceletFactory;
@@ -438,20 +437,9 @@ public void renderView(FacesContext ctx, UIViewRoot viewToRender) throws IOExcep
             ResponseWriter writer = origWriter.cloneWithWriter(stateWriter);
             ctx.setResponseWriter(writer);
 
-            //  Don't call startDoc and endDoc on a partial response
             if (ctx.getPartialViewContext().isPartialRequest()) {
-                Map<Object, Object> contextMap = ctx.getAttributes();
-                contextMap.put(ELFlash.DELAYED_END_DOCUMENT, true);
+                // Any pre/post processing logic such as startDocument(), doPostPhaseActions() and endDocument() must be done in PartialViewContextImpl, see also #4977
                 viewToRender.encodeAll(ctx);
-                contextMap.remove(ELFlash.DELAYED_END_DOCUMENT);
-                try {
-                    ctx.getExternalContext().getFlash().doPostPhaseActions(ctx);
-                } catch (UnsupportedOperationException uoe) {
-                    if (LOGGER.isLoggable(FINE)) {
-                        LOGGER.fine("ExternalContext.getFlash() throw UnsupportedOperationException -> Flash unavailable");
-                    }
-                }
-                ctx.getPartialViewContext().getPartialResponseWriter().endDocument();
             } else {
                 if (ctx.isProjectStage(Development)) {
                     FormOmittedChecker.check(ctx);

impl/src/main/java/com/sun/faces/context/PartialViewContextImpl.java

@@ -19,6 +19,7 @@
 import static com.sun.faces.renderkit.RenderKitUtils.PredefinedPostbackParameter.PARTIAL_EXECUTE_PARAM;
 import static com.sun.faces.renderkit.RenderKitUtils.PredefinedPostbackParameter.PARTIAL_RENDER_PARAM;
 import static com.sun.faces.renderkit.RenderKitUtils.PredefinedPostbackParameter.PARTIAL_RESET_VALUES_PARAM;
+import static java.util.logging.Level.FINE;
 import static javax.faces.FactoryFinder.VISIT_CONTEXT_FACTORY;
 
 import java.io.IOException;
@@ -56,7 +57,6 @@
 
 import com.sun.faces.RIConstants;
 import com.sun.faces.component.visit.PartialVisitContext;
-import com.sun.faces.context.flash.ELFlash;
 import com.sun.faces.renderkit.RenderKitUtils.PredefinedPostbackParameter;
 import com.sun.faces.util.FacesLogger;
 import com.sun.faces.util.HtmlUtils;
@@ -308,6 +308,7 @@ public void processPartial(PhaseId phaseId) {
                 if (isRenderAll()) {
                     renderAll(ctx, viewRoot);
                     renderState(ctx);
+                    doFlashPostPhaseActions(ctx);
                     writer.endDocument();
                     return;
                 }
@@ -322,10 +323,9 @@ public void processPartial(PhaseId phaseId) {
 
                 renderState(ctx);
                 renderEvalScripts(ctx);
+                doFlashPostPhaseActions(ctx);
 
-                if (!ctx.getAttributes().containsKey(ELFlash.DELAYED_END_DOCUMENT) || !(Boolean) ctx.getAttributes().get(ELFlash.DELAYED_END_DOCUMENT)) {
-                    writer.endDocument();
-                }
+                writer.endDocument();
             } catch (IOException ex) {
                 this.cleanupAfterView();
             } catch (RuntimeException ex) {
@@ -335,6 +335,16 @@ public void processPartial(PhaseId phaseId) {
             }
         }
     }
+    
+    private void doFlashPostPhaseActions(FacesContext ctx) {
+        try {
+            ctx.getExternalContext().getFlash().doPostPhaseActions(ctx);
+        } catch (UnsupportedOperationException uoe) {
+            if (LOGGER.isLoggable(FINE)) {
+                LOGGER.fine("ExternalContext.getFlash() throw UnsupportedOperationException -> Flash unavailable");
+            }
+        }
+    }
 
     /**
      * @see javax.faces.context.PartialViewContext#getPartialResponseWriter()

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

@@ -661,9 +661,6 @@ public void doPostPhaseActions(FacesContext context) {
     public static final String ACT_AS_DO_LAST_PHASE_ACTIONS = 
             ELFlash.class.getPackage().getName() + ".ACT_AS_DO_LAST_PHASE_ACTIONS";
 
-    public static final String DELAYED_END_DOCUMENT =
-            ELFlash.class.getPackage().getName() + ".DELAYED_END_DOCUMENT";
-
     /**
      * <p>This is the most magic of methods.  There are several scenarios
      * in which this method can be called, but the first time it is