[
http://jira.jboss.com/jira/browse/JBSEAM-1822?page=comments#action_12378717 ]
Sam Roberton commented on JBSEAM-1822:
--------------------------------------
The relevant excerpt from the JSF 1.2 spec is in section 11.3: "The JSF
implementation must guarantee that, if beforePhase() has been called on a particular
instance, then afterPhase() will also be called, regardless of any Exceptions that may
have been thrown during the actual execution of the lifecycle phase."
SeamPhaseListener relies on this behaviour: it relies on the fact that either
afterRender(FacesContext) or afterResponseComplete(FacesContext) is called in order to
clean up the contexts by calling Manager.instance().endRequest(Map) and
FacesLifecycle.endRequest(ExternalContext).
Therefore, since the phase listener 'after phase' methods will be called by a JSF
implementation, but are not called by BaseSeamTest, BaseSeamTest is not accurately
modelling (and so can't accurately be testing) the behaviour of the live application.
I'm about to attach a test case which highlights one problem which manifests itself
because of this: the conversation context is not flushed if the 'after phase'
event is not called, and so incorrect conversation behaviour can be observed from test
classes. No doubt this is not the only problem that's caused by not calling
'after phase' events, but it's the simplest one I can come up with a test case
for.
BaseSeamTest does not properly emulateJsfLifecycle does not handle
phase listeners per the jsf 1.2 spec.
--------------------------------------------------------------------------------------------------------
Key: JBSEAM-1822
URL:
http://jira.jboss.com/jira/browse/JBSEAM-1822
Project: JBoss Seam
Issue Type: Bug
Components: Test Harness
Affects Versions: 2.0.0.BETA1
Reporter: Chris Rudd
Assigned To: Shane Bryzak
Fix For: 2.0.0.GA
Under the 1.2 JSF spec, all phase listeners are called with the after phase events
reguarless of if an exception was thrown during the phase processing.
The resulting issue is that when Init.isTransactionMangementEnabled is true, and and an
exception (or an AssertionError) is thrown from within the phase method, the SeamPhase
listner does not get a chance to handle the condition and rollback the transaction. This
leaves the transaction open, and all further tests run for that class are now
"tainted" as there is a transaction running that will never be completed.
Wrapping code in the phase methods
(restoreViewPhase,applyRequestValuesPhase,processValidationsPhase,updateModelValuesPhase,invokeApplicationsPhase,
renderResponsePhase) like this will resolve the issue :
private void renderResponsePhase() throws Exception
{
phases.beforePhase(new PhaseEvent(facesContext, PhaseId.RENDER_RESPONSE,
MockLifecycle.INSTANCE));
+ try
+ {
updateConversationId();
renderResponseBegun = true;
renderResponse();
renderResponseComplete = true;
facesContext.getApplication().getStateManager().saveView(facesContext);
updateConversationId();
+ }
+ finally
+ {
phases.afterPhase(new PhaseEvent(facesContext, PhaseId.RENDER_RESPONSE,
MockLifecycle.INSTANCE));
+ }
}
it may be cleaner to refactor the phase methods into PhaseExection classes. (remove
firing of phase events from the phase methods )
public class PhaseExecution {
private PhaseId phaseId;
public PhaseExecution(PhaseId phaseId)
{
this.phaseId = phaseId;
}
protected abstract void execute() throws Exception
public void run() throws Exception {
fireBefore();
try
{
execute();
}
finally
{
afterPhase();
}
}
protected void fireBefore()
{
phases.beforePhase(new PhaseEvent(facesContext, phaseId,
MockLifecycle.INSTANCE));
}
protected void fireAfter()
{
phases.afterPhase(new PhaseEvent(facesContext, phaseId,
MockLifecycle.INSTANCE));
}
}
final private PhaseExcecution RESTORE_VIEW_PHASE= new
PhaseExecution(PhaseId.RESTORE_VIEW) {
protected void execute() throws Exception {
restoreViewPhase();
}
};
final private PhaseExcecution RENDER_RESPONSE_PHASE= new
PhaseExecution(PhaseId.RENDER_RESPONSE) {
protected void execute() throws Exception {
renderResponsePhase();
}
};
...
/**
* @return true if a response was rendered
*/
private boolean emulateJsfLifecycle() throws Exception
{
RESTORE_VIEW_PHASE.run();
if ( !isGetRequest() && !skipToRender() )
{
APPLY_REQUEST_VALUES_PHASE.run();
if (!skipToRender())
{
PROCESS_VALIDATIONS_PHASE.run();
if ( !skipToRender() )
{
UPDATE_MODEL_VALUES_PHASE.run();
if ( !skipToRender() )
{
INVOKE_APPLICATION_PHASE.run();
}
}
}
}
if ( skipRender() )
{
// we really should look at redirect parameters here!
return false;
}
else
{
RENDER_RESPONSE_PHASE.run();
return true;
}
}
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://jira.jboss.com/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira