Return commit id on successful commit

Knowing the commit id of changes can be useful for example when wanting
to compare to committed changes and knowing which one finished first and
other features that we want in the future.

Author: kofrezo

adminapi/dataset.py

@@ -282,6 +282,8 @@ def commit(self):
         for obj in self:
             obj._confirm_changes()
 
+        return result['commit_id']
+
     def _fetch_results(self):
         request_data = {'filters': self._filters}
         if self._restrict is not None:
@@ -489,6 +491,8 @@ def commit(self):
 
         self._confirm_changes()
 
+        return result['commit_id']
+
 
 class MultiAttr(set):
     """This class must redefine all mutable methods of the set class

serveradmin/api/views.py

@@ -99,7 +99,7 @@ def dataset_commit(request, app, data):
             kwargs[key] = value
 
     try:
-        commit_query(app=app, **kwargs)
+        _, commit_id = commit_query(app=app, **kwargs)
     except ValidationError as error:
         return {
             'status': 'error',
@@ -109,6 +109,7 @@ def dataset_commit(request, app, data):
 
     return {
         'status': 'success',
+        'commit_id': commit_id,
     }
 
 

serveradmin/dataset.py

@@ -18,8 +18,9 @@ def _fetch_new_object(self, servertype):
 
     def commit(self, app=None, user=None):
         commit_obj = self._build_commit_object()
-        commit_query(app=app, user=user, **commit_obj)
+        _, commit_id = commit_query(app=app, user=user, **commit_obj)
         self._confirm_changes()
+        return commit_id
 
     def _fetch_results(self):
         return execute_query(self._filters, self._restrict, self._order_by)
@@ -28,5 +29,6 @@ def _fetch_results(self):
 class DatasetObject(ApiDatasetObject):
     def commit(self, app=None, user=None):
         commit_obj = self._build_commit_object()
-        commit_query(app=app, user=user, **commit_obj)
+        _, commit_id = commit_query(app=app, user=user, **commit_obj)
         self._confirm_changes()
+        return commit_id

serveradmin/serverdb/query_committer.py

@@ -129,7 +129,7 @@ def commit_query(created=[], changed=[], deleted=[], app=None, user=None):
             created_objects, changed_objects, deleted_objects
         )
 
-        _log_changes(user, app, changed, created_objects, deleted_objects)
+        commit_id = _log_changes(user, app, changed, created_objects, deleted_objects)
 
     post_commit.send_robust(
         commit_query, created=created, changed=changed, deleted=deleted
@@ -139,7 +139,7 @@ def commit_query(created=[], changed=[], deleted=[], app=None, user=None):
         list(created_objects.values()),
         list(changed_objects.values()),
         list(deleted_objects.values()),
-    )
+    ), commit_id
 
 
 def _validate(attribute_lookup, changed, changed_objects):
@@ -467,7 +467,7 @@ def _acl_violations(touched_objects, pending_changes, acl):
     return violations or None
 
 
-def _log_changes(user, app, changed, created_objects, deleted_objects):
+def _log_changes(user, app, changed, created_objects, deleted_objects) -> int:
     changes = list()
     commit = ChangeCommit(user=user, app=app)
 
@@ -504,6 +504,8 @@ def _log_changes(user, app, changed, created_objects, deleted_objects):
         commit.save()
         Change.objects.bulk_create(changes)
 
+    return commit.id
+
 
 def _fetch_servers(object_ids):
     servers = {

serveradmin/serverdb/views.py

@@ -183,8 +183,8 @@ def recreate(request, change_id):
             server_object.pop(attribute_id)
 
     try:
-        commit = commit_query([server_object], user=request.user)
-        object_id = str(commit.created[0]['object_id'])
+        changes_obj, _ = commit_query([server_object], user=request.user)
+        object_id = str(changes_obj.created[0]['object_id'])
     except (CommitError, ValidationError) as error:
         messages.error(request, str(error))
         return redirect(reverse('serverdb_changes'))

serveradmin/servershell/views.py

@@ -315,8 +315,7 @@ def _edit(request: HttpRequest, server, edit_mode=False, template='edit'):  # NO
                 messages.info(request, str('Nothing has changed.'))
             else:
                 try:
-                    commit_obj = commit_query(created, changed,
-                                              user=request.user)
+                    commit_obj, _ = commit_query(created, changed, user=request.user)
                 except (PermissionDenied, ValidationError) as err:
                     messages.error(request, str(err))
                 else: