feat: add tool filter #6951

edwinjosechittilappilly · 2025-03-06T16:35:59Z

This pull request includes changes to enhance the tool metadata management by introducing a status flag and enabling dynamic filtering of tools based on their status. The most important changes include the addition of a status field to the tool metadata, modifications to filter tools based on their status, and the introduction of methods to manage the list of enabled tools.

Enhancements to tool metadata management:

src/backend/base/langflow/base/tools/constants.py: Added a new metadata field status to indicate whether a tool is active.

Dynamic filtering of tools:

src/backend/base/langflow/base/tools/component_tool.py: Updated update_tools_metadata method to filter tools based on their status and return only active tools. [1] [2]

Management of enabled tools:

src/backend/base/langflow/custom/custom_component/component.py: Introduced _enabled_tools class variable and methods set_enabled_tools and get_enabled_tools to manage the list of enabled tools. [1] [2]
src/backend/base/langflow/custom/custom_component/component.py: Added _filter_tools_by_status method to filter tools based on their status and the list of enabled tools.
src/backend/base/langflow/custom/custom_component/component.py: Implemented to_toolkit method to convert components to a list of tools, incorporating the new status-based filtering logic.

…(`feat-add-tool-filter`) Here's the optimized version of the Python program. In this revision, I applied the Walrus operator (`:=`) to avoid an additional lookup for the "tags" key in the dictionary, making the loop condition more direct and slightly improving performance.

codeflash-ai · 2025-03-06T16:47:38Z

src/backend/base/langflow/custom/custom_component/component.py

+
+    def _extract_tools_tags(self, tools_metadata: list[dict]) -> list[str]:
+        """Extract the first tag from each tool's metadata."""
+        return [tool["tags"][0] for tool in tools_metadata if tool["tags"]]


Suggested change

return [tool["tags"][0] for tool in tools_metadata if tool["tags"]]

return [tags[0] for tool in tools_metadata if (tags := tool["tags"])]

codeflash-ai · 2025-03-06T16:47:41Z

⚡️ Codeflash found optimizations for this PR

📄 19% (0.19x) speedup for `Component._extract_tools_tags` in `src/backend/base/langflow/custom/custom_component/component.py`

⏱️ Runtime : 312 microseconds → 262 microseconds (best of 36 runs)

📝 Explanation and details

Here's the optimized version of the Python program.

In this revision, I applied the Walrus operator (:=) to avoid an additional lookup for the "tags" key in the dictionary, making the loop condition more direct and slightly improving performance.

✅ Correctness verification report:

Test	Status
⚙️ Existing Unit Tests	🔘 None Found
🌀 Generated Regression Tests	✅ 29 Passed
⏪ Replay Tests	🔘 None Found
🔎 Concolic Coverage Tests	🔘 None Found
📊 Tests Coverage	undefined

🌀 Generated Regression Tests Details

from __future__ import annotations

from copy import deepcopy
from typing import Any

import nanoid
# imports
import pytest  # used for our unit tests
from langflow.custom.custom_component.component import Component
from langflow.custom.custom_component.custom_component import CustomComponent
from langflow.events.event_manager import EventManager
from langflow.graph.edge.schema import EdgeData
from langflow.inputs.inputs import InputTypes
from langflow.services.tracing.schema import Log
from langflow.template.field.base import Output
from langflow.utils.async_helpers import run_until_complete


# unit tests
def test_basic_functionality():
    component = Component()
    codeflash_output = component._extract_tools_tags([{"tags": ["tag1"]}])
    codeflash_output = component._extract_tools_tags([{"tags": ["tag1"]}, {"tags": ["tag2"]}])
    codeflash_output = component._extract_tools_tags([{"tags": ["tag1", "tag2"]}, {"tags": ["tag3", "tag4"]}])

def test_edge_cases():
    component = Component()
    codeflash_output = component._extract_tools_tags([])
    codeflash_output = component._extract_tools_tags([{"tags": []}])
    codeflash_output = component._extract_tools_tags([{}])
    codeflash_output = component._extract_tools_tags([{"tags": ["tag1"]}, {"tags": []}, {}, {"tags": ["tag2"]}])

def test_complex_cases():
    component = Component()
    codeflash_output = component._extract_tools_tags([{"tags": [["nested_tag"]]}])
    codeflash_output = component._extract_tools_tags([{"tags": [123]}])
    codeflash_output = component._extract_tools_tags([{"tags": ["tag1", 123]}, {"tags": [456, "tag2"]}])

def test_large_scale_cases():
    component = Component()
    codeflash_output = component._extract_tools_tags([{"tags": ["tag" + str(i)]} for i in range(1000)])
    codeflash_output = component._extract_tools_tags([{"tags": ["tag" + str(i) for i in range(1000)]}])

def test_unusual_inputs():
    component = Component()
    with pytest.raises(TypeError):
        component._extract_tools_tags([{"tags": ["tag1"]}, "not_a_dict", {"tags": ["tag2"]}])
    with pytest.raises(TypeError):
        component._extract_tools_tags([{"tags": ["tag1"]}, 123, {"tags": ["tag2"]}, None])
# codeflash_output is used to check that the output of the original code is the same as that of the optimized code.

from __future__ import annotations

from copy import deepcopy
from typing import Any

import nanoid
# imports
import pytest  # used for our unit tests
from langflow.custom.custom_component.component import Component
from langflow.custom.custom_component.custom_component import CustomComponent
from langflow.events.event_manager import EventManager
from langflow.graph.edge.schema import EdgeData
from langflow.inputs.inputs import InputTypes
from langflow.services.tracing.schema import Log
from langflow.template.field.base import Output
from langflow.utils.async_helpers import run_until_complete


# unit tests
@pytest.fixture
def component():
    return Component()

def test_single_tool_with_tags(component):
    tools_metadata = [{"tags": ["tag1", "tag2"]}]
    codeflash_output = component._extract_tools_tags(tools_metadata)

def test_multiple_tools_with_tags(component):
    tools_metadata = [{"tags": ["tag1", "tag2"]}, {"tags": ["tagA", "tagB"]}]
    codeflash_output = component._extract_tools_tags(tools_metadata)

def test_empty_list(component):
    tools_metadata = []
    codeflash_output = component._extract_tools_tags(tools_metadata)

def test_tool_without_tags(component):
    tools_metadata = [{"tags": []}]
    codeflash_output = component._extract_tools_tags(tools_metadata)

def test_mixed_tags_and_no_tags(component):
    tools_metadata = [{"tags": ["tag1"]}, {"tags": []}, {"tags": ["tag2"]}]
    codeflash_output = component._extract_tools_tags(tools_metadata)

def test_nested_tags(component):
    tools_metadata = [{"tags": [["nested_tag1"]]}, {"tags": ["tag2"]}]
    codeflash_output = component._extract_tools_tags(tools_metadata)

def test_tags_with_special_characters(component):
    tools_metadata = [{"tags": ["tag-1", "tag_2"]}, {"tags": ["tag@3", "tag#4"]}]
    codeflash_output = component._extract_tools_tags(tools_metadata)

def test_large_number_of_tools(component):
    tools_metadata = [{"tags": ["tag1"]}] * 1000
    codeflash_output = component._extract_tools_tags(tools_metadata)

def test_large_number_of_tags_in_a_tool(component):
    tools_metadata = [{"tags": ["tag" + str(i) for i in range(1000)]}]
    codeflash_output = component._extract_tools_tags(tools_metadata)

def test_combination_of_large_number_of_tools_and_tags(component):
    tools_metadata = [{"tags": ["tag" + str(i) for i in range(100)]} for _ in range(1000)]
    codeflash_output = component._extract_tools_tags(tools_metadata)

def test_non_dictionary_elements(component):
    tools_metadata = ["not_a_dict"]
    with pytest.raises(TypeError):
        component._extract_tools_tags(tools_metadata)



def test_single_tool_with_single_tag(component):
    tools_metadata = [{"tags": ["single_tag"]}]
    codeflash_output = component._extract_tools_tags(tools_metadata)

def test_single_tool_with_maximum_length_tag(component):
    tools_metadata = [{"tags": ["a" * 1000]}]
    codeflash_output = component._extract_tools_tags(tools_metadata)

def test_tools_with_empty_strings_as_tags(component):
    tools_metadata = [{"tags": [""]}, {"tags": ["tag1"]}]
    codeflash_output = component._extract_tools_tags(tools_metadata)

def test_extremely_large_data_set(component):
    tools_metadata = [{"tags": ["tag" + str(i) for i in range(1000)]} for _ in range(1000)]
    codeflash_output = component._extract_tools_tags(tools_metadata)

def test_high_complexity_tags(component):
    tools_metadata = [{"tags": ["tag" + "a" * i for i in range(1000)]}]
    codeflash_output = component._extract_tools_tags(tools_metadata)
# codeflash_output is used to check that the output of the original code is the same as that of the optimized code.

To test or edit this optimization locally git merge codeflash/optimize-pr6951-2025-03-06T16.47.32

codspeed-hq · 2025-03-06T16:50:36Z

CodSpeed Performance Report

Merging #6951 will improve performances by 71.24%

_{Comparing feat-add-tool-filter (fb741cb) with main (a8f4090)}

Summary

⚡ 1 improvements
✅ 18 untouched benchmarks

Benchmarks breakdown

	Benchmark	`BASE`	`HEAD`	Change
⚡	`test_cancel_nonexistent_build`	13.6 ms	7.9 ms	+71.24%

Copilot

PR Overview

This pull request enhances tool metadata management by introducing a new status field and dynamic filtering of tools based on their status, as well as methods to manage a list of enabled tools.

Add a boolean "status" field to tool metadata to indicate tool activity.
Introduce class-level methods (set_enabled_tools and get_enabled_tools) and a filtering mechanism (_filter_tools_by_status) in custom components.
Update tool metadata processing in component_tool.py to filter out tools with inactive status.

Reviewed Changes

File	Description
src/backend/base/langflow/custom/custom_component/component.py	New methods for managing enabled tools and status-based filtering.
src/backend/base/langflow/base/tools/constants.py	Added new "status" metadata field to tools constants.
src/backend/base/langflow/base/tools/component_tool.py	Updated metadata filtering logic based on tool status.

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (2)

src/backend/base/langflow/base/tools/component_tool.py:311

Using the '|' operator in isinstance() checks is not supported. Replace it with a tuple: isinstance(tool, (StructuredTool, BaseTool)).

if isinstance(tool, StructuredTool | BaseTool) and tool.tags:

src/backend/base/langflow/custom/custom_component/component.py:1112

[nitpick] The nested conditional logic in _build_tools_metadata_input is somewhat complex; consider refactoring or adding inline comments to improve readability and maintainability.

if self.check_for_tool_tag_change(old_tags, new_tags):

Copilot · 2025-03-06T18:16:53Z

src/backend/base/langflow/base/tools/constants.py

+        "display_name": "Status",
+        "type": "boolean",
+        "description": "Indicates whether the tool is currently active. Set to True to activate this tool.",
+        "default": "False",


The default value for the 'status' field is set as a string "False" even though the type is boolean. Replace it with the boolean value False.

Suggested change

"default": "False",

"default": False,

edwinjosechittilappilly · 2025-03-06T18:21:18Z

https://www.loom.com/share/c4cf198a002244f3ac060fa2098d9a00?sid=4fc8234d-e0f5-4c68-9987-ea35a317aed2

edwinjosechittilappilly · 2025-03-06T18:21:59Z

Merge only after #6935

ogabrielluiz

We definitely need tests for these.

ogabrielluiz · 2025-03-10T14:22:02Z

src/backend/base/langflow/base/tools/constants.py

+        "display_name": "Status",
+        "type": "boolean",
+        "description": "Indicates whether the tool is currently active. Set to True to activate this tool.",
+        "default": "False",


Should this be set to True by default instead? I think it shouldn't have quotes either.

ogabrielluiz · 2025-03-10T14:24:40Z

src/backend/base/langflow/base/tools/constants.py

@@ -35,6 +35,14 @@
        "edit_mode": EditMode.INLINE,
        "hidden": True,
    },
+    {
+        "name": "status",
+        "display_name": "Status",


I think we need a more descriptive name for this. Enabled or Active.. something like that.

Instead of status right?

Co-authored-by: Copilot <[email protected]>

github-actions bot added the enhancement New feature or request label Mar 6, 2025

codeflash-ai bot reviewed Mar 6, 2025

View reviewed changes

github-actions bot added enhancement New feature or request and removed enhancement New feature or request labels Mar 6, 2025

edwinjosechittilappilly changed the base branch from main to fix-tool-mode-refresh-issues March 6, 2025 18:14

github-actions bot added enhancement New feature or request and removed enhancement New feature or request labels Mar 6, 2025

edwinjosechittilappilly requested a review from Copilot March 6, 2025 18:15

Copilot AI reviewed Mar 6, 2025

View reviewed changes

edwinjosechittilappilly marked this pull request as ready for review March 6, 2025 18:21

dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Mar 6, 2025

edwinjosechittilappilly requested a review from ogabrielluiz March 6, 2025 18:21

github-actions bot added enhancement New feature or request and removed enhancement New feature or request labels Mar 6, 2025

edwinjosechittilappilly self-assigned this Mar 7, 2025

edwinjosechittilappilly force-pushed the feat-add-tool-filter branch from 8ba5844 to 43d2511 Compare March 8, 2025 09:14

github-actions bot added enhancement New feature or request and removed enhancement New feature or request labels Mar 8, 2025

ogabrielluiz requested changes Mar 10, 2025

View reviewed changes

Base automatically changed from fix-tool-mode-refresh-issues to main March 10, 2025 14:57

github-actions bot removed the enhancement New feature or request label Mar 10, 2025

edwinjosechittilappilly and others added 19 commits March 10, 2025 13:59

fix the update real time table refresh issues.

71d9496

Update src/backend/base/langflow/custom/custom_component/component.py

8dfaa09

Co-authored-by: Copilot <[email protected]>

[autofix.ci] apply automated fixes

33aba8b

[autofix.ci] apply automated fixes

06107c9

Update component.py

c1a6ece

Update component.py

11596f8

format errors

02c1d85

[autofix.ci] apply automated fixes

2e1e4e1

Update index.tsx

55e0204

[autofix.ci] apply automated fixes

e74938e

lint error fix

7120573

[autofix.ci] apply automated fixes

e84d56c

fix format issue

a813470

[autofix.ci] apply automated fixes

d96bc19

fix typing.override does not exist in your Python version

c433ef6

filter added

e44e727

Update index.tsx

8fec729

[autofix.ci] apply automated fixes

cc2e528

update variables

98adfc9

edwinjosechittilappilly force-pushed the feat-add-tool-filter branch from aa3191f to 98adfc9 Compare March 10, 2025 18:08

dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Mar 10, 2025

github-actions bot added enhancement New feature or request and removed enhancement New feature or request labels Mar 10, 2025

modify tool filter

fb741cb

github-actions bot added enhancement New feature or request and removed enhancement New feature or request labels Mar 10, 2025

added dynamic property to set the tools in a better effective way

e1d3885

github-actions bot added enhancement New feature or request and removed enhancement New feature or request labels Mar 10, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add tool filter #6951

feat: add tool filter #6951

edwinjosechittilappilly commented Mar 6, 2025 •

edited

Loading

codeflash-ai bot Mar 6, 2025

codeflash-ai bot commented Mar 6, 2025

codspeed-hq bot commented Mar 6, 2025 •

edited

Loading

Copilot AI left a comment

Copilot AI Mar 6, 2025

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

edwinjosechittilappilly commented Mar 6, 2025

edwinjosechittilappilly commented Mar 6, 2025

ogabrielluiz left a comment

ogabrielluiz Mar 10, 2025

ogabrielluiz Mar 10, 2025

edwinjosechittilappilly Mar 10, 2025

	return [tool["tags"][0] for tool in tools_metadata if tool["tags"]]
	return [tags[0] for tool in tools_metadata if (tags := tool["tags"])]

feat: add tool filter #6951

Are you sure you want to change the base?

feat: add tool filter #6951

Conversation

edwinjosechittilappilly commented Mar 6, 2025 • edited Loading

codeflash-ai bot Mar 6, 2025

Choose a reason for hiding this comment

codeflash-ai bot commented Mar 6, 2025

⚡️ Codeflash found optimizations for this PR

📄 19% (0.19x) speedup for Component._extract_tools_tags in src/backend/base/langflow/custom/custom_component/component.py

codspeed-hq bot commented Mar 6, 2025 • edited Loading

CodSpeed Performance Report

Merging #6951 will improve performances by 71.24%

Summary

Benchmarks breakdown

Copilot AI left a comment

Choose a reason for hiding this comment

PR Overview

Reviewed Changes

Copilot AI Mar 6, 2025

Choose a reason for hiding this comment

edwinjosechittilappilly commented Mar 6, 2025

edwinjosechittilappilly commented Mar 6, 2025

ogabrielluiz left a comment

Choose a reason for hiding this comment

ogabrielluiz Mar 10, 2025

Choose a reason for hiding this comment

ogabrielluiz Mar 10, 2025

Choose a reason for hiding this comment

edwinjosechittilappilly Mar 10, 2025

Choose a reason for hiding this comment

edwinjosechittilappilly commented Mar 6, 2025 •

edited

Loading

📄 19% (0.19x) speedup for `Component._extract_tools_tags` in `src/backend/base/langflow/custom/custom_component/component.py`

codspeed-hq bot commented Mar 6, 2025 •

edited

Loading