Fixed Multiple-Nag Bug by Refactoring in-app New Campaign Handling

[IllianiCBT]

For a good long while there has been a weird bug where sometimes advancing day would cause nag dialogs to trigger multiple times. This became more noticeable with the introduction of the Turnover module, as that nags users on a monthly basis increasing the likelihood users will interact with this bug.

It's taken me literal months to track down and identify the cause of this bug. It turns out that when a user creates a new campaign, from within an existing campaign, event listeners are not unregistered causing all events to be triggered multiple times. For example, it would mean that any New Day event would be triggered twice. Technically, it would trigger once for each new in-app campaign created. Create 20 new campaigns, one after the other, without exiting mhq? Your new day events would trigger 20 times.

However, if we unregister these event listeners and the user happened to cancel out of the in-app new campaign dialog then no events would trigger until the campaign was reloaded or mhq exited.

Previously we've papered over in-app new campaign issues by having a dialog pop-up advising the user not to cancel once they pass a certain point. That worked well enough for the old 'preset' bug, but that wouldn't work here. At least, not without a really poor play experience.

Instead, what I've done is passed some logic down the chain so that a few things happen when a player triggers an in-app new campaign:

• We ask the user to confirm they want to start a new campaign. If they fail to confirm, we stop here.
• We ask the user if they would like to save their existing campaign. If they cancel the save prompt, or a save fails, we stop here.
• The point of no return is reached. We unregister all event listeners and trigger the new campaign preset picker dialog.
• If the preset picker dialog is canceled, we exit MekHQ entirely.
• If the customize preset dialog is canceled, we exit MekHQ entirely.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 10.47%. Comparing base (7ddb24c) to head (974f563).
Report is 64 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff              @@
##             master    #5357      +/-   ##
============================================
- Coverage     10.47%   10.47%   -0.01%     
+ Complexity     6069     6065       -4     
============================================
  Files           959      959              
  Lines        135559   135602      +43     
  Branches      19750    19760      +10     
============================================
- Hits          14204    14200       -4     
- Misses       119997   120046      +49     
+ Partials       1358     1356       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[IllianiCBT]

A couple of addendums:

• I could have sworn there were a couple of bug reports related to this, but I couldn't find them.
• The duplicate events issue isn't just restricted to New Day events, but effectively any gui-based event. I anticipate this fix having some performance improvements for users who start a lot of campaigns back-to-back.

[psikomonkie]

Do you think this would fix #4767 ?

[IllianiCBT]

Potentially. iirc we were never able to track down the root cause, but multiple event triggers could cause that, if paid recruitment is a part of the functionality triggered by a new day event.