Merge pull request #20510 from nsoranzo/remove_ToolDocumentCache

Remove deprecated tool document cache

Author: mvdbeek

client/src/api/schema/schema.ts

@@ -24498,7 +24498,9 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": unknown;
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
                 };
             };
             /** @description Request Error */

doc/source/admin/galaxy_options.rst

@@ -1217,22 +1217,6 @@
 :Type: str
 
 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-``enable_tool_document_cache``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-:Description:
-    This option is deprecated, and the tool document cache will be
-    removed in the next release. Whether to enable the tool document
-    cache. This cache stores expanded XML strings. Enabling the tool
-    cache results in slightly faster startup times. The tool cache is
-    backed by a SQLite database, which cannot be stored on certain
-    network disks. The cache location is configurable with the
-    ``tool_cache_data_dir`` tag in tool config files.
-:Default: ``false``
-:Type: bool
-
-
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 ``tool_search_index_dir``
 ~~~~~~~~~~~~~~~~~~~~~~~~~

lib/galaxy/app.py

@@ -788,7 +788,6 @@ def __init__(self, **kwargs) -> None:
         self.datatypes_registry.load_external_metadata_tool(self.toolbox)
         # Load history import/export tools.
         load_lib_tools(self.toolbox)
-        self.toolbox.persist_cache(register_postfork=True)
         # visualizations registry: associates resources with visualizations, controls how to render
         self.visualizations_registry = self._register_singleton(
             VisualizationsRegistry,

lib/galaxy/app_unittest_utils/galaxy_mock.py

@@ -267,8 +267,6 @@ def __init__(self, **kwargs):
         self.version_major = "19.09"
 
         # set by MockDir
-        self.enable_tool_document_cache = False
-        self.tool_cache_data_dir = os.path.join(self.root, "tool_cache")
         self.external_chown_script = None
         self.check_job_script_integrity = False
         self.check_job_script_integrity_count = 0

lib/galaxy/config/sample/galaxy.yml.sample

@@ -935,15 +935,6 @@ galaxy:
   # generated commands run in sh.
   #default_job_shell: /bin/bash
 
-  # This option is deprecated, and the tool document cache will be
-  # removed in the next release. Whether to enable the tool document
-  # cache. This cache stores expanded XML strings. Enabling the tool
-  # cache results in slightly faster startup times. The tool cache is
-  # backed by a SQLite database, which cannot be stored on certain
-  # network disks. The cache location is configurable with the
-  # ``tool_cache_data_dir`` tag in tool config files.
-  #enable_tool_document_cache: false
-
   # Directory in which the toolbox search index is stored. The value of
   # this option will be resolved with respect to <data_dir>.
   #tool_search_index_dir: tool_search_index

lib/galaxy/config/schemas/config_schema.yml

@@ -882,19 +882,6 @@ mapping:
           should be disabled. Containerized jobs always use /bin/sh - so more maximum
           portability tool authors should assume generated commands run in sh.
 
-      enable_tool_document_cache:
-        type: bool
-        default: false
-        required: false
-        desc: |
-          This option is deprecated, and the tool document cache will be removed
-          in the next release.
-          Whether to enable the tool document cache. This cache stores
-          expanded XML strings. Enabling the tool cache results in slightly faster startup
-          times. The tool cache is backed by a SQLite database, which cannot
-          be stored on certain network disks. The cache location is configurable
-          with the ``tool_cache_data_dir`` tag in tool config files.
-
       tool_search_index_dir:
         type: str
         default: tool_search_index

lib/galaxy/dependencies/pinned-requirements.txt

@@ -187,7 +187,6 @@ social-auth-core==4.7.0
 sortedcontainers==2.4.0
 spython==0.3.14
 sqlalchemy==2.0.40
-sqlitedict==2.1.0
 sqlparse==0.5.3
 starlette==0.47.2
 starlette-context==0.4.0

lib/galaxy/managers/tools.py

@@ -53,10 +53,10 @@ def tool_payload_to_tool(app, tool_dict: Dict[str, Any]) -> Optional[Tool]:
     return tool
 
 
-class DynamicToolManager(ModelManager[model.DynamicTool]):
+class DynamicToolManager(ModelManager[DynamicTool]):
     """Manages dynamic tools stored in Galaxy's database."""
 
-    model_class = model.DynamicTool
+    model_class = DynamicTool
 
     def ensure_can_use_unprivileged_tool(self, user: model.User):
         stmt = select(
@@ -70,7 +70,7 @@ def ensure_can_use_unprivileged_tool(self, user: model.User):
         if not self.session().execute(stmt).scalar():
             raise exceptions.InsufficientPermissionsException("User is not allowed to run unprivileged tools")
 
-    def get_tool_by_id_or_uuid(self, id_or_uuid: Union[int, str]):
+    def get_tool_by_id_or_uuid(self, id_or_uuid: Union[int, str]) -> Union[DynamicTool, None]:
         if isinstance(id_or_uuid, int):
             return self.get_tool_by_id(id_or_uuid)
         else:
@@ -213,9 +213,10 @@ def deactivate_unprivileged_tool(self, user: model.User, dynamic_tool: DynamicTo
         session.execute(update_stmt)
         session.commit()
 
-    def deactivate(self, dynamic_tool):
-        self.update(dynamic_tool, {"active": False})
-        return dynamic_tool
+    def deactivate(self, dynamic_tool: DynamicTool) -> DynamicTool:
+        assert isinstance(dynamic_tool.uuid, UUID)
+        del self.app.toolbox._tools_by_uuid[dynamic_tool.uuid]
+        return self.update(dynamic_tool, {"active": False})
 
 
 class ToolFilterMixin:

lib/galaxy/model/__init__.py

@@ -341,7 +341,7 @@ def get_uuid(uuid: Optional[Union[UUID, str]] = None) -> UUID:
         return uuid
     if not uuid:
         return uuid4()
-    return UUID(str(uuid))
+    return UUID(uuid)
 
 
 def to_json(sa_session, column, keys: List[str]):

lib/galaxy/queue_worker.py

@@ -11,7 +11,10 @@
 import threading
 import time
 from inspect import ismodule
-from typing import TYPE_CHECKING
+from typing import (
+    Optional,
+    TYPE_CHECKING,
+)
 
 from kombu import (
     Consumer,
@@ -33,10 +36,14 @@
 log = logging.getLogger(__name__)
 
 if TYPE_CHECKING:
-    from galaxy.structured_app import MinimalManagerApp
+    from galaxy.app import UniverseApplication
+    from galaxy.structured_app import (
+        MinimalManagerApp,
+        StructuredApp,
+    )
 
 
-def send_local_control_task(app, task, get_response=False, kwargs=None):
+def send_local_control_task(app: "StructuredApp", task: str, get_response: bool = False, kwargs: Optional[dict] = None):
     """
     This sends a message to the process-local control worker, which is useful
     for one-time asynchronous tasks like recalculating user disk usage.
@@ -162,7 +169,7 @@ def reload_tool(app, **kwargs):
         log.error("Reload tool invoked without tool id.")
 
 
-def reload_toolbox(app, save_integrated_tool_panel=True, **kwargs):
+def reload_toolbox(app: "UniverseApplication", save_integrated_tool_panel: bool = True, **kwargs) -> None:
     reload_timer = util.ExecutionTimer()
     log.debug("Executing toolbox reload on '%s'", app.config.server_name)
     reload_count = app.toolbox._reload_count
@@ -174,7 +181,7 @@ def reload_toolbox(app, save_integrated_tool_panel=True, **kwargs):
     log.debug("Toolbox reload %s", reload_timer)
 
 
-def _get_new_toolbox(app, save_integrated_tool_panel=True):
+def _get_new_toolbox(app: "UniverseApplication", save_integrated_tool_panel: bool = True) -> None:
     """
     Generate a new toolbox, by constructing a toolbox from the config files,
     and then adding pre-existing data managers from the old toolbox to the new toolbox.
@@ -188,9 +195,9 @@ def _get_new_toolbox(app, save_integrated_tool_panel=True):
     app.datatypes_registry.load_datatype_converters(new_toolbox, use_cached=True)
     app.datatypes_registry.load_external_metadata_tool(new_toolbox)
     load_lib_tools(new_toolbox)
-    [new_toolbox.register_tool(tool) for tool in new_toolbox.data_manager_tools.values()]
+    for tool in new_toolbox.data_manager_tools.values():
+        new_toolbox.register_tool(tool)
     app._toolbox = new_toolbox
-    app.toolbox.persist_cache()
 
 
 def reload_data_managers(app, **kwargs):