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>

1 files changed, 254 insertions, 0 deletions

diff --git a/app/Controllers/Http/RecipeController.ts b/app/Controllers/Http/RecipeController.ts
new file mode 100644
index 0000000..5186a11
--- /dev/null
+++ b/app/Controllers/Http/RecipeController.ts
@@ -0,0 +1,254 @@
+import type { HttpContextContract } from '@ioc:Adonis/Core/HttpContext';
+import fs from 'fs-extra';
+import Application from '@ioc:Adonis/Core/Application';
+import path from 'node:path';
+import Recipe from 'App/Models/Recipe';
+import { isCreationEnabled } from 'Config/app';
+import { validator, schema, rules } from '@ioc:Adonis/Core/Validator';
+import targz from 'targz';
+import semver from 'semver';
+import Drive from '@ioc:Adonis/Core/Drive';
+
+// TODO: This file needs to be refactored and cleaned up to include types
+
+const createSchema = schema.create({
+  name: schema.string(),
+  id: schema.string([rules.unique({ table: 'recipes', column: 'recipeId' })]),
+  // TODO: Check if this is correct
+  //   author: 'required|accepted',
+  author: schema.string(),
+  svg: schema.string([rules.url()]),
+});
+
+const searchSchema = schema.create({
+  needle: schema.string(),
+});
+
+const downloadSchema = schema.create({
+  // TODO: Check if this is correct
+  //   recipe: 'required|accepted',
+  recipe: schema.string(),
+});
+
+const compress = (src: string, dest: string) =>
+  new Promise((resolve, reject) => {
+    targz.compress(
+      {
+        src,
+        dest,
+      },
+      err => {
+        if (err) {
+          reject(err);
+        } else {
+          resolve(dest);
+        }
+      },
+    );
+  });
+
+export default class RecipesController {
+  // List official and custom recipes
+  public async list({ response }: HttpContextContract) {
+    const officialRecipes = fs.readJsonSync(
+      path.join(Application.appRoot, 'recipes', 'all.json'),
+    );
+    const customRecipesArray = await Recipe.all();
+    const customRecipes = customRecipesArray.map(recipe => ({
+      id: recipe.recipeId,
+      name: recipe.name,
+      ...(typeof recipe.data === 'string'
+        ? JSON.parse(recipe.data)
+        : recipe.data),
+    }));
+
+    const recipes = [...officialRecipes, ...customRecipes];
+
+    return response.send(recipes);
+  }
+
+  // TODO: Test this endpoint
+  // Create a new recipe using the new.html page
+  public async create({ request, response }: HttpContextContract) {
+    // Check if recipe creation is enabled
+    if (isCreationEnabled === 'false') {
+      return response.send(
+        'This server doesn\'t allow the creation of new recipes.',
+      );
+    }
+
+    // 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,
+      });
+    }
+
+    if (!data.id) {
+      return response.send('Please provide an ID');
+    }
+
+    // Check for invalid characters
+    if (/\.+/.test(data.id) || /\/+/.test(data.id)) {
+      return response.send(
+        'Invalid recipe name. Your recipe name may not contain "." or "/"',
+      );
+    }
+
+    // Clear temporary recipe folder
+    await fs.emptyDir(Application.tmpPath('recipe'));
+
+    // Move uploaded files to temporary path
+    const files = request.file('files');
+    if (!files) {
+      return response.abort('Error processsing files.');
+    }
+    await files.move(Application.tmpPath('recipe'));
+
+    // Compress files to .tar.gz file
+    const source = Application.tmpPath('recipe');
+    const destination = path.join(
+      Application.appRoot,
+      `/recipes/archives/${data.id}.tar.gz`,
+    );
+
+    compress(source, destination);
+
+    // Create recipe in db
+    await Recipe.create({
+      name: data.name,
+      recipeId: data.id,
+      // @ts-expect-error
+      data: JSON.stringify({
+        author: data.author,
+        featured: false,
+        version: '1.0.0',
+        icons: {
+          svg: data.svg,
+        },
+      }),
+    });
+
+    return response.send('Created new recipe');
+  }
+
+  // Search official and custom recipes
+  public async search({ request, response }: HttpContextContract) {
+    // Validate user input
+    let data;
+    try {
+      data = await request.validate({ schema: searchSchema });
+    } catch (error) {
+      return response.status(401).send({
+        message: 'Please provide a needle',
+        messages: error.messages,
+        status: 401,
+      });
+    }
+
+    const { needle } = data;
+
+    // Get results
+    let results;
+
+    if (needle === 'ferdium:custom') {
+      const dbResults = await Recipe.all();
+      results = dbResults.map(recipe => ({
+        id: recipe.recipeId,
+        name: recipe.name,
+        ...(typeof recipe.data === 'string'
+          ? JSON.parse(recipe.data)
+          : recipe.data),
+      }));
+    } else {
+      const localResultsArray = await Recipe.query().where(
+        'name',
+        'LIKE',
+        `%${needle}%`,
+      );
+      results = localResultsArray.map(recipe => ({
+        id: recipe.recipeId,
+        name: recipe.name,
+        ...(typeof recipe.data === 'string'
+          ? JSON.parse(recipe.data)
+          : recipe.data),
+      }));
+    }
+
+    return response.send(results);
+  }
+
+  public popularRecipes({ response }: HttpContextContract) {
+    return response.send(
+      fs
+        .readJsonSync(path.join(Application.appRoot, 'recipes', 'all.json'))
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        .filter((recipe: any) => recipe.featured),
+    );
+  }
+
+  // TODO: test this endpoint
+  public update({ request, response }: HttpContextContract) {
+    const updates = [];
+    const recipes = request.all();
+    const allJson = fs.readJsonSync(
+      path.join(Application.appRoot, 'recipes', 'all.json'),
+    );
+
+    for (const recipe of Object.keys(recipes)) {
+      const version = recipes[recipe];
+
+      // Find recipe in local recipe repository
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      const localRecipe = allJson.find((r: any) => r.id === recipe);
+      if (localRecipe && semver.lt(version, localRecipe.version)) {
+        updates.push(recipe);
+      }
+    }
+
+    return response.send(updates);
+  }
+
+  // TODO: test this endpoint
+  // Download a recipe
+  public async download({ response, params }: HttpContextContract) {
+    // Validate user input
+    let data;
+    try {
+      data = await validator.validate({
+        data: params,
+        schema: downloadSchema,
+      });
+    } catch (error) {
+      return response.status(401).send({
+        message: 'Please provide a recipe ID',
+        messages: error.messages,
+        status: 401,
+      });
+    }
+
+    const service = data.recipe;
+
+    // Check for invalid characters
+    if (/\.+/.test(service) || /\/+/.test(service)) {
+      return response.send('Invalid recipe name');
+    }
+
+    // Check if recipe exists in recipes folder
+    if (await Drive.exists(`${service}.tar.gz`)) {
+      return response
+        .type('.tar.gz')
+        .send(await Drive.get(`${service}.tar.gz`));
+    }
+
+    return response.status(400).send({
+      message: 'Recipe not found',
+      code: 'recipe-not-found',
+    });
+  }
+}