ui: refine hook to schedule data refreshes

[xinhaoz]

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

[cockroach-teamcity]

This change is 

[maryliag]

Reviewed 3 of 4 files at r2, 1 of 1 files at r3.
Reviewable status: complete! 0 of 0 LGTMs obtained (waiting on @xinhaoz)

---

-- commits line 7 at r3:
isn't the issue that this value should have been true then?

---

pkg/ui/workspaces/cluster-ui/src/util/hooks.ts line 37 at r3 (raw file):

 * @param callbackFn The call back function to be called at the provided interval.
 * @param scheduleIntervalMs scheduling interval in millis
 * @param shouldReschedule reschedule the function after completion

nit: the phrasing make it sounds like the shouldReschedule is a function that does the reschedule itself. Clarify that this is just a parameter that decided if you should reschedule or not

---

pkg/ui/workspaces/cluster-ui/src/util/hooks.spec.tsx line 34 at r3 (raw file):

  it("should schedule the function according to the lastCompleted time and interval provided", async () => {
    const timeoutMs = 3000;

can you use smaller duration so the test doesn't take too long?

---

pkg/ui/workspaces/cluster-ui/src/util/hooks.spec.tsx line 52 at r3 (raw file):

      { timeout: timeoutMs * 3 + 1500 },
    );
    // 3 intervals and the initial call on mount, since last completed was iniitially null.

nit: initially

[xinhaoz]

Reviewable status: complete! 0 of 0 LGTMs obtained (waiting on @maryliag)

---

-- commits line 7 at r3:

Previously, maryliag (Marylia Gutierrez) wrote…

isn't the issue that this value should have been true then?

We keep it as false because we still do not want to poll when the time picker is on a custom time range. The fix is that we now 'restart' the polling if the data is invalid.

---

pkg/ui/workspaces/cluster-ui/src/util/hooks.ts line 37 at r3 (raw file):

Previously, maryliag (Marylia Gutierrez) wrote…

nit: the phrasing make it sounds like the shouldReschedule is a function that does the reschedule itself. Clarify that this is just a parameter that decided if you should reschedule or not

Done.

---

pkg/ui/workspaces/cluster-ui/src/util/hooks.spec.tsx line 34 at r3 (raw file):

Previously, maryliag (Marylia Gutierrez) wrote…

can you use smaller duration so the test doesn't take too long?

Done.

---

pkg/ui/workspaces/cluster-ui/src/util/hooks.spec.tsx line 52 at r3 (raw file):

Previously, maryliag (Marylia Gutierrez) wrote…

nit: initially

Done.

[maryliag]

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

[xinhaoz]

TFTR!
bors r+

[craig]

Build succeeded:

• Bazel Essential CI (Cockroach)