Files
tbd-station-14/Content.Server/Github/GithubBackgroundWorker.cs
beck-thompson a8d6dbc324 Added button and manager for in game bug reports (Part 1) (#35350)
* Added the button and manager

* Minor cleanup

* Reigstered to the wrong thing!

* Unload UI

* Address the review

* First commit :)

* Some cleanup

* Added some comments and now the placehoder text goes away once you start typing

* Some cleanup and better test command

* Basic rate limiter class (Not finished)

* Cleanup

* Removed forgotten comment xD

* Whitespace removal

* Minor cleanup, cvar hours -> minutes

* More minor tweaks

* Don't cache timer and add examples to fields

* Added CCvar for time between bug reports

* Minor crash when restarting rounds fixed

* It compiled on my computer!

* Fix comment indents

* Remove unecessary async, removed magic strings, simplfied sawmill to not use post inject

* Make struct private

* Simplfiy TryGetLongHeader

* Changed list to enumerable

* URI cleanup

* Got rid of the queue, used a much better way!

* Made the comments a little better and fix some issues with them

* Added header consts

* Maximum reports per round is now an error message

* Time between reports is now in seconds

* Change ordering

* Change hotkey to O

* only update window when its open

* Split up validation

* address review

* Address a few issues

* inheritance fix

* API now doesn't keep track of requests, just uses the rate limited response from github

* Rough idea of how channels would work

* refactor: reorganized code, placed rate limiter into http-client-handler AND manager (usually only manager-one should work)

* cleanup

* Add user agent so api doesn't get mad

* Better error logs

* Cleanup

* It now throws!

* refactor: renaming, moved some methods, xml-doc cleanups

* refactor: BugReportWindow formatted to convention, enforced 1 updates only 1 per sec

* Add very basic licence info

* Fixed the issues!

* Set ccvar default to false

* make the button better

* fix test fail silly me

* Adress the review!

* refactor: cleanup of entry point code, binding server-side code with client-facing manager

* Resolve the other issues and cleanup and stuff smile :)

* not entity

* fixes

* Cleanup

* Cleanup

* forgor region

* fixes

* Split up function and more stuff

* Better unsubs yaygit add -A

* I pray...

* Revert "I pray..."

This reverts commit 9629fb4f1289c9009a03e4e4facd9ae975e6303e.

* I think I have to add it in the pr

* Revert "I think I have to add it in the pr"

This reverts commit e185b42f570fe5f0f51e0e44761d7938e22e67f7.

* Tweaks

* Minor tweak to permissions

---------

Co-authored-by: pa.pecherskij <pa.pecherskij@interfax.ru>
2025-08-15 09:10:38 -07:00

75 lines
2.3 KiB
C#

using System.Threading;
using System.Threading.Channels;
using System.Threading.Tasks;
using Content.Server.Github.Requests;
using Content.Shared.CCVar;
using Robust.Shared.Configuration;
namespace Content.Server.Github;
public sealed class GithubBackgroundWorker
{
[Dependency] private readonly GithubClient _client = default!;
[Dependency] private readonly IConfigurationManager _cfg = default!;
[Dependency] private readonly ILogManager _log = default!;
private ISawmill _sawmill = default!;
private bool _enabled;
private readonly Channel<IGithubRequest> _channel = Channel.CreateUnbounded<IGithubRequest>();
private readonly CancellationTokenSource _cts = new CancellationTokenSource();
public ChannelWriter<IGithubRequest> Writer => _channel.Writer;
public void Initialize()
{
_sawmill = _log.GetSawmill("github-ratelimit");
_cfg.OnValueChanged(CCVars.GithubEnabled, val => Interlocked.Exchange(ref _enabled, val), true);
}
public async Task HandleQueue()
{
var token = _cts.Token;
var reader = _channel.Reader;
while (!token.IsCancellationRequested)
{
await reader.WaitToReadAsync(token);
if (!reader.TryRead(out var request))
continue;
await SendRequest(request, token);
}
}
// this should be called in BaseServer.Cleanup!
public void Shutdown()
{
_cts.Cancel();
}
/// <summary>
/// Directly send a request to the API. This does not have any rate limits checks so be careful!
/// <b>Only use this if you have a very good reason to!</b>
/// </summary>
/// <param name="request">The request to make.</param>
/// <param name="ct">Request cancellation token.</param>
/// <returns>The direct HTTP response from the API. If null the request could not be made.</returns>
private async Task SendRequest<T>(T request, CancellationToken ct) where T : IGithubRequest
{
if (!_enabled)
{
_sawmill.Info("Tried to make a github api request but the api was not enabled.");
return;
}
try
{
await _client.TryMakeRequestSafe(request, ct);
}
catch (Exception e)
{
_sawmill.Error("Github API exception: {error}", e.ToString());
}
}
}