Skip to content

Commit

Permalink
feat: add force option to report screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
betodealmeida committed Dec 22, 2021
1 parent b1ec4f8 commit fdfa801
Show file tree
Hide file tree
Showing 6 changed files with 72 additions and 7 deletions.
2 changes: 2 additions & 0 deletions superset-frontend/src/components/ReportModal/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ export interface ReportObject {
validator_type: string;
working_timeout: number;
creation_method: string;
force_screenshot: boolean;
}

interface ChartObject {
Expand Down Expand Up @@ -227,6 +228,7 @@ const ReportModal: FunctionComponent<ReportProps> = ({
active: true,
report_format: currentReport?.report_format || defaultNotificationFormat,
timezone: currentReport?.timezone,
force_screenshot: false,
};

if (isEditMode) {
Expand Down
2 changes: 2 additions & 0 deletions superset-frontend/src/views/CRUD/alert/AlertReportModal.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,7 @@ const DEFAULT_ALERT = {
sql: '',
validator_config_json: {},
validator_type: '',
force_screenshot: true,
grace_period: undefined,
};

Expand Down Expand Up @@ -512,6 +513,7 @@ const AlertReportModal: FunctionComponent<AlertReportModalProps> = ({
const data: any = {
...currentAlert,
type: isReport ? 'Report' : 'Alert',
force_screenshot: isReport ? 'false' : 'true',
validator_type: conditionNotNull ? 'not null' : 'operator',
validator_config_json: conditionNotNull
? {}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# 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.
"""Add force_screenshot to alerts/reports
Revision ID: bb38f40aa3ff
Revises: abe27eaf93db
Create Date: 2021-12-10 19:25:29.802949
"""

# revision identifiers, used by Alembic.
revision = "bb38f40aa3ff"
down_revision = "abe27eaf93db"

import sqlalchemy as sa
from alembic import op
from sqlalchemy.ext.declarative import declarative_base

from superset import db

Base = declarative_base()


class ReportSchedule(Base):
__tablename__ = "report_schedule"

id = sa.Column(sa.Integer, primary_key=True)
type = sa.Column(sa.String(50), nullable=False)
force_screenshot = sa.Column(sa.Boolean, default=False)


def upgrade():
with op.batch_alter_table("report_schedule") as batch_op:
batch_op.add_column(sa.Column("force_screenshot", sa.Boolean(), default=False))

bind = op.get_bind()
session = db.Session(bind=bind)

for report in session.query(ReportSchedule).all():
report.force_screenshot = report.type == "Alert"

session.commit()


def downgrade():
with op.batch_alter_table("report_schedule") as batch_op:
batch_op.drop_column("force_screenshot")
4 changes: 4 additions & 0 deletions superset/models/reports.py
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,10 @@ class ReportSchedule(Model, AuditMixinNullable):
# Store the selected dashboard tabs etc.
extra = Column(Text, default="{}")

# (Reports) When generating a screenshot, bypass the cache? This is always true for
# Alerts.
force_screenshot = Column(Boolean, default=False)

def __repr__(self) -> str:
return str(self.name)

Expand Down
8 changes: 1 addition & 7 deletions superset/reports/commands/execute.py