Open
Conversation
Reviewer's GuideThis PR bolsters patch reliability by introducing HarmonyFinalizer hooks across all patches for exception logging, standardizes class and method access modifiers to internal/private for consistency, and streamlines patch declarations by specifying targets directly in the HarmonyPatch attributes. Sequence diagram for exception handling in patch finalizerssequenceDiagram
participant PatchedMethod as Patched Method
participant PatchClass as Patch Finalizer
participant Logger as MarseyLogger
PatchedMethod->>PatchClass: Exception thrown
PatchClass->>Logger: Fatal($"Error while patching <PatchName>: {__exception}")
Class diagram for updated patch classes with HarmonyFinalizerclassDiagram
class ConsoleHostPatch {
+[HarmonyPatch("Robust.Client.Console.ClientConsoleHost", "CanExecute")]
-Postfix(ref bool __result)
-Finalizer(Exception __exception)
}
class ClientHeavyAttackPatch {
+[HarmonyPatch(typeof(MeleeWeaponSystem), "ClientHeavyAttack")]
-Prefix(ref EntityUid user, ...)
-Finalizer(Exception __exception)
}
class DrawOcclusionDepthPatch {
+[HarmonyPatch]
-Prefix()
-Finalizer(Exception __exception)
}
class GunUpdatePatch {
+[HarmonyPatch(typeof(GunSystem), nameof(GunSystem.Update))]
-Transpiler(IEnumerable<CodeInstruction> codes)
-Finalizer(Exception __exception)
}
class ClientAdminManagerPatch {
+[HarmonyPatch]
-Prefix(ref bool __result)
-Finalizer(Exception __exception)
}
class EntityMenuElementPatch {
+[HarmonyPatch]
-Prefix(EntityUid entity, EntityMenuElement __instance, ref string __result)
-Finalizer(Exception __exception)
}
class ClientConGroupControllerPatch {
+[HarmonyPatch]
-Prefix(ref bool __result)
-Finalizer(Exception __exception)
}
class MouseRotatorPatch {
+[HarmonyPatch]
-Prefix()
-Finalizer(Exception __exception)
}
class OverlaysPatch {
+[HarmonyPatch]
-Prefix()
-Finalizer(Exception __exception)
}
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @noverd - I've reviewed your changes - here's some feedback:
- Consider consolidating the repeated [HarmonyFinalizer] logging logic into a shared helper or base class to reduce boilerplate across all patches.
- Verify that your finalizer signatures match Harmony’s expected signature (usually returning an Exception) so that errors are handled or propagated correctly.
- Double-check that changing patch classes from public to internal doesn’t inadvertently break any external consumers or reflection-based lookups.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider consolidating the repeated [HarmonyFinalizer] logging logic into a shared helper or base class to reduce boilerplate across all patches.
- Verify that your finalizer signatures match Harmony’s expected signature (usually returning an Exception) so that errors are handled or propagated correctly.
- Double-check that changing patch classes from public to internal doesn’t inadvertently break any external consumers or reflection-based lookups.
## Individual Comments
### Comment 1
<location> `ArabicaCliento/Patches/ConsoleHostPatch.cs:13` </location>
<code_context>
}
+
+
+ [HarmonyFinalizer]
+ private static void Finalizer(Exception __exception)
+ {
</code_context>
<issue_to_address>
Finalizer logs all exceptions, which may mask original errors.
Logging without rethrowing may suppress important exceptions and hide bugs. Consider rethrowing after logging or handling only specific exceptions.
</issue_to_address>
### Comment 2
<location> `ArabicaCliento/Patches/DrawOcclusionDepthPatch.cs:14` </location>
<code_context>
}
+
+
+ [HarmonyFinalizer]
+ private static void Finalizer(Exception __exception)
+ {
</code_context>
<issue_to_address>
Finalizer logs exceptions but does not handle or rethrow them.
Consider rethrowing the exception after logging to prevent silent failures and ensure errors are not masked.
</issue_to_address>
### Comment 3
<location> `ArabicaCliento/Patches/GunUpdatePatch.cs:61` </location>
<code_context>
}
+
+
+ [HarmonyFinalizer]
+ private static void Finalizer(Exception __exception)
+ {
</code_context>
<issue_to_address>
Finalizer logs exceptions but does not rethrow.
Evaluate if rethrowing exceptions after logging is necessary to ensure important errors are not silently ignored.
</issue_to_address>
### Comment 4
<location> `ArabicaCliento/Patches/ClientAdminManagerPatch.cs:28` </location>
<code_context>
}
+
+
+ [HarmonyFinalizer]
+ private static void Finalizer(Exception __exception)
+ {
+ MarseyLogger.Fatal($"Error while patching ClientAdminManagerPatch: {__exception}");
+ }
}
</code_context>
<issue_to_address>
Finalizer logs exceptions but does not rethrow.
Suppressing exceptions in the finalizer may conceal errors. Consider rethrowing after logging if needed.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
+13
to
+16
| [HarmonyFinalizer] | ||
| private static void Finalizer(Exception __exception) | ||
| { | ||
| MarseyLogger.Fatal($"Error while patching ConsoleHostPatch: {__exception}"); |
There was a problem hiding this comment.
issue (bug_risk): Finalizer logs all exceptions, which may mask original errors.
Logging without rethrowing may suppress important exceptions and hide bugs. Consider rethrowing after logging or handling only specific exceptions.
Comment on lines
+14
to
+17
| [HarmonyFinalizer] | ||
| private static void Finalizer(Exception __exception) | ||
| { | ||
| MarseyLogger.Fatal($"Error while patching DrawOcclusionDepthPatch: {__exception}"); |
There was a problem hiding this comment.
issue (bug_risk): Finalizer logs exceptions but does not handle or rethrow them.
Consider rethrowing the exception after logging to prevent silent failures and ensure errors are not masked.
Comment on lines
+61
to
+64
| [HarmonyFinalizer] | ||
| private static void Finalizer(Exception __exception) | ||
| { | ||
| MarseyLogger.Fatal($"Error while patching GunUpdatePatch: {__exception}"); |
There was a problem hiding this comment.
issue (bug_risk): Finalizer logs exceptions but does not rethrow.
Evaluate if rethrowing exceptions after logging is necessary to ensure important errors are not silently ignored.
Comment on lines
+28
to
+31
| [HarmonyFinalizer] | ||
| private static void Finalizer(Exception __exception) | ||
| { | ||
| MarseyLogger.Fatal($"Error while patching ClientAdminManagerPatch: {__exception}"); |
There was a problem hiding this comment.
issue (bug_risk): Finalizer logs exceptions but does not rethrow.
Suppressing exceptions in the finalizer may conceal errors. Consider rethrowing after logging if needed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
title 🥇
LocalPlayerAddCompSystemwith generic and replace with type-checking systemsSummary by Sourcery
Add Harmony finalizers for robust error handling in patches, streamline patch definitions, and standardize class modifiers to improve client stability
Enhancements: