Skip to content

fix(useNow): set 1000ms default interval (#4708) #4709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

MPFGlaser
Copy link

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.
⚠️ Slowing down new functions

Warning: Slowing down new functions

As the VueUse audience continues to grow, we have been inundated with an overwhelming number of feature requests and pull requests. As a result, maintaining the project has become increasingly challenging and has stretched our capacity to its limits. As such, in the near future, we may need to slow down our acceptance of new features and prioritize the stability and quality of existing functions. Please note that new features for VueUse may not be accepted at this time. If you have any new ideas, we suggest that you first incorporate them into your own codebase, iterate on them to suit your needs, and assess their generalizability. If you strongly believe that your ideas are beneficial to the community, you may submit a pull request along with your use cases, and we would be happy to review and discuss them. Thank you for your understanding.


Description

As described in issue #4708, useNow updates a lot, causing a rather significant performance impact for such a (relatively) small utility. This is even moreso the case when actually doing something with the Date value provided, such as converting it to an internationalised string.
I've resolved this by setting the default interval to 1000 ms rather than requestAnimationFrame. For the use cases where a higher update frequency is required, it is still possible, but I reckon that for 99.9% of cases, once a second is more than plenty.

Additional context

N/A

@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Apr 14, 2025
@@ -31,7 +31,7 @@ export function useNow(options: UseNowOptions<true>): { now: Ref<Date> } & Pausa
export function useNow(options: UseNowOptions<boolean> = {}) {
const {
controls: exposeControls = false,
interval = 'requestAnimationFrame',
interval = 1000,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if we do this we should also update the @default in tsdocs

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, I've corrected it.

@OrbisK
Copy link
Collaborator

OrbisK commented Apr 14, 2025

I'm not against the change, but I think it's also kind of nice to really default to the "now" time. 🤔

Bildschirmaufzeichnung.vom.2025-04-14.15-47-21.mp4

@OrbisK
Copy link
Collaborator

OrbisK commented Apr 14, 2025

Can you share a minimal reproduction of code that causes the cpu to reach 99%?

@ferferga
Copy link
Member

I've added some profilings and my concerns to the original issue: #4708 (comment)

TLDR: The amount of precision we have by default creates a perception that is more resource taxing, but requestAnimationFrame scheduler is smarter than us. It even takes into account tab inactivity. Our defaults are good enough imo and probably there's another problem in the @MPFGlaser code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:XS This PR changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants