Remove deprecated tool document cache #20510
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also: - Small refactorings
Fix the following API test failure:
```
______________________ TestToolsApi.test_tool_deactivate _______________________
self = <galaxy_test.api.test_tools.TestToolsApi object at 0x7f4808a67b50>
def test_tool_deactivate(self):
# Create tool.
tool_response = self.dataset_populator.create_tool(MINIMAL_TOOL_NO_ID)
self._assert_has_keys(tool_response, "id", "uuid", "active")
assert tool_response["active"]
deactivate_response = self.dataset_populator.deactivate_dynamic_tool(tool_response["uuid"])
assert not deactivate_response["active"]
# Run tool.
history_id = self.dataset_populator.new_history()
response = self._run(history_id=history_id, tool_uuid=tool_response["uuid"], assert_ok=False)
# Get a 404 when trying to run a deactivated tool.
> self._assert_status_code_is(response, 404)
...
E AssertionError: Request status code (200) was not expected value 404.
```
caused by this addition in the previous commit in
`lib/galaxy/tool_util/toolbox/base.py::AbstractToolBox.get_tool()`:
```python
+ tool_uuid = tool_uuid if isinstance(tool_uuid, UUID) else UUID(tool_uuid)
tool_from_uuid = self._get_tool_by_uuid(tool_uuid)
```
Before this change, `tool_uuid` was passed to `self._get_tool_by_uuid()`
as a string instead of being transformed into a UUID. This meant that
in:
```python
def _get_tool_by_uuid(self, tool_uuid: UUID) -> Union["Tool", None]:
if tool_uuid in self._tools_by_uuid:
return self._tools_by_uuid[tool_uuid]
dynamic_tool = self.app.dynamic_tool_manager.get_tool_by_uuid(tool_uuid)
if dynamic_tool:
return self.load_dynamic_tool(dynamic_tool)
return None
```
the first `if` would always fail (because the `_tools_by_uuid` dict
keys are UUIDs), the dynamic tool would then be loaded from
the database again, and the `active` attribute would be correctly
checked in `load_dynamic_tool()`.
After the mentioned change, the `tool_uuid` is instead correctly
found in the `_tools_by_uuid` dict, but the `active` attribute is
never checked.
Therefore the fix is to remove a dynamic tool from `_tools_by_uuid`
when it is deactivated.
nsoranzo
added
kind/enhancement
kind/refactoring
github-actions
bot
added
area/documentation
area/API
area/admin
area/database
|
Failing tests unrelated. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Close #20432 .
Also:
toolbox._tools_by_uuiddict when deactivated (see commit for details)How to test the changes?
(Select all options that apply)
License