From: Kohei Yoshino <kohei.yoshino@gmail.com>
Date: Tue, 26 Feb 2019 04:34:27 +0000 (-0500)
Subject: Bug 1496207 - Allow to request uplift of multiple patches at once by adding checkboxe... 
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=a6168d0ca61a7e9623d2d7a8815ba136ffac4eea;p=thirdparty%2Fbugzilla.git

Bug 1496207 - Allow to request uplift of multiple patches at once by adding checkboxes for other patches
---

diff --git a/extensions/BMO/template/en/default/hook/flag/type_comment-form.html.tmpl b/extensions/BMO/template/en/default/hook/flag/type_comment-form.html.tmpl
index e620dece8..011bd92dd 100644
--- a/extensions/BMO/template/en/default/hook/flag/type_comment-form.html.tmpl
+++ b/extensions/BMO/template/en/default/hook/flag/type_comment-form.html.tmpl
@@ -6,6 +6,8 @@
   # defined by the Mozilla Public License, v. 2.0.
   #%]
 
+<meta name="extra-patch-types" content="text/x-phabricator-request">
+
 <template class="approval-request" data-flags="approval‑mozilla‑beta approval‑mozilla‑release">
   <section>
     <header>
diff --git a/extensions/FlagTypeComment/web/js/ftc.js b/extensions/FlagTypeComment/web/js/ftc.js
index 9ae965e44..539eebd34 100644
--- a/extensions/FlagTypeComment/web/js/ftc.js
+++ b/extensions/FlagTypeComment/web/js/ftc.js
@@ -24,12 +24,18 @@ Bugzilla.FlagTypeComment = class FlagTypeComment {
     this.$comment = document.querySelector('#comment');
 
     if (this.$flags && this.$comment) {
+      const $extra_patch_types = document.querySelector('meta[name="extra-patch-types"]');
+
+      this.$form = this.$comment.form;
+      this.bug_id = Number(this.$form.bugid.value);
+      this.attachment_id = Number(this.$form.id.value);
+      this.extra_patch_types = $extra_patch_types ? $extra_patch_types.content.split(' ') : [];
       this.selects = [...this.$flags.querySelectorAll('.flag_select')];
       this.selects.forEach($select => $select.addEventListener('change', () => this.flag_onselect($select)));
       this.$fieldset_wrapper = this.$flags.parentElement.appendChild(document.createElement('div'));
       this.$fieldset_wrapper.id = 'approval-request-fieldset-wrapper';
       this.$comment_wrapper = document.querySelector('#smallCommentFrame') || this.$comment.parentElement;
-      this.$comment.form.addEventListener('submit', () => this.form_onsubmit());
+      this.$form.addEventListener('submit', event => this.form_onsubmit(event));
     }
   }
 
@@ -91,13 +97,13 @@ Bugzilla.FlagTypeComment = class FlagTypeComment {
   }
 
   /**
-   * Find a `<select>` element for a requested flag that matches the given fieldset.
+   * Find one or more `<select>` elements that match the requested flag(s) of the given fieldset.
    * @param {HTMLElement} $fieldset `<section>` element with the `data-flags` attribute.
-   * @returns {HTMLSelectElement} Any `<select>` element.
+   * @returns {Array.<HTMLSelectElement>} Any `<select>` element(s).
    */
-  find_select($fieldset) {
+  find_selectors($fieldset) {
     return this.selects
-      .find($_select => $_select.value === '?' && this.check_compatibility($_select.dataset.name, $fieldset));
+      .filter($_select => $_select.value === '?' && this.check_compatibility($_select.dataset.name, $fieldset));
   }
 
   /**
@@ -107,6 +113,50 @@ Bugzilla.FlagTypeComment = class FlagTypeComment {
     this.$comment_wrapper.hidden = this.inserted_fieldsets.length > 0;
   }
 
+  /**
+   * Parse a fieldset to convert the form values to comment text.
+   * @param {HTMLElement} $fieldset `<section>` element with the `data-flags` attribute.
+   * @returns {String} Comment text formatted in the Markdown syntax.
+   */
+  create_comment($fieldset) {
+    return [
+      `### ${$fieldset.querySelector('h3').innerText}`,
+      ...[...$fieldset.querySelectorAll('tr')].map($tr => {
+        const checkboxes = [...$tr.querySelectorAll('input[type="checkbox"]:checked')];
+        const $radio = $tr.querySelector('input[type="radio"]:checked');
+        const $input = $tr.querySelector('textarea,select,input');
+        const label = $tr.querySelector('th').innerText.replace(/\n/g, ' ');
+        let value = '';
+
+        if (checkboxes.length) {
+          value = checkboxes.map($checkbox => $checkbox.value.trim()).join(', ');
+        } else if ($radio) {
+          value = $radio.value.trim();
+        } else if ($input) {
+          value = $input.value.trim();
+
+          if ($input.dataset.type === 'bug') {
+            if (!value) {
+              value = 'None';
+            } else if (!isNaN(value)) {
+              value = `Bug ${value}`;
+            }
+          }
+
+          if ($input.dataset.type === 'bugs') {
+            if (!value) {
+              value = 'None';
+            } else {
+              value = value.split(/,\s*/).map(str => (!isNaN(str) ? `Bug ${str}` : str)).join(', ');
+            }
+          }
+        }
+
+        return `* **${label}**: ${value}`;
+      }),
+    ].join('\n');
+  }
+
   /**
    * Add text to the comment box at the end of any existing comment.
    * @param {String} text Comment text to be added.
@@ -127,7 +177,7 @@ Bugzilla.FlagTypeComment = class FlagTypeComment {
 
     // Remove the temporary fieldset if not required. One fieldset can support multiple flags, so, for example,
     // if `approval‑mozilla‑release` is unselected but `approval‑mozilla‑beta` is still selected, keep it
-    if (state !== '?' && $fieldset && !this.find_select($fieldset)) {
+    if (state !== '?' && $fieldset && !this.find_selectors($fieldset).length) {
       $fieldset.remove();
     }
 
@@ -137,6 +187,25 @@ Bugzilla.FlagTypeComment = class FlagTypeComment {
 
       if ($fieldset) {
         this.$fieldset_wrapper.appendChild($fieldset);
+
+        // Show any other patches that can be requested for approval
+        bugzilla_ajax({
+          url: `${BUGZILLA.config.basepath}rest/bug/${this.bug_id}/attachment?` +
+            'include_fields=id,summary,content_type,is_patch,is_obsolete',
+        }, ({ bugs }) => {
+          const attachments = bugs ? bugs[this.bug_id] : [];
+          const others = attachments.filter(att => att.id !== this.attachment_id && !att.is_obsolete &&
+            (att.is_patch || this.extra_patch_types.includes(att.content_type)));
+
+          if (others.length) {
+            $fieldset.querySelector('tbody').insertAdjacentHTML('beforeend',
+              '<tr class="other-patches"><th>Do you want to request approval of these patches as well?</th><td>' +
+              `${others.map(patch =>
+                `<div><label><input type="checkbox" checked data-id="${patch.id}"> ${patch.summary}</label></div>`
+              ).join('')}` +
+              '</td></tr>');
+          }
+        });
       }
     }
 
@@ -166,59 +235,57 @@ Bugzilla.FlagTypeComment = class FlagTypeComment {
 
   /**
    * Convert the input values into comment text and remove the temporary fieldset before submitting the form.
-   * @returns {Boolean} Always `true` to allow submitting the form.
+   * @param {Event} event `submit` event.
+   * @returns {Boolean} `true` when submitting the form normally if no fieldset has been inserted, `false` otherwise.
    */
-  form_onsubmit() {
-    const $markdown_off = this.$comment.form.querySelector('input[name="markdown_off"]');
+  async form_onsubmit(event) {
+    if (!this.inserted_fieldsets.length) {
+      return true;
+    }
+
+    // Prevent auto-submission
+    event.preventDefault();
+
+    const $markdown_off = this.$form.querySelector('input[name="markdown_off"]');
 
     // Enable Markdown for any regular patches. Phabricator requests don't come with this hidden `<input>`
-    if (this.inserted_fieldsets.length && $markdown_off) {
+    if ($markdown_off) {
       $markdown_off.remove();
     }
 
-    for (const $fieldset of this.inserted_fieldsets) {
-      const text = [
-        `### ${$fieldset.querySelector('h3').innerText}`,
-        ...[...$fieldset.querySelectorAll('tr')].map($tr => {
-          const checkboxes = [...$tr.querySelectorAll('input[type="checkbox"]:checked')];
-          const $radio = $tr.querySelector('input[type="radio"]:checked');
-          const $input = $tr.querySelector('textarea,select,input');
-          const label = $tr.querySelector('th').innerText.replace(/\n/g, ' ');
-          let value = '';
-
-          if (checkboxes.length) {
-            value = checkboxes.map($checkbox => $checkbox.value.trim()).join(', ');
-          } else if ($radio) {
-            value = $radio.value.trim();
-          } else if ($input) {
-            value = $input.value.trim();
-
-            if ($input.dataset.type === 'bug') {
-              if (!value) {
-                value = 'None';
-              } else if (!isNaN(value)) {
-                value = `Bug ${value}`;
-              }
-            }
-
-            if ($input.dataset.type === 'bugs') {
-              if (!value) {
-                value = 'None';
-              } else {
-                value = value.split(/,\s*/).map(str => (!isNaN(str) ? `Bug ${str}` : str)).join(', ');
-              }
-            }
-          }
-
-          return `* **${label}**: ${value}`;
-        }),
-      ].join('\n');
+    // Convert the form values to Markdown comment
+    this.inserted_fieldsets.forEach($fieldset => this.add_comment(this.create_comment($fieldset)));
+
+    // Submit the form via XHR before API requests to make sure the change is notified via email
+    await new Promise(resolve => {
+      const request = new XMLHttpRequest();
+
+      request.open('POST', `${BUGZILLA.config.basepath}attachment.cgi`);
+      request.addEventListener('loadend', () => resolve());
+      request.send(new FormData(this.$form));
+    });
+
+    // Request approval for other patches if any
+    await Promise.all([...this.inserted_fieldsets].map($fieldset => new Promise(resolve => {
+      const ids = [...$fieldset.querySelectorAll('tr.other-patches input:checked')]
+        .map($input => Number($input.dataset.id));
+      const flags = this.find_selectors($fieldset).map($select => ({ name: $select.dataset.name, status: '?' }));
+
+      if (ids.length && flags.length) {
+        bugzilla_ajax({
+          type: 'PUT',
+          url: `${BUGZILLA.config.basepath}rest/bug/attachment/${ids[0]}`,
+          data: { ids, flags },
+        }, () => resolve(), () => resolve());
+      } else {
+        resolve();
+      }
+    })));
 
-      this.add_comment(text);
-      $fieldset.remove();
-    }
+    // Redirect to the bug once everything is done
+    location.href = `${BUGZILLA.config.basepath}show_bug.cgi?id=${this.bug_id}`;
 
-    return true;
+    return false;
   }
 };
 
diff --git a/template/en/default/attachment/edit.html.tmpl b/template/en/default/attachment/edit.html.tmpl
index 13f143eeb..348e80da8 100644
--- a/template/en/default/attachment/edit.html.tmpl
+++ b/template/en/default/attachment/edit.html.tmpl
@@ -50,6 +50,7 @@
 [% editable_or_hide = can_edit ? "" : " bz_hidden_option" %]
 
 <form method="post" action="[% basepath FILTER none %]attachment.cgi" onsubmit="normalizeComments();">
+  <input type="hidden" name="bugid" value="[% attachment.bug_id %]">
   <input type="hidden" name="id" value="[% attachment.id %]">
   <input type="hidden" name="action" value="update">
   <input type="hidden" name="contenttypemethod" value="manual">