Skip to content
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.

Sign up for GitHub

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

Add back support for kernel launch timeout pad #910

Merged
merged 10 commits into from
Jul 7, 2022
Merged

Add back support for kernel launch timeout pad #910

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
8e8526f
Re-add LAUNCH_TIMEOUT_PAD support
CiprianAnton Jul 6, 2022
aca15ec
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 6, 2022
e2ed218
Move option next to other configs
CiprianAnton Jul 6, 2022
21bb207
Update jupyter_server/gateway/gateway_client.py
CiprianAnton Jul 6, 2022
544be57
- Update request_timeout default value
CiprianAnton Jul 6, 2022
96faf7c
Update help with suggestion
CiprianAnton Jul 7, 2022
1f73b15
Make the launch_timeout_pad be flow for consitency with other timeout…
CiprianAnton Jul 7, 2022
283b3dc
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 7, 2022
31cdee1
Forgot to make default value also float.
CiprianAnton Jul 7, 2022
2bff10b
Merge branch 'users/canton/add-suport-for-kernel-launch-timeout-pad' …
CiprianAnton Jul 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions jupyter_server/gateway/gateway_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ def connect_timeout_default(self):
os.environ.get("JUPYTER_GATEWAY_CONNECT_TIMEOUT", self.connect_timeout_default_value)
)

request_timeout_default_value = 40.0
request_timeout_default_value = 42.0
request_timeout_env = "JUPYTER_GATEWAY_REQUEST_TIMEOUT"
request_timeout = Float(
default_value=request_timeout_default_value,
Expand Down Expand Up @@ -341,21 +341,22 @@ def gateway_retry_max_default(self):
os.environ.get("JUPYTER_GATEWAY_RETRY_MAX", self.gateway_retry_max_default_value)
)

kernel_launch_timeout_pad_default_value = 0
kernel_launch_timeout_pad_env = "JUPYTER_GATEWAY_KERNEL_LAUNCH_TIMEOUT_PAD"
kernel_launch_timeout_pad = Int(
default_value=kernel_launch_timeout_pad_default_value,
launch_timeout_pad_default_value = 2
launch_timeout_pad_env = "JUPYTER_GATEWAY_LAUNCH_TIMEOUT_PAD"
launch_timeout_pad = Int(
default_value=launch_timeout_pad_default_value,
config=True,
help="""Timeout pad to be ensured between KERNEL_LAUNCH_TIMEOUT and request_timeout.
(JUPYTER_GATEWAY_KERNEL_LAUNCH_TIMEOUT_PAD env var)""",
help="""Timeout pad to be ensured between KERNEL_LAUNCH_TIMEOUT and request_timeout
such that request_timeout >= KERNEL_LAUNCH_TIMEOUT + timeout_pad.
(JUPYTER_GATEWAY_LAUNCH_TIMEOUT_PAD env var)""",
)

@default("kernel_launch_timeout_pad")
def kernel_launch_timeout_pad_default(self):
@default("launch_timeout_pad")
def launch_timeout_pad_default(self):
return int(
os.environ.get(
"JUPYTER_GATEWAY_KERNEL_LAUNCH_TIMEOUT_PAD",
self.kernel_launch_timeout_pad_default_value,
"JUPYTER_GATEWAY_LAUNCH_TIMEOUT_PAD",
self.launch_timeout_pad_default_value,
)
)

Expand All @@ -375,13 +376,13 @@ def init_static_args(self):
# greater value of the two and taking into account the following relation:
# request_timeout = KERNEL_LAUNCH_TIME + padding
minimum_request_timeout = (
float(GatewayClient.KERNEL_LAUNCH_TIMEOUT) + self.kernel_launch_timeout_pad
float(GatewayClient.KERNEL_LAUNCH_TIMEOUT) + self.launch_timeout_pad
)
if self.request_timeout < minimum_request_timeout:
self.request_timeout = minimum_request_timeout
elif self.request_timeout > minimum_request_timeout:
GatewayClient.KERNEL_LAUNCH_TIMEOUT = (
int(self.request_timeout) - self.kernel_launch_timeout_pad
int(self.request_timeout) - self.launch_timeout_pad
)
# Ensure any adjustments are reflected in env.
os.environ["KERNEL_LAUNCH_TIMEOUT"] = str(GatewayClient.KERNEL_LAUNCH_TIMEOUT)
Expand Down
14 changes: 7 additions & 7 deletions tests/test_gateway.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ def init_gateway(monkeypatch):
monkeypatch.setenv("JUPYTER_GATEWAY_HTTP_USER", mock_http_user)
monkeypatch.setenv("JUPYTER_GATEWAY_REQUEST_TIMEOUT", "44.4")
monkeypatch.setenv("JUPYTER_GATEWAY_CONNECT_TIMEOUT", "44.4")
monkeypatch.setenv("JUPYTER_GATEWAY_KERNEL_LAUNCH_TIMEOUT_PAD", "1")
monkeypatch.setenv("JUPYTER_GATEWAY_LAUNCH_TIMEOUT_PAD", "1")
yield
GatewayClient.clear_instance()

Expand All @@ -199,7 +199,7 @@ async def test_gateway_env_options(init_gateway, jp_serverapp):
jp_serverapp.gateway_config.connect_timeout == jp_serverapp.gateway_config.request_timeout
)
assert jp_serverapp.gateway_config.connect_timeout == 44.4
assert jp_serverapp.gateway_config.kernel_launch_timeout_pad == 1
assert jp_serverapp.gateway_config.launch_timeout_pad == 1

GatewayClient.instance().init_static_args()
assert GatewayClient.instance().KERNEL_LAUNCH_TIMEOUT == 43
Expand All @@ -211,7 +211,7 @@ async def test_gateway_cli_options(jp_configurable_serverapp):
"--GatewayClient.http_user=" + mock_http_user,
"--GatewayClient.connect_timeout=44.4",
"--GatewayClient.request_timeout=96.0",
"--GatewayClient.kernel_launch_timeout_pad=2",
"--GatewayClient.launch_timeout_pad=6",
]

GatewayClient.clear_instance()
Expand All @@ -222,11 +222,11 @@ async def test_gateway_cli_options(jp_configurable_serverapp):
assert app.gateway_config.http_user == mock_http_user
assert app.gateway_config.connect_timeout == 44.4
assert app.gateway_config.request_timeout == 96.0
assert app.gateway_config.kernel_launch_timeout_pad == 2
assert app.gateway_config.launch_timeout_pad == 6
GatewayClient.instance().init_static_args()
assert (
GatewayClient.instance().KERNEL_LAUNCH_TIMEOUT == 94
) # Ensure KLT gets set from request-timeout - kernel_launch_timeout_pad
GatewayClient.instance().KERNEL_LAUNCH_TIMEOUT == 90
) # Ensure KLT gets set from request-timeout - launch_timeout_pad
GatewayClient.clear_instance()


Expand All @@ -244,7 +244,7 @@ async def test_gateway_request_timeout_pad_option(
):
argv = [
f"--GatewayClient.request_timeout={request_timeout}",
"--GatewayClient.kernel_launch_timeout_pad=5",
"--GatewayClient.launch_timeout_pad=5",
]

GatewayClient.clear_instance()
Expand Down