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>

9 files changed, 209 insertions, 280 deletions

diff --git a/start/app.js b/start/app.js
deleted file mode 100644
index f1fb23a..0000000
--- a/start/app.js
+++ /dev/null
@@ -1,65 +0,0 @@
-/*
-|--------------------------------------------------------------------------
-| Providers
-|--------------------------------------------------------------------------
-|
-| Providers are building blocks for your Adonis app. Anytime you install
-| a new Adonis specific package, chances are you will register the
-| provider here.
-|
-*/
-const providers = [
-  '@adonisjs/framework/providers/AppProvider',
-  '@adonisjs/auth/providers/AuthProvider',
-  '@adonisjs/bodyparser/providers/BodyParserProvider',
-  '@adonisjs/cors/providers/CorsProvider',
-  '@adonisjs/lucid/providers/LucidProvider',
-  '@adonisjs/drive/providers/DriveProvider',
-  '@adonisjs/validator/providers/ValidatorProvider',
-  '@adonisjs/framework/providers/ViewProvider',
-  '@adonisjs/session/providers/SessionProvider',
-  '@adonisjs/shield/providers/ShieldProvider',
-  '@adonisjs/persona/providers/PersonaProvider',
-  '@adonisjs/mail/providers/MailProvider',
-];
-
-/*
-|--------------------------------------------------------------------------
-| Ace Providers
-|--------------------------------------------------------------------------
-|
-| Ace providers are required only when running ace commands. For example
-| Providers for migrations, tests etc.
-|
-*/
-const aceProviders = [
-  '@adonisjs/lucid/providers/MigrationsProvider',
-];
-
-/*
-|--------------------------------------------------------------------------
-| Aliases
-|--------------------------------------------------------------------------
-|
-| Aliases are short unique names for IoC container bindings. You are free
-| to create your own aliases.
-|
-| For example:
-|   { Route: 'Adonis/Src/Route' }
-|
-*/
-const aliases = {};
-
-/*
-|--------------------------------------------------------------------------
-| Commands
-|--------------------------------------------------------------------------
-|
-| Here you store ace commands for your package
-|
-*/
-const commands = [];
-
-module.exports = {
-  providers, aceProviders, aliases, commands,
-};
diff --git a/start/events.js b/start/events.js
deleted file mode 100644
index a99afd5..0000000
--- a/start/events.js
+++ /dev/null
@@ -1,25 +0,0 @@
-const Event = use('Event');
-const Mail = use('Mail');
-const Env = use('Env');
-
-Event.on('forgot::password', async ({ user, token }) => {
-  const body = `
-Hello ${user.username},
-we received a request to reset your Ferdium account password.
-Use the link below to reset your password. If you didn't requested that your password be reset, please ignore this message.
-
-${Env.get('APP_URL')}/user/reset?token=${encodeURIComponent(token)}
-
-This message was sent automatically. Please do not reply.
-`;
-  console.log('Sending message', body);
-  try {
-    await Mail.raw(body, (message) => {
-      message.subject('[Ferdium] Reset your password');
-      message.from(Env.get('MAIL_SENDER'));
-      message.to(user.email);
-    });
-  } catch (e) {
-    console.log(`Couldn't send mail: ${e}`);
-  }
-});
diff --git a/start/events.ts b/start/events.ts
new file mode 100644
index 0000000..11e63e5
--- /dev/null
+++ b/start/events.ts
@@ -0,0 +1,33 @@
+import Config from '@ioc:Adonis/Core/Config';
+import Event from '@ioc:Adonis/Core/Event';
+import Mail from '@ioc:Adonis/Addons/Mail';
+
+/*
+|--------------------------------------------------------------------------
+| Preloaded File
+|--------------------------------------------------------------------------
+|
+| Any code written inside this file will be executed during the application
+| boot.
+|
+*/
+Event.on('forgot::password', async ({ user, token }) => {
+  try {
+    // eslint-disable-next-line no-console
+    console.log('Sending message');
+    await Mail.send(message => {
+      message
+        .subject('[Ferdium] Forgot Password')
+        .to(user.email)
+        .from(Config.get('dasshboard.mailFrom'))
+        .textView('emails.forgot-password', {
+          appUrl: Config.get('app.url'),
+          username: user.username,
+          token,
+        });
+    });
+  } catch (error) {
+    // eslint-disable-next-line no-console
+    console.log(`Couldn't send mail: ${error}`);
+  }
+});
diff --git a/start/kernel.js b/start/kernel.js
deleted file mode 100644
index 12c2162..0000000
--- a/start/kernel.js
+++ /dev/null
@@ -1,62 +0,0 @@
-/** @type {import('@adonisjs/framework/src/Server')} */
-const Server = use('Server');
-
-/*
-|--------------------------------------------------------------------------
-| Global Middleware
-|--------------------------------------------------------------------------
-|
-| Global middleware are executed on each http request only when the routes
-| match.
-|
-*/
-const globalMiddleware = [
-  'Adonis/Middleware/BodyParser',
-  'App/Middleware/ConvertEmptyStringsToNull',
-  'Adonis/Middleware/AuthInit',
-  'Adonis/Middleware/Session',
-];
-
-/*
-|--------------------------------------------------------------------------
-| Named Middleware
-|--------------------------------------------------------------------------
-|
-| Named middleware is key/value object to conditionally add middleware on
-| specific routes or group of routes.
-|
-| // define
-| {
-|   auth: 'Adonis/Middleware/Auth'
-| }
-|
-| // use
-| Route.get().middleware('auth')
-|
-*/
-const namedMiddleware = {
-  auth: 'Adonis/Middleware/Auth',
-  guest: 'Adonis/Middleware/AllowGuestOnly',
-  shield: 'Adonis/Middleware/Shield',
-};
-
-/*
-|--------------------------------------------------------------------------
-| Server Middleware
-|--------------------------------------------------------------------------
-|
-| Server level middleware are executed even when route for a given URL is
-| not registered. Features like `static assets` and `cors` needs better
-| control over request lifecycle.
-|
-*/
-const serverMiddleware = [
-  'Adonis/Middleware/Static',
-  'Adonis/Middleware/Cors',
-  'App/Middleware/HandleDoubleSlash',
-];
-
-Server
-  .registerGlobal(globalMiddleware)
-  .registerNamed(namedMiddleware)
-  .use(serverMiddleware);
diff --git a/start/kernel.ts b/start/kernel.ts
new file mode 100644
index 0000000..1c5c92b
--- /dev/null
+++ b/start/kernel.ts
@@ -0,0 +1,49 @@
+/*
+|--------------------------------------------------------------------------
+| Application middleware
+|--------------------------------------------------------------------------
+|
+| This file is used to define middleware for HTTP requests. You can register
+| middleware as a `closure` or an IoC container binding. The bindings are
+| preferred, since they keep this file clean.
+|
+*/
+
+import Server from '@ioc:Adonis/Core/Server';
+
+/*
+|--------------------------------------------------------------------------
+| Global middleware
+|--------------------------------------------------------------------------
+|
+| An array of global middleware, that will be executed in the order they
+| are defined for every HTTP requests.
+|
+*/
+Server.middleware.register([
+  () => import('@ioc:Adonis/Core/BodyParser'),
+  () => import('@ioc:Adonis/Addons/Shield'),
+]);
+
+/*
+|--------------------------------------------------------------------------
+| Named middleware
+|--------------------------------------------------------------------------
+|
+| Named middleware are defined as key-value pair. The value is the namespace
+| or middleware function and key is the alias. Later you can use these
+| alias on individual routes. For example:
+|
+| { auth: () => import('App/Middleware/Auth') }
+|
+| and then use it as follows
+|
+| Route.get('dashboard', 'UserController.dashboard').middleware('auth')
+|
+*/
+Server.middleware.registerNamed({
+  auth: () => import('App/Middleware/Auth'),
+  dashboard: () => import('App/Middleware/Dashboard'),
+  guest: () => import('App/Middleware/AllowGuestOnly'),
+  shield: () => import('@ioc:Adonis/Addons/Shield'),
+});
diff --git a/start/routes.js b/start/routes.js
deleted file mode 100644
index 0f3785f..0000000
--- a/start/routes.js
+++ /dev/null
@@ -1,128 +0,0 @@
-/*
-|--------------------------------------------------------------------------
-| Routes
-|--------------------------------------------------------------------------
-|
-*/
-
-/** @type {typeof import('@adonisjs/framework/src/Route/Manager')} */
-const Route = use('Route');
-const Env = use('Env');
-
-// Health: Returning if all systems function correctly
-Route.get('health', ({
-  response,
-}) => response.send({
-  api: 'success',
-  db: 'success',
-}));
-
-// API is grouped under '/v1/' route
-Route.group(() => {
-  // User authentification
-  Route.post('auth/signup', 'UserController.signup').middleware('guest');
-  Route.post('auth/login', 'UserController.login').middleware('guest');
-
-  // User info
-  Route.get('me', 'UserController.me').middleware('auth');
-  Route.put('me', 'UserController.updateMe').middleware('auth');
-
-  // Service info
-  Route.post('service', 'ServiceController.create').middleware('auth');
-  Route.put('service/reorder', 'ServiceController.reorder').middleware('auth');
-  Route.put('service/:id', 'ServiceController.edit').middleware('auth');
-  Route.delete('service/:id', 'ServiceController.delete').middleware('auth');
-  Route.get('me/services', 'ServiceController.list').middleware('auth');
-  Route.get('recipe', 'ServiceController.list').middleware('auth');
-  Route.get('icon/:id', 'ServiceController.icon');
-
-  // Recipe store
-  Route.get('recipes', 'RecipeController.list');
-  Route.get('recipes/search', 'RecipeController.search');
-  Route.get('recipes/popular', 'RecipeController.popularRecipes');
-  Route.get('recipes/download/:recipe', 'RecipeController.download');
-  Route.post('recipes/update', 'RecipeController.update');
-
-  // Workspaces
-  Route.put('workspace/:id', 'WorkspaceController.edit').middleware('auth');
-  Route.delete('workspace/:id', 'WorkspaceController.delete').middleware('auth');
-  Route.post('workspace', 'WorkspaceController.create').middleware('auth');
-  Route.get('workspace', 'WorkspaceController.list').middleware('auth');
-
-  // Static responses
-  Route.get('features/:mode?', 'StaticController.features');
-  Route.get('services', 'StaticController.emptyArray');
-  Route.get('news', 'StaticController.emptyArray');
-  Route.get('announcements/:version', 'StaticController.announcement');
-}).prefix('v1');
-
-// User dashboard
-if (Env.get('IS_DASHBOARD_ENABLED') !== 'false') {
-  Route.group(() => {
-    // Auth
-    Route.get('login', ({ view }) => view.render('dashboard.login')).middleware('guest');
-    Route.post('login', 'DashboardController.login').middleware('guest').as('login');
-
-    // Reset password
-    Route.get('forgot', ({ view }) => view.render('dashboard.forgotPassword')).middleware('guest');
-    Route.post('forgot', 'DashboardController.forgotPassword').middleware('guest');
-
-    Route.get('reset', ({ view, request }) => {
-      const { token } = request.get();
-      if (token) {
-        return view.render('dashboard.resetPassword', { token });
-      }
-      return view.render('others.message', {
-        heading: 'Invalid token',
-        text: 'Please make sure you are using a valid and recent link to reset your password.',
-      });
-    }).middleware('guest');
-    Route.post('reset', 'DashboardController.resetPassword').middleware('guest');
-
-    // Dashboard
-    Route.get('account', 'DashboardController.account').middleware('auth:session');
-    Route.post('account', 'DashboardController.edit').middleware('auth:session');
-
-    Route.get('data', 'DashboardController.data').middleware('auth:session');
-
-    Route.get('export', 'DashboardController.export').middleware('auth:session');
-    Route.post('transfer', 'DashboardController.import').middleware('auth:session');
-    Route.get('transfer', ({ view }) => view.render('dashboard.transfer')).middleware('auth:session');
-
-    Route.get('delete', ({ view }) => view.render('dashboard.delete')).middleware('auth:session');
-    Route.post('delete', 'DashboardController.delete').middleware('auth:session');
-
-    Route.get('logout', 'DashboardController.logout').middleware('auth:session');
-
-    Route.get('*', ({ response }) => response.redirect('/user/account'));
-  }).prefix('user').middleware('shield');
-} else {
-  Route.group(() => {
-    Route.get('*', ({
-      response,
-    }) => response.send('The user dashboard is disabled on this server\n\nIf you are the server owner, please set IS_DASHBOARD_ENABLED to true to enable the dashboard.'));
-  }).prefix('user');
-}
-
-// Recipe creation
-Route.post('new', 'RecipeController.create');
-Route.get('new', ({ response, view }) => {
-  if (Env.get('IS_CREATION_ENABLED') == 'false') { // eslint-disable-line eqeqeq
-    return response.send('This server doesn\'t allow the creation of new recipes.\n\nIf you are the server owner, please set IS_CREATION_ENABLED to true to enable recipe creation.');
-  }
-  return view.render('others.new');
-});
-
-// Franz/Ferdi account import
-Route.post('import', 'UserController.import');
-Route.get('import', ({ view }) => view.render('others.import'));
-
-// Legal documents
-Route.get('terms', ({ response }) => response.redirect('/terms.html'));
-Route.get('privacy', ({ response }) => response.redirect('/privacy.html'));
-
-// Index
-Route.get('/', ({ view }) => view.render('others.index'));
-
-// 404 handler
-Route.get('/*', ({ response }) => response.redirect('/'));
diff --git a/start/routes.ts b/start/routes.ts
new file mode 100644
index 0000000..75cef72
--- /dev/null
+++ b/start/routes.ts
@@ -0,0 +1,22 @@
+/*
+|--------------------------------------------------------------------------
+| Routes
+|--------------------------------------------------------------------------
+|
+| This file is dedicated for defining HTTP routes. A single file is enough
+| for majority of projects, however you can define routes in different
+| files and just make sure to import them inside this file. For example
+|
+| Define routes in following two files
+| ├── start/routes/cart.ts
+| ├── start/routes/customer.ts
+|
+| and then import them inside `start/routes.ts` as follows
+|
+| import './routes/cart'
+| import './routes/customer'
+|
+*/
+
+import './routes/api';
+import './routes/web';
diff --git a/start/routes/api.ts b/start/routes/api.ts
new file mode 100644
index 0000000..78282f0
--- /dev/null
+++ b/start/routes/api.ts
@@ -0,0 +1,51 @@
+// As this is currently a rebuild of the initial API we it is grouped in /v2/
+
+import Route from '@ioc:Adonis/Core/Route';
+
+Route.group(() => {
+  // User authentification
+  Route.post('auth/signup', 'UserController.signup').middleware('guest');
+  Route.post('auth/login', 'UserController.login').middleware('guest');
+
+  // User info
+  Route.get('me', 'UserController.me').middleware('auth:jwt');
+  Route.put('me', 'UserController.updateMe').middleware('auth:jwt');
+  Route.get('me/newtoken', 'UserController.newToken').middleware('auth:jwt');
+
+  // // Service info
+  Route.post('service', 'ServiceController.create').middleware('auth:jwt');
+  Route.put('service/reorder', 'ServiceController.reorder').middleware(
+    'auth:jwt',
+  );
+  Route.put('service/:id', 'ServiceController.edit').middleware('auth:jwt');
+  Route.delete('service/:id', 'ServiceController.delete').middleware(
+    'auth:jwt',
+  );
+  Route.get('me/services', 'ServiceController.list').middleware('auth:jwt');
+  Route.get('recipe', 'ServiceController.list').middleware('auth:jwt');
+  Route.get('icon/:id', 'ServiceController.icon');
+
+  // Recipe store
+  Route.get('recipes', 'RecipeController.list');
+  Route.get('recipes/search', 'RecipeController.search');
+  Route.get('recipes/popular', 'RecipeController.popularRecipes');
+  Route.get('recipes/download/:recipe', 'RecipeController.download');
+  Route.post('recipes/update', 'RecipeController.update');
+
+  // // Workspaces
+  Route.put('workspace/:id', 'WorkspaceController.edit').middleware('auth:jwt');
+  Route.delete('workspace/:id', 'WorkspaceController.delete').middleware(
+    'auth:jwt',
+  );
+  Route.post('workspace', 'WorkspaceController.create').middleware('auth:jwt');
+  Route.get('workspace', 'WorkspaceController.list').middleware('auth:jwt');
+
+  // Static responses
+  Route.get('features/:mode?', 'Api/Static/FeaturesController.show');
+  Route.get('services', 'Api/Static/EmptyController.show');
+  Route.get('news', 'Api/Static/EmptyController.show');
+  Route.get(
+    'announcements/:version',
+    'Api/Static/AnnouncementsController.show',
+  );
+}).prefix('/v1');
diff --git a/start/routes/web.ts b/start/routes/web.ts
new file mode 100644
index 0000000..308abec
--- /dev/null
+++ b/start/routes/web.ts
@@ -0,0 +1,54 @@
+import Route from '@ioc:Adonis/Core/Route';
+
+// Health check
+Route.get('health', 'HealthController.index');
+
+// Legal documents
+Route.get('terms', ({ response }) => response.redirect('/terms.html'));
+Route.get('privacy', ({ response }) => response.redirect('/privacy.html'));
+
+// Index
+Route.get('/', ({ view }) => view.render('others/index'));
+
+Route.group(() => {
+  Route.group(() => {
+    // Guest troutes
+    Route.group(() => {
+      Route.get('login', 'Dashboard/LoginController.show');
+      Route.post('login', 'Dashboard/LoginController.login').as('login');
+
+      // Reset password
+      Route.get('forgot', 'Dashboard/ForgotPasswordController.show');
+      Route.post('forgot', 'Dashboard/ForgotPasswordController.forgotPassword');
+
+      Route.get('reset', 'Dashboard/ResetPasswordController.show');
+      Route.post('reset', 'Dashboard/ResetPasswordController.resetPassword');
+    }).middleware(['dashboard', 'guest']);
+
+    // Authenticated routes
+    Route.group(() => {
+      Route.get('account', 'Dashboard/AccountController.show');
+      Route.post('account', 'Dashboard/AccountController.store');
+
+      Route.get('data', 'Dashboard/DataController.show');
+      Route.get('export', 'Dashboard/ExportController.show');
+
+      Route.get('transfer', 'Dashboard/TransferController.show');
+      Route.post('transfer', 'Dashboard/TransferController.import');
+
+      Route.get('delete', 'Dashboard/DeleteController.show');
+      Route.post('delete', 'Dashboard/DeleteController.delete');
+
+      Route.get('logout', 'Dashboard/LogOutController.logout');
+
+      Route.get('*', ({ response }) => response.redirect('/user/account'));
+    }).middleware(['dashboard', 'auth:web']);
+  }).prefix('user');
+
+  // Franz/Ferdi account import
+  Route.get('import', ({ view }) => view.render('others/import'));
+  Route.post('import', 'UserController.import');
+
+  // 404 handler
+  Route.get('/*', ({ response }) => response.redirect('/'));
+}).middleware(['dashboard']);