Merge pull request #2 from OSC/upgrade/codeserver

Fix authentication issues with code-server

.gitignore

@@ -1,2 +1,3 @@
 /tmp/
 /local/
+/code-server*/

README.md

@@ -37,23 +37,23 @@ use and place this wherever you store batch connect apps (`/var/www/ood/apps/sys
 
     ```sh
     # replace URL with latest release from code-server
-    wget https://github.com/cdr/code-server/releases/download/2.1692-vsc1.39.2/code-server2.1692-vsc1.39.2-linux-x86_64.tar.gz
-    tar -xzf code-server2.1692-vsc1.39.2-linux-x86_64.tar.gz
+    wget https://github.com/cdr/code-server/releases/download/3.2.0/code-server-3.2.0-linux-x86_64.tar.gz
+    tar -xzf code-server-3.2.0-linux-x86_64.tar.gz
     ```
 
 3. You will notice code-server is an executable inside that directory and can get the full path: 
 
     ```sh
-    $ readlink -f code-server2.1692-vsc1.39.2-linux-x86_64/code-server
-    /users/PZS0562/efranz/code-server2.1692-vsc1.39.2-linux-x86_64/code-server
+    $ readlink -f code-server-3.2.0-linux-x86_64.tar.gz
+    /users/PZS0562/efranz/code-server-3.2.0-linux-x86_64.tar.gz
     ```
 
 4. Update the path to the code-server binary in the script https://github.com/OSC/bc_osc_codeserver/blob/3082790ee69c82fe6fe757074da7d8d18c7d7e3d/template/script.sh.erb#L27:
 
     ```diff
      # An arbitrary path...
     - /fs/project/PZS0714/mrodgers/bin/code-server-2.1523-vsc1.38.1 \
-    + /users/PZS0562/efranz/code-server2.1692-vsc1.39.2-linux-x86_64/code-server \
+    + /users/PZS0562/efranz/code-server-3.2.0-linux-x86_64/code-server \
      --auth=password \
      --port="$port" \
     ```

form.yml

@@ -10,4 +10,4 @@ attributes:
     data-filepicker: true
     data-target-file-type: dirs  # Valid values are: files, dirs, or both
     readonly: false
-    help: "Select your project directory; defaults to $HOME"
+    help: "Select your project directory; defaults to $HOME"

submit.yml.erb

@@ -4,4 +4,4 @@ batch_connect:
 script:
   native:
     resources:
-      nodes: "1:ppn=1:owens"
+      nodes: "1:ppn=2:owens"

template/after.sh.erb

@@ -1,9 +1,11 @@
-# Wait for the Jupyter server to start
-echo "Waiting for Jupyter server to open port ${port}..."
+# Wait for the Code Server to start
+echo "$(date): Waiting for Code Server to open port ${port}..."
+
 if wait_until_port_used "${host}:${port}" 600; then
-  echo "Discovered code-server listening on port ${port}!"
+  echo "$(date): Discovered code-server listening on port ${port}!"
 else
-  echo "Timed out waiting for Jupyter server to open port ${port}!"
+  echo "$(date): Timed out waiting for Code Server to open port ${port}!"
   clean_up 1
 fi
+
 sleep 2

template/before.sh.erb

@@ -1,8 +1,11 @@
-# # Export the module function if it exists
+# Export the module function if it exists
 [[ $(type -t module) == "function" ]] && export -f module
 
-# # Find available port to run server on
+# Find available port to run server on
 export port=$(find_port ${host})
 
-# # Generate SHA1 encrypted password (requires OpenSSL installed)
+# Export compute node the script is running on
+export host="${host}"
+
+# Generate SHA1 encrypted password (requires OpenSSL installed)
 export password="$(create_passwd 16)"

template/script.sh.erb

@@ -1,38 +1,53 @@
 #!/usr/bin/env bash
-<%-
-    # Ensure that code-server always starts up in either a user defined directory or the home directory
-    working_dir = Pathname.new(context.working_dir)
-    if ! working_dir.exist? || working_dir.to_s.empty?
-        working_dir = Pathname.new(ENV['HOME'])
-    elsif working_dir.file?
-        working_dir = working_dir.parent
-    end
+<%
+# Determine the application root from session token.
+app_root = BatchConnect::App.from_token(session.token).root.realpath
+
+# Set our working directory.
+working_dir = Pathname.new(context.working_dir)
+
+# Ensure that code-server always starts up in either a user defined directory or the home directory.
+if ! working_dir.exist?
+    working_dir = Pathname.new(ENV['HOME'])
+elsif working_dir.file?
+    working_dir = working_dir.parent
+end
 %>
 
-# Setup environment
-CODE_SERVER="${CODE_SERVER:-/users/PZS0562/efranz/code-server2.1692-vsc1.39.2-linux-x86_64/code-server}"
+# Setup environment.
+APP_ROOT="<%= app_root.to_s %>"
 CODE_SERVER_DATAROOT="$HOME/.local/share/bc_osc_codeserver"
 
+# Path to Code Server binary. /code-server/ is expected to be a symlink to #{CODE_SERVER_FOLDER}/bin/code-server
+#
+# ln -s code-server-3.3.1-linux-x86_64 code-server
+CODE_SERVER="${CODE_SERVER:-${APP_ROOT}/code-server/bin/code-server}"
 
-# Ensure a dataroot for Code Server
+# Ensure a dataroot for Code Server.
 mkdir -p "$CODE_SERVER_DATAROOT/extensions"
 
-# Expose the password to the server
+# Expose the password to the server.
 export PASSWORD="$password"
 
-# VSCode complains that system git is too old
+# Print compute node.
+echo "$(date): Running on compute node ${compute_node}:$port"
+
+# VSCode complains that system git is too old.
 module load git
 
+echo ""
+
 #
-# Start Code Server
+# Start Code Server.
 #
-echo $CODE_SERVER
+echo "$(date): Started code-server"
+echo ""
 
-# An arbitrary path...
 $CODE_SERVER \
-    --auth=password \
-    --port="$port" \
+    --auth="password" \
+    --bind-addr="0.0.0.0:${port}" \
     --disable-telemetry \
     --extra-extensions-dir="$CODE_SERVER_DATAROOT/extensions" \
     --user-data-dir="$CODE_SERVER_DATAROOT" \
+    --log debug \
     "<%= working_dir.to_s %>"

view.html.erb

@@ -1,6 +1,30 @@
-<form action="/rnode/<%= host %>/<%= port %>/login" method="post" target="_blank">
-  <input type="hidden" name="password" value="<%= password %>">
+<%
+  require 'digest'
+
+  # Generate form id, based on host and port
+  form_id = Digest::SHA1.hexdigest("--" + host.to_s + "--" + port.to_s + "--")
+
+  # Generate SHA256 digest of Code Server Password
+  cookieValue = Digest::SHA256.hexdigest(password)
+%>
+
+<script type="text/javascript">
+(function () {
+  let date = new Date()
+  date.setTime(date.getTime() + (7*24*60*60*1000))
+  let expires = "expires=" + date.toUTCString()
+  let cookiePath = "path=/rnode/" + "<%= host.to_s %>" + "/" + "<%= port.to_s %>/";
+  /**
+    We have to use "key" as the cookie name since upstream in cdr/code-server
+    the authentication cookie is hard coded "key"
+  */
+  let cookie = `key=<%= cookieValue %>;${expires};${cookiePath};secure`;
+  document.cookie = cookie;
+})();
+</script>
+
+<form id="<%= form_id %>" action="/rnode/<%= host %>/<%= port %>/" method="get" target="_blank">
   <button class="btn btn-primary" type="submit">
-    <i class="fa fa-cogs"></i> Connect to Code Server
+    <i class="fa fa-cogs"></i> Connect to VS Code
   </button>
 </form>