When using the versioned decorator I noticed that when adding or

revoking an api key the service it associated with was of course added
to db.session.dirty.

That resulted in an updated version of service being added to the
service history table that showed no visible difference from that
record immediately precending it as the change was to another table,
namely the api_key table. A new api key or revoked api key was correctly
added to api_key and api_key_history tables. However I think an
'unchanged' service history record may be a bit confusing as you'd need
to correlate with api_keys to work out what the change was.

I think it's best to just record the new/revoked api_key and not create
another version of the service.

This pr wraps the exisiting versioned decorator with one that take a
class which you are interested in versioning.

Using the new decorator you only get a new version and history record
for the class you pass to outer decorator.

If the exising behaviour is acceptable to the powers that be then by all
means ignore/close this pr.

app/dao/api_key_dao.py

@@ -7,12 +7,12 @@ from app.models import ApiKey
 
 from app.dao.dao_utils import (
     transactional,
-    versioned
+    version_class
 )
 
 
 @transactional
-@versioned
+@version_class(ApiKey)
 def save_model_api_key(api_key, update_dict={}):
     if update_dict:
         update_dict.pop('id', None)

app/dao/dao_utils.py

@@ -18,13 +18,16 @@ def transactional(func):
     return commit_or_rollback
 
 
-def versioned(func):
+def version_class(model_class):
-    @wraps(func)
+    def versioned(func):
-    def record_version(*args, **kwargs):
+        @wraps(func)
-        from app import db
+        def record_version(*args, **kwargs):
-        func(*args, **kwargs)
+            from app import db
-        history_objects = [create_history(obj) for obj in
+            func(*args, **kwargs)
-                           versioned_objects(itertools.chain(db.session.new, db.session.dirty))]
+            history_objects = [create_history(obj) for obj in
-        for h_obj in history_objects:
+                               versioned_objects(itertools.chain(db.session.new, db.session.dirty))
-            db.session.add(h_obj)
+                               if isinstance(obj, model_class)]
-    return record_version
+            for h_obj in history_objects:
+                db.session.add(h_obj)
+        return record_version
+    return versioned

app/dao/services_dao.py

@@ -6,7 +6,7 @@ from sqlalchemy import asc
 
 from app.dao.dao_utils import (
     transactional,
-    versioned
+    version_class
 )
 
 
@@ -27,7 +27,7 @@ def dao_fetch_service_by_id_and_user(service_id, user_id):
 
 
 @transactional
-@versioned
+@version_class(Service)
 def dao_create_service(service, user):
     from app.dao.permissions_dao import permission_dao
     service.users.append(user)
@@ -37,7 +37,7 @@ def dao_create_service(service, user):
 
 
 @transactional
-@versioned
+@version_class(Service)
 def dao_update_service(service):
     db.session.add(service)
 

tests/app/dao/test_api_key_dao.py

@@ -111,3 +111,18 @@ def test_should_not_allow_duplicate_key_names_per_service(notify_api,
         fail("should throw IntegrityError")
     except:
         pass
+
+
+def test_save_api_key_should_not_create_new_service_history(notify_api, notify_db, notify_db_session, sample_service):
+
+    from app.models import Service
+
+    assert Service.query.count() == 1
+    assert Service.get_history_model().query.count() == 1
+
+    api_key = ApiKey(**{'service': sample_service,
+                        'name': sample_service.name,
+                        'created_by': sample_service.created_by})
+    save_model_api_key(api_key)
+
+    assert Service.get_history_model().query.count() == 1