-
Notifications
You must be signed in to change notification settings - Fork 15.5k
#55020 gantt view is not getting updatedin realtime #55130
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
base: main
Are you sure you want to change the base?
#55020 gantt view is not getting updatedin realtime #55130
Conversation
Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for fix, left some comments~
@@ -123,6 +124,20 @@ export const Gantt = ({ limit }: Props) => { | |||
|
|||
const isLoading = runsLoading || structureLoading || summariesLoading || tiLoading; | |||
|
|||
useEffect(() => { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
taskInstancesData
would auto-refresh here so I think it could work without this useEffect
.
airflow/airflow-core/src/airflow/ui/src/layouts/Details/Gantt/Gantt.tsx
Lines 109 to 120 in 2b91be8
const { data: taskInstancesData, isLoading: tiLoading } = useTaskInstanceServiceGetTaskInstances( | |
{ | |
dagId, | |
dagRunId: runId ?? "~", | |
}, | |
undefined, | |
{ | |
enabled: Boolean(dagId), | |
refetchInterval: (query) => | |
query.state.data?.task_instances.some((ti) => isStatePending(ti.state)) ? refetchInterval : false, | |
}, | |
); |
|
||
if (hasRunningTasks) { | ||
const interval = setInterval(() => { | ||
setCurrentTime(new Date().toISOString()); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could get current time with selectedTimezone
easily with dayjs
const { selectedTimezone } = useTimezone();
// Make the value timezone-aware
setCurrentTime(dayjs().tz(selectedTimezone).format("YYYY-MM-DD HH:mm:ss"))
const target = event.native?.target as HTMLElement | undefined; | ||
}: ChartOptionsParams) => { | ||
const isRunning = selectedRun?.state === "running"; | ||
const effectiveEndDate = isRunning ? new Date().toISOString() : selectedRun?.end_date; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also here
…g-updatedin-realtime
…essed review comments
Hello @guan404ming, Thanks for all the great suggestions, I believe I have addressed them, also made a few more changes, e..g, expanding to other pending tasks ( Here is the expanded test dag from the original issue post: from datetime import datetime, timedelta
from airflow import DAG
from airflow.providers.standard.operators.bash import BashOperator
from airflow.providers.standard.operators.python import PythonOperator
from airflow.providers.standard.sensors.filesystem import FileSensor
from airflow.utils.task_group import TaskGroup
def task_that_fails():
raise Exception("This task always fails for testing")
def task_that_succeeds():
print("This task succeeds")
return "success"
dag = DAG(
'test_gantt_chart_dag',
start_date=datetime(2025, 7, 1),
schedule=None,
is_paused_upon_creation=False,
catchup=False,
max_active_runs=1,
default_args={
'retries': 2,
'retry_delay': timedelta(seconds=10),
}
)
long_running_task = BashOperator(
task_id="long_running_task",
bash_command="echo 'Starting long task'; sleep 180; echo 'Long task completed'",
dag=dag
)
queued_task = BashOperator(
task_id="queued_task",
bash_command="echo 'Queued task executed'; sleep 30",
dag=dag,
pool='default_pool',
pool_slots=10
)
failing_task = PythonOperator(
task_id="failing_task",
python_callable=task_that_fails,
dag=dag
)
waiting_sensor = FileSensor(
task_id="waiting_sensor",
filepath="/tmp/nonexistent_file_for_testing.txt",
timeout=300,
poke_interval=30,
dag=dag
)
scheduled_task = BashOperator(
task_id="scheduled_task",
bash_command="echo 'Scheduled task executed'; sleep 15",
dag=dag
)
quick_success_task = PythonOperator(
task_id="quick_success_task",
python_callable=task_that_succeeds,
dag=dag
)
upstream_failed_task = BashOperator(
task_id="upstream_failed_task",
bash_command="echo 'This should not run due to upstream failure'",
dag=dag
)
with TaskGroup("processing_group", dag=dag) as processing_group:
group_start = BashOperator(
task_id="group_start",
bash_command="echo 'Group starting'; sleep 5",
dag=dag,
)
parallel_task_1 = BashOperator(
task_id="parallel_task_1",
bash_command="echo 'Parallel task 1 running'; sleep 60",
dag=dag,
)
parallel_task_2 = PythonOperator(
task_id="parallel_task_2",
python_callable=task_that_fails,
dag=dag,
)
parallel_task_3 = BashOperator(
task_id="parallel_task_3",
bash_command="echo 'Parallel task 3 running'; sleep 45",
dag=dag,
)
group_end = BashOperator(
task_id="group_end",
bash_command="echo 'Group completed'; sleep 10",
trigger_rule="none_failed_min_one_success",
dag=dag,
)
group_start >> [parallel_task_1, parallel_task_2, parallel_task_3] >> group_end
final_task = BashOperator(
task_id="final_task",
bash_command="echo 'All processing completed'",
dag=dag
)
long_running_task >> scheduled_task
quick_success_task >> queued_task
failing_task >> upstream_failed_task
waiting_sensor >> scheduled_task
processing_group >> final_task Here is the new recording after the fix is applied: Screen.Recording.2025-09-02.at.11.13.34.PM.mov |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall looks good, one nit
@@ -33,6 +33,9 @@ import { | |||
import "chart.js/auto"; | |||
import "chartjs-adapter-dayjs-4/dist/chartjs-adapter-dayjs-4.esm"; | |||
import annotationPlugin from "chartjs-plugin-annotation"; | |||
import dayjs from "dayjs"; | |||
import timezone from "dayjs/plugin/timezone"; | |||
import utc from "dayjs/plugin/utc"; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there any special reason for using this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh, good catch, those imports are redundant, as well as L58-L60 down below. Sorry, not very familiar with dayjs
so missed that. Fixing it now, thanks for the review!
…g-updatedin-realtime
…g-updatedin-realtime
Hello there,
This PR is an attempt to fix #55020 where the gantt chart wasn't showing real-time progress for running tasks.
After applying the fix:
Screen.Recording.2025-09-01.at.9.18.13.PM.mov
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named
{pr_number}.significant.rst
or{issue_number}.significant.rst
, in airflow-core/newsfragments.