From e503468660a13760010a94ecda5f0625c6f47f87 Mon Sep 17 00:00:00 2001 From: Ricardo Date: Fri, 13 Oct 2023 14:12:03 +0200 Subject: Server re-build with latest AdonisJS framework & Typescript (#47) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 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 Co-authored-by: Balaji Vijayakumar Co-authored-by: MCMXC <16797721+mcmxcdev@users.noreply.github.com> Co-authored-by: André Oliveira --- start/routes.js | 128 -------------------------------------------------------- 1 file changed, 128 deletions(-) delete mode 100644 start/routes.js (limited to 'start/routes.js') 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('/')); -- cgit v1.2.3-54-g00ecf