liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

refactor: only pass shard ID to event handlers instead of full shard object

Browse Source
This commit is contained in:
spiral
2022-01-14 18:39:03 -05:00
parent bf80dd0988
commit 50a24f03a7
13 changed files with 74 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
PluralKit.Bot/Utils/SentryUtils.cs
View File

@@ -6,7 +6,7 @@ namespace PluralKit.Bot;
public interface ISentryEnricher<T> where T : IGatewayEvent
{
void Enrich(Scope scope, Shard shard, T evt);
void Enrich(Scope scope, int shardId, T evt);
}
public class SentryEnricher:
@@ -26,7 +26,7 @@ public class SentryEnricher:
// TODO: should this class take the Scope by dependency injection instead?
// Would allow us to create a centralized "chain of handlers" where this class could just be registered as an entry in
public void Enrich(Scope scope, Shard shard, MessageCreateEvent evt)
public void Enrich(Scope scope, int shardId, MessageCreateEvent evt)
{
scope.AddBreadcrumb(evt.Content, "event.message",
data: new Dictionary<string, string>
@@ -36,7 +36,7 @@ public class SentryEnricher:
{"guild", evt.GuildId.ToString()},
{"message", evt.Id.ToString()}
});
scope.SetTag("shard", shard.ShardId.ToString());
scope.SetTag("shard", shardId.ToString());
// Also report information about the bot's permissions in the channel
// We get a lot of permission errors so this'll be useful for determining problems
@@ -46,7 +46,7 @@ public class SentryEnricher:
// scope.AddBreadcrumb(perms.ToPermissionString(), "permissions");
}
public void Enrich(Scope scope, Shard shard, MessageDeleteBulkEvent evt)
public void Enrich(Scope scope, int shardId, MessageDeleteBulkEvent evt)
{
scope.AddBreadcrumb("", "event.messageDelete",
data: new Dictionary<string, string>
@@ -55,10 +55,10 @@ public class SentryEnricher:
{"guild", evt.GuildId.ToString()},
{"messages", string.Join(",", evt.Ids)}
});
scope.SetTag("shard", shard.ShardId.ToString());
scope.SetTag("shard", shardId.ToString());
}
public void Enrich(Scope scope, Shard shard, MessageUpdateEvent evt)
public void Enrich(Scope scope, int shardId, MessageUpdateEvent evt)
{
scope.AddBreadcrumb(evt.Content.Value ?? "<unknown>", "event.messageEdit",
data: new Dictionary<string, string>
@@ -67,10 +67,10 @@ public class SentryEnricher:
{"guild", evt.GuildId.Value.ToString()},
{"message", evt.Id.ToString()}
});
scope.SetTag("shard", shard.ShardId.ToString());
scope.SetTag("shard", shardId.ToString());
}
public void Enrich(Scope scope, Shard shard, MessageDeleteEvent evt)
public void Enrich(Scope scope, int shardId, MessageDeleteEvent evt)
{
scope.AddBreadcrumb("", "event.messageDelete",
data: new Dictionary<string, string>
@@ -79,10 +79,10 @@ public class SentryEnricher:
{"guild", evt.GuildId.ToString()},
{"message", evt.Id.ToString()}
});
scope.SetTag("shard", shard.ShardId.ToString());
scope.SetTag("shard", shardId.ToString());
}
public void Enrich(Scope scope, Shard shard, MessageReactionAddEvent evt)
public void Enrich(Scope scope, int shardId, MessageReactionAddEvent evt)
{
scope.AddBreadcrumb("", "event.reaction",
data: new Dictionary<string, string>
@@ -93,6 +93,6 @@ public class SentryEnricher:
{"message", evt.MessageId.ToString()},
{"reaction", evt.Emoji.Name}
});
scope.SetTag("shard", shard.ShardId.ToString());
scope.SetTag("shard", shardId.ToString());
}
}

4
PluralKit.Bot/Utils/SerilogGatewayEnricherFactory.cs
View File

@@ -20,9 +20,9 @@ public class SerilogGatewayEnricherFactory
_botConfig = botConfig;
}
public async Task<ILogEventEnricher> GetEnricher(Shard shard, IGatewayEvent evt)
public async Task<ILogEventEnricher> GetEnricher(int shardId, IGatewayEvent evt)
{
var props = new List<LogEventProperty> { new("ShardId", new ScalarValue(shard.ShardId)) };
var props = new List<LogEventProperty> { new("ShardId", new ScalarValue(shardId)) };
if (_botConfig.Cluster != null)
props.Add(new LogEventProperty("ClusterId", new ScalarValue(_botConfig.Cluster.NodeName)));