Skip to content

timeout related fixes and error propogation improvements#120

Open
amruthesht wants to merge 16 commits into
mainfrom
socket-timeout
Open

timeout related fixes and error propogation improvements#120
amruthesht wants to merge 16 commits into
mainfrom
socket-timeout

Conversation

@amruthesht

@amruthesht amruthesht commented Nov 19, 2025

Copy link
Copy Markdown
Contributor

Fixes #111

Changes made in this Pull Request:

  • timeout defualt value chnaged to 600
  • Imporvements to exception chaining and error propogation
  • test-cases for timeout
  • warning for timeout <= 1

PR Checklist

  • Tests?
  • Docs?
  • CHANGELOG updated?
  • Issue raised/referenced?

@codecov

codecov Bot commented Nov 19, 2025

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 79.41176% with 7 lines in your changes missing coverage. Please review.
✅ Project coverage is 84.26%. Comparing base (0769db1) to head (71ccddb).

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@amruthesht amruthesht self-assigned this Nov 19, 2025
@amruthesht amruthesht marked this pull request as ready for review November 19, 2025 07:44

@orbeckst orbeckst left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 on the timeout=600.

I have technical comments on the tests, please see inline.

@HeydenLabASU do you want to review and give your blessing?

@ljwoods2 do you have comments?

Comment thread imdclient/tests/test_imdclient.py Outdated
Comment thread imdclient/tests/test_imdclient.py Outdated
Comment thread imdclient/tests/test_imdclient.py Outdated
Comment thread imdclient/tests/test_imdclient.py Outdated
@ljwoods2

Copy link
Copy Markdown
Collaborator

@orbeckst super backed up atm, will need ~1 week to get to this. apologies, feel free to move forward without me if you're hoping to push a release

@amruthesht amruthesht requested a review from orbeckst November 21, 2025 08:31
@orbeckst

Copy link
Copy Markdown
Member

@amruthesht please resolve the conflict that's holding up the CI. Thanks.

@orbeckst orbeckst left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The refactoring of the client/server in the tests looks good to me (and all tests continue to pass).

Coverage is low because you added many more cases for exceptions and we're not testing all these different fail cases separately. There also appears to be some code (InThread client?) that is not really tested at all (?)

I don't think it's worthwhile right now to create test cases for each separate failure case (unless it's easy to do, e.g. with mocking) but we should be clear what is untested code. Could you please

  1. check the [coverage]((https://app.codecov.io/gh/Becksteinlab/imdclient/pull/120) for the code.
  2. mark untested code blocks with #pragma: nocover
  3. raise issues for larger code blocks that should be tested eventually

Comment thread imdclient/tests/server.py
Comment thread imdclient/IMDClient.py
Comment thread imdclient/IMDClient.py
Comment thread imdclient/IMDClient.py
@orbeckst

Copy link
Copy Markdown
Member

@amruthesht @HeydenLabASU I think we still want this fix, right?

@orbeckst orbeckst mentioned this pull request May 13, 2026
3 tasks
@orbeckst

Copy link
Copy Markdown
Member

@amruthesht can you finish the PR and then we can make a release #130?

We need a release so that we have a zenodo DOI for the package as we want to include that in the paper.

@amruthesht

Copy link
Copy Markdown
Contributor Author

@orbeckst, I added additional tests to improve coverage and restructured some of the test classes. I think the PR would add useful fixes and error handling to the package

@amruthesht amruthesht requested a review from orbeckst June 22, 2026 03:51

@orbeckst orbeckst left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding the additional tests.

Last thing: please add an entry to CHANGELOG!

Comment thread imdclient/IMDClient.py Outdated
@orbeckst

Copy link
Copy Markdown
Member

@amruthesht as discussed, we only need the CHANGELOG entry and then it's good to go.

@orbeckst orbeckst mentioned this pull request Jun 27, 2026
2 tasks
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.

Test IMDClient timeout kwarg, add helpful hint to use it

3 participants