dosubot[bot] commented on issue #29797:
URL: https://github.com/apache/superset/issues/29797#issuecomment-2260949082
<!-- Greeting -->
Hey @danielli-ziprecruiter! I'm here to help you with this issue. I'm a bot
designed to assist with bug reports, questions, and contributions. Let's tackle
this together!
<!-- Answer -->
To resolve the issue with the alert scheduling feature in Superset not
properly converting timezones, you need to ensure that the `triggered_at`
datetime is correctly converted to the specified timezone and then back to UTC
for scheduling. Here is the relevant part of the code that deals with timezone
conversion:
```python
def cron_schedule_window(
triggered_at: datetime, cron: str, timezone: str
) -> Iterator[datetime]:
window_size = app.config["ALERT_REPORTS_CRON_WINDOW_SIZE"]
try:
tz = pytz_timezone(timezone)
except UnknownTimeZoneError:
# fallback to default timezone
tz = pytz_timezone("UTC")
logger.warning("Timezone %s was invalid. Falling back to 'UTC'",
timezone)
utc = pytz_timezone("UTC")
# convert the current time to the user's local time for comparison
time_now = triggered_at.astimezone(tz)
start_at = time_now - timedelta(seconds=window_size / 2)
stop_at = time_now + timedelta(seconds=window_size / 2)
crons = croniter(cron, start_at)
for schedule in crons.all_next(datetime):
if schedule >= stop_at:
break
# convert schedule back to utc
yield schedule.astimezone(utc).replace(tzinfo=None)
```
Ensure that:
1. The `timezone` parameter is correctly passed and is a valid timezone
string.
2. The `triggered_at` datetime is in UTC before being passed to this
function.
Additionally, you can refer to the integration tests in
`tests/integration_tests/reports/api_tests.py` to verify the behavior of the
alert scheduling feature. For example, the test case for creating a report
schedule with an invalid timezone ensures that the system correctly handles
invalid timezones:
```python
# Test that report cannot be created with an invalid timezone
report_schedule_data = {
"type": ReportScheduleType.ALERT,
"name": "new5",
"description": "description",
"creation_method": ReportCreationMethod.ALERTS_REPORTS,
"crontab": "0 9 * * *",
"recipients": [
{
"type": ReportRecipientType.EMAIL,
"recipient_config_json": {"target": "[email protected]"},
},
{
"type": ReportRecipientType.SLACK,
"recipient_config_json": {"target": "channel"},
},
],
"working_timeout": 3600,
"timezone": "this is not a timezone",
"dashboard": dashboard.id,
"database": example_db.id,
}
rv = self.post_assert_metric(uri, report_schedule_data, "post")
assert rv.status_code == 400
data = json.loads(rv.data.decode("utf-8"))
assert data == {
"message": {
"timezone": [f"Must be one of: {', '.join(pytz.all_timezones)}."]
}
}
```
If the issue persists, you might want to add additional logging to verify
the values of `triggered_at`, `timezone`, and the computed `time_now`,
`start_at`, and `stop_at` to debug the issue further
<sup>[[1]](https://github.com/apache/superset/blob/master/superset/tasks/cron_util.py)</sup><sup>[[2]](https://github.com/apache/superset/blob/master/tests/integration_tests/reports/api_tests.py)</sup>.
Additionally, ensure that the timezones for both the Apache Superset backend
and the database engine are configured to use the same timezone, preferably
UTC, to avoid inconsistencies. This consistency helps in maintaining accurate
scheduling and alerting functionalities
<sup>[[3]](https://github.com/apache/superset/blob/master/docs/docs/configuration/timezones.mdx)</sup>.
<!-- Dosu Comment Footer -->
*To continue talking to [Dosu](https://dosu.dev), mention @dosu.*
--
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]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
