From 8b1efc88129fa0d39beffff8a9e8d00ef923820f Mon Sep 17 00:00:00 2001 From: DOOM Date: Thu, 6 Jun 2024 18:43:43 -0700 Subject: [PATCH 001/101] ports goon station bug report system --- code/datums/bug_report.dm | 84 +++++++++++ colonialmarines.dme | 1 + interface/interface.dm | 10 +- .../tgui/interfaces/BugReportForm.tsx | 140 ++++++++++++++++++ .../tgui/styles/interfaces/BugReportForm.scss | 41 +++++ tgui/packages/tgui/styles/main.scss | 1 + 6 files changed, 269 insertions(+), 8 deletions(-) create mode 100644 code/datums/bug_report.dm create mode 100644 tgui/packages/tgui/interfaces/BugReportForm.tsx create mode 100644 tgui/packages/tgui/styles/interfaces/BugReportForm.scss diff --git a/code/datums/bug_report.dm b/code/datums/bug_report.dm new file mode 100644 index 000000000000..18b150555980 --- /dev/null +++ b/code/datums/bug_report.dm @@ -0,0 +1,84 @@ +// Datum for handling bug reports, giving Harry the motivation to set up the config to get this functional. + +/datum/tgui_bug_report_form + // contains all the body text for the bug report. + var/list/bug_report_data = null + + // user making the bug report + var/mob/user = null + +/datum/tgui_bug_report_form/New(mob/user) + // we should also test if the api is functional here, once the maintainers get the api is token. + if(!user.client) // nope. + external_link_prompt() + qdel(src) + src.user = user + +/datum/tgui_bug_report_form/proc/external_link_prompt() + tgui_alert(user, "Unable to create a bug report at this time, please create the issue directly through our github repository instead") + + if(tgui_alert(user, "This will open the GitHub in your browser. Are you sure?", "Confirm", list("Yes", "No")) == "Yes") + user << link(CONFIG_GET(string/githuburl)) + +/datum/tgui_bug_report_form/ui_state() + return GLOB.always_state + +/datum/tgui_bug_report_form/tgui_interact(mob/user, datum/tgui/ui) + ui = SStgui.try_update_ui(user, src, ui) + if(!ui) + ui = new(user, src, "BugReportForm") + ui.open() + +/datum/tgui_bug_report_form/ui_close(mob/user) + . = ..() + qdel(src) + +/datum/tgui_bug_report_form/proc/submit_form() + return TRUE + /*var/desc = {" + + ### Testmerges + blah blah + + ### Round ID + [GLOB.round_id] + + ### Description of the bug + [bug_report_data["description"]] + + ### What's the difference with what should have happened? + [bug_report_data["expected_behavior"]] + + ### How do we reproduce this bug? + [bug_report_data["steps"]] + + "} + + // rustg export, copy pasta from goon + var/api_response = some_proc("issue", list( + "title" = data["title"], + "body" = desc, + )) + // + if(api_message != some_success_response) + tgui_alert(user, "There has been an issue with reporting your bug, please try again later!", "Issue not reported!") + return FALSE + return TRUE + */ +/datum/tgui_bug_report_form/ui_act(action, list/params, datum/tgui/ui, list/params) + . = ..() + if (.) + return + var/mob/user = ui.user + switch(action) + if("confirm") + bug_report_data = params + ui_close(src) + if(!submit_form()) + message_admins("[user.key] has attempted to submit a bug report at [worldtime2text()].") + external_link_prompt() + to_chat(user, SPAN_WARNING("Bug report has successfully been submitted, thank you!")) + message_admins("[user.key] has submitted a bug report at [worldtime2text()].") + if("cancel") + ui_close(src) + . = TRUE diff --git a/colonialmarines.dme b/colonialmarines.dme index e7f280cd99df..b90746ceb21c 100644 --- a/colonialmarines.dme +++ b/colonialmarines.dme @@ -332,6 +332,7 @@ #include "code\datums\ASRS.dm" #include "code\datums\beam.dm" #include "code\datums\browser.dm" +#include "code\datums\bug_report.dm" #include "code\datums\callback.dm" #include "code\datums\changelog.dm" #include "code\datums\combat_personalized.dm" diff --git a/interface/interface.dm b/interface/interface.dm index c9112160d94f..89607ac12815 100644 --- a/interface/interface.dm +++ b/interface/interface.dm @@ -62,14 +62,8 @@ set name = "Submit Bug" set desc = "Submit a bug." set hidden = TRUE - - if(tgui_alert(src, "Please search for the bug first to make sure you aren't posting a duplicate.", "No dupe bugs please", list("OK", "Cancel")) != "OK") - return - - if(tgui_alert(src, "This will open the GitHub in your browser. Are you sure?", "Confirm", list("Yes", "No")) != "Yes") - return - - src << link(CONFIG_GET(string/githuburl)) + var/datum/tgui_bug_report_form/report = new(usr) + report.tgui_interact(usr) return /client/verb/set_fps() diff --git a/tgui/packages/tgui/interfaces/BugReportForm.tsx b/tgui/packages/tgui/interfaces/BugReportForm.tsx new file mode 100644 index 000000000000..cef85c35e4e8 --- /dev/null +++ b/tgui/packages/tgui/interfaces/BugReportForm.tsx @@ -0,0 +1,140 @@ +import React, { createRef, useState } from 'react'; + +import { useBackend } from '../backend'; +import { Flex, Section } from '../components'; +import { ButtonCheckbox } from '../components/Button'; +import { Window } from '../layouts'; + +type ReportForm = { + steps: string; + title: string; + description: string; + expected_behavior: string; +}; + +const InputTitle = (props) => { + return ( +

+ {props.children} + {props.required && {' *'}} +

+ ); +}; + +export const BugReportForm = (props) => { + const { act } = useBackend(); + const [checkBox, setCheckbox] = useState(false); + + const titleRef = createRef(); + const stepsRef = createRef(); + const descriptionRef = createRef(); + const expectedBehaviorRef = createRef(); + + const submit = () => { + const data: ReportForm = { + steps: stepsRef.current ? stepsRef.current.value : '', + title: titleRef.current ? titleRef.current.value : '', + description: descriptionRef.current ? descriptionRef.current.value : '', + expected_behavior: expectedBehaviorRef.current + ? expectedBehaviorRef.current.value + : '', + }; + + if ( + !data.title || + !data.description || + !data.expected_behavior || + !data.steps || + !checkBox + ) { + alert('Please fill out all required fields!'); + return; + } + act('confirm', data); + }; + + return ( + + +
+ + + + Github Repository + + + + {'Title'} + + + + {'Description'} + {'Give a short description of the bug'} + + + + + {"What's the difference with what should have happened?"} + + {'Give a short description of what you expected to happen'} + + + + + {'How do we reproduce this bug?'} + + {'Give a list of steps to reproduce this issue'} +