[core] fix: get toasters timeout Infinity to match behavior of timeout 0

[JML321]

Fixes #6742

A toast with timeout: Infinity closes immediately.

See this sandbox https://codesandbox.io/p/sandbox/blueprint-toast-issue-forked-4t9r9t?file=%2Fsrc%2FApp.js%3A17%2C4.

However, a Toast with timeout: Infinity should disable the timeout, just like a Toast with timeout: 0.

Additionally, a test case for timeout: Infinity is needed.

The Issue

The error is in blueprint/packages/core/src/components/toast/toast2.tsx, specifically the line:

isTimeoutEnabled = timeout != null && timeout > 0;

Currently, when timeout = Infinity, then isTimeoutEnabled = True. When Infinity is passed as the timeout, due to useTimeout's functionality, the toast closes immediately with a 0 second delay.

This code needs to be fixed so when timeout = Infinity, then isTimeoutEnabled = False (i.e. the timeout is disabled).

Changes proposed in this pull request:

Three changes:

1. Adding an extra line as a comment to share where I found that "timeout: Infinity" should disable the timeout.
2. Fix isTimeoutEnabled so that for timeout = Infinity, isTimeoutEnabled is False, not True. In addition, the isTimeoutEnabled value is preserved for all other inputs of timeout.
3. Creating a test case that sees whether a toaster with timeout: Infinity has received a dismiss, returning a False if it has.

These changes produced correct functionality on my local computer.

Tests

• Passes tests for packages\core

Reviewers should focus on:

1. If the added comment line should be modified or deleted
2. If the new isTimeoutEnabled matches the wanted functionality, such that isTImeoutEnabled is True when the timeout is greater than 0, and False when the timeout is either null, less than or equal to 0, and Infinity.
3. Whether the test case achieves what was requested for in the open issue.

Screenshots

[changelog-app]

Generate changelog in packages/core/changelog/@unreleased

What do the change types mean?

• feature: A new feature of the service.
• improvement: An incremental improvement in the functionality or operation of the service.
• fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
• break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
  and external consumers of the service's API (e.g. customer-written software or integrations).
• deprecation: Advertises the intention to remove service functionality without any change to the
  operation of the service itself.
• manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
  performing database surgery, ...) at the time of upgrade for it to succeed.
• migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?

• ❗The break and manual task changelog types will result in a major release!
• 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
• ✨ All others will result in a minor version release.

Type

• Feature
• Improvement
• Fix
• Break
• Deprecation
• Manual task
• Migration

Description

[core] fix: get toasters timeout Infinity to match behavior of timeout 0

Check the box to generate changelog(s)

• Generate changelog entry

[jscheiny]

Thanks for making this change and adding tests. Just a few minor comments

[jscheiny]

I think we can remove both these comments, they don't add anything that the code does not provide here.

[jscheiny]

Also, lets update the docs for the timeout prop to mention the behavior of Infinity.

[JML321]

Thanks for the feedback! I've removed the comments and updated the timeout prop documentation to include the Infinity behavior. Let me know if you'd like me to make any other changes.

[jscheiny]

One minor docs change below, thanks for making this contribution

[jscheiny]

Suggested change

	* Providing a value less than or equal to 0 or Infinity will disable the timeout (this is discouraged).
	* Setting this to Infinity or a value less than or equal to 0 will disable the timeout (this is discouraged).

Minor nit to make sure that this is clear that we're not referring to values less than infinity

[JML321]

Great! Glad to help.