Offload slow file operations to threads for snapshots and project "save as". Ref #1187 #1307.

gns3server/controller/snapshot.py

@@ -19,11 +19,13 @@
 import os
 import uuid
 import shutil
+import tempfile
 import asyncio
 import aiohttp.web
 from datetime import datetime, timezone
 
-
+from ..utils.asyncio import wait_run_in_executor
+from .export_project import export_project
 from .import_project import import_project
 
 
@@ -71,6 +73,37 @@ class Snapshot:
     def created_at(self):
         return int(self._created_at)
 
+    def _create_snapshot_file(self, zipstream):
+        """
+        Creates the snapshot file (to be run in its own thread)
+        """
+
+        with open(self.path, "wb") as f:
+            for data in zipstream:
+                f.write(data)
+
+    @asyncio.coroutine
+    def create(self):
+        """
+        Create the snapshot
+        """
+
+        if os.path.exists(self.path):
+            raise aiohttp.web.HTTPConflict(text="The snapshot file '{}' already exists".format(self.name))
+
+        snapshot_directory = os.path.join(self._project.path, "snapshots")
+        try:
+            os.makedirs(snapshot_directory, exist_ok=True)
+        except OSError as e:
+            raise aiohttp.web.HTTPInternalServerError(text="Could not create the snapshot directory '{}': {}".format(snapshot_directory, e))
+
+        try:
+            with tempfile.TemporaryDirectory() as tmpdir:
+                zipstream = yield from export_project(self._project, tmpdir, keep_compute_id=True, allow_all_nodes=True)
+                yield from wait_run_in_executor(self._create_snapshot_file, zipstream)
+        except OSError as e:
+            raise aiohttp.web.HTTPConflict(text="Could not create snapshot file '{}': {}".format(self.path, e))
+
     @asyncio.coroutine
     def restore(self):
         """
@@ -78,18 +111,21 @@ class Snapshot:
         """
 
         yield from self._project.delete_on_computes()
-        # We don't send close notif to clients because the close / open dance is purely internal
+        # We don't send close notification to clients because the close / open dance is purely internal
         yield from self._project.close(ignore_notification=True)
-        self._project.controller.notification.emit("snapshot.restored", self.__json__())
+
         try:
-            if os.path.exists(os.path.join(self._project.path, "project-files")):
-                shutil.rmtree(os.path.join(self._project.path, "project-files"))
+            # delete the current project files
+            project_files_path = os.path.join(self._project.path, "project-files")
+            if os.path.exists(project_files_path):
+                yield from wait_run_in_executor(shutil.rmtree, project_files_path)
             with open(self._path, "rb") as f:
                 project = yield from import_project(self._project.controller, self._project.id, f, location=self._project.path)
         except (OSError, PermissionError) as e:
             raise aiohttp.web.HTTPConflict(text=str(e))
+        self._project.controller.notification.emit("snapshot.restored", self.__json__())
         yield from project.open()
-        return project
+        return self._project
 
     def __json__(self):
         return {