Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

N/A #6433

Closed
wants to merge 79 commits into from
Closed

N/A #6433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
79 commits
Select commit Hold shift + click to select a range
8b1efc8
ports goon station bug report system
Jun 7, 2024
3aa8fd0
checks
Jun 7, 2024
48f3507
formal
Jun 7, 2024
a469174
wrong time
Jun 7, 2024
8db8a1d
adds admin panel for managing bug reports / fixes smelly code / time …
Jun 7, 2024
07eb842
cleanup
Jun 7, 2024
c6db7f6
f
Jun 7, 2024
0aad3e5
lol
Jun 7, 2024
d827a70
r
Jun 7, 2024
f632e30
removed debug output
Jun 7, 2024
96d493e
cleanup
Jun 7, 2024
becfb83
makes more sense
Jun 7, 2024
a40e981
argument fix
Jun 7, 2024
6baf16d
user successfull submission message
Jun 7, 2024
63f5180
spelling
Jun 7, 2024
0f119d6
tm
Jun 8, 2024
61cf146
s
Jun 8, 2024
97b2b36
Adds API handling
Jun 8, 2024
829ddaf
cleanup & bugfixes
Jun 8, 2024
02f2492
typo
Jun 8, 2024
d1f45c2
t
Jun 8, 2024
8ea2a2a
s
Jun 8, 2024
dbeae84
f
Jun 8, 2024
27eedd8
m
Jun 8, 2024
c1bf0e2
n
Jun 8, 2024
7044f84
f
Jun 8, 2024
9b81fd4
better
Jun 8, 2024
d28bd6e
update comments
Jun 8, 2024
26fa1ce
post
Jun 8, 2024
336c9d4
bug fixes
Jun 8, 2024
a82534a
added a comment
Jun 8, 2024
97a3e6a
don't need that bit
Jun 8, 2024
0f27673
Apply suggestions from code review
vero5123 Jun 8, 2024
bfc52fa
removed redundant code
Jun 8, 2024
bca873d
Merge branch 'ISSUE-MAKER' of github.com:vero5123/cmss13 into ISSUE-M…
Jun 8, 2024
6180d35
suggestions
Jun 8, 2024
4cc2527
f
Jun 8, 2024
c1f16bf
tos message
Jun 8, 2024
3c23137
better handling
Jun 8, 2024
f77ce8f
bug fix & cleanup
Jun 8, 2024
8e367c9
more concise
Jun 8, 2024
cdcff3c
sounds better
Jun 8, 2024
ca2f960
bug fix
Jun 8, 2024
50bb0b0
fix
Jun 8, 2024
f412aab
typo
Jun 8, 2024
ffcf768
cancel should cleanup
Jun 8, 2024
da84894
more cleanup
Jun 9, 2024
2cef9cc
comment
Jun 9, 2024
12f104c
r
Jun 9, 2024
1d712fd
comment
Jun 9, 2024
962cf8b
moved the staff check
Jun 9, 2024
50c5818
spacing
Jun 9, 2024
01b2314
qdel
Jun 9, 2024
30b22de
bug fix
Jun 9, 2024
36f6591
bug fix
Jun 9, 2024
c063467
minor cleanup after bugfix
Jun 9, 2024
2704069
Apply suggestions from code review
vero5123 Jun 9, 2024
caa31dd
no qdel in new
Jun 9, 2024
01cb3a3
Merge branch 'ISSUE-MAKER' of github.com:vero5123/cmss13 into ISSUE-M…
Jun 9, 2024
8371cd8
suggested changes
Jun 9, 2024
def4ebf
added the new back after the changes.
Jun 9, 2024
cc79ecf
config example
Jun 9, 2024
1dd1a93
fixes formatting placeholder
Jun 10, 2024
ef1f609
tms should display correctly now
Jun 10, 2024
95c5450
fixes tm list
Jun 10, 2024
4209ac4
f
Jun 10, 2024
6d6a026
l
Jun 10, 2024
ddcea55
keep it simple
Jun 10, 2024
c118643
format
Jun 10, 2024
9c31a9d
format
Jun 10, 2024
00b4ce9
it's fine, i'll leave it as it was before.
Jun 10, 2024
f697c00
we don't want the header
Jun 10, 2024
917d68f
adds the bug label to every anonymous report.
Jun 10, 2024
db7c084
reject message
Jun 10, 2024
1d7009f
typo
Jun 10, 2024
e833263
clarity
Jun 10, 2024
bc8a60c
f
Jun 10, 2024
dd263ed
improvement
Jun 11, 2024
f7cee00
Merge branch 'cmss13-devs:master' into issue-maker
vero5123 Jun 11, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions code/__DEFINES/admin.dm
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ GLOBAL_LIST_INIT(note_categories, list("Admin", "Merit", "Whitelist"))
#define OBSERVER_JMP(observer, atom) atom ? "(<a href='?src=[REF(observer)];jumptocoord=1;X=[atom.x];Y=[atom.y];Z=[atom.z]'>JMP</a>)" : ""
#define ARES_MARK(user) "(<a href='?_src_=admin_holder;[HrefToken(forceGlobal = TRUE)];AresMark=[REF(user)]'>MARK</a>)"
#define ARES_REPLY(user, ref) "(<a href='?_src_=admin_holder;[HrefToken(forceGlobal = TRUE)];AresReply=[REF(user)];AresRef=[ref]'>RPLY</a>)"
#define ADMIN_VIEW_BUG_REPORT(datum) "<a href='?_src_=admin_holder;[HrefToken(forceGlobal = TRUE)];view_bug_report=[REF(datum)]'>VIEW REPORT</a>"

/atom/proc/Admin_Coordinates_Readable(area_name, admin_jump_ref)
var/turf/T = get_turf(src)
Expand Down
3 changes: 3 additions & 0 deletions code/_globalvars/global_lists.dm
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ GLOBAL_LIST_EMPTY(CLFFaxes)
GLOBAL_LIST_EMPTY(GeneralFaxes) //Inter-machine faxes
GLOBAL_LIST_EMPTY(fax_contents) //List of fax contents to maintain it even if source paper is deleted

// for all of our various bugs and runtimes
GLOBAL_LIST_EMPTY(bug_reports)

//datum containing a reference to the flattend map png url, the actual png is stored in the user's cache.
GLOBAL_LIST_EMPTY(uscm_flat_tacmap_data)
GLOBAL_LIST_EMPTY(xeno_flat_tacmap_data)
Expand Down
8 changes: 8 additions & 0 deletions code/controllers/configuration/entries/general.dm
Original file line number Diff line number Diff line change
Expand Up @@ -664,3 +664,11 @@ This maintains a list of ip addresses that are able to bypass topic filtering.

/datum/config_entry/string/client_error_message
default = "Your version of BYOND is too old, may have issues, and is blocked from accessing this server."

// GitHub API, used for anonymous bug report handling.
/datum/config_entry/string/github_app_api
protection = CONFIG_ENTRY_LOCKED | CONFIG_ENTRY_HIDDEN

/datum/config_entry/string/repo_name

/datum/config_entry/string/org
189 changes: 189 additions & 0 deletions code/datums/bug_report.dm
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
// Datum for handling bug reports
#define STATUS_SUCCESS 201

/datum/tgui_bug_report_form
/// contains all the body text for the bug report.
var/list/bug_report_data = null

/// client of user who created the initial report, immutable, set on init.
var/client/initial_user = null

/// client of the admin who is accessing the report, we don't want multiple admins unknowingly making changes at the same time.
var/client/admin_user = null

/// value to determine if the bug report is submitted and awaiting admin approval, used for state purposes in tgui.
var/awaiting_admin_approval = FALSE

// for garbage collection purposes.
var/selected_confirm = FALSE

/datum/tgui_bug_report_form/New(mob/user)
initial_user = user.client

/datum/tgui_bug_report_form/proc/external_link_prompt(client/user)
tgui_alert(user, "Unable to create a bug report at this time, please create the issue directly through our GitHub repository instead")
var/url = CONFIG_GET(string/githuburl)
if(!url)
to_chat(user, SPAN_WARNING("The configuration is not properly set, unable to open external link"))
return

if(tgui_alert(user, "This will open the GitHub in your browser. Are you sure?", "Confirm", list("Yes", "No")) == "Yes")
user << link(url)

/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)
. = ..()
if(!admin_user && user.client == initial_user && !selected_confirm) // user closes the ui without selecting confirm or approve.
qdel(src)
return
admin_user = null
selected_confirm = FALSE

/datum/tgui_bug_report_form/Destroy()
GLOB.bug_reports -= src
return ..()

/datum/tgui_bug_report_form/proc/sanitize_payload(list/params)
for(var/param in params)
params[param] = sanitize(params[param], list("\t"=" ","�"=" "))

return params

// whether or not an admin can access the record at a given time.
/datum/tgui_bug_report_form/proc/assign_admin(mob/user)
if(!initial_user)
to_chat(user, SPAN_WARNING("Unable to identify the author of the bug report."))
return FALSE
if(admin_user)
if(user.client == admin_user)
to_chat(user, SPAN_WARNING("This bug report review is already opened and accessed by you."))
else
to_chat(user, SPAN_WARNING("Another administrator is currently accessing this report, please wait for them to finish before making any changes."))
return FALSE
if(!CLIENT_IS_STAFF(user.client))
message_admins("[user.ckey] has attempted to review [initial_user.ckey]'s bug report titled [bug_report_data["title"]] without proper authorization at [time2text(world.timeofday, "YYYY-MM-DD hh:mm:ss")].")
return FALSE

admin_user = user.client
return TRUE

// returns the body payload
/datum/tgui_bug_report_form/proc/create_form()
var/datum/getrev/revdata = GLOB.revdata
var/test_merges
if(length(revdata.testmerge))
test_merges = revdata.GetTestMergeInfo(header = FALSE)

var/desc = {"
### Testmerges
[test_merges ? test_merges : "N/A"]

### Round ID
[GLOB.round_id ? GLOB.round_id : "N/A"]

### 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"]]

## Report details
Author: [initial_user]
Admin: [admin_user]
"}

return desc

// the real deal, we are sending the request through the api.
/datum/tgui_bug_report_form/proc/send_request(payload_body, client/user)
// for any future changes see https://docs.github.com/en/rest/issues/issues
var/repo_name = CONFIG_GET(string/repo_name)
var/org = CONFIG_GET(string/org)
var/token = CONFIG_GET(string/github_app_api)

if(!token || !org || !repo_name)
tgui_alert(user, "The configuration is not set for the external API.", "Issue not reported!")
external_link_prompt(user)
qdel(src)
return

var/url = "https://api.github.com/repos/[org]/[repo_name]/issues"
var/list/headers = list()
headers["Authorization"] = "Bearer [token]"
headers["Content-Type"] = "text/markdown; charset=utf-8"
headers["Accept"] = "application/vnd.github+json"

var/datum/http_request/request = new()
var/list/payload = list(
"title" = bug_report_data["title"],
"body" = payload_body,
"labels" = list("Bug")
)

request.prepare(RUSTG_HTTP_METHOD_POST, url, json_encode(payload), headers)
request.begin_async()
UNTIL(request.is_complete())

var/datum/http_response/response = request.into_response()
if(response.errored || response.status_code != STATUS_SUCCESS)
external_link_prompt(user)
else
message_admins("[user.ckey] has approved a bug report from [initial_user.ckey] titled [bug_report_data["title"]] at [time2text(world.timeofday, "YYYY-MM-DD hh:mm:ss")].")
to_chat(initial_user, SPAN_WARNING("An admin has successfully submitted your report and it should now be visible on GitHub. Thanks again!"))
qdel(src)// approved and submitted, we no longer need the datum.

// proc that creates a ticket for an admin to approve or deny a bug report request
/datum/tgui_bug_report_form/proc/bug_report_request()
to_chat(initial_user, SPAN_WARNING("Your bug report has been submitted, thank you!"))
GLOB.bug_reports += src

var/general_message = "[initial_user.ckey] has created a bug report, you may find this report directly in the ticket panel. Feel free modify the issue to your liking before submitting it to GitHub."
GLOB.admin_help_ui_handler.perform_adminhelp(initial_user, general_message, urgent = FALSE)

var/href_message = ADMIN_VIEW_BUG_REPORT(src)
initial_user.current_ticket.AddInteraction(href_message)

/datum/tgui_bug_report_form/ui_act(action, list/params, datum/tgui/ui)
. = ..()
if (.)
return
var/mob/user = ui.user
switch(action)
if("confirm")
bug_report_data = sanitize_payload(params)
selected_confirm = TRUE
// bug report request is now waiting for admin approval
if(!awaiting_admin_approval)
bug_report_request()
awaiting_admin_approval = TRUE
else // otherwise it's been approved
var/payload_body = create_form()
send_request(payload_body, user.client)
if("cancel")
if(awaiting_admin_approval) // admin has chosen to reject the bug report
reject(user.client)
qdel(src)
ui.close()
. = TRUE

/datum/tgui_bug_report_form/ui_data(mob/user)
. = list()
.["report_details"] = bug_report_data // only filled out once the user as submitted the form
.["awaiting_admin_approval"] = awaiting_admin_approval

/datum/tgui_bug_report_form/proc/reject(client/user)
message_admins("[user.ckey] has rejected a bug report from [initial_user.ckey] titled [bug_report_data["title"]] at [time2text(world.timeofday, "YYYY-MM-DD hh:mm:ss")].")
to_chat(initial_user, SPAN_WARNING("An admin has rejected your bug report, this can happen for several reasons. They will most likely get back to you shortly regarding your issue."))

#undef STATUS_SUCCESS
15 changes: 15 additions & 0 deletions code/modules/admin/topic/topic.dm
Original file line number Diff line number Diff line change
Expand Up @@ -2248,6 +2248,21 @@
return
return remove_tagged_datum(datum_to_remove)

if(href_list["view_bug_report"])
if(!check_rights(R_ADMIN|R_MOD))
return

var/datum/tgui_bug_report_form/bug_report = locate(href_list["view_bug_report"])
if(!istype(bug_report) || QDELETED(bug_report))
to_chat(usr, SPAN_WARNING("This bug report is no longer available."))
return

if(!bug_report.assign_admin(usr))
return

bug_report.tgui_interact(usr)
return

if(href_list["show_tags"])
if(!check_rights(R_ADMIN))
return
Expand Down
1 change: 1 addition & 0 deletions colonialmarines.dme
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
5 changes: 5 additions & 0 deletions config/example/config.txt
Original file line number Diff line number Diff line change
Expand Up @@ -253,3 +253,8 @@ GAMEMODE_DEFAULT Extended
CLIENT_ERROR_VERSION 514
#CLIENT_ERROR_BUILD 1589
#CLIENT_ERROR_MESSAGE Your version of BYOND is too old, may have issues, and is blocked from accessing this server.

## GITHUB API
#GITHUB_APP_API
#REPO_NAME cmss13
#ORG cmss13-devs
9 changes: 3 additions & 6 deletions interface/interface.dm
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,11 @@
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")
if(!usr)
return
var/datum/tgui_bug_report_form/report = new(usr)

src << link(CONFIG_GET(string/githuburl))
report.tgui_interact(usr)
return

/client/verb/set_fps()
Expand Down
Loading
Loading