Support responseTimeout profile property for z/OSMF operations #369

aadityasinha-dotcom · 2025-06-19T08:03:20Z

What It Does
Fixes #334

How to Test

Review Checklist
I certify that I have:

tested my changes
added/updated automated tests
updated the changelog
followed the contribution guidelines

Additional Comments

Signed-off-by: aadityasinha-dotcom <aadityasinha009@gmail.com>

Copilot

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_timeout field on ISession
Assigns response_timeout from profile props for both auth flows
Includes X-IBM-Response-Timeout header 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-Timeout is 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 using Optional[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")

src/core/zowe/core_for_zowe_sdk/sdk_api.py

codecov · 2025-07-07T15:11:55Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.01%. Comparing base (7d093e6) to head (021c0ea).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #369      +/-   ##
==========================================
+ Coverage   81.86%   82.01%   +0.14%     
==========================================
  Files          48       49       +1     
  Lines        2768     2791      +23     
==========================================
+ Hits         2266     2289      +23     
  Misses        502      502

Flag	Coverage Δ
unittests	`82.01% <100.00%> (+0.14%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

t1m0thyj · 2025-07-07T15:51:33Z

src/core/zowe/core_for_zowe_sdk/session.py

            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")


@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.

Keeping the core package zosmf agnostic makes sense.
Maybe we can move this response timeout somewhere in the zosmf package?

Thank you for the review, can you review the changes I tried moving it to the zosmf package ☺️

pem70

Changes LGTM.

zFernand0

Changes make sense.
I agree with Timothy's comment that we should keep the session free from z/somf specific properties

zFernand0 · 2025-07-09T14:29:57Z

src/core/zowe/core_for_zowe_sdk/session.py

            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")


Keeping the core package zosmf agnostic makes sense.
Maybe we can move this response timeout somewhere in the zosmf package?

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Aaditya Sinha <75474786+aadityasinha-dotcom@users.noreply.github.com>

Signed-off-by: aadityasinha-dotcom <aadityasinha009@gmail.com>

zFernand0

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 🙏

Signed-off-by: aadityasinha-dotcom <aadityasinha009@gmail.com>

src/zos_files/zowe/zos_files_for_zowe_sdk/files.py

Signed-off-by: aadityasinha-dotcom <aadityasinha009@gmail.com>

traeok · 2025-11-19T16:13:42Z

Hi @aadityasinha-dotcom , just tagging for awareness: Seems that the build is failing with a lint error:

src/zos_files/zowe/zos_files_for_zowe_sdk/files.py:70:0: C0301: Line too long

Can you please fix this once you get a chance? Thanks

Signed-off-by: aadityasinha-dotcom <aadityasinha009@gmail.com>

re-review

src/zos_files/zowe/zos_files_for_zowe_sdk/files.py

src/zosmf/zowe/zosmf_for_zowe_sdk/zosmf.py

tests/unit/test_zosmf.py

Signed-off-by: aadityasinha-dotcom <aadityasinha009@gmail.com>

t1m0thyj

Code changes LGTM! Please ~~resolve failing unit tests~~ (I've done this 😁) and add a changelog entry 😋

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>

t1m0thyj · 2025-12-26T17:45:26Z

src/zos_files/zowe/zos_files_for_zowe_sdk/api.py

+        async_threshold = profile.get("asyncThreshold") or profile.get("X-IBM-Async-Threshold")
+        if not async_threshold:


Although it's true that the X-IBM-Async-Threshold and X-IBM-Response-Timeout headers are mutually exclusive, Zowe team config files don't allow the asyncThreshold parameter to be defined in a z/OSMF profile, so I think this check can be removed.

That's true, I also think asyncThreshold check can be removed.

Signed-off-by: aadityasinha-dotcom <aadityasinha009@gmail.com>

t1m0thyj · 2025-12-26T18:23:11Z

src/zos_files/zowe/zos_files_for_zowe_sdk/api.py

+        else:
+            if hasattr(self, "logger"):
+                self.logger.info("X-IBM-Async-Threshold present; X-IBM-Response-Timeout will be ignored by z/OSMF")


Please remove the else block - we don't need to log a warning when responseTimeout is missing on the profile. Everything else LGTM 😋

Signed-off-by: aadityasinha-dotcom <aadityasinha009@gmail.com>

t1m0thyj

LGTM, thanks @aadityasinha-dotcom!

Support responseTimeout profile property for z/OSMF operations

bbf42b3

Signed-off-by: aadityasinha-dotcom <aadityasinha009@gmail.com>

github-project-automation bot added this to Zowe CLI Squad Jun 19, 2025

github-project-automation bot moved this to New Issues in Zowe CLI Squad Jun 19, 2025

zowe-robot moved this from New Issues to Review/QA in Zowe CLI Squad Jun 19, 2025

adam-wolfe requested review from pem70 and zFernand0 June 23, 2025 15:08

t1m0thyj requested review from Copilot and t1m0thyj July 7, 2025 15:04

Copilot AI reviewed Jul 7, 2025

View reviewed changes

src/core/zowe/core_for_zowe_sdk/sdk_api.py Outdated Show resolved Hide resolved

t1m0thyj reviewed Jul 7, 2025

View reviewed changes

Merge branch 'main' into response_timeout

9412974

pem70 reviewed Jul 8, 2025

View reviewed changes

zFernand0 requested changes Jul 9, 2025

View reviewed changes

aadityasinha-dotcom and others added 2 commits July 21, 2025 14:23

Update src/core/zowe/core_for_zowe_sdk/sdk_api.py

f3285e6

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Aaditya Sinha <75474786+aadityasinha-dotcom@users.noreply.github.com>

moved the response_timeout in zosmf package and added unit test

2aa377b

Signed-off-by: aadityasinha-dotcom <aadityasinha009@gmail.com>

JTonda requested review from pem70, t1m0thyj and zFernand0 July 21, 2025 15:14

zFernand0 assigned zFernand0 and aadityasinha-dotcom and unassigned zFernand0 and aadityasinha-dotcom Aug 11, 2025

Merge branch 'main' into response_timeout

ebd612a

zFernand0 moved this from Review/QA to Release Backlog in Zowe CLI Squad Aug 11, 2025

zFernand0 previously requested changes Aug 15, 2025

View reviewed changes

github-project-automation bot moved this from Release Backlog to Review/QA in Zowe CLI Squad Aug 15, 2025

Merge branch 'main' into response_timeout

1da40ae

JTonda moved this from Review/QA to In Progress in Zowe CLI Squad Oct 27, 2025

JTonda removed the request for review from pem70 October 27, 2025 15:20

aadityasinha-dotcom and others added 4 commits October 30, 2025 17:11

Merge branch 'main' into response_timeout

e46f89e

same funcitonality in the files.py

fc70e08

Signed-off-by: aadityasinha-dotcom <aadityasinha009@gmail.com>

added test for file.py

683d5e6

Signed-off-by: aadityasinha-dotcom <aadityasinha009@gmail.com>

fixes

1f95621

Signed-off-by: aadityasinha-dotcom <aadityasinha009@gmail.com>

aadityasinha-dotcom commented Nov 12, 2025

View reviewed changes

src/zos_files/zowe/zos_files_for_zowe_sdk/files.py Outdated Show resolved Hide resolved

t1m0thyj reviewed Nov 13, 2025

View reviewed changes

src/zos_files/zowe/zos_files_for_zowe_sdk/files.py Outdated Show resolved Hide resolved

moved to zos_files_constants

433a077

Signed-off-by: aadityasinha-dotcom <aadityasinha009@gmail.com>

aadityasinha-dotcom and others added 2 commits November 19, 2025 23:43

Merge branch 'main' into response_timeout

6d8fe6a

fixed lint errors

cc4db15

Signed-off-by: aadityasinha-dotcom <aadityasinha009@gmail.com>

zFernand0 requested review from t1m0thyj and zFernand0 November 24, 2025 16:08

aadityasinha-dotcom commented Nov 24, 2025

View reviewed changes

src/zos_files/zowe/zos_files_for_zowe_sdk/files.py Outdated Show resolved Hide resolved

t1m0thyj requested changes Dec 4, 2025

View reviewed changes

src/zosmf/zowe/zosmf_for_zowe_sdk/zosmf.py Outdated Show resolved Hide resolved

tests/unit/test_zosmf.py Outdated Show resolved Hide resolved

github-project-automation bot moved this from In Progress to Review/QA in Zowe CLI Squad Dec 4, 2025

aadityasinha-dotcom and others added 3 commits December 6, 2025 23:50

Merge branch 'main' into response_timeout

c4e88f1

added changes to remove header from zosmf

f77ff42

Signed-off-by: aadityasinha-dotcom <aadityasinha009@gmail.com>

Merge branch 'main' into response_timeout

345347b

JTonda requested a review from t1m0thyj December 15, 2025 16:14

t1m0thyj requested changes Dec 17, 2025

View reviewed changes

t1m0thyj added 2 commits December 19, 2025 17:29

Refactor zos_files_for_zowe_sdk to use BaseFilesApi

a417f0c

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>

Add docs string to new api class

021c0ea

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>

t1m0thyj reviewed Dec 26, 2025

View reviewed changes

aadityasinha-dotcom added 2 commits December 26, 2025 23:47

remove asyncThreshold check and updated changelog

c362795

Signed-off-by: aadityasinha-dotcom <aadityasinha009@gmail.com>

fixed changes

de1d45f

Signed-off-by: aadityasinha-dotcom <aadityasinha009@gmail.com>

t1m0thyj reviewed Dec 26, 2025

View reviewed changes

removed else block

8b3ab97

Signed-off-by: aadityasinha-dotcom <aadityasinha009@gmail.com>

t1m0thyj approved these changes Dec 26, 2025

View reviewed changes

t1m0thyj requested a review from traeok December 26, 2025 18:33

		async_threshold = profile.get("asyncThreshold") or profile.get("X-IBM-Async-Threshold")
		if not async_threshold:

Support responseTimeout profile property for z/OSMF operations #369

Are you sure you want to change the base?

Support responseTimeout profile property for z/OSMF operations #369

Uh oh!

Conversation

aadityasinha-dotcom commented Jun 19, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

codecov bot commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

t1m0thyj Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

zFernand0 Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

aadityasinha-dotcom Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

pem70 left a comment

Choose a reason for hiding this comment

Uh oh!

zFernand0 left a comment

Choose a reason for hiding this comment

Uh oh!

zFernand0 Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

zFernand0 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

LGTM! 😋

Uh oh!

Uh oh!

Uh oh!

traeok commented Nov 19, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

t1m0thyj left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

t1m0thyj Dec 26, 2025

Choose a reason for hiding this comment

Uh oh!

aadityasinha-dotcom Dec 26, 2025

Choose a reason for hiding this comment

Uh oh!

t1m0thyj Dec 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

t1m0thyj left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov bot commented Jul 7, 2025 •

edited

Loading

zFernand0 left a comment •

edited

Loading

t1m0thyj left a comment •

edited

Loading

t1m0thyj Dec 26, 2025 •

edited

Loading