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>

Author: 5 people

.adonisrc.json

@@ -0,0 +1,52 @@
+{
+  "typescript": true,
+  "commands": [
+    "./commands",
+    "@adonisjs/core/build/commands/index.js",
+    "@adonisjs/repl/build/commands",
+    "@adonisjs/lucid/build/commands",
+    "@adonisjs/mail/build/commands",
+    "adonis5-jwt/build/commands"
+  ],
+  "exceptionHandlerNamespace": "App/Exceptions/Handler",
+  "aliases": {
+    "App": "app",
+    "Config": "config",
+    "Database": "database",
+    "Contracts": "contracts"
+  },
+  "preloads": ["./start/routes", "./start/kernel", "./start/events"],
+  "providers": [
+    "./providers/AppProvider",
+    "@adonisjs/core",
+    "@adonisjs/view",
+    "@adonisjs/lucid",
+    "@adonisjs/auth",
+    "@adonisjs/shield",
+    "@adonisjs/session",
+    "@adonisjs/mail",
+    "adonis5-jwt",
+    "./providers/LegacyHasherProvider"
+  ],
+  "aceProviders": ["@adonisjs/repl"],
+  "tests": {
+    "suites": [
+      {
+        "name": "functional",
+        "files": ["tests/functional/**/*.spec(.ts|.js)"],
+        "timeout": 60000
+      }
+    ]
+  },
+  "testProviders": ["@japa/preset-adonis/TestsProvider"],
+  "metaFiles": [
+    {
+      "pattern": "resources/views/**/*.edge",
+      "reloadServer": false
+    },
+    {
+      "pattern": "public/**",
+      "reloadServer": false
+    }
+  ]
+}

.do/deploy.template.yaml

@@ -17,5 +17,12 @@ docker
 node_modules
 .husky
 
+# Ignore data folder
+data
+tmp
+
 # Ignore recipes folder (it is pulled in the image by git)
 recipes
+
+# Ignore build folder
+build

.dockerignore

@@ -0,0 +1,15 @@
+#This is a minimal needed configuration for development
+
+NODE_ENV=development
+APP_URL=http://localhost:3333
+DB_CONNECTION=sqlite
+APP_KEY=IDU2cMbrvS6iv5841YmFJSjnIqT1X1Nx
+
+# These are needed if running outside of Docker
+HOST=127.0.0.1
+PORT=3333
+
+IS_CREATION_ENABLED=true
+IS_DASHBOARD_ENABLED=true
+IS_REGISTRATION_ENABLED=true
+CONNECT_WITH_FRANZ=true

.env.development

@@ -1,3 +1,5 @@
+#This is a example file with all the available configuration options.
+
 NODE_ENV=development
 APP_URL=localhost
 DB_CONNECTION=sqlite
@@ -19,8 +21,6 @@ IS_DASHBOARD_ENABLED=true
 IS_REGISTRATION_ENABLED=true
 CONNECT_WITH_FRANZ=false
 DATA_DIR=data
-PUID=1000
-PGID=1000
 
 # These are needed if running outside of Docker
 APP_KEY= # Need to set some value

.env.example

@@ -0,0 +1,6 @@
+#This is a minimal needed configuration for test
+
+NODE_ENV=test
+ASSETS_DRIVER=fake
+SESSION_DRIVER=memory
+APP_KEY=IDU2cMbrvS6iv5841YmFJSjnIqT1X1Nx

.env.test

@@ -29,8 +29,7 @@ node_modules
 /recipes/
 
 # package files
-package.json
 pnpm-lock.yaml
 
 # Json
-*.json
+tests/functional/dashboard/import-stubs/invalid.json

.eslintignore

@@ -1,33 +1,86 @@
+/** @type {import('eslint').Linter.Config} */
 module.exports = {
   root: true,
-  env: {
-    commonjs: true,
-    es6: true,
-    node: true,
+  parserOptions: {
+    ecmaVersion: 2018,
+    sourceType: 'module',
+    project: './tsconfig.json',
   },
-  extends: ['airbnb-base'],
+  ignorePatterns: ['node_modules', 'build', 'recipes', '.eslintrc.js'],
+  extends: [
+    'plugin:adonis/typescriptApp',
+    'plugin:unicorn/recommended',
+    'prettier',
+  ],
+  plugins: [],
   globals: {
-    Atomics: 'readonly',
-    SharedArrayBuffer: 'readonly',
-    use: 'readonly',
-    window: 'readonly',
-    document: 'readonly',
-    ENV: 'readonly',
-    session: 'readonly',
-    response: 'readonly',
+    use: true,
   },
-  parserOptions: {
-    ecmaVersion: 2018,
+  env: {
+    es6: true,
+    node: true,
   },
+  reportUnusedDisableDirectives: true,
+  overrides: [
+    {
+      files: ['**/*.ts'],
+      extends: [
+        'plugin:adonis/typescriptApp',
+        'plugin:@typescript-eslint/eslint-recommended',
+        'plugin:@typescript-eslint/strict',
+        // TODO: Opt-in to a stricter ruleset in the future
+        // 'plugin:@typescript-eslint/strict-type-checked',
+        'plugin:@typescript-eslint/stylistic-type-checked',
+        'plugin:import/typescript',
+      ],
+      parser: '@typescript-eslint/parser',
+      plugins: [],
+      rules: {
+        // eslint
+        'max-len': 0,
+
+        // @typescript-eslint
+        '@typescript-eslint/no-non-null-assertion': 0,
+        '@typescript-eslint/no-empty-interface': 0,
+        '@typescript-eslint/semi': 0,
+        '@typescript-eslint/space-before-function-paren': 0,
+        '@typescript-eslint/no-extraneous-class': 0,
+        '@typescript-eslint/ban-ts-comment': 0,
+        '@typescript-eslint/prefer-ts-expect-error': 0,
+      },
+    },
+  ],
   rules: {
-    'arrow-parens': 0,
-    'class-methods-use-this': 0,
-    eqeqeq: 1,
-    'implicit-arrow-linebreak': 0,
+    // eslint
+    'array-callback-return': 1,
+    'consistent-return': 1,
     'max-len': 0,
     'no-await-in-loop': 1,
-    'no-restricted-syntax': 0,
-    'operator-linebreak': 0,
-    'object-curly-newline': 0,
+    'no-return-assign': 1,
+    'no-console': [
+      1,
+      {
+        allow: ['warn', 'error'],
+      },
+    ],
+    'no-param-reassign': 1,
+    'prefer-destructuring': 1,
+    // eslint-plugin-unicorn
+    'unicorn/filename-case': 0,
+    'unicorn/prefer-module': 0,
+    'unicorn/prevent-abbreviations': 0,
+
+    'unicorn/import-style': [
+      2,
+      {
+        styles: {
+          path: {
+            named: true,
+          },
+        },
+      },
+    ],
+    'unicorn/no-empty-file': 0,
+    'unicorn/prefer-top-level-await': 0,
   },
 };

.eslintrc.js

@@ -0,0 +1,30 @@
+name: AdonisJS check
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  adonis-js-check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use Node.js specified in the '.nvmrc' file
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: ".nvmrc"
+
+      - name: Install pnpm
+        run: npm i -gf "pnpm@$(node -p 'require("./package.json").engines.pnpm')" && pnpm -v
+
+      - run: pnpm install
+
+      - run: pnpm typecheck
+
+      - run: pnpm lint
+
+      - run: pnpm test
+
+      - run: pnpm run build

.github/workflows/build.yml

@@ -349,6 +349,8 @@ tags
 
 # Adonis directory for storing tmp files
 tmp
+build
+public/assets
 
 # Environment variables, never commit this file
 .env