This is an automated email from the ASF dual-hosted git repository.
bbovenzi pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new bb560528035 Implement dag version selector for source code. (#46885)
bb560528035 is described below
commit bb5605280352a83d33b50a73cba68c7123fee5aa
Author: Karthikeyan Singaravelan <[email protected]>
AuthorDate: Wed Feb 19 21:00:54 2025 +0530
Implement dag version selector for source code. (#46885)
---
airflow/ui/src/pages/Dag/Code/Code.tsx | 84 +++++++++++++++++++++++++++++++---
1 file changed, 77 insertions(+), 7 deletions(-)
diff --git a/airflow/ui/src/pages/Dag/Code/Code.tsx
b/airflow/ui/src/pages/Dag/Code/Code.tsx
index f52215f6c61..2efd4e569ea 100644
--- a/airflow/ui/src/pages/Dag/Code/Code.tsx
+++ b/airflow/ui/src/pages/Dag/Code/Code.tsx
@@ -16,14 +16,23 @@
* specific language governing permissions and limitations
* under the License.
*/
-import { Box, Button, Heading, HStack } from "@chakra-ui/react";
-import { useState } from "react";
-import { useParams } from "react-router-dom";
+import { Box, Button, Heading, HStack, Field } from "@chakra-ui/react";
+import { useQueryClient } from "@tanstack/react-query";
+import type { OptionsOrGroups, GroupBase, SingleValue } from
"chakra-react-select";
+import { AsyncSelect } from "chakra-react-select";
+import { useState, useCallback } from "react";
+import { useParams, useSearchParams } from "react-router-dom";
import { createElement, PrismLight as SyntaxHighlighter } from
"react-syntax-highlighter";
import python from "react-syntax-highlighter/dist/esm/languages/prism/python";
import { oneLight, oneDark } from
"react-syntax-highlighter/dist/esm/styles/prism";
-import { useDagServiceGetDagDetails, useDagSourceServiceGetDagSource } from
"openapi/queries";
+import {
+ useDagServiceGetDagDetails,
+ useDagSourceServiceGetDagSource,
+ UseDagVersionServiceGetDagVersionsKeyFn,
+} from "openapi/queries";
+import { DagVersionService } from "openapi/requests/services.gen";
+import type { DAGVersionCollectionResponse, DagVersionResponse } from
"openapi/requests/types.gen";
import { ErrorAlert } from "src/components/ErrorAlert";
import Time from "src/components/Time";
import { ProgressBar } from "src/components/ui";
@@ -32,8 +41,18 @@ import { useConfig } from "src/queries/useConfig";
SyntaxHighlighter.registerLanguage("python", python);
+const VERSION_PARAM = "version";
+
+type Option = {
+ label: string;
+ value: string;
+};
+
export const Code = () => {
const { dagId } = useParams();
+ const [searchParams, setSearchParams] = useSearchParams();
+ const selectedVersion = searchParams.get(VERSION_PARAM);
+ const queryClient = useQueryClient();
const {
data: dag,
@@ -49,6 +68,7 @@ export const Code = () => {
isLoading: isCodeLoading,
} = useDagSourceServiceGetDagSource({
dagId: dagId ?? "",
+ versionNumber: selectedVersion === null ? undefined :
parseInt(selectedVersion, 10),
});
const defaultWrap = Boolean(useConfig("default_wrap"));
@@ -65,6 +85,42 @@ export const Code = () => {
style['code[class*="language-"]'].whiteSpace = wrap ? "pre-wrap" : "pre";
}
+ const loadVersions = (
+ _: string,
+ callback: (options: OptionsOrGroups<Option, GroupBase<Option>>) => void,
+ ): Promise<OptionsOrGroups<Option, GroupBase<Option>>> =>
+ queryClient.fetchQuery({
+ queryFn: () =>
+ DagVersionService.getDagVersions({
+ dagId: dagId ?? "",
+ }).then((data: DAGVersionCollectionResponse) => {
+ const options = data.dag_versions.map((version: DagVersionResponse)
=> {
+ const versionNumber = version.version_number.toString();
+
+ return {
+ label: versionNumber,
+ value: versionNumber,
+ };
+ });
+
+ callback(options);
+
+ return options;
+ }),
+ queryKey: UseDagVersionServiceGetDagVersionsKeyFn({ dagId: dagId ?? ""
}),
+ staleTime: 0,
+ });
+
+ const handleStateChange = useCallback(
+ (version: SingleValue<Option>) => {
+ if (version) {
+ searchParams.set(VERSION_PARAM, version.value);
+ setSearchParams(searchParams);
+ }
+ },
+ [searchParams, setSearchParams],
+ );
+
return (
<Box>
<HStack justifyContent="space-between" mt={2}>
@@ -73,9 +129,23 @@ export const Code = () => {
Parsed at: <Time datetime={dag.last_parsed_time} />
</Heading>
)}
- <Button aria-label={wrap ? "Unwrap" : "Wrap"} bg="bg.panel"
onClick={toggleWrap} variant="outline">
- {wrap ? "Unwrap" : "Wrap"}
- </Button>
+ <HStack>
+ <Field.Root>
+ <AsyncSelect
+ defaultOptions
+ filterOption={undefined}
+ isSearchable={false}
+ loadOptions={loadVersions}
+ onChange={handleStateChange}
+ placeholder="Dag Version"
+ value={selectedVersion === null ? null : { label:
selectedVersion, value: selectedVersion }} // null is required
https://github.com/JedWatson/react-select/issues/3066
+ />
+ </Field.Root>
+
+ <Button aria-label={wrap ? "Unwrap" : "Wrap"} bg="bg.panel"
onClick={toggleWrap} variant="outline">
+ {wrap ? "Unwrap" : "Wrap"}
+ </Button>
+ </HStack>
</HStack>
<ErrorAlert error={error ?? codeError} />
<ProgressBar size="xs" visibility={isLoading || isCodeLoading ?
"visible" : "hidden"} />