Merge branch 'main' into feature/support_args

Author: goebbert1

.github/dependabot.yaml

@@ -0,0 +1,16 @@
+# dependabot.yaml reference: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+#
+# Notes:
+# - Status and logs from dependabot are provided at
+#   https://github.com/jupyterhub/jupyterhub-python-repo-template/network/updates.
+#
+version: 2
+updates:
+  # Maintain dependencies in our GitHub Workflows
+  - package-ecosystem: github-actions
+    directory: /
+    labels: [ci]
+    schedule:
+      interval: monthly
+      time: "05:00"
+      timezone: Etc/UTC

.github/workflows/release.yaml

@@ -0,0 +1,54 @@
+# This is a GitHub workflow defining a set of jobs with a set of steps.
+# ref: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
+#
+name: Release
+
+# Always tests wheel building, but only publish to PyPI on pushed tags.
+on:
+  pull_request:
+    paths-ignore:
+      - "**.md"
+      - ".github/workflows/*.yaml"
+      - "!.github/workflows/release.yaml"
+  push:
+    paths-ignore:
+      - "**.md"
+      - ".github/workflows/*.yaml"
+      - "!.github/workflows/release.yaml"
+    branches-ignore:
+      - "dependabot/**"
+      - "pre-commit-ci-update-config"
+    tags: ["**"]
+  workflow_dispatch:
+
+jobs:
+  build-release:
+    runs-on: ubuntu-24.04
+    permissions:
+      # id-token=write is required for pypa/gh-action-pypi-publish, and the PyPI
+      # project needs to be configured to trust this workflow.
+      #
+      # ref: https://github.com/jupyterhub/team-compass/issues/648
+      #
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: install build package
+        run: |
+          pip install --upgrade pip
+          pip install build
+          pip freeze
+
+      - name: build release
+        run: |
+          python -m build --sdist --wheel .
+          ls -l dist
+
+      - name: publish to pypi
+        uses: pypa/gh-action-pypi-publish@release/v1
+        if: startsWith(github.ref, 'refs/tags/')

.travis.yml

@@ -1,23 +1,48 @@
-# 2.2.0 - 2023-06-12
+# Changelog
+
+## 2.2
+
+### 2.2.1 - 2024-03-13
+
+([full changelog](https://github.com/jupyterhub/jupyter-rsession-proxy/compare/v2.2.0...v2.2.1))
+
+#### Merged PRs
+
+- Update requirements for jupyter-server-proxy [#146](https://github.com/jupyterhub/jupyter-rsession-proxy/pull/146) ([@consideRatio](https://github.com/consideRatio), [@ryanlovett](https://github.com/ryanlovett))
+- Add new RStudio icon [#125](https://github.com/jupyterhub/jupyter-rsession-proxy/pull/125) ([@danilopeixoto](https://github.com/danilopeixoto), [@yuvipanda](https://github.com/yuvipanda))
+
+#### Contributors to this release
+
+The following people contributed discussions, new ideas, code and documentation contributions, and review.
+See [our definition of contributors](https://github-activity.readthedocs.io/en/latest/#how-does-this-tool-define-contributions-in-the-reports).
+
+([GitHub contributors page for this release](https://github.com/jupyterhub/jupyter-rsession-proxy/graphs/contributors?from=2023-06-23&to=2024-03-13&type=c))
+
+@benz0li ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-rsession-proxy+involves%3Abenz0li+updated%3A2023-06-23..2024-03-13&type=Issues)) | @danilopeixoto ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-rsession-proxy+involves%3Adanilopeixoto+updated%3A2023-06-23..2024-03-13&type=Issues)) | @eeholmes ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-rsession-proxy+involves%3Aeeholmes+updated%3A2023-06-23..2024-03-13&type=Issues)) | @ryanlovett ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-rsession-proxy+involves%3Aryanlovett+updated%3A2023-06-23..2024-03-13&type=Issues)) | @yuvipanda ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-rsession-proxy+involves%3Ayuvipanda+updated%3A2023-06-23..2024-03-13&type=Issues))
+
+### 2.2.0 - 2023-06-12
 
 ([full changelog](https://github.com/jupyterhub/jupyter-rsession-proxy/compare/v2.1.0...8a87f3fbb21015927cfb30aec63af791fb0a19bc))
 
-## Merged PRs
+#### Merged PRs
 
+- Prepare 2.2.0 release. [#141](https://github.com/jupyterhub/jupyter-rsession-proxy/pull/141) ([@ryanlovett](https://github.com/ryanlovett))
 - add float conversion for timeout [#137](https://github.com/jupyterhub/jupyter-rsession-proxy/pull/137) ([@matuskosut](https://github.com/matuskosut))
 - Fix netloc when rstudio-server inserts port. [#134](https://github.com/jupyterhub/jupyter-rsession-proxy/pull/134) ([@ryanlovett](https://github.com/ryanlovett))
 
-## Contributors to this release
+#### Contributors to this release
 
 ([GitHub contributors page for this release](https://github.com/jupyterhub/jupyter-rsession-proxy/graphs/contributors?from=2022-09-07&to=2023-06-12&type=c))
 
 [@matuskosut](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-rsession-proxy+involves%3Amatuskosut+updated%3A2022-09-07..2023-06-12&type=Issues) | [@ryanlovett](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-rsession-proxy+involves%3Aryanlovett+updated%3A2022-09-07..2023-06-12&type=Issues) | [@welcome](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-rsession-proxy+involves%3Awelcome+updated%3A2022-09-07..2023-06-12&type=Issues)
 
-# 2.1.0 - 2022-09-07
+## 2.1
+
+### 2.1.0 - 2022-09-07
 
 ([full changelog](https://github.com/jupyterhub/jupyter-rsession-proxy/compare/v2.0...v2.1.0))
 
-## Merged PRs
+#### Merged PRs
 
 - use NB_USER rather than getpass.getuser() [#132](https://github.com/jupyterhub/jupyter-rsession-proxy/pull/132) ([@vivian-rook](https://github.com/vivian-rook))
 - add 10s default timeout and environment varariable [#128](https://github.com/jupyterhub/jupyter-rsession-proxy/pull/128) ([@matuskosut](https://github.com/matuskosut))
@@ -27,13 +52,15 @@
 - Add CHANGELOG.md. [#112](https://github.com/jupyterhub/jupyter-rsession-proxy/pull/112) ([@ryanlovett](https://github.com/ryanlovett))
 - Add conda install instructions [#68](https://github.com/jupyterhub/jupyter-rsession-proxy/pull/68) ([@xhochy](https://github.com/xhochy))
 
-## Contributors to this release
+#### Contributors to this release
 
 ([GitHub contributors page for this release](https://github.com/jupyterhub/jupyter-rsession-proxy/graphs/contributors?from=2021-12-01&to=2022-09-07&type=c))
 
 [@ccoulombe](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-rsession-proxy+involves%3Accoulombe+updated%3A2021-12-01..2022-09-07&type=Issues) | [@guimou](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-rsession-proxy+involves%3Aguimou+updated%3A2021-12-01..2022-09-07&type=Issues) | [@lucianolacurcia](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-rsession-proxy+involves%3Alucianolacurcia+updated%3A2021-12-01..2022-09-07&type=Issues) | [@mathematicalmichael](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-rsession-proxy+involves%3Amathematicalmichael+updated%3A2021-12-01..2022-09-07&type=Issues) | [@matuskosut](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-rsession-proxy+involves%3Amatuskosut+updated%3A2021-12-01..2022-09-07&type=Issues) | [@moschlar](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-rsession-proxy+involves%3Amoschlar+updated%3A2021-12-01..2022-09-07&type=Issues) | [@riazarbi](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-rsession-proxy+involves%3Ariazarbi+updated%3A2021-12-01..2022-09-07&type=Issues) | [@ryanlovett](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-rsession-proxy+involves%3Aryanlovett+updated%3A2021-12-01..2022-09-07&type=Issues) | [@vivian-rook](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-rsession-proxy+involves%3Avivian-rook+updated%3A2021-12-01..2022-09-07&type=Issues) | [@welcome](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-rsession-proxy+involves%3Awelcome+updated%3A2021-12-01..2022-09-07&type=Issues) | [@xhochy](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-rsession-proxy+involves%3Axhochy+updated%3A2021-12-01..2022-09-07&type=Issues) | [@yuvipanda](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-rsession-proxy+involves%3Ayuvipanda+updated%3A2021-12-01..2022-09-07&type=Issues)
 
-# 2.0 - 2021-12-01
+## 2.0
+
+### 2.0 - 2021-12-01
 
 #### BREAKING CHANGES
 
@@ -47,13 +74,13 @@
 
 * Bump jupyter-server-proxy from 3.1.0 to 3.2.0.
 
-## Merged PRs
+#### Merged PRs
 
 * Rewrite /auth-sign-in redirect. [#110](https://github.com/jupyterhub/jupyter-rsession-proxy/pull/110) ([@ryanlovett](https://github.com/ryanlovett))
 * Bump to v1.4. [#105](https://github.com/jupyterhub/jupyter-rsession-proxy/pull/105) ([@ryanlovett](https://github.com/ryanlovett))
 * Use tmp file for secure cookie [#98](https://github.com/jupyterhub/jupyter-rsession-proxy/pull/98) ([@danielfrg](https://github.com/danielfrg))
 
-## Contributors to this release
+#### Contributors to this release
 
 ([GitHub contributors page for this release](https://github.com/jupyterhub/jupyter-rsession-proxy/graphs/contributors?from=2021-07-03&to=2021-11-30&type=c))
 

CHANGELOG.md

@@ -0,0 +1,61 @@
+# How to make a release
+
+`jupyterhub-python-repo-template` is a package available on [PyPI] and
+[conda-forge].
+
+These are the instructions on how to make a release.
+
+## Pre-requisites
+
+- Push rights to this GitHub repository
+
+## Steps to make a release
+
+1. Create a PR updating `CHANGELOG.md` with [github-activity] and continue when
+   its merged. For details about this, see the [team-compass documentation]
+   about it.
+
+   [team-compass documentation]: https://jupyterhub-team-compass.readthedocs.io/en/latest/practices/releases.html
+
+2. Checkout main and make sure it is up to date.
+
+   ```shell
+   git checkout main
+   git fetch origin main
+   git reset --hard origin/main
+   ```
+
+3. Update the version, make commits, and push a git tag with `tbump`.
+
+   ```shell
+   pip install tbump
+   ```
+
+   `tbump` will ask for confirmation before doing anything.
+
+   ```shell
+   # Example versions to set: 1.0.0, 1.0.0b1
+   VERSION=
+   tbump ${VERSION}
+   ```
+
+   Following this, the [CI system] will build and publish a release.
+
+4. Reset the version back to dev, e.g. `1.0.1.dev` after releasing `1.0.0`.
+
+   ```shell
+   # Example version to set: 1.0.1.dev
+   NEXT_VERSION=
+   tbump --no-tag ${NEXT_VERSION}.dev
+   ```
+
+5. Following the release to PyPI, an automated PR should arrive within 24 hours
+   to [conda-forge/jupyterhub-python-repo-template-feedstock] with instructions
+   on releasing to conda-forge. You are welcome to volunteer doing this, but
+   aren't required as part of making this release to PyPI.
+
+[github-activity]: https://github.com/executablebooks/github-activity
+[pypi]: https://pypi.org/project/jupyterhub-python-repo-template/
+[conda-forge]: https://anaconda.org/conda-forge/jupyterhub-python-repo-template
+[conda-forge/jupyterhub-python-repo-template-feedstock]: https://github.com/conda-forge/jupyterhub-python-repo-template-feedstock
+[ci system]: https://github.com/jupyterhub/jupyterhub-python-repo-template/actions/workflows/release.yaml

RELEASE.md

@@ -51,7 +51,7 @@ def get_system_user():
     return(user)
 
 def setup_rserver():
-    def _get_env(port):
+    def _get_env(port, unix_socket):
         return dict(USER=get_system_user())
 
     def db_config(db_dir):
@@ -84,7 +84,7 @@ def _get_www_frame_origin(default="same"):
         except Exception:
             return default
 
-    def _get_cmd(port):
+    def _get_cmd(port, unix_socket):
         ntf = tempfile.NamedTemporaryFile()
 
         # use mkdtemp() so the directory and its contents don't vanish when
@@ -96,7 +96,6 @@ def _get_cmd(port):
             get_rstudio_executable('rserver'),
             '--auth-none=1',
             '--www-frame-origin=' + _get_www_frame_origin(),
-            '--www-port=' + str(port),
             '--www-verify-user-agent=0',
             '--secure-cookie-key-file=' + ntf.name,
             '--server-user=' + get_system_user(),
@@ -125,9 +124,13 @@ def _get_cmd(port):
             except:
                 pass
 
-        #if unix_socket != "":
-        #    if supported_args['www-socket']:
-        #         cmd.append('--www-socket={unix_socket}')
+        if unix_socket != "":
+            if supported_args['www-socket']:
+                 cmd.append('--www-socket={unix_socket}')
+            else:
+                raise NotImplementedError(f'rstudio-server does not support requested socket connection')
+        else:
+            cmd.append('--www-port={port}')
 
         return cmd
 
@@ -147,6 +150,16 @@ def _get_timeout(default=15):
             'icon_path': get_icon_path()
         }
     }
+
+    use_socket = os.getenv('JUPYTER_RSESSION_PROXY_USE_SOCKET')
+    if use_socket is not None:
+        # If this env var is anything other than case insensitive 'no' or 'false',
+        # use unix sockets instead of tcp sockets. This allows us to default to
+        # using unix sockets by default in the future once this feature is better
+        # tested, and allow people to turn it off if needed.
+        if use_socket.casefold() not in ('no', 'false'):
+            server_process['unix_socket'] = True
+
     return server_process
 
 def setup_rsession():

jupyter_rsession_proxy/__init__.py

@@ -0,0 +1,27 @@
+# tbump is used to simplify and standardize the release process when updating
+# the version, making a git commit and tag, and pushing changes.
+#
+# ref: https://github.com/your-tools/tbump#readme
+#
+[tool.tbump]
+github_url = "https://github.com/jupyterhub/jupyter-rsession-proxy"
+
+[tool.tbump.version]
+current = "2.2.1"
+regex = '''
+    (?P<major>\d+)
+    \.
+    (?P<minor>\d+)
+    \.
+    (?P<patch>\d+)
+    (?P<pre>((a|b|rc)\d+)|)
+    \.?
+    (?P<dev>(?<=\.)dev\d*|)
+'''
+
+[tool.tbump.git]
+message_template = "Bump to v{new_version}"
+tag_template = "v{new_version}"
+
+[[tool.tbump.file]]
+src = "setup.py"