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.

Sign up for GitHub

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

Jump to bottom

Handle invalid date parsing in webserver views. #23161

Merged
merged 6 commits into from
May 16, 2022
Merged

Handle invalid date parsing in webserver views. #23161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
506d8af
Handle invalid date from query parameters in views.
tirkarthi Apr 13, 2022
4620d51
Add tests.
tirkarthi Apr 13, 2022
6e68016
Use common parsing helper.
tirkarthi Apr 22, 2022
36754a0
Add type hint.
tirkarthi Apr 25, 2022
2f48271
Remove unwanted error check.
tirkarthi Apr 25, 2022
a8df8ff
Fix extra_links endpoint.
tirkarthi Apr 25, 2022
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
46 changes: 31 additions & 15 deletions airflow/www/views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,13 +187,13 @@ def get_date_time_num_runs_dag_runs_form_data(www_request, session, dag):
"""Get Execution Data, Base Date & Number of runs from a Request"""
date_time = www_request.args.get('execution_date')
if date_time:
date_time = timezone.parse(date_time)
date_time = _safe_parse_datetime(date_time)
else:
date_time = dag.get_latest_execution_date(session=session) or timezone.utcnow()

base_date = www_request.args.get('base_date')
if base_date:
base_date = timezone.parse(base_date)
base_date = _safe_parse_datetime(base_date)
else:
# The DateTimeField widget truncates milliseconds and would loose
# the first dag run. Round to next second.
Expand Down Expand Up @@ -242,6 +242,14 @@ def get_date_time_num_runs_dag_runs_form_data(www_request, session, dag):
}


def _safe_parse_datetime(v):
"""Parse datetime and return error message for invalid dates"""
try:
return timezone.parse(v)
except (TypeError, ParserError):
abort(400, f"Invalid datetime: {v!r}")


def task_group_to_grid(task_item_or_group, dag, dag_runs, tis, session):
"""
Create a nested dict representation of this TaskGroup and its children used to construct
Expand Down Expand Up @@ -1256,7 +1264,7 @@ def rendered_templates(self, session):
task_id = request.args.get('task_id')
map_index = request.args.get('map_index', -1, type=int)
execution_date = request.args.get('execution_date')
dttm = timezone.parse(execution_date)
dttm = _safe_parse_datetime(execution_date)
form = DateTimeForm(data={'execution_date': dttm})
root = request.args.get('root', '')

Expand Down Expand Up @@ -1357,7 +1365,8 @@ def rendered_k8s(self, session: Session = NEW_SESSION):
dag_id = request.args.get('dag_id')
task_id = request.args.get('task_id')
execution_date = request.args.get('execution_date')
dttm = timezone.parse(execution_date)
dttm = _safe_parse_datetime(execution_date)

form = DateTimeForm(data={'execution_date': dttm})
root = request.args.get('root', '')
map_index = request.args.get('map_index', -1, type=int)
Expand Down Expand Up @@ -1506,7 +1515,12 @@ def log(self, session=None):
task_id = request.args.get('task_id')
map_index = request.args.get('map_index', -1, type=int)
execution_date = request.args.get('execution_date')
dttm = timezone.parse(execution_date) if execution_date else None

if execution_date:
dttm = _safe_parse_datetime(execution_date)
else:
dttm = None

form = DateTimeForm(data={'execution_date': dttm})
dag_model = DagModel.get_dagmodel(dag_id)

Expand Down Expand Up @@ -1553,7 +1567,7 @@ def redirect_to_external_log(self, session=None):
dag_id = request.args.get('dag_id')
task_id = request.args.get('task_id')
execution_date = request.args.get('execution_date')
dttm = timezone.parse(execution_date)
dttm = _safe_parse_datetime(execution_date)
map_index = request.args.get('map_index', -1, type=int)
try_number = request.args.get('try_number', 1)

Expand Down Expand Up @@ -1590,7 +1604,7 @@ def task(self, session):
dag_id = request.args.get('dag_id')
task_id = request.args.get('task_id')
execution_date = request.args.get('execution_date')
dttm = timezone.parse(execution_date)
dttm = _safe_parse_datetime(execution_date)
map_index = request.args.get('map_index', -1, type=int)
form = DateTimeForm(data={'execution_date': dttm})
root = request.args.get('root', '')
Expand Down Expand Up @@ -1722,7 +1736,8 @@ def xcom(self, session=None):
# Carrying execution_date through, even though it's irrelevant for
# this context
execution_date = request.args.get('execution_date')
dttm = timezone.parse(execution_date)
dttm = _safe_parse_datetime(execution_date)

form = DateTimeForm(data={'execution_date': dttm})
root = request.args.get('root', '')
dag = DagModel.get_dagmodel(dag_id)
Expand Down Expand Up @@ -2064,7 +2079,7 @@ def clear(self):
map_indexes = request.form.getlist('map_index', type=int)

execution_date = request.form.get('execution_date')
execution_date = timezone.parse(execution_date)
execution_date = _safe_parse_datetime(execution_date)
confirmed = request.form.get('confirmed') == "true"
upstream = request.form.get('upstream') == "true"
downstream = request.form.get('downstream') == "true"
Expand Down Expand Up @@ -2595,7 +2610,7 @@ def grid(self, dag_id, session=None):
num_runs = conf.getint('webserver', 'default_dag_run_display_number')

try:
base_date = timezone.parse(request.args["base_date"])
base_date = _safe_parse_datetime(request.args["base_date"])
except (KeyError, ValueError):
base_date = dag.get_latest_execution_date() or timezone.utcnow()

Expand Down Expand Up @@ -2834,6 +2849,7 @@ def graph(self, dag_id, session=None):
edges = dag_edges(dag)

dt_nr_dr_data = get_date_time_num_runs_dag_runs_form_data(request, session, dag)

dt_nr_dr_data['arrange'] = arrange
dttm = dt_nr_dr_data['dttm']
dag_run = dag.get_dagrun(execution_date=dttm)
Expand Down Expand Up @@ -2940,7 +2956,7 @@ def duration(self, dag_id, session=None):
num_runs = request.args.get('num_runs', default=default_dag_run, type=int)

if base_date:
base_date = timezone.parse(base_date)
base_date = _safe_parse_datetime(base_date)
else:
base_date = dag.get_latest_execution_date() or timezone.utcnow()

Expand Down Expand Up @@ -3087,7 +3103,7 @@ def tries(self, dag_id, session=None):
num_runs = request.args.get('num_runs', default=default_dag_run, type=int)

if base_date:
base_date = timezone.parse(base_date)
base_date = _safe_parse_datetime(base_date)
else:
base_date = dag.get_latest_execution_date() or timezone.utcnow()

Expand Down Expand Up @@ -3177,7 +3193,7 @@ def landing_times(self, dag_id, session=None):
num_runs = request.args.get('num_runs', default=default_dag_run, type=int)

if base_date:
base_date = timezone.parse(base_date)
base_date = _safe_parse_datetime(base_date)
else:
base_date = dag.get_latest_execution_date() or timezone.utcnow()

Expand Down Expand Up @@ -3411,7 +3427,7 @@ def extra_links(self, session: "Session" = NEW_SESSION):
map_index = request.args.get('map_index', -1, type=int)
execution_date = request.args.get('execution_date')
link_name = request.args.get('link_name')
dttm = timezone.parse(execution_date)
dttm = _safe_parse_datetime(execution_date)
dag = current_app.dag_bag.get_dag(dag_id)

if not dag or task_id not in dag.task_ids:
Expand Down Expand Up @@ -3466,7 +3482,7 @@ def task_instances(self):

dttm = request.args.get('execution_date')
if dttm:
dttm = timezone.parse(dttm)
dttm = _safe_parse_datetime(dttm)
else:
response = jsonify({'error': f"Invalid execution_date {dttm}"})
response.status_code = 400
Expand Down
57 changes: 57 additions & 0 deletions tests/www/views/test_views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,3 +373,60 @@ def test_get_task_stats_from_query():

data = get_task_stats_from_query(query_data)
assert data == expected_data


@pytest.mark.parametrize(
"url, content",
[
(
'/rendered-templates?execution_date=invalid',
"Invalid datetime: 'invalid'",
),
(
'/log?execution_date=invalid',
"Invalid datetime: 'invalid'",
),
(
'/redirect_to_external_log?execution_date=invalid',
"Invalid datetime: 'invalid'",
),
(
'/task?execution_date=invalid',
"Invalid datetime: 'invalid'",
),
(
'dags/example_bash_operator/graph?execution_date=invalid',
"Invalid datetime: 'invalid'",
),
(
'dags/example_bash_operator/graph?execution_date=invalid',
"Invalid datetime: 'invalid'",
),
(
'dags/example_bash_operator/duration?base_date=invalid',
"Invalid datetime: 'invalid'",
),
(
'dags/example_bash_operator/tries?base_date=invalid',
"Invalid datetime: 'invalid'",
),
(
'dags/example_bash_operator/landing-times?base_date=invalid',
"Invalid datetime: 'invalid'",
),
(
'dags/example_bash_operator/gantt?execution_date=invalid',
"Invalid datetime: 'invalid'",
),
(
'extra_links?execution_date=invalid',
"Invalid datetime: 'invalid'",
),
],
)
def test_invalid_dates(app, admin_client, url, content):
"""Test invalid date format doesn't crash page."""
resp = admin_client.get(url, follow_redirects=True)

assert resp.status_code == 400
assert content in resp.get_data().decode()