Merge development branch (caching resolver, devcontainer, deadlock detector, clippy) (#80)

## Major Changes:
- updates the `devcontainer` definition to make things more usable:
  - Bases devcontainer off newer version of ubuntu (24.10)
- Fix locale issue causing spacing issue in zsh
(https://github.com/ohmyzsh/ohmyzsh/wiki/FAQ#i-see-duplicate-typed-characters-after-i-complete-a-command)
- Switches to `gdb` as the default debugger, as it supports hashmap
visualization (rust-lang/rust#111868)
- Caches rust packages in a persistent volume to avoid re-downloading
packages between container rebuilds.
- adds a resolver for SWC that is aware of package `exports, to support
custom `source` imports within a monorepo
- adds a deadlock detector for `dashmap` and wires it into the caching
resolver (this is temporary and should be removed in the future)
- Adds a CI job to ensure no unused dependencies are included (using
`cargo-udeps`). This is not included in the container build as it is
_exceptionally_ slow to build from source (~250s on my machine)
- Fixes issues discovered by `cargo clippy`

---------

Co-authored-by: Max Huang-Hobbs <[email protected]>

Author: Adjective-Object

.devcontainer/Dockerfile

@@ -1,49 +1,85 @@
-FROM ubuntu:22.10
+FROM ubuntu:24.10
 
-# Update default packages
-RUN apt-get update
+# Set locale before any packages are installed,
+# since packages are influenced by the current locale on installation
+#
+# This is necessary to get zsh to work well.
+#  See: https://github.com/ohmyzsh/ohmyzsh/wiki/FAQ#i-see-duplicate-typed-characters-after-i-complete-a-command
+RUN apt-get update && apt-get install -y language-pack-en
+RUN echo LC_CTYPE=\"en_US.UTF-8\" "\n" \
+    LC_ALL=\"en_US.UTF-8\" "\n" \
+    LANG=\"en_US.UTF-8\" "\n" > /etc/default/locale
+
+# Set locale before any packages are installed,
+# since packages are influenced by the current locale on installation
+#
+# This is necessary to get zsh to work well.
+#  See: https://github.com/ohmyzsh/ohmyzsh/wiki/FAQ#i-see-duplicate-typed-characters-after-i-complete-a-command
+RUN apt-get install -y language-pack-en
+RUN echo LC_CTYPE=\"en_US.UTF-8\" "\n" \
+    LC_ALL=\"en_US.UTF-8\" "\n" \
+    LANG=\"en_US.UTF-8\" "\n" > /etc/default/locale
 
 # Get Ubuntu packages
-RUN apt-get install -y \
+RUN apt-get update && apt-get install -y \
     build-essential \
+    gdb \
+    pkg-config \
     curl git zsh \
     vim
 
 # Update new packages
 RUN apt-get update
 
-ARG USERNAME=dev
+ARG USERNAME=ubuntu
 ARG HOME=/home/${USERNAME}
-ARG USER_UID=1000
+ARG USER_UID=1010
 ARG USER_GID=$USER_UID
 
-# Create the user
-RUN groupadd --gid $USER_GID $USERNAME \
-    && useradd --uid $USER_UID --gid $USER_GID -m $USERNAME \
-    #
-    # [Optional] Add sudo support. Omit if you don't need to install software after connecting.
-    && apt-get update \
+# Create the user (disabled: user is default 'ubuntu')
+# RUN groupadd --gid $USER_GID $USERNAME \
+#     && useradd --uid $USER_UID --gid $USER_GID -m $USERNAME
+
+# [Optional] Add sudo support. Omit if you don't need to install software after connecting.
+RUN apt-get update \
     && apt-get install -y sudo \
     && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME \
     && chmod 0440 /etc/sudoers.d/$USERNAME
 
-# setup zsh for the user
-RUN mkdir -p ${HOME}/.antigen
-RUN curl https://raw.githubusercontent.com/zsh-users/antigen/master/bin/antigen.zsh > ${HOME}/.antigen/antigen.zsh
-COPY zshrc.zsh ${HOME}/.zshrc
-
-# Get Rust
-RUN curl https://sh.rustup.rs -sSf | bash -s -- -y
-RUN echo 'source ${HOME}/.cargo/env' >> ${HOME}/.zshrc
-
 # Get Node
-RUN curl -fsSL https://deb.nodesource.com/setup_19.x | bash -
+RUN curl -fsSL https://deb.nodesource.com/setup_20.x | sudo bash - 
 RUN apt install -y nodejs
 
 # Preload yarn with corepack
 RUN corepack enable
 RUN corepack prepare yarn@stable --activate
 
-# recursively change ownership of the mounted files
-# to the "dev" user
-RUN chown ${USERNAME}:${USERNAME} ${HOME} -R
+# get native dependencies
+RUN apt install -y libdw-dev
+
+# Start acting as the container user to avoid permissions issues
+USER ${USERNAME}
+RUN sudo chown ${USERNAME}:${USERNAME} ${HOME}/.cache -R
+
+# setup zsh for the user
+RUN mkdir -p ${HOME}/.antigen
+RUN curl -L https://git.io/antigen > ${HOME}/.antigen/antigen.zsh
+COPY zshrc.zsh ${HOME}/.zshrc
+RUN sudo chown ${USERNAME}:${USERNAME} ${HOME}/.zshrc
+# run zsh to install antigen plugins for the first time
+RUN zsh ${HOME}/.zshrc
+
+# Make the mount target directories
+RUN sudo mkdir -p /cache ${HOME}/.cargo/registry
+RUN sudo chown ${USERNAME}:${USERNAME} /cache -R
+RUN sudo chown ${USERNAME}:${USERNAME} ${HOME}/.cargo -R
+
+# Install rust
+RUN curl https://sh.rustup.rs -sSf | bash -s -- -y
+RUN sudo chown ${USERNAME}:${USERNAME} ${HOME}/.cargo -R
+RUN echo 'source ${HOME}/.cargo/env' >> ${HOME}/.zprofile
+RUN echo 'source ${HOME}/.cargo/env' >> ${HOME}/.profile
+
+# Install cargo-udeps
+# RUN sudo apt-get update && sudo apt-get install -y libssl-dev
+# RUN bash -c "source ${HOME}/.cargo/env && cargo install cargo-udeps"

.devcontainer/devcontainer.json

@@ -1,32 +1,56 @@
 {
   "$schema": "https://raw.githubusercontent.com/microsoft/vscode/master/extensions/configuration-editing/schemas/devContainer.schema.json",
-  "name": "good-fences-rs development container",
+  "name": "${localWorkspaceFolderBasename} devcontainer",
   "build": {
     "dockerfile": "./Dockerfile",
     "args": {
-      "USERNAME": "vscode"
+      "USERNAME": "ubuntu"
     }
   },
-  "remoteUser": "vscode",
+  // In wsl, we want the acting user to match the user we are launching Docker from,
+  // which is typically 'ubuntu' in the default WSL configuration.
+  //
+  // This is because mounted volumes from Linux retain their original file permissions.
+  // If the acting user is not the same as the user in the container, the container
+  // may not have permission to write to the mounted volume, or may mangle the permissions
+  // of mounted files.
+  //
+  // See https://github.com/microsoft/vscode-dev-containers/issues/108
+  "remoteUser": "ubuntu",
   // see https://github.com/microsoft/vscode-remote-release/issues/1333#issuecomment-528234042
-  "workspaceMount": "",
-  "runArgs": [
-    "--init",
-    "--volume=${localWorkspaceFolder}:/workspaces/ori:Z"
-  ],
   "settings": {
-    "terminal.integrated.shell.linux": "/bin/zsh"
+    "terminal.integrated.profiles.linux": {
+      "zsh": {
+        "path": "/usr/bin/zsh"
+      }
+    },
+    "terminal.integrated.defaultProfile.linux": "zsh"
   },
-  "workspaceFolder": "/workspaces/ori",
-  "postStartCommand": "/bin/bash .devcontainer/config_fetch.sh",
+  "workspaceMount": "source=${localWorkspaceFolder},target=/workspaces/${localWorkspaceFolderBasename},type=bind,consistency=delegated",
+  "mounts": [
+    // This mounts client-web checked out next to this repo for testing, left checked-in here for convenience.
+    // Don't commit it, though!
+    // "source=${localWorkspaceFolder}/../client-web,target=/workspaces/client-web,type=bind,consistency=cached",
+    // expose the user's ssh credentials to the dev container
+    "source=${localEnv:HOME}/.ssh,target=/home/ubuntu/.ssh,type=bind,consistency=cached",
+    // map the .persist directory to /cache so it can be persisted between container rebuilds.
+    // This persists zsh history as well as downloaded cargo crate sources.
+    "source=${localWorkspaceFolder}/.persist,target=/cache,type=bind,consistency=cached",
+    "source=${localWorkspaceFolder}/.persist/cargo-registry,target=/home/ubuntu/.cargo/registry,type=bind,consistency=cached"
+  ],
+  "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
+  // "postStartCommand": "/bin/bash .devcontainer/config_fetch.sh",
   "extensions": [
-    "rust-lang.rust-analyzer"
+    "ms-vscode.cpptools",
+    "rust-lang.rust-analyzer",
+    "tamasfe.even-better-toml",
+    "vadimcn.vscode-lldb"
   ],
   "remoteEnv": {
-    "VM_REPO_PATH": "/workspaces/ori"
+    "VM_REPO_PATH": "/workspaces/${localWorkspaceFolderBasename}"
   },
   "forwardPorts": [
     3000,
-    30001
+    3001
   ]
 }

.devcontainer/zshrc.zsh

@@ -1,17 +1,17 @@
 # Source Antigen
-source ~/.antigen/antigen.zsh
-autoload -U colors && colors
-setopt promptsubst
-# Set up oh-my-zsh
+source ${HOME}/.antigen/antigen.zsh;
 antigen use oh-my-zsh
-# Set up plugins
 antigen bundle git
-antigen bundle docker
-# Set up our preferred theme
-antigen theme cloud
-# Run all that config
+antigen bundle heroku
+antigen bundle pip
+antigen bundle lein
+antigen bundle command-not-found
+antigen bundle zsh-users/zsh-syntax-highlighting
+antigen theme awesomepanda
 antigen apply
 
 # Set up Ctrl + Backspace and Ctrl + Del so you can move around and backspace faster (try it!)
 bindkey '^H' backward-kill-word
-bindkey -M emacs '^[[3;5~' kill-word
+bindkey '5~' kill-word
+
+export HISTFILE="/cache/.zsh_history"

.github/workflows/unittest.yml

@@ -19,6 +19,15 @@ jobs:
         run: yarn install
       - name: Check changefile
         run: yarn check-changefile
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy
+      - uses: giraffate/clippy-action@v1
+        with:
+          reporter: 'github-pr-review'
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          clippy_flags: -- --all-targets -Dwarnings
   tests-linux:
     runs-on: ubuntu-20.04
     steps:
@@ -28,6 +37,11 @@ jobs:
         run: yarn install && yarn build
       - name: cargo test
         run: cargo test --release
+      - name: Run cargo-udeps 
+        uses: aig787/cargo-udeps-action@v1
+        with:
+          version: 'latest'
+          args: '--all-targets'
       - name: run napi tests
         run: yarn test
       - name: upload-artifacts

.gitignore

@@ -1,16 +1,20 @@
 /target
+/rust-analyzer-target
 
 
 # Added by cargo
 #
 # already existing elements were commented out
 
-#/target
 node_modules
 *.node
 index.js
 index.d.ts
 good-fences-violations.json
+.yarn/*
+!.yarn/releases
+!.yarn/plugins
+.pnp.*
 
 # Previous accidentally committed files
 token

.persist/.gitignore

@@ -0,0 +1,6 @@
+*
+!README.md
+!.gitignore
+!cargo-registry/
+cargo-registry/*
+!cargo-registry/README.md

.persist/README.md

@@ -0,0 +1,2 @@
+# .persist
+This directory is used to persist state between machine builds (e.g. zsh_history)

.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+    "recommendations": [
+        "rust-lang.rust-analyzer",
+        "vadimcn.vscode-lldb",
+        "ms-vscode-remote.remote-containers",
+        "tamasfe.even-better-toml",
+        "ms-vscode.cpptools"
+    ]
+}

.vscode/launch.json

@@ -17,7 +17,13 @@
             "args": [
                 "--config-path=${file}"
             ],
-            "cwd": "${workspaceFolder}"
+            "cwd": "${workspaceFolder}",
+            "initCommands": [
+                "settings set target.disable-aslr false"
+            ],
+            "env": {
+                "RUST_BACKTRACE": "1"
+            }
         }
     ]
 }

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+    "rust-analyzer.checkOnSave": true,
+    "rust-analyzer.check.command": "clippy",
+    // runs rust-analyzer against a separate target directory than the normal rust compiler.
+    // this is a workaround for the following issue: https://github.com/rust-lang/rust-analyzer/issues/17482
+    "rust-analyzer.cargo.targetDir": "./rust-analyzer-target",
+    // prefer using GDB over lldb because lldb's debug visualizations are worse.
+    // See https://github.com/rust-lang/rust/issues/111868
+    "rust-analyzer.debug.engine": "ms-vscode.cpptools",
+    "rust-analyzer.debug.engineSettings": {
+        "cppdbg": {
+            "miDebuggerPath": "${env:HOME}/.cargo/bin/rust-gdb",
+            "setupCommands": [
+                {
+                    "description": "Enable pretty-printing for gdb",
+                    "text": "-enable-pretty-printing",
+                    "ignoreFailures": false
+                }
+            ],
+        }
+    },
+    "editor.formatOnSave": true,
+    "files.autoSaveWorkspaceFilesOnly": true,
+    "lldb.cargo": "/home/ubuntu/.cargo/bin/cargo",
+    "terminal.integrated.shellIntegration.decorationsEnabled": "never",
+}