carta-controller 4.0.0 → 4.1.1

package/.readthedocs.yaml

@@ -0,0 +1,22 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/src/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - requirements: docs/requirements.txt

package/README.md

@@ -1,6 +1,6 @@
 # CARTA Controller
 
-[![carta version](https://img.shields.io/badge/CARTA%20Version-4.0.0-brightgreen)](https://github.com/CARTAvis/carta-backend/releases/tag/v4.0.0-rc.0)
+[![carta version](https://img.shields.io/badge/CARTA%20Version-4.1.0-brightgreen)](https://github.com/CARTAvis/carta-backend/releases/tag/v4.1.0)
 [![npm version](https://img.shields.io/npm/v/carta-controller?style=flat)](https://npmjs.org/package/carta-controller "View this project on npm")
 ![last commit](https://img.shields.io/github/last-commit/CARTAvis/carta-controller)
 ![commit activity](https://img.shields.io/github/commit-activity/m/CARTAvis/carta-controller)

package/dist/controllerTests.js

@@ -188,7 +188,8 @@ function testBackendStartup(username) {
             "-u",
             `${username}`,
             config_1.ServerConfig.processCommand,
-            "--no_http",
+            "--no_frontend",
+            "--no_database",
             "--debug_no_auth",
             "--port",
             `${port}`,

package/dist/serverHandlers.js

@@ -185,7 +185,8 @@ function startServer(username) {
                 "-u",
                 `${username}`,
                 config_1.ServerConfig.processCommand,
-                "--no_http",
+                "--no_frontend",
+                "--no_database",
                 "--port",
                 `${port}`,
                 "--top_level_folder",

package/dist/util.js

@@ -41,29 +41,12 @@ function verboseError(...args) {
 }
 exports.verboseError = verboseError;
 function getUserId(username) {
-    var _a;
     if (!username) {
         throw new Error("Missing argument for username");
     }
-    let usernameRegex = undefined;
-    if (process.env.NAME_REGEX) {
-        try {
-            usernameRegex = new RegExp(process.env.NAME_REGEX);
-        }
-        catch (err) {
-            console.warn(err);
-        }
-    }
-    if (!usernameRegex) {
-        // As specified in useradd manpage
-        usernameRegex = /^[a-z_][a-z0-9_-]*[$]?$/gm;
-    }
-    if (!username.match(usernameRegex)) {
-        throw new Error("Malformed argument for username");
-    }
-    const result = (_a = (0, child_process_1.spawnSync)("id", ["-u", username])) === null || _a === void 0 ? void 0 : _a.stdout;
-    if (result) {
-        const uid = Number.parseInt(result);
+    const result = (0, child_process_1.spawnSync)("id", ["-u", username]);
+    if (!result.status && (result === null || result === void 0 ? void 0 : result.stdout)) {
+        const uid = Number.parseInt(result.stdout);
         if (isFinite(uid)) {
             return uid;
         }

package/docs/src/almalinux8_instructions.rst

@@ -11,12 +11,12 @@ Step-by-step instructions for AlmaLinux 8
 1. Install Node.js
 ~~~~~~~~~~~~~~~~~~
 
-The CARTA controller uses `Node.js <https://nodejs.org/>`_ and supports v12, v14, and v16. Node.js can easily be installed from the AlmaLinux 8 AppStream repository. Here we install v14, as well as the ``npm`` package manager.
+The CARTA controller uses `Node.js <https://nodejs.org/>`_, which can easily be installed from the AlmaLinux 8 AppStream repository. We recommend using the `latest LTS version <https://github.com/nodejs/release#release-schedule>`_. The oldest version known to work with the controller is v16. Here we install v20, as well as the ``npm`` package manager.
 
 .. code-block:: shell
 
-    # Install Node.js v14:
-    sudo dnf module enable nodejs:14
+    # Install Node.js v20:
+    sudo dnf module enable nodejs:20
     sudo dnf install -y nodejs npm
 
     # Check it is installed and working:
@@ -54,7 +54,10 @@ The CARTA controller uses `MongoDB <https://www.mongodb.com/>`_ to store user pr
 .. note::
 
     On RHEL7/CentOS7, MongoDB v14 can be installed as follows:
-    ``curl -fsSL https://rpm.nodesource.com/setup_14.x | bash - && yum install -y nodejs``
+    
+    .. code-block:: shell
+    
+        curl -fsSL https://rpm.nodesource.com/setup_14.x | bash - && yum install -y nodejs
 
 
 3. Install the CARTA controller
@@ -66,6 +69,15 @@ The easiest way to install the CARTA controller is using ``npm``.
 
     sudo dnf install -y python3 make gcc-c++
     sudo npm install -g --unsafe-perm carta-controller
+    
+    
+.. note::
+
+    If you would like to install the latest **beta** release of CARTA, please install the ``beta`` tag of the controller instead:
+    
+    .. code-block:: shell
+    
+        sudo npm install -g --unsafe-perm carta-controller@beta
 
 .. note::
 
@@ -98,8 +110,22 @@ The easiest way is to install the CARTA backend is from our `cartavis/carta Copr
     sudo dnf -y install carta-backend
 
     # Check that the backend can run and matches the major version number of the controller.
-    # Please note, we currently install the version of carta_backend in a non-standard location.
-    /opt/carta/bin/carta_backend --version
+    /usr/bin/carta_backend --version
+
+.. note::
+    The ``carta-backend`` package is updated with every stable CARTA release. If you would like to install the latest **beta** version of CARTA, or to receive beta release updates as well as stable release updates in the future, please install ``carta-backend-beta`` instead:
+    
+    .. code-block:: shell
+    
+        sudo dnf -y install carta-backend-beta
+    
+    Make sure that you install the matching controller version (using the ``beta`` tag).
+
+    We currently install the beta version of ``carta_backend`` in a non-standard location:
+    
+    .. code-block:: shell
+    
+        /opt/carta-beta/bin/carta_backend --version
 
 
 5. Install Nginx
@@ -163,11 +189,11 @@ An :ref:`example sudoers configuration<example_sudoers>` is provided in the conf
     The ``carta`` user should not be in the ``carta-users`` group. ``carta-users`` should only be assigned to the normal user accounts.
 
 .. note::
-    As we install the version of the carta_backend in a non-standard location, please remember to change the path to the carta_backend executable in the custom sudoers file:
-
-   .. code-block:: bash
-
-      carta ALL=(%carta-users) NOPASSWD:SETENV: /opt/carta/bin/carta_backend
+    If you have installed the **beta** version of CARTA, please remember to change the path to the ``carta_backend`` executable in the sudoers file:
+    
+    .. code-block:: bash
+    
+        carta ALL=(%carta-users) NOPASSWD:SETENV: /opt/carta-beta/bin/carta_backend
 
 7. Set up the user authentication method
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

package/docs/src/conf.py

@@ -18,11 +18,11 @@
 # -- Project information -----------------------------------------------------
 
 project = 'CARTA Controller'
-copyright = '2021, Angus Comrie, Adrianna Pińska and Robert Simmonds'
-author = 'Angus Comrie, Adrianna Pińska and Robert Simmonds'
+copyright = '2021, Angus Comrie, Adrianna Pińska, David Aikema and Robert Simmonds'
+author = 'Angus Comrie, Adrianna Pińska, David Aikema and Robert Simmonds'
 
 # The full version, including alpha/beta/rc tags
-release = '4.0.0'
+release = '4.1.0'
 
 
 # -- General configuration ---------------------------------------------------

package/docs/src/configuration.rst

@@ -147,10 +147,11 @@ To test the configuration of the controller, you can use the built-in test featu
     [
     'running sudo --preserve-env=CARTA_AUTH_TOKEN -n -u alice /usr/bin/carta_backend --no_http --debug_no_auth --port 3499 --top_level_folder /usr/share/carta --no_log /usr/share/carta'
     ]
-    [2023-11-30 12:28:48.207] [info] /usr/bin/carta_backend: Version 4.0.0
-    [2023-11-30 12:28:48.209] [info] Listening on port 3499 with top level folder /usr/share/carta, starting folder /usr/share/carta. The number of OpenMP worker threads will be handled automatically.
+    [2024-01-19 08:30:05.888Z] [CARTA] [info] /usr/bin/carta_backend: Version 4.1.0
+    [2024-01-19 08:30:05.888Z] [CARTA] [info] Listening on port 3499 with top level folder /usr/share/carta, starting folder /usr/share/carta, and 8 OpenMP worker threads
     ✔ Backend process started successfully
-    [2023-11-30 12:28:50.169] [info] Session 1 [127.0.0.1] Connected. Num sessions: 1
+    [2024-01-19 08:30:07.850Z] [CARTA] [info] 0x561f1a635180 ::Session (1235524527:1)
+    [2024-01-19 08:30:07.850Z] [CARTA] [info] Session 1235524527 [127.0.0.1] Connected. Num sessions: 1
     ✔ Backend process accepted connection
     [ 'running sudo -u alice ./scripts/carta_kill_script.sh 54275' ]
     ✔ Backend process killed correctly

package/docs/src/index.rst

@@ -25,9 +25,9 @@ We officially support Ubuntu 18.04 and 20.04, and RHEL 7 and 8 (and their freely
    schema
    schema_backend
 
-.. |backend-github| image:: https://img.shields.io/badge/CARTA%20Version-4.0.0-brightgreen
+.. |backend-github| image:: https://img.shields.io/badge/CARTA%20Version-4.1.0-brightgreen
         :alt: View this backend version on GitHub
-        :target: https://github.com/CARTAvis/carta-backend/releases/tag/v4.0.0
+        :target: https://github.com/CARTAvis/carta-backend/releases/tag/v4.1.0
 
 .. |npm-package| image:: https://img.shields.io/npm/v/carta-controller?style=flat
         :alt: View this project on npm

package/docs/src/installation.rst

@@ -3,16 +3,22 @@
 Installation
 ============
 
+This section provides a general overview. For a more detailed installation guide, please refer to our step-by-step instructions for :ref:`Ubuntu<focal_instructions>` or :ref:`RPM-based distributions<almalinux8_instructions>`.
+
 .. _install_backend:
 
 Installing the backend
 ----------------------
 
-We provide `binary Ubuntu packages <https://launchpad.net/~cartavis-team/+archive/ubuntu/carta>`_ of the latest beta and release versions of the CARTA backend. You can install the beta version with all dependencies by adding our PPA to your system and running ``apt-get install carta-backend-beta``. Please refer to our :ref:`Ubuntu Focal instructions<focal_instructions>` for more details.
+We provide binary `Ubuntu packages <https://launchpad.net/~cartavis-team/+archive/ubuntu/carta>`_ and `RPM packages <https://copr.fedorainfracloud.org/coprs/cartavis/carta>`_ of the latest beta and stable releases of the CARTA backend. You can install the latest stable version with all dependencies on Ubuntu by adding our PPA to your system and running ``apt-get install carta-backend``.
+
+.. note::
+
+    The ``carta-backend`` package is updated with every stable CARTA release. If you would like to install the latest **beta** version of CARTA, or to receive beta release updates as well as stable release updates in the future, please install the ``carta-backend-beta`` package instead.
 
 .. note::
 
-    The ``casacore-data`` package is recommended by the backend package, but installing it is optional. The packages in our PPA should be compatible both with the ``casacore-data`` package in the core Ubuntu repositories and with the package provided by the `Kern PPAs <https://launchpad.net/~kernsuite>`_. You may also wish to manage the required data files without using a package.
+    The ``casacore-data`` package is recommended by the Ubuntu backend package, but installing it is optional. The packages in our PPA should be compatible both with the ``casacore-data`` package in the core Ubuntu repositories and with the package provided by the `Kern PPAs <https://launchpad.net/~kernsuite>`_. You may also wish to manage the required data files without using a package.
 
 To install the backend on a different host system, or to install a custom version, you can build it from source from the `backend repository <https://github.com/CARTAvis/carta-backend/>`_ on GitHub.
 
@@ -28,7 +34,11 @@ If you install the controller from NPM, the corresponding packaged version of th
 Installing the controller
 -------------------------
 
-You can install the latest release version of the CARTA controller from NPM by running ``npm install -g carta-controller``, or from GitHub by cloning the `controller repository <https://github.com/CARTAvis/carta-controller/>`_ and running ``npm install``.
+You can install the latest stable version of the CARTA controller from NPM by running ``npm install -g carta-controller``, or from GitHub by cloning the `controller repository <https://github.com/CARTAvis/carta-controller/>`_ and running ``npm install``.
+
+.. note::
+
+    If you would like to install the latest **beta** release of CARTA, please install ``carta-controller@beta`` instead.
 
 .. _run_controller:
 

package/docs/src/introduction.rst

@@ -10,14 +10,16 @@ The CARTA controller provides a simple dashboard which authenticates users and a
 Dependencies
 ------------
 
-To allow the controller to serve CARTA sessions, you must give it access to an executable CARTA backend, which can be either a compiled executable or a container. If you want to use a non-standard version of the CARTA frontend, you must also build it, and adjust the controller configuration to point to it. You should use the ``v4.0.0`` tag of `the CARTA backend <https://github.com/CARTAvis/carta-backend>`_.
+To allow the controller to serve CARTA sessions, you must give it access to an executable CARTA backend, which can be either a compiled executable or a container. If you want to use a non-standard version of the CARTA frontend, you must also build it, and adjust the controller configuration to point to it.
 
 By default, the controller runs on port 8000. It should be run behind a proxy, so that it can be accessed via HTTP and HTTPS. 
 
-MongoDB is required for storing user preferences, layouts and (in the near future) controller metrics.
+MongoDB is required for storing user preferences, layouts, workspaces, and (in the near future) controller metrics.
 
 You also need a working `NodeJS LTS <https://nodejs.org/en/about/releases/>`_ installation with NPM. Use ``npm install`` to install all Node dependencies.
 
+Detailed installation instructions are available for :ref:`Ubuntu<focal_instructions>` and :ref:`RPM-based distributions<almalinux8_instructions>`.
+
 .. _authentication:
 
 Authentication support

package/docs/src/ubuntu_focal_instructions.rst

@@ -25,6 +25,17 @@ Install the CARTA backend and other required packages
     # Install additional packages
     sudo apt-get install nginx g++ mongodb make curl
 
+.. note::
+    The ``carta-backend`` package is updated with every stable CARTA release. If you would like to install the latest **beta** version of CARTA, or to receive beta release updates as well as stable release updates in the future, please install the ``carta-backend-beta`` package instead:
+    
+    .. code-block:: shell
+    
+        sudo apt-get install install carta-backend-beta
+    
+    These packages cannot be installed simultaneously, as they use the same install locations. If you install one, you will automatically be prompted to uninstall the other.
+    
+    Make sure that you install the matching controller version (using the ``beta`` tag).
+
 Set up directories and permissions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -63,7 +74,7 @@ Install CARTA controller
 
 .. note::
 
-    Currently supported versions of NodeJS are v12, v14 and v16. In the example below we install the latest LTS version of NodeJS from the `NodeSource repo <https://github.com/nodesource/distributions>`_. Do not pass the ``--unsafe-perm`` flag to ``npm`` if using a local install.
+    We recommend using the `latest LTS version <https://github.com/nodejs/release#release-schedule>`_ of NodeJS. The oldest version known to work with the controller is v16. In the example below we install the latest LTS version from the `NodeSource repo <https://github.com/nodesource/distributions>`_. Do not pass the ``--unsafe-perm`` flag to ``npm`` if using a local install.
 
 .. code-block:: shell
 
@@ -87,6 +98,14 @@ Install CARTA controller
     openssl genrsa -out carta_private.pem 4096
     openssl rsa -in carta_private.pem -outform PEM -pubout -out carta_public.pem
     
+.. note::
+
+    If you would like to install the latest **beta** release of CARTA, please install the ``beta`` tag of the controller instead:
+    
+    .. code-block:: shell
+    
+        sudo npm install -g --unsafe-perm carta-controller@beta
+    
 Configure controller
 ~~~~~~~~~~~~~~~~~~~~
     

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "carta-controller",
-    "version": "4.0.0",
+    "version": "4.1.1",
     "description": "NodeJS-based controller for CARTA",
     "repository": "https://github.com/CARTAvis/carta-controller",
     "homepage": "https://www.cartavis.org",
@@ -24,7 +24,7 @@
         "ajv-formats": "^2.1.0",
         "axios": "^0.27.2",
         "body-parser": "^1.19.0",
-        "carta-frontend": "4.0.0",
+        "carta-frontend": "^4.1.0",
         "chalk": "^4.1.2",
         "compression": "^1.7.4",
         "cookie-parser": "^1.4.5",

package/scripts/carta_kill_script.sh

@@ -2,16 +2,31 @@
 # This script is a safe way to allow a user to kill specific commands of other users via sudo
 COMMAND_TO_MATCH="carta_backend"
 
-# Gets the child PID of the command (because it is run via sudo)
-CHILD_PID=`pgrep -P $1`
-# Gets the command name of the process to be killed
-COMMAND_OF_PID=`ps -p $CHILD_PID -o comm=`
+# The backend is started with sudo, and there may be multiple nested sudo processes,
+# so we recursively search for a child process with the correct name.
 
-# Only allow processes with the same command name to be killed
-if [ "$COMMAND_OF_PID" == "$COMMAND_TO_MATCH" ]; then
-    kill -9 $CHILD_PID
-    exit $?
-else
-    echo "$COMMAND_OF_PID does not match $COMMAND_TO_MATCH"
-    exit 1
-fi
+# Start with the PID that was passed in
+PID=$1
+
+while : ; do
+    # Get the command name of the process
+    COMMAND_OF_PID=`ps -p $PID -o comm=`
+
+    # If this is the backend process, try to kill it
+    if [ "$COMMAND_OF_PID" == "$COMMAND_TO_MATCH" ]; then
+        kill -9 $PID
+        exit $?
+    fi
+
+    # Otherwise look for a child
+    CHILD_PID=`pgrep -P $PID`
+
+    # If there's no child, exit with an error
+    if [ -z "${CHILD_PID}" ]; then
+        echo "Could not find child process named $COMMAND_TO_MATCH."
+        exit 1
+    fi
+
+    # Otherwise start over with the child process
+    PID=$CHILD_PID
+done

package/docs/_build/html/.buildinfo

@@ -1,4 +0,0 @@
-# Sphinx build info version 1
-# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 80ca7713e4b7333cb6b1a41695aacdb5
-tags: 645f666f9bcd5a90fca523b33c5a78b7