Add "deprecated" flag to query runners (and alert destinations) (getredash#3972)

* add a deprecated flag to query runners and show only non-deprecated query runners when adding a new data source

* add a deprecated flag to alert destinations and show only non-deprecated alert destinations when adding a new alert destination

* add a deprecated() decorator for a more succint way to deprecate

* deprecate URL query runner and HipChat alert destination

* use class properties instead of class methods for deprecation

* I <3 newlines

Author: Omer Lachish

redash/destinations/__init__.py

@@ -11,6 +11,8 @@
 
 
 class BaseDestination(object):
+    deprecated = False
+
     def __init__(self, configuration):
         self.configuration = configuration
 

redash/destinations/hipchat.py

@@ -3,7 +3,7 @@
 
 from redash.destinations import *
 from redash.models import Alert
-from redash.utils import json_dumps
+from redash.utils import json_dumps, deprecated
 
 
 colors = {
@@ -13,6 +13,7 @@
 }
 
 
+@deprecated()
 class HipChat(BaseDestination):
     @classmethod
     def configuration_schema(cls):

redash/handlers/data_sources.py

@@ -19,7 +19,8 @@
 class DataSourceTypeListResource(BaseResource):
     @require_admin
     def get(self):
-        return [q.to_dict() for q in sorted(query_runners.values(), key=lambda q: q.name())]
+        available_query_runners = filter(lambda q: not q.deprecated, query_runners.values())
+        return [q.to_dict() for q in sorted(available_query_runners, key=lambda q: q.name())]
 
 
 class DataSourceResource(BaseResource):

redash/handlers/destinations.py

@@ -13,7 +13,8 @@
 class DestinationTypeListResource(BaseResource):
     @require_admin
     def get(self):
-        return [q.to_dict() for q in destinations.values()]
+        available_destinations = filter(lambda q: not q.deprecated, destinations.values())
+        return [q.to_dict() for q in available_destinations]
 
 
 class DestinationResource(BaseResource):

redash/query_runner/__init__.py

@@ -53,6 +53,7 @@ class NotSupported(Exception):
 
 
 class BaseQueryRunner(object):
+    deprecated = False
     noop_query = None
 
     def __init__(self, configuration):

redash/query_runner/url.py

@@ -1,6 +1,8 @@
 from redash.query_runner import BaseHTTPQueryRunner, register
+from redash.utils import deprecated
 
 
+@deprecated()
 class Url(BaseHTTPQueryRunner):
     requires_url = False
 

redash/utils/__init__.py

@@ -192,3 +192,11 @@ def to_filename(s):
     s = re.sub('[<>:"\\\/|?*]+', " ", s, flags=re.UNICODE)
     s = re.sub("\s+", "_", s, flags=re.UNICODE)
     return s.strip("_")
+
+
+def deprecated():
+    def wrapper(K):
+        setattr(K, 'deprecated', True)
+        return K
+
+    return wrapper

tests/handlers/test_data_sources.py

@@ -1,7 +1,9 @@
 from funcy import pairwise
 from tests import BaseTestCase
+from mock import patch
 
 from redash.models import DataSource
+from redash.query_runner.pg import PostgreSQL
 
 
 class TestDataSourceGetSchema(BaseTestCase):
@@ -38,6 +40,14 @@ def test_returns_data_for_admin(self):
         rv = self.make_request('get', "/api/data_sources/types", user=admin)
         self.assertEqual(rv.status_code, 200)
 
+    def test_does_not_show_deprecated_types(self):
+        admin = self.factory.create_admin()
+        with patch.object(PostgreSQL, 'deprecated', return_value=True):
+            rv = self.make_request('get', "/api/data_sources/types", user=admin)
+
+        types = map(lambda x: x['type'], rv.json)
+        self.assertNotIn('pg', types)
+
     def test_returns_403_for_non_admin(self):
         rv = self.make_request('get', "/api/data_sources/types")
         self.assertEqual(rv.status_code, 403)

tests/handlers/test_destinations.py

@@ -1,6 +1,8 @@
 from tests import BaseTestCase
+from mock import patch
 
 from redash.models import NotificationDestination
+from redash.destinations.slack import Slack
 
 
 class TestDestinationListResource(BaseTestCase):
@@ -78,3 +80,13 @@ def test_post(self):
         d = NotificationDestination.query.get(d.id)
         self.assertEqual(d.name, data['name'])
         self.assertEqual(d.options['url'], data['options']['url'])
+        
+
+class DestinationTypesTest(BaseTestCase):
+    def test_does_not_show_deprecated_types(self):
+        admin = self.factory.create_admin()
+        with patch.object(Slack, 'deprecated', return_value=True):
+            rv = self.make_request('get', "/api/destinations/types", user=admin)
+
+        types = map(lambda x: x['type'], rv.json)
+        self.assertNotIn('slack', types)