Server re-build with latest AdonisJS framework & Typescript (#47)

* chore: setup first basis structure

* chore: ensure styling is loaded correctly

* chore: comply to new routing syntax by replace . with / in routes/resource locations

* chore: add login controller

* chore: correctly use views with slash instead of dot

* chore: working login + tests

* chore: clean up tests

* chore: add password-forgot endpoint and matching test

* chore: add delete page test

* chore: add logout test

* chore: add reset-password route and tests

* chore: remove obsolete comment

* chore: add account-page and tests

* chore: add data page & first step of the test

* chore: add transfer/import data feature and tests

* chore: add export and basic test

* chore: add all static api routes with tests

* Regenerate 'pnpm-lock.json' and fix bad merge conflict

WIP:
- Tests have been commented out since they dont work
- Server doesn't start

* easier dev and test runs

* - remove --require-pragma from reformat-files so formatting works properly
- run pnpm reformat-files over codebase
- remove .json files from .eslintignore
- add invalid.json file to .eslintignore
- configure prettier properly in eslint config
- add type jsdoc to prettier config
- run adonis generate:manifest command to regenerate ace-manifest.json
- specify volta in package.json
- introduce typecheck npm script
- remove unused .mjs extension from npm scripts
- install missing type definition dependencies
- add pnpm.allowedDeprecatedVersions to package.json
- fix invalid extends in tsconfig.json causing TS issues throughout codebase
- remove @ts-ignore throughout codebase which is not relevant anymore
- enable some of the tsconfig options
- remove outdated eslint-disable from codebase
- change deprecated faker.company.companyName() to faker.company.name()
- fix TS issues inside transfer.spec.ts

* - update to latest node and pnpm versions
- upgrade all non-major dependencies to latest
- install missing @types/luxon dependency
- add cuid to pnpm.allowedDeprecatedVersions
- add esModuleInterop config option to tsconfig
- migrate more deprecated faker methods to new ones
- add more temporary ts-ignore to code

* - update eslint config
- remove trailingComma: all since default in prettier v3
- add typecheck command to prepare-code npm script
- upgrade various dependencies to latest major version
- update tsconfig to include only useful config options
- disable some lint issues and fix others

* - add test command to prepare-code
- disable strictPropertyInitialization flag in tsconfig which creates issues with adonis models
- update precommit hook to excute pnpm prepare-code
- remove ts-ignore statements from all models

* fix node and pnpm dependency update

* add cross env (so that we can develop on windows)

* add signup endpoint (TODO: JWT auth)

* Add login endpoint

* Add me and updateMe endpoints

* Add service endpoint

* refactor: change endpoints to use jwt

* add recipes endpoint

* add workspaces endpoint

* fix web controllors for login and post import

* Update node deps

* Change auth middleware (for web) and exempt api from CSRF

* Add import endpoint (franz import)

* Fix export/import logic

* Fix service and workspace data in user/data

* Fix partial lint

* chore: workaround lint issues

* fix: migration naming had two .

* Sync back node with recipes repo

* Temporarily ignore typescript

* Fix adonisrc to handle public folder static assets

* Fix issue with production database

* add Legacy Password Provider

* Fix lint errors

* Fix issue on login errors frontend

* add Legacy Password Provider

* Fix issue with customIcons

* Fix issue with auth tokens

* Update 'node' to '18.18.0'

* make docker work

* improve docker entrypoint (test api performance)

* Add migration database script

* NODE_ENV on recipes

* prefer @ts-expect-error over @ts-ignore

* small fixes

* Update 'pnpm' to '8.7.6'

* fix error catch

* Automatically generate JWT Public and Private keys

* Use custom Adonis5-jwt

* Update code to use secret (old way, no breaking changes)

* Normalize appKey

* Trick to make JWT tokens on client work with new version

* Fix error with new JWT logic

* Change migration and how we store JWT

* Fix 500 response code (needs to be 401)

* Improve logic and fix bugs

* Fix build and entrypoint logic

* Catch error if appKey changes

* Add newToken logic

* Fix lint (ignore any errors)

* Add build for PRs

* pnpm reformat-files result

* Fix some tests

* Fix reset password not working (test failing)

* Restore csrfTokens (disabled by accident)

* Fix pnpm start command with .env

* Disable failing tests on the transfer endpoint (TODO)

* Add tests to PR build

* Fix build

* Remove unnecessary assertStatus

* Add typecheck

* hash password on UserFactory (fix build)

* Add JWT_USE_PEM true by default (increase security)

* fix name of github action

---------

Co-authored-by: Vijay A <vraravam@users.noreply.github.com>
Co-authored-by: Balaji Vijayakumar <kuttibalaji.v6@gmail.com>
Co-authored-by: MCMXC <16797721+mcmxcdev@users.noreply.github.com>
Co-authored-by: André Oliveira <oliveira.andrerodrigues95@gmail.com>

2 files changed, 70 insertions, 26 deletions

diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml
index d2985d3..62c13e4 100644
--- a/docker/docker-compose.yml
+++ b/docker/docker-compose.yml
@@ -1,7 +1,7 @@
 version: "2"
 services:
   ferdium-server:
-    image: ferdium/ferdium-server:latest
+    image: ferdium-server
     container_name: ferdium-server
     environment:
       - NODE_ENV=development
@@ -25,8 +25,7 @@ services:
       - IS_REGISTRATION_ENABLED=true
       - CONNECT_WITH_FRANZ=false
       - DATA_DIR=/data
-      - PUID=1000
-      - PGID=1000
+      - JWT_USE_PEM=true
     volumes:
       - ferdium-database-vol:/data
       - ferdium-recipes-vol:/app/recipes
@@ -34,5 +33,4 @@ services:
       - 3333:3333
     restart: unless-stopped
 volumes:
-  ferdium-database-vol:
   ferdium-recipes-vol:
diff --git a/docker/entrypoint.sh b/docker/entrypoint.sh
index 4178d97..b2f4924 100755
--- a/docker/entrypoint.sh
+++ b/docker/entrypoint.sh
@@ -17,18 +17,23 @@ Brought to you by ferdium.org
 EOL
 
 # Update recipes from official git repository
+
+# We need to set NODE_ENV to development to install devDependencies
+SAVE_NODE_ENV=$NODE_ENV
+NODE_ENV=development
+
 if [ ! -d "/app/recipes/.git" ]; # When we mount an existing volume (ferdium-recipes-vol:/app/recipes) if this is only /app/recipes it is always true
 then
-  echo '**** Generating recipes for first run ****'
-  git clone --branch main https://github.com/ferdium/ferdium-recipes recipes
+    echo '**** Generating recipes for first run ****'
+    git clone --branch main https://github.com/ferdium/ferdium-recipes recipes
 else
-  echo '**** Updating recipes ****'
-  chown -R root /app/recipes # Fixes ownership problem when doing git pull -r
-  cd recipes
-  git stash -u
-  git pull -r
-  git stash pop
-  cd ..
+    echo '**** Updating recipes ****'
+    chown -R root /app/recipes # Fixes ownership problem when doing git pull -r
+    cd recipes
+    git stash -u
+    git pull -r
+    git stash pop
+    cd ..
 fi
 
 cd recipes
@@ -39,31 +44,72 @@ pnpm i
 pnpm package
 cd ..
 
+# Restore NODE_ENV
+NODE_ENV=$SAVE_NODE_ENV
+
 key_file="${DATA_DIR}/FERDIUM_APP_KEY.txt"
 
 print_app_key_message() {
-  app_key=$1
-  printf '**** App key is %s. ' ${app_key}
-  printf 'You can modify `%s` to update the app key ****\n' ${key_file}
+    app_key=$1
+    printf '**** App key is %s. ' ${app_key}
+    printf 'You can modify `%s` to update the app key ****\n' ${key_file}
 }
 
 # Create APP key if needed
 if [ -z ${APP_KEY} ] && [ ! -f ${key_file} ]
 then
-  echo '**** Generating Ferdium-server app key for first run ****'
-  adonis key:generate
-  APP_KEY=$(grep APP_KEY .env | cut -d '=' -f2)
-  echo ${APP_KEY} > ${key_file}
-  print_app_key_message ${APP_KEY}
+    echo '**** Generating Ferdium-server app key for first run ****'
+    adonis key:generate
+    APP_KEY=$(grep APP_KEY .env | cut -d '=' -f2)
+    echo ${APP_KEY} > ${key_file}
+    print_app_key_message ${APP_KEY}
 else
-  APP_KEY=$(cat ${key_file})
-  print_app_key_message ${APP_KEY}
+    APP_KEY=$(cat ${key_file})
+    print_app_key_message ${APP_KEY}
 fi
 
+# -------------------------------------
+# Create JWT public/private keys if needed
+
+# Check if JWT_USE_PEM is true
+if [ "$JWT_USE_PEM" = "true" ]; then
+  # Define file paths for public and private keys
+  publicKeyFile="${DATA_DIR}/FERDIUM_JWT_PUBLIC_KEY.pem"
+  privateKeyFile="${DATA_DIR}/FERDIUM_JWT_PRIVATE_KEY.pem"
+  # Check if public and private key files exist
+  if [ ! -f "$publicKeyFile" ] || [ ! -f "$privateKeyFile" ]; then
+      echo "Generating public and private keys..."
+
+      # Use Node.js to generate the keys
+      node ace jwt:generate-keys $DATA_DIR
+      mv ${DATA_DIR}/public.pem ${publicKeyFile}
+      mv ${DATA_DIR}/private.pem ${privateKeyFile}
+
+      echo "Public and private keys generated successfully."
+  else
+      echo "Using existing public and private keys."
+  fi
+  JWT_PUBLIC_KEY=$(cat ${publicKeyFile})
+  JWT_PRIVATE_KEY=$(cat ${privateKeyFile})
+  export JWT_PUBLIC_KEY
+  export JWT_PRIVATE_KEY
+else
+    echo "JWT_USE_PEM is not set to true. Skipping JWT certificate generation."
+fi
+# End of JWT public/private keys
+# -------------------------------------
+
 export APP_KEY
 
-node ace migration:run --force
+# Enable the errexit option
+set -e
 
-chown -R "${PUID:-1000}":"${PGID:-1000}" "${DATA_DIR}" /app # This is the cause of the problem on line 29/32
+# Run the script to migrate from AdonisJS v4 to v5
+sh /app/scripts/adonisjs-4-to-5.sh
+
+# Disable the errexit option
+set +e
+
+node ace migration:run --force
 
-su-exec "${PUID:-1000}":"${PGID:-1000}" node server.js
+node build/server.js