Add issue reporting (#50)

* Added a form to the header for reporting issues

* Use a dev tag for testing on ndip-test

* Update report issue pane based on user feedback

* Clean up the app header

* Reduce space between report issue and help

* Refactor and cleanup the app header

* Address more feedback

* Rename subjects to topics and indent values

* Consolidate help and info panels

* Fix right margin of list items

* Remove dev tag

Author: evilkermit

.env.sample

@@ -58,3 +58,8 @@ MONITORING_URL=http://your_prometheus_server/alerts
 ALERTS_URL=http://your_prometheus_server/api/v1/alerts
 # The endpoint for checking all possible alerts
 TARGETS_URL=http://your_prometheus_server/api/v1/targets
+
+# Issue reporting settings
+GITLAB_ISSUES_API_ENDPOINT=https://code.ornl.gov/api/v4/projects/20733/issues
+GITLAB_ACCESS_TOKEN=secret
+VITE_SUPPORT_EMAIL=ndip@ornl.gov

CHANGELOG.md

@@ -1,3 +1,7 @@
+### nova-dashboard, 0.21.0
+
+* Added a form to the header for reporting issues (thanks to John Duggan).
+
 ### nova-dashboard, 0.20.4
 
 * Changed the endpoint used to retrieve the Galaxy API key to generate a new key if needed (thanks to John Duggan).

pixi.lock

@@ -1,6 +1,6 @@
 [project]
 name = "nova-dashboard"
-version = "0.20.4"
+version = "0.21.0"
 description = ""
 authors = [
     { name = "Yakubov, Sergey", email = "yakubovs@ornl.gov" },

pyproject.toml

@@ -146,6 +146,14 @@ def is_admin(self) -> bool:
         except Exception:
             return False
 
+    def is_logged_in(self) -> bool:
+        try:
+            with self.connection.connect() as connection:
+                connection.galaxy_instance.users.get_current_user()
+                return True
+        except Exception:
+            return False
+
     def launch_job(self, tool_id: str, inputs: dict[str, str]) -> str:
         with self.connection.connect() as connection:
             if inputs:

src/launcher_app/galaxy.py

@@ -0,0 +1,35 @@
+"""Defines a class for interacting GitLab to create issues."""
+
+from typing import Any, Dict
+
+from django.conf import settings
+from requests import post
+
+
+class IssueManager:
+    """Class to create GitLab issues."""
+
+    def submit(self, data: Dict[str, Any]) -> str:
+        response = post(
+            settings.GITLAB_ISSUES_API_ENDPOINT,
+            headers={"PRIVATE-TOKEN": settings.GITLAB_ACCESS_TOKEN},
+            json={
+                "description": f"""# Reported By
+
+{data["email"]}
+
+# Mode of Contact
+
+Issue submission form
+
+# Issue Description
+
+{data["description"]}
+
+# Internal Issue Links""",
+                "title": f"{data['topic']}",
+            },
+        )
+        result = response.json()
+
+        return result["web_url"]

src/launcher_app/issue.py

@@ -125,6 +125,10 @@
 ALERTS_URL = os.environ.get("ALERTS_URL", "")
 TARGETS_URL = os.environ.get("TARGETS_URL", "")
 
+# Issue reporting settings
+GITLAB_ISSUES_API_ENDPOINT = os.environ.get("GITLAB_ISSUES_API_ENDPOINT")
+GITLAB_ACCESS_TOKEN = os.environ.get("GITLAB_ACCESS_TOKEN")
+
 # Internationalization
 # https://docs.djangoproject.com/en/5.1/topics/i18n/
 

src/launcher_app/settings.py

@@ -31,6 +31,7 @@
     path("api/galaxy/monitor/", views.galaxy_monitor),
     path("api/galaxy/stop/", views.galaxy_stop),
     path("api/galaxy/tools/", views.galaxy_tools),
+    path("api/issue/", views.report_issue),
     path("api/notification/", views.notification),
 ]
 

src/launcher_app/urls.py

@@ -17,6 +17,7 @@
 from requests import request as proxy_request
 
 from .galaxy import GalaxyManager
+from .issue import IssueManager
 from .notification import NotificationManager
 from .status import StatusManager
 
@@ -112,6 +113,22 @@ def galaxy_tools(request: HttpRequest) -> JsonResponse:
         return _create_galaxy_error(e, tools={})
 
 
+@require_POST
+def report_issue(request: HttpRequest) -> HttpResponse:
+    issue_manager = IssueManager()
+
+    try:
+        data = json.loads(request.body)
+        galaxy_manager = GalaxyManager(data.get("api_key", ""))
+        if not galaxy_manager.is_logged_in():
+            raise PermissionDenied()
+        url = issue_manager.submit(data)
+    except Exception:
+        return HttpResponseBadRequest("unable to process request")
+
+    return JsonResponse({"url": url})
+
+
 @require_http_methods(["GET", "POST"])
 def notification(request: HttpRequest) -> HttpResponse:
     notification_manager = NotificationManager()

src/launcher_app/views.py

@@ -14,23 +14,23 @@
         "@mdi/font": "^7.4.47",
         "js-cookie": "^3.0.5",
         "lodash.merge": "^4.6.2",
-        "pinia": "^2.1.7",
+        "pinia": "^2.3.1",
         "toml": "^3.0.0",
-        "vue": "^3.4.29",
-        "vue-router": "^4.3.3"
+        "vue": "^3.5.31",
+        "vue-router": "^4.6.4"
     },
     "devDependencies": {
-        "@rushstack/eslint-patch": "^1.8.0",
-        "@vitejs/plugin-vue": "^5.0.5",
+        "@rushstack/eslint-patch": "^1.16.1",
+        "@vitejs/plugin-vue": "^5.2.4",
         "@vue/eslint-config-prettier": "^9.0.0",
-        "eslint": "^8.57.0",
-        "eslint-plugin-vue": "^9.23.0",
-        "prettier": "^3.2.5",
-        "prettier-eslint": "^16.3.0",
-        "sass-embedded": "^1.77.8",
-        "vite": "^5.3.1",
-        "vite-plugin-vuetify": "^2.0.4",
-        "vue-eslint-parser": "^8.0.0",
-        "vuetify": "^3.7.0"
+        "eslint": "^8.57.1",
+        "eslint-plugin-vue": "^9.33.0",
+        "prettier": "^3.8.1",
+        "prettier-eslint": "^16.4.2",
+        "sass-embedded": "^1.98.0",
+        "vite": "^5.4.21",
+        "vite-plugin-vuetify": "^2.1.3",
+        "vue-eslint-parser": "^8.3.0",
+        "vuetify": "^3.12.4"
     }
 }