Change tracking

migrations/versions/4952e040e9dd_clear_changes_table.py

@@ -0,0 +1,34 @@
+"""clear_changes_table
+
+Revision ID: 4952e040e9dd
+Revises: e5c7a4e2df4d
+Create Date: 2020-04-06 13:22:15.256635
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '4952e040e9dd'
+down_revision = 'e5c7a4e2df4d'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.execute("DELETE FROM changes")
+    op.drop_column("changes", "object_version")
+    op.create_index(
+        "ix_changes_object_ref",
+        "changes",
+        ["object_type", "object_id"],
+        unique=False,
+    )
+
+
+def downgrade():
+    op.add_column("changes", sa.Column("object_version", sa.Integer(), nullable=True, default=0))
+    op.execute("UPDATE changes SET object_version = 0")
+    op.alter_column("changes", "object_version", nullable=False)
+    op.drop_index("ix_changes_object_ref")

redash/handlers/dashboards.py

@@ -107,6 +107,10 @@ def post(self):
         )
         models.db.session.add(dashboard)
         models.db.session.commit()
+
+        dashboard.record_changes(self.current_user, models.Change.Type.Created)
+        models.db.session.commit()
+
         return serialize_dashboard(dashboard)
 
 
@@ -210,9 +214,9 @@ def post(self, dashboard_slug):
 
         updates["changed_by"] = self.current_user
 
-        self.update_model(dashboard, updates)
-        models.db.session.add(dashboard)
         try:
+            self.update_model(dashboard, updates)
+            dashboard.record_changes(self.current_user)
             models.db.session.commit()
         except StaleDataError:
             abort(409)
@@ -240,16 +244,14 @@ def delete(self, dashboard_slug):
             dashboard_slug, self.current_org
         )
         dashboard.is_archived = True
-        dashboard.record_changes(changed_by=self.current_user)
-        models.db.session.add(dashboard)
-        d = serialize_dashboard(dashboard, with_widgets=True, user=self.current_user)
+        dashboard.record_changes(self.current_user)
         models.db.session.commit()
 
         self.record_event(
             {"action": "archive", "object_id": dashboard.id, "object_type": "dashboard"}
         )
 
-        return d
+        return serialize_dashboard(dashboard, with_widgets=True, user=self.current_user)
 
 
 class PublicDashboardResource(BaseResource):
@@ -283,7 +285,9 @@ def post(self, dashboard_id):
         dashboard = models.Dashboard.get_by_id_and_org(dashboard_id, self.current_org)
         require_admin_or_owner(dashboard.user_id)
         api_key = models.ApiKey.create_for_object(dashboard, self.current_user)
-        models.db.session.flush()
+        models.db.session.commit()
+
+        api_key.record_changes(self.current_user, models.Change.Type.Created)
         models.db.session.commit()
 
         public_url = url_for(
@@ -316,6 +320,7 @@ def delete(self, dashboard_id):
         if api_key:
             api_key.active = False
             models.db.session.add(api_key)
+            api_key.record_changes(self.current_user)
             models.db.session.commit()
 
         self.record_event(

redash/handlers/queries.py

@@ -259,6 +259,11 @@ def post(self):
         models.db.session.add(query)
         models.db.session.commit()
 
+        query.record_changes(self.current_user, models.Change.Type.Created)
+        for vis in query.visualizations:
+            vis.record_changes(self.current_user, models.Change.Type.Created)
+        models.db.session.commit()
+
         self.record_event(
             {"action": "create", "object_id": query.id, "object_type": "query"}
         )
@@ -376,6 +381,7 @@ def post(self, query_id):
 
         try:
             self.update_model(query, query_def)
+            query.record_changes(self.current_user)
             models.db.session.commit()
         except StaleDataError:
             abort(409)
@@ -416,7 +422,8 @@ def delete(self, query_id):
             models.Query.get_by_id_and_org, query_id, self.current_org
         )
         require_admin_or_owner(query.user_id)
-        query.archive(self.current_user)
+        query.archive()
+        query.record_changes(self.current_user)
         models.db.session.commit()
 
 
@@ -428,6 +435,7 @@ def post(self, query_id):
         )
         require_admin_or_owner(query.user_id)
         query.regenerate_api_key()
+        query.record_changes(self.current_user)
         models.db.session.commit()
 
         self.record_event(
@@ -459,6 +467,11 @@ def post(self, query_id):
         forked_query = query.fork(self.current_user)
         models.db.session.commit()
 
+        forked_query.record_changes(self.current_user, models.Change.Type.Created)
+        for vis in forked_query.visualizations:
+            vis.record_changes(self.current_user, models.Change.Type.Created)
+        models.db.session.commit()
+
         self.record_event(
             {"action": "fork", "object_id": query_id, "object_type": "query"}
         )

redash/handlers/visualizations.py

@@ -23,6 +23,10 @@ def post(self):
         vis = models.Visualization(**kwargs)
         models.db.session.add(vis)
         models.db.session.commit()
+
+        vis.record_changes(self.current_user, models.Change.Type.Created)
+        models.db.session.commit()
+
         return serialize_visualization(vis, with_query=False)
 
 
@@ -42,9 +46,10 @@ def post(self, visualization_id):
         kwargs.pop("query_id", None)
 
         self.update_model(vis, kwargs)
-        d = serialize_visualization(vis, with_query=False)
+        vis.record_changes(self.current_user)
         models.db.session.commit()
-        return d
+
+        return serialize_visualization(vis, with_query=False)
 
     @require_permission("edit_query")
     def delete(self, visualization_id):
@@ -59,5 +64,6 @@ def delete(self, visualization_id):
                 "object_type": "Visualization",
             }
         )
+        vis.record_changes(self.current_user, models.Change.Type.Deleted)
         models.db.session.delete(vis)
         models.db.session.commit()

redash/handlers/widgets.py

@@ -50,7 +50,9 @@ def post(self):
         models.db.session.add(widget)
         models.db.session.commit()
 
+        widget.record_changes(self.current_user, models.Change.Type.Created)
         models.db.session.commit()
+
         return serialize_widget(widget)
 
 
@@ -70,6 +72,7 @@ def post(self, widget_id):
         widget_properties = request.get_json(force=True)
         widget.text = widget_properties["text"]
         widget.options = json_dumps(widget_properties["options"])
+        widget.record_changes(self.current_user)
         models.db.session.commit()
         return serialize_widget(widget)
 
@@ -85,5 +88,6 @@ def delete(self, widget_id):
         self.record_event(
             {"action": "delete", "object_id": widget_id, "object_type": "widget"}
         )
+        widget.record_changes(self.current_user, models.Change.Type.Deleted)
         models.db.session.delete(widget)
         models.db.session.commit()

redash/models/__init__.py

@@ -42,7 +42,7 @@
 from redash.models.parameterized_query import ParameterizedQuery
 
 from .base import db, gfk_type, Column, GFKBase, SearchBaseQuery
-from .changes import ChangeTrackingMixin, Change  # noqa
+from .changes import Change, track_changes  # noqa
 from .mixins import BelongsToOrgMixin, TimestampMixin
 from .organizations import Organization
 from .types import (
@@ -451,7 +451,20 @@ def should_schedule_next(
     "schedule",
     "schedule_failures",
 )
-class Query(ChangeTrackingMixin, TimestampMixin, BelongsToOrgMixin, db.Model):
+@track_changes(
+    attributes=[
+        "name",
+        "description",
+        "query_text",
+        "is_archived",
+        "is_draft",
+        "api_key",
+        "options",
+        "schedule",
+        "tags",
+    ]
+)
+class Query(TimestampMixin, BelongsToOrgMixin, db.Model):
     id = Column(db.Integer, primary_key=True)
     version = Column(db.Integer, default=1)
     org_id = Column(db.Integer, db.ForeignKey("organizations.id"))
@@ -500,7 +513,7 @@ class Query(ChangeTrackingMixin, TimestampMixin, BelongsToOrgMixin, db.Model):
     def __str__(self):
         return str(self.id)
 
-    def archive(self, user=None):
+    def archive(self):
         db.session.add(self)
         self.is_archived = True
         self.schedule = None
@@ -512,8 +525,6 @@ def archive(self, user=None):
         for a in self.alerts:
             db.session.delete(a)
 
-        if user:
-            self.record_changes(user)
 
     def regenerate_api_key(self):
         self.api_key = generate_token(40)
@@ -1055,7 +1066,8 @@ def generate_slug(ctx):
 @generic_repr(
     "id", "name", "slug", "user_id", "org_id", "version", "is_archived", "is_draft"
 )
-class Dashboard(ChangeTrackingMixin, TimestampMixin, BelongsToOrgMixin, db.Model):
+@track_changes(attributes=["name", "is_archived", "is_draft", "tags", "dashboard_filters_enabled"])
+class Dashboard(TimestampMixin, BelongsToOrgMixin, db.Model):
     id = Column(db.Integer, primary_key=True)
     version = Column(db.Integer)
     org_id = Column(db.Integer, db.ForeignKey("organizations.id"))
@@ -1161,6 +1173,10 @@ def lowercase_name(cls):
 
 
 @generic_repr("id", "name", "type", "query_id")
+@track_changes(
+    parent=(Query, "query_id"),
+    attributes=["type", "name", "description", "options"]
+)
 class Visualization(TimestampMixin, BelongsToOrgMixin, db.Model):
     id = Column(db.Integer, primary_key=True)
     type = Column(db.String(100))
@@ -1178,7 +1194,7 @@ def __str__(self):
 
     @classmethod
     def get_by_id_and_org(cls, object_id, org):
-        return super(Visualization, cls).get_by_id_and_org(object_id, org, Query)
+        return super().get_by_id_and_org(object_id, org, Query)
 
     def copy(self):
         return {
@@ -1190,6 +1206,10 @@ def copy(self):
 
 
 @generic_repr("id", "visualization_id", "dashboard_id")
+@track_changes(
+    parent=(Dashboard, "dashboard_id"),
+    attributes=["text", "visualization_id", "options"]
+)
 class Widget(TimestampMixin, BelongsToOrgMixin, db.Model):
     id = Column(db.Integer, primary_key=True)
     visualization_id = Column(
@@ -1210,7 +1230,7 @@ def __str__(self):
 
     @classmethod
     def get_by_id_and_org(cls, object_id, org):
-        return super(Widget, cls).get_by_id_and_org(object_id, org, Dashboard)
+        return super().get_by_id_and_org(object_id, org, Dashboard)
 
 
 @generic_repr(
@@ -1275,6 +1295,10 @@ def record(cls, event):
 
 
 @generic_repr("id", "created_by_id", "org_id", "active")
+@track_changes(
+    parent=("object_type", "object_id"),
+    attributes=["api_key", "created_by_id", "active"]
+)
 class ApiKey(TimestampMixin, GFKBase, db.Model):
     id = Column(db.Integer, primary_key=True)
     org_id = Column(db.Integer, db.ForeignKey("organizations.id"))