amoghrajesh commented on code in PR #73030: URL: https://github.com/apache/airflow/pull/73030#discussion_r4093309177
########## airflow-core/src/airflow/ui/src/pages/TaskInstance/Details.test.tsx: ########## @@ -0,0 +1,170 @@ +/*! + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import "@testing-library/jest-dom"; +import { render, screen } from "@testing-library/react"; +import { describe, expect, it, vi } from "vitest"; + +import type { TaskInstanceHistoryResponse, TaskInstanceResponse } from "openapi/requests/types.gen"; + +import i18n from "src/i18n/config"; +import { Wrapper } from "src/utils/Wrapper"; + +import { Details } from "./Details"; + +// Sibling panels each fetch their own data and are unrelated to the state-reason +// banner and row under test. +vi.mock("./BlockingDeps", () => ({ BlockingDeps: () => undefined })); +vi.mock("./ExtraLinks", () => ({ ExtraLinks: () => undefined })); +vi.mock("./TriggererInfo", () => ({ TriggererInfo: () => undefined })); +vi.mock("src/components/DagVersionDetails", () => ({ DagVersionDetails: () => undefined })); +vi.mock("src/components/TaskTrySelect", () => ({ TaskTrySelect: () => undefined })); +vi.mock("src/components/TeamName", () => ({ TeamName: () => undefined })); +vi.mock("src/hooks/useShowTeam", () => ({ useShowTeam: () => false })); + +const mockTaskInstance = vi.fn<() => TaskInstanceResponse | undefined>(); +const mockTryInstance = vi.fn<() => TaskInstanceHistoryResponse | undefined>(); + +vi.mock("openapi/queries", async () => { + const actual = await vi.importActual("openapi/queries"); + + return { + ...actual, + useTaskInstanceServiceGetMappedTaskInstance: () => ({ data: mockTaskInstance() }), + useTaskInstanceServiceGetTaskInstanceTryDetails: () => ({ data: mockTryInstance() }), + }; +}); + +vi.mock("src/utils", async () => { + const actual = await vi.importActual("src/utils"); + + return { ...actual, useAutoRefresh: () => false }; +}); + +const buildTaskInstance = (overrides: Partial<TaskInstanceResponse>): TaskInstanceResponse => + ({ + dag_id: "test_dag", + dag_run_id: "run_1", + dag_version: null, + duration: null, + end_date: null, + id: "ti-id", + map_index: -1, + max_tries: 2, + note: null, + operator_name: "PythonOperator", + rendered_map_index: null, + start_date: null, + state: "failed", + state_reason: null, + task_display_name: "test_task", + task_id: "test_task", + trigger: null, + triggerer_job: null, + try_number: 3, + ...overrides, + }) as unknown as TaskInstanceResponse; + +const renderDetails = ( + taskInstance: TaskInstanceResponse, + tryInstance: Partial<TaskInstanceHistoryResponse> = {}, +) => { + mockTaskInstance.mockReturnValue(taskInstance); + mockTryInstance.mockReturnValue({ + ...taskInstance, + ...tryInstance, + }); + + return render(<Details />, { wrapper: Wrapper }); +}; + +describe("Details state reason", () => { + it("does not render the banner when there is no reason", () => { + renderDetails(buildTaskInstance({ state_reason: null })); + + expect(screen.queryByTestId("state-reason-alert")).not.toBeInTheDocument(); + expect(screen.queryByText(i18n.t("common:taskInstance.stateReason"))).not.toBeInTheDocument(); + }); + + it.each([ + { state: "failed", titleKey: "failed" }, + { state: "up_for_retry", titleKey: "upForRetry" }, + ] as const)("titles the banner for a $state task", ({ state, titleKey }) => { + renderDetails(buildTaskInstance({ max_tries: 2, state, state_reason: "auth error", try_number: 3 })); + + expect(screen.getByTestId("state-reason-alert")).toHaveTextContent( + i18n.t(`common:taskInstance.stateReasonSummary.${titleKey}`, { totalTries: 3, tryNumber: 3 }), Review Comment: Registered the common bundle in a `beforeEach`, following `DagDeactivatedBanner.test.tsx`, and added an `up_for_retry` case with `max_tries: 3`, `try_number: 2` so the two numbers differ. The off by one now fails 3 tests and swapping the arguments fails 1, where both were silent before. ########## airflow-core/src/airflow/ui/src/pages/TaskInstance/Details.test.tsx: ########## @@ -0,0 +1,170 @@ +/*! + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import "@testing-library/jest-dom"; +import { render, screen } from "@testing-library/react"; +import { describe, expect, it, vi } from "vitest"; + +import type { TaskInstanceHistoryResponse, TaskInstanceResponse } from "openapi/requests/types.gen"; + +import i18n from "src/i18n/config"; +import { Wrapper } from "src/utils/Wrapper"; + +import { Details } from "./Details"; + +// Sibling panels each fetch their own data and are unrelated to the state-reason +// banner and row under test. +vi.mock("./BlockingDeps", () => ({ BlockingDeps: () => undefined })); +vi.mock("./ExtraLinks", () => ({ ExtraLinks: () => undefined })); +vi.mock("./TriggererInfo", () => ({ TriggererInfo: () => undefined })); +vi.mock("src/components/DagVersionDetails", () => ({ DagVersionDetails: () => undefined })); +vi.mock("src/components/TaskTrySelect", () => ({ TaskTrySelect: () => undefined })); +vi.mock("src/components/TeamName", () => ({ TeamName: () => undefined })); +vi.mock("src/hooks/useShowTeam", () => ({ useShowTeam: () => false })); + +const mockTaskInstance = vi.fn<() => TaskInstanceResponse | undefined>(); +const mockTryInstance = vi.fn<() => TaskInstanceHistoryResponse | undefined>(); + +vi.mock("openapi/queries", async () => { + const actual = await vi.importActual("openapi/queries"); + + return { + ...actual, + useTaskInstanceServiceGetMappedTaskInstance: () => ({ data: mockTaskInstance() }), + useTaskInstanceServiceGetTaskInstanceTryDetails: () => ({ data: mockTryInstance() }), + }; +}); + +vi.mock("src/utils", async () => { + const actual = await vi.importActual("src/utils"); + + return { ...actual, useAutoRefresh: () => false }; +}); + +const buildTaskInstance = (overrides: Partial<TaskInstanceResponse>): TaskInstanceResponse => + ({ + dag_id: "test_dag", + dag_run_id: "run_1", + dag_version: null, + duration: null, + end_date: null, + id: "ti-id", + map_index: -1, + max_tries: 2, + note: null, + operator_name: "PythonOperator", + rendered_map_index: null, + start_date: null, + state: "failed", + state_reason: null, + task_display_name: "test_task", + task_id: "test_task", + trigger: null, + triggerer_job: null, + try_number: 3, + ...overrides, + }) as unknown as TaskInstanceResponse; + +const renderDetails = ( + taskInstance: TaskInstanceResponse, + tryInstance: Partial<TaskInstanceHistoryResponse> = {}, +) => { + mockTaskInstance.mockReturnValue(taskInstance); + mockTryInstance.mockReturnValue({ + ...taskInstance, + ...tryInstance, + }); + + return render(<Details />, { wrapper: Wrapper }); +}; + +describe("Details state reason", () => { + it("does not render the banner when there is no reason", () => { + renderDetails(buildTaskInstance({ state_reason: null })); + + expect(screen.queryByTestId("state-reason-alert")).not.toBeInTheDocument(); + expect(screen.queryByText(i18n.t("common:taskInstance.stateReason"))).not.toBeInTheDocument(); + }); + + it.each([ + { state: "failed", titleKey: "failed" }, + { state: "up_for_retry", titleKey: "upForRetry" }, + ] as const)("titles the banner for a $state task", ({ state, titleKey }) => { + renderDetails(buildTaskInstance({ max_tries: 2, state, state_reason: "auth error", try_number: 3 })); + + expect(screen.getByTestId("state-reason-alert")).toHaveTextContent( + i18n.t(`common:taskInstance.stateReasonSummary.${titleKey}`, { totalTries: 3, tryNumber: 3 }), Review Comment: [after rebase comments on PR 2](https://github.com/apache/airflow/pull/73030/commits/74e7573a5606e4fa7bf83616ab1aef5106a1bb62) ########## airflow-core/src/airflow/ui/src/pages/TaskInstance/Details.tsx: ########## @@ -115,6 +122,48 @@ export const Details = () => { return translate("common:none", { defaultValue: "None" }); }; + const stateReasonSummary = ((): StateReasonSummary | undefined => { + const reason = taskInstance?.state_reason; + + if ( + reason === null || + reason === undefined || + taskInstance === undefined || + !STATES_WITH_REASON.includes(taskInstance.state ?? "") Review Comment: [after rebase comments on PR 2](https://github.com/apache/airflow/pull/73030/commits/74e7573a5606e4fa7bf83616ab1aef5106a1bb62) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
