Merge lp:~gmb/launchpad/ajaxify-branch-linking into lp:launchpad/db-devel

[Graham Binns]

It's now possible to link a branch to a bug inline.

[Graham Binns (gmb)]

This branch ajaxifies the "Link a related branch" action on the bug page.

Note that this branch does *not* update the list of linked branches; that's a subsequent branch that's currently in progress but needs more work.

[Graham Binns (gmb)]

Here's the actual diff:

=== modified file 'lib/canonical/launchpad/javascript/bugs/bugtask-index.js'
--- lib/canonical/launchpad/javascript/bugs/bugtask-index.js 2009-09-22 11:46:49 +0000
+++ lib/canonical/launchpad/javascript/bugs/bugtask-index.js 2009-09-28 10:35:09 +0000
@@ -37,6 +37,7 @@
     'class="lazr-neg lazr-btn" >Cancel</button>';
 var privacy_link;
 var privacy_spinner;
+var link_branch_link;

 /*
  * An object representing the bugtask subscribers portlet.
@@ -210,9 +211,11 @@
             });
             privacy_link.addClass('js-action');
         }
+
         create_error_overlay();
         setup_inline_commenting();
         setup_add_attachment();
+ setup_link_branch_picker();
     }, window);
 };

@@ -627,6 +630,101 @@
     }
 }

+/**
+ * Set up the link-a-related-branch picker.
+ */
+function setup_link_branch_picker() {
+ if (lp_client === undefined || bug_repr === undefined) {
+ setup_client_and_bug();
+ }
+
+ var error_handler = new LP.client.ErrorHandler();
+
+ error_handler.clearProgressUI = function () {
+ link_branch_link.toggleClass('update-in-progress-message');
+ };
+ error_handler.showError = function(error_msg) {
+ display_error(Y.get('.menu-link-addsubscriber'), error_msg);
+ };
+
+ function get_branch_and_link_to_bug(data) {
+ var branch_url = data['api_uri'];
+ config = {
+ on: {
+ success: link_branch_to_bug,
+ failure: error_handler.getFailureHandler()
+ }
+ };
+
+ // Start the spinner and then grab the branch.
+ link_branch_link.toggleClass('update-in-progress-message');
+ lp_client.get(branch_url, config);
+ }
+
+ // Set up the picker itself.
+ link_branch_link = Y.get('.menu-link-addbranch');
+ if (Y.Lang.isValue(link_branch_link)) {
+ var config = {
+ header: 'Link a related branch',
+ step_title: 'Search'
+ };
+
+ var picker = Y.lp.picker.create(
+ 'Branch', get_branch_and_link_to_bug, config);
+
+ // Clear results and search terms on cancel or save.
+ picker.on('save', clear_picker, picker);
+ picker.on('cancel', clear_picker, picker);
+
+ link_branch_link.on('click', function(e) {
+ e.halt();
+ picker.show();
+ });
+ link_branch_link.addClass('js-action');
+ }
+}
+
+/**
+ * Link a branch to the current bug.
+ * @param branch {Object} The branch to link to the bug, as returned by
+ * the Launchpad API.
+ */
+function link_branch_to_bug(branch) {
+ var error_handler = new LP.client.ErrorHandler();
+ error_handler.clearProgressUI = function () {
+ link_branch_link.toggleClass('update-in-progress-message');
+ };
+ error_handler.showError = function(error_msg) {
+ display_error(Y.get('.menu-link-addsubscriber'), error_msg);
+ };
+
+ // Call linkBranch() on the bug and flash the 'add a branch' link
+ // accordingly.
+ config = {
+ on: {
+ success: function(client) {
+ // Show the green flash anim to say the action
+ // ...

[Graham Binns (gmb)]

Incremental diff of changes:

=== modified file 'lib/canonical/launchpad/javascript/bugs/bugtask-index.js'
--- lib/canonical/launchpad/javascript/bugs/bugtask-index.js 2009-09-28 10:02:35 +0000
+++ lib/canonical/launchpad/javascript/bugs/bugtask-index.js 2009-09-28 11:01:30 +0000
@@ -634,14 +634,8 @@
  * Set up the link-a-related-branch picker.
  */
 function setup_link_branch_picker() {
- if (lp_client === undefined) {
- lp_client = new LP.client.Launchpad();
- }
-
- if (lp_bug_entry === undefined) {
- var bug_repr = LP.client.cache.bug;
- lp_bug_entry = new LP.client.Entry(
- lp_client, bug_repr, bug_repr.self_link);
+ if (lp_client === undefined || bug_repr === undefined) {
+ setup_client_and_bug();
     }

     var error_handler = new LP.client.ErrorHandler();
@@ -704,21 +698,13 @@
         display_error(Y.get('.menu-link-addsubscriber'), error_msg);
     };

- // Call linkBranch() on the bug and flash the 'add a branch' link
- // accordingly.
+ // Call linkBranch() on the bug.
     config = {
         on: {
             success: function(client) {
- // Show the green flash anim to say the action
- // has completed.
- var anim = Y.lazr.anim.green_flash(
- {node: link_branch_link});
- anim.on('end', function(e) {
- link_branch_link.toggleClass(
- 'update-in-progress-message');
- });
+ link_branch_link.toggleClass(
+ 'update-in-progress-message');
                 anim.run();
- link_branch_link.set('innerHTML', 'Link another branch');
             },
             failure: error_handler.getFailureHandler()
         },

=== modified file 'lib/lp/bugs/browser/bug.py'
--- lib/lp/bugs/browser/bug.py 2009-09-18 22:46:33 +0000
+++ lib/lp/bugs/browser/bug.py 2009-09-28 11:01:30 +0000
@@ -239,10 +239,7 @@

     def addbranch(self):
         """Return the 'Add branch' Link."""
- if self.context.bug.linked_branches.count() > 0:
- text = 'Link another branch'
- else:
- text = 'Link a related branch'
+ text = 'Link a related branch'
         return Link('+addbranch', text, icon='add')

     def linktocve(self):

=== modified file 'lib/lp/bugs/stories/bugs/xx-link-bug-to-branch.txt'
--- lib/lp/bugs/stories/bugs/xx-link-bug-to-branch.txt 2009-09-18 22:46:33 +0000
+++ lib/lp/bugs/stories/bugs/xx-link-bug-to-branch.txt 2009-09-28 11:01:30 +0000
@@ -36,17 +36,6 @@
     lp://dev/~name12/firefox/main (Development)
     ...

-The text "Link a related branch" has now changed to "Link another branch".
-
- >>> user_browser.getLink('Link a related branch')
- Traceback (most recent call last):
- ...
- LinkNotFoundError
-
- >>> user_browser.getLink('Link another branch')
- <Link text='Link another branch'
- url='http://bugs.launchpad.dev/firefox/+bug/1/+addbranch'>
-
 We can delete existing links between a bug and a branch.

     >>> delete_branch_link_url = (

=== modified file 'lib/canonical/launchpad/javascript/bugs/bugtask-index.js'
--- lib/canonical/launchpad/javascript/bugs/bugtask-index.js	2009-10-09 20:29:23 +0000
+++ lib/canonical/launchpad/javascript/bugs/bugtask-index.js	2009-10-16 08:32:15 +0000
@@ -37,6 +37,7 @@
     'class="lazr-neg lazr-btn" >Cancel</button>';
 var privacy_link;
 var privacy_spinner;
+var link_branch_link;
 
 /*
  * An object representing the bugtask subscribers portlet.
@@ -125,9 +126,7 @@
             return;
         }
 
-        if (lp_client === undefined || bug_repr === undefined) {
-            setup_client_and_bug();
-        }
+        setup_client_and_bug();
 
         // First look for 'Mark as duplicate' links.
         var update_dupe_links = Y.all('.menu-link-mark-dupe');
@@ -211,6 +210,7 @@
             privacy_link.addClass('js-action');
         }
         setup_add_attachment();
+        setup_link_branch_picker();
     }, window);
 };
 
@@ -268,10 +268,7 @@
         return;
     }
 
-    if (lp_client === undefined || bug_repr === undefined) {
-        setup_client_and_bug();
-    }
-
+    setup_client_and_bug();
     var subscription = new Y.lp.Subscription({
         link: Y.get('.menu-link-subscription'),
         spinner: Y.get('#sub-unsub-spinner'),
@@ -567,6 +564,91 @@
 };
 
 
+/**
+ * Set up the link-a-related-branch picker.
+ */
+function setup_link_branch_picker() {
+    setup_client_and_bug();
+
+    var error_handler = new LP.client.ErrorHandler();
+
+    error_handler.clearProgressUI = function () {
+        link_branch_link.toggleClass('update-in-progress-message');
+    };
+    error_handler.showError = function(error_msg) {
+        display_error(Y.get('.menu-link-addsubscriber'), error_msg);
+    };
+
+    function get_branch_and_link_to_bug(data) {
+        var branch_url = data['api_uri'];
+        config = {
+            on: {
+                success: link_branch_to_bug,
+                failure: error_handler.getFailureHandler()
+            }
+        };
+
+        // Start the spinner and then grab the branch.
+        link_branch_link.toggleClass('update-in-progress-message');
+        lp_client.get(branch_url, config);
+    }
+
+    // Set up the picker itself.
+    link_branch_link = Y.get('.menu-link-addbranch');
+    if (Y.Lang.isValue(link_branch_link)) {
+        var config = {
+            header: 'Link a related branch',
+            step_title: 'Search'
+        };
+
+        var picker = Y.lp.picker.create(
+            'Branch', get_branch_and_link_to_bug, config);
+
+        // Clear results and search terms on cancel or save.
+        picker.on('save', clear_picker, picker);
+        picker.on('cancel', clear_picker, picker);
+
+        link_branch_link.on('click', function(e) {
+            e.halt();
+            picker.show();
+        });
+        link_branch_link.addClass('js-action');
+    }
+}
+
+/**
+ * Link a branch to the current bug.
+ * @param branch {Object} The branch to link to the bug, as returned by
+ *                        the Launchpad API.
+ */
+function link_branch_to_bug(branch) {
+    var error_handler = new LP.client.ErrorHandler();
+    error_handler.clearProgressUI = function () {
+        link_branch_link.toggleClass('update-in-progress-message');
+    };
+    error_handler.showError = function(error_msg) {
+        display_error(Y.get('.menu-link-addsubscriber'), error_msg);
+    };
+
+    // Call linkBranch() on the bug.
+    config = {
+        on: {
+            success: function(client) {
+                link_branch_link.toggleClass(
+                    'update-in-progress-message');
+                anim.run();
+            },
+            failure: error_handler.getFailureHandler()
+        },
+        parameters: {
+            branch: branch.get('self_link')
+        }
+    };
+
+    lp_client.named_post(
+        lp_bug_entry.get('self_link'), 'linkBranch', config);
+}
+
 /*
  * Traverse the DOM of a given remove icon to find
  * the user's link.  Returns a URI of the form "/~username".

=== modified file 'lib/lp/bugs/browser/bug.py'
--- lib/lp/bugs/browser/bug.py	2009-09-18 22:46:33 +0000
+++ lib/lp/bugs/browser/bug.py	2009-10-16 08:32:15 +0000
@@ -239,10 +239,7 @@
 
     def addbranch(self):
         """Return the 'Add branch' Link."""
-        if self.context.bug.linked_branches.count() > 0:
-            text = 'Link another branch'
-        else:
-            text = 'Link a related branch'
+        text = 'Link a related branch'
         return Link('+addbranch', text, icon='add')
 
     def linktocve(self):

=== modified file 'lib/lp/bugs/stories/bugs/xx-link-bug-to-branch.txt'
--- lib/lp/bugs/stories/bugs/xx-link-bug-to-branch.txt	2009-09-18 22:46:33 +0000
+++ lib/lp/bugs/stories/bugs/xx-link-bug-to-branch.txt	2009-10-16 08:32:15 +0000
@@ -36,17 +36,6 @@
     lp://dev/~name12/firefox/main (Development)
     ...
 
-The text "Link a related branch" has now changed to "Link another branch".
-
-    >>> user_browser.getLink('Link a related branch')
-    Traceback (most recent call last):
-    ...
-    LinkNotFoundError
-
-    >>> user_browser.getLink('Link another branch')
-    <Link text='Link another branch'
-        url='http://bugs.launchpad.dev/firefox/+bug/1/+addbranch'>
-
 We can delete existing links between a bug and a branch.
 
     >>> delete_branch_link_url = (