Add schedule_until field to queries, to allow expiry (re getredash#15)

client/app/components/queries/schedule-dialog.html

@@ -15,4 +15,8 @@ <h4 class="modal-title">Refresh Schedule</h4>
             <query-time-picker refresh-type="$ctrl.refreshType" query="$ctrl.query" save-query="$ctrl.saveQuery"></query-time-picker>
         </label>
     </div>
+    <label>
+      Stop scheduling at date/time (format yyyy-MM-ddTHH:mm:ss, like 2016-12-28T14:57:00):
+      <schedule-until query="$ctrl.query" save-query="$ctrl.saveQuery"></schedule-until>
+    </label>
 </div>

client/app/components/queries/schedule-dialog.js

@@ -124,6 +124,17 @@ function queryRefreshSelect() {
   };
 }
 
+function scheduleUntil() {
+  return {
+    restrict: 'E',
+    scope: {
+      query: '=',
+      saveQuery: '=',
+    },
+    template: '<input type="datetime-local" step="1" class="form-control" ng-model="query.scheduleUntil" ng-change="saveQuery()">',
+  };
+}
+
 const ScheduleForm = {
   controller() {
     this.query = this.resolve.query;
@@ -146,5 +157,6 @@ const ScheduleForm = {
 export default function init(ngModule) {
   ngModule.directive('queryTimePicker', queryTimePicker);
   ngModule.directive('queryRefreshSelect', queryRefreshSelect);
+  ngModule.directive('scheduleUntil', scheduleUntil);
   ngModule.component('scheduleDialog', ScheduleForm);
 }

client/app/services/query.js

@@ -251,6 +251,10 @@ function QueryResource($resource, $http, $q, $location, currentUser, QueryResult
       .format('HH:mm');
   };
 
+  Query.prototype.hasScheduleExpiry = function hasScheduleExpiry() {
+    return (this.schedule && this.schedule_until);
+  };
+
   Query.prototype.hasResult = function hasResult() {
     return !!(this.latest_query_data || this.latest_query_data_id);
   };

migrations/versions/eb2f788f997e_.py

@@ -0,0 +1,27 @@
+"""Add 'schedule_until' column to queries.
+
+Revision ID: eb2f788f997e
+Revises: d1eae8b9893e
+Create Date: 2017-03-02 12:20:00.029066
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = 'eb2f788f997e'
+down_revision = 'd1eae8b9893e'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.add_column(
+        'queries',
+        sa.Column('schedule_until', sa.DateTime(timezone=True), nullable=True))
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('queries', 'schedule_until')

redash/handlers/queries.py

@@ -85,6 +85,7 @@ def post(self):
         :<json string name:
         :<json string description:
         :<json string schedule: Schedule interval, in seconds, for repeated execution of this query
+        :<json string schedule_until: Time in ISO format to stop scheduling this query (may be null to run indefinitely)
         :<json object options: Query options
 
         .. _query-response-label:
@@ -96,6 +97,7 @@ def post(self):
         :>json string query: Query text
         :>json string query_hash: Hash of query text
         :>json string schedule: Schedule interval, in seconds, for repeated execution of this query
+        :<json string schedule_until: Time in ISO format to stop scheduling this query (may be null to run indefinitely)
         :>json string api_key: Key for public access to this query's results.
         :>json boolean is_archived: Whether this query is displayed in indexes and search results or not.
         :>json boolean is_draft: Whether this query is a draft or not

redash/models.py

@@ -828,6 +828,7 @@ class Query(ChangeTrackingMixin, TimestampMixin, BelongsToOrgMixin, db.Model):
     is_draft = Column(db.Boolean, default=True, index=True)
     schedule = Column(db.String(10), nullable=True)
     schedule_failures = Column(db.Integer, default=0)
+    schedule_until = Column(db.DateTime(True), nullable=True)
     visualizations = db.relationship("Visualization", cascade="all, delete-orphan")
     options = Column(MutableDict.as_mutable(PseudoJSON), default={})
 
@@ -846,6 +847,7 @@ def to_dict(self, with_stats=False, with_visualizations=False, with_user=True, w
             'query': self.query_text,
             'query_hash': self.query_hash,
             'schedule': self.schedule,
+            'schedule_until': self.schedule_until,
             'api_key': self.api_key,
             'is_archived': self.is_archived,
             'is_draft': self.is_draft,
@@ -931,7 +933,9 @@ def by_user(cls, user):
     def outdated_queries(cls):
         queries = (db.session.query(Query)
                    .options(joinedload(Query.latest_query_data).load_only('retrieved_at'))
-                   .filter(Query.schedule != None)
+                   .filter(Query.schedule != None,
+                           (Query.schedule_until == None) |
+                           (Query.schedule_until > db.func.now()))
                    .order_by(Query.id))
 
         now = utils.utcnow()

tests/test_models.py

@@ -192,6 +192,34 @@ def test_failure_extends_schedule(self):
         query_result.retrieved_at = utcnow() - datetime.timedelta(minutes=17)
         self.assertEqual(list(models.Query.outdated_queries()), [query])
 
+    def test_schedule_until_after(self):
+        """
+        Queries with non-null ``schedule_until`` are not reported by
+        Query.outdated_queries() after the given time is past.
+        """
+        three_hours_ago = utcnow() - datetime.timedelta(hours=3)
+        two_hours_ago = utcnow() - datetime.timedelta(hours=2)
+        query = self.factory.create_query(schedule="3600", schedule_until=three_hours_ago)
+        query_result = self.factory.create_query_result(query=query.query_text, retrieved_at=two_hours_ago)
+        query.latest_query_data = query_result
+
+        queries = models.Query.outdated_queries()
+        self.assertNotIn(query, queries)
+
+    def test_schedule_until_before(self):
+        """
+        Queries with non-null ``schedule_until`` are reported by
+        Query.outdated_queries() before the given time is past.
+        """
+        one_hour_from_now = utcnow() + datetime.timedelta(hours=1)
+        two_hours_ago = utcnow() - datetime.timedelta(hours=2)
+        query = self.factory.create_query(schedule="3600", schedule_until=one_hour_from_now)
+        query_result = self.factory.create_query_result(query=query.query_text, retrieved_at=two_hours_ago)
+        query.latest_query_data = query_result
+
+        queries = models.Query.outdated_queries()
+        self.assertIn(query, queries)
+
 
 class QueryArchiveTest(BaseTestCase):
     def setUp(self):