Skip to content
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.

Sign up for GitHub

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

Jump to bottom

release-23.1: ui: refine hook to schedule data refreshes #99376

Merged
merged 1 commit into from
Apr 4, 2023
Merged

release-23.1: ui: refine hook to schedule data refreshes #99376

merged 1 commit into from
Apr 4, 2023

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Mar 23, 2023 •
edited by xinhaoz
Loading

Backport 1/1 commits from #97516 on behalf of @xinhaoz.

/cc @cockroachdb/release

This commit refines the logic in the useFetchDataWithPolling hook. Namely, it has been renamed to useScheduleFunction to be more generic. It also fixes a bug where the first call would not occur if shouldPoll was false. This mainly affects the insights pages where if the page was loaded with a custom time interval, the request would not be made.

Epic: none

Release note: None

Release justification: bug fix for existing functionality

@xinhaoz
ui: refine hook to schedule data refreshes
6ed0115 
This commit refines the logic in the `useFetchDataWithPolling`
hook. Namely, it has been renamed to `useScheduleFunction` to
be more generic. It also fixes a bug in the insights pages
where we would not update stale data  if `shouldPoll` was false
(which is the case for custom time intervals). We fix this by
always fetching immediately if the data is invalid.

Tests were also added to verify the hook behaviour.

Epic: none

Release note: None
@blathers-crl blathers-crl bot requested a review from a team March 23, 2023 14:36
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-23.1-97516 branch 2 times, most recently from 15a85aa to 6ed0115 Compare March 23, 2023 14:36
@blathers-crl blathers-crl bot requested review from maryliag and xinhaoz March 23, 2023 14:36
@blathers-crl
Copy link
Author

blathers-crl bot commented Mar 23, 2023

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Patches should only be created for serious issues or test-only changes.
  • Patches should not break backwards-compatibility.
  • Patches should change as little code as possible.
  • Patches should not change on-disk formats or node communication protocols.
  • Patches should not add new functionality.
  • Patches must not add, edit, or otherwise modify cluster versions; or add version gates.
If some of the basic criteria cannot be satisfied, ensure that the exceptional criteria are satisfied within.
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters.
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.

Add a brief release justification to the body of your PR to justify this backport.

Some other things to consider:

  • What did we do to ensure that a user that doesn’t know & care about this backport, has no idea that it happened?
  • Will this work in a cluster of mixed patch versions? Did we test that?
  • If a user upgrades a patch version, uses this feature, and then downgrades, what happens?

@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels Mar 23, 2023
@cockroach-teamcity
Copy link
Member

This change is Reviewable

@rafiss
Copy link
Collaborator

rafiss commented Mar 31, 2023

@xinhaoz just wanted to check if this needs to be merged in time for 23.1.0?

@xinhaoz
Copy link
Member

xinhaoz commented Apr 3, 2023

@rafiss Shouldn't hold anything up, I'm getting it merged now though.

maryliag
maryliag approved these changes Apr 3, 2023
View reviewed changes
Copy link
Contributor

@maryliag maryliag left a comment

Choose a reason for hiding this comment

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

:lgtm:

Reviewed 4 of 4 files at r1, all commit messages.
Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained (waiting on @xinhaoz)

@xinhaoz xinhaoz merged commit 13d9fe7 into release-23.1 Apr 4, 2023
@xinhaoz xinhaoz deleted the blathers/backport-release-23.1-97516 branch April 4, 2023 00:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maryliag maryliag maryliag approved these changes

@xinhaoz xinhaoz Awaiting requested review from xinhaoz

Assignees

@xinhaoz xinhaoz

Labels
blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@cockroach-teamcity @rafiss @xinhaoz @maryliag