Skip to content

Improve HTTP transport stability & logging #956

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

VinayakTiwari1103
Copy link

@VinayakTiwari1103 VinayakTiwari1103 commented Mar 8, 2025

This PR enhances the HTTP transport layer by improving socket handling, request throttling, and error logging. It ensures better stability, optimizes reconnections, and improves debugging capabilities.
Key Changes

  • Improved socket reconnection logic to handle timeouts more effectively.
  • Enhanced request throttling mechanism for smoother API interactions.
  • Refactored logging for better traceability and debugging.
  • Addressed potential connection closure issues across different OS environments.

Testing Details

  • The changes were tested locally using RESTler, as our CI workflow does not support long-running tests.
  • Request coverage verification was done manually to ensure expected behavior.
  • Noted that the GitHub workflow test failed due to the expected output (Request coverage (successful / total): 6 / 6) not being found.
  • Debugging ongoing: Reviewing logs in restler_working_dir/Test to identify the root cause.
  • Next steps: Running RESTler with more detailed logging and updating the PR accordingly.

@VinayakTiwari1103
Copy link
Author

@VinayakTiwari1103 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below.

1. **Definitions**.
   **“Code”** means the computer software code, whether in human-readable or machine-executable form,
   that is delivered by You to Microsoft under this Agreement.
   **“Project”** means any of the projects owned or managed by Microsoft and offered under a license
   approved by the Open Source Initiative ([www.opensource.org](http://www.opensource.org)).
   **“Submit”** is the act of uploading, submitting, transmitting, or distributing code or other content to any
   Project, including but not limited to communication on electronic mailing lists, source code control
   systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
   discussing and improving that Project, but excluding communication that is conspicuously marked or
   otherwise designated in writing by You as “Not a Submission.”
   **“Submission”** means the Code and any other copyrightable material Submitted by You, including any
   associated comments and documentation.

2. **Your Submission**. You must agree to the terms of this Agreement before making a Submission to any
   Project. This Agreement covers any and all Submissions that You, now or in the future (except as
   described in Section 4 below), Submit to any Project.

3. **Originality of Work**. You represent that each of Your Submissions is entirely Your original work.
   Should You wish to Submit materials that are not Your original work, You may Submit them separately
   to the Project if You (a) retain all copyright and license information that was in the materials as You
   received them, (b) in the description accompanying Your Submission, include the phrase “Submission
   containing materials of a third party:” followed by the names of the third party and any licenses or other
   restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
   guidelines concerning Submissions.

4. **Your Employer**. References to “employer” in this Agreement include Your employer or anyone else
   for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
   Submission is made in the course of Your work for an employer or Your employer has intellectual
   property rights in Your Submission by contract or applicable law, You must secure permission from Your
   employer to make the Submission before signing this Agreement. In that case, the term “You” in this
   Agreement will refer to You and the employer collectively. If You change employers in the future and
   desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
   and secure permission from the new employer before Submitting those Submissions.

5. **Licenses**.


* **Copyright License**. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
  Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
  the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
  parties.

* **Patent License**. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
  Your patent claims that are necessarily infringed by the Submission or the combination of the
  Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
  import or otherwise dispose of the Submission alone or with the Project.

* **Other Rights Reserved**. Each party reserves all rights not expressly granted in this Agreement.
  No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
  granted by implication, exhaustion, estoppel or otherwise.


6. **Representations and Warranties**. You represent that You are legally entitled to grant the above
   licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
   have disclosed under Section 3). You represent that You have secured permission from Your employer to
   make the Submission in cases where Your Submission is made in the course of Your work for Your
   employer or Your employer has intellectual property rights in Your Submission by contract or applicable
   law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
   have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
   You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
   REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
   EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
   PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
   NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

7. **Notice to Microsoft**. You agree to notify Microsoft in writing of any facts or circumstances of which
   You later become aware that would make Your representations in this Agreement inaccurate in any
   respect.

8. **Information about Submissions**. You agree that contributions to Projects and information about
   contributions may be maintained indefinitely and disclosed publicly, including Your name and other
   information that You submit with Your Submission.

9. **Governing Law/Jurisdiction**. This Agreement is governed by the laws of the State of Washington, and
   the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
   Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
   exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
   defenses of lack of personal jurisdiction and forum non-conveniens.

10. **Entire Agreement/Assignment**. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

@microsoft-github-policy-service agree

@VinayakTiwari1103
Copy link
Author

Hi @marina-p @rifiles @PatGod , could you please review and approve the workflow when you have time? Thanks!

@marina-p
Copy link
Contributor

marina-p commented Mar 10, 2025

Hi @VinayakTiwari1103 - workflow approved. Could you please comment in the PR description how you tested these changes? We currently do not have long-running tests that can be launched in the CI workflow, we usually run another set of tests separately on real-world services for larger changes like this one.


In reply to: 2708453414

@VinayakTiwari1103
Copy link
Author

Hi @VinayakTiwari1103 - workflow approved. Could you please comment in the PR description how you tested these changes? We currently do not have long-running tests that can be launched in the CI workflow, we usually run another set of tests separately on real-world services for larger changes like this one.

In reply to: 2708453414

I've updated the PR description with details on how I tested these changes. Let me know if anything else is needed.

@marina-p
Copy link
Contributor

FYI, the end to end test is failing due to a known issue, fix will be merged today. The engine tests do not have any known issues.

@marina-p
Copy link
Contributor

Hi @VinayakTiwari1103,

For the PR description update - thank you, that is helpful. In addition, I'd like to better understand the specific bugs you have fixed with this change. This will help me suggest new regression tests.

Also, please split the cosmetic improvements into a separate PR (for example, changes to output formatting, spacing only changes, non-functional code rewrites, etc.). This will make it easier to review these and make sure they are consistent with the conventions of the project.

Thanks,

Marina

@VinayakTiwari1103
Copy link
Author

Hi @marina-p,

Thanks for the feedback and Guidance! Here’s a more detailed breakdown of the specific issues that this PR addresses:

1. Fixed socket reconnection issues after timeouts

  • Previously, when a request timeout occurred, the socket would sometimes fail to reconnect correctly, leading to intermittent failures.
  • The new logic ensures that after a timeout, the socket is properly closed and re-established before retrying the request.
  • This prevents dropped requests and improves the reliability of long-running RESTler fuzzing sessions.

2. Addressed connection closure inconsistencies across different OS environments

  • The handling of persistent connections varied between Windows and Linux which causing different behaviors in connection termination.
  • In some cases, lingering connections were not closed properly, leading to resource exhaustion or unexpected errors.
  • This fix standardizes the connection shutdown process, ensuring graceful closure across all supported platforms.

3. Improved request throttling logic to prevent API overload and optimize retries

  • The existing throttling mechanism did not efficiently manage API rate limits, leading to occasional bursts of excessive requests.
  • This update introduces an adaptive throttling mechanism that dynamically adjusts request pacing based on response latency and server load.
  • As a result, RESTler now interacts more smoothly with APIs, reducing the risk of triggering rate limits or getting blocked.

I’ve also noted your request to separate cosmetic changes into a different PR and will do so accordingly.

Regarding the failing end-to-end tests, I’ll re-run them once the known issue fix is merged and update the PR accordingly.

Let me know if you need any further clarifications!

Best,
Vinayak

@VinayakTiwari1103
Copy link
Author

Hi @marina-p,

I wanted to check if there are any further updates needed from my side for this PR. I have already addressed your feedback regarding the specific fixes and separated the cosmetic changes into a different PR.

Also, I noticed that the required checks are still pending. Could you please confirm if there are any additional steps I should take, or if this is something that needs to be addressed from the maintainers' side?

Let me know if any other modifications or clarifications are required!

Best,
Vinayak

@marina-p
Copy link
Contributor

Hi @VinayakTiwari1103,

I see two commits in the PR, but they appear identical for me. Could you please check that you pushed the commit with the latest updates? Let me know if I'm missing something.

RE: the checks, apologies for the delay. I am still trying to figure out how to enable checks to trigger automatically for anyone who submits a PR (this was the case when the PR checks were linked to an ADO project, but no longer after migrating to GitHub actions). For now, the fastest option will be for you to run unit tests locally and get them to pass.

Thanks,

Marina

@VinayakTiwari1103
Copy link
Author

Hi @marina-p,

Thanks for reviewing the PR! I'll double-check the commits and ensure that the latest updates are correctly pushed. I'll update you shortly once I've verified.

Regarding the checks, no worries! I'll run the unit tests locally and confirm that everything passes. Let me know if there’s anything else I should keep in mind while running them.

Best,
Vinayak

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants