Merge pull request #1478 from dalf/submit_bug_workflow

Engine error log: Submit a new issue button: ask the user to check if there are some existing issues.

searx/static/themes/simple/src/less/new_issue.less

@@ -1,21 +1,48 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
+.stats_endpoint {
+  .github-issue-button {
+    display: block;
+    padding: 8px 16px;
+    font-family: sans-serif;
+    font-size: 16px;
+    color: white;
+    background-color: #238636;
+    border: #2ea043;
+    border-radius: 10px !important;
+    box-shadow: rgba(0, 0, 0, 0) 0 0 0 0;
+  }
 
-.github-issue-button {
-  display: block;
-  padding: 8px 16px;
-  font-family: sans-serif;
-  font-size: 16px;
-  color: white;
-  background-color: #238636;
-  border: #2ea043;
-  border-radius: 10px !important;
-  box-shadow: rgba(0, 0, 0, 0) 0 0 0 0;
-}
+  .github-issue-button:hover {
+    background-color: #2ea043;
+  }
 
-.github-issue-button:hover {
-  background-color: #2ea043;
-}
+  .issue-hide {
+    display: none;
+  }
+
+  input[type=checked] {
+    position: absolute;
+  }
+
+  label {
+    margin: 1rem 1rem 1rem 0;
+  }
+
+  .step_content {
+    margin: 1rem 1rem 1rem 2rem;
+  }
+
+  .step1,
+  .step2 {
+    visibility: hidden;
+  }
+
+  .step1_delay {
+    transition: visibility 0s linear 4s;
+  }
 
-.issue-hide {
-  display: none;
+  #step1:checked ~ .step1,
+  #step2:checked ~ .step2 {
+    visibility: visible;
+  }
 }

searx/static/themes/simple/src/less/stats.less

@@ -1,6 +1,25 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
 .engine-stats {
+  border-spacing: 0;
+  border-collapse: collapse;
+
+  tr td,
+  tr th {
+    border-bottom: 1px solid var(--color-result-border);
+    padding: 0.25rem;
+  }
+
+  table.engine-tooltip {
+    border-spacing: 0;
+    border-collapse: collapse;
+
+    td,
+    th {
+      border: none;
+    }
+  }
+
   .engine-name {
     width: 20rem;
   }
@@ -13,23 +32,33 @@
   .engine-reliability {
     text-align: right;
   }
+}
+
+table.engine-error th.engine-error-type,
+table.engine-error td.engine-error-type,
+failed-test {
+  width: 10rem;
+}
+
+.engine-errors {
+  margin-top: 3rem;
 
   table.engine-error {
     max-width: 1280px;
-    margin: 1rem;
-    border: 1px solid gray;
-  }
+    margin: 1rem 0 3rem 0;
+    border: 1px solid var(--color-result-border);
+    .ltr-text-align-left();
 
-  table.engine-error th.engine-error-type,
-  table.engine-error td.engine-error-type,
-  failed-test {
-    width: 10rem;
-  }
+    tr th,
+    tr td {
+      padding: 0.5rem;
+    }
 
-  table.engine-error span.log_parameters {
-    border-right: 1px solid gray;
-    padding: 0 1rem 0 0;
-    margin: 0 0 0 0.5rem;
+    & span.log_parameters {
+      border-right: 1px solid solid var(--color-result-border);
+      padding: 0 1rem 0 0;
+      margin: 0 0 0 0.5rem;
+    }
   }
 }
 

searx/templates/simple/new_issue.html

@@ -60,6 +60,16 @@ or manually by executing the searx/webapp.py file? -->
 {{-'\n  '}}* {{ test_name }}: {% for result in results%}`{{ result }}`,{% endfor -%}
 {%- endfor -%}
     </textarea>
-    <button type="submit" class="github-issue-button" title="{{ get_setting('brand.new_issue_url') }}">{{ _('Submit a new issue on Github including the above information') }}</button>
+    <input type="checkbox" id="step1">
+    <label for="step1">{{ _('Start submiting a new issue on GitHub') }}</label>
+    <div class="step1 step_content">
+        <p><a href="https://github.com/searxng/searxng/issues?q=is%3Aissue+Bug:%20{{ engine_name }}" target="_blank" rel="noreferrer noreferrer">{{ _('Please check for existing bugs about this engine on GitHub') }}</a></p>
+    </div>
+    <input class="step1 step1_delay" type="checkbox" id="step2">
+    <label class="step1 step1_delay" for="step2" >{{ _('I confirm there is no existing bug about the issue I encounter') }}</label>
+    <div class="step2 step_content">
+        <p>{{ _('If this is a public instance, please specify the URL in the bug report') }}</p>
+        <button type="submit" class="github-issue-button" title="{{ get_setting('brand.new_issue_url') }}">{{ _('Submit a new issue on Github including the above information') }}</button>
+    </div>
 </form>
 {% endmacro %}

searx/templates/simple/stats.html

@@ -91,15 +91,15 @@
 </table>
 {% endif %}
 
-<div>
-    {% if selected_engine_name %}
+{% if selected_engine_name %}
+    <div class="engine-errors">
         {% for secondary in [False, True] %}
             {% set ns = namespace(first=true) %}
             {% for error in engine_reliabilities[selected_engine_name].errors %}
                 {% if secondary == error.secondary %}
                     {% if ns.first %}
                         {% set ns.first = false %}
-                        <h3>{% if secondary %}{{ _('Warnings') }}{% else %}{{ _('Errors and exceptions') }}{% endif %}</h3>
+                        <h2>{% if secondary %}{{ _('Warnings') }}{% else %}{{ _('Errors and exceptions') }}{% endif %}</h2>
                     {% endif %}
                     <table class="engine-error">
                         <tbody>
@@ -145,7 +145,7 @@
             </table>
         {% endif %}
         {{ new_issue(selected_engine_name, engine_reliabilities[selected_engine_name]) }}
-    {% endif %}
-</div>
+    </div>
+{% endif %}
 
 {% endblock %}