Feat/improve exceptions #164

SnowyWhite · 2024-11-03T01:38:43Z

What does this PR do?

This pull request improves the message shown when the game crashes.
It replaces the old MessageBox with a TaskDialog that offers more customisation options.

The following information is included in the new message:

The IW4x revision of the client
The Windows Version
The launch parameters

And if the crash happened in-game:

Whether it was in private match or on a dedicated server
The IW4x revision of the server
The server name
the IP address of the server
The gametype
The map name

It also includes a hyperlink to join the Discord server.

Anything else we should know?

To make this possible, a few other things were added or changed too.

sv_version dvar, which contains the version parsed from an Infostring
shortversion dvar, which contains the client version (was already part of the game)
UI_GetGameTypeDisplayName method, for completeness, not really required
A new utility method the get the Windows version as a string
The required minimum version of Windows is updated from 5 to 6 (Vista), as the new Windows Controls library has this limit

Screenshot of crash messages

Crash happened when playing on a dedicated server

Crash happened when playing a private match

Crash happened somewhere at the main menu

Rackover

Looks good overall, few things to change

src/Components/Modules/Exception.cpp

src/Utils/Utils.cpp

…at/improve-exceptions

…te/iw4y into feat/improve-exceptions

src/Components/Modules/Exception.cpp

Rackover · 2024-11-05T21:13:59Z

I'm testing this as soon as I have a bit of time

src/Utils/Utils.cpp

src/Components/Modules/Exception.cpp

Rackover · 2024-11-07T09:18:18Z

src/Game/Dvars.hpp

@@ -132,6 +132,10 @@ namespace Game
 	extern const dvar_t** cg_scoreboardWidth;

 	extern const dvar_t** version;
+	/// <summary>


why so? care to explain? :P

yea but as a result of it being microsoft-specific, this comment is visible in Intellisense when you type the name of the function or variable in Visual Studio.

If you type Game::version it will print in a tooltip the content of the <summary> placed just above, making it convenient to use. I do not have the same behaviour with just /// (although maybe there are other ways to achieve it)

If you have a practical case where the XML Documentation actually poses a problem, one that I can verify, in comparison to slash code documentation (or other methods) tell me! I do not know one, but I also work predominantly with M$ tooling

🤔

If what you mean by " 👎 " is that Visual Studio doesn't handle XML comments in Intellisense, I can provide examples where it does.
If what you mean by " 👎 " is that you know no practical downsides to using XML documentation then i'm happy to mark this conversation as resolved.

If you meant to express anything else, please use your words, I'm not fluent in "👎 " 😄

My question is: Is there anything that XML documentation breaks in comparison to ///? For instance, is there a widely used code editor that simply won't accept or display XML comments but would display /// comments?

If this is not the case then XML comments are the way to go - a large portion of people who work with this project are using or will use Visual Studio predominantly, where having Intellisense enabled by default means XML comments do have an advantage over /// comments. But if XML comments breaks other widely used IDEs, I don't mind considering leaving them out of the codebase.

I'm looking for a practical example of XML docs presenting a problem, in a real environment - i understand the theory behind having things standard or not but it's just not something that strikes me as particularly important in that project or in that ecosystem, so practical cases where something actually breaks take priority.

I used the XML style comments on purpose for a couple of reasons:

As mentioned by louve, one just needs to type /// and it will automatically create the <summary> tag and others for return types and parameters etc.

Being able to distinguish them from other comments might come in handy in the future (perhaps the wiki will get a section explaining the codebase, and XML comments would make it easy for automated export and formatting).

I am aware that this is a Visual Studio specific feature, but on the other hand most people will be working on the project with this IDE anyway and will therefore benefit from it, while users of other IDEs will not have much of a disadvantage. Moreover, the XML style is just the default option in Visual Studio, there are other, more standardized options, switching to another that works for everyone would be no problem:

Having an eye-catching doc style will hopefully remind and encourage others to document their code too :D

wroyca · 2024-11-07T03:33:54Z

src/Components/Modules/Exception.cpp

+			const auto serverVersion = Dvar::Var("sv_version").get<std::string>();
+			const auto ipAddress = Network::Address(*Game::connectedHost).getString();
+
+			char serverName[256]{ 0 };


non-constant bound is dangerous

feel free to accompany your comment with a snippet or a suggestion for something that the offending code should be replaced with

None that come to mind right now without more context. I believe the first step would be to look into StripColors and StripAllTextIcons and see how we can handle it better; perhaps leave a TODO for now or a FIXME;

I opened issue #165 for this.

src/Components/Modules/Exception.cpp

src/Components/Modules/Party.cpp

Rackover · 2024-11-11T22:24:41Z

So it's really cool and it passes testing but it's missing one thing..... fs_game 🤔

I think this is just an oversight cause I remember you talking about it.
Here I'm on a heavily modded server, fs_game is definitely not vanilla, so it should probably be part of the exception message!

Once this is handled i'm ready to merge it & release

SnowyWhite and others added 12 commits November 2, 2024 22:37

doc: Add a hint to OnDvarInit

6fdd796

feat: Add UI_GetGameTypeDisplayName

e1b61b1

feat: Add new dvar to save the server version

d17fd51

feat: Add dvar for the client version

28cf8b0

feat: Add method to get the Windows version

0859f4e

feat: Include Windows Controls library

5d546d0

feat: Limit Windows to the minimum supported version

ccadb19

fix: Actually set sv_version value

a9da13f

feat: Implement improved exception message

11f89ba

feat: Apply formatting before copying the message to clipboard

3e34e46

fix: Display MessageBox in case of a stack overflow

d99ff56

Merge branch 'develop' into feat/improve-exceptions

c3602ad

Rackover requested changes Nov 5, 2024

View reviewed changes

src/Components/Modules/Exception.cpp Outdated Show resolved Hide resolved

src/Components/Modules/Exception.cpp Outdated Show resolved Hide resolved

src/Components/Modules/Exception.cpp Outdated Show resolved Hide resolved

src/Utils/Utils.cpp Outdated Show resolved Hide resolved

SnowyWhite added 4 commits November 5, 2024 19:41

Merge branch 'develop' of https://github.com/iw4x/iw4x-client into fe…

4665b5a

…at/improve-exceptions

feat: Add method to get system architecture

d0d799a

fix: Use macros for duplicate strings

96d22ec

Merge branch 'feat/improve-exceptions' of https://github.com/SnowyWhi…

d2e6ef2

…te/iw4y into feat/improve-exceptions

Rackover reviewed Nov 5, 2024

View reviewed changes

src/Components/Modules/Exception.cpp Outdated Show resolved Hide resolved

fix: Replace macro with constexpr

955b562

wroyca reviewed Nov 7, 2024

View reviewed changes

src/Utils/Utils.cpp Outdated Show resolved Hide resolved

wroyca reviewed Nov 7, 2024

View reviewed changes

src/Utils/Utils.cpp Outdated Show resolved Hide resolved

wroyca requested changes Nov 7, 2024

View reviewed changes

Rackover reviewed Nov 7, 2024

View reviewed changes

src/Components/Modules/Exception.cpp Outdated Show resolved Hide resolved

diamante0018 reviewed Nov 7, 2024

View reviewed changes

src/Components/Modules/Party.cpp Outdated Show resolved Hide resolved

SnowyWhite added 3 commits November 7, 2024 23:16

fix: Implement requested changes

e9c4ae2

fix: Use proper check for private match

4f9220f

fix: Rename com_sv_running to sv_running

3858c31

feat: Add Mod Name to message

148e29a

SnowyWhite and others added 2 commits December 3, 2024 01:12

Merge branch 'develop' into feat/improve-exceptions

62c3175

Merge branch 'develop' into feat/improve-exceptions

144381d

Rackover approved these changes Dec 3, 2024

View reviewed changes

Rackover merged commit 4d79e89 into iw4x:develop Dec 3, 2024
2 checks passed

SnowyWhite deleted the feat/improve-exceptions branch December 17, 2024 23:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/improve exceptions #164

Feat/improve exceptions #164

SnowyWhite commented Nov 3, 2024

Rackover left a comment

Rackover commented Nov 5, 2024

This comment was marked as resolved.

Rackover Nov 7, 2024

This comment was marked as resolved.

Rackover Nov 7, 2024 •

edited

Loading

Rackover Nov 7, 2024

This comment was marked as resolved.

Rackover Nov 7, 2024

This comment was marked as resolved.

SnowyWhite Nov 7, 2024

wroyca Nov 7, 2024

Rackover Nov 7, 2024

wroyca Nov 7, 2024

SnowyWhite Nov 7, 2024

Rackover commented Nov 11, 2024

Feat/improve exceptions #164

Feat/improve exceptions #164

Conversation

SnowyWhite commented Nov 3, 2024

Crash happened when playing on a dedicated server

Crash happened when playing a private match

Crash happened somewhere at the main menu

Rackover left a comment

Choose a reason for hiding this comment

Rackover commented Nov 5, 2024

This comment was marked as resolved.

Choose a reason for hiding this comment

This comment was marked as resolved.

Rackover Nov 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as resolved.

Choose a reason for hiding this comment

This comment was marked as resolved.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Rackover commented Nov 11, 2024

Rackover Nov 7, 2024 •

edited

Loading