feat(dropbox): add new folders trigger

feat: Implement async handler for routes

.devcontainer/devcontainer.json

@@ -8,7 +8,7 @@
       "version": "latest"
     },
     "ghcr.io/devcontainers/features/node:1": {
-      "version": 20
+      "version": 18
     },
     "ghcr.io/devcontainers/features/common-utils:1": {
       "username": "vscode",

packages/backend/package.json

@@ -33,19 +33,18 @@
     "axios": "1.6.0",
     "bcrypt": "^5.0.1",
     "bullmq": "^3.0.0",
-    "copyfiles": "^2.4.1",
     "cors": "^2.8.5",
     "crypto-js": "^4.1.1",
     "debug": "~2.6.9",
     "dotenv": "^10.0.0",
     "express": "~4.18.2",
+    "express-async-handler": "^1.2.0",
     "express-basic-auth": "^1.2.1",
     "express-graphql": "^0.12.0",
     "fast-xml-parser": "^4.0.11",
     "graphql-middleware": "^6.1.15",
     "graphql-shield": "^7.5.0",
     "graphql-tools": "^8.2.0",
-    "graphql-type-json": "^0.3.2",
     "handlebars": "^4.7.7",
     "http-errors": "~1.6.3",
     "http-proxy-agent": "^7.0.0",
@@ -68,7 +67,6 @@
     "pluralize": "^8.0.0",
     "raw-body": "^2.5.2",
     "showdown": "^2.1.0",
-    "stripe": "^11.13.0",
     "winston": "^3.7.1",
     "xmlrpc": "^1.3.2"
   },
@@ -97,6 +95,7 @@
     "url": "https://github.com/automatisch/automatisch/issues"
   },
   "devDependencies": {
+    "@typescript-eslint/utils": "^7.0.2",
     "nodemon": "^2.0.13",
     "supertest": "^6.3.3",
     "vitest": "^1.1.3"

packages/backend/src/apps/dropbox/index.js

@@ -2,6 +2,7 @@ import defineApp from '../../helpers/define-app.js';
 import addAuthHeader from './common/add-auth-header.js';
 import auth from './auth/index.js';
 import actions from './actions/index.js';
+import triggers from './triggers/index.js';
 
 export default defineApp({
   name: 'Dropbox',
@@ -15,4 +16,5 @@ export default defineApp({
   beforeRequest: [addAuthHeader],
   auth,
   actions,
+  triggers,
 });

packages/backend/src/apps/dropbox/triggers/index.js

@@ -0,0 +1,3 @@
+import newFolders from './new-folders/index.js';
+
+export default [newFolders];

packages/backend/src/apps/dropbox/triggers/new-folders/index.js

@@ -0,0 +1,61 @@
+import defineTrigger from '../../../../helpers/define-trigger.js';
+
+export default defineTrigger({
+  name: 'New folders',
+  key: 'newFolders',
+  pollInterval: 15,
+  description:
+    'Triggers when any new folder is added. Ensure that the number of files/folders within the monitored directory remains below 4000.',
+  arguments: [
+    {
+      label: 'Folder',
+      key: 'folderPath',
+      type: 'string',
+      required: true,
+      description:
+        'Enter the folder path that you want to follow, like /TextFiles or /Documents/Taxes.',
+      variables: true,
+    },
+  ],
+
+  async run($) {
+    const folderPath = $.step.parameters.folderPath;
+    let endpoint = '/2/files/list_folder';
+    let next = false;
+
+    const params = {
+      path: folderPath,
+      recursive: false,
+      include_deleted: false,
+      include_has_explicit_shared_members: false,
+      include_mounted_folders: true,
+      limit: 2000,
+      include_non_downloadable_files: true,
+    };
+
+    do {
+      const { data } = await $.http.post(endpoint, params);
+
+      if (data.has_more) {
+        endpoint += '/continue';
+        params.cursor = data.cursor;
+        next = data.has_more;
+      } else {
+        next = false;
+      }
+
+      if (data.entries?.length) {
+        for (const entry of data.entries.reverse()) {
+          if (entry['.tag'] === 'folder') {
+            $.pushTriggerItem({
+              raw: entry,
+              meta: {
+                internalId: entry.id,
+              },
+            });
+          }
+        }
+      }
+    } while (next);
+  },
+});

packages/backend/src/controllers/api/v1/admin/app-auth-clients/get-app-auth-client.js

@@ -0,0 +1,10 @@
+import { renderObject } from '../../../../../helpers/renderer.js';
+import AppAuthClient from '../../../../../models/app-auth-client.js';
+
+export default async (request, response) => {
+  const appAuthClient = await AppAuthClient.query()
+    .findById(request.params.appAuthClientId)
+    .throwIfNotFound();
+
+  renderObject(response, appAuthClient);
+};

packages/backend/src/controllers/api/v1/admin/app-auth-clients/get-app-auth-client.test.js

@@ -0,0 +1,35 @@
+import { vi, describe, it, expect, beforeEach } from 'vitest';
+import request from 'supertest';
+import app from '../../../../../app.js';
+import createAuthTokenByUserId from '../../../../../helpers/create-auth-token-by-user-id.js';
+import { createUser } from '../../../../../../test/factories/user.js';
+import getAdminAppAuthClientMock from '../../../../../../test/mocks/rest/api/v1/admin/get-app-auth-client.js';
+import { createAppAuthClient } from '../../../../../../test/factories/app-auth-client.js';
+import { createRole } from '../../../../../../test/factories/role.js';
+import * as license from '../../../../../helpers/license.ee.js';
+
+describe('GET /api/v1/admin/app-auth-clients/:appAuthClientId', () => {
+  let currentUser, currentUserRole, currentAppAuthClient, token;
+
+  describe('with valid license key', () => {
+    beforeEach(async () => {
+      vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
+
+      currentUserRole = await createRole({ key: 'admin' });
+      currentUser = await createUser({ roleId: currentUserRole.id });
+      currentAppAuthClient = await createAppAuthClient();
+
+      token = createAuthTokenByUserId(currentUser.id);
+    });
+
+    it('should return specified app auth client info', async () => {
+      const response = await request(app)
+        .get(`/api/v1/admin/app-auth-clients/${currentAppAuthClient.id}`)
+        .set('Authorization', token)
+        .expect(200);
+
+      const expectedPayload = getAdminAppAuthClientMock(currentAppAuthClient);
+      expect(response.body).toEqual(expectedPayload);
+    });
+  });
+});

packages/backend/src/controllers/api/v1/admin/permissions/get-permissions-catalog.ee.js

@@ -0,0 +1,6 @@
+import { renderObject } from '../../../../../helpers/renderer.js';
+import permissionCatalog from '../../../../../helpers/permission-catalog.ee.js';
+
+export default async (request, response) => {
+  renderObject(response, permissionCatalog);
+};

packages/backend/src/controllers/api/v1/admin/permissions/get-permissions-catalog.ee.test.js

@@ -0,0 +1,32 @@
+import { vi, describe, it, expect, beforeEach } from 'vitest';
+import request from 'supertest';
+import app from '../../../../../app.js';
+import createAuthTokenByUserId from '../../../../../helpers/create-auth-token-by-user-id.js';
+import { createRole } from '../../../../../../test/factories/role.js';
+import { createUser } from '../../../../../../test/factories/user.js';
+import getPermissionsCatalogMock from '../../../../../../test/mocks/rest/api/v1/admin/permissions/get-permissions-catalog.ee.js';
+import * as license from '../../../../../helpers/license.ee.js';
+
+describe('GET /api/v1/admin/permissions/catalog', () => {
+  let role, currentUser, token;
+
+  beforeEach(async () => {
+    role = await createRole({ key: 'admin' });
+    currentUser = await createUser({ roleId: role.id });
+
+    token = createAuthTokenByUserId(currentUser.id);
+  });
+
+  it('should return roles', async () => {
+    vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
+
+    const response = await request(app)
+      .get('/api/v1/admin/permissions/catalog')
+      .set('Authorization', token)
+      .expect(200);
+
+    const expectedPayload = await getPermissionsCatalogMock();
+
+    expect(response.body).toEqual(expectedPayload);
+  });
+});

packages/backend/src/controllers/api/v1/admin/roles/get-role.ee.js

@@ -0,0 +1,16 @@
+import { renderObject } from '../../../../../helpers/renderer.js';
+import Role from '../../../../../models/role.js';
+
+export default async (request, response) => {
+  const role = await Role.query()
+    .leftJoinRelated({
+      permissions: true,
+    })
+    .withGraphFetched({
+      permissions: true,
+    })
+    .findById(request.params.roleId)
+    .throwIfNotFound();
+
+  renderObject(response, role);
+};

packages/backend/src/controllers/api/v1/admin/roles/get-role.ee.test.js

@@ -0,0 +1,38 @@
+import { vi, describe, it, expect, beforeEach } from 'vitest';
+import request from 'supertest';
+import app from '../../../../../app.js';
+import createAuthTokenByUserId from '../../../../../helpers/create-auth-token-by-user-id.js';
+import { createRole } from '../../../../../../test/factories/role.js';
+import { createUser } from '../../../../../../test/factories/user.js';
+import { createPermission } from '../../../../../../test/factories/permission.js';
+import getRoleMock from '../../../../../../test/mocks/rest/api/v1/admin/roles/get-role.ee.js';
+import * as license from '../../../../../helpers/license.ee.js';
+
+describe('GET /api/v1/admin/roles/:roleId', () => {
+  let role, currentUser, token, permissionOne, permissionTwo;
+
+  beforeEach(async () => {
+    role = await createRole({ key: 'admin' });
+    permissionOne = await createPermission({ roleId: role.id });
+    permissionTwo = await createPermission({ roleId: role.id });
+    currentUser = await createUser({ roleId: role.id });
+
+    token = createAuthTokenByUserId(currentUser.id);
+  });
+
+  it('should return roles', async () => {
+    vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
+
+    const response = await request(app)
+      .get(`/api/v1/admin/roles/${role.id}`)
+      .set('Authorization', token)
+      .expect(200);
+
+    const expectedPayload = await getRoleMock(role, [
+      permissionOne,
+      permissionTwo,
+    ]);
+
+    expect(response.body).toEqual(expectedPayload);
+  });
+});

packages/backend/src/controllers/api/v1/admin/roles/get-roles.ee.js

@@ -0,0 +1,8 @@
+import { renderObject } from '../../../../../helpers/renderer.js';
+import Role from '../../../../../models/role.js';
+
+export default async (request, response) => {
+  const roles = await Role.query().orderBy('name');
+
+  renderObject(response, roles);
+};

packages/backend/src/controllers/api/v1/admin/roles/get-roles.ee.test.js

@@ -0,0 +1,33 @@
+import { vi, describe, it, expect, beforeEach } from 'vitest';
+import request from 'supertest';
+import app from '../../../../../app.js';
+import createAuthTokenByUserId from '../../../../../helpers/create-auth-token-by-user-id.js';
+import { createRole } from '../../../../../../test/factories/role.js';
+import { createUser } from '../../../../../../test/factories/user.js';
+import getRolesMock from '../../../../../../test/mocks/rest/api/v1/admin/roles/get-roles.ee.js';
+import * as license from '../../../../../helpers/license.ee.js';
+
+describe('GET /api/v1/admin/roles', () => {
+  let roleOne, roleTwo, currentUser, token;
+
+  beforeEach(async () => {
+    roleOne = await createRole({ key: 'admin' });
+    roleTwo = await createRole({ key: 'user' });
+    currentUser = await createUser({ roleId: roleOne.id });
+
+    token = createAuthTokenByUserId(currentUser.id);
+  });
+
+  it('should return roles', async () => {
+    vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
+
+    const response = await request(app)
+      .get('/api/v1/admin/roles')
+      .set('Authorization', token)
+      .expect(200);
+
+    const expectedPayload = await getRolesMock([roleOne, roleTwo]);
+
+    expect(response.body).toEqual(expectedPayload);
+  });
+});

packages/backend/src/controllers/api/v1/admin/saml-auth-providers/get-saml-auth-provider.ee.js

@@ -0,0 +1,10 @@
+import { renderObject } from '../../../../../helpers/renderer.js';
+import SamlAuthProvider from '../../../../../models/saml-auth-provider.ee.js';
+
+export default async (request, response) => {
+  const samlAuthProvider = await SamlAuthProvider.query()
+    .findById(request.params.samlAuthProviderId)
+    .throwIfNotFound();
+
+  renderObject(response, samlAuthProvider);
+};

packages/backend/src/controllers/api/v1/admin/saml-auth-providers/get-saml-auth-provider.ee.test.js

@@ -0,0 +1,34 @@
+import { vi, describe, it, expect, beforeEach } from 'vitest';
+import request from 'supertest';
+import app from '../../../../../app.js';
+import createAuthTokenByUserId from '../../../../../helpers/create-auth-token-by-user-id.js';
+import { createRole } from '../../../../../../test/factories/role.js';
+import { createUser } from '../../../../../../test/factories/user.js';
+import { createSamlAuthProvider } from '../../../../../../test/factories/saml-auth-provider.ee.js';
+import getSamlAuthProviderMock from '../../../../../../test/mocks/rest/api/v1/admin/saml-auth-providers/get-saml-auth-provider.ee.js';
+import * as license from '../../../../../helpers/license.ee.js';
+
+describe('GET /api/v1/admin/saml-auth-provider/:samlAuthProviderId', () => {
+  let samlAuthProvider, currentUser, token;
+
+  beforeEach(async () => {
+    const role = await createRole({ key: 'admin' });
+    currentUser = await createUser({ roleId: role.id });
+    samlAuthProvider = await createSamlAuthProvider();
+
+    token = createAuthTokenByUserId(currentUser.id);
+  });
+
+  it('should return saml auth provider with specified id', async () => {
+    vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
+
+    const response = await request(app)
+      .get(`/api/v1/admin/saml-auth-providers/${samlAuthProvider.id}`)
+      .set('Authorization', token)
+      .expect(200);
+
+    const expectedPayload = await getSamlAuthProviderMock(samlAuthProvider);
+
+    expect(response.body).toEqual(expectedPayload);
+  });
+});

packages/backend/src/controllers/api/v1/admin/saml-auth-providers/get-saml-auth-providers.ee.js

@@ -0,0 +1,11 @@
+import { renderObject } from '../../../../../helpers/renderer.js';
+import SamlAuthProvider from '../../../../../models/saml-auth-provider.ee.js';
+
+export default async (request, response) => {
+  const samlAuthProviders = await SamlAuthProvider.query().orderBy(
+    'created_at',
+    'desc'
+  );
+
+  renderObject(response, samlAuthProviders);
+};

packages/backend/src/controllers/api/v1/admin/saml-auth-providers/get-saml-auth-providers.ee.test.js

@@ -0,0 +1,39 @@
+import { vi, describe, it, expect, beforeEach } from 'vitest';
+import request from 'supertest';
+import app from '../../../../../app.js';
+import createAuthTokenByUserId from '../../../../../helpers/create-auth-token-by-user-id.js';
+import { createRole } from '../../../../../../test/factories/role.js';
+import { createUser } from '../../../../../../test/factories/user.js';
+import { createSamlAuthProvider } from '../../../../../../test/factories/saml-auth-provider.ee.js';
+import getSamlAuthProvidersMock from '../../../../../../test/mocks/rest/api/v1/admin/saml-auth-providers/get-saml-auth-providers.ee.js';
+import * as license from '../../../../../helpers/license.ee.js';
+
+describe('GET /api/v1/admin/saml-auth-providers', () => {
+  let samlAuthProviderOne, samlAuthProviderTwo, currentUser, token;
+
+  beforeEach(async () => {
+    const role = await createRole({ key: 'admin' });
+    currentUser = await createUser({ roleId: role.id });
+
+    samlAuthProviderOne = await createSamlAuthProvider();
+    samlAuthProviderTwo = await createSamlAuthProvider();
+
+    token = createAuthTokenByUserId(currentUser.id);
+  });
+
+  it('should return saml auth providers', async () => {
+    vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
+
+    const response = await request(app)
+      .get('/api/v1/admin/saml-auth-providers')
+      .set('Authorization', token)
+      .expect(200);
+
+    const expectedPayload = await getSamlAuthProvidersMock([
+      samlAuthProviderTwo,
+      samlAuthProviderOne,
+    ]);
+
+    expect(response.body).toEqual(expectedPayload);
+  });
+});

packages/backend/src/controllers/api/v1/admin/users/get-user.ee.js

@@ -0,0 +1,13 @@
+import { renderObject } from '../../../../../helpers/renderer.js';
+import User from '../../../../../models/user.js';
+
+export default async (request, response) => {
+  const user = await User.query()
+    .withGraphFetched({
+      role: true,
+    })
+    .findById(request.params.userId)
+    .throwIfNotFound();
+
+  renderObject(response, user);
+};

packages/backend/src/controllers/api/v1/admin/users/get-user.ee.test.js

@@ -0,0 +1,34 @@
+import { vi, describe, it, expect, beforeEach } from 'vitest';
+import request from 'supertest';
+import app from '../../../../../app.js';
+import createAuthTokenByUserId from '../../../../../helpers/create-auth-token-by-user-id';
+import { createUser } from '../../../../../../test/factories/user';
+import { createRole } from '../../../../../../test/factories/role';
+import getUserMock from '../../../../../../test/mocks/rest/api/v1/admin/users/get-user.js';
+import * as license from '../../../../../helpers/license.ee.js';
+
+describe('GET /api/v1/admin/users/:userId', () => {
+  let currentUser, currentUserRole, anotherUser, anotherUserRole, token;
+
+  beforeEach(async () => {
+    currentUserRole = await createRole({ key: 'admin' });
+    currentUser = await createUser({ roleId: currentUserRole.id });
+
+    anotherUser = await createUser();
+    anotherUserRole = await anotherUser.$relatedQuery('role');
+
+    token = createAuthTokenByUserId(currentUser.id);
+  });
+
+  it('should return specified user info', async () => {
+    vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
+
+    const response = await request(app)
+      .get(`/api/v1/admin/users/${anotherUser.id}`)
+      .set('Authorization', token)
+      .expect(200);
+
+    const expectedPayload = getUserMock(anotherUser, anotherUserRole);
+    expect(response.body).toEqual(expectedPayload);
+  });
+});

packages/backend/src/controllers/api/v1/admin/users/get-users.ee.js

@@ -0,0 +1,15 @@
+import { renderObject } from '../../../../../helpers/renderer.js';
+import User from '../../../../../models/user.js';
+import paginateRest from '../../../../../helpers/pagination-rest.js';
+
+export default async (request, response) => {
+  const usersQuery = User.query()
+    .withGraphFetched({
+      role: true,
+    })
+    .orderBy('full_name', 'asc');
+
+  const users = await paginateRest(usersQuery, request.query.page);
+
+  renderObject(response, users);
+};

packages/backend/src/controllers/api/v1/admin/users/get-users.ee.test.js

@@ -0,0 +1,49 @@
+import { vi, describe, it, expect, beforeEach } from 'vitest';
+import request from 'supertest';
+import app from '../../../../../app';
+import createAuthTokenByUserId from '../../../../../helpers/create-auth-token-by-user-id';
+import { createRole } from '../../../../../../test/factories/role';
+import { createUser } from '../../../../../../test/factories/user';
+import getUsersMock from '../../../../../../test/mocks/rest/api/v1/admin/users/get-users.js';
+import * as license from '../../../../../helpers/license.ee.js';
+
+describe('GET /api/v1/admin/users', () => {
+  let currentUser, currentUserRole, anotherUser, anotherUserRole, token;
+
+  beforeEach(async () => {
+    currentUserRole = await createRole({ key: 'admin' });
+
+    currentUser = await createUser({
+      roleId: currentUserRole.id,
+      fullName: 'Current User',
+    });
+
+    anotherUserRole = await createRole({
+      key: 'anotherUser',
+      name: 'Another user role',
+    });
+
+    anotherUser = await createUser({
+      roleId: anotherUserRole.id,
+      fullName: 'Another User',
+    });
+
+    token = createAuthTokenByUserId(currentUser.id);
+  });
+
+  it('should return users data', async () => {
+    vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
+
+    const response = await request(app)
+      .get('/api/v1/admin/users')
+      .set('Authorization', token)
+      .expect(200);
+
+    const expectedResponsePayload = await getUsersMock(
+      [anotherUser, currentUser],
+      [anotherUserRole, currentUserRole]
+    );
+
+    expect(response.body).toEqual(expectedResponsePayload);
+  });
+});

packages/backend/src/controllers/api/v1/app-auth-clients/get-app-auth-client.js

@@ -0,0 +1,11 @@
+import { renderObject } from '../../../../helpers/renderer.js';
+import AppAuthClient from '../../../../models/app-auth-client.js';
+
+export default async (request, response) => {
+  const appAuthClient = await AppAuthClient.query()
+    .findById(request.params.appAuthClientId)
+    .where({ active: true })
+    .throwIfNotFound();
+
+  renderObject(response, appAuthClient);
+};

packages/backend/src/controllers/api/v1/app-auth-clients/get-app-auth-client.test.js

@@ -0,0 +1,31 @@
+import { vi, describe, it, expect, beforeEach } from 'vitest';
+import request from 'supertest';
+import app from '../../../../app.js';
+import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id.js';
+import { createUser } from '../../../../../test/factories/user.js';
+import getAppAuthClientMock from '../../../../../test/mocks/rest/api/v1/admin/get-app-auth-client.js';
+import { createAppAuthClient } from '../../../../../test/factories/app-auth-client.js';
+import * as license from '../../../../helpers/license.ee.js';
+
+describe('GET /api/v1/app-auth-clients/:id', () => {
+  let currentUser, currentAppAuthClient, token;
+
+  beforeEach(async () => {
+    vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
+
+    currentUser = await createUser();
+    currentAppAuthClient = await createAppAuthClient();
+
+    token = createAuthTokenByUserId(currentUser.id);
+  });
+
+  it('should return specified app auth client info', async () => {
+    const response = await request(app)
+      .get(`/api/v1/app-auth-clients/${currentAppAuthClient.id}`)
+      .set('Authorization', token)
+      .expect(200);
+
+    const expectedPayload = getAppAuthClientMock(currentAppAuthClient);
+    expect(response.body).toEqual(expectedPayload);
+  });
+});

packages/backend/src/controllers/api/v1/automatisch/info.js

@@ -0,0 +1,13 @@
+import appConfig from '../../../../config/app.js';
+import { hasValidLicense } from '../../../../helpers/license.ee.js';
+import { renderObject } from '../../../../helpers/renderer.js';
+
+export default async (request, response) => {
+  const info = {
+    isCloud: appConfig.isCloud,
+    isMation: appConfig.isMation,
+    isEnterprise: await hasValidLicense(),
+  };
+
+  renderObject(response, info);
+};

packages/backend/src/controllers/api/v1/automatisch/info.test.js

@@ -0,0 +1,22 @@
+import { vi, expect, describe, it } from 'vitest';
+import request from 'supertest';
+import appConfig from '../../../../config/app.js';
+import app from '../../../../app.js';
+import infoMock from '../../../../../test/mocks/rest/api/v1/automatisch/info.js';
+import * as license from '../../../../helpers/license.ee.js';
+
+describe('GET /api/v1/automatisch/info', () => {
+  it('should return Automatisch info', async () => {
+    vi.spyOn(appConfig, 'isCloud', 'get').mockReturnValue(false);
+    vi.spyOn(appConfig, 'isMation', 'get').mockReturnValue(false);
+    vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
+
+    const response = await request(app)
+      .get('/api/v1/automatisch/info')
+      .expect(200);
+
+    const expectedPayload = infoMock();
+
+    expect(response.body).toEqual(expectedPayload);
+  });
+});

packages/backend/src/controllers/api/v1/automatisch/license.js

@@ -0,0 +1,15 @@
+import { getLicense } from '../../../../helpers/license.ee.js';
+import { renderObject } from '../../../../helpers/renderer.js';
+
+export default async (request, response) => {
+  const license = await getLicense();
+
+  const computedLicense = {
+    id: license ? license.id : null,
+    name: license ? license.name : null,
+    expireAt: license ? license.expireAt : null,
+    verified: license ? true : false,
+  };
+
+  renderObject(response, computedLicense);
+};

packages/backend/src/controllers/api/v1/automatisch/license.test.js

@@ -0,0 +1,23 @@
+import { vi, expect, describe, it } from 'vitest';
+import request from 'supertest';
+import app from '../../../../app.js';
+import licenseMock from '../../../../../test/mocks/rest/api/v1/automatisch/license.js';
+import * as license from '../../../../helpers/license.ee.js';
+
+describe('GET /api/v1/automatisch/license', () => {
+  it('should return Automatisch license info', async () => {
+    vi.spyOn(license, 'getLicense').mockResolvedValue({
+      id: '123',
+      name: 'license-name',
+      expireAt: '2025-12-31T23:59:59Z',
+    });
+
+    const response = await request(app)
+      .get('/api/v1/automatisch/license')
+      .expect(200);
+
+    const expectedPayload = licenseMock();
+
+    expect(response.body).toEqual(expectedPayload);
+  });
+});

packages/backend/src/controllers/api/v1/automatisch/notifications.js

@@ -0,0 +1,19 @@
+import { renderObject } from '../../../../helpers/renderer.js';
+import axios from '../../../../helpers/axios-with-proxy.js';
+import logger from '../../../../helpers/logger.js';
+
+const NOTIFICATIONS_URL =
+  'https://notifications.automatisch.io/notifications.json';
+
+export default async (request, response) => {
+  let notifications = [];
+
+  try {
+    const response = await axios.get(NOTIFICATIONS_URL);
+    notifications = response.data;
+  } catch (error) {
+    logger.error('Error fetching notifications API endpoint!', error);
+  }
+
+  renderObject(response, notifications);
+};

packages/backend/src/controllers/api/v1/automatisch/notifications.test.js

@@ -0,0 +1,9 @@
+import { describe, it } from 'vitest';
+import request from 'supertest';
+import app from '../../../../app.js';
+
+describe('GET /api/v1/automatisch/notifications', () => {
+  it('should return Automatisch notifications', async () => {
+    await request(app).get('/api/v1/automatisch/notifications').expect(200);
+  });
+});

packages/backend/src/controllers/api/v1/automatisch/version.js

@@ -0,0 +1,6 @@
+import appConfig from '../../../../config/app.js';
+import { renderObject } from '../../../../helpers/renderer.js';
+
+export default async (request, response) => {
+  renderObject(response, { version: appConfig.version });
+};

packages/backend/src/controllers/api/v1/automatisch/version.test.js

@@ -0,0 +1,26 @@
+import { describe, it, expect } from 'vitest';
+import request from 'supertest';
+import app from '../../../../app.js';
+
+describe('GET /api/v1/automatisch/version', () => {
+  it('should return Automatisch version', async () => {
+    const response = await request(app)
+      .get('/api/v1/automatisch/version')
+      .expect(200);
+
+    const expectedPayload = {
+      data: {
+        version: '0.10.0',
+      },
+      meta: {
+        count: 1,
+        currentPage: null,
+        isArray: false,
+        totalPages: null,
+        type: 'Object',
+      },
+    };
+
+    expect(response.body).toEqual(expectedPayload);
+  });
+});

packages/backend/src/controllers/api/v1/flows/get-flow.js

@@ -0,0 +1,11 @@
+import { renderObject } from '../../../../helpers/renderer.js';
+
+export default async (request, response) => {
+  const flow = await request.currentUser.authorizedFlows
+    .withGraphJoined({ steps: true })
+    .orderBy('steps.position', 'asc')
+    .findOne({ 'flows.id': request.params.flowId })
+    .throwIfNotFound();
+
+  renderObject(response, flow);
+};

packages/backend/src/controllers/api/v1/flows/get-flow.test.js

@@ -0,0 +1,71 @@
+import { describe, it, expect, beforeEach } from 'vitest';
+import request from 'supertest';
+import app from '../../../../app.js';
+import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id';
+import { createUser } from '../../../../../test/factories/user';
+import { createFlow } from '../../../../../test/factories/flow';
+import { createStep } from '../../../../../test/factories/step';
+import { createPermission } from '../../../../../test/factories/permission';
+import getFlowMock from '../../../../../test/mocks/rest/api/v1/flows/get-flow';
+
+describe('GET /api/v1/flows/:flowId', () => {
+  let currentUser, currentUserRole, token;
+
+  beforeEach(async () => {
+    currentUser = await createUser();
+    currentUserRole = await currentUser.$relatedQuery('role');
+
+    token = createAuthTokenByUserId(currentUser.id);
+  });
+
+  it('should return the flow data of current user', async () => {
+    const currentUserflow = await createFlow({ userId: currentUser.id });
+    const triggerStep = await createStep({ flowId: currentUserflow.id });
+    const actionStep = await createStep({ flowId: currentUserflow.id });
+
+    await createPermission({
+      action: 'read',
+      subject: 'Flow',
+      roleId: currentUserRole.id,
+      conditions: ['isCreator'],
+    });
+
+    const response = await request(app)
+      .get(`/api/v1/flows/${currentUserflow.id}`)
+      .set('Authorization', token)
+      .expect(200);
+
+    const expectedPayload = await getFlowMock(currentUserflow, [
+      triggerStep,
+      actionStep,
+    ]);
+
+    expect(response.body).toEqual(expectedPayload);
+  });
+
+  it('should return the flow data of another user', async () => {
+    const anotherUser = await createUser();
+    const anotherUserFlow = await createFlow({ userId: anotherUser.id });
+    const triggerStep = await createStep({ flowId: anotherUserFlow.id });
+    const actionStep = await createStep({ flowId: anotherUserFlow.id });
+
+    await createPermission({
+      action: 'read',
+      subject: 'Flow',
+      roleId: currentUserRole.id,
+      conditions: [],
+    });
+
+    const response = await request(app)
+      .get(`/api/v1/flows/${anotherUserFlow.id}`)
+      .set('Authorization', token)
+      .expect(200);
+
+    const expectedPayload = await getFlowMock(anotherUserFlow, [
+      triggerStep,
+      actionStep,
+    ]);
+
+    expect(response.body).toEqual(expectedPayload);
+  });
+});

packages/backend/src/controllers/api/v1/payment/get-paddle-info.ee.js

@@ -0,0 +1,8 @@
+import { renderObject } from '../../../../helpers/renderer.js';
+import Billing from '../../../../helpers/billing/index.ee.js';
+
+export default async (request, response) => {
+  const paddleInfo = Billing.paddleInfo;
+
+  renderObject(response, paddleInfo);
+};

packages/backend/src/controllers/api/v1/payment/get-paddle-info.ee.test.js

@@ -0,0 +1,33 @@
+import { vi, describe, it, expect, beforeEach } from 'vitest';
+import request from 'supertest';
+import app from '../../../../app.js';
+import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id.js';
+import { createUser } from '../../../../../test/factories/user.js';
+import getPaddleInfoMock from '../../../../../test/mocks/rest/api/v1/payment/get-paddle-info.js';
+import appConfig from '../../../../config/app.js';
+import billing from '../../../../helpers/billing/index.ee.js';
+
+describe('GET /api/v1/payment/paddle-info', () => {
+  let user, token;
+
+  beforeEach(async () => {
+    user = await createUser();
+    token = createAuthTokenByUserId(user.id);
+
+    vi.spyOn(appConfig, 'isCloud', 'get').mockReturnValue(true);
+    vi.spyOn(billing.paddleInfo, 'vendorId', 'get').mockReturnValue(
+      'sampleVendorId'
+    );
+  });
+
+  it('should return payment plans', async () => {
+    const response = await request(app)
+      .get('/api/v1/payment/paddle-info')
+      .set('Authorization', token)
+      .expect(200);
+
+    const expectedResponsePayload = await getPaddleInfoMock();
+
+    expect(response.body).toEqual(expectedResponsePayload);
+  });
+});

packages/backend/src/controllers/api/v1/payment/get-plans.ee.js

@@ -0,0 +1,8 @@
+import { renderObject } from '../../../../helpers/renderer.js';
+import Billing from '../../../../helpers/billing/index.ee.js';
+
+export default async (request, response) => {
+  const paymentPlans = Billing.paddlePlans;
+
+  renderObject(response, paymentPlans);
+};

packages/backend/src/controllers/api/v1/payment/get-plans.ee.test.js

@@ -0,0 +1,29 @@
+import { vi, describe, it, expect, beforeEach } from 'vitest';
+import request from 'supertest';
+import app from '../../../../app.js';
+import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id.js';
+import { createUser } from '../../../../../test/factories/user.js';
+import getPaymentPlansMock from '../../../../../test/mocks/rest/api/v1/payment/get-plans.js';
+import appConfig from '../../../../config/app.js';
+
+describe('GET /api/v1/payment/plans', () => {
+  let user, token;
+
+  beforeEach(async () => {
+    user = await createUser();
+    token = createAuthTokenByUserId(user.id);
+
+    vi.spyOn(appConfig, 'isCloud', 'get').mockReturnValue(true);
+  });
+
+  it('should return payment plans', async () => {
+    const response = await request(app)
+      .get('/api/v1/payment/plans')
+      .set('Authorization', token)
+      .expect(200);
+
+    const expectedResponsePayload = await getPaymentPlansMock();
+
+    expect(response.body).toEqual(expectedResponsePayload);
+  });
+});

packages/backend/src/controllers/api/v1/users/get-current-user.js

@@ -0,0 +1,5 @@
+import { renderObject } from '../../../../helpers/renderer.js';
+
+export default async (request, response) => {
+  renderObject(response, request.currentUser);
+};

packages/backend/src/controllers/api/v1/users/get-current-user.test.js

@@ -0,0 +1,26 @@
+import { describe, it, expect, beforeEach } from 'vitest';
+import request from 'supertest';
+import app from '../../../../app.js';
+import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id';
+import { createUser } from '../../../../../test/factories/user';
+import getCurrentUserMock from '../../../../../test/mocks/rest/api/v1/users/get-current-user';
+
+describe('GET /api/v1/users/me', () => {
+  let role, currentUser, token;
+
+  beforeEach(async () => {
+    currentUser = await createUser();
+    role = await currentUser.$relatedQuery('role');
+    token = createAuthTokenByUserId(currentUser.id);
+  });
+
+  it('should return current user info', async () => {
+    const response = await request(app)
+      .get('/api/v1/users/me')
+      .set('Authorization', token)
+      .expect(200);
+
+    const expectedPayload = getCurrentUserMock(currentUser, role);
+    expect(response.body).toEqual(expectedPayload);
+  });
+});

packages/backend/src/controllers/api/v1/users/get-invoices.ee.js

@@ -0,0 +1,7 @@
+import { renderObject } from '../../../../helpers/renderer.js';
+
+export default async (request, response) => {
+  const invoices = await request.currentUser.getInvoices();
+
+  renderObject(response, invoices);
+};

packages/backend/src/controllers/api/v1/users/get-invoices.ee.test.js

@@ -0,0 +1,34 @@
+import { describe, it, expect, beforeEach, vi } from 'vitest';
+import request from 'supertest';
+import app from '../../../../app.js';
+import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id';
+import { createUser } from '../../../../../test/factories/user';
+import User from '../../../../models/user';
+import getInvoicesMock from '../../../../../test/mocks/rest/api/v1/users/get-invoices.ee';
+
+describe('GET /api/v1/user/invoices', () => {
+  let currentUser, token;
+
+  beforeEach(async () => {
+    currentUser = await createUser();
+    token = createAuthTokenByUserId(currentUser.id);
+  });
+
+  it('should return current user invoices', async () => {
+    const invoices = [
+      { id: 1, amount: 100, description: 'Invoice 1' },
+      { id: 2, amount: 200, description: 'Invoice 2' },
+    ];
+
+    vi.spyOn(User.prototype, 'getInvoices').mockResolvedValue(invoices);
+
+    const response = await request(app)
+      .get('/api/v1/users/invoices')
+      .set('Authorization', token)
+      .expect(200);
+
+    const expectedPayload = await getInvoicesMock(invoices);
+
+    expect(response.body).toEqual(expectedPayload);
+  });
+});

packages/backend/src/controllers/api/v1/users/get-user-trial.ee.js

@@ -0,0 +1,12 @@
+import { renderObject } from '../../../../helpers/renderer.js';
+
+export default async (request, response) => {
+  const inTrial = await request.currentUser.inTrial();
+
+  const trialInfo = {
+    inTrial,
+    expireAt: request.currentUser.trialExpiryDate,
+  };
+
+  renderObject(response, trialInfo);
+};

packages/backend/src/controllers/api/v1/users/get-user-trial.ee.test.js

@@ -0,0 +1,38 @@
+import { vi, describe, it, expect, beforeEach } from 'vitest';
+import request from 'supertest';
+import app from '../../../../app.js';
+import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id.js';
+import { createUser } from '../../../../../test/factories/user.js';
+import getUserTrialMock from '../../../../../test/mocks/rest/api/v1/users/get-user-trial.js';
+import appConfig from '../../../../config/app.js';
+import { DateTime } from 'luxon';
+import User from '../../../../models/user.js';
+
+describe('GET /api/v1/users/:userId/trial', () => {
+  let user, token;
+
+  beforeEach(async () => {
+    const trialExpiryDate = DateTime.now().plus({ days: 30 }).toISODate();
+    user = await createUser({ trialExpiryDate });
+    token = createAuthTokenByUserId(user.id);
+
+    vi.spyOn(appConfig, 'isCloud', 'get').mockReturnValue(true);
+  });
+
+  describe('should return in trial, active subscription and expire at info', () => {
+    beforeEach(async () => {
+      vi.spyOn(User.prototype, 'inTrial').mockResolvedValue(false);
+      vi.spyOn(User.prototype, 'hasActiveSubscription').mockResolvedValue(true);
+    });
+
+    it('should return null', async () => {
+      const response = await request(app)
+        .get(`/api/v1/users/${user.id}/trial`)
+        .set('Authorization', token)
+        .expect(200);
+
+      const expectedResponsePayload = await getUserTrialMock(user);
+      expect(response.body).toEqual(expectedResponsePayload);
+    });
+  });
+});

packages/backend/src/controllers/healthcheck/index.js

@@ -0,0 +1,3 @@
+export default async (request, response) => {
+  response.status(200).end();
+};

packages/backend/src/controllers/healthcheck/index.test.js

@@ -0,0 +1,9 @@
+import { describe, it } from 'vitest';
+import request from 'supertest';
+import app from '../../app.js';
+
+describe('GET /healthcheck', () => {
+  it('should return 200 response with version data', async () => {
+    await request(app).get('/healthcheck').expect(200);
+  });
+});

packages/backend/src/graphql/mutations/delete-step.js

@@ -1,8 +1,13 @@
-const deleteStep = async (_parent, params, context) => {
-  context.currentUser.can('update', 'Flow');
+import Step from '../../models/flow.js';
 
-  const step = await context.currentUser
-    .$relatedQuery('steps')
+const deleteStep = async (_parent, params, context) => {
+  const conditions = context.currentUser.can('update', 'Flow');
+  const isCreator = conditions.isCreator;
+  const allSteps = Step.query();
+  const userSteps = context.currentUser.$relatedQuery('steps');
+  const baseQuery = isCreator ? userSteps : allSteps;
+
+  const step = await baseQuery
     .withGraphFetched('flow')
     .findOne({
       'steps.id': params.input.id,

packages/backend/src/helpers/authentication.js

@@ -20,7 +20,8 @@ export const isAuthenticated = async (_parent, _args, req) => {
       .withGraphFetched({
         role: true,
         permissions: true,
-      });
+      })
+      .throwIfNotFound();
 
     return true;
   } catch (error) {
@@ -28,6 +29,14 @@ export const isAuthenticated = async (_parent, _args, req) => {
   }
 };
 
+export const authenticateUser = async (request, response, next) => {
+  if (await isAuthenticated(null, null, request)) {
+    next();
+  } else {
+    return response.status(401).end();
+  }
+};
+
 const isAuthenticatedRule = rule()(isAuthenticated);
 
 export const authenticationRules = {

packages/backend/src/helpers/authentication.test.js

@@ -1,11 +1,8 @@
-import { describe, it, expect, vi } from 'vitest';
+import { describe, it, expect } from 'vitest';
 import { allow } from 'graphql-shield';
-import jwt from 'jsonwebtoken';
-import User from '../models/user.js';
 import { isAuthenticated, authenticationRules } from './authentication.js';
-
-vi.mock('jsonwebtoken');
-vi.mock('../models/user.js');
+import { createUser } from '../../test/factories/user.js';
+import createAuthTokenByUserId from '../helpers/create-auth-token-by-user-id.js';
 
 describe('isAuthenticated', () => {
   it('should return false if no token is provided', async () => {
@@ -14,29 +11,26 @@ describe('isAuthenticated', () => {
   });
 
   it('should return false if token is invalid', async () => {
-    jwt.verify.mockImplementation(() => {
-      throw new Error('invalid token');
-    });
-
     const req = { headers: { authorization: 'invalidToken' } };
     expect(await isAuthenticated(null, null, req)).toBe(false);
   });
 
-  it('should return true if token is valid', async () => {
-    jwt.verify.mockReturnValue({ userId: '123' });
+  it('should return true if token is valid and there is a user', async () => {
+    const user = await createUser();
+    const token = createAuthTokenByUserId(user.id);
 
-    User.query.mockReturnValue({
-      findById: vi.fn().mockReturnValue({
-        leftJoinRelated: vi.fn().mockReturnThis(),
-        withGraphFetched: vi
-          .fn()
-          .mockResolvedValue({ id: '123', role: {}, permissions: {} }),
-      }),
-    });
-
-    const req = { headers: { authorization: 'validToken' } };
+    const req = { headers: { authorization: token } };
     expect(await isAuthenticated(null, null, req)).toBe(true);
   });
+
+  it('should return false if token is valid and but there is no user', async () => {
+    const user = await createUser();
+    const token = createAuthTokenByUserId(user.id);
+    await user.$query().delete();
+
+    const req = { headers: { authorization: token } };
+    expect(await isAuthenticated(null, null, req)).toBe(false);
+  });
 });
 
 describe('authentication rules', () => {

packages/backend/src/helpers/authorization.js

@@ -0,0 +1,37 @@
+const authorizationList = {
+  'GET /api/v1/users/:userId': {
+    action: 'read',
+    subject: 'User',
+  },
+  'GET /api/v1/users/': {
+    action: 'read',
+    subject: 'User',
+  },
+  'GET /api/v1/flows/:flowId': {
+    action: 'read',
+    subject: 'Flow',
+  },
+};
+
+export const authorizeUser = async (request, response, next) => {
+  const currentRoute =
+    request.method + ' ' + request.baseUrl + request.route.path;
+  const currentRouteRule = authorizationList[currentRoute];
+
+  try {
+    request.currentUser.can(currentRouteRule.action, currentRouteRule.subject);
+    next();
+  } catch (error) {
+    return response.status(403).end();
+  }
+};
+
+export const authorizeAdmin = async (request, response, next) => {
+  const role = await request.currentUser.$relatedQuery('role');
+
+  if (role?.isAdmin) {
+    next();
+  } else {
+    return response.status(403).end();
+  }
+};

packages/backend/src/helpers/check-is-cloud.js

@@ -0,0 +1,11 @@
+import appConfig from '../config/app.js';
+
+export const checkIsCloud = async (request, response, next) => {
+  if (appConfig.isCloud) {
+    next();
+  } else {
+    return response.status(404).end();
+  }
+};
+
+export default checkIsCloud;

packages/backend/src/helpers/check-is-enterprise.js

@@ -0,0 +1,9 @@
+import { hasValidLicense } from './license.ee.js';
+
+export const checkIsEnterprise = async (request, response, next) => {
+  if (await hasValidLicense()) {
+    next();
+  } else {
+    return response.status(404).end();
+  }
+};

packages/backend/src/helpers/logger.js

@@ -4,8 +4,8 @@ import appConfig from '../config/app.js';
 const levels = {
   error: 0,
   warn: 1,
-  info: 2,
-  http: 3,
+  http: 2,
+  info: 3,
   debug: 4,
 };
 

packages/backend/src/helpers/pagination-rest.js

@@ -0,0 +1,25 @@
+const paginateRest = async (query, page) => {
+  const pageSize = 10;
+
+  page = parseInt(page, 10);
+
+  if (isNaN(page) || page < 1) {
+    page = 1;
+  }
+
+  const [records, count] = await Promise.all([
+    query.limit(pageSize).offset((page - 1) * pageSize),
+    query.resultSize(),
+  ]);
+
+  return {
+    pageInfo: {
+      currentPage: page,
+      totalPages: Math.ceil(count / pageSize),
+    },
+    totalCount: count,
+    records,
+  };
+};
+
+export default paginateRest;

packages/backend/src/helpers/renderer.js

@@ -0,0 +1,45 @@
+import serializers from '../serializers/index.js';
+
+const isPaginated = (object) =>
+  object?.pageInfo &&
+  object?.totalCount !== undefined &&
+  Array.isArray(object?.records);
+
+const isArray = (object) =>
+  Array.isArray(object) || Array.isArray(object?.records);
+
+const totalCount = (object) =>
+  isPaginated(object) ? object.totalCount : isArray(object) ? object.length : 1;
+
+const renderObject = (response, object) => {
+  let data = isPaginated(object) ? object.records : object;
+
+  const type = isPaginated(object)
+    ? object.records[0].constructor.name
+    : Array.isArray(object)
+    ? object?.[0]?.constructor?.name || 'Object'
+    : object.constructor.name;
+
+  const serializer = serializers[type];
+
+  if (serializer) {
+    data = Array.isArray(data)
+      ? data.map((item) => serializer(item))
+      : serializer(data);
+  }
+
+  const computedPayload = {
+    data,
+    meta: {
+      type,
+      count: totalCount(object),
+      isArray: isArray(object),
+      currentPage: isPaginated(object) ? object.pageInfo.currentPage : null,
+      totalPages: isPaginated(object) ? object.pageInfo.totalPages : null,
+    },
+  };
+
+  return response.json(computedPayload);
+};
+
+export { renderObject };

packages/backend/src/models/user.js

@@ -15,6 +15,7 @@ import Role from './role.js';
 import Step from './step.js';
 import Subscription from './subscription.ee.js';
 import UsageData from './usage-data.ee.js';
+import Billing from '../helpers/billing/index.ee.js';
 
 class User extends Base {
   static tableName = 'users';
@@ -143,6 +144,11 @@ class User extends Base {
     },
   });
 
+  get authorizedFlows() {
+    const conditions = this.can('read', 'Flow');
+    return conditions.isCreator ? this.$relatedQuery('flows') : Flow.query();
+  }
+
   login(password) {
     return bcrypt.compare(password, this.password);
   }
@@ -237,6 +243,20 @@ class User extends Base {
     return currentUsageData.consumedTaskCount < plan.quota;
   }
 
+  async getInvoices() {
+    const subscription = await this.$relatedQuery('currentSubscription');
+
+    if (!subscription) {
+      return [];
+    }
+
+    const invoices = await Billing.paddleClient.getInvoices(
+      Number(subscription.paddleSubscriptionId)
+    );
+
+    return invoices;
+  }
+
   async $beforeInsert(queryContext) {
     await super.$beforeInsert(queryContext);
 

packages/backend/src/queues/action.js

@@ -15,11 +15,17 @@ process.on('SIGTERM', async () => {
   await actionQueue.close();
 });
 
-actionQueue.on('error', (err) => {
-  if (err.code === CONNECTION_REFUSED) {
-    logger.error('Make sure you have installed Redis and it is running.', err);
+actionQueue.on('error', (error) => {
+  if (error.code === CONNECTION_REFUSED) {
+    logger.error(
+      'Make sure you have installed Redis and it is running.',
+      error
+    );
+
     process.exit();
   }
+
+  logger.error('Error happened in action queue!', error);
 });
 
 export default actionQueue;

packages/backend/src/queues/delete-user.ee.js

@@ -15,11 +15,17 @@ process.on('SIGTERM', async () => {
   await deleteUserQueue.close();
 });
 
-deleteUserQueue.on('error', (err) => {
-  if (err.code === CONNECTION_REFUSED) {
-    logger.error('Make sure you have installed Redis and it is running.', err);
+deleteUserQueue.on('error', (error) => {
+  if (error.code === CONNECTION_REFUSED) {
+    logger.error(
+      'Make sure you have installed Redis and it is running.',
+      error
+    );
+
     process.exit();
   }
+
+  logger.error('Error happened in delete user queue!', error);
 });
 
 export default deleteUserQueue;

packages/backend/src/queues/email.js

@@ -15,11 +15,17 @@ process.on('SIGTERM', async () => {
   await emailQueue.close();
 });
 
-emailQueue.on('error', (err) => {
-  if (err.code === CONNECTION_REFUSED) {
-    logger.error('Make sure you have installed Redis and it is running.', err);
+emailQueue.on('error', (error) => {
+  if (error.code === CONNECTION_REFUSED) {
+    logger.error(
+      'Make sure you have installed Redis and it is running.',
+      error
+    );
+
     process.exit();
   }
+
+  logger.error('Error happened in email queue!', error);
 });
 
 export default emailQueue;

packages/backend/src/queues/flow.js

@@ -15,11 +15,17 @@ process.on('SIGTERM', async () => {
   await flowQueue.close();
 });
 
-flowQueue.on('error', (err) => {
-  if (err.code === CONNECTION_REFUSED) {
-    logger.error('Make sure you have installed Redis and it is running.', err);
+flowQueue.on('error', (error) => {
+  if (error.code === CONNECTION_REFUSED) {
+    logger.error(
+      'Make sure you have installed Redis and it is running.',
+      error
+    );
+
     process.exit();
   }
+
+  logger.error('Error happened in flow queue!', error);
 });
 
 export default flowQueue;

packages/backend/src/queues/remove-cancelled-subscriptions.ee.js

@@ -18,11 +18,20 @@ process.on('SIGTERM', async () => {
   await removeCancelledSubscriptionsQueue.close();
 });
 
-removeCancelledSubscriptionsQueue.on('error', (err) => {
-  if (err.code === CONNECTION_REFUSED) {
-    logger.error('Make sure you have installed Redis and it is running.', err);
+removeCancelledSubscriptionsQueue.on('error', (error) => {
+  if (error.code === CONNECTION_REFUSED) {
+    logger.error(
+      'Make sure you have installed Redis and it is running.',
+      error
+    );
+
     process.exit();
   }
+
+  logger.error(
+    'Error happened in remove cancelled subscriptions queue!',
+    error
+  );
 });
 
 removeCancelledSubscriptionsQueue.add('remove-cancelled-subscriptions', null, {

packages/backend/src/queues/trigger.js

@@ -15,11 +15,17 @@ process.on('SIGTERM', async () => {
   await triggerQueue.close();
 });
 
-triggerQueue.on('error', (err) => {
-  if (err.code === CONNECTION_REFUSED) {
-    logger.error('Make sure you have installed Redis and it is running.', err);
+triggerQueue.on('error', (error) => {
+  if (error.code === CONNECTION_REFUSED) {
+    logger.error(
+      'Make sure you have installed Redis and it is running.',
+      error
+    );
+
     process.exit();
   }
+
+  logger.error('Error happened in trigger queue!', error);
 });
 
 export default triggerQueue;

packages/backend/src/routes/api/v1/admin/app-auth-clients.js

@@ -0,0 +1,18 @@
+import { Router } from 'express';
+import asyncHandler from 'express-async-handler';
+import { authenticateUser } from '../../../../helpers/authentication.js';
+import { authorizeAdmin } from '../../../../helpers/authorization.js';
+import { checkIsEnterprise } from '../../../../helpers/check-is-enterprise.js';
+import getAdminAppAuthClientsAction from '../../../../controllers/api/v1/admin/app-auth-clients/get-app-auth-client.js';
+
+const router = Router();
+
+router.get(
+  '/:appAuthClientId',
+  authenticateUser,
+  authorizeAdmin,
+  checkIsEnterprise,
+  asyncHandler(getAdminAppAuthClientsAction)
+);
+
+export default router;

packages/backend/src/routes/api/v1/admin/permissions.ee.js

@@ -0,0 +1,18 @@
+import { Router } from 'express';
+import asyncHandler from 'express-async-handler';
+import { authenticateUser } from '../../../../helpers/authentication.js';
+import { authorizeAdmin } from '../../../../helpers/authorization.js';
+import { checkIsEnterprise } from '../../../../helpers/check-is-enterprise.js';
+import getPermissionsCatalogAction from '../../../../controllers/api/v1/admin/permissions/get-permissions-catalog.ee.js';
+
+const router = Router();
+
+router.get(
+  '/catalog',
+  authenticateUser,
+  authorizeAdmin,
+  checkIsEnterprise,
+  asyncHandler(getPermissionsCatalogAction)
+);
+
+export default router;

packages/backend/src/routes/api/v1/admin/roles.ee.js

@@ -0,0 +1,27 @@
+import { Router } from 'express';
+import asyncHandler from 'express-async-handler';
+import { authenticateUser } from '../../../../helpers/authentication.js';
+import { authorizeAdmin } from '../../../../helpers/authorization.js';
+import { checkIsEnterprise } from '../../../../helpers/check-is-enterprise.js';
+import getRolesAction from '../../../../controllers/api/v1/admin/roles/get-roles.ee.js';
+import getRoleAction from '../../../../controllers/api/v1/admin/roles/get-role.ee.js';
+
+const router = Router();
+
+router.get(
+  '/',
+  authenticateUser,
+  authorizeAdmin,
+  checkIsEnterprise,
+  asyncHandler(getRolesAction)
+);
+
+router.get(
+  '/:roleId',
+  authenticateUser,
+  authorizeAdmin,
+  checkIsEnterprise,
+  asyncHandler(getRoleAction)
+);
+
+export default router;

packages/backend/src/routes/api/v1/admin/saml-auth-providers.ee.js

@@ -0,0 +1,27 @@
+import { Router } from 'express';
+import asyncHandler from 'express-async-handler';
+import { authenticateUser } from '../../../../helpers/authentication.js';
+import { authorizeAdmin } from '../../../../helpers/authorization.js';
+import { checkIsEnterprise } from '../../../../helpers/check-is-enterprise.js';
+import getSamlAuthProvidersAction from '../../../../controllers/api/v1/admin/saml-auth-providers/get-saml-auth-providers.ee.js';
+import getSamlAuthProviderAction from '../../../../controllers/api/v1/admin/saml-auth-providers/get-saml-auth-provider.ee.js';
+
+const router = Router();
+
+router.get(
+  '/',
+  authenticateUser,
+  authorizeAdmin,
+  checkIsEnterprise,
+  asyncHandler(getSamlAuthProvidersAction)
+);
+
+router.get(
+  '/:samlAuthProviderId',
+  authenticateUser,
+  authorizeAdmin,
+  checkIsEnterprise,
+  asyncHandler(getSamlAuthProviderAction)
+);
+
+export default router;

packages/backend/src/routes/api/v1/admin/users.ee.js

@@ -0,0 +1,27 @@
+import { Router } from 'express';
+import asyncHandler from 'express-async-handler';
+import { authenticateUser } from '../../../../helpers/authentication.js';
+import { authorizeAdmin } from '../../../../helpers/authorization.js';
+import { checkIsEnterprise } from '../../../../helpers/check-is-enterprise.js';
+import getUsersAction from '../../../../controllers/api/v1/admin/users/get-users.ee.js';
+import getUserAction from '../../../../controllers/api/v1/admin/users/get-user.ee.js';
+
+const router = Router();
+
+router.get(
+  '/',
+  authenticateUser,
+  authorizeAdmin,
+  checkIsEnterprise,
+  asyncHandler(getUsersAction)
+);
+
+router.get(
+  '/:userId',
+  authenticateUser,
+  authorizeAdmin,
+  checkIsEnterprise,
+  asyncHandler(getUserAction)
+);
+
+export default router;

packages/backend/src/routes/api/v1/app-auth-clients.js

@@ -0,0 +1,16 @@
+import { Router } from 'express';
+import asyncHandler from 'express-async-handler';
+import { authenticateUser } from '../../../helpers/authentication.js';
+import { checkIsEnterprise } from '../../../helpers/check-is-enterprise.js';
+import getAppAuthClientAction from '../../../controllers/api/v1/app-auth-clients/get-app-auth-client.js';
+
+const router = Router();
+
+router.get(
+  '/:appAuthClientId',
+  authenticateUser,
+  checkIsEnterprise,
+  asyncHandler(getAppAuthClientAction)
+);
+
+export default router;

packages/backend/src/routes/api/v1/automatisch.js

@@ -0,0 +1,15 @@
+import { Router } from 'express';
+import asyncHandler from 'express-async-handler';
+import versionAction from '../../../controllers/api/v1/automatisch/version.js';
+import notificationsAction from '../../../controllers/api/v1/automatisch/notifications.js';
+import infoAction from '../../../controllers/api/v1/automatisch/info.js';
+import licenseAction from '../../../controllers/api/v1/automatisch/license.js';
+
+const router = Router();
+
+router.get('/version', asyncHandler(versionAction));
+router.get('/notifications', asyncHandler(notificationsAction));
+router.get('/info', asyncHandler(infoAction));
+router.get('/license', asyncHandler(licenseAction));
+
+export default router;

packages/backend/src/routes/api/v1/flows.js

@@ -0,0 +1,16 @@
+import { Router } from 'express';
+import asyncHandler from 'express-async-handler';
+import { authenticateUser } from '../../../helpers/authentication.js';
+import { authorizeUser } from '../../../helpers/authorization.js';
+import getFlowAction from '../../../controllers/api/v1/flows/get-flow.js';
+
+const router = Router();
+
+router.get(
+  '/:flowId',
+  authenticateUser,
+  authorizeUser,
+  asyncHandler(getFlowAction)
+);
+
+export default router;

packages/backend/src/routes/api/v1/payment.ee.js

@@ -0,0 +1,24 @@
+import { Router } from 'express';
+import asyncHandler from 'express-async-handler';
+import { authenticateUser } from '../../../helpers/authentication.js';
+import checkIsCloud from '../../../helpers/check-is-cloud.js';
+import getPlansAction from '../../../controllers/api/v1/payment/get-plans.ee.js';
+import getPaddleInfoAction from '../../../controllers/api/v1/payment/get-paddle-info.ee.js';
+
+const router = Router();
+
+router.get(
+  '/plans',
+  authenticateUser,
+  checkIsCloud,
+  asyncHandler(getPlansAction)
+);
+
+router.get(
+  '/paddle-info',
+  authenticateUser,
+  checkIsCloud,
+  asyncHandler(getPaddleInfoAction)
+);
+
+export default router;

packages/backend/src/routes/api/v1/users.js

@@ -0,0 +1,26 @@
+import { Router } from 'express';
+import asyncHandler from 'express-async-handler';
+import { authenticateUser } from '../../../helpers/authentication.js';
+import checkIsCloud from '../../../helpers/check-is-cloud.js';
+import getCurrentUserAction from '../../../controllers/api/v1/users/get-current-user.js';
+import getUserTrialAction from '../../../controllers/api/v1/users/get-user-trial.ee.js';
+import getInvoicesAction from '../../../controllers/api/v1/users/get-invoices.ee.js';
+
+const router = Router();
+
+router.get('/me', authenticateUser, asyncHandler(getCurrentUserAction));
+router.get(
+  '/invoices',
+  authenticateUser,
+  checkIsCloud,
+  asyncHandler(getInvoicesAction)
+);
+
+router.get(
+  '/:userId/trial',
+  authenticateUser,
+  checkIsCloud,
+  asyncHandler(getUserTrialAction)
+);
+
+export default router;

packages/backend/src/routes/healthcheck.js

@@ -0,0 +1,9 @@
+import { Router } from 'express';
+import asyncHandler from 'express-async-handler';
+import indexAction from '../controllers/healthcheck/index.js';
+
+const router = Router();
+
+router.get('/', asyncHandler(indexAction));
+
+export default router;

packages/backend/src/routes/index.js

@@ -2,11 +2,33 @@ import { Router } from 'express';
 import graphQLInstance from '../helpers/graphql-instance.js';
 import webhooksRouter from './webhooks.js';
 import paddleRouter from './paddle.ee.js';
+import healthcheckRouter from './healthcheck.js';
+import automatischRouter from './api/v1/automatisch.js';
+import usersRouter from './api/v1/users.js';
+import paymentRouter from './api/v1/payment.ee.js';
+import appAuthClientsRouter from './api/v1/app-auth-clients.js';
+import flowsRouter from './api/v1/flows.js';
+import samlAuthProvidersRouter from './api/v1/admin/saml-auth-providers.ee.js';
+import rolesRouter from './api/v1/admin/roles.ee.js';
+import permissionsRouter from './api/v1/admin/permissions.ee.js';
+import adminUsersRouter from './api/v1/admin/users.ee.js';
+import adminAppAuthClientsRouter from './api/v1/admin/app-auth-clients.js';
 
 const router = Router();
 
 router.use('/graphql', graphQLInstance);
 router.use('/webhooks', webhooksRouter);
 router.use('/paddle', paddleRouter);
+router.use('/healthcheck', healthcheckRouter);
+router.use('/api/v1/automatisch', automatischRouter);
+router.use('/api/v1/users', usersRouter);
+router.use('/api/v1/payment', paymentRouter);
+router.use('/api/v1/app-auth-clients', appAuthClientsRouter);
+router.use('/api/v1/flows', flowsRouter);
+router.use('/api/v1/admin/saml-auth-providers', samlAuthProvidersRouter);
+router.use('/api/v1/admin/roles', rolesRouter);
+router.use('/api/v1/admin/permissions', permissionsRouter);
+router.use('/api/v1/admin/users', adminUsersRouter);
+router.use('/api/v1/admin/app-auth-clients', adminAppAuthClientsRouter);
 
 export default router;

packages/backend/src/routes/paddle.ee.js

@@ -1,16 +1,9 @@
 import { Router } from 'express';
+import asyncHandler from 'express-async-handler';
 import webhooksHandler from '../controllers/paddle/webhooks.ee.js';
 
 const router = Router();
 
-const exposeError = (handler) => async (req, res, next) => {
-  try {
-    await handler(req, res, next);
-  } catch (err) {
-    next(err);
-  }
-};
-
-router.post('/webhooks', exposeError(webhooksHandler));
+router.post('/webhooks', asyncHandler(webhooksHandler));
 
 export default router;

packages/backend/src/serializers/app-auth-client.js

@@ -0,0 +1,10 @@
+const appAuthClientSerializer = (appAuthClient) => {
+  return {
+    id: appAuthClient.id,
+    appConfigId: appAuthClient.appConfigId,
+    name: appAuthClient.name,
+    active: appAuthClient.active,
+  };
+};
+
+export default appAuthClientSerializer;

packages/backend/src/serializers/app-auth-client.test.js

@@ -0,0 +1,22 @@
+import { describe, it, expect, beforeEach } from 'vitest';
+import { createAppAuthClient } from '../../test/factories/app-auth-client';
+import appAuthClientSerializer from './app-auth-client';
+
+describe('appAuthClient serializer', () => {
+  let appAuthClient;
+
+  beforeEach(async () => {
+    appAuthClient = await createAppAuthClient();
+  });
+
+  it('should return app auth client data', async () => {
+    const expectedPayload = {
+      id: appAuthClient.id,
+      appConfigId: appAuthClient.appConfigId,
+      name: appAuthClient.name,
+      active: appAuthClient.active,
+    };
+
+    expect(appAuthClientSerializer(appAuthClient)).toEqual(expectedPayload);
+  });
+});

packages/backend/src/serializers/flow.js

@@ -0,0 +1,18 @@
+import stepSerializer from './step.js';
+
+const flowSerializer = (flow) => {
+  let flowData = {
+    id: flow.id,
+    name: flow.name,
+    active: flow.active,
+    status: flow.status,
+  };
+
+  if (flow.steps) {
+    flowData.steps = flow.steps.map((step) => stepSerializer(step));
+  }
+
+  return flowData;
+};
+
+export default flowSerializer;

packages/backend/src/serializers/flow.test.js

@@ -0,0 +1,44 @@
+import { describe, it, expect, beforeEach } from 'vitest';
+import { createFlow } from '../../test/factories/flow';
+import flowSerializer from './flow';
+import stepSerializer from './step';
+import { createStep } from '../../test/factories/step';
+
+describe('flowSerializer', () => {
+  let flow, stepOne, stepTwo;
+
+  beforeEach(async () => {
+    flow = await createFlow();
+
+    stepOne = await createStep({
+      flowId: flow.id,
+      type: 'trigger',
+    });
+
+    stepTwo = await createStep({
+      flowId: flow.id,
+      type: 'action',
+    });
+  });
+
+  it('should return flow data', async () => {
+    const expectedPayload = {
+      id: flow.id,
+      name: flow.name,
+      active: flow.active,
+      status: flow.status,
+    };
+
+    expect(flowSerializer(flow)).toEqual(expectedPayload);
+  });
+
+  it('should return flow data with the steps', async () => {
+    flow.steps = [stepOne, stepTwo];
+
+    const expectedPayload = {
+      steps: [stepSerializer(stepOne), stepSerializer(stepTwo)],
+    };
+
+    expect(flowSerializer(flow)).toMatchObject(expectedPayload);
+  });
+});

packages/backend/src/serializers/index.js

@@ -0,0 +1,19 @@
+import userSerializer from './user.js';
+import roleSerializer from './role.js';
+import permissionSerializer from './permission.js';
+import samlAuthProviderSerializer from './saml-auth-provider.ee.js';
+import appAuthClientSerializer from './app-auth-client.js';
+import flowSerializer from './flow.js';
+import stepSerializer from './step.js';
+
+const serializers = {
+  User: userSerializer,
+  Role: roleSerializer,
+  Permission: permissionSerializer,
+  SamlAuthProvider: samlAuthProviderSerializer,
+  AppAuthClient: appAuthClientSerializer,
+  Flow: flowSerializer,
+  Step: stepSerializer,
+};
+
+export default serializers;

packages/backend/src/serializers/permission.js

@@ -0,0 +1,13 @@
+const permissionSerializer = (permission) => {
+  return {
+    id: permission.id,
+    roleId: permission.roleId,
+    action: permission.action,
+    subject: permission.subject,
+    conditions: permission.conditions,
+    createdAt: permission.createdAt,
+    updatedAt: permission.updatedAt,
+  };
+};
+
+export default permissionSerializer;

packages/backend/src/serializers/permission.test.js

@@ -0,0 +1,25 @@
+import { describe, it, expect, beforeEach } from 'vitest';
+import { createPermission } from '../../test/factories/permission';
+import permissionSerializer from './permission';
+
+describe('permissionSerializer', () => {
+  let permission;
+
+  beforeEach(async () => {
+    permission = await createPermission();
+  });
+
+  it('should return permission data', async () => {
+    const expectedPayload = {
+      id: permission.id,
+      roleId: permission.roleId,
+      action: permission.action,
+      subject: permission.subject,
+      conditions: permission.conditions,
+      createdAt: permission.createdAt,
+      updatedAt: permission.updatedAt,
+    };
+
+    expect(permissionSerializer(permission)).toEqual(expectedPayload);
+  });
+});

packages/backend/src/serializers/role.js

@@ -0,0 +1,23 @@
+import permissionSerializer from './permission.js';
+
+const roleSerializer = (role) => {
+  let roleData = {
+    id: role.id,
+    name: role.name,
+    key: role.key,
+    description: role.description,
+    createdAt: role.createdAt,
+    updatedAt: role.updatedAt,
+    isAdmin: role.isAdmin,
+  };
+
+  if (role.permissions) {
+    roleData.permissions = role.permissions.map((permission) =>
+      permissionSerializer(permission)
+    );
+  }
+
+  return roleData;
+};
+
+export default roleSerializer;

packages/backend/src/serializers/role.test.js

@@ -0,0 +1,52 @@
+import { describe, it, expect, beforeEach } from 'vitest';
+import { createRole } from '../../test/factories/role';
+import roleSerializer from './role';
+import permissionSerializer from './permission';
+import { createPermission } from '../../test/factories/permission';
+
+describe('roleSerializer', () => {
+  let role, permissionOne, permissionTwo;
+
+  beforeEach(async () => {
+    role = await createRole();
+
+    permissionOne = await createPermission({
+      roleId: role.id,
+      action: 'read',
+      subject: 'User',
+    });
+
+    permissionTwo = await createPermission({
+      roleId: role.id,
+      action: 'read',
+      subject: 'Role',
+    });
+  });
+
+  it('should return role data', async () => {
+    const expectedPayload = {
+      id: role.id,
+      name: role.name,
+      key: role.key,
+      description: role.description,
+      createdAt: role.createdAt,
+      updatedAt: role.updatedAt,
+      isAdmin: role.isAdmin,
+    };
+
+    expect(roleSerializer(role)).toEqual(expectedPayload);
+  });
+
+  it('should return role data with the permissions', async () => {
+    role.permissions = [permissionOne, permissionTwo];
+
+    const expectedPayload = {
+      permissions: [
+        permissionSerializer(permissionOne),
+        permissionSerializer(permissionTwo),
+      ],
+    };
+
+    expect(roleSerializer(role)).toMatchObject(expectedPayload);
+  });
+});

packages/backend/src/serializers/saml-auth-provider.ee.js

@@ -0,0 +1,18 @@
+const samlAuthProviderSerializer = (samlAuthProvider) => {
+  return {
+    id: samlAuthProvider.id,
+    name: samlAuthProvider.name,
+    certificate: samlAuthProvider.certificate,
+    signatureAlgorithm: samlAuthProvider.signatureAlgorithm,
+    issuer: samlAuthProvider.issuer,
+    entryPoint: samlAuthProvider.entryPoint,
+    firstnameAttributeName: samlAuthProvider.firstnameAttributeName,
+    surnameAttributeName: samlAuthProvider.surnameAttributeName,
+    emailAttributeName: samlAuthProvider.emailAttributeName,
+    roleAttributeName: samlAuthProvider.roleAttributeName,
+    active: samlAuthProvider.active,
+    defaultRoleId: samlAuthProvider.defaultRoleId,
+  };
+};
+
+export default samlAuthProviderSerializer;

packages/backend/src/serializers/saml-auth-provider.ee.test.js

@@ -0,0 +1,32 @@
+import { describe, it, expect, beforeEach } from 'vitest';
+import { createSamlAuthProvider } from '../../test/factories/saml-auth-provider.ee.js';
+import samlAuthProviderSerializer from './saml-auth-provider.ee.js';
+
+describe('samlAuthProviderSerializer', () => {
+  let samlAuthProvider;
+
+  beforeEach(async () => {
+    samlAuthProvider = await createSamlAuthProvider();
+  });
+
+  it('should return saml auth provider data', async () => {
+    const expectedPayload = {
+      id: samlAuthProvider.id,
+      name: samlAuthProvider.name,
+      certificate: samlAuthProvider.certificate,
+      signatureAlgorithm: samlAuthProvider.signatureAlgorithm,
+      issuer: samlAuthProvider.issuer,
+      entryPoint: samlAuthProvider.entryPoint,
+      firstnameAttributeName: samlAuthProvider.firstnameAttributeName,
+      surnameAttributeName: samlAuthProvider.surnameAttributeName,
+      emailAttributeName: samlAuthProvider.emailAttributeName,
+      roleAttributeName: samlAuthProvider.roleAttributeName,
+      active: samlAuthProvider.active,
+      defaultRoleId: samlAuthProvider.defaultRoleId,
+    };
+
+    expect(samlAuthProviderSerializer(samlAuthProvider)).toEqual(
+      expectedPayload
+    );
+  });
+});

packages/backend/src/serializers/step.js

@@ -0,0 +1,15 @@
+const stepSerializer = (step) => {
+  return {
+    id: step.id,
+    type: step.type,
+    key: step.key,
+    appKey: step.appKey,
+    iconUrl: step.iconUrl,
+    webhookUrl: step.webhookUrl,
+    status: step.status,
+    position: step.position,
+    parameters: step.parameters,
+  };
+};
+
+export default stepSerializer;

packages/backend/src/serializers/step.test.js

@@ -0,0 +1,27 @@
+import { describe, it, expect, beforeEach } from 'vitest';
+import { createStep } from '../../test/factories/step';
+import stepSerializer from './step';
+
+describe('stepSerializer', () => {
+  let step;
+
+  beforeEach(async () => {
+    step = await createStep();
+  });
+
+  it('should return step data', async () => {
+    const expectedPayload = {
+      id: step.id,
+      type: step.type,
+      key: step.key,
+      appKey: step.appKey,
+      iconUrl: step.iconUrl,
+      webhookUrl: step.webhookUrl,
+      status: step.status,
+      position: step.position,
+      parameters: step.parameters,
+    };
+
+    expect(stepSerializer(step)).toEqual(expectedPayload);
+  });
+});

packages/backend/src/serializers/user.js

@@ -0,0 +1,31 @@
+import roleSerializer from './role.js';
+import permissionSerializer from './permission.js';
+import appConfig from '../config/app.js';
+
+const userSerializer = (user) => {
+  let userData = {
+    id: user.id,
+    email: user.email,
+    createdAt: user.createdAt,
+    updatedAt: user.updatedAt,
+    fullName: user.fullName,
+  };
+
+  if (user.role) {
+    userData.role = roleSerializer(user.role);
+  }
+
+  if (user.permissions) {
+    userData.permissions = user.permissions.map((permission) =>
+      permissionSerializer(permission)
+    );
+  }
+
+  if (appConfig.isCloud && user.trialExpiryDate) {
+    userData.trialExpiryDate = user.trialExpiryDate;
+  }
+
+  return userData;
+};
+
+export default userSerializer;

packages/backend/src/serializers/user.test.js

@@ -0,0 +1,80 @@
+import { vi, describe, it, expect, beforeEach } from 'vitest';
+import { DateTime } from 'luxon';
+import appConfig from '../config/app';
+import { createUser } from '../../test/factories/user';
+import { createPermission } from '../../test/factories/permission';
+import userSerializer from './user';
+import roleSerializer from './role';
+import permissionSerializer from './permission';
+
+describe('userSerializer', () => {
+  let user, role, permissionOne, permissionTwo;
+
+  beforeEach(async () => {
+    user = await createUser();
+    role = await user.$relatedQuery('role');
+
+    permissionOne = await createPermission({
+      roleId: role.id,
+      action: 'read',
+      subject: 'User',
+    });
+
+    permissionTwo = await createPermission({
+      roleId: role.id,
+      action: 'read',
+      subject: 'Role',
+    });
+  });
+
+  it('should return user data', async () => {
+    vi.spyOn(appConfig, 'isCloud', 'get').mockReturnValue(false);
+
+    const expectedPayload = {
+      createdAt: user.createdAt,
+      email: user.email,
+      fullName: user.fullName,
+      id: user.id,
+      updatedAt: user.updatedAt,
+    };
+
+    expect(userSerializer(user)).toEqual(expectedPayload);
+  });
+
+  it('should return user data with the role', async () => {
+    user.role = role;
+
+    const expectedPayload = {
+      role: roleSerializer(role),
+    };
+
+    expect(userSerializer(user)).toMatchObject(expectedPayload);
+  });
+
+  it('should return user data with the permissions', async () => {
+    user.permissions = [permissionOne, permissionTwo];
+
+    const expectedPayload = {
+      permissions: [
+        permissionSerializer(permissionOne),
+        permissionSerializer(permissionTwo),
+      ],
+    };
+
+    expect(userSerializer(user)).toMatchObject(expectedPayload);
+  });
+
+  it('should return user data with trial expiry date', async () => {
+    vi.spyOn(appConfig, 'isCloud', 'get').mockReturnValue(true);
+
+    await user.$query().patch({
+      trialExpiryDate: DateTime.now().plus({ days: 30 }).toISODate(),
+    });
+
+    const expectedPayload = {
+      trialExpiryDate: user.trialExpiryDate,
+    };
+
+    expect(userSerializer(user)).toMatchObject(expectedPayload);
+  });
+});

packages/backend/test/factories/app-auth-client.js

@@ -0,0 +1,25 @@
+import { faker } from '@faker-js/faker';
+import { createAppConfig } from './app-config.js';
+import AppAuthClient from '../../src/models/app-auth-client';
+
+const formattedAuthDefaults = {
+  oAuthRedirectUrl: faker.internet.url(),
+  instanceUrl: faker.internet.url(),
+  clientId: faker.string.uuid(),
+  clientSecret: faker.string.uuid(),
+};
+
+export const createAppAuthClient = async (params = {}) => {
+  params.name = params?.name || faker.person.fullName();
+  params.id = params?.id || faker.string.uuid();
+  params.appConfigId = params?.appConfigId || (await createAppConfig()).id;
+  params.active = params?.active ?? true;
+  params.formattedAuthDefaults =
+    params?.formattedAuthDefaults || formattedAuthDefaults;
+
+  const appAuthClient = await AppAuthClient.query()
+    .insert(params)
+    .returning('*');
+
+  return appAuthClient;
+};

packages/backend/test/factories/app-config.js

@@ -0,0 +1,13 @@
+import AppConfig from '../../src/models/app-config.js';
+
+export const createAppConfig = async (params = {}) => {
+  const appConfigData = {
+    key: params?.key || 'gitlab',
+  };
+
+  const appConfig = await AppConfig.query()
+    .insert(appConfigData)
+    .returning('*');
+
+  return appConfig;
+};

packages/backend/test/factories/config.js

@@ -1,4 +1,5 @@
 import { faker } from '@faker-js/faker';
+import Config from '../../src/models/config';
 
 export const createConfig = async (params = {}) => {
   const configData = {
@@ -6,10 +7,7 @@ export const createConfig = async (params = {}) => {
     value: params?.value || { data: 'sampleConfig' },
   };
 
-  const [config] = await global.knex
-    .table('config')
-    .insert(configData)
-    .returning('*');
+  const config = await Config.query().insert(configData).returning('*');
 
   return config;
 };

packages/backend/test/factories/connection.js

@@ -1,5 +1,6 @@
 import appConfig from '../../src/config/app';
 import { AES } from 'crypto-js';
+import Connection from '../../src/models/connection';
 
 export const createConnection = async (params = {}) => {
   params.key = params?.key || 'deepl';
@@ -16,10 +17,7 @@ export const createConnection = async (params = {}) => {
     appConfig.encryptionKey
   ).toString();
 
-  const [connection] = await global.knex
-    .table('connections')
-    .insert(params)
-    .returning('*');
+  const connection = await Connection.query().insert(params).returning('*');
 
   return connection;
 };

packages/backend/test/factories/execution-step.js

@@ -1,3 +1,4 @@
+import ExecutionStep from '../../src/models/execution-step';
 import { createExecution } from './execution';
 import { createStep } from './step';
 
@@ -8,8 +9,7 @@ export const createExecutionStep = async (params = {}) => {
   params.dataIn = params?.dataIn || { dataIn: 'dataIn' };
   params.dataOut = params?.dataOut || { dataOut: 'dataOut' };
 
-  const [executionStep] = await global.knex
-    .table('executionSteps')
+  const executionStep = await ExecutionStep.query()
     .insert(params)
     .returning('*');
 

packages/backend/test/factories/execution.js

@@ -1,3 +1,4 @@
+import Execution from '../../src/models/execution';
 import { createFlow } from './flow';
 
 export const createExecution = async (params = {}) => {
@@ -6,10 +7,7 @@ export const createExecution = async (params = {}) => {
   params.createdAt = params?.createdAt || new Date().toISOString();
   params.updatedAt = params?.updatedAt || new Date().toISOString();
 
-  const [execution] = await global.knex
-    .table('executions')
-    .insert(params)
-    .returning('*');
+  const execution = await Execution.query().insert(params).returning('*');
 
   return execution;
 };

packages/backend/test/factories/flow.js

@@ -1,3 +1,4 @@
+import Flow from '../../src/models/flow';
 import { createUser } from './user';
 
 export const createFlow = async (params = {}) => {
@@ -6,7 +7,7 @@ export const createFlow = async (params = {}) => {
   params.createdAt = params?.createdAt || new Date().toISOString();
   params.updatedAt = params?.updatedAt || new Date().toISOString();
 
-  const [flow] = await global.knex.table('flows').insert(params).returning('*');
+  const flow = await Flow.query().insert(params).returning('*');
 
   return flow;
 };

packages/backend/test/factories/permission.js

@@ -1,3 +1,4 @@
+import Permission from '../../src/models/permission';
 import { createRole } from './role';
 
 export const createPermission = async (params = {}) => {
@@ -6,10 +7,7 @@ export const createPermission = async (params = {}) => {
   params.subject = params?.subject || 'User';
   params.conditions = params?.conditions || ['isCreator'];
 
-  const [permission] = await global.knex
-    .table('permissions')
-    .insert(params)
-    .returning('*');
+  const permission = await Permission.query().insert(params).returning('*');
 
   return permission;
 };

packages/backend/test/factories/role.js

@@ -1,8 +1,10 @@
+import Role from '../../src/models/role';
+
 export const createRole = async (params = {}) => {
   params.name = params?.name || 'Viewer';
   params.key = params?.key || 'viewer';
 
-  const [role] = await global.knex.table('roles').insert(params).returning('*');
+  const role = await Role.query().insert(params).returning('*');
 
   return role;
 };

packages/backend/test/factories/saml-auth-provider.ee.js

@@ -0,0 +1,33 @@
+import { createRole } from './role';
+import SamlAuthProvider from '../../src/models/saml-auth-provider.ee.js';
+
+export const createSamlAuthProvider = async (params = {}) => {
+  params.name = params?.name || 'Keycloak SAML';
+  params.certificate = params?.certificate || 'certificate';
+  params.signatureAlgorithm = params?.signatureAlgorithm || 'sha512';
+
+  params.entryPoint =
+    params?.entryPoint ||
+    'https://example.com/auth/realms/automatisch/protocol/saml';
+
+  params.issuer = params?.issuer || 'automatisch-client';
+
+  params.firstnameAttributeName =
+    params?.firstnameAttributeName || 'urn:oid:2.1.1.42';
+
+  params.surnameAttributeName =
+    params?.surnameAttributeName || 'urn:oid:2.1.1.4';
+
+  params.emailAttributeName =
+    params?.emailAttributeName || 'urn:oid:1.1.2342.19200300.100.1.1';
+
+  params.roleAttributeName = params?.roleAttributeName || 'Role';
+  params.defaultRoleId = params?.defaultRoleId || (await createRole()).id;
+  params.active = params?.active || true;
+
+  const samlAuthProvider = await SamlAuthProvider.query()
+    .insert(params)
+    .returning('*');
+
+  return samlAuthProvider;
+};

packages/backend/test/factories/step.js

@@ -1,3 +1,4 @@
+import Step from '../../src/models/step';
 import { createFlow } from './flow';
 
 export const createStep = async (params = {}) => {
@@ -16,7 +17,7 @@ export const createStep = async (params = {}) => {
   params.appKey =
     params?.appKey || (params.type === 'action' ? 'deepl' : 'webhook');
 
-  const [step] = await global.knex.table('steps').insert(params).returning('*');
+  const step = await Step.query().insert(params).returning('*');
 
   return step;
 };