Support responseTimeout profile property for z/OSMF operations #369
Conversation
Signed-off-by: aadityasinha-dotcom <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
Adds support for the responseTimeout profile property by surfacing it on the session object and sending it as an HTTP header for z/OSMF calls.
- Introduces
response_timeoutfield onISession - Assigns
response_timeoutfrom profile props for both auth flows - Includes
X-IBM-Response-Timeoutheader in SDK API requests
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/core/zowe/core_for_zowe_sdk/session.py | Adds response_timeout attribute and assigns from responseTimeout prop |
| src/core/zowe/core_for_zowe_sdk/sdk_api.py | Adds X-IBM-Response-Timeout header using response_timeout |
Comments suppressed due to low confidence (3)
src/core/zowe/core_for_zowe_sdk/sdk_api.py:52
- [nitpick] New header behavior should be covered by automated tests to verify that
X-IBM-Response-Timeoutis only sent when the profile property is set and that its value is correctly formatted.
"X-IBM-Response-Timeout": self.session.response_timeout,
src/core/zowe/core_for_zowe_sdk/session.py:27
- Using
Optional[str]may allow non-numeric values; consider usingOptional[int](or validating/casting the string) so that the timeout is always a valid number.
response_timeout: Optional[str] = None
src/core/zowe/core_for_zowe_sdk/session.py:71
- Directly assigning the raw prop can lead to unexpected types; add validation or cast to the expected type (e.g.,
int(props.get(...))).
self.session.response_timeout = props.get("responseTimeout")
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #369 +/- ##
==========================================
+ Coverage 88.05% 88.11% +0.06%
==========================================
Files 65 65
Lines 3340 3357 +17
==========================================
+ Hits 2941 2958 +17
Misses 399 399
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| self.session.user = props.get("user") | ||
| self.session.password = props.get("password") | ||
| self.session.reject_unauthorized = bool(props.get("rejectUnauthorized")) | ||
| self.session.response_timeout = props.get("responseTimeout") |
There was a problem hiding this comment.
@zFernand0 @traeok Is it ok to store response_timeout on the Session class since it's specific to z/OSMF? Wondering if we should keep the properties on the Session class more profile/service-agnostic.
There was a problem hiding this comment.
Keeping the core package zosmf agnostic makes sense.
Maybe we can move this response timeout somewhere in the zosmf package?
There was a problem hiding this comment.
Thank you for the review, can you review the changes I tried moving it to the zosmf package
| self.session.user = props.get("user") | ||
| self.session.password = props.get("password") | ||
| self.session.reject_unauthorized = bool(props.get("rejectUnauthorized")) | ||
| self.session.response_timeout = props.get("responseTimeout") |
There was a problem hiding this comment.
Keeping the core package zosmf agnostic makes sense.
Maybe we can move this response timeout somewhere in the zosmf package?
Co-authored-by: Copilot <[email protected]> Signed-off-by: Aaditya Sinha <[email protected]>
Signed-off-by: aadityasinha-dotcom <[email protected]>
zFernand0
assigned
zFernand0 and
aadityasinha-dotcom and unassigned
zFernand0 and
aadityasinha-dotcom
There was a problem hiding this comment.
LGTM! 😋
I do have one small request...
Doing this only in the zosmf package will impact only the functions dependent on the zosmf...
From the IBM documentation...
https://www.ibm.com/docs/en/zos/2.5.0?topic=services-zos-data-set-file-rest-interface#izuhpinfo_api_restfiles__title__5
I believe we would want to add this same funcitonality in the files.py.
And perhaps also add some validation around it (mostly to warn people that the value may be modified by z/OSMF
5 >= responseTimeout >= 600 😋
If possible, please keep in mind that more headers may need to be introduced in the future 🙏
github-project-automation
bot
moved this from Release Backlog
to Review/QA
in Zowe CLI Squad
Signed-off-by: aadityasinha-dotcom <[email protected]>
4 participants
What It Does
Fixes #334
How to Test
Review Checklist
I certify that I have:
Additional Comments