FIX: Tap Interaction is performed after it times out (ISXB-627)

[jfreire-unity]

Description

Fixes an issue surfaced by https://jira.unity3d.com/browse/ISXB-627

Tap interaction for analog controls such as Gamepad sticks and triggers would keep getting restarted and canceled once above the press point. And could potentially get performed after it's first timeout.

Now, once the Tap Interactions timer expires, it can only be "restarted" once if goes below the release point.

Testing status & QA

I added a automated test to confirm the behavior and validated it with the ISX-627 project (adapted) as well.

Overall Product Risks

• Complexity: 0
• Halo Effect: 0

Comments to reviewers

⚠️ The ISXB-627 bug repro doesn't work properly from 1.14 forward since it uses PlayerInput, and there are some issues with the project setup. I recommend editing that project.
Or alternatively, creating a project with an InputActionAsset that has 2 different actions for a Gamepad trigger: one with a Hold interaction and one with a Tap interaction and see that the problem doesn't reproduce.

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.

[Copilot]

Pull Request Overview

This PR fixes an issue where the Tap Interaction for analog controls (e.g. Gamepad sticks/triggers) would erroneously restart immediately after timing out.

• Added a flag (canceledFromTimerExpired) to prevent immediate reactivation after the timeout.
• Updated the Process method to incorporate this flag and reset it when appropriate.
• Updated the CHANGELOG to document the fix.

Reviewed Changes

Copilot reviewed 19 out of 23 changed files in this pull request and generated no comments.

File	Description
Packages/com.unity.inputsystem/InputSystem/Actions/Interactions/TapInteraction.cs	Added a timeout flag and logic to prevent restarting after tap timeout.
Packages/com.unity.inputsystem/CHANGELOG.md	Updated the changelog with a description of the tap interaction fix.

Files not reviewed (4)

• Assets/Samples/SimpleDemo/SimpleDemo_UsingPlayerInputSettings.lighting: Language not supported
• ProjectSettings/MemorySettings.asset: Language not supported
• ProjectSettings/MultiplayerManager.asset: Language not supported
• ProjectSettings/SceneTemplateSettings.json: Language not supported

Comments suppressed due to low confidence (1)

Packages/com.unity.inputsystem/InputSystem/Actions/Interactions/TapInteraction.cs:91

• Consider resetting the 'canceledFromTimerExpired' flag in the Reset() method to ensure that no stale state persists between interactions.

public void Reset()

[ekcoh]

Great fix, test case and changes looks good to me.

[jfreire-unity]

Great fix, test case and changes looks good to me.

thanks for proactively approving before I requested the review! :)

[jfreire-unity]

@Pauliusd01 ping me on Slack if you have any issues trying to reproduce the bug. Essentially, avoid the PlayerInput component usage since it's broken even without a fix (I'm not sure if we have a bug for it)

[Pauliusd01]

LGTM, previoulsy I'd get tap interactions on start and end of holding the trigger now I only get it at the start