Test docker build on arm64 (#618)

* Test if docker will build for every PR

* We didn't need this new action, docker-publish already had this target

* Nicer label?

* Fix more labels

* intall docker maybe!

* Hopeful fix

* Do we need this?

* Roll the dice!

* Giving up on macOs build

* Run Node 22 ?

* Remove remove-peer-dependencies

* Guessing here

* Newer python doesn't ship with setuptools, which breaks our build

* We need pip as well :'(

* Does alpine have this package

* Grasping at straws. Copying what @usrrname was doign

* Try node 20 again

* Node-gyp install?

* More comments

* Can we add libsodium via apk?

* Update changelog

* Seems like readFile from fs/promises struggles with large files.

* Remove some (now) unneeded dependencies

* Revert "Seems like readFile from fs/promises struggles with large files."

This reverts commit 8c3ca43.

* Better?

* We might not need any of the binary packages anymore. Lets see!

.github/workflows/docker-publish.yml

@@ -19,19 +19,17 @@ jobs:
   # Run tests.
   # See also https://docs.docker.com/docker-hub/builds/automated-testing/
   test:
-    runs-on: ubuntu-latest
+
+    name: Testing Docker Build for ${{matrix.os}}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, ubuntu-24.04-arm]
 
     steps:
       - uses: actions/checkout@v4
-
-      - name: Run tests
-        run: |
-          if [ -f docker-compose.test.yml ]; then
-            docker-compose --file docker-compose.test.yml build
-            docker-compose --file docker-compose.test.yml run sut
-          else
-            docker build . --file Dockerfile
-          fi
+      - name: docker build
+        run: docker build . --file Dockerfile
 
   # Push image to GitHub Packages.
   # See also https://docs.docker.com/docker-hub/builds/

Dockerfile

@@ -2,17 +2,13 @@
 FROM node:20-alpine as build-stage
 WORKDIR /opt/app
 
-# Needed for building @vscode/sqlite3 package
-RUN apk add python3 make gcc musl-dev g++
-
 COPY package.json package.json Makefile tsconfig.json ./
 COPY assets assets
 COPY templates templates
 COPY schemas schemas
 COPY src src
 
-# --legacy-peer-deps should be removed when all dependencies are marked as stable
-RUN npm i --legacy-peer-deps --environment=dev && npx tsc && npm prune --production && rm -r src/
+RUN npm i --environment=dev && npx tsc && npm prune --production && rm -r src/
 
 # Stage 2: run!
 FROM node:20-alpine

changelog.md

@@ -7,6 +7,8 @@ Changelog
 * Removed outdated `eff-diceware-passphrase` dependency. It was breaking the
   build on arm64 due to old transitive dependencies. We've instead included the
   EFF wordlist and generate diceware passwords ourselves.
+* Docker image could not be built on arm64 due to a transative dependency using
+  an old version of libsodium.
 
 
 0.29.0 (2025-02-07)

src/crypto.ts

@@ -43,10 +43,18 @@ export function uuidUrn() {
 
 
 const wordList:string[] = [];
-export async function loadWordList() {
+
+/**
+ * Load the EFF large word list.
+ *
+ * This function has a quiet parameter, so the console statement won't run.
+ *
+ * The reason is that it seems to break node --test.
+ */
+export async function loadWordList(quiet = false) {
   if (wordList.length === 0) {
     const __dirname = dirname(fileURLToPath(import.meta.url));
-    console.info('🎲 Loading EFF large word list');
+    if (!quiet) console.info('🎲 Loading EFF large word list');
     const result = await readFile(join(__dirname, '../assets/eff_large_wordlist.txt'), 'utf8');
     for(const line of result.split('\n')) {
       wordList.push(line.split('\t')[1]);

test/crypto.ts

@@ -67,7 +67,7 @@ describe('Crypto utilities', () => {
 
     it('should generate a password', async () => {
 
-      await loadWordList();
+      await loadWordList(true);
       const password = generatePassword();
       assert.match(password, /^[a-z-]{20,}$/);
       assert.equal(password.split('-').length, 6);