Issue 5880 - Basic issue reporter implementation

issue-reporter.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ skipping 324 matching lines @@
     uuidString += component;
     if (i >= 1 && i<= 4)
       uuidString += "-";
   }
 
   let params = new URLSearchParams({
     version: 1,
     guid: uuidString,
     lang: reportData.getElementsByTagName("adblock-plus")[0].getAttribute("locale")
   });
   let url = "https://reports.adblockplus.org/submitReport?" + params;

[Felix Dahlke, 2017/10/19 16:48:04]

Why not make this a pref?

[Wladimir Palant, 2017/10/19 17:54:25]

Why make it a pref? It used to be a pref in the legacy Firefox extension, which
made sense for testing. But with Web Extensions hidden preferences aren't
exactly accessible.

[Felix Dahlke, 2017/10/19 18:21:31]

Two reasons:

1. Feels wrong to hard code URLs in general. We have most (if not all?) of them
in prefs.js already.
2. Makes it easier for forks to change (granted, they have to host their own
backend, but still).

But like I said, I wouldn't insist.

 
   let reportSent = event =>
   {
-    let success;
-    let errorMessage;
+    let success = false;
+    let errorMessage = browser.i18n.getMessage("filters_subscription_lastDownload_connectionError");
     try
     {
       success = request.status == 200;
-      errorMessage = request.status + " " + request.statusText;
+      if (request.status != 0)
+        errorMessage = request.status + " " + request.statusText;
     }
     catch (e)
     {
-      // No request status, connection wasn't established.
-      success = false;
-      errorMessage = browser.i18n.getMessage("filters_subscription_lastDownload_connectionError");
+      // Getting request status might throw if no connection was established
     }
 
     let result;
     try
     {
       result = request.responseText;
     }
     catch (e)
     {
       result = "";
+    }
+
+    if (!success)
+    {
+      let errorElement = document.getElementById("error");
+      let template = browser.i18n.getMessage("issueReporter_errorMessage").replace(/[\r\n\s]+/g, " ");
+
+      let [, beforeLink, linkText, afterLink] = /(.*)\[link\](.*)\[\/link\](.*)/.exec(template) || [null, "", template, ""];
+      beforeLink = beforeLink.replace(/\?1\?/g, errorMessage);
+      afterLink = afterLink.replace(/\?1\?/g, errorMessage);
+
+      while (errorElement.firstChild)
+        errorElement.removeChild(errorElement.firstChild);
+
+      let link = document.createElement("a");
+      link.textContent = linkText;
+      browser.runtime.sendMessage({
+        type: "app.get",
+        what: "doclink",
+        link: "reporter_connect_issue"
+      }).then(url =>
+      {
+        link.href = url;
+      });
+
+
+      errorElement.appendChild(document.createTextNode(beforeLink));
+      errorElement.appendChild(link);
+      errorElement.appendChild(document.createTextNode(afterLink));
+
+      errorElement.hidden = false;
     }
 
     result = result.replace(/%CONFIRMATION%/g, encodeHTML(browser.i18n.getMessage("issueReporter_confirmationMessage")));
     result = result.replace(/%KNOWNISSUE%/g, encodeHTML(browser.i18n.getMessage("issueReporter_knownIssueMessage")));
     result = result.replace(/(<html)\b/, '$1 dir="' + encodeHTML(window.getComputedStyle(document.documentElement, "").direction + '"'));
 
+    document.getElementById("sendReportMessage").hidden = true;
     document.getElementById("sendingProgressContainer").hidden = true;
 
     let resultFrame = document.getElementById("result");
     resultFrame.setAttribute("src", "data:text/html;charset=utf-8," + encodeURIComponent(result));
     resultFrame.hidden = false;
 
     document.getElementById("continue").disabled = false;
   };
 
   let request = new XMLHttpRequest();
@@ skipping 15 matching lines @@
       progress.value = event.loaded;
     }
   });
   request.send(serializeReportData());
 }
 
 function leaveSendPage()
 {
   window.close();
 }