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 --- contracts/auth.ts | 103 ++++++++++++++++++++++++++++++++++++++++++++++++++++ contracts/drive.ts | 13 +++++++ contracts/env.ts | 23 ++++++++++++ contracts/events.ts | 33 +++++++++++++++++ contracts/hash.ts | 26 +++++++++++++ contracts/mail.ts | 13 +++++++ contracts/tests.ts | 19 ++++++++++ 7 files changed, 230 insertions(+) create mode 100644 contracts/auth.ts create mode 100644 contracts/drive.ts create mode 100644 contracts/env.ts create mode 100644 contracts/events.ts create mode 100644 contracts/hash.ts create mode 100644 contracts/mail.ts create mode 100644 contracts/tests.ts (limited to 'contracts') diff --git a/contracts/auth.ts b/contracts/auth.ts new file mode 100644 index 0000000..1625116 --- /dev/null +++ b/contracts/auth.ts @@ -0,0 +1,103 @@ +/** + * Contract source: https://git.io/JOdz5 + * + * Feel free to let us know via PR, if you find something broken in this + * file. + */ + +import User from 'App/Models/User'; +import { JWTGuardConfig, JWTGuardContract } from '@ioc:Adonis/Addons/Jwt'; + +declare module '@ioc:Adonis/Addons/Auth' { + /* + |-------------------------------------------------------------------------- + | Providers + |-------------------------------------------------------------------------- + | + | The providers are used to fetch users. The Auth module comes pre-bundled + | with two providers that are `Lucid` and `Database`. Both uses database + | to fetch user details. + | + | You can also create and register your own custom providers. + | + */ + interface ProvidersList { + /* + |-------------------------------------------------------------------------- + | User Provider + |-------------------------------------------------------------------------- + | + | The following provider uses Lucid models as a driver for fetching user + | details from the database for authentication. + | + | You can create multiple providers using the same underlying driver with + | different Lucid models. + | + */ + user: { + implementation: LucidProviderContract; + config: LucidProviderConfig; + }; + } + + /* + |-------------------------------------------------------------------------- + | Guards + |-------------------------------------------------------------------------- + | + | The guards are used for authenticating users using different drivers. + | The auth module comes with 3 different guards. + | + | - SessionGuardContract + | - BasicAuthGuardContract + | - OATGuardContract ( Opaque access token ) + | + | Every guard needs a provider for looking up users from the database. + | + */ + interface GuardsList { + /* + |-------------------------------------------------------------------------- + | Web Guard + |-------------------------------------------------------------------------- + | + | The web guard uses sessions for maintaining user login state. It uses + | the `user` provider for fetching user details. + | + */ + web: { + implementation: SessionGuardContract<'user', 'web'>; + config: SessionGuardConfig<'user'>; + }; + /* + |-------------------------------------------------------------------------- + | OAT Guard + |-------------------------------------------------------------------------- + | + | OAT, stands for (Opaque access tokens) guard uses database backed tokens + | to authenticate requests. + | + */ + api: { + implementation: OATGuardContract<'user', 'api'>; + config: OATGuardConfig<'user'>; + }; + /* + |-------------------------------------------------------------------------- + | Basic Auth Guard + |-------------------------------------------------------------------------- + | + | The basic guard uses basic auth for maintaining user login state. It uses + | the `user` provider for fetching user details. + | + */ + basic: { + implementation: BasicAuthGuardContract<'user', 'basic'>; + config: BasicAuthGuardConfig<'user'>; + }; + jwt: { + implementation: JWTGuardContract<'user', 'api'>; + config: JWTGuardConfig<'user'>; + }; + } +} diff --git a/contracts/drive.ts b/contracts/drive.ts new file mode 100644 index 0000000..47b70f3 --- /dev/null +++ b/contracts/drive.ts @@ -0,0 +1,13 @@ +/** + * Contract source: https://git.io/JBt3I + * + * Feel free to let us know via PR, if you find something broken in this contract + * file. + */ + +import { InferDisksFromConfig } from '@adonisjs/core/build/config'; +import driveConfig from '../config/drive'; + +declare module '@ioc:Adonis/Core/Drive' { + interface DisksList extends InferDisksFromConfig {} +} diff --git a/contracts/env.ts b/contracts/env.ts new file mode 100644 index 0000000..e1fd92e --- /dev/null +++ b/contracts/env.ts @@ -0,0 +1,23 @@ +/** + * Contract source: https://git.io/JTm6U + * + * Feel free to let us know via PR, if you find something broken in this contract + * file. + */ + +declare module '@ioc:Adonis/Core/Env' { + /* + |-------------------------------------------------------------------------- + | Getting types for validated environment variables + |-------------------------------------------------------------------------- + | + | The `default` export from the "../env.ts" file exports types for the + | validated environment variables. Here we merge them with the `EnvTypes` + | interface so that you can enjoy intellisense when using the "Env" + | module. + | + */ + + type CustomTypes = typeof import('../env').default; + interface EnvTypes extends CustomTypes {} +} diff --git a/contracts/events.ts b/contracts/events.ts new file mode 100644 index 0000000..541bdc2 --- /dev/null +++ b/contracts/events.ts @@ -0,0 +1,33 @@ +/** + * Contract source: https://git.io/JfefG + * + * Feel free to let us know via PR, if you find something broken in this contract + * file. + */ + +import User from 'App/Models/User'; + +declare module '@ioc:Adonis/Core/Event' { + /* + |-------------------------------------------------------------------------- + | Define typed events + |-------------------------------------------------------------------------- + | + | You can define types for events inside the following interface and + | AdonisJS will make sure that all listeners and emit calls adheres + | to the defined types. + | + | For example: + | + | interface EventsList { + | 'new:user': UserModel + | } + | + | Now calling `Event.emit('new:user')` will statically ensure that passed value is + | an instance of the the UserModel only. + | + */ + interface EventsList { + 'forgot:password': { user: User; token: string }; + } +} diff --git a/contracts/hash.ts b/contracts/hash.ts new file mode 100644 index 0000000..af336c7 --- /dev/null +++ b/contracts/hash.ts @@ -0,0 +1,26 @@ +/** + * Contract source: https://git.io/Jfefs + * + * Feel free to let us know via PR, if you find something broken in this contract + * file. + */ + +import { InferListFromConfig } from '@adonisjs/core/build/config'; +import hashConfig from '../config/hash'; + +declare module '@ioc:Adonis/Core/Hash' { + interface HashersList extends InferListFromConfig { + bcrypt: { + config: BcryptConfig; + implementation: BcryptContract; + }; + argon: { + config: ArgonConfig; + implementation: ArgonContract; + }; + legacy: { + config: BcryptConfig; + implementation: HashDriverContract; + }; + } +} diff --git a/contracts/mail.ts b/contracts/mail.ts new file mode 100644 index 0000000..0ea307f --- /dev/null +++ b/contracts/mail.ts @@ -0,0 +1,13 @@ +/** + * Contract source: https://git.io/JvgAT + * + * Feel free to let us know via PR, if you find something broken in this contract + * file. + */ + +import { InferMailersFromConfig } from '@adonisjs/mail/build/config'; +import mailConfig from '../config/mail'; + +declare module '@ioc:Adonis/Addons/Mail' { + interface MailersList extends InferMailersFromConfig {} +} diff --git a/contracts/tests.ts b/contracts/tests.ts new file mode 100644 index 0000000..fec995d --- /dev/null +++ b/contracts/tests.ts @@ -0,0 +1,19 @@ +/** + * Contract source: https://bit.ly/3DP1ypf + * + * Feel free to let us know via PR, if you find something broken in this contract + * file. + */ + +import '@japa/runner'; + +declare module '@japa/runner' { + interface TestContext { + // Extend context + } + + // eslint-disable-next-line @typescript-eslint/no-unused-vars + interface Test { + // Extend test + } +} -- cgit v1.2.3-54-g00ecf