diff options
author | Ricardo <ricardo@cino.io> | 2023-10-13 14:12:03 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-10-13 13:12:03 +0100 |
commit | e503468660a13760010a94ecda5f0625c6f47f87 (patch) | |
tree | fa532f54fc5f091de08d55405ec6339bd2440a02 /app/Models | |
parent | 1.3.16 [skip ci] (diff) | |
download | ferdium-server-e503468660a13760010a94ecda5f0625c6f47f87.tar.gz ferdium-server-e503468660a13760010a94ecda5f0625c6f47f87.tar.zst ferdium-server-e503468660a13760010a94ecda5f0625c6f47f87.zip |
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>
Diffstat (limited to 'app/Models')
-rw-r--r-- | app/Models/Recipe.js | 7 | ||||
-rw-r--r-- | app/Models/Recipe.ts | 23 | ||||
-rw-r--r-- | app/Models/Service.js | 10 | ||||
-rw-r--r-- | app/Models/Service.ts | 40 | ||||
-rw-r--r-- | app/Models/Token.js | 10 | ||||
-rw-r--r-- | app/Models/Token.ts | 38 | ||||
-rw-r--r-- | app/Models/Traits/NoTimestamp.js | 14 | ||||
-rw-r--r-- | app/Models/User.js | 46 | ||||
-rw-r--r-- | app/Models/User.ts | 98 | ||||
-rw-r--r-- | app/Models/Workspace.js | 10 | ||||
-rw-r--r-- | app/Models/Workspace.ts | 41 |
11 files changed, 240 insertions, 97 deletions
diff --git a/app/Models/Recipe.js b/app/Models/Recipe.js deleted file mode 100644 index bd97411..0000000 --- a/app/Models/Recipe.js +++ /dev/null | |||
@@ -1,7 +0,0 @@ | |||
1 | /** @type {typeof import('@adonisjs/lucid/src/Lucid/Model')} */ | ||
2 | const Model = use('Model'); | ||
3 | |||
4 | class Recipe extends Model { | ||
5 | } | ||
6 | |||
7 | module.exports = Recipe; | ||
diff --git a/app/Models/Recipe.ts b/app/Models/Recipe.ts new file mode 100644 index 0000000..fce5f3d --- /dev/null +++ b/app/Models/Recipe.ts | |||
@@ -0,0 +1,23 @@ | |||
1 | import { DateTime } from 'luxon'; | ||
2 | import { BaseModel, column } from '@ioc:Adonis/Lucid/Orm'; | ||
3 | |||
4 | export default class Recipe extends BaseModel { | ||
5 | @column({ isPrimary: true }) | ||
6 | public id: number; | ||
7 | |||
8 | @column() | ||
9 | public name: string; | ||
10 | |||
11 | @column() | ||
12 | public recipeId: string; | ||
13 | |||
14 | // TODO: Type the data object. | ||
15 | @column() | ||
16 | public data: object; | ||
17 | |||
18 | @column.dateTime({ autoCreate: true }) | ||
19 | public createdAt: DateTime; | ||
20 | |||
21 | @column.dateTime({ autoCreate: true, autoUpdate: true }) | ||
22 | public updatedAt: DateTime; | ||
23 | } | ||
diff --git a/app/Models/Service.js b/app/Models/Service.js deleted file mode 100644 index cf3e6f4..0000000 --- a/app/Models/Service.js +++ /dev/null | |||
@@ -1,10 +0,0 @@ | |||
1 | /** @type {typeof import('@adonisjs/lucid/src/Lucid/Model')} */ | ||
2 | const Model = use('Model'); | ||
3 | |||
4 | class Service extends Model { | ||
5 | user() { | ||
6 | return this.belongsTo('App/Models/User', 'userId', 'id'); | ||
7 | } | ||
8 | } | ||
9 | |||
10 | module.exports = Service; | ||
diff --git a/app/Models/Service.ts b/app/Models/Service.ts new file mode 100644 index 0000000..af1a8e1 --- /dev/null +++ b/app/Models/Service.ts | |||
@@ -0,0 +1,40 @@ | |||
1 | import { DateTime } from 'luxon'; | ||
2 | import { BaseModel, column, HasOne, hasOne } from '@ioc:Adonis/Lucid/Orm'; | ||
3 | import User from './User'; | ||
4 | |||
5 | export default class Service extends BaseModel { | ||
6 | @column({ isPrimary: true }) | ||
7 | public id: number; | ||
8 | |||
9 | @hasOne(() => User, { | ||
10 | foreignKey: 'userId', | ||
11 | }) | ||
12 | public user: HasOne<typeof User>; | ||
13 | |||
14 | @column({ | ||
15 | columnName: 'userId', | ||
16 | }) | ||
17 | public userId: number; | ||
18 | |||
19 | @column({ | ||
20 | columnName: 'serviceId', | ||
21 | }) | ||
22 | public serviceId: string; | ||
23 | |||
24 | @column() | ||
25 | public name: string; | ||
26 | |||
27 | @column({ | ||
28 | columnName: 'recipeId', | ||
29 | }) | ||
30 | public recipeId: string; | ||
31 | |||
32 | @column() | ||
33 | public settings: string; | ||
34 | |||
35 | @column.dateTime({ autoCreate: true }) | ||
36 | public createdAt: DateTime; | ||
37 | |||
38 | @column.dateTime({ autoCreate: true, autoUpdate: true }) | ||
39 | public updatedAt: DateTime; | ||
40 | } | ||
diff --git a/app/Models/Token.js b/app/Models/Token.js deleted file mode 100644 index 7965a7a..0000000 --- a/app/Models/Token.js +++ /dev/null | |||
@@ -1,10 +0,0 @@ | |||
1 | /** @type {typeof import('@adonisjs/lucid/src/Lucid/Model')} */ | ||
2 | const Model = use('Model'); | ||
3 | |||
4 | class Token extends Model { | ||
5 | user() { | ||
6 | return this.belongsTo('App/Models/User'); | ||
7 | } | ||
8 | } | ||
9 | |||
10 | module.exports = Token; | ||
diff --git a/app/Models/Token.ts b/app/Models/Token.ts new file mode 100644 index 0000000..4f85ebc --- /dev/null +++ b/app/Models/Token.ts | |||
@@ -0,0 +1,38 @@ | |||
1 | import { DateTime } from 'luxon'; | ||
2 | import { BaseModel, column, HasOne, hasOne } from '@ioc:Adonis/Lucid/Orm'; | ||
3 | import User from './User'; | ||
4 | |||
5 | export default class Token extends BaseModel { | ||
6 | @column({ isPrimary: true }) | ||
7 | public id: number; | ||
8 | |||
9 | @hasOne(() => User, { | ||
10 | localKey: 'user_id', | ||
11 | foreignKey: 'id', | ||
12 | }) | ||
13 | public user: HasOne<typeof User>; | ||
14 | |||
15 | @column() | ||
16 | public user_id: number; | ||
17 | |||
18 | @column() | ||
19 | public token: string; | ||
20 | |||
21 | @column() | ||
22 | public type: string; | ||
23 | |||
24 | @column() | ||
25 | public is_revoked: boolean; | ||
26 | |||
27 | @column() | ||
28 | public name: string; | ||
29 | |||
30 | @column.dateTime() | ||
31 | public expires_at: DateTime; | ||
32 | |||
33 | @column.dateTime({ autoCreate: true }) | ||
34 | public created_at: DateTime; | ||
35 | |||
36 | @column.dateTime({ autoCreate: true, autoUpdate: true }) | ||
37 | public updated_at: DateTime; | ||
38 | } | ||
diff --git a/app/Models/Traits/NoTimestamp.js b/app/Models/Traits/NoTimestamp.js deleted file mode 100644 index 914f542..0000000 --- a/app/Models/Traits/NoTimestamp.js +++ /dev/null | |||
@@ -1,14 +0,0 @@ | |||
1 | class NoTimestamp { | ||
2 | register(Model) { | ||
3 | Object.defineProperties(Model, { | ||
4 | createdAtColumn: { | ||
5 | get: () => null, | ||
6 | }, | ||
7 | updatedAtColumn: { | ||
8 | get: () => null, | ||
9 | }, | ||
10 | }); | ||
11 | } | ||
12 | } | ||
13 | |||
14 | module.exports = NoTimestamp; | ||
diff --git a/app/Models/User.js b/app/Models/User.js deleted file mode 100644 index 4472017..0000000 --- a/app/Models/User.js +++ /dev/null | |||
@@ -1,46 +0,0 @@ | |||
1 | /** @type {typeof import('@adonisjs/lucid/src/Lucid/Model')} */ | ||
2 | const Model = use('Model'); | ||
3 | |||
4 | /** @type {import('@adonisjs/framework/src/Hash')} */ | ||
5 | const Hash = use('Hash'); | ||
6 | |||
7 | class User extends Model { | ||
8 | static boot() { | ||
9 | super.boot(); | ||
10 | |||
11 | /** | ||
12 | * A hook to hash the user password before saving | ||
13 | * it to the database. | ||
14 | */ | ||
15 | this.addHook('beforeSave', async (userInstance) => { | ||
16 | if (userInstance.dirty.password) { | ||
17 | // eslint-disable-next-line no-param-reassign | ||
18 | userInstance.password = await Hash.make(userInstance.password); | ||
19 | } | ||
20 | }); | ||
21 | } | ||
22 | |||
23 | /** | ||
24 | * A relationship on tokens is required for auth to | ||
25 | * work. Since features like `refreshTokens` or | ||
26 | * `rememberToken` will be saved inside the | ||
27 | * tokens table. | ||
28 | * | ||
29 | * @method tokens | ||
30 | * | ||
31 | * @return {Object} | ||
32 | */ | ||
33 | tokens() { | ||
34 | return this.hasMany('App/Models/Token'); | ||
35 | } | ||
36 | |||
37 | services() { | ||
38 | return this.hasMany('App/Models/Service', 'id', 'userId'); | ||
39 | } | ||
40 | |||
41 | workspaces() { | ||
42 | return this.hasMany('App/Models/Workspace', 'id', 'userId'); | ||
43 | } | ||
44 | } | ||
45 | |||
46 | module.exports = User; | ||
diff --git a/app/Models/User.ts b/app/Models/User.ts new file mode 100644 index 0000000..0ed4627 --- /dev/null +++ b/app/Models/User.ts | |||
@@ -0,0 +1,98 @@ | |||
1 | import { DateTime } from 'luxon'; | ||
2 | import { | ||
3 | BaseModel, | ||
4 | beforeSave, | ||
5 | column, | ||
6 | HasMany, | ||
7 | hasMany, | ||
8 | } from '@ioc:Adonis/Lucid/Orm'; | ||
9 | import Hash from '@ioc:Adonis/Core/Hash'; | ||
10 | import Event from '@ioc:Adonis/Core/Event'; | ||
11 | import moment from 'moment'; | ||
12 | import Encryption from '@ioc:Adonis/Core/Encryption'; | ||
13 | import randtoken from 'rand-token'; | ||
14 | import Token from './Token'; | ||
15 | import Workspace from './Workspace'; | ||
16 | import Service from './Service'; | ||
17 | |||
18 | export default class User extends BaseModel { | ||
19 | @column({ isPrimary: true }) | ||
20 | public id: number; | ||
21 | |||
22 | @column() | ||
23 | public email: string; | ||
24 | |||
25 | @column() | ||
26 | public username: string; | ||
27 | |||
28 | @column() | ||
29 | public password: string; | ||
30 | |||
31 | @column() | ||
32 | public lastname: string; | ||
33 | |||
34 | // TODO: Type the settings object. | ||
35 | @column() | ||
36 | public settings: object; | ||
37 | |||
38 | @column.dateTime({ autoCreate: true }) | ||
39 | public created_at: DateTime; | ||
40 | |||
41 | @column.dateTime({ autoCreate: true, autoUpdate: true }) | ||
42 | public updated_at: DateTime; | ||
43 | |||
44 | @beforeSave() | ||
45 | public static async hashPassword(user: User) { | ||
46 | if (user.$dirty.password) { | ||
47 | user.password = await Hash.make(user.password); | ||
48 | } | ||
49 | } | ||
50 | |||
51 | @hasMany(() => Token, { | ||
52 | foreignKey: 'user_id', | ||
53 | }) | ||
54 | public tokens: HasMany<typeof Token>; | ||
55 | |||
56 | @hasMany(() => Service, { | ||
57 | foreignKey: 'userId', | ||
58 | }) | ||
59 | public services: HasMany<typeof Service>; | ||
60 | |||
61 | @hasMany(() => Workspace, { | ||
62 | foreignKey: 'userId', | ||
63 | }) | ||
64 | public workspaces: HasMany<typeof Workspace>; | ||
65 | |||
66 | public async forgotPassword(): Promise<void> { | ||
67 | const token = await this.generateToken(this, 'forgot_password'); | ||
68 | |||
69 | await Event.emit('forgot:password', { | ||
70 | user: this, | ||
71 | token, | ||
72 | }); | ||
73 | } | ||
74 | |||
75 | private async generateToken(user: User, type: string): Promise<string> { | ||
76 | const query = user | ||
77 | .related('tokens') | ||
78 | .query() | ||
79 | .where('type', type) | ||
80 | .where('is_revoked', false) | ||
81 | .where( | ||
82 | 'updated_at', | ||
83 | '>=', | ||
84 | moment().subtract(24, 'hours').format('YYYY-MM-DD HH:mm:ss'), | ||
85 | ); | ||
86 | |||
87 | const row = await query.first(); | ||
88 | if (row) { | ||
89 | return row.token; | ||
90 | } | ||
91 | |||
92 | const token = Encryption.encrypt(randtoken.generate(16)); | ||
93 | |||
94 | await user.related('tokens').create({ type, token }); | ||
95 | |||
96 | return token; | ||
97 | } | ||
98 | } | ||
diff --git a/app/Models/Workspace.js b/app/Models/Workspace.js deleted file mode 100644 index e3a3285..0000000 --- a/app/Models/Workspace.js +++ /dev/null | |||
@@ -1,10 +0,0 @@ | |||
1 | /** @type {typeof import('@adonisjs/lucid/src/Lucid/Model')} */ | ||
2 | const Model = use('Model'); | ||
3 | |||
4 | class Workspace extends Model { | ||
5 | user() { | ||
6 | return this.belongsTo('App/Models/User', 'userId', 'id'); | ||
7 | } | ||
8 | } | ||
9 | |||
10 | module.exports = Workspace; | ||
diff --git a/app/Models/Workspace.ts b/app/Models/Workspace.ts new file mode 100644 index 0000000..8648e02 --- /dev/null +++ b/app/Models/Workspace.ts | |||
@@ -0,0 +1,41 @@ | |||
1 | import { DateTime } from 'luxon'; | ||
2 | import { BaseModel, column, HasOne, hasOne } from '@ioc:Adonis/Lucid/Orm'; | ||
3 | import User from './User'; | ||
4 | |||
5 | export default class Workspace extends BaseModel { | ||
6 | @column({ isPrimary: true }) | ||
7 | public id: number; | ||
8 | |||
9 | @column({ | ||
10 | columnName: 'workspaceId', | ||
11 | }) | ||
12 | public workspaceId: string; | ||
13 | |||
14 | @hasOne(() => User, { | ||
15 | foreignKey: 'userId', | ||
16 | }) | ||
17 | public user: HasOne<typeof User>; | ||
18 | |||
19 | @column({ | ||
20 | columnName: 'userId', | ||
21 | }) | ||
22 | public userId: number; | ||
23 | |||
24 | @column() | ||
25 | public name: string; | ||
26 | |||
27 | @column() | ||
28 | public order: number; | ||
29 | |||
30 | @column() | ||
31 | public services: string; | ||
32 | |||
33 | @column() | ||
34 | public data: string; | ||
35 | |||
36 | @column.dateTime({ autoCreate: true }) | ||
37 | public createdAt: DateTime; | ||
38 | |||
39 | @column.dateTime({ autoCreate: true, autoUpdate: true }) | ||
40 | public updatedAt: DateTime; | ||
41 | } | ||