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 --- app/Controllers/Http/ServiceController.ts | 365 ++++++++++++++++++++++++++++++ 1 file changed, 365 insertions(+) create mode 100644 app/Controllers/Http/ServiceController.ts (limited to 'app/Controllers/Http/ServiceController.ts') 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 @@ +import type { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'; +import { schema } from '@ioc:Adonis/Core/Validator'; +import Service from 'App/Models/Service'; +import { url } from 'Config/app'; +import { v4 as uuid } from 'uuid'; +import * as fs from 'fs-extra'; +import path from 'node:path'; +import Application from '@ioc:Adonis/Core/Application'; +import sanitize from 'sanitize-filename'; + +const createSchema = schema.create({ + name: schema.string(), + recipeId: schema.string(), +}); + +export default class ServicesController { + // Create a new service for user + public async create({ request, response, auth }: HttpContextContract) { + // @ts-expect-error Property 'user' does not exist on type 'HttpContextContract'. + const user = auth.user ?? request.user; + + if (!user) { + return response.unauthorized('Missing or invalid api token'); + } + + // Validate user input + let data; + try { + data = await request.validate({ schema: createSchema }); + } catch (error) { + return response.status(401).send({ + message: 'Invalid POST arguments', + messages: error.messages, + status: 401, + }); + } + + // Get new, unused uuid + let serviceId; + do { + serviceId = uuid(); + } while ( + // eslint-disable-next-line no-await-in-loop, unicorn/no-await-expression-member + (await Service.query().where('serviceId', serviceId)).length > 0 + ); + + await Service.create({ + userId: user.id, + serviceId, + name: data.name, + recipeId: data.recipeId, + settings: JSON.stringify(data), + }); + + return response.send({ + data: { + userId: user.id, + id: serviceId, + isEnabled: true, + isNotificationEnabled: true, + isBadgeEnabled: true, + isMuted: false, + isDarkModeEnabled: '', + spellcheckerLanguage: '', + order: 1, + customRecipe: false, + hasCustomIcon: false, + workspaces: [], + // eslint-disable-next-line unicorn/no-null + iconUrl: null, + ...data, + }, + status: ['created'], + }); + } + + // List all services a user has created + public async list({ request, response, auth }: HttpContextContract) { + // @ts-expect-error Property 'user' does not exist on type 'HttpContextContract'. + const user = auth.user ?? request.user; + + if (!user) { + return response.unauthorized('Missing or invalid api token'); + } + + const { id } = user; + const services = await user.related('services').query(); + + // Convert to array with all data Franz wants + // eslint-disable-next-line @typescript-eslint/no-explicit-any + const servicesArray = services.map((service: any) => { + const settings = + typeof service.settings === 'string' + ? JSON.parse(service.settings) + : service.settings; + + return { + customRecipe: false, + hasCustomIcon: !!settings.iconId, + isBadgeEnabled: true, + isDarkModeEnabled: '', + isEnabled: true, + isMuted: false, + isNotificationEnabled: true, + order: 1, + spellcheckerLanguage: '', + workspaces: [], + ...settings, + iconUrl: settings.iconId + ? `${url}/v1/icon/${settings.iconId}` + : // eslint-disable-next-line unicorn/no-null + null, + id: service.serviceId, + name: service.name, + recipeId: service.recipeId, + userId: id, + }; + }); + + return response.send(servicesArray); + } + + public async delete({ params, auth, response }: HttpContextContract) { + // @ts-expect-error Property 'user' does not exist on type 'HttpContextContract'. + const user = auth.user ?? request.user; + + if (!user) { + return response.unauthorized('Missing or invalid api token'); + } + + // Update data in database + await Service.query() + .where('serviceId', params.id) + .where('userId', user.id) + .delete(); + + return response.send({ + message: 'Sucessfully deleted service', + status: 200, + }); + } + + // TODO: Test if icon upload works + public async edit({ request, response, auth, params }: HttpContextContract) { + // @ts-expect-error Property 'user' does not exist on type 'HttpContextContract'. + const user = auth.user ?? request.user; + + if (!user) { + return response.unauthorized('Missing or invalid api token'); + } + + const { id } = params; + const service = await Service.query() + .where('serviceId', id) + .where('userId', user.id) + .firstOrFail(); + + if (request.file('icon')) { + // Upload custom service icon + const icon = request.file('icon', { + extnames: ['png', 'jpg', 'jpeg', 'svg'], + size: '2mb', + }); + + if (icon === null) { + return response.badRequest('Icon not uploaded.'); + } + + const settings = + typeof service.settings === 'string' + ? JSON.parse(service.settings) + : service.settings; + + let iconId; + do { + iconId = uuid() + uuid(); + } while ( + // eslint-disable-next-line no-await-in-loop + await fs.exists(path.join(Application.tmpPath('uploads'), iconId)) + ); + iconId = `${iconId}.${icon.extname}`; + + await icon.move(Application.tmpPath('uploads'), { + name: iconId, + overwrite: true, + }); + + if (icon.state !== 'moved') { + return response.status(500).send(icon.errors); + } + + const newSettings = { + ...settings, + + iconId, + customIconVersion: settings?.customIconVersion + ? settings.customIconVersion + 1 + : 1, + }; + + // Update data in database + await Service.query() + .where('serviceId', id) + .where('userId', user.id) + .update({ + name: service.name, + settings: JSON.stringify(newSettings), + }); + + return response.send({ + data: { + id, + name: service.name, + ...newSettings, + iconUrl: `${url}/v1/icon/${newSettings.iconId}`, + userId: user.id, + }, + status: ['updated'], + }); + } + // Update service info + const data = request.all(); + + const settings = { + ...(typeof service.settings === 'string' + ? JSON.parse(service.settings) + : service.settings), + ...data, + }; + + if (settings.customIcon === 'delete') { + fs.remove( + path.join(Application.tmpPath('uploads'), settings.iconId), + ).catch(error => { + console.error(error); + }); + + settings.iconId = undefined; + settings.customIconVersion = undefined; + settings.customIcon = ''; + } + + // Update data in database + await Service.query() + .where('serviceId', id) + .where('userId', user.id) + .update({ + name: data.name, + settings: JSON.stringify(settings), + }); + + // Get updated row + const serviceUpdated = await Service.query() + .where('serviceId', id) + .where('userId', user.id) + .firstOrFail(); + + return response.send({ + data: { + id, + name: serviceUpdated.name, + ...settings, + iconUrl: `${url}/v1/icon/${settings.iconId}`, + userId: user.id, + }, + status: ['updated'], + }); + } + + // TODO: Test if this works + public async reorder({ request, response, auth }: HttpContextContract) { + // @ts-expect-error Property 'user' does not exist on type 'HttpContextContract'. + const user = auth.user ?? request.user; + + if (!user) { + return response.unauthorized('Missing or invalid api token'); + } + + const data = request.all(); + + for (const service of Object.keys(data)) { + // Get current settings from db + const serviceData = await Service.query() // eslint-disable-line no-await-in-loop + .where('serviceId', service) + .where('userId', user.id) + + .firstOrFail(); + + const settings = { + ...(typeof serviceData.settings === 'string' + ? JSON.parse(serviceData.settings) + : serviceData.settings), + order: data[service], + }; + + // Update data in database + await Service.query() // eslint-disable-line no-await-in-loop + .where('serviceId', service) + .where('userId', user.id) + .update({ + settings: JSON.stringify(settings), + }); + } + + // Get new services + const services = await user.related('services').query(); + // Convert to array with all data Franz wants + // eslint-disable-next-line @typescript-eslint/no-explicit-any + const servicesArray = services.map((service: any) => { + const settings = + typeof service.settings === 'string' + ? JSON.parse(service.settings) + : service.settings; + + return { + customRecipe: false, + hasCustomIcon: !!settings.iconId, + isBadgeEnabled: true, + isDarkModeEnabled: '', + isEnabled: true, + isMuted: false, + isNotificationEnabled: true, + order: 1, + spellcheckerLanguage: '', + workspaces: [], + ...settings, + iconUrl: settings.iconId + ? `${url}/v1/icon/${settings.iconId}` + : // eslint-disable-next-line unicorn/no-null + null, + id: service.serviceId, + name: service.name, + recipeId: service.recipeId, + userId: user.id, + }; + }); + + return response.send(servicesArray); + } + + // TODO: Test if this works + public async icon({ params, response }: HttpContextContract) { + let { id } = params; + + id = sanitize(id); + if (id === '') { + return response.status(404).send({ + status: 'Icon doesn\'t exist', + }); + } + + const iconPath = path.join(Application.tmpPath('uploads'), id); + + try { + await fs.access(iconPath); + } catch { + // File not available. + return response.status(404).send({ + status: 'Icon doesn\'t exist', + }); + } + + return response.download(iconPath); + } +} -- cgit v1.2.3-54-g00ecf