osdlib: document why empty catch blocks are intentional #65
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.
The OSD class has 4 methods that wrap calls to parent document methods in try-catch blocks. The catch blocks were empty, which looks like a bug or lazy error handling at first glance.
Turns out it's intentional - these methods can throw when the game runs inside a cross-origin iframe (the parent document's OSD methods aren't accessible due to same-origin policy). Silently failing is actually the right behavior here since the OSD indicators are optional UI chrome, not critical functionality.
Added comments to each catch block so the next person who looks at this doesn't waste time wondering if it's a bug.
Changes: