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/Controllers/Http/ServiceController.ts | |
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/Controllers/Http/ServiceController.ts')
-rw-r--r-- | app/Controllers/Http/ServiceController.ts | 365 |
1 files changed, 365 insertions, 0 deletions
diff --git a/app/Controllers/Http/ServiceController.ts b/app/Controllers/Http/ServiceController.ts new file mode 100644 index 0000000..36c6ca4 --- /dev/null +++ b/app/Controllers/Http/ServiceController.ts | |||
@@ -0,0 +1,365 @@ | |||
1 | import type { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'; | ||
2 | import { schema } from '@ioc:Adonis/Core/Validator'; | ||
3 | import Service from 'App/Models/Service'; | ||
4 | import { url } from 'Config/app'; | ||
5 | import { v4 as uuid } from 'uuid'; | ||
6 | import * as fs from 'fs-extra'; | ||
7 | import path from 'node:path'; | ||
8 | import Application from '@ioc:Adonis/Core/Application'; | ||
9 | import sanitize from 'sanitize-filename'; | ||
10 | |||
11 | const createSchema = schema.create({ | ||
12 | name: schema.string(), | ||
13 | recipeId: schema.string(), | ||
14 | }); | ||
15 | |||
16 | export default class ServicesController { | ||
17 | // Create a new service for user | ||
18 | public async create({ request, response, auth }: HttpContextContract) { | ||
19 | // @ts-expect-error Property 'user' does not exist on type 'HttpContextContract'. | ||
20 | const user = auth.user ?? request.user; | ||
21 | |||
22 | if (!user) { | ||
23 | return response.unauthorized('Missing or invalid api token'); | ||
24 | } | ||
25 | |||
26 | // Validate user input | ||
27 | let data; | ||
28 | try { | ||
29 | data = await request.validate({ schema: createSchema }); | ||
30 | } catch (error) { | ||
31 | return response.status(401).send({ | ||
32 | message: 'Invalid POST arguments', | ||
33 | messages: error.messages, | ||
34 | status: 401, | ||
35 | }); | ||
36 | } | ||
37 | |||
38 | // Get new, unused uuid | ||
39 | let serviceId; | ||
40 | do { | ||
41 | serviceId = uuid(); | ||
42 | } while ( | ||
43 | // eslint-disable-next-line no-await-in-loop, unicorn/no-await-expression-member | ||
44 | (await Service.query().where('serviceId', serviceId)).length > 0 | ||
45 | ); | ||
46 | |||
47 | await Service.create({ | ||
48 | userId: user.id, | ||
49 | serviceId, | ||
50 | name: data.name, | ||
51 | recipeId: data.recipeId, | ||
52 | settings: JSON.stringify(data), | ||
53 | }); | ||
54 | |||
55 | return response.send({ | ||
56 | data: { | ||
57 | userId: user.id, | ||
58 | id: serviceId, | ||
59 | isEnabled: true, | ||
60 | isNotificationEnabled: true, | ||
61 | isBadgeEnabled: true, | ||
62 | isMuted: false, | ||
63 | isDarkModeEnabled: '', | ||
64 | spellcheckerLanguage: '', | ||
65 | order: 1, | ||
66 | customRecipe: false, | ||
67 | hasCustomIcon: false, | ||
68 | workspaces: [], | ||
69 | // eslint-disable-next-line unicorn/no-null | ||
70 | iconUrl: null, | ||
71 | ...data, | ||
72 | }, | ||
73 | status: ['created'], | ||
74 | }); | ||
75 | } | ||
76 | |||
77 | // List all services a user has created | ||
78 | public async list({ request, response, auth }: HttpContextContract) { | ||
79 | // @ts-expect-error Property 'user' does not exist on type 'HttpContextContract'. | ||
80 | const user = auth.user ?? request.user; | ||
81 | |||
82 | if (!user) { | ||
83 | return response.unauthorized('Missing or invalid api token'); | ||
84 | } | ||
85 | |||
86 | const { id } = user; | ||
87 | const services = await user.related('services').query(); | ||
88 | |||
89 | // Convert to array with all data Franz wants | ||
90 | // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
91 | const servicesArray = services.map((service: any) => { | ||
92 | const settings = | ||
93 | typeof service.settings === 'string' | ||
94 | ? JSON.parse(service.settings) | ||
95 | : service.settings; | ||
96 | |||
97 | return { | ||
98 | customRecipe: false, | ||
99 | hasCustomIcon: !!settings.iconId, | ||
100 | isBadgeEnabled: true, | ||
101 | isDarkModeEnabled: '', | ||
102 | isEnabled: true, | ||
103 | isMuted: false, | ||
104 | isNotificationEnabled: true, | ||
105 | order: 1, | ||
106 | spellcheckerLanguage: '', | ||
107 | workspaces: [], | ||
108 | ...settings, | ||
109 | iconUrl: settings.iconId | ||
110 | ? `${url}/v1/icon/${settings.iconId}` | ||
111 | : // eslint-disable-next-line unicorn/no-null | ||
112 | null, | ||
113 | id: service.serviceId, | ||
114 | name: service.name, | ||
115 | recipeId: service.recipeId, | ||
116 | userId: id, | ||
117 | }; | ||
118 | }); | ||
119 | |||
120 | return response.send(servicesArray); | ||
121 | } | ||
122 | |||
123 | public async delete({ params, auth, response }: HttpContextContract) { | ||
124 | // @ts-expect-error Property 'user' does not exist on type 'HttpContextContract'. | ||
125 | const user = auth.user ?? request.user; | ||
126 | |||
127 | if (!user) { | ||
128 | return response.unauthorized('Missing or invalid api token'); | ||
129 | } | ||
130 | |||
131 | // Update data in database | ||
132 | await Service.query() | ||
133 | .where('serviceId', params.id) | ||
134 | .where('userId', user.id) | ||
135 | .delete(); | ||
136 | |||
137 | return response.send({ | ||
138 | message: 'Sucessfully deleted service', | ||
139 | status: 200, | ||
140 | }); | ||
141 | } | ||
142 | |||
143 | // TODO: Test if icon upload works | ||
144 | public async edit({ request, response, auth, params }: HttpContextContract) { | ||
145 | // @ts-expect-error Property 'user' does not exist on type 'HttpContextContract'. | ||
146 | const user = auth.user ?? request.user; | ||
147 | |||
148 | if (!user) { | ||
149 | return response.unauthorized('Missing or invalid api token'); | ||
150 | } | ||
151 | |||
152 | const { id } = params; | ||
153 | const service = await Service.query() | ||
154 | .where('serviceId', id) | ||
155 | .where('userId', user.id) | ||
156 | .firstOrFail(); | ||
157 | |||
158 | if (request.file('icon')) { | ||
159 | // Upload custom service icon | ||
160 | const icon = request.file('icon', { | ||
161 | extnames: ['png', 'jpg', 'jpeg', 'svg'], | ||
162 | size: '2mb', | ||
163 | }); | ||
164 | |||
165 | if (icon === null) { | ||
166 | return response.badRequest('Icon not uploaded.'); | ||
167 | } | ||
168 | |||
169 | const settings = | ||
170 | typeof service.settings === 'string' | ||
171 | ? JSON.parse(service.settings) | ||
172 | : service.settings; | ||
173 | |||
174 | let iconId; | ||
175 | do { | ||
176 | iconId = uuid() + uuid(); | ||
177 | } while ( | ||
178 | // eslint-disable-next-line no-await-in-loop | ||
179 | await fs.exists(path.join(Application.tmpPath('uploads'), iconId)) | ||
180 | ); | ||
181 | iconId = `${iconId}.${icon.extname}`; | ||
182 | |||
183 | await icon.move(Application.tmpPath('uploads'), { | ||
184 | name: iconId, | ||
185 | overwrite: true, | ||
186 | }); | ||
187 | |||
188 | if (icon.state !== 'moved') { | ||
189 | return response.status(500).send(icon.errors); | ||
190 | } | ||
191 | |||
192 | const newSettings = { | ||
193 | ...settings, | ||
194 | |||
195 | iconId, | ||
196 | customIconVersion: settings?.customIconVersion | ||
197 | ? settings.customIconVersion + 1 | ||
198 | : 1, | ||
199 | }; | ||
200 | |||
201 | // Update data in database | ||
202 | await Service.query() | ||
203 | .where('serviceId', id) | ||
204 | .where('userId', user.id) | ||
205 | .update({ | ||
206 | name: service.name, | ||
207 | settings: JSON.stringify(newSettings), | ||
208 | }); | ||
209 | |||
210 | return response.send({ | ||
211 | data: { | ||
212 | id, | ||
213 | name: service.name, | ||
214 | ...newSettings, | ||
215 | iconUrl: `${url}/v1/icon/${newSettings.iconId}`, | ||
216 | userId: user.id, | ||
217 | }, | ||
218 | status: ['updated'], | ||
219 | }); | ||
220 | } | ||
221 | // Update service info | ||
222 | const data = request.all(); | ||
223 | |||
224 | const settings = { | ||
225 | ...(typeof service.settings === 'string' | ||
226 | ? JSON.parse(service.settings) | ||
227 | : service.settings), | ||
228 | ...data, | ||
229 | }; | ||
230 | |||
231 | if (settings.customIcon === 'delete') { | ||
232 | fs.remove( | ||
233 | path.join(Application.tmpPath('uploads'), settings.iconId), | ||
234 | ).catch(error => { | ||
235 | console.error(error); | ||
236 | }); | ||
237 | |||
238 | settings.iconId = undefined; | ||
239 | settings.customIconVersion = undefined; | ||
240 | settings.customIcon = ''; | ||
241 | } | ||
242 | |||
243 | // Update data in database | ||
244 | await Service.query() | ||
245 | .where('serviceId', id) | ||
246 | .where('userId', user.id) | ||
247 | .update({ | ||
248 | name: data.name, | ||
249 | settings: JSON.stringify(settings), | ||
250 | }); | ||
251 | |||
252 | // Get updated row | ||
253 | const serviceUpdated = await Service.query() | ||
254 | .where('serviceId', id) | ||
255 | .where('userId', user.id) | ||
256 | .firstOrFail(); | ||
257 | |||
258 | return response.send({ | ||
259 | data: { | ||
260 | id, | ||
261 | name: serviceUpdated.name, | ||
262 | ...settings, | ||
263 | iconUrl: `${url}/v1/icon/${settings.iconId}`, | ||
264 | userId: user.id, | ||
265 | }, | ||
266 | status: ['updated'], | ||
267 | }); | ||
268 | } | ||
269 | |||
270 | // TODO: Test if this works | ||
271 | public async reorder({ request, response, auth }: HttpContextContract) { | ||
272 | // @ts-expect-error Property 'user' does not exist on type 'HttpContextContract'. | ||
273 | const user = auth.user ?? request.user; | ||
274 | |||
275 | if (!user) { | ||
276 | return response.unauthorized('Missing or invalid api token'); | ||
277 | } | ||
278 | |||
279 | const data = request.all(); | ||
280 | |||
281 | for (const service of Object.keys(data)) { | ||
282 | // Get current settings from db | ||
283 | const serviceData = await Service.query() // eslint-disable-line no-await-in-loop | ||
284 | .where('serviceId', service) | ||
285 | .where('userId', user.id) | ||
286 | |||
287 | .firstOrFail(); | ||
288 | |||
289 | const settings = { | ||
290 | ...(typeof serviceData.settings === 'string' | ||
291 | ? JSON.parse(serviceData.settings) | ||
292 | : serviceData.settings), | ||
293 | order: data[service], | ||
294 | }; | ||
295 | |||
296 | // Update data in database | ||
297 | await Service.query() // eslint-disable-line no-await-in-loop | ||
298 | .where('serviceId', service) | ||
299 | .where('userId', user.id) | ||
300 | .update({ | ||
301 | settings: JSON.stringify(settings), | ||
302 | }); | ||
303 | } | ||
304 | |||
305 | // Get new services | ||
306 | const services = await user.related('services').query(); | ||
307 | // Convert to array with all data Franz wants | ||
308 | // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
309 | const servicesArray = services.map((service: any) => { | ||
310 | const settings = | ||
311 | typeof service.settings === 'string' | ||
312 | ? JSON.parse(service.settings) | ||
313 | : service.settings; | ||
314 | |||
315 | return { | ||
316 | customRecipe: false, | ||
317 | hasCustomIcon: !!settings.iconId, | ||
318 | isBadgeEnabled: true, | ||
319 | isDarkModeEnabled: '', | ||
320 | isEnabled: true, | ||
321 | isMuted: false, | ||
322 | isNotificationEnabled: true, | ||
323 | order: 1, | ||
324 | spellcheckerLanguage: '', | ||
325 | workspaces: [], | ||
326 | ...settings, | ||
327 | iconUrl: settings.iconId | ||
328 | ? `${url}/v1/icon/${settings.iconId}` | ||
329 | : // eslint-disable-next-line unicorn/no-null | ||
330 | null, | ||
331 | id: service.serviceId, | ||
332 | name: service.name, | ||
333 | recipeId: service.recipeId, | ||
334 | userId: user.id, | ||
335 | }; | ||
336 | }); | ||
337 | |||
338 | return response.send(servicesArray); | ||
339 | } | ||
340 | |||
341 | // TODO: Test if this works | ||
342 | public async icon({ params, response }: HttpContextContract) { | ||
343 | let { id } = params; | ||
344 | |||
345 | id = sanitize(id); | ||
346 | if (id === '') { | ||
347 | return response.status(404).send({ | ||
348 | status: 'Icon doesn\'t exist', | ||
349 | }); | ||
350 | } | ||
351 | |||
352 | const iconPath = path.join(Application.tmpPath('uploads'), id); | ||
353 | |||
354 | try { | ||
355 | await fs.access(iconPath); | ||
356 | } catch { | ||
357 | // File not available. | ||
358 | return response.status(404).send({ | ||
359 | status: 'Icon doesn\'t exist', | ||
360 | }); | ||
361 | } | ||
362 | |||
363 | return response.download(iconPath); | ||
364 | } | ||
365 | } | ||