chore(agents-api): made follow redirects and method customisable arguments for API TOOL CALL

[Vedantsahai18]

User description

…ents

---

PR Type

Enhancement, Tests

---

Description

• Added customizable method and follow_redirects arguments to API calls.

• Enhanced error handling for JSON decoding in API responses.

• Introduced a new test for method override in API calls.

• Refactored code for improved clarity and maintainability.

---

Changes walkthrough 📝

	Relevant files
Enhancement	execute_api_call.py Enhance API call customization and error handling                agents-api/agents_api/activities/execute_api_call.py Added method and follow_redirects as customizable request arguments. Improved error handling for JSON decoding failures. Refactored API call logic for better clarity. Updated headers and request arguments handling. +30/-23
Tests	test_task_execution_workflow.py Add test for API call method override                                        agents-api/tests/test_task_execution_workflow.py Added a test for API call method override functionality. Validated API call behavior with overridden method and arguments. Mocked workflow execution for testing API call steps. +88/-0

---

Need help?

Type /help how to ... in the comments thread for any questions about Qodo Merge usage.

Check out the documentation for more information.

---

Important

Enhance API call customization by adding method and follow_redirects to RequestArgs and updating execute_api_call to prioritize these arguments.

• Enhancements:
  • Added method and follow_redirects to RequestArgs in execute_api_call.py.
  • Updated execute_api_call to prioritize RequestArgs for method and follow_redirects.
• Testing:
  • Added test task execution workflow: handle api_call tool call step with Method Override in test_task_execution_workflow.py to verify method override functionality.

^{This description was created by for 6dba9c7. It will automatically update as commits are pushed.}

[entelligence-ai-pr-reviews]

LGTM 👍

[entelligence-ai-pr-reviews]

📚 Documentation Updates

I've created a pull request with documentation updates based on your changes:
#1244

The documentation updates are in branch: doc-updates-1741907879

Please review the documentation changes to ensure they accurately reflect your code changes.

[qodo-merge-pro-for-open-source]

PR Reviewer Guide 🔍

(Review updated until commit 6dba9c7)

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 PR contains tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Request Arguments Handling The new implementation pops method, url, and follow_redirects from request_args before passing the remaining arguments to the request method. This could lead to unexpected behavior if these keys exist in the original request_args but weren't intended to be removed. method=request_args.pop("method", api_call.method), url=str(request_args.pop("url", api_call.url)), headers={**arg_headers, **(api_call.headers or {})}, follow_redirects=request_args.pop( "follow_redirects", api_call.follow_redirects ), Error Handling The error handling for JSON decoding has been improved, but the outer exception handler still catches all BaseException types which is overly broad and might mask important errors like KeyboardInterrupt or SystemExit. except json.JSONDecodeError as e: response_dict["json"] = None activity.logger.debug(f"Failed to parse JSON response: {e}") return response_dict except BaseException as e:

[qodo-merge-pro-for-open-source]

PR Code Suggestions ✨

Latest suggestions up to 6dba9c7
Explore these optional code suggestions:

Category	Suggestion	Impact
General	Avoid modifying input dictionary The code is popping keys from request_args while using it, which modifies the dictionary during the request. This can lead to unexpected behavior if the dictionary is used elsewhere after this operation. Consider creating a copy of request_args before modifying it. agents-api/agents_api/activities/execute_api_call.py [36-44] +# Create a copy of request_args to avoid modifying the original +req_args = request_args.copy() response: Response = await client.request( - method=request_args.pop("method", api_call.method), - url=str(request_args.pop("url", api_call.url)), + method=req_args.pop("method", api_call.method), + url=str(req_args.pop("url", api_call.url)), headers={**arg_headers, **(api_call.headers or {})}, - follow_redirects=request_args.pop( + follow_redirects=req_args.pop( "follow_redirects", api_call.follow_redirects ), - **request_args, + **req_args, ) Apply this suggestion Suggestion importance[1-10]: 7 __ Why: The suggestion correctly identifies a potential issue where the original request_args dictionary is being modified during execution through pop() operations. Creating a copy before modification is a good practice that prevents side effects if the dictionary is used elsewhere after this function.	Medium
More

---

Previous suggestions

Suggestions up to commit 8a8c6ce

Category	Suggestion	Impact
Possible issue	Fix dictionary modification during unpacking **The code is popping keys from the request_args dictionary while it's being used as request_args in the same function call. This can lead to unpredictable behavior since dictionary unpacking happens after the individual arguments are processed, but the dictionary is being modified during the function call. agents-api/agents_api/activities/execute_api_call.py [35-43] +method = request_args.pop("method", api_call.method) +follow_redirects = request_args.pop("follow_redirects", api_call.follow_redirects) response = await client.request( - method=request_args.pop("method", api_call.method), + method=method, url=arg_url or str(api_call.url), headers={**(arg_headers or {}), **(api_call.headers or {})}, - follow_redirects=request_args.pop( - "follow_redirects", api_call.follow_redirects - ), + follow_redirects=follow_redirects, **request_args, ) Suggestion importance[1-10]: 9 __ Why: This suggestion addresses a critical issue where keys are being popped from request_args while it's simultaneously being unpacked with **request_args. This can lead to unpredictable behavior and potential bugs since dictionary modification during unpacking has undefined behavior in Python.	High

[ellipsis-dev]

👍 Looks good to me! Reviewed everything up to 8a8c6ce in 35 seconds

More details

• Looked at 29 lines of code in 1 files
• Skipped 0 files when reviewing.
• Skipped posting 5 drafted comments based on config settings.

1. agents-api/agents_api/activities/execute_api_call.py:36

• Draft comment:
  Using request_args.pop() modifies the dictionary. Verify that this mutation is acceptable and no other part of the code relies on request_args.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50%
  None

2. agents-api/agents_api/activities/execute_api_call.py:39

• Draft comment:
  Similarly, popping 'follow_redirects' from request_args changes the dictionary. Ensure this behavior is intended.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50%
  None

3. agents-api/agents_api/activities/execute_api_call.py:20

• Draft comment:
  Added keys (files, method, follow_redirects) to RequestArgs improve API flexibility. Ensure values (e.g. method and follow_redirects) are validated before passing to httpx, as httpx expects specific types (non-None for method and a boolean for follow_redirects).
• Reason this comment was not posted:
  Confidence changes required: 50% <= threshold 50%
  None

4. agents-api/agents_api/activities/execute_api_call.py:36

• Draft comment:
  Using pop('method', api_call.method) gives callers override control. Note that pop modifies the input dict – if request_args is needed later unmodified, consider working on a copy.
• Reason this comment was not posted:
  Confidence changes required: 30% <= threshold 50%
  None

5. agents-api/agents_api/activities/execute_api_call.py:39

• Draft comment:
  Similarly, extracting follow_redirects via pop allows override, but please ensure the value is a valid bool before passing to httpx to avoid unintended behavior.
• Reason this comment was not posted:
  Confidence changes required: 50% <= threshold 50%
  None

Workflow ID: wflow_mJMNeWr49TABIm40

---

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

[ellipsis-dev]

❌ Changes requested. Incremental review on a21835c in 1 minute and 39 seconds

More details

• Looked at 65 lines of code in 1 files
• Skipped 0 files when reviewing.
• Skipped posting 3 drafted comments based on config settings.

1. agents-api/agents_api/activities/execute_api_call.py:55

• Draft comment:
  Avoid catching BaseException. It's too broad and may capture system signals (e.g., KeyboardInterrupt). Consider catching Exception or a more specific exception like JSONDecodeError.
• Reason this comment was not posted:
  Comment was on unchanged code.

2. agents-api/agents_api/activities/execute_api_call.py:36

• Draft comment:
  Popping 'method' and 'url' from request_args modifies the input dict. Ensure this is intentional and doesn't affect subsequent usages.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50%
  None

3. agents-api/agents_api/activities/execute_api_call.py:55

• Draft comment:
  Catching BaseException is overly broad (it also captures system-exiting exceptions). Consider catching Exception (or a more specific exception) when parsing JSON.
• Reason this comment was not posted:
  Comment was on unchanged code.

Workflow ID: wflow_7wCDY2wBWUckkS4v

---

Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

[ellipsis-dev]

👍 Looks good to me! Incremental review on b00ac55 in 47 seconds

More details

• Looked at 99 lines of code in 1 files
• Skipped 0 files when reviewing.
• Skipped posting 4 drafted comments based on config settings.

1. agents-api/tests/test_task_execution_workflow.py:308

• Draft comment:
  Great test for overriding method from tool spec. Consider also adding a test case where the follow_redirects parameter is explicitly set (i.e., not None) to ensure that both customizable parameters are validated.
• Reason this comment was not posted:
  Confidence changes required: 0% <= threshold 50%
  None

2. agents-api/tests/test_task_execution_workflow.py:308

• Draft comment:
  The new test 'handle api_call tool call step with Method Override' verifies that the spec's method ('POST') takes precedence over the input method ('GET'). Consider adding an inline comment explaining this behavior for clarity.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50%
  None

3. agents-api/tests/test_task_execution_workflow.py:314

• Draft comment:
  Consider renaming variables 'arguments' (spec) and 'input_arguments' (runtime override) to more distinct names (e.g., 'spec_args' and 'override_args') for improved clarity.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50%
  None

4. agents-api/tests/test_task_execution_workflow.py:378

• Draft comment:
  Since 'follow_redirects' is now a customizable argument, consider adding a test case where this parameter is explicitly set to a non-None value to fully exercise the new functionality.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50%
  None

Workflow ID: wflow_eGYOyFuTUCVP1pEN

---

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

[creatorrr]

@ellipsis-dev please make changes according to PR review comments

[ellipsis-dev]

I couldn't find the specific PR review comments that detail the changes needed. Could you please provide more information or a direct link to the review comments so I can address them accordingly?

---

Responding to this comment by @creatorrr. For more information about Ellipsis, check the documentation.

[ellipsis-dev]

👍 Looks good to me! Reviewed everything up to 6dba9c7 in 6 minutes and 52 seconds

More details

• Looked at 181 lines of code in 2 files
• Skipped 0 files when reviewing.
• Skipped posting 7 drafted comments based on config settings.

1. agents-api/agents_api/activities/execute_api_call.py:36

• Draft comment:
  Using request_args.pop() to extract 'method', 'url', and 'follow_redirects' is destructive. Confirm that downstream code isn’t affected by the mutation of request_args.
• Reason this comment was not posted:
  Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50%
  The use of pop() is intentional here - it removes the special parameters that need custom handling, then passes the rest as kwargs. The request_args dict is not used after the client.request() call. Since this is a local function parameter, mutations don't affect the caller. The pattern is actually clean and common.
  I could be wrong about whether request_args needs to maintain its state after the function call. There could be expectations from callers about the dict being unmodified.
  Since request_args is a function parameter and TypedDict, it's reasonable to treat it as an input-only structure that won't be referenced after the function call. The pop() pattern is appropriate here.
  The comment should be deleted as the use of pop() is intentional and appropriate in this context, following a common pattern for handling kwargs.

2. agents-api/tests/test_task_execution_workflow.py:313

• Draft comment:
  Test 'handle api_call tool call step with Method Override' verifies that RequestArgs can override tool spec values. It might help to add a comment clarifying that the spec (api_call) remains unchanged while the RequestArgs override is used for the actual HTTP call.
• Reason this comment was not posted:
  Confidence changes required: 0% <= threshold 50%
  None

3. agents-api/agents_api/activities/execute_api_call.py:14

• Draft comment:
  New keys ('files', 'method', 'follow_redirects') have been added to RequestArgs. Consider adding inline comments explaining their usage.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50%
  None

4. agents-api/agents_api/activities/execute_api_call.py:35

• Draft comment:
  The comment about method override indicates that request_args takes precedence. Documenting this merge behavior would improve clarity.
• Reason this comment was not posted:
  Confidence changes required: 50% <= threshold 50%
  None

5. agents-api/agents_api/activities/execute_api_call.py:40

• Draft comment:
  Using request_args.pop for 'follow_redirects' overrides the default. Consider clarifying in documentation that runtime parameters override ApiCallDef defaults.
• Reason this comment was not posted:
  Confidence changes required: 50% <= threshold 50%
  None

6. agents-api/agents_api/activities/execute_api_call.py:56

• Draft comment:
  Catching json.JSONDecodeError is good, but consider if other exceptions like ValueError might be raised by response.json() and handle them as needed.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50%
  None

7. agents-api/tests/test_task_execution_workflow.py:308

• Draft comment:
  The test for 'handle api_call tool call step with Method Override' shows a difference between tool spec and input arguments. Adding a comment to explain that request_args overrides (from input) are applied at runtime could improve clarity.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50%
  None

Workflow ID: wflow_oW4jj5y6lVtiXpGl

---

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.