trying to merge main to dolora5

.github/actions/setup/action.yml

@@ -4,9 +4,9 @@ runs:
   using: "composite"
   steps:
     - name: Setup Node
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
-        node-version: "16.x"
+        node-version: "20.x"
     - name: Install Dependencies
       run: npm install
       shell: bash

.github/workflows/deploy.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup
         uses: ./.github/actions/setup
       - name: Build
@@ -18,7 +18,7 @@ jobs:
           VUE_APP_BROWSER_NAME: "CCLAW"
           VUE_APP_NAME: "PDPA DBNO PoC - Draft"
       - name: Deploy
-        uses: crazy-max/ghaction-github-pages@v3
+        uses: crazy-max/ghaction-github-pages@v4
         with:
           target_branch: gh-pages
           build_dir: dist

.github/workflows/test.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup
         uses: ./.github/actions/setup
       - name: Test Purescript

.nvmrc

@@ -1 +1 @@
-19.1.0
+20.5.1

README.md

@@ -25,12 +25,11 @@ NVM is a version manager for node. Follow the instructions on the [nvm github](h
 
 First, install nvm from https://nvm.sh/
 
-Then run the following set of install scripts:
+Then run the following set of install scripts, from inside the vue-pure-pdpa directory:
 
 ```shell
-$ echo 18.16.0 > .nvmrc
-$ nvm use
 $ nvm install
+$ nvm use
 $ nvm exec
 $ npm install -g node-gyp@latest
 $ npm install
@@ -90,15 +89,19 @@ You only have to do this once:
 ```
 mkdir ~/v8kworkdir
 cd ~/v8kworkdir
-export V8K_WORKDIR=~/v8kworkdir
-rsync -va ~/src/smucclaw/vue-pure-pdpa/ vue-big/
+export V8K_WORKDIR=$HOME/v8kworkdir
+git clone git://github.com/smucclaw/vue-pure-pdpa
+rsync -va vue-pure-pdpa/ vue-big/
+(cd vue-big; npm i; npm run deps)
 rsync -va --exclude={.spago,.git,node_modules} vue-big/ vue-small/
 cd vue-small
 ln -s ../vue-big/.git .
 ln -s ../vue-big/node_modules .
 ln -s ../vue-big/.spago .
 ```
 
+Remember to update your gunicorn conf file to set V8K_WORKDIR to the path as above.
+
 This sets you up with `vue-small`, which is a copy of `vue-big`, which is a copy of the `vue-pure-pdpa` repo.
 
 `vue-small` takes up a bit less space, by taking advantage of symlinks to reuse existing files that don't change across copies.

bin/https.md

@@ -0,0 +1,158 @@
+## Initial state.
+In the initial state, both Gunicorn and Vue expose HTTPS on both the loopback (127.0.0.1) 
+and network (172.x.x.x) interfaces and manage their own HTTPS configuration.
+
+```mermaid
+flowchart RL
+    subgraph network
+        network_port_8400(172:8400)-- https ---id1(( ))
+        network_port_8401(172:8401)-- https ---id2(( ))
+    end
+    subgraph localhost
+        loop_port_8400(127:8400)-- https ---id3(( ))
+        loop_port_8401(127:8401)-- https ---id4(( ))
+    end
+    gunicorn[[ gunicorn ]]---network_port_8400
+    gunicorn---loop_port_8400
+    vue[[ vue ]]---network_port_8401
+    vue---loop_port_8401
+```
+
+This creates a hassle during local development as HTTPS either needs to be disabled or configured.
+Disabling HTTPS, while easy, creates unnecessary differences in GitHub.
+Configuring HTTPS for local development is unnecessary work.
+
+## Terminate https
+I thought it might be beneficial to terminate HTTPS on Nginx and have Gunicorn and Vue always use plain HTTP.
+
+```mermaid
+flowchart LR
+    subgraph network
+        direction LR
+        id1(( )) -- HTTPS --- network_port_8400(172:8400)
+        id2(( )) -- HTTPS --- network_port_8401(172:8401)
+    end
+    nginx[[nginx]]
+    network_port_8400 --- nginx
+    network_port_8401 --- nginx
+
+    subgraph localhost
+        direction LR
+        id3(( )) -- http --- loop_port_8400(127:8400)
+        id4(( ))-- http --- loop_port_8401(127:8401)
+    end
+    gunicorn[[ gunicorn ]]
+    loop_port_8400---gunicorn
+    vue[[ vue ]]
+    loop_port_8401---vue
+    nginx---id3
+    nginx---id4
+    linkStyle 0 stroke:red;
+    linkStyle 1 stroke:red;
+    linkStyle 4 stroke:blue;
+    linkStyle 5 stroke:blue;
+```
+
+## Complication #1: Vue doesn't give up the network port.
+
+Unfortunately, Vue doesn't give up the network port. So, after encountering some troubles,
+I had to set up a less straightforward scheme where Nginx proxies the ports by adding 1 to the port number. 
+So HTTPS:8400 is forwarded to HTTP:18400.
+
+```mermaid
+flowchart LR
+    subgraph network
+        direction LR
+        https_172_8400(( )) -- HTTPS --- network_port_8400(172:8400)
+        https_172_8401(( )) -- HTTPS --- network_port_8401(172:8401)
+        https_172_18401(( )) -- HTTP --- network_port_18401(172:18401)
+    end
+    nginx[[nginx]]
+    network_port_8400 --- nginx
+    network_port_8401 --- nginx
+
+    subgraph localhost
+        direction LR
+        http_127_8400(( )) -- http --- loop_port_18400(127:18400)
+        http_127_8401(( ))-- http --- loop_port_18401(127:18401)
+    end
+    gunicorn[[ gunicorn ]]
+    loop_port_18400---gunicorn
+    vue[[ vue ]]
+    loop_port_18401---vue
+    nginx---http_127_8400
+    nginx---http_127_8401
+    network_port_18401---vue
+    linkStyle 0 stroke:red;
+    linkStyle 1 stroke:red;
+    linkStyle 2 stroke:blue;
+    linkStyle 5 stroke:blue;
+    linkStyle 6 stroke:blue;
+```
+
+Respective redirect config for nginx
+```
+proxy_pass http://127.0.0.1:1$server_port;
+```
+Might confuse people as this is an unusual redirect setup.
+
+## Complication #2: Vue needs to proxy WebSockets too.
+Vue relies on WebSockets for communication between the client (web browser) and the server in development mode. 
+Therefore, WebSockets need to be proxied as well.
+
+```mermaid
+flowchart LR
+    subgraph network
+        direction LR
+        https_172_8400(( )) -- HTTPS --- network_port_8400(172:8400)
+        https_172_8401(( )) -- HTTPS --- network_port_8401(172:8401)
+        wss_172_8401(( )) -- WSS --- network_port_8401(172:18401)
+        http_172_8401(( )) -- HTTP --- network_port_18401(172:18401)
+        ws_172_18401(( )) -- WS --- network_port_18401(172:18401)
+    end
+    nginx[[nginx]]
+    network_port_8400 --- nginx
+    network_port_8401 --- nginx
+
+    subgraph localhost
+        direction LR
+        http_127_8400(( )) -- http --- loop_port_18400(127:18400)
+        http_127_8401(( ))-- http --- loop_port_18401(127:18401)
+        ws_127_8401(( ))-- WS --- loop_port_18401(127:18401)
+    end
+    gunicorn[[ gunicorn ]]
+    loop_port_18400---gunicorn
+    vue[[ vue ]]
+    loop_port_18401---vue
+    nginx---http_127_8400
+    nginx---http_127_8401
+    nginx---ws_127_8401
+    network_port_18401---vue
+    linkStyle 0 stroke:red;
+    linkStyle 1 stroke:red;
+    linkStyle 2 stroke:red;
+    linkStyle 3 stroke:blue;
+    linkStyle 4 stroke:blue;
+    linkStyle 7 stroke:blue;
+    linkStyle 8 stroke:blue;
+    linkStyle 9 stroke:blue;
+```
+
+This creates a further complication that when Vue is started in HTTP mode, 
+it creates a dynamically unsecured WebSocket backlink. By default, the Vue client in the 
+browser will try to communicate with the Vue server on `ws://host:18401`, which is not served. 
+This can be explicitly configured in `vue.config.js`:
+
+```javascript
+devServer: {
+    client: {
+        webSocketURL: 'wss://cclaw.legalese.com:8408/ws'
+    }
+}
+```
+However, it needs to know the port on the proxy. This can still be done by templating `vue.config`
+during the generation of the `vue-0xx` work directory, as the external port is known at the time of 
+`vue-0xx` generation. But it further complicates the setup and adds some more "magic".
+
+Basically, what was expected to be a simple proxy setup that simplifies the configuration turned 
+out to be a rather complex setup relying on non-standard configurations and runtime template generation.

bin/v8k

@@ -126,7 +126,7 @@ def do_up(args: argparse.Namespace, workdir: str):
             print("refreshing the purs file", file=sys.stderr)
             # [TODO] do this in a more atomic way with a tmp file and a rename, because the vue server may try to
             #  reread the file too soon, when the cp hasn't completed.
-            purs_file = join(e['dir'], "src", "RuleLib", "PDPADBNO.purs")
+            purs_file = join(e['dir'], "src", "RuleLib", "Interview.purs")
             print(f"cp {args.filename} {purs_file}", file=sys.stderr)
             subprocess.run(["cp", args.filename, purs_file])
             subprocess.run(["touch", join(e['dir'], "v8k.json")])
@@ -184,7 +184,7 @@ def do_up(args: argparse.Namespace, workdir: str):
     rsync_command = f"rsync -a {workdir}/vue-small/ {server_config['dir']}/"
     print(rsync_command, file=sys.stderr)
     subprocess.run([rsync_command], shell=True)
-    subprocess.run(["cp", args.filename, join(server_config['dir'], "src", "RuleLib", "PDPADBNO.purs")])
+    subprocess.run(["cp", args.filename, join(server_config['dir'], "src", "RuleLib", "Interview.purs")])
 
     with open(join(server_config['dir'], "v8k.json"), "w") as write_file:
         json.dump(server_config, write_file)