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.

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

server, ui: remove interpreted jobs retrying status #97505

Merged
merged 2 commits into from
Feb 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 30 additions & 21 deletions pkg/server/admin.go
Original file line number Diff line number Diff line change
Expand Up @@ -2245,40 +2245,49 @@ func jobsHelper(
cfg *BaseConfig,
sv *settings.Values,
) (_ *serverpb.JobsResponse, retErr error) {
retryRunningCondition := "status='running' AND next_run > now() AND num_runs > 1"
retryRevertingCondition := "status='reverting' AND next_run > now() AND num_runs > 1"

q := makeSQLQuery()
q.Append(`
SELECT job_id, job_type, description, statement, user_name, descriptor_ids,
case
when ` + retryRunningCondition + ` then 'retry-running'
when ` + retryRevertingCondition + ` then 'retry-reverting'
else status
end as status, running_status, created, started, finished, modified, fraction_completed,
high_water_timestamp, error, last_run, next_run, num_runs, execution_events::string, coordinator_id
FROM crdb_internal.jobs
WHERE true
`)
if req.Status == "retrying" {
q.Append(" AND ( ( " + retryRunningCondition + " ) OR ( " + retryRevertingCondition + " ) )")
} else if req.Status != "" {
SELECT
job_id,
job_type,
description,
statement,
user_name,
descriptor_ids,
status,
running_status,
created,
started,
finished,
modified,
fraction_completed,
high_water_timestamp,
error,
last_run,
next_run,
num_runs,
execution_events::string,
coordinator_id
FROM crdb_internal.jobs
WHERE true`) // Simplifies filter construction below.
if req.Status != "" {
q.Append(" AND status = $", req.Status)
}
if req.Type != jobspb.TypeUnspecified {
q.Append(" AND job_type = $", req.Type.String())
} else {
// Don't show automatic jobs in the overview page.
q.Append(" AND (")
q.Append(" AND ( job_type NOT IN (")
for idx, jobType := range jobspb.AutomaticJobTypes {
q.Append("job_type != $", jobType.String())
if idx < len(jobspb.AutomaticJobTypes)-1 {
q.Append(" AND ")
if idx != 0 {
q.Append(", ")
}
q.Append("$", jobType.String())
}
q.Append(" OR job_type IS NULL)")
q.Append(" ) OR job_type IS NULL)")
}
q.Append("ORDER BY created DESC")
q.Append(" ORDER BY created DESC")
if req.Limit > 0 {
q.Append(" LIMIT $", tree.DInt(req.Limit))
}
Expand Down
36 changes: 0 additions & 36 deletions pkg/server/admin_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1725,11 +1725,6 @@ func TestAdminAPIJobs(t *testing.T) {
append(append([]int64{}, revertingOnlyIds...), retryRevertingIds...),
[]int64{},
},
{
"jobs?status=retrying",
append(append([]int64{}, retryRunningIds...), retryRevertingIds...),
[]int64{},
},
{
"jobs?status=pending",
[]int64{},
Expand Down Expand Up @@ -1807,11 +1802,6 @@ func TestAdminAPIJobsDetails(t *testing.T) {
defer s.Stopper().Stop(context.Background())
sqlDB := sqlutils.MakeSQLRunner(conn)

runningOnlyIds := []int64{1, 3, 5}
revertingOnlyIds := []int64{2, 4, 6}
retryRunningIds := []int64{7}
retryRevertingIds := []int64{8}

now := timeutil.Now()

encodedError := func(err error) *errors.EncodedError {
Expand Down Expand Up @@ -1891,32 +1881,6 @@ func TestAdminAPIJobsDetails(t *testing.T) {
t.Fatal(err)
}

// test that the select statement correctly converts expected jobs to retry-____ statuses
expectedStatuses := []struct {
status string
ids []int64
}{
{"running", runningOnlyIds},
{"reverting", revertingOnlyIds},
{"retry-running", retryRunningIds},
{"retry-reverting", retryRevertingIds},
}
for _, expected := range expectedStatuses {
var jobsWithStatus []serverpb.JobResponse
for _, job := range res.Jobs {
for _, expectedID := range expected.ids {
if job.ID == expectedID {
jobsWithStatus = append(jobsWithStatus, job)
}
}
}

require.Len(t, jobsWithStatus, len(expected.ids))
for _, job := range jobsWithStatus {
assert.Equal(t, expected.status, job.Status)
}
}

// Trim down our result set to the jobs we injected.
resJobs := append([]serverpb.JobResponse(nil), res.Jobs...)
sort.Slice(resJobs, func(i, j int) bool {
Expand Down
38 changes: 25 additions & 13 deletions pkg/ui/workspaces/cluster-ui/src/jobs/jobsPage/jobsPage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,14 @@ import { Pagination, ResultsPerPageLabel } from "src/pagination";
import { isSelectedColumn } from "src/columnsSelector/utils";
import { DATE_FORMAT_24_UTC, syncHistory, TimestampToMoment } from "src/util";
import { jobsColumnLabels, JobsTable, makeJobsColumns } from "./jobsTable";
import { showOptions, statusOptions, typeOptions } from "../util";
import {
showOptions,
statusOptions,
typeOptions,
isValidJobStatus,
defaultRequestOptions,
isValidJobType,
} from "../util";

import { commonStyles } from "src/common";
import sortableTableStyles from "src/sortedtable/sortedtable.module.scss";
Expand Down Expand Up @@ -108,8 +115,8 @@ export class JobsPage extends React.Component<JobsPageProps, PageState> {
}

// Filter Status.
const status = searchParams.get("status") || undefined;
if (this.props.setStatus && status && status != this.props.status) {
const status = searchParams.get("status");
if (this.props.setStatus && status && status !== this.props.status) {
this.props.setStatus(status);
}

Expand Down Expand Up @@ -145,6 +152,17 @@ export class JobsPage extends React.Component<JobsPageProps, PageState> {
}

componentDidUpdate(prevProps: JobsPageProps): void {
// Because we removed the retrying status, we add this check
// just in case there exists an app that attempts to load a non-existent
// status.
if (!isValidJobStatus(this.props.status)) {
this.onStatusSelected(defaultRequestOptions.status);
}

if (!isValidJobType(this.props.type)) {
this.onTypeSelected(defaultRequestOptions.type.toString());
}

if (
prevProps.lastUpdated !== this.props.lastUpdated ||
prevProps.show !== this.props.show ||
Expand Down Expand Up @@ -274,27 +292,21 @@ export class JobsPage extends React.Component<JobsPageProps, PageState> {
<PageConfigItem>
<Dropdown items={statusOptions} onChange={this.onStatusSelected}>
Status:{" "}
{
statusOptions.find(option => option["value"] === status)[
"name"
]
}
{statusOptions.find(option => option.value === status)?.name}
</Dropdown>
</PageConfigItem>
<PageConfigItem>
<Dropdown items={typeOptions} onChange={this.onTypeSelected}>
Type:{" "}
{
typeOptions.find(
option => option["value"] === type.toString(),
)["name"]
typeOptions.find(option => option.value === type.toString())
?.name
}
</Dropdown>
</PageConfigItem>
<PageConfigItem>
<Dropdown items={showOptions} onChange={this.onShowSelected}>
Show:{" "}
{showOptions.find(option => option["value"] === show)["name"]}
Show: {showOptions.find(option => option.value === show)?.name}
</Dropdown>
</PageConfigItem>
</PageConfig>
Expand Down
58 changes: 27 additions & 31 deletions pkg/ui/workspaces/cluster-ui/src/jobs/util/jobOptions.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,8 @@ export function jobToVisual(job: Job): JobStatusVisual {
return JobStatusVisual.BadgeWithErrorMessage;
case JOB_STATUS_RUNNING:
return JobStatusVisual.ProgressBarWithDuration;
case JOB_STATUS_RETRY_RUNNING:
return JobStatusVisual.ProgressBarWithDuration;
case JOB_STATUS_PENDING:
return JobStatusVisual.BadgeWithMessage;
case JOB_STATUS_RETRY_REVERTING:
return JobStatusVisual.BadgeWithRetrying;
case JOB_STATUS_CANCELED:
case JOB_STATUS_CANCEL_REQUESTED:
case JOB_STATUS_PAUSED:
Expand All @@ -59,36 +55,43 @@ export const JOB_STATUS_CANCEL_REQUESTED = "cancel-requested";
export const JOB_STATUS_PAUSED = "paused";
export const JOB_STATUS_PAUSE_REQUESTED = "paused-requested";
export const JOB_STATUS_RUNNING = "running";
export const JOB_STATUS_RETRY_RUNNING = "retry-running";
export const JOB_STATUS_PENDING = "pending";
export const JOB_STATUS_REVERTING = "reverting";
export const JOB_STATUS_REVERT_FAILED = "revert-failed";
export const JOB_STATUS_RETRY_REVERTING = "retry-reverting";

export function isRetrying(status: string): boolean {
return [JOB_STATUS_RETRY_RUNNING, JOB_STATUS_RETRY_REVERTING].includes(
status,
);
}
export function isRunning(status: string): boolean {
return [JOB_STATUS_RUNNING, JOB_STATUS_RETRY_RUNNING].includes(status);
return [JOB_STATUS_RUNNING, JOB_STATUS_REVERTING].some(s =>
status.includes(s),
);
}
export function isTerminalState(status: string): boolean {
return [JOB_STATUS_SUCCEEDED, JOB_STATUS_FAILED].includes(status);
}

export const statusOptions = [
{ value: "", name: "All" },
{ value: "succeeded", name: "Succeeded" },
{ value: "failed", name: "Failed" },
{ value: "paused", name: "Paused" },
{ value: "canceled", name: "Canceled" },
{ value: "running", name: "Running" },
{ value: "pending", name: "Pending" },
{ value: "reverting", name: "Reverting" },
{ value: "retrying", name: "Retrying" },
{ value: JOB_STATUS_SUCCEEDED, name: "Succeeded" },
{ value: JOB_STATUS_FAILED, name: "Failed" },
{ value: JOB_STATUS_PAUSED, name: "Paused" },
{ value: JOB_STATUS_PAUSE_REQUESTED, name: "Pause Requested" },
{ value: JOB_STATUS_CANCELED, name: "Canceled" },
{ value: JOB_STATUS_CANCEL_REQUESTED, name: "Cancel Requested" },
{ value: JOB_STATUS_RUNNING, name: "Running" },
{ value: JOB_STATUS_PENDING, name: "Pending" },
{ value: JOB_STATUS_REVERTING, name: "Reverting" },
{ value: JOB_STATUS_REVERT_FAILED, name: "Revert Failed" },
];

const ALL_JOB_STATUSES = new Set(statusOptions.map(option => option.value));

/**
* @param jobStatus job status - any string
* @returns Returns true if the job status string is a valid status.
*/
export function isValidJobStatus(jobStatus: string): boolean {
return ALL_JOB_STATUSES.has(jobStatus);
}

export function jobHasOneOfStatuses(job: Job, ...statuses: string[]): boolean {
return statuses.indexOf(job.status) !== -1;
}
Expand All @@ -110,21 +113,10 @@ export const jobStatusToBadgeStatus = (status: string): BadgeStatus => {
case JOB_STATUS_PAUSED:
case JOB_STATUS_PAUSE_REQUESTED:
case JOB_STATUS_REVERTING:
case JOB_STATUS_RETRY_REVERTING:
default:
return "default";
}
};
export const jobStatusToBadgeText = (status: string): string => {
switch (status) {
case JOB_STATUS_RETRY_REVERTING:
return JOB_STATUS_REVERTING;
case JOB_STATUS_RETRY_RUNNING:
return JOB_STATUS_RUNNING;
default:
return status;
}
};

const jobTypeKeys = Object.keys(JobType);

Expand Down Expand Up @@ -216,6 +208,10 @@ export const typeOptions = [
},
];

export function isValidJobType(jobType: number): boolean {
return jobType >= 0 && jobType < jobTypeKeys.length;
}

export const showOptions = [
{ value: "50", name: "Latest 50" },
{ value: "0", name: "All" },
Expand Down
4 changes: 1 addition & 3 deletions pkg/ui/workspaces/cluster-ui/src/jobs/util/jobStatus.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import classNames from "classnames/bind";
import React from "react";

import { Duration } from "./duration";
import { JobStatusVisual, isRetrying, jobToVisual } from "./jobOptions";
import { JobStatusVisual, jobToVisual } from "./jobOptions";
import {
JobStatusBadge,
ProgressBar,
Expand Down Expand Up @@ -54,7 +54,6 @@ export const JobStatus: React.FC<JobStatusProps> = ({
</div>
);
case JobStatusVisual.ProgressBarWithDuration: {
const jobIsRetrying = isRetrying(job.status);
return (
<div>
<ProgressBar
Expand All @@ -63,7 +62,6 @@ export const JobStatus: React.FC<JobStatusProps> = ({
showPercentage={true}
/>
<Duration job={job} className={cx("jobs-table__duration")} />
{jobIsRetrying && <RetryingStatusBadge />}
{job.running_status && (
<div className={cx("jobs-table__running-status")}>
{job.running_status}
Expand Down
40 changes: 8 additions & 32 deletions pkg/ui/workspaces/cluster-ui/src/jobs/util/jobStatusCell.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,9 @@
// by the Apache License, Version 2.0, included in the file
// licenses/APL.txt.
import { cockroach } from "@cockroachlabs/crdb-protobuf-client";
import { Tooltip } from "@cockroachlabs/ui-components";
import React from "react";
import { TimestampToMoment } from "src/util";
import { DATE_FORMAT_24_UTC } from "src/util/format";

import { JobStatus } from "./jobStatus";
import { isRetrying } from "./jobOptions";

type Job = cockroach.server.serverpb.IJobResponse;

Expand All @@ -30,31 +26,11 @@ export const JobStatusCell: React.FC<JobStatusCellProps> = ({
lineWidth,
compact = false,
hideDuration = false,
}) => {
const jobStatus = (
<JobStatus
job={job}
lineWidth={lineWidth}
compact={compact}
hideDuration={hideDuration}
/>
);
if (isRetrying(job.status)) {
return (
<Tooltip
placement="bottom"
style="tableTitle"
content={
<>
Next Planned Execution Time:
<br />
{TimestampToMoment(job.next_run).format(DATE_FORMAT_24_UTC)}
</>
}
>
{jobStatus}
</Tooltip>
);
}
return jobStatus;
};
}) => (
<JobStatus
job={job}
lineWidth={lineWidth}
compact={compact}
hideDuration={hideDuration}
/>
);
Loading