-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
cluster-ui: use job lastCompleted time when formatting last refresh time
This fixes a small bug in the TableMetadataJobControl component where we were reading the last updated time of the job to determine whether the job completed. This lead to `Invalid Date` being shown when the job never completed before. Epic: CRDB-37558 Release note: None
- Loading branch information
Showing
2 changed files
with
179 additions
and
1 deletion.
There are no files selected for viewing
178 changes: 178 additions & 0 deletions
178
...paces/cluster-ui/src/components/tableMetadataLastUpdated/tableMetadataJobControl.spec.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,178 @@ | ||
// Copyright 2024 The Cockroach Authors. | ||
// | ||
// Use of this software is governed by the CockroachDB Software License | ||
// included in the /LICENSE file. | ||
|
||
import "@testing-library/jest-dom"; | ||
import { render, screen, fireEvent, act } from "@testing-library/react"; | ||
import moment from "moment-timezone"; | ||
import React from "react"; | ||
|
||
import * as api from "src/api/databases/tableMetaUpdateJobApi"; | ||
import { TimezoneContext } from "src/contexts"; | ||
|
||
import { TableMetadataJobControl } from "./tableMetadataJobControl"; | ||
|
||
jest.mock("src/api/databases/tableMetaUpdateJobApi"); | ||
|
||
describe("TableMetadataJobControl", () => { | ||
const mockOnDataUpdated = jest.fn(); | ||
const mockRefreshJobStatus = jest.fn(); | ||
const mockLastCompletedTime = moment("2024-01-01T12:00:00Z"); | ||
const mockLastUpdatedTime = moment("2024-01-01T12:05:00Z"); | ||
const mockLastStartTime = moment("2024-01-01T11:59:00Z"); | ||
|
||
beforeEach(() => { | ||
jest.useFakeTimers(); | ||
jest.spyOn(api, "useTableMetaUpdateJob").mockReturnValue({ | ||
jobStatus: { | ||
dataValidDuration: moment.duration(1, "hour"), | ||
currentStatus: api.TableMetadataJobStatus.NOT_RUNNING, | ||
progress: 0, | ||
lastCompletedTime: mockLastCompletedTime, | ||
lastStartTime: mockLastStartTime, | ||
lastUpdatedTime: mockLastUpdatedTime, | ||
automaticUpdatesEnabled: false, | ||
}, | ||
refreshJobStatus: mockRefreshJobStatus, | ||
isLoading: false, | ||
}); | ||
jest.spyOn(api, "triggerUpdateTableMetaJobApi").mockResolvedValue({ | ||
message: "Job triggered", | ||
job_triggered: true, | ||
}); | ||
}); | ||
|
||
afterEach(() => { | ||
jest.useRealTimers(); | ||
jest.clearAllMocks(); | ||
}); | ||
|
||
it("renders the last refreshed time", () => { | ||
render( | ||
<TimezoneContext.Provider value="UTC"> | ||
<TableMetadataJobControl onDataUpdated={mockOnDataUpdated} /> | ||
</TimezoneContext.Provider>, | ||
); | ||
|
||
expect(screen.getByText(/Last refreshed:/)).toBeInTheDocument(); | ||
expect( | ||
screen.getByText(/Jan 01, 2024 at 12:00:00 UTC/), | ||
).toBeInTheDocument(); | ||
}); | ||
|
||
it('renders "Never" when lastCompletedTime is null', () => { | ||
jest.spyOn(api, "useTableMetaUpdateJob").mockReturnValue({ | ||
jobStatus: { | ||
lastCompletedTime: null, | ||
dataValidDuration: moment.duration(1, "hour"), | ||
currentStatus: api.TableMetadataJobStatus.NOT_RUNNING, | ||
progress: 0, | ||
lastStartTime: mockLastUpdatedTime, | ||
lastUpdatedTime: mockLastUpdatedTime, | ||
automaticUpdatesEnabled: false, | ||
}, | ||
refreshJobStatus: mockRefreshJobStatus, | ||
isLoading: false, | ||
}); | ||
|
||
render( | ||
<TimezoneContext.Provider value="UTC"> | ||
<TableMetadataJobControl onDataUpdated={mockOnDataUpdated} /> | ||
</TimezoneContext.Provider>, | ||
); | ||
|
||
expect(screen.getByText(/Last refreshed: Never/)).toBeInTheDocument(); | ||
}); | ||
|
||
it("triggers update when refresh button is clicked", async () => { | ||
render( | ||
<TimezoneContext.Provider value="UTC"> | ||
<TableMetadataJobControl onDataUpdated={mockOnDataUpdated} /> | ||
</TimezoneContext.Provider>, | ||
); | ||
|
||
const refreshButton = screen.getByRole("button"); | ||
await act(async () => { | ||
fireEvent.click(refreshButton); | ||
}); | ||
|
||
expect(api.triggerUpdateTableMetaJobApi).toHaveBeenCalledWith({ | ||
onlyIfStale: false, | ||
}); | ||
expect(mockRefreshJobStatus).toHaveBeenCalled(); | ||
}); | ||
|
||
it("schedules next update after dataValidDuration", async () => { | ||
render( | ||
<TimezoneContext.Provider value="UTC"> | ||
<TableMetadataJobControl onDataUpdated={mockOnDataUpdated} /> | ||
</TimezoneContext.Provider>, | ||
); | ||
|
||
await act(async () => { | ||
// Advance timer 1 hour and 30s. | ||
jest.advanceTimersByTime(3600000 + 30000); | ||
}); | ||
|
||
expect(api.triggerUpdateTableMetaJobApi).toHaveBeenCalledWith({ | ||
onlyIfStale: true, | ||
}); | ||
}); | ||
|
||
it("calls onDataUpdated when lastCompletedTime changes", () => { | ||
const { rerender } = render( | ||
<TimezoneContext.Provider value="UTC"> | ||
<TableMetadataJobControl onDataUpdated={mockOnDataUpdated} /> | ||
</TimezoneContext.Provider>, | ||
); | ||
|
||
// Update the mock to return a new lastCompletedTime | ||
jest.spyOn(api, "useTableMetaUpdateJob").mockReturnValue({ | ||
jobStatus: { | ||
lastCompletedTime: moment("2024-01-01T13:00:00Z"), | ||
lastStartTime: moment("2024-01-01T13:00:00Z"), | ||
lastUpdatedTime: moment.utc(), | ||
dataValidDuration: moment.duration(1, "hour"), | ||
currentStatus: api.TableMetadataJobStatus.NOT_RUNNING, | ||
progress: 0, | ||
automaticUpdatesEnabled: false, | ||
}, | ||
refreshJobStatus: mockRefreshJobStatus, | ||
isLoading: false, | ||
}); | ||
|
||
// Rerender the component with the updated mock | ||
rerender( | ||
<TimezoneContext.Provider value="UTC"> | ||
<TableMetadataJobControl onDataUpdated={mockOnDataUpdated} /> | ||
</TimezoneContext.Provider>, | ||
); | ||
|
||
expect(mockOnDataUpdated).toHaveBeenCalled(); | ||
}); | ||
|
||
it("disables refresh button when job is running", () => { | ||
jest.spyOn(api, "useTableMetaUpdateJob").mockReturnValue({ | ||
jobStatus: { | ||
lastCompletedTime: moment("2024-01-01T12:00:00Z"), | ||
dataValidDuration: moment.duration(1, "hour"), | ||
currentStatus: api.TableMetadataJobStatus.RUNNING, | ||
progress: 0, | ||
lastStartTime: moment.utc(), | ||
lastUpdatedTime: moment.utc(), | ||
automaticUpdatesEnabled: false, | ||
}, | ||
refreshJobStatus: mockRefreshJobStatus, | ||
isLoading: false, | ||
}); | ||
|
||
render( | ||
<TimezoneContext.Provider value="UTC"> | ||
<TableMetadataJobControl onDataUpdated={mockOnDataUpdated} /> | ||
</TimezoneContext.Provider>, | ||
); | ||
|
||
expect(screen.getByRole("button")).toBeDisabled(); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters