Merge pull request #545 from jglick/Behaviour-specify-14495

[JENKINS-14495] Define Behaviour.specify.

changelog.html

@@ -56,6 +56,11 @@ Upcoming changes</a>
 <div id="trunk" style="display:none"><!--=TRUNK-BEGIN=-->
 <ul class=image>
   <li class=bug>
+    Refactored <code>behavior.js</code> to run more predictably.
+    Plugin JavaScript should use <code>Behaviour.specify</code> in place of
+    <code>Behaviour.register</code>, <code>Behaviour.list</code>,
+    <code>hudsonRules</code>, and <code>jenkinsRules</code>.
+    (<a href="https://issues.jenkins-ci.org/browse/JENKINS-14495">issue 14495</a> cont'd)
     Fixed a possible race condition in the remoting layer.
     (<a href="https://issues.jenkins-ci.org/browse/JENKINS-14909">issue 14909</a>)
   <li class=bug>

core/src/main/resources/hudson/PluginManager/_table.js

@@ -20,8 +20,7 @@ function showhideCategory(col) {
     row.style.display = newDisplay;
 }
 
-Behaviour.register({
-  "#filter-box": function(e) {
+Behaviour.specify("#filter-box", '_table', 0, function(e) {
       function applyFilter() {
           var filter = e.value.toLowerCase();
           ["TR.plugin","TR.plugin-category"].each(function(clz) {
@@ -36,5 +35,4 @@ Behaviour.register({
       }
 
       e.onkeyup = applyFilter;
-  }
 });

core/src/main/resources/hudson/console/ExpandableDetailsNote/script.js

 (function() {
-    Behaviour.register({
-
-        "INPUT.reveal-expandable-detail" : function(e) {
+    Behaviour.specify("INPUT.reveal-expandable-detail", 'ExpandableDetailsNote', 0, function(e) {
             var detail = e.nextSibling;
             makeButton(e,function() {
                 detail.style.display = (detail.style.display=="block")?"none":"block";  
             });
-        }
     });
 }());

core/src/main/resources/hudson/matrix/LabelAxis/config.jelly

@@ -29,7 +29,7 @@ THE SOFTWARE.
   <f:entry title="${%Node/Label}" field="labels">
     <div class="yahooTree labelAxis-tree" style="border: 1px solid gray; height: 10em; overflow:auto;" values="${instance.valueString}" />
     <script>
-      hudsonRules["DIV.labelAxis-tree"] = function(e) {
+      Behaviour.specify("DIV.labelAxis-tree", 'LabelAxis', 0, function(e) {
         var tree = new YAHOO.widget.TreeView(e);
 
         var labels = new YAHOO.widget.TextNode("${%Labels}", tree.getRoot(), false);
@@ -60,7 +60,7 @@ THE SOFTWARE.
         tree.subscribe("clickEvent", function(node) {
             return false;
         });
-      };
+      });
     </script>
   </f:entry>
 </j:jelly>

core/src/main/resources/hudson/security/GlobalMatrixAuthorizationStrategy/config.jelly

@@ -144,16 +144,15 @@ THE SOFTWARE.
         });
       })();
 
-      Behaviour.register({
-        "#${strategyid} TD.stop A.remove" : function(e) {
+      Behaviour.specify("#${strategyid} TD.stop A.remove", 'GlobalMatrixAuthorizationStrategy', 0, function(e) {
           e.onclick = function() {
             var tr = findAncestor(this,"TR");
             tr.parentNode.removeChild(tr);
             return false;
           }
           e = null; <!-- avoid memory leak -->
-        },
-        "#${strategyid} TD.stop A.toggleall" : function(e) {
+        });
+      Behaviour.specify("#${strategyid} TD.stop A.toggleall", 'GlobalMatrixAuthorizationStrategy', 0, function(e) {
           e.onclick = function() {
             var tr = findAncestor(this,"TR");
             var inputs = tr.getElementsByTagName("INPUT");
@@ -163,14 +162,13 @@ THE SOFTWARE.
             return false;
           };
           e = null; <!-- avoid memory leak -->
-        },
+        });
         <j:if test="${empty(descriptorPath)}">
           <j:set var="descriptorPath" value="${descriptor.descriptorFullUrl}"/>
         </j:if>
         <!-- validates the name -->
-        "#${strategyid} TR.permission-row" : function(e) {
+        Behaviour.specify("#${strategyid} TR.permission-row", 'GlobalMatrixAuthorizationStrategy', 0, function(e) {
           FormChecker.delayedCheck("${descriptorPath}/checkName?value="+encodeURIComponent(e.getAttribute("name")),"GET",e.firstChild);
-        }
         });
     </script>
   </f:block>

core/src/main/resources/lib/form/advanced/advanced.js

-Behaviour.register({
-    "INPUT.advanced-button" : function(e) {
+Behaviour.specify("INPUT.advanced-button", 'advanced', 0, function(e) {
         makeButton(e,function(e) {
             var link = e.target;
             while(!Element.hasClassName(link,"advancedLink"))
@@ -23,5 +22,4 @@ Behaviour.register({
             layoutUpdateCallback.call();
         });
         e = null; // avoid memory leak
-    }
 });
\ No newline at end of file

core/src/main/resources/lib/form/apply/apply.js

-Behaviour.register({
-    "INPUT.apply-button":function (e) {
+Behaviour.specify("INPUT.apply-button", 'apply', 0, function (e) {
         var id;
         var containerId = "container"+(iota++);
 
@@ -63,5 +62,4 @@ Behaviour.register({
                 f.target = null;
             }
         });
-    }
 });
\ No newline at end of file

core/src/main/resources/lib/form/combobox/combobox.js

-Behaviour.register({
-    "INPUT.combobox2" : function(e) {
+Behaviour.specify("INPUT.combobox2", 'combobox', 0, function(e) {
         var items = [];
 
         var c = new ComboBox(e,function(value) {
@@ -21,5 +20,4 @@ Behaviour.register({
                 }
             });
         });
-    }
 });
\ No newline at end of file

core/src/main/resources/lib/form/hetero-list/hetero-list.js

@@ -2,8 +2,7 @@
 
 // do the ones that extract innerHTML so that they can get their original HTML before
 // other behavior rules change them (like YUI buttons.)
-Behaviour.list.unshift({
-    "DIV.hetero-list-container" : function(e) {
+Behaviour.specify("DIV.hetero-list-container", 'hetero-list', -100, function(e) {
         e=$(e);
         if(isInsideRemovable(e))    return;
 
@@ -134,9 +133,9 @@ Behaviour.list.unshift({
                 }
             });
         }
-    },
+    });
 
-    "DIV.dd-handle" : function(e) {
+Behaviour.specify("DIV.dd-handle", 'hetero-list', -100, function(e) {
         e=$(e);
         e.on("mouseover",function() {
             $(this).up(".repeated-chunk").addClassName("hover");
@@ -144,5 +143,4 @@ Behaviour.list.unshift({
         e.on("mouseout",function() {
             $(this).up(".repeated-chunk").removeClassName("hover");
         });
-    }
 });

core/src/main/resources/lib/form/radioBlock/radioBlock.js

@@ -24,11 +24,8 @@ var radioBlockSupport = {
     }
 };
 
-Behaviour.list.unshift({
-    // this needs to happen before TR.row-set-end rule kicks in.
-    // but this is a hack.
-    // TODO: how do we handle ordering?
-    "INPUT.radio-block-control" : function(r) {
+// this needs to happen before TR.row-set-end rule kicks in.
+Behaviour.specify("INPUT.radio-block-control", 'radioBlock', -100, function(r) {
         r.id = "radio-block-"+(iota++);
 
         // when one radio button is clicked, we need to update foldable block for
@@ -73,5 +70,4 @@ Behaviour.list.unshift({
         // install event handlers to update visibility.
         // needs to use onclick and onchange for Safari compatibility
         r.onclick = r.onchange = function() { g.updateButtons(); };
-    }
 });

core/src/main/resources/lib/form/repeatable/repeatable.js

@@ -99,8 +99,7 @@ var repeatableSupport = {
 
 // do the ones that extract innerHTML so that they can get their original HTML before
 // other behavior rules change them (like YUI buttons.)
-Behaviour.list.unshift({
-    "DIV.repeated-container" : function(e) {
+Behaviour.specify("DIV.repeated-container", 'repeatable', -100, function(e) {
         if(isInsideRemovable(e))    return;
 
         // compute the insertion point
@@ -109,27 +108,25 @@ Behaviour.list.unshift({
             ip = ip.previous();
         // set up the logic
         object(repeatableSupport).init(e, e.firstChild, ip);
-    }
 });
 
-Behaviour.register({
     // button to add a new repeatable block
-    "INPUT.repeatable-add" : function(e) {
+Behaviour.specify("INPUT.repeatable-add", 'repeatable', 0, function(e) {
         makeButton(e,function(e) {
             repeatableSupport.onAdd(e.target);
         });
         e = null; // avoid memory leak
-    },
+    });
 
-    "INPUT.repeatable-delete" : function(e) {
+Behaviour.specify("INPUT.repeatable-delete", 'repeatable', 0, function(e) {
         makeButton(e,function(e) {
             repeatableSupport.onDelete(e.target);
         });
         e = null; // avoid memory leak
-    },
+    });
 
     // radio buttons in repeatable content
-    "DIV.repeated-chunk" : function(d) {
+Behaviour.specify("DIV.repeated-chunk", 'repeatable', 0, function(d) {
         var inputs = d.getElementsByTagName('INPUT');
         for (var i = 0; i < inputs.length; i++) {
             if (inputs[i].type == 'radio') {
@@ -145,5 +142,4 @@ Behaviour.register({
                 if (inputs[i].defaultChecked) inputs[i].checked = true;
             }
         }
-    }
 });
\ No newline at end of file

core/src/main/resources/lib/form/select/select.js

@@ -40,8 +40,7 @@ function updateListBox(listBox,url,config) {
     new Ajax.Request(url, config);
 }
 
-Behaviour.register({
-    "SELECT.select" : function(e) {
+Behaviour.specify("SELECT.select", 'select', 0, function(e) {
         // controls that this SELECT box depends on
         refillOnChange(e,function(params) {
             var value = e.value;
@@ -63,5 +62,4 @@ Behaviour.register({
                 }
             });
         });
-    }
 });
\ No newline at end of file

core/src/main/resources/lib/form/textarea/textarea.js

-Behaviour.register({
-    "TEXTAREA.codemirror" : function(e) {
+Behaviour.specify("TEXTAREA.codemirror", 'textarea', 0, function(e) {
         var h = e.clientHeight;
         var config = e.getAttribute("codemirror-config") || "";
         config = eval('({'+config+'})');
@@ -14,9 +13,9 @@ Behaviour.register({
         var scroller = codemirror.getScrollerElement();
         scroller.setAttribute("style","border:1px solid black;");
         scroller.style.height = h+"px";
-    },
+    });
 
-    "DIV.textarea-preview-container" : function (e) {
+Behaviour.specify("DIV.textarea-preview-container", 'textarea', 100, function (e) {
         var previewDiv = findElementsBySelector(e,".textarea-preview")[0];
         var showPreview = findElementsBySelector(e,".textarea-show-preview")[0];
         var hidePreview = findElementsBySelector(e,".textarea-hide-preview")[0];
@@ -54,5 +53,4 @@ Behaviour.register({
             $(hidePreview).hide();
             $(previewDiv).hide();
         };
-    }
 });
\ No newline at end of file

core/src/main/resources/lib/hudson/projectViewNested.js

@@ -21,7 +21,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  * THE SOFTWARE.
  */
-hudsonRules["IMG.treeview-fold-control"] = function(e) {
+Behaviour.specify("IMG.treeview-fold-control", 'projectViewNested', 0, function(e) {
     e.onexpanded = function() {
         var img = this;
         var tr = findAncestor(img, "TR");
@@ -50,4 +50,4 @@ hudsonRules["IMG.treeview-fold-control"] = function(e) {
         });
     };
     e = null;
-};
+});

core/src/main/resources/lib/layout/breadcrumbs.js

@@ -117,17 +117,17 @@ var breadcrumbs = (function() {
         return false;
     }
 
-    jenkinsRules["#breadcrumbs LI"] = function (e) {
+    Behaviour.specify("#breadcrumbs LI", 'breadcrumbs', 0, function (e) {
         // when the mouse hovers over LI, activate the menu
         e = $(e);
         if (e.hasClassName("no-context-menu"))  return;
         e.observe("mouseover", function () { handleHover(e.firstChild,0) });
-    };
+    });
 
-    jenkinsRules["A.model-link"] = function (a) {
+    Behaviour.specify("A.model-link", 'breadcrumbs', 0, function (a) {
         // ditto for model-link, but give it a larger delay to avoid unintended menus to be displayed
         $(a).observe("mouseover", function () { handleHover(a,500); });
-    };
+    });
 
     /**
      * @namespace breadcrumbs

core/src/main/resources/lib/layout/copyButton/copyButton.js

 // @include "org.kohsuke.stapler.zeroclipboard"
 
-Behaviour.register({
-    "span.copy-button" : function(e) {
+Behaviour.specify("span.copy-button", 'copyButton', 0, function(e) {
         var btn = e.firstChild;
         var id = "copy-button"+(iota++);
         btn.id = id;
@@ -35,5 +34,4 @@ Behaviour.register({
         clip.addEventListener('onMouseUp',function() {
             $(id).removeClassName('yui-button-active')
         });
-    }
 });

test/src/test/java/scripts/BehaviorTest.java

@@ -61,4 +61,10 @@ public class BehaviorTest extends HudsonTestCase {
         assertEquals("initial and appended yet different", r.getJavaScriptResult().toString());
     }
 
+    public void testSelectorOrdering() throws Exception {
+        HtmlPage p = createWebClient().goTo("self/testSelectorOrdering");
+        ScriptResult r = p.executeJavaScript("document.getElementsBySelector('DIV.a')[0].innerHTML");
+        assertEquals("initial early counted! generic weevils! late", r.getJavaScriptResult().toString());
+    }
+
 }

test/src/test/resources/lib/layout/RenderOnDemandTest/testBehaviour.jelly

@@ -30,10 +30,8 @@ THE SOFTWARE.
 <l:layout title="">
   <l:main-panel>
     <script>
-      Behaviour.register({
-        ".a" : function (e) {
+      Behaviour.specify(".a", 'test', 0, function (e) {
         e.innerHTML = e.getAttribute("value");
-        }
       });
     </script>
 

test/src/test/resources/scripts/BehaviorTest/testDuplicateRegistrations.jelly

@@ -26,20 +26,14 @@ THE SOFTWARE.
   <l:layout title="">
     <l:main-panel>
       <script>
-        Behaviour.register({
-          ".a" : function (e) {
+        Behaviour.specify(".a", 'test1', 0, function (e) {
           e.innerHTML += ' and appended';
-          }
         });
-        Behaviour.register({
-          ".a" : function (e) {
+        Behaviour.specify(".a", 'test1', 0, function (e) {
           e.innerHTML += ' and appended';
-          }
         });
-        Behaviour.register({
-          ".a" : function (e) {
+        Behaviour.specify(".a", 'test2', 0, function (e) {
           e.innerHTML += ' yet different';
-          }
         });
       </script>
       <div class="a">initial</div>

test/src/test/resources/scripts/BehaviorTest/testSelectorOrdering.jelly

+<!--
+The MIT License
+
+Copyright (c) 2012, CloudBees, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+-->
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
+  <l:layout title="">
+    <l:main-panel>
+      <script>
+        Behaviour.specify("DIV", 'generic', 0, function (e) {
+          e.innerHTML += ' generic';
+        });
+        Behaviour.specify(".a", 'early', -100, function (e) {
+          e.innerHTML += ' early';
+        });
+        Behaviour.specify(".a", 'late', 100, function (e) {
+          e.innerHTML += ' late';
+        });
+        Behaviour.specify("DIV", 'zyzzyva', 0, function (e) {
+          e.innerHTML += ' weevils!';
+        });
+        Behaviour.specify("DIV", 'abacus', 0, function (e) {
+          e.innerHTML += ' counted!';
+        });
+      </script>
+      <div class="a">initial</div>
+    </l:main-panel>
+  </l:layout>
+</j:jelly>

ui-samples-plugin/src/main/resources/jenkins/plugins/ui_samples/SyntaxHighlightedTextArea/index.groovy

@@ -22,12 +22,12 @@ namespace("/lib/samples").sample(title:_("Syntax Highlighted Text Area")) {
 
     // see CodeMirror web site for more about how to control the newly instantiated text area.
     script("""
-        hudsonRules["TEXTAREA.my-groovy-textbox"] = function(e) {
+        Behaviour.specify("TEXTAREA.my-groovy-textbox", "SyntaxHighlightedTextArea", 0, function(e) {
             var w = CodeMirror.fromTextArea(e,{
               mode:"text/x-groovy",
               lineNumbers: true
             }).getWrapperElement();
             w.setAttribute("style","border:1px solid black; margin-top: 1em; margin-bottom: 1em")
-        }
+        });
     """)
 }

war/src/main/webapp/scripts/behavior.js

@@ -9,20 +9,16 @@
 
    Usage:
 
-	var myrules = {
-		'b.someclass' : function(element){
-			element.onclick = function(){
+        Behaviour.specify('b.someclass', 'myrules.alert', 10, function(element) {
+            element.onclick = function() {
                 alert(this.innerHTML);
             }
-		},
-		'#someid u' : function(element){
-			element.onmouseover = function(){
+        });
+        Behaviour.specify('#someid u', 'myrules.blah', 0, function(element) {
+            element.onmouseover = function() {
                 this.innerHTML = "BLAH!";
             }
-		}
-	};
-
-	Behaviour.register(myrules);
+        });
 
 	// Call Behaviour.apply() to re-apply the rules (if you
 	// update the dom, etc).
@@ -37,9 +33,35 @@
 
 */
 
-var Behaviour = {
+var Behaviour = (function() {
+    var storage = [{selector: '', id: '_deprecated', priority: 0}];
+    return {
+
+    /**
+     * Specifies something to do when an element matching a CSS selector is encountered.
+     * @param {String} selector a CSS selector triggering your behavior
+     * @param {String} id combined with selector, uniquely identifies this behavior; prevents duplicate registrations
+     * @param {Number} priority relative position of this behavior in case multiple apply to a given element; lower numbers applied first (sorted by id then selector in case of tie); choose 0 if you do not care
+     * @param {Function} behavior callback function taking one parameter, a (DOM) {@link Element}, and returning void
+     */
+    specify : function(selector, id, priority, behavior) {
+        for (var i = 0; i < storage.length; i++) {
+            if (storage[i].selector == selector && storage[i].id == id) {
+                storage.splice(i, 1);
+                break;
+            }
+        }
+        storage.push({selector: selector, id: id, priority: priority, behavior: behavior});
+        storage.sort(function(a, b) {
+            var location = a.priority - b.priority;
+            return location != 0 ? location : a.id < b.id ? -1 : a.id > b.id ? 1 : a.selector < b.selector ? -1 : a.selector > b.selector ? 1 : 0;
+        });
+    },
+
+        /** @deprecated For backward compatibility only; use {@link specify} instead. */
 	list : new Array,
 
+        /** @deprecated For backward compatibility only; use {@link specify} instead. */
 	register : function(sheet){
 		Behaviour.list.push(sheet);
 	},
@@ -65,28 +87,30 @@ var Behaviour = {
      *      this semantics is preserved.
      */
     applySubtree : function(startNode,includeSelf) {
-        var behaviorsBySelector = {};
+        if (!(startNode instanceof Array)) {
+            startNode = [startNode];
+        }
+        storage._each(function (registration) {
+            if (registration.id == '_deprecated') {
                 Behaviour.list._each(function(sheet) {
                     for (var selector in sheet){
-                var behavior = sheet[selector];
-                var behaviors = behaviorsBySelector[selector];
-                if (behaviors == null) {
-                    behaviors = [];
-                    behaviorsBySelector[selector] = behaviors;
-                }
-                if (behaviors.indexOf(behavior.toString()) == -1) {
-                    behaviors.push(behavior.toString());
-                    function apply(n) {
-                        var list = findElementsBySelector(n,selector,includeSelf);
-                        if (list.length>0)  // just to simplify setting of a breakpoint.
+                        startNode._each(function (n) {
+                            var list = findElementsBySelector(n, selector, includeSelf);
+                            if (list.length > 0) { // just to simplify setting of a breakpoint.
+                                //console.log('deprecated:' + selector + ' on ' + list.length + ' elements');
                                 list._each(sheet[selector]);
                             }
-                    if (startNode instanceof Array) {
-                        startNode._each(apply)
-                    } else {
-                        apply(startNode);
+                        });
                     }
+                });
+            } else {
+                startNode._each(function (node) {
+                    var list = findElementsBySelector(node, registration.selector, includeSelf);
+                    if (list.length > 0) {
+                        //console.log(registration.id + ':' + registration.selector + ' @' + registration.priority + ' on ' + list.length + ' elements');
+                        list._each(registration.behavior);
                     }
+                });
             }
         });
     },
@@ -103,7 +127,7 @@ var Behaviour = {
 			}
 		}
 	}
-}
+}})();
 
 Behaviour.start();
 

war/src/main/webapp/scripts/hudson-behavior.js

@@ -561,7 +561,9 @@ function sequencer(fs) {
     return next();
 }
 
+/** @deprecated Use {@link Behaviour.specify} instead. */
 var jenkinsRules = {
+// XXX convert as many as possible to Behaviour.specify calls; some seem to have an implicit order dependency, but what?
     "BODY" : function() {
         tooltip = new YAHOO.widget.Tooltip("tt", {context:[], zindex:999});
     },
@@ -1159,7 +1161,17 @@ var jenkinsRules = {
         adjustSticker();
     }
 };
+/** @deprecated Use {@link Behaviour.specify} instead. */
 var hudsonRules = jenkinsRules; // legacy name
+(function() {
+    var p = 20;
+    for (var selector in jenkinsRules) {
+        Behaviour.specify(selector, 'hudson-behavior', p++, jenkinsRules[selector]);
+        delete jenkinsRules[selector];
+    }
+})();
+// now empty, but plugins can stuff things in here later:
+Behaviour.register(hudsonRules);
 
 function applyTooltip(e,text) {
         // copied from YAHOO.widget.Tooltip.prototype.configContext to efficiently add a new element
@@ -1212,10 +1224,6 @@ function refillOnChange(e,onChange) {
     h();   // initial fill
 }
 
-Behaviour.register(hudsonRules);
-
-
-
 function xor(a,b) {
     // convert both values to boolean by '!' and then do a!=b
     return !a != !b;