FIX: disabling the InputSystemUIInputModule component resets all actions to None #2192

K-Tone · 2025-06-05T09:41:29Z

Description

This PR fixes a problem where disabling the InputSystemUIInputModule component would reset all the actions, even if they had been priorly set by user.

This started to happen after a fix for another regression landed, where we unassigned all actions from the components OnDisable. I believe this is wrong, since the only thing we really need to be resetting is the default actions asset that shouldn't normally survive re-reentering playmode.

Testing status & QA

Local testing, a new regression test, pending a QA pass

Overall Product Risks

Complexity: Low
Halo Effect: Low

Checklist

Before review:

Changelog entry added.
- Explains the change in Changed, Fixed, Added sections.
- For API change contains an example snippet and/or migration example.
- JIRA ticket linked, example (case %%). If it is a private issue, just add the case ID without a link.
- Jira port for the next release set as "Resolved".
Tests added/changed, if applicable.
- Functional tests Area_CanDoX, Area_CanDoX_EvenIfYIsTheCase, Area_WhenIDoX_AndYHappens_ThisIsTheResult.
- Performance tests.
- Integration tests.
Docs for new/changed API's.
- Xmldoc cross references are set correctly.
- Added explanation how the API works.
- Usage code examples added.
- The manual is updated, if needed.

During merge:

Commit message for squash-merge is prefixed with one of the list:
- NEW: ___.
- FIX: ___.
- DOCS: ___.
- CHANGE: ___.
- RELEASE: 1.1.0-preview.3.

After merge:

Create forward/backward port if needed. If you are blocked from creating a forward port now please add a task to ISX-1444.

K-Tone · 2025-06-05T09:42:55Z

Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs

            InputActionState.s_GlobalState.onActionControlsChanged.RemoveCallback(m_OnControlsChangedDelegate);
            DisableAllActions();
            UnhookActions();
-            UnassignActions();


^ This line is very wrong, it results in user data being lost on component deactivation.

codecov-github-com · 2025-06-05T09:54:40Z

Codecov Report

Attention: Patch coverage is 36.36364% with 7 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
...InputSystem/Plugins/UI/InputSystemUIInputModule.cs	36.36%	7 Missing ⚠️

@@             Coverage Diff             @@
##           develop    #2192      +/-   ##
===========================================
- Coverage    67.78%   67.78%   -0.01%     
===========================================
  Files          367      367              
  Lines        53526    53536      +10     
===========================================
+ Hits         36284    36287       +3     
- Misses       17242    17249       +7

Flag	Coverage Δ
mac_2021.3_pkg	`5.41% <0.00%> (-0.01%)`	⬇️
mac_2021.3_project	`70.42% <36.36%> (-0.02%)`	⬇️
mac_2022.3_pkg	`5.19% <ø> (ø)`
mac_2022.3_project	`65.28% <36.36%> (-0.01%)`	⬇️
mac_6000.0_pkg	`5.20% <ø> (ø)`
mac_6000.0_project	`67.70% <36.36%> (-0.01%)`	⬇️
mac_6000.1_pkg	`5.20% <ø> (ø)`
mac_6000.1_project	`67.70% <36.36%> (-0.01%)`	⬇️
mac_6000.2_pkg	`5.20% <ø> (ø)`
mac_6000.2_project	`67.70% <36.36%> (-0.01%)`	⬇️
mac_trunk_pkg	`5.20% <ø> (ø)`
mac_trunk_project	`67.70% <36.36%> (-0.01%)`	⬇️
win_2021.3_pkg	`5.41% <0.00%> (-0.01%)`	⬇️
win_2021.3_project	`70.49% <36.36%> (-0.02%)`	⬇️
win_2022.3_pkg	`5.19% <ø> (ø)`
win_2022.3_project	`65.36% <36.36%> (-0.01%)`	⬇️
win_6000.0_pkg	`5.20% <ø> (ø)`
win_6000.0_project	`67.77% <36.36%> (-0.01%)`	⬇️
win_6000.1_pkg	`5.20% <ø> (ø)`
win_6000.1_project	`67.77% <36.36%> (-0.01%)`	⬇️
win_6000.2_pkg	`5.20% <ø> (ø)`
win_6000.2_project	`67.77% <36.36%> (-0.01%)`	⬇️
win_trunk_pkg	`5.20% <ø> (ø)`
win_trunk_project	`67.77% <36.36%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...InputSystem/Plugins/UI/InputSystemUIInputModule.cs	`93.17% <36.36%> (-0.59%)`	⬇️

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

K-Tone · 2025-06-06T09:22:32Z

As to the catches by Copilot:

(1) This is fine. Historically, we've only had UnassignActions since the beginning of the year, and that was a mistake, so I think future maintainers don't need to know we made that mistake and corrected it quickly

(2) There is a short, but to the point comment actually. Not sure I'd like to expand it further.

Pauliusd01

Found an issue with the UI default actions getting added in after a scene load. Steps are: Open our main repo as a unity project -> top dropdown QA Tools -> Add all core samples / open core scene -> import the textmeshpro essentials if needed -> make sure the event system is set to use a project wide actions asset if it isn't already -> enter play mode and observe the action count -> pick anything from the scene loader -> esc -> return to scene picker and observe the action count again. This does not reproduce in Develop

06.06.2025.-.Unity.197.mp4

K-Tone · 2025-06-25T08:28:34Z

Hey @Pauliusd01, could you try it again please? With this new patch, I tried:

(1) With actions asset set before play mode

Disabling component doesn't lead to all actions lost any more
Entering playmode and loading the project-wide test scene and navigating the menu doesn't duplicate actions

(2) With no actions asset set before play mode

Entering playmode sets the default actions correctly
Disabling domain reload and entering play mode twice doesn't result in exception

Note that when you enter play mode with InputSystemUIInputModule that had no actions asset assigned it results in us creating some default actions asset behind the scenes and using it to assign all actions. Disabling this component results in us destroying the default asset, and thus the actions get unassigned as well, so you do get "None" in this case, which I guess is kinda by design (though unfortunate). Enabling it back will restore defaults. If I were to redesign this component from scratch, I would make an explicit checkbox in the component called "Use defaults", and in this case I would hide all the actions, so that the user doesn't get confused by what is going on behind the scenes. This would also simplify code a little bit.

K-Tone · 2025-06-25T08:53:02Z

Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs

            UnhookActions();
-            UnassignActions();
+
+            // In the case we've been initialialised with default actions, we want to unalloc them


We want to do this because if we don't dealloc them, then no one would

K-Tone · 2025-06-25T08:55:08Z

Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs

+        {
+            if (defaultActions != null)
+            {
+                defaultActions.Dispose();


I guess, calling Dispose is just to stay on the safe side since the only data default actions stores is a ref to ScriptableObject that won't survive even with domain reload off. It will be in this intermediate state though, where its native data is gone but the instance is not null until the next gc run (however you'll see it as "null" in debugger, and ==null will be true as well, thanks to Unity's Equals overload for all Object descendants).

Does this comment imply that it should be Object.ReferenceEquals(null, defaultActions) in if statement above? If its disposable, yes it should be disposed, even if the implementation would do nothing IMO.

I think I wasn't clear, pardon. DefaultActions is fine to check for null like above since it's not destroyed natively. What is in the intermediate state happens to be aggregated in defaultActions (DefaultActions has a ref to ScriptableObject, so it's the ScriptableObject would have to be checked with ReferenceEquals if we needed to, but we don't).

Copilot

Pull Request Overview

This PR fixes an issue where disabling the InputSystemUIInputModule component unintentionally resets user-assigned actions by refining the reset logic for default actions.

Introduces a static ResetDefaultActions method to dispose of lingering static default actions across domain reloads.
Modifies OnDisable to only unassign default actions when they match the current actions asset.
Adds a regression Unity test to verify user actions persist and updates a test description in the editor tests for clarity.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File	Description
Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs	Added ResetDefaultActions method with proper disposal logic and refined OnDisable unassignment for default actions.
Packages/com.unity.inputsystem/CHANGELOG.md	Added a changelog entry summarizing the fix.
Assets/Tests/InputSystem/Plugins/UITests.InputModuleTests.cs	Added a new regression test ensuring disabling does not reset user actions.
Assets/Tests/InputSystem.Editor/ProjectWideInputActionsEditorTests.cs	Updated test description for improved grammar.

Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs

ekcoh

Nice and tidy, looks good to me, great you added a test for the regression. Only a single comment/question regarding the null check.

ekcoh · 2025-06-25T19:02:35Z

Assets/Tests/InputSystem/Plugins/UITests.InputModuleTests.cs

        }

+        [UnityTest]
+        [Description("Regression test for https://jira.unity3d.com/browse/ISXB-1493")]


Great you added a specific test for the regression

ekcoh · 2025-06-25T19:04:41Z

Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs

+        {
+            if (defaultActions != null)
+            {
+                defaultActions.Dispose();


Does this comment imply that it should be Object.ReferenceEquals(null, defaultActions) in if statement above? If its disposable, yes it should be disposed, even if the implementation would do nothing IMO.

ekcoh · 2025-06-25T19:06:53Z

@K-Tone Looks like you need to rerun the formatter on this branch before CI will be happier. Other failures look like instabilities.

…ving junk after reloading

…temUIInputModule.cs Co-authored-by: Copilot <[email protected]>

K-Tone commented Jun 5, 2025

View reviewed changes

K-Tone changed the title ~~reset the default actions static field during scene load to fix it ha…~~ FIX: disabling the InputSystemUIInputModule resets all actions to None Jun 5, 2025

K-Tone changed the title ~~FIX: disabling the InputSystemUIInputModule resets all actions to None~~ FIX: disabling the InputSystemUIInputModule component resets all actions to None Jun 5, 2025

K-Tone requested a review from Copilot June 6, 2025 09:18

This comment was marked as outdated.

Sign in to view

K-Tone requested review from Pauliusd01 and ekcoh June 6, 2025 10:12

Pauliusd01 requested changes Jun 6, 2025

View reviewed changes

Pauliusd01 self-requested a review June 25, 2025 08:42

K-Tone commented Jun 25, 2025

View reviewed changes

K-Tone marked this pull request as ready for review June 25, 2025 08:59

K-Tone force-pushed the anthony/isxb-1493-deactivation-resets-actions branch from bb42698 to e4eba87 Compare June 25, 2025 08:59

K-Tone requested a review from Copilot June 25, 2025 15:40

Copilot AI reviewed Jun 25, 2025

View reviewed changes

Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs Outdated Show resolved Hide resolved

ekcoh approved these changes Jun 25, 2025

View reviewed changes

Pauliusd01 approved these changes Jun 26, 2025

View reviewed changes

K-Tone and others added 7 commits June 26, 2025 13:31

reset the default actions static field during scene load to fix it ha…

e433739

…ving junk after reloading

add a new regression test to improve coverage

6879065

fix up typo

f08c6fd

update changelog

d94b0e6

yet another attempt at addressing the ui input issues

6aa15c7

use non-default asset for testing

f4bed15

Update Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSys…

5c996c0

…temUIInputModule.cs Co-authored-by: Copilot <[email protected]>

K-Tone force-pushed the anthony/isxb-1493-deactivation-resets-actions branch from eb2a2b1 to 5c996c0 Compare June 26, 2025 10:31

update formatting

29fcc49

update changelog with a linked case

44831d5

K-Tone merged commit 4f6aca6 into develop Jun 27, 2025
131 checks passed

K-Tone deleted the anthony/isxb-1493-deactivation-resets-actions branch June 27, 2025 08:19

FIX: disabling the InputSystemUIInputModule component resets all actions to None #2192

FIX: disabling the InputSystemUIInputModule component resets all actions to None #2192

Uh oh!

Conversation

K-Tone commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing status & QA

Overall Product Risks

Checklist

Uh oh!

K-Tone Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

codecov-github-com bot commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

This comment was marked as outdated.

Uh oh!

K-Tone commented Jun 6, 2025

Uh oh!

Pauliusd01 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

K-Tone commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

K-Tone Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

K-Tone Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

ekcoh Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

K-Tone Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

ekcoh left a comment

Choose a reason for hiding this comment

Uh oh!

ekcoh Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

ekcoh Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

ekcoh commented Jun 25, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

K-Tone commented Jun 5, 2025 •

edited

Loading

codecov-github-com bot commented Jun 5, 2025 •

edited

Loading

Pauliusd01 left a comment •

edited

Loading

K-Tone commented Jun 25, 2025 •

edited

Loading