Skip to content

Commit 7e992ae

Browse files
committed
docs,feat Address PR Feedback
Update name and verbiage.
1 parent 0bedf09 commit 7e992ae

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

docs/source/server-process.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,15 +157,15 @@ One of:
157157
- A callable that takes any {ref}`callable arguments <server-process:callable-arguments>`,
158158
and returns a dictionary of strings that are used & treated same as above.
159159

160-
### `skip_activity_reporting`
160+
### `update_last_activity`
161161

162-
Whether to report activity from the proxy to JupyterHub. If _True_, JupyterHub
162+
Whether to report activity from the proxy to Jupyter Server. If _True_, Jupyter Server
163163
will not be notified of new activity.
164164

165165
Useful if you want to have a seperate way of determining activity through a
166166
proxied application.
167167

168-
Defaults to _False_.
168+
Defaults to _True_.
169169

170170
(server-process:callable-arguments)=
171171

jupyter_server_proxy/config.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
"new_browser_tab",
4343
"request_headers_override",
4444
"rewrite_response",
45-
"skip_activity_reporting",
45+
"update_last_activity",
4646
],
4747
)
4848

@@ -58,7 +58,7 @@ def __init__(self, *args, **kwargs):
5858
self.unix_socket = sp.unix_socket
5959
self.mappath = sp.mappath
6060
self.rewrite_response = sp.rewrite_response
61-
self.skip_activity_reporting = sp.skip_activity_reporting
61+
self.update_last_activity = sp.update_last_activity
6262

6363
def get_request_headers_override(self):
6464
return self._realize_rendered_template(sp.request_headers_override)
@@ -83,7 +83,7 @@ def __init__(self, *args, **kwargs):
8383
self.requested_unix_socket = sp.unix_socket
8484
self.mappath = sp.mappath
8585
self.rewrite_response = sp.rewrite_response
86-
self.skip_activity_reporting = sp.skip_activity_reporting
86+
self.update_last_activity = sp.update_last_activity
8787

8888
def get_env(self):
8989
return self._realize_rendered_template(sp.environment)
@@ -166,8 +166,8 @@ def make_server_process(name, server_process_config, serverproxy_config):
166166
"rewrite_response",
167167
tuple(),
168168
),
169-
skip_activity_reporting=server_process_config.get(
170-
"skip_activity_reporting", False
169+
update_last_activity=server_process_config.get(
170+
"update_last_activity", True
171171
),
172172
)
173173

@@ -290,8 +290,8 @@ def cats_only(response, path):
290290
291291
Defaults to the empty tuple ``tuple()``.
292292
293-
skip_activity_reporting
294-
Will cause the proxy to not report activity back to JupyterHub.
293+
update_last_activity
294+
Will cause the proxy to report activity back to jupyter server.
295295
""",
296296
config=True,
297297
)

jupyter_server_proxy/handlers.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ def __init__(self, *args, **kwargs):
117117
tuple(),
118118
)
119119
self._requested_subprotocols = None
120-
self.skip_activity_reporting = kwargs.pop("skip_activity_reporting", False)
120+
self.update_last_activity = kwargs.pop("update_last_activity", True)
121121
super().__init__(*args, **kwargs)
122122

123123
# Support/use jupyter_server config arguments allow_origin and allow_origin_pat
@@ -235,7 +235,7 @@ def _record_activity(self):
235235
avoids proxied traffic being ignored by the notebook's
236236
internal idle-shutdown mechanism
237237
"""
238-
if not self.skip_activity_reporting:
238+
if self.update_last_activity:
239239
self.settings["api_last_activity"] = utcnow()
240240

241241
def _get_context_path(self, host, port):

0 commit comments

Comments
 (0)