[richfaces-issues] [JBoss JIRA] (RF-13776) a4j:ajax problem with hierarchical component IDs

[Michael B (JIRA)]

    [ https://issues.jboss.org/browse/RF-13776?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12992786#comment-12992786 ] 

Michael B commented on RF-13776:
--------------------------------

[~bleathem] yes, I can confirm that changing either the parent or child id to s.th. completely different solves the problem. 

But just to make sure: changing the ids of course is a valid workaround, but I think no one can guess that similar ids can lead to such problems, - especially when having no exception, no log, no nothing to work with - except for the fact, that your actionListener is never invoked...

But back to the point, there was s.th. I found during debugging that would support your idea that maybe the relevant code only identifies RichFaces components: when you debug a little further there is that function call to *richfaces.$(this)* in the code snippet "searchForComponentRootOrReturn"

Here is the function:

{code:title=richfaces.$|borderStyle=solid}
richfaces.$ = function(source) {
   var element = richfaces.getDomElement( source );
   if(element)
   {
      return( element[richfaces.RICH_CONTAINER] || {} )["component"]
   }
};
{code}

In the example "source" (and also "element") is the selectBooleanCheckbox which does not have the attribute for "richfaces.RICH_CONTAINER", thus this function returns "undefined", which in turn may lead to the calling function continuing its search for a valid parent.

If I have the next time slot for bug tracing I will also try the two things you mentioned. Meanwhile looking at this function(s) should give you a good starting point for reproducing the problem.

> a4j:ajax problem with hierarchical component IDs
> ------------------------------------------------
>
>                 Key: RF-13776
>                 URL: https://issues.jboss.org/browse/RF-13776
>             Project: RichFaces
>          Issue Type: Bug
>      Security Level: Public(Everyone can see) 
>          Components: component-a4j-core
>    Affects Versions: 4.3.7
>         Environment: RichFaces 4.3.7
> Mojarra 2.1.29
> Java 7 Update 67 (x64)
> Tomcat 7.0.52 (x64)
>            Reporter: Michael B
>
> First of all: this is a bug report related to RF-12616.
> The actionListener of an a4j:ajax-enhanced component is not invoked on the server side. In a nutshell the problem is due to the request parameter "javax.faces.source" not matching the id of the component for which the AjaxBehaviorEvent is bound.
> The problem occurs when you assign hierarchical component ids in your xhtml. 
> Here is a condensed snippet xhtml illustrating the problem:
> {code:title=Snippet|borderStyle=solid}
> <rich:treeNode id="treeNode">
>    <h:selectBooleanCheckbox id="treeNodeSelectBox">
>       <a4j:ajax event="click" execute="@this" listener="#{someManagedBean.onCheckboxClick}" />
>    </h:selectBooleanCheckbox>
> </rich:treeNode>
> {code}
> As you can see, the id of the selectBooleanCheckbox begins with the id of the treeNode.
> The RichFaces JavaScript handler introduced a function to obviously evaluate the correct component id for the event (which is then passed as request parameter 'javax.faces.source' in the AJAX request).
> {code:title=RichFaces JS-Snippet|borderStyle=solid}
>     richfaces.ajax = function(source, event, options) {
>         var options = options || {};
>         
>         var sourceId = getSourceId(source, options);
>         var sourceElement = getSourceElement(source);
>         
>         // event source re-targeting finds a RichFaces component root
>         // to setup javax.faces.source correctly - RF-12616)
>         if (sourceElement) {
>             source = searchForComponentRootOrReturn(sourceElement);
>         }
> 		
> 		...
>     /*
>      * Returns RichFaces component root for given element in the list of ancestors of sourceElement.
>      * Otherwise returns sourceElement if RichFaces component root can't be located.
>      */
>     var searchForComponentRootOrReturn = function(sourceElement) {
>         if (sourceElement.id && !richfaces.$(sourceElement)) {
>             var parentElement = false;
>             jQuery(sourceElement).parents().each(function() {
>                 if (this.id && sourceElement.id.indexOf(this.id) == 0) { // otherwise parent element is definitely not JSF component
>                     var suffix = sourceElement.id.substring(this.id.length); // extract suffix
>                     if (suffix.match(/^[a-zA-Z]*$/) && richfaces.$(this)) {
>                         parentElement = this;
>                         return false;
>                     }
>                 }
>             });
>             if (parentElement !== false) {
>                 return parentElement;
>             }
>         }
>         return sourceElement;
>     };
> {code}
> The problem is within the function "searchForComponentRootOrReturn" which in this special case of id-hierarchy evaluates to the wrong element. The correct element to be returned here would be the "sourceElement" (selectBooleanCheckbox with the id "treeNodeSelectBox" in the example above), but the code evaluates to a "parentElement" (treeNode in the example above) due to its id "treeNode" being a prefix of the component which fired the event.
> It took me a whole day to figure that one out, since there is no useful output neither in a4j:log nor in server side logging in a case where the parameter "javax.faces.source" does not match the component id. In fact the AJAX request is executed just fine, only the event is never queued...
> (See Mojarra HtmlBasicRenderer => decodeBehaviors and its check method isBehaviorSource)



--
This message was sent by Atlassian JIRA
(v6.2.6#6264)