girder 5.0.7.dev2__tar.gz → 5.0.7.dev4__tar.gz

{girder-5.0.7.dev2/girder.egg-info → girder-5.0.7.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: girder
-Version: 5.0.7.dev2
+Version: 5.0.7.dev4
 Summary: Web-based data management platform
 Home-page: https://girder.readthedocs.org
 Author: Kitware, Inc.

{girder-5.0.7.dev2 → girder-5.0.7.dev4}/docs/migration-guide.rst

@@ -137,6 +137,55 @@ to run the local worker is:
 
     celery -A girder_worker.app worker -Q local
 
+Event handlers for ``local``-queue work
++++++++++++++++++++++++++++++++++++++++
+
+Many operations that previously ran synchronously in the Girder web process are now
+enqueued as Celery tasks on the ``local`` queue. For example, the assetstore import
+handler calls ``importDataTask.delay(...)`` rather than Girder 3.x's ``Assetstore().importData(...)`` in
+the request thread. Model events such as ``s3_assetstore_imported``,
+``filesystem_assetstore_imported``, and ``assetstore_import.after`` are still triggered, but
+they fire in **whichever process runs the import**—typically a Celery worker, not the web
+server.
+
+``events.bind`` calls made in a :py:class:`~girder.plugin.GirderPlugin` ``load`` method only
+apply to the Girder web process. Many events still fire there as before, especially REST
+events (``rest.*.before``, ``rest.*.after``, and so on). The worker does not load server
+plugins instead it discovers task modules through the ``girder_worker_plugins`` entry point (see
+:py:class:`girder_worker.GirderWorkerPluginABC`). If your handlers must run when code
+executes on the ``local`` queue (for example during ``importDataTask``), register them in a
+worker plugin subclass instead of only in ``load``, binding them in ``__init__`` when the
+worker starts. For example, the Import Tracker plugin binds
+``assetstore_import.before``, ``assetstore_import.after``, and ``assetstore_import.error`` in
+``ImportTrackerWorkerPlugin.__init__`` (see
+``plugins/import_tracker/girder_import_tracker/girder_worker_plugin.py``).
+
+Below is an example of a worker plugin that registers event handlers for the ``local`` queue.
+
+.. code-block:: python
+
+    from girder import events
+    from girder_worker import GirderWorkerPluginABC
+
+    from my_plugin.handlers import on_s3_imported, on_import_finished
+
+
+    class MyPluginWorker(GirderWorkerPluginABC):
+        def __init__(self, app, *args, **kwargs):
+            events.bind(
+                's3_assetstore_imported',
+                'my_plugin_s3_imported',
+                on_s3_imported,
+            )
+            events.bind(
+                'assetstore_import.after',
+                'my_plugin_import_after',
+                on_import_finished,
+            )
+
+        def task_imports(self):
+            return ['my_plugin.tasks']
+
 Overhaul of notifications system switch from WSGI to ASGI
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 

{girder-5.0.7.dev2 → girder-5.0.7.dev4/girder.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: girder
-Version: 5.0.7.dev2
+Version: 5.0.7.dev4
 Summary: Web-based data management platform
 Home-page: https://girder.readthedocs.org
 Author: Kitware, Inc.