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 --- tests/functional/api/register.spec.ts | 0 tests/functional/api/static/announcements.spec.ts | 55 +++++++++++++++++++++++ tests/functional/api/static/features.spec.ts | 29 ++++++++++++ tests/functional/api/static/news.spec.ts | 11 +++++ tests/functional/api/static/services.spec.ts | 11 +++++ 5 files changed, 106 insertions(+) create mode 100644 tests/functional/api/register.spec.ts create mode 100644 tests/functional/api/static/announcements.spec.ts create mode 100644 tests/functional/api/static/features.spec.ts create mode 100644 tests/functional/api/static/news.spec.ts create mode 100644 tests/functional/api/static/services.spec.ts (limited to 'tests/functional/api') diff --git a/tests/functional/api/register.spec.ts b/tests/functional/api/register.spec.ts new file mode 100644 index 0000000..e69de29 diff --git a/tests/functional/api/static/announcements.spec.ts b/tests/functional/api/static/announcements.spec.ts new file mode 100644 index 0000000..ac933fe --- /dev/null +++ b/tests/functional/api/static/announcements.spec.ts @@ -0,0 +1,55 @@ +import { test } from '@japa/runner'; +import { apiVersion } from '../../../config'; + +test.group('API / Static / News', () => { + test('returns a 404 response when the requested versions does not exist', async ({ + client, + }) => { + const response = await client.get(`/${apiVersion}/announcements/illegal`); + + response.assertStatus(404); + response.assertTextIncludes('No announcement found.'); + }); + + test('returns a 200 response with default version file when specifying version as input', async ({ + client, + }) => { + const response = await client.get(`/${apiVersion}/announcements/version`); + + response.assertStatus(200); + response.assertBody({ + main: { + headline: 'Example Announcement', + subHeadline: 'Configure your announcement here', + image: { + light: 'https://api.ferdium.org/assets/feature/light.png', + dark: 'https://api.ferdium.org/assets/feature/dark.png', + }, + text: 'Long description here', + cta: { + label: 'Click here to do something', + href: '/settings/app', + analytics: { + category: 'announcements-main', + action: 'event', + label: 'This does not get used', + }, + }, + }, + spotlight: { + title: 'Spotlight:', + subject: 'Show another feature', + text: 'Show another feature in the spotlight', + cta: { + label: 'Click here to do something', + href: '/settings/team', + analytics: { + category: 'announcements-spotlight', + action: 'event', + label: 'This does not get used', + }, + }, + }, + }); + }); +}); diff --git a/tests/functional/api/static/features.spec.ts b/tests/functional/api/static/features.spec.ts new file mode 100644 index 0000000..1050fcf --- /dev/null +++ b/tests/functional/api/static/features.spec.ts @@ -0,0 +1,29 @@ +import { test } from '@japa/runner'; +import { apiVersion } from '../../../config'; + +const defaultResponse = { + isServiceProxyEnabled: true, + isWorkspaceEnabled: true, + isAnnouncementsEnabled: true, + isSettingsWSEnabled: false, + isMagicBarEnabled: true, + isTodosEnabled: true, +}; + +test.group('API / Static / Features', () => { + test('returns a 200 response with empty array', async ({ client }) => { + const response = await client.get(`/${apiVersion}/features`); + + response.assertStatus(200); + response.assertBody(defaultResponse); + }); + + test('returns a 200 response with expected object when calling with :mode', async ({ + client, + }) => { + const response = await client.get(`/${apiVersion}/features/random`); + + response.assertStatus(200); + response.assertBody(defaultResponse); + }); +}); diff --git a/tests/functional/api/static/news.spec.ts b/tests/functional/api/static/news.spec.ts new file mode 100644 index 0000000..8f3818f --- /dev/null +++ b/tests/functional/api/static/news.spec.ts @@ -0,0 +1,11 @@ +import { test } from '@japa/runner'; +import { apiVersion } from '../../../config'; + +test.group('API / Static / News', () => { + test('returns a 200 response with empty array', async ({ client }) => { + const response = await client.get(`/${apiVersion}/news`); + + response.assertStatus(200); + response.assertBody([]); + }); +}); diff --git a/tests/functional/api/static/services.spec.ts b/tests/functional/api/static/services.spec.ts new file mode 100644 index 0000000..55eef37 --- /dev/null +++ b/tests/functional/api/static/services.spec.ts @@ -0,0 +1,11 @@ +import { test } from '@japa/runner'; +import { apiVersion } from '../../../config'; + +test.group('API / Static / Services', () => { + test('returns a 200 response with empty array', async ({ client }) => { + const response = await client.get(`/${apiVersion}/services`); + + response.assertStatus(200); + response.assertBody([]); + }); +}); -- cgit v1.2.3-54-g00ecf