Skip to content

Commit 544be57

Browse files
committed
- Update request_timeout default value
- Update pad_timeout default value - Rename kernel_launch_timeout_pad => launch_timeout_pad
1 parent 21bb207 commit 544be57

File tree

2 files changed

+19
-19
lines changed

2 files changed

+19
-19
lines changed

jupyter_server/gateway/gateway_client.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ def connect_timeout_default(self):
128128
os.environ.get("JUPYTER_GATEWAY_CONNECT_TIMEOUT", self.connect_timeout_default_value)
129129
)
130130

131-
request_timeout_default_value = 40.0
131+
request_timeout_default_value = 42.0
132132
request_timeout_env = "JUPYTER_GATEWAY_REQUEST_TIMEOUT"
133133
request_timeout = Float(
134134
default_value=request_timeout_default_value,
@@ -341,22 +341,22 @@ def gateway_retry_max_default(self):
341341
os.environ.get("JUPYTER_GATEWAY_RETRY_MAX", self.gateway_retry_max_default_value)
342342
)
343343

344-
kernel_launch_timeout_pad_default_value = 0
345-
kernel_launch_timeout_pad_env = "JUPYTER_GATEWAY_KERNEL_LAUNCH_TIMEOUT_PAD"
346-
kernel_launch_timeout_pad = Int(
347-
default_value=kernel_launch_timeout_pad_default_value,
344+
launch_timeout_pad_default_value = 2
345+
launch_timeout_pad_env = "JUPYTER_GATEWAY_LAUNCH_TIMEOUT_PAD"
346+
launch_timeout_pad = Int(
347+
default_value=launch_timeout_pad_default_value,
348348
config=True,
349349
help="""Timeout pad to be ensured between KERNEL_LAUNCH_TIMEOUT and request_timeout
350350
such that request_timeout >= KERNEL_LAUNCH_TIMEOUT + timeout_pad.
351-
(JUPYTER_GATEWAY_KERNEL_LAUNCH_TIMEOUT_PAD env var)""",
351+
(JUPYTER_GATEWAY_LAUNCH_TIMEOUT_PAD env var)""",
352352
)
353353

354-
@default("kernel_launch_timeout_pad")
355-
def kernel_launch_timeout_pad_default(self):
354+
@default("launch_timeout_pad")
355+
def launch_timeout_pad_default(self):
356356
return int(
357357
os.environ.get(
358-
"JUPYTER_GATEWAY_KERNEL_LAUNCH_TIMEOUT_PAD",
359-
self.kernel_launch_timeout_pad_default_value,
358+
"JUPYTER_GATEWAY_LAUNCH_TIMEOUT_PAD",
359+
self.launch_timeout_pad_default_value,
360360
)
361361
)
362362

@@ -376,13 +376,13 @@ def init_static_args(self):
376376
# greater value of the two and taking into account the following relation:
377377
# request_timeout = KERNEL_LAUNCH_TIME + padding
378378
minimum_request_timeout = (
379-
float(GatewayClient.KERNEL_LAUNCH_TIMEOUT) + self.kernel_launch_timeout_pad
379+
float(GatewayClient.KERNEL_LAUNCH_TIMEOUT) + self.launch_timeout_pad
380380
)
381381
if self.request_timeout < minimum_request_timeout:
382382
self.request_timeout = minimum_request_timeout
383383
elif self.request_timeout > minimum_request_timeout:
384384
GatewayClient.KERNEL_LAUNCH_TIMEOUT = (
385-
int(self.request_timeout) - self.kernel_launch_timeout_pad
385+
int(self.request_timeout) - self.launch_timeout_pad
386386
)
387387
# Ensure any adjustments are reflected in env.
388388
os.environ["KERNEL_LAUNCH_TIMEOUT"] = str(GatewayClient.KERNEL_LAUNCH_TIMEOUT)

tests/test_gateway.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ def init_gateway(monkeypatch):
186186
monkeypatch.setenv("JUPYTER_GATEWAY_HTTP_USER", mock_http_user)
187187
monkeypatch.setenv("JUPYTER_GATEWAY_REQUEST_TIMEOUT", "44.4")
188188
monkeypatch.setenv("JUPYTER_GATEWAY_CONNECT_TIMEOUT", "44.4")
189-
monkeypatch.setenv("JUPYTER_GATEWAY_KERNEL_LAUNCH_TIMEOUT_PAD", "1")
189+
monkeypatch.setenv("JUPYTER_GATEWAY_LAUNCH_TIMEOUT_PAD", "1")
190190
yield
191191
GatewayClient.clear_instance()
192192

@@ -199,7 +199,7 @@ async def test_gateway_env_options(init_gateway, jp_serverapp):
199199
jp_serverapp.gateway_config.connect_timeout == jp_serverapp.gateway_config.request_timeout
200200
)
201201
assert jp_serverapp.gateway_config.connect_timeout == 44.4
202-
assert jp_serverapp.gateway_config.kernel_launch_timeout_pad == 1
202+
assert jp_serverapp.gateway_config.launch_timeout_pad == 1
203203

204204
GatewayClient.instance().init_static_args()
205205
assert GatewayClient.instance().KERNEL_LAUNCH_TIMEOUT == 43
@@ -211,7 +211,7 @@ async def test_gateway_cli_options(jp_configurable_serverapp):
211211
"--GatewayClient.http_user=" + mock_http_user,
212212
"--GatewayClient.connect_timeout=44.4",
213213
"--GatewayClient.request_timeout=96.0",
214-
"--GatewayClient.kernel_launch_timeout_pad=2",
214+
"--GatewayClient.launch_timeout_pad=6",
215215
]
216216

217217
GatewayClient.clear_instance()
@@ -222,11 +222,11 @@ async def test_gateway_cli_options(jp_configurable_serverapp):
222222
assert app.gateway_config.http_user == mock_http_user
223223
assert app.gateway_config.connect_timeout == 44.4
224224
assert app.gateway_config.request_timeout == 96.0
225-
assert app.gateway_config.kernel_launch_timeout_pad == 2
225+
assert app.gateway_config.launch_timeout_pad == 6
226226
GatewayClient.instance().init_static_args()
227227
assert (
228-
GatewayClient.instance().KERNEL_LAUNCH_TIMEOUT == 94
229-
) # Ensure KLT gets set from request-timeout - kernel_launch_timeout_pad
228+
GatewayClient.instance().KERNEL_LAUNCH_TIMEOUT == 90
229+
) # Ensure KLT gets set from request-timeout - launch_timeout_pad
230230
GatewayClient.clear_instance()
231231

232232

@@ -244,7 +244,7 @@ async def test_gateway_request_timeout_pad_option(
244244
):
245245
argv = [
246246
f"--GatewayClient.request_timeout={request_timeout}",
247-
"--GatewayClient.kernel_launch_timeout_pad=5",
247+
"--GatewayClient.launch_timeout_pad=5",
248248
]
249249

250250
GatewayClient.clear_instance()

0 commit comments

Comments
 (0)