Merge lp:~abentley/launchpad/reuse-refactor into lp:launchpad

[Aaron Bentley]

[Aaron Bentley (abentley)]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

= Summary =
Refactor the inline bug comment code for reuse, specifically by branch
merge proposals.

== Proposed fix ==
Extract the error handling code from bugtask-index.js into errors.js.
Extract the comment handling code into comment.js. Reorganize as a Widget.

== Pre-implementation notes ==
Preimplementation was with thumper.

== Implementation details ==
As a drive-by, the export of IBranchMergeProposal.createComment is
changed to export_factory_operation. This ensures that its return value
is usable.

== Tests ==
bin/test -v --layer=BugsWindmillLayer

== Demo and Q/A ==

= Launchpad lint =

Checking for conflicts. and issues in doctests and templates.
Running jslint, xmllint, pyflakes, and pylint.
Using normal rules.

Linting changed files:
  lib/lp/code/interfaces/branchmergeproposal.py
  lib/canonical/launchpad/javascript/bugs/bugtask-index.js
  lib/canonical/launchpad/javascript/lp/errors.js
  lib/canonical/launchpad/interfaces/_schema_circular_imports.py
  lib/lp/bugs/templates/bugtask-index.pt
  lib/canonical/launchpad/javascript/lp/comment.js

== JSLint notices ==
jslint: No problem found in
'/home/abentley/launchpad/inline-comment/lib/canonical/launchpad/javascript/lp/comment.js'.

jslint: No problem found in
'/home/abentley/launchpad/inline-comment/lib/canonical/launchpad/javascript/lp/errors.js'.

jslint: No problem found in
'/home/abentley/launchpad/inline-comment/lib/canonical/launchpad/javascript/bugs/bugtask-index.js'.

jslint: 3 files to lint.

== Pylint notices ==

lib/lp/code/interfaces/branchmergeproposal.py
    27: [F0401] Unable to import 'lazr.lifecycle.event' (No module named
lifecycle)
    42: [F0401] Unable to import 'lazr.restful.fields' (No module named
restful)
    43: [F0401] Unable to import 'lazr.restful.declarations' (No module
named restful)

lib/canonical/launchpad/interfaces/_schema_circular_imports.py
    18: [F0401] Unable to import 'lazr.restful.declarations' (No module
named restful)
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iEYEARECAAYFAkrUklMACgkQ0F+nu1YWqI0TIgCfcsmvIb+qgNSDBGRnDyciBJvh
h3gAnin+FvxrnRxj4Miho4vOzpQF912z
=+Dh5
-----END PGP SIGNATURE-----

[Brad Crittenden (bac)]

Aaron this is a great change. Thanks for moving the comment and error functionality to a place they can be re-used.

The only tiny nit I have is at line 645 of the diff where you have an in-line comment, which our coding standards discourage.

review: Approve (code)

=== modified file 'lib/canonical/launchpad/interfaces/_schema_circular_imports.py'
--- lib/canonical/launchpad/interfaces/_schema_circular_imports.py	2009-09-09 11:28:03 +0000
+++ lib/canonical/launchpad/interfaces/_schema_circular_imports.py	2009-10-14 13:58:19 +0000
@@ -100,6 +100,8 @@
 IBranchMergeProposal['createComment'].queryTaggedValue(
     LAZR_WEBSERVICE_EXPORTED)['params']['parent'].schema = \
         ICodeReviewComment
+patch_entry_return_type(
+    IBranchMergeProposal, 'createComment', ICodeReviewComment)
 IBranchMergeProposal['all_comments'].value_type.schema = ICodeReviewComment
 IBranchMergeProposal['nominateReviewer'].queryTaggedValue(
     LAZR_WEBSERVICE_EXPORTED)['return_type'].schema = ICodeReviewVoteReference
 
=== modified file 'lib/canonical/launchpad/javascript/bugs/bugtask-index.js'
--- lib/canonical/launchpad/javascript/bugs/bugtask-index.js	2009-10-06 21:58:10 +0000
+++ lib/canonical/launchpad/javascript/bugs/bugtask-index.js	2009-10-14 13:58:19 +0000
@@ -83,7 +83,7 @@
         }
     };
     error_handler.showError = function(error_msg) {
-        display_error(Y.get('.menu-link-addsubscriber'), error_msg);
+        Y.lp.display_error(Y.get('.menu-link-addsubscriber'), error_msg);
     };
 
     var config = {
@@ -210,12 +210,11 @@
             });
             privacy_link.addClass('js-action');
         }
-        create_error_overlay();
-        setup_inline_commenting();
         setup_add_attachment();
     }, window);
 };
 
+
 /*
  * Clear the subscribe someone else picker.
  *
@@ -313,7 +312,6 @@
 
     setup_unsubscribe_icon_handlers(subscription);
     setup_subscribe_someone_else_handler(subscription);
-    create_error_overlay();
 }
 
 /*
@@ -568,64 +566,6 @@
     lp_bug_entry.lp_save(config);
 };
 
-/*
- * Create the form overlay to use when encountering errors.
- *
- * @method create_error_overlay
-*/
-function create_error_overlay() {
-    if (error_overlay === undefined) {
-        error_overlay = new Y.lazr.FormOverlay({
-            headerContent: '<h2>Error</h2>',
-            form_header:  '',
-            form_content:  '',
-            form_submit_button: Y.Node.create(
-                '<button style="display:none"></button>'),
-            form_cancel_button: cancel_form_button(),
-            centered: true,
-            visible: false
-        });
-        error_overlay.render();
-    }
-}
-
-/*
- * Create a form button for canceling an error form
- * that won't reload the page on submit.
- *
- * @method cancel_form_button
- * @return button {Node} The form's cancel button.
-*/
-function cancel_form_button() {
-    var button = Y.Node.create('<button>OK</button>');
-    button.on('click', function(e) {
-        e.preventDefault();
-        error_overlay.hide();
-    });
-    return button;
-}
-
-/*
- * Take an error message and display in an overlay (creating it if necessary).
- *
- * @method display_error
- * @param flash_node {Node} The node to red flash.
- * @param msg {String} The message to display.
-*/
-function display_error(flash_node, msg) {
-    create_error_overlay();
-    if (flash_node) {
-        var anim = Y.lazr.anim.red_flash({ node: flash_node });
-        anim.on('end', function(e) {
-            error_overlay.showError(msg);
-            error_overlay.show();
-        });
-        anim.run();
-    } else {
-        error_overlay.showError(msg);
-        error_overlay.show();
-    }
-}
 
 /*
  * Traverse the DOM of a given remove icon to find
@@ -652,6 +592,7 @@
     return user_uri;
 }
 
+
 /*
  * Build the HTML for a user link for the subscribers list.
  *
@@ -1014,7 +955,7 @@
     };
     error_handler.showError = function (error_msg) {
         var flash_node = Y.get('.' + person.get('css_name'));
-        display_error(flash_node, error_msg);
+        Y.lp.display_error(flash_node, error_msg);
 
     };
 
@@ -1089,7 +1030,7 @@
         subscription.disable_spinner();
     };
     error_handler.showError = function (error_msg) {
-        display_error(subscription_link, error_msg);
+        Y.lp.display_error(subscription_link, error_msg);
     };
 
     var config = {
@@ -1145,7 +1086,7 @@
         subscription.disable_spinner();
     };
     error_handler.showError = function (error_msg) {
-        display_error(subscription_link, error_msg);
+        Y.lp.display_error(subscription_link, error_msg);
     };
 
     var config = {
@@ -1257,7 +1198,7 @@
                 backgroundColor: tr.hasClass('highlight') ? '#FFFF99' : '#FFFFFF'
             });
             status_choice_edit.showError = function(err) {
-              display_error(null, err);
+              Y.lp.display_error(null, err);
             };
             status_choice_edit.on('save', function(e) {
                 var cb = status_choice_edit.get('contentBox');
@@ -1289,7 +1230,7 @@
                 backgroundColor: tr.hasClass('highlight') ? '#FFFF99' : '#FFFFFF'
             });
             importance_choice_edit.showError = function(err) {
-              display_error(null, err);
+              Y.lp.display_error(null, err);
             };
             importance_choice_edit.on('save', function(e) {
                 var cb = importance_choice_edit.get('contentBox');
@@ -1324,7 +1265,7 @@
             clickable_content: false
         });
         milestone_choice_edit.showError = function(err) {
-            display_error(null, err);
+            Y.lp.display_error(null, err);
         };
         milestone_choice_edit.plug({
             fn: Y.lp.client.plugins.PATCHPlugin, cfg: {
@@ -1378,7 +1319,7 @@
                 "header": "Change assignee",
                 "remove_button_text": "Remove assignee",
                 "null_display_value": "Unassigned"});
-        assignee_picker.render()
+        assignee_picker.render();
     }
 };
 
@@ -1486,7 +1427,7 @@
     },
 
     showError: function(err) {
-        display_error(null, err);
+        Y.lp.display_error(null, err);
     },
 
     syncUI: function() {
@@ -1549,7 +1490,7 @@
 function check_can_be_unsubscribed(subscription) {
     var error_handler = new LP.client.ErrorHandler();
     error_handler.showError = function (error_msg) {
-        display_error(Y.get('.menu-link-addsubscriber'), error_msg);
+        Y.lp.display_error(Y.get('.menu-link-addsubscriber'), error_msg);
     };
 
     var config = {
@@ -1618,7 +1559,7 @@
 
     var error_handler = new LP.client.ErrorHandler();
     error_handler.showError = function(error_msg) {
-        display_error(Y.get('.menu-link-addsubscriber'), error_msg);
+        Y.lp.display_error(Y.get('.menu-link-addsubscriber'), error_msg);
     };
 
     if (subscription.is_already_subscribed()) {
@@ -1631,88 +1572,6 @@
 }
 
 /*
- * Set up and handle submitting a comment inline.
- *
- * @method setup_inline_commenting
- */
-function setup_inline_commenting() {
-    var submit_button = Y.get('[id="field.actions.save"]');
-    var progress_message = Y.Node.create(
-        '<span class="update-in-progress-message">Saving...</span>');
-    var comment_input = Y.get('[id="field.comment"]');
-
-    var error_handler = new LP.client.ErrorHandler();
-    error_handler.clearProgressUI = function () {
-        clearProgressUI();
-    };
-    error_handler.showError = function (error_msg) {
-        display_error(submit_button, error_msg);
-    };
-
-    function clearProgressUI() {
-        progress_message.get('parentNode').replaceChild(
-            submit_button, progress_message);
-        comment_input.removeAttribute('disabled');
-    }
-
-    function hide_or_show_submit_button(e) {
-        if (comment_input.get('value') === '') {
-            submit_button.set('disabled', true);
-        }
-        else {
-            submit_button.set('disabled', false);
-        }
-    }
-    /* Hook up hide_or_show_submit_button on both keyup and mouseup to
-       handle both entering text with the keyboard, and pasting with the
-       mouse.  */
-    comment_input.on('keyup', hide_or_show_submit_button);
-    comment_input.on('mouseup', hide_or_show_submit_button);
-    hide_or_show_submit_button(null);
-    submit_button.addClass('js-action');
-    submit_button.setStyle('display', 'inline');
-    submit_button.on('click', function(e) {
-        e.halt();
-        var comment_text = comment_input.get('value');
-        /* Don't try to add an empty comment. */
-        if (trim(comment_text) === '') {
-            return;
-        }
-        var config = {
-            on: {
-                success: function(message_entry) {
-                    var config = {
-                        on: {
-                            success: function(message_html) {
-                                var fieldset = Y.get('#add-comment-form');
-                                var legend = Y.get('#add-comment-form legend');
-                                var comment = Y.Node.create(message_html);
-                                fieldset.get('parentNode').insertBefore(
-                                    comment, fieldset);
-                                clearProgressUI();
-                                comment_input.set('value', '');
-                                Y.lazr.anim.green_flash({node: comment}).run();
-                            }
-                        },
-                        accept: LP.client.XHTML
-                    };
-                    lp_client.get(message_entry.get('self_link'), config);
-                },
-                failure: error_handler.getFailureHandler()
-            },
-            parameters: {
-                content: comment_input.get('value')
-            }
-        };
-        comment_input.set('disabled', 'true');
-        submit_button.get('parentNode').replaceChild(
-            progress_message, submit_button);
-        lp_client.named_post(
-            bug_repr.self_link, 'newMessage', config);
-    });
-}
-
-/*
  * Click handling to pass comment text to the attachment
  * page if there is a comment.
  *
@@ -1734,5 +1593,6 @@
 }, '0.1', {requires: ['base', 'oop', 'node', 'event', 'io-base', 'substitute',
                       'widget-position-ext', 'lazr.formoverlay', 'lazr.anim',
                       'lazr.base', 'lazr.overlay', 'lazr.choiceedit',
-                      'lp.picker', 'lp.client.plugins', 'lp.subscriber']});
+                      'lp.picker', 'lp.client.plugins', 'lp.subscriber',
+                      'lp.errors']});
 
 
=== added file 'lib/canonical/launchpad/javascript/lp/comment.js'
--- lib/canonical/launchpad/javascript/lp/comment.js	1970-01-01 00:00:00 +0000
+++ lib/canonical/launchpad/javascript/lp/comment.js	2009-10-14 13:58:19 +0000
@@ -0,0 +1,191 @@
+YUI.add('lp.comment', function(Y) {
+
+Y.lp = Y.namespace('lp');
+
+var Comment = function () {
+        Comment.superclass.constructor.apply(this, arguments);
+};
+
+
+Comment.NAME = 'comment';
+
+Comment.ATTRS = {
+};
+Y.extend(Comment, Y.Widget, {
+
+    /**
+     * Initialize the Comment
+     *
+     * @method initializer
+     */
+    initializer: function() {
+        this.submit_button = this.get_submit();
+        this.comment_input = Y.get('[id="field.comment"]');
+        this.lp_client = new LP.client.Launchpad();
+        this.error_handler = new LP.client.ErrorHandler();
+        this.error_handler.clearProgressUI = bind(this.clearProgressUI, this);
+        this.error_handler.showError = bind(function (error_msg) {
+            Y.lp.display_error(this.submit_button, error_msg);
+        }, this);
+        this.progress_message = Y.Node.create(
+            '<span class="update-in-progress-message">Saving...</span>');
+    },
+
+    /**
+     * Return the Submit button.
+     *
+     * This is provided so that it can be overridden in subclasses.
+     *
+     * @method get_submit
+     */
+    get_submit: function(){
+        return Y.get('[id="field.actions.save"]');
+    },
+    /**
+     * Implementation of Widget.renderUI.
+     *
+     * This redisplays the submit button, in case it has been hidden by
+     * the web page.
+     *
+     * @method renderUI
+     */
+    renderUI: function() {
+        this.submit_button.addClass('js-action');
+        this.submit_button.setStyle('display', 'inline');
+    },
+    /**
+     * Ensure that the widget's values are suitable for submission.
+     *
+     * The contents of the comment field must contain at least one
+     * non-whitespace character.
+     *
+     * @method validate
+     */
+    validate: function() {
+        return trim(this.comment_input.get('value')) !== '';
+    },
+    /**
+     * Make the widget enabled or disabled.
+     *
+     * @method set_disabled
+     * @param disabled A boolean, true if the widget is disabled.
+     */
+    set_disabled: function(disabled){
+        this.comment_input.set('disabled', disabled);
+    },
+    /**
+     * Add the widget's comment as a new comment, updating the display.
+     *
+     * @method add_comment
+     * @param e An event
+     */
+    add_comment: function(e){
+        e.halt();
+        /* Don't try to add an empty comment. */
+        if (!this.validate()) {
+            return;
+        }
+        this.set_disabled(true);
+        this.submit_button.get('parentNode').replaceChild(
+            this.progress_message, this.submit_button);
+        this.post_comment(bind(function(message_entry) {
+            this.get_comment_HTML(
+                message_entry, bind(this.insert_comment_HTML, this));
+        }, this));
+    },
+    /**
+     * Post the comment to the Launchpad API
+     *
+     * @method post_comment
+     * @param callback A callable to call if the post is successful.
+     */
+    post_comment: function(callback) {
+        var config = {
+            on: {
+                success: callback,
+                failure: this.error_handler.getFailureHandler()
+            },
+            parameters: {content: this.comment_input.get('value')}
+        };
+        this.lp_client.named_post(
+            LP.client.cache.bug.self_link, 'newMessage', config);
+    },
+    /**
+     * Retrieve the HTML of the specified message entry.
+     *
+     * @method get_comment_HTML
+     * @param message_entry The comment to get the HTML for.
+     * @param callback On success, call this with the HTML of the comment.
+     */
+    get_comment_HTML: function(message_entry, callback){
+        var config = {
+            on: {
+                success: callback
+            },
+            accept: LP.client.XHTML
+        };
+        this.lp_client.get(message_entry.get('self_link'), config);
+    },
+    /**
+     * Insert the specified HTML into the page.
+     *
+     * @method insert_comment_HTML
+     * @param message_html The HTML of the comment to insert.
+     */
+    insert_comment_HTML: function(message_html) {
+        var fieldset = Y.get('#add-comment-form');
+        var comment = Y.Node.create(message_html);
+        fieldset.get('parentNode').insertBefore(comment, fieldset);
+        this.reset_contents();
+        Y.lazr.anim.green_flash({node: comment}).run();
+    },
+    /**
+     * Reset the widget to a blank state.
+     *
+     * @method reset_contents
+     */
+    reset_contents: function() {
+          this.clearProgressUI();
+          this.comment_input.set('value', '');
+          this.syncUI();
+    },
+    /**
+     * Stop indicating that a submission is in progress.
+     *
+     * @method clearProgressUI
+     */
+    clearProgressUI: function(){
+          this.progress_message.get('parentNode').replaceChild(
+              this.submit_button, this.progress_message);
+          this.set_disabled(false);
+    },
+    /**
+     * Implementation of Widget.bindUI: Bind events to methods.
+     *
+     * Key and mouse presses (e.g. mouse paste) call syncUI, in case the submit
+     * button needs to be updated.  Clicking on the submit button invokes
+     * add_comment.
+     *
+     * @method bindUI
+     */
+    bindUI: function(){
+        this.comment_input.on('keyup', bind(this.syncUI, this));
+        this.comment_input.on('mouseup', bind(this.syncUI, this));
+        this.submit_button.on('click', bind(this.add_comment, this));
+    },
+    /**
+     * Implementation of Widget.syncUI: Update appearance according to state.
+     *
+     * This just updates the submit button.
+     *
+     * @method syncUI
+     */
+    syncUI: function(){
+        this.submit_button.set('disabled', !this.validate());
+    }
+});
+
+Y.lp.Comment = Comment;
+
+
+}, '0.1' ,{requires:['oop', 'widget', 'lp.client.plugins', 'lp.errors']});
 
=== added file 'lib/canonical/launchpad/javascript/lp/errors.js'
--- lib/canonical/launchpad/javascript/lp/errors.js	1970-01-01 00:00:00 +0000
+++ lib/canonical/launchpad/javascript/lp/errors.js	2009-10-14 13:58:19 +0000
@@ -0,0 +1,81 @@
+YUI.add('lp.errors', function(Y) {
+
+Y.lp = Y.namespace('lp');
+
+/*
+ * Create a form button for canceling an error form
+ * that won't reload the page on submit.
+ *
+ * @method cancel_form_button
+ * @return button {Node} The form's cancel button.
+*/
+var cancel_form_button = function() {
+    var button = Y.Node.create('<button>OK</button>');
+    button.on('click', function(e) {
+        e.preventDefault();
+        error_overlay.hide();
+    });
+    return button;
+};
+
+
+var error_overlay;
+/*
+ * Create the form overlay to use when encountering errors.
+ *
+ * @method create_error_overlay
+*/
+var create_error_overlay = function() {
+    if (error_overlay === undefined) {
+        error_overlay = new Y.lazr.FormOverlay({
+            headerContent: '<h2>Error</h2>',
+            form_header:  '',
+            form_content:  '',
+            form_submit_button: Y.Node.create(
+                '<button style="display:none"></button>'),
+            form_cancel_button: cancel_form_button(),
+            centered: true,
+            visible: false
+        });
+        error_overlay.render();
+    }
+};
+
+/**
+ * Run a callback, optionally flashing a specified node red beforehand.
+ *
+ * If the supplied node evaluates false, the callback is invoked immediately.
+ *
+ * @method maybe_red_flash
+ * @param flash_node The node to flash red, or null for no flash.
+ * @param callback The callback to invoke.
+ */
+var maybe_red_flash = function(flash_node, callback)
+{
+    if (flash_node) {
+        var anim = Y.lazr.anim.red_flash({ node: flash_node });
+        anim.on('end', callback);
+        anim.run();
+    } else {
+        callback();
+    }
+};
+
+
+/*
+ * Take an error message and display in an overlay (creating it if necessary).
+ *
+ * @method display_error
+ * @param flash_node {Node} The node to red flash.
+ * @param msg {String} The message to display.
+*/
+var display_error = function(flash_node, msg) {
+    create_error_overlay();
+    maybe_red_flash(flash_node, function(){
+        error_overlay.showError(msg);
+        error_overlay.show();
+    });
+};
+
+Y.lp.display_error = display_error;
+}, '0.1', {requires:['lazr.formoverlay']});
 
=== modified file 'lib/lp/bugs/templates/bugtask-index.pt'
--- lib/lp/bugs/templates/bugtask-index.pt	2009-09-22 18:05:41 +0000
+++ lib/lp/bugs/templates/bugtask-index.pt	2009-10-14 13:58:19 +0000
@@ -25,6 +25,14 @@
                 tal:define="lp_js string:${icingroot}/build"
                 tal:attributes="src string:${lp_js}/bugs/bug_tags_entry.js">
         </script>
+        <script type="text/javascript"
+                tal:define="lp_js string:${icingroot}/build"
+                tal:attributes="src string:${lp_js}/lp/comment.js">
+        </script>
+        <script type="text/javascript"
+                tal:define="lp_js string:${icingroot}/build"
+                tal:attributes="src string:${lp_js}/lp/errors.js">
+        </script>
       </tal:devmode>
       <script type="text/javascript">
         YUI().use('base', 'node', 'oop', 'event', 'bugs.bugtask_index', function(Y) {
@@ -282,6 +290,12 @@
                 var button = document.getElementById('field.actions.save');
                 button.style.display = 'none';
               </script>
+              <script type="text/javascript">
+                YUI().use('lp.comment', function(Y) {
+                var comment = new Y.lp.Comment();
+                comment.render();
+                })
+              </script>
             </div>
             <tal:attachment-link
                 define="add_attachment_link context_menu/addcomment"
 
=== modified file 'lib/lp/code/interfaces/branchmergeproposal.py'
--- lib/lp/code/interfaces/branchmergeproposal.py	2009-10-01 13:25:12 +0000
+++ lib/lp/code/interfaces/branchmergeproposal.py	2009-10-14 13:58:19 +0000
@@ -41,9 +41,10 @@
 from canonical.launchpad.webapp.interfaces import ITableBatchNavigator
 from lazr.restful.fields import CollectionField, Reference
 from lazr.restful.declarations import (
-    call_with, export_as_webservice_entry, export_read_operation,
-    export_write_operation, exported, operation_parameters,
-    operation_returns_entry, rename_parameters_as, REQUEST_USER)
+    call_with, export_as_webservice_entry, export_factory_operation,
+    export_read_operation, export_write_operation, exported,
+    operation_parameters, operation_returns_entry, rename_parameters_as,
+    REQUEST_USER)
 
 
 class InvalidBranchMergeProposal(Exception):
@@ -454,7 +455,8 @@
         vote=Choice(vocabulary=CodeReviewVote), review_type=Text(),
         parent=Reference(schema=Interface))
     @call_with(owner=REQUEST_USER)
-    @export_write_operation()
+    # ICodeReviewComment supplied as Interface to avoid circular imports.
+    @export_factory_operation(Interface, [])
     def createComment(owner, subject, content=None, vote=None,
                       review_type=None, parent=None):
         """Create an ICodeReviewComment associated with this merge proposal.
 
=== modified file 'lib/lp/code/stories/webservice/xx-branchmergeproposal.txt'
--- lib/lp/code/stories/webservice/xx-branchmergeproposal.txt	2009-10-12 09:40:17 +0000
+++ lib/lp/code/stories/webservice/xx-branchmergeproposal.txt	2009-10-14 13:58:19 +0000
@@ -146,10 +146,12 @@
 
 Now the code review should be made.
 
-    >>> comment = reviewer_webservice.named_post(
+    >>> comment_result = reviewer_webservice.named_post(
     ...     merge_proposal['self_link'], 'createComment',
     ...     subject='Great work', content='This is great work',
-    ...     vote=CodeReviewVote.APPROVE.title, review_type='code').jsonBody()
+    ...     vote=CodeReviewVote.APPROVE.title, review_type='code')
+    >>> comment_link = comment_result.getHeader('Location')
+    >>> comment = reviewer_webservice.get(comment_link).jsonBody()
     >>> pprint_entry(comment)
     branch_merge_proposal_link: u'http://.../~source/fooix/fix-it/+merge/1'
     id: 3