girder 5.0.23.dev5__tar.gz → 5.0.24.dev2__tar.gz

{girder-5.0.23.dev5 → girder-5.0.24.dev2}/.circleci/config.yml

@@ -169,7 +169,10 @@ jobs:
       - build-plugins
       - run:
           name: Run pytest tests
-          command: tox -e pytest_circleci -- -x
+          command: |
+            # tox refuses to stage packages in group/world-writable directories
+            umask 0022
+            tox -e pytest_circleci -- -x
           working_directory: girder
       - store_test_results:
           path: girder/build/test/results

{girder-5.0.23.dev5 → girder-5.0.24.dev2}/PKG-INFO

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

{girder-5.0.23.dev5 → girder-5.0.24.dev2}/docs/plugins.rst

@@ -402,6 +402,51 @@ instead. The potential error values are:
   current authentication policy.
 
 
+Local Checkout
+--------------
+`PyPI package <https://pypi.org/project/girder-local-checkout/>`__: ``girder-local-checkout``
+
+Data on an S3 assetstore is slower to access than data on a filesystem assetstore.  This plugin
+lets users with write access to a folder temporarily "checkout" the folder: every file in the
+folder (recursively) whose data lives on an S3 assetstore is copied to a filesystem assetstore for
+a chosen number of days, and Girder serves the local copy while the checkout lasts.  Files added to
+the folder after a checkout are not copied until the checkout is renewed.
+
+The folder actions menu gains a **Make files local** item.  Choosing it shows how many files can
+be made local, how many already are, and, for a checked-out folder, the days remaining.  The
+duration can be lengthened or shortened, or the checkout released; copying and releasing happen in
+background tasks on the ``local`` worker queue, so a worker must be available.
+
+Each checkout is tracked per folder.  A file keeps its local copy until the latest expiration of
+every checkout that covers it, so checking out a parent folder for a short time never shortens a
+longer checkout of a subfolder.  When a file's local copy is released, the file once again refers
+to its S3 data; deleting or replacing a checked-out file removes both the local copy and the S3
+data.  An S3 assetstore cannot be deleted while a checked-out file's original data is on it.
+
+Expired checkouts are cleaned up daily, before each new checkout, and on demand via
+``POST /local_checkout/cleanup``.  Free space on the filesystem assetstore is computed with the
+``GIRDER_FILESYSTEMASSETSTORE_RESERVED_MBYTES`` reservation applied.  If a checkout needs more space
+than is free, local copies that expire sooner than the new checkout are released first; if there
+is still not enough room, the checkout is left partial and says so.  Likewise, an upload to the
+filesystem assetstore that would not otherwise fit releases local copies, soonest-expiring first,
+rather than failing.
+
+Administrators can list all checkouts, the files and space they use, and each assetstore's free
+space with ``GET /local_checkout``.  The plugin's configuration page shows the same summary and
+has these settings:
+
+* **Assetstore for local copies**: the filesystem assetstore that receives the copies.  By default
+  the current default assetstore is used.  If that is not a filesystem assetstore, the user picks
+  one of the filesystem assetstores when checking out a folder (via the ``assetstoreId``
+  parameter of ``PUT /folder/{id}/local_checkout``, which may be omitted when there is only one),
+  and the feature is unavailable only if there are no filesystem assetstores.
+* **Maximum checkout duration**: the most days a checkout may last (default 90).
+* **Only administrators may checkout folders**: restrict the feature to site administrators;
+  other users do not see the folder action.
+
+This plugin requires the Jobs plugin and currently only copies files from S3 assetstores.
+
+
 README
 ------
 `PyPI package <https://pypi.org/project/girder-readme/>`__: ``girder-readme``

{girder-5.0.23.dev5 → girder-5.0.24.dev2}/girder/models/assetstore.py

@@ -1,4 +1,5 @@
 import datetime
+import logging
 
 from girder import events
 from girder.constants import AssetstoreType, SortDir
@@ -8,6 +9,8 @@ from girder.utility.abstract_assetstore_adapter import AbstractAssetstoreAdapter
 
 from .model_base import Model
 
+logger = logging.getLogger(__name__)
+
 
 class Assetstore(Model):
     """
@@ -69,6 +72,13 @@ class Assetstore(Model):
         except (NoAssetstoreAdapter, ValidationException):
             # this assetstore is currently unreachable, so skip this step
             pass
+        except Exception:
+            # The assetstore's backend could not be reached.  There could be
+            # partial uploads, but no files.
+            logger.warning(
+                'Could not remove partial uploads from assetstore %s (%s); '
+                'deleting the assetstore anyway.',
+                assetstore.get('name'), assetstore['_id'], exc_info=True)
         # now remove the assetstore
         super().remove(assetstore)
         # If after removal there is no current assetstore, then pick a

{girder-5.0.23.dev5 → girder-5.0.24.dev2}/girder.egg-info/PKG-INFO

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

{girder-5.0.23.dev5 → girder-5.0.24.dev2}/girder.egg-info/scm_file_list.json

@@ -689,6 +689,32 @@
     "plugins/ldap/plugin_tests/ldap_test.py",
     "plugins/ldap/pyproject.toml",
     "plugins/ldap/setup.py",
+    "plugins/local_checkout/MANIFEST.in",
+    "plugins/local_checkout/README.rst",
+    "plugins/local_checkout/girder_local_checkout/__init__.py",
+    "plugins/local_checkout/girder_local_checkout/girder_worker_plugin.py",
+    "plugins/local_checkout/girder_local_checkout/models.py",
+    "plugins/local_checkout/girder_local_checkout/rest.py",
+    "plugins/local_checkout/girder_local_checkout/settings.py",
+    "plugins/local_checkout/girder_local_checkout/tasks.py",
+    "plugins/local_checkout/girder_local_checkout/utils.py",
+    "plugins/local_checkout/girder_local_checkout/web_client/main.js",
+    "plugins/local_checkout/girder_local_checkout/web_client/package-lock.json",
+    "plugins/local_checkout/girder_local_checkout/web_client/package.json",
+    "plugins/local_checkout/girder_local_checkout/web_client/stylesheets/localCheckout.styl",
+    "plugins/local_checkout/girder_local_checkout/web_client/templates/checkoutDialog.pug",
+    "plugins/local_checkout/girder_local_checkout/web_client/templates/config.pug",
+    "plugins/local_checkout/girder_local_checkout/web_client/templates/folderActions.pug",
+    "plugins/local_checkout/girder_local_checkout/web_client/tsconfig.json",
+    "plugins/local_checkout/girder_local_checkout/web_client/views/CheckoutDialog.js",
+    "plugins/local_checkout/girder_local_checkout/web_client/views/ConfigView.js",
+    "plugins/local_checkout/girder_local_checkout/web_client/vite-env.d.ts",
+    "plugins/local_checkout/girder_local_checkout/web_client/vite.config.ts",
+    "plugins/local_checkout/plugin.cmake",
+    "plugins/local_checkout/plugin_tests/__init__.py",
+    "plugins/local_checkout/plugin_tests/test_local_checkout.py",
+    "plugins/local_checkout/pyproject.toml",
+    "plugins/local_checkout/setup.py",
     "plugins/oauth/MANIFEST.in",
     "plugins/oauth/girder_oauth/__init__.py",
     "plugins/oauth/girder_oauth/providers/__init__.py",
@@ -1050,6 +1076,7 @@
     "test/test_api_key.py",
     "test/test_api_prefix.py",
     "test/test_asgi.py",
+    "test/test_assetstore_delete.py",
     "test/test_assetstore_model_override.py",
     "test/test_cache.py",
     "test/test_collection.py",

girder-5.0.24.dev2/girder.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "5.0.23",
+  "distance": 2,
+  "node": "g79ea3ea87dbbf4bc49d7cef5a8831d11fe4ea748",
+  "dirty": false,
+  "branch": "master",
+  "node_date": "2026-11-03"
+}

{girder-5.0.23.dev5 → girder-5.0.24.dev2}/requirements-dev.txt

@@ -15,6 +15,7 @@
 -e plugins/hashsum_download
 -e plugins/homepage
 -e plugins/item_licenses
+-e plugins/local_checkout
 -e plugins/ldap
 -e plugins/oauth
 -e plugins/readme

{girder-5.0.23.dev5 → girder-5.0.24.dev2}/scripts/publicNames.txt

@@ -452,6 +452,7 @@ girder
                 list
                 remove
                 validate
+            logger
         collection
             Collection
                 countFolders
@@ -1129,6 +1130,73 @@ plugins
                 PluginSettings
                     SERVERS
                     SETTINGS
+    local_checkout
+        girder_local_checkout
+            LocalCheckoutPlugin
+                DISPLAY_NAME
+                load
+            girder_worker_plugin
+                LocalCheckoutWorkerPlugin
+                    task_imports
+            models
+                Checkout
+                    createCheckout
+                    findByFolder
+                    initialize
+                    validate
+                CheckoutFile
+                    addCheckout
+                    computeExpires
+                    findByFile
+                    initialize
+                    validate
+                CheckoutStatus
+                    COMPLETE
+                    ERROR
+                    PARTIAL
+                    PENDING
+                    RUNNING
+            rest
+                LocalCheckout
+                    cleanup
+                    getSettings
+                    listCheckouts
+                deleteFolderCheckout
+                getFolderCheckout
+                setFolderCheckout
+            settings
+                PluginSettings
+                    ADMIN_ONLY
+                    ASSETSTORE_ID
+                    MAX_DAYS
+            tasks
+                checkoutFolderTask
+                cleanupTask
+                detachCheckoutTask
+            utils
+                CLEANUP_CHECK_INTERVAL
+                CLEANUP_INTERVAL
+                LOCATION_KEYS
+                cleanupExpired
+                cleanupIsDue
+                deleteOriginal
+                detachCheckout
+                ensureSpace
+                folderStatus
+                freeSpace
+                getAssetstoreTypes
+                getFilesystemAssetstores
+                getTargetAssetstore
+                isSourceFile
+                logger
+                makeLocal
+                makeRoomForUpload
+                releaseFile
+                removeCheckout
+                resolveCheckoutAssetstore
+                runCheckout
+                updateCheckoutExpiry
+                walkFiles
     oauth
         girder_oauth
             OAuthPlugin

girder-5.0.23.dev5/girder.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "5.0.22",
-  "distance": 5,
-  "node": "g70eb94dcdcf9f92d6e5252c83bbadc6d8c98db6b",
-  "dirty": false,
-  "branch": "master",
-  "node_date": "2026-10-28"
-}