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

fix(reports): Clear last value when state is WORKING #19941

Merged
merged 2 commits into from
May 13, 2022
Merged

fix(reports): Clear last value when state is WORKING #19941

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6903c48
fix(reports): Clear last value when state is WORKING
May 4, 2022
17ed438
Update cbe71abde154_fix_report_schedule_and_log.py
john-bodley May 13, 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
82 changes: 82 additions & 0 deletions superset/migrations/versions/cbe71abde154_fix_report_schedule_and_log.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# 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.
"""fix report schedule and execution log

Revision ID: cbe71abde154
Revises: a9422eeaae74
Create Date: 2022-05-03 19:39:32.074608

"""

# revision identifiers, used by Alembic.
revision = "cbe71abde154"
down_revision = "a9422eeaae74"

from alembic import op
from sqlalchemy import Column, Float, Integer, String, Text
from sqlalchemy.ext.declarative import declarative_base

from superset import db
from superset.models.reports import ReportState

Base = declarative_base()


class ReportExecutionLog(Base):
__tablename__ = "report_execution_log"

id = Column(Integer, primary_key=True)
state = Column(String(50), nullable=False)
value = Column(Float)
value_row_json = Column(Text)


class ReportSchedule(Base):
__tablename__ = "report_schedule"

id = Column(Integer, primary_key=True)
last_state = Column(String(50))
last_value = Column(Float)
last_value_row_json = Column(Text)


def upgrade():
bind = op.get_bind()
session = db.Session(bind=bind)

for schedule in (
session.query(ReportSchedule)
.filter(ReportSchedule.last_state == ReportState.WORKING)
.all()
):
schedule.last_value = None
schedule.last_value_row_json = None
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@john-bodley do you think there's a chance that if there is a report that's in a working state, that we could potentially wind up altering the value after the report has completed? Just based off your migration timing of around a minute and most of these reports take under a minute to run, we may wind up with some reports that wind up with a completed state and no value, i.e., the commit happens here after the state has changed on the report side. Just wondering if it's safer not to change reports that are in progress.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@eschutho I guess with any migration there's a risk of a race condition happening whilst the migration is running. I've replicated the session.commit() to ensure that there's also a commit directly after the ReportSchedule which likely only has a handful of reports in WORKING state.


for execution_log in (
session.query(ReportExecutionLog)
.filter(ReportExecutionLog.state == ReportState.WORKING)
.all()
):
execution_log.value = None
execution_log.value_row_json = None

session.commit()
session.close()


def downgrade():
pass
70 changes: 39 additions & 31 deletions superset/reports/commands/execute.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,35 +94,39 @@ def __init__(
self._start_dttm = datetime.utcnow()
self._execution_id = execution_id

def set_state_and_log(
def update_report_schedule_and_log(
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I felt that update_report_schedule_and_log was more reflective of the function logic.

self,
state: ReportState,
error_message: Optional[str] = None,
) -> None:
"""
Updates current ReportSchedule state and TS. If on final state writes the log
for this execution
Update the report schedule state et al. and reflect the change in the execution
log.
"""
now_dttm = datetime.utcnow()
self.set_state(state, now_dttm)
self.create_log(
state,
error_message=error_message,
)

def set_state(self, state: ReportState, dttm: datetime) -> None:
self.update_report_schedule(state)
self.create_log(error_message)

def update_report_schedule(self, state: ReportState) -> None:
"""
Set the current report schedule state, on this case we want to
commit immediately
Update the report schedule state et al.

When the report state is WORKING we must ensure that the values from the last
execution run are cleared to ensure that they are not propagated to the
execution log.
"""

if state == ReportState.WORKING:
self._report_schedule.last_value = None
self._report_schedule.last_value_row_json = None

self._report_schedule.last_state = state
self._report_schedule.last_eval_dttm = dttm
self._report_schedule.last_eval_dttm = datetime.utcnow()
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's no need to pass in the timestamp which isn't used elsewhere.


self._session.merge(self._report_schedule)
self._session.commit()

def create_log(
self, state: ReportState, error_message: Optional[str] = None
) -> None:
def create_log(self, error_message: Optional[str] = None) -> None:
"""
Creates a Report execution log, uses the current computed last_value for Alerts
"""
Expand All @@ -132,7 +136,7 @@ def create_log(
end_dttm=datetime.utcnow(),
value=self._report_schedule.last_value,
value_row_json=self._report_schedule.last_value_row_json,
state=state,
state=self._report_schedule.last_state,
error_message=error_message,
report_schedule=self._report_schedule,
uuid=self._execution_id,
Expand Down Expand Up @@ -490,17 +494,19 @@ class ReportNotTriggeredErrorState(BaseReportState):
initial = True

def next(self) -> None:
self.set_state_and_log(ReportState.WORKING)
self.update_report_schedule_and_log(ReportState.WORKING)
try:
# If it's an alert check if the alert is triggered
if self._report_schedule.type == ReportScheduleType.ALERT:
if not AlertCommand(self._report_schedule).run():
self.set_state_and_log(ReportState.NOOP)
self.update_report_schedule_and_log(ReportState.NOOP)
return
self.send()
self.set_state_and_log(ReportState.SUCCESS)
self.update_report_schedule_and_log(ReportState.SUCCESS)
except CommandException as first_ex:
self.set_state_and_log(ReportState.ERROR, error_message=str(first_ex))
self.update_report_schedule_and_log(
ReportState.ERROR, error_message=str(first_ex)
)
# TODO (dpgaspar) convert this logic to a new state eg: ERROR_ON_GRACE
if not self.is_in_error_grace_period():
try:
Expand All @@ -509,12 +515,12 @@ def next(self) -> None:
f" {self._report_schedule.name}",
str(first_ex),
)
self.set_state_and_log(
self.update_report_schedule_and_log(
ReportState.ERROR,
error_message=REPORT_SCHEDULE_ERROR_NOTIFICATION_MARKER,
)
except CommandException as second_ex:
self.set_state_and_log(
self.update_report_schedule_and_log(
ReportState.ERROR, error_message=str(second_ex)
)
raise first_ex
Expand All @@ -533,13 +539,13 @@ class ReportWorkingState(BaseReportState):
def next(self) -> None:
if self.is_on_working_timeout():
exception_timeout = ReportScheduleWorkingTimeoutError()
self.set_state_and_log(
self.update_report_schedule_and_log(
ReportState.ERROR,
error_message=str(exception_timeout),
)
raise exception_timeout
exception_working = ReportSchedulePreviousWorkingError()
self.set_state_and_log(
self.update_report_schedule_and_log(
ReportState.WORKING,
error_message=str(exception_working),
)
Expand All @@ -560,33 +566,35 @@ class ReportSuccessState(BaseReportState):
def next(self) -> None:
if self._report_schedule.type == ReportScheduleType.ALERT:
if self.is_in_grace_period():
self.set_state_and_log(
self.update_report_schedule_and_log(
ReportState.GRACE,
error_message=str(ReportScheduleAlertGracePeriodError()),
)
return
self.set_state_and_log(ReportState.WORKING)
self.update_report_schedule_and_log(ReportState.WORKING)
try:
if not AlertCommand(self._report_schedule).run():
self.set_state_and_log(ReportState.NOOP)
self.update_report_schedule_and_log(ReportState.NOOP)
return
except CommandException as ex:
self.send_error(
f"Error occurred for {self._report_schedule.type}:"
f" {self._report_schedule.name}",
str(ex),
)
self.set_state_and_log(
self.update_report_schedule_and_log(
ReportState.ERROR,
error_message=REPORT_SCHEDULE_ERROR_NOTIFICATION_MARKER,
)
raise ex

try:
self.send()
self.set_state_and_log(ReportState.SUCCESS)
self.update_report_schedule_and_log(ReportState.SUCCESS)
except CommandException as ex:
self.set_state_and_log(ReportState.ERROR, error_message=str(ex))
self.update_report_schedule_and_log(
ReportState.ERROR, error_message=str(ex)
)


class ReportScheduleStateMachine: # pylint: disable=too-few-public-methods
Expand Down
9 changes: 9 additions & 0 deletions tests/integration_tests/reports/commands_tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,11 @@ def assert_log(state: str, error_message: Optional[str] = None):
assert state in log_states
assert error_message in [log.error_message for log in logs]

for log in logs:
if log.state == ReportState.WORKING:
assert log.value is None
assert log.value_row_json is None


def create_report_notification(
email_target: Optional[str] = None,
Expand Down Expand Up @@ -370,11 +375,15 @@ def create_report_slack_chart_working():
)
report_schedule.last_state = ReportState.WORKING
report_schedule.last_eval_dttm = datetime(2020, 1, 1, 0, 0)
report_schedule.last_value = None
report_schedule.last_value_row_json = None
db.session.commit()
log = ReportExecutionLog(
scheduled_dttm=report_schedule.last_eval_dttm,
start_dttm=report_schedule.last_eval_dttm,
end_dttm=report_schedule.last_eval_dttm,
value=report_schedule.last_value,
value_row_json=report_schedule.last_value_row_json,
state=ReportState.WORKING,
report_schedule=report_schedule,
uuid=uuid4(),
Expand Down