fix(server): prevent delete base currency

feat: setup e2e

.github/workflows/e2e.yml

@@ -0,0 +1,68 @@
+name: E2E
+on:
+  push:
+    branches:
+      - main
+      - develop
+    paths:
+      - '**.ts'
+      - '**.tsx'
+      - '**/tsconfig.json'
+      - 'yarn.lock'
+      - '.github/workflows/e2e.yml'
+  pull_request:
+    paths:
+      - '**.ts'
+      - '**.tsx'
+      - '**/tsconfig.json'
+      - 'yarn.lock'
+      - '.github/workflows/e2e.yml'
+
+defaults:
+  run:
+    shell: 'bash'
+
+jobs:
+  test_setup:
+    name: Test setup
+    runs-on: ubuntu-latest
+    outputs:
+      preview_url: ${{ steps.waitForVercelPreviewDeployment.outputs.url }}
+    steps:
+      - name: Wait for Vercel preview deployment to be ready
+        uses: patrickedqvist/wait-for-vercel-preview@v1.3.1
+        id: waitForVercelPreviewDeployment
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          max_timeout: 3000
+
+  test_e2e:
+    runs-on: ubuntu-latest
+    needs: test_setup
+    name: Playwright tests
+    timeout-minutes: 15
+    environment: ${{ vars.ENVIRONMENT_STAGE }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 14 # Need for npm >=7.7
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Install Playwright with deps
+        run: npx playwright install --with-deps
+
+      - name: Run tests
+        run: npm run test:e2e
+        env:
+          PLAYWRIGHT_TEST_BASE_URL: ${{ needs.test_setup.outputs.preview_url }}
+
+      - uses: actions/upload-artifact@v2
+        if: always()
+        with:
+          name: playwright-report
+          path: test-results/
+          retention-days: 30

.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 data
-.env
+.env
+test-results/

docker-compose.prod.yml

@@ -40,7 +40,7 @@ services:
     environment:
       # Mail
       - MAIL_HOST=${MAIL_HOST}
-      - MAIL_USERNAME=${MAIL_USERNAM}
+      - MAIL_USERNAME=${MAIL_USERNAME}
       - MAIL_PASSWORD=${MAIL_PASSWORD}
       - MAIL_PORT=${MAIL_PORT}
       - MAIL_SECURE=${MAIL_SECURE}

e2e/authentication.spec.ts

@@ -0,0 +1,68 @@
+import { test, expect, Page } from '@playwright/test';
+
+let authPage: Page;
+
+test.describe('authentication', () => {
+  test.beforeAll(async ({ browser }) => {
+    authPage = await browser.newPage();
+  });
+
+  test.describe('login', () => {
+    test.beforeAll(async () => {
+      await authPage.goto('/auth/login');
+    });
+    test('should show the login page.', async () => {
+      await expect(authPage.locator('body')).toContainText(
+        "Don't have an account? Sign up"
+      );
+    });
+    test('should email and password be required.', async () => {
+      await authPage.getByRole('button', { name: 'Log in' }).click();
+
+      await expect(authPage.locator('form')).toContainText(
+        'Email is a required field'
+      );
+      await expect(authPage.locator('form')).toContainText(
+        'Password is a required field'
+      );
+    });
+    test('should go to the register page when click on sign up link', async () => {
+      await authPage.getByRole('link', { name: 'Sign up' }).click();
+      await expect(authPage.url()).toContain('/auth/register');
+    });
+  });
+
+  test.describe('register', () => {
+    test.beforeAll(async () => {
+      await authPage.goto('/auth/register');
+    });
+    test('should first name, last name, email and password be required.', async () => {
+      await authPage.getByRole('button', { name: 'Register' }).click();
+
+      await expect(authPage.locator('form')).toContainText(
+        'First name is a required field'
+      );
+      await expect(authPage.locator('form')).toContainText(
+        'Last name is a required field'
+      );
+      await expect(authPage.locator('form')).toContainText(
+        'Email is a required field'
+      );
+      await expect(authPage.locator('form')).toContainText(
+        'Password is a required field'
+      );
+    });
+  });
+
+  test.describe('reset password', () => {
+    test.beforeAll(async () => {
+      await authPage.goto('/auth/send_reset_password');
+    });
+    test('should email be required.', async () => {
+      await authPage.getByRole('button', { name: 'Reset Password' }).click();
+      await expect(authPage.locator('form')).toContainText(
+        'Email is a required field'
+      );
+    });
+  });
+});

package-lock.json

@@ -941,6 +941,23 @@
         "esquery": "^1.0.1"
       }
     },
+    "@playwright/test": {
+      "version": "1.32.3",
+      "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.32.3.tgz",
+      "integrity": "sha512-BvWNvK0RfBriindxhLVabi8BRe3X0J9EVjKlcmhxjg4giWBD/xleLcg2dz7Tx0agu28rczjNIPQWznwzDwVsZQ==",
+      "requires": {
+        "@types/node": "*",
+        "fsevents": "2.3.2",
+        "playwright-core": "1.32.3"
+      },
+      "dependencies": {
+        "playwright-core": {
+          "version": "1.32.3",
+          "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.32.3.tgz",
+          "integrity": "sha512-SB+cdrnu74ZIn5Ogh/8278ngEh9NEEV0vR4sJFmK04h2iZpybfbqBY0bX6+BLYWVdV12JLLI+JEFtSnYgR+mWg=="
+        }
+      }
+    },
     "@tootallnate/once": {
       "version": "2.0.0",
       "resolved": "https://registry.npmjs.org/@tootallnate/once/-/once-2.0.0.tgz",
@@ -986,8 +1003,7 @@
     "@types/node": {
       "version": "18.14.6",
       "resolved": "https://registry.npmjs.org/@types/node/-/node-18.14.6.tgz",
-      "integrity": "sha512-93+VvleD3mXwlLI/xASjw0FzKcwzl3OdTCzm1LaRfqgS21gfFtK3zDXM5Op9TeeMsJVOaJ2VRDpT9q4Y3d0AvA==",
-      "dev": true
+      "integrity": "sha512-93+VvleD3mXwlLI/xASjw0FzKcwzl3OdTCzm1LaRfqgS21gfFtK3zDXM5Op9TeeMsJVOaJ2VRDpT9q4Y3d0AvA=="
     },
     "@types/normalize-package-data": {
       "version": "2.4.1",
@@ -2304,6 +2320,12 @@
       "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==",
       "dev": true
     },
+    "fsevents": {
+      "version": "2.3.2",
+      "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz",
+      "integrity": "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==",
+      "optional": true
+    },
     "function-bind": {
       "version": "1.1.1",
       "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz",

package.json

@@ -10,6 +10,7 @@
     "dev:server": "lerna run dev --scope \"@bigcapital/server\"",
     "build:server": "lerna run build --scope \"@bigcapital/server\"",
     "serve:server": "lerna run serve --scope \"@bigcapital/server\"",
+    "test:e2e": "playwright test",
     "prepare": "husky install"
   },
   "workspaces": [
@@ -21,7 +22,8 @@
     "@commitlint/config-lerna-scopes": "^17.4.2",
     "husky": "^8.0.3",
     "lerna": "^6.4.1",
-    "@commitlint/cli": "^17.4.2"
+    "@commitlint/cli": "^17.4.2",
+    "@playwright/test": "^1.32.3"
   },
   "engines": {
     "node": "14.x"
@@ -30,6 +32,5 @@
     "hooks": {
       "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
     }
-  },
-  "dependencies": {}
+  }
 }

packages/server/src/services/Currencies/CurrenciesService.ts

@@ -1,18 +1,15 @@
 import { Inject, Service } from 'typedi';
-import { uniq } from 'lodash';
-
 import {
   ICurrencyEditDTO,
   ICurrencyDTO,
   ICurrenciesService,
   ICurrency,
 } from '@/interfaces';
-import {
-  EventDispatcher,
-  EventDispatcherInterface,
-} from 'decorators/eventDispatcher';
 import { ServiceError } from '@/exceptions';
 import TenancyService from '@/services/Tenancy/TenancyService';
+import { Tenant } from '@/system/models';
+import { TransformerInjectable } from '@/lib/Transformer/TransformerInjectable';
+import { CurrencyTransformer } from './CurrencyTransformer';
 
 const ERRORS = {
   CURRENCY_NOT_FOUND: 'currency_not_found',
@@ -23,14 +20,11 @@ const ERRORS = {
 
 @Service()
 export default class CurrenciesService implements ICurrenciesService {
-  @Inject('logger')
-  logger: any;
-
-  @EventDispatcher()
-  eventDispatcher: EventDispatcherInterface;
+  @Inject()
+  private tenancy: TenancyService;
 
   @Inject()
-  tenancy: TenancyService;
+  private transformer: TransformerInjectable;
 
   /**
    * Retrieve currency by given currency code or throw not found error.
@@ -105,7 +99,7 @@ export default class CurrenciesService implements ICurrenciesService {
    */
   public async newCurrency(tenantId: number, currencyDTO: ICurrencyDTO) {
     const { Currency } = this.tenancy.models(tenantId);
-  
+
     // Validate currency code uniquiness.
     await this.validateCurrencyCodeUniquiness(
       tenantId,
@@ -141,13 +135,15 @@ export default class CurrenciesService implements ICurrenciesService {
    * @param {number} tenantId
    * @param {string} currencyCode
    */
-  validateCannotDeleteBaseCurrency(tenantId: number, currencyCode: string) {
-    const settings = this.tenancy.settings(tenantId);
-    const baseCurrency = settings.get({
-      group: 'organization',
-      key: 'base_currency',
-    });
-    if (baseCurrency === currencyCode) {
+  private async validateCannotDeleteBaseCurrency(
+    tenantId: number,
+    currencyCode: string
+  ) {
+    const tenant = await Tenant.query()
+      .findById(tenantId)
+      .withGraphFetched('metadata');
+
+    if (tenant.metadata.baseCurrency === currencyCode) {
       throw new ServiceError(ERRORS.CANNOT_DELETE_BASE_CURRENCY);
     }
   }
@@ -156,7 +152,7 @@ export default class CurrenciesService implements ICurrenciesService {
    * Delete the given currency code.
    * @param {number} tenantId
    * @param {string} currencyCode
-   * @return {Promise<}
+   * @return {Promise<void>}
    */
   public async deleteCurrency(
     tenantId: number,
@@ -180,19 +176,13 @@ export default class CurrenciesService implements ICurrenciesService {
   public async listCurrencies(tenantId: number): Promise<ICurrency[]> {
     const { Currency } = this.tenancy.models(tenantId);
 
-    const settings = this.tenancy.settings(tenantId);
-    const baseCurrency = settings.get({
-      group: 'organization',
-      key: 'base_currency',
-    });
-
     const currencies = await Currency.query().onBuild((query) => {
       query.orderBy('createdAt', 'ASC');
     });
-    const formattedCurrencies = currencies.map((currency) => ({
-      isBaseCurrency: baseCurrency === currency.currencyCode,
-      ...currency,
-    }));
-    return formattedCurrencies;
+    return this.transformer.transform(
+      tenantId,
+      currencies,
+      new CurrencyTransformer()
+    );
   }
 }

packages/server/src/services/Currencies/CurrencyTransformer.ts

@@ -0,0 +1,19 @@
+import { Transformer } from '@/lib/Transformer/Transformer';
+
+export class CurrencyTransformer extends Transformer {
+  /**
+   * Include these attributes to sale invoice object.
+   * @returns {Array}
+   */
+  public includeAttributes = (): string[] => {
+    return ['isBaseCurrency'];
+  };
+
+  /**
+   * Detarmines whether the currency is base currency.
+   * @returns {boolean}
+   */
+  public isBaseCurrency(currency): boolean {
+    return this.context.organization.baseCurrency === currency.currencyCode;
+  }
+}

playwright.config.ts

@@ -0,0 +1,38 @@
+import path from 'path';
+import { PlaywrightTestConfig, devices } from '@playwright/test';
+import dotenv from 'dotenv';
+
+dotenv.config();
+
+// Reference: https://playwright.dev/docs/test-configuration
+const config: PlaywrightTestConfig = {
+  // Timeout per test
+  timeout: 60 * 1000,
+  workers: 1,
+  // Test directory
+  testDir: path.join(__dirname, 'e2e'),
+  // If a test fails, retry it additional 2 times
+  retries: 0,
+  // Artifacts folder where screenshots, videos, and traces are stored.
+  outputDir: 'test-results/',
+  use: {
+    // Retry a test if its failing with enabled tracing. This allows you to analyse the DOM, console logs, network traffic etc.
+    // More information: https://playwright.dev/docs/trace-viewer
+    trace: 'retain-on-failure',
+
+    // All available context options: https://playwright.dev/docs/api/class-browser#browser-new-context
+    // contextOptions: {
+    //   ignoreHTTPSErrors: true,
+    // },
+    baseURL: process.env.PLAYWRIGHT_TEST_BASE_URL || 'http://localhost:4000',
+  },
+  projects: [
+    {
+      name: 'Desktop Chrome',
+      use: {
+        ...devices['Desktop Chrome'],
+      },
+    },
+  ],
+};
+export default config;

vercel.json

@@ -1,5 +1,9 @@
 {
   "installCommand": "npm install && npm run bootstrap",
   "buildCommand": "CI='' npm run build:webapp",
-  "outputDirectory": "packages/webapp/build"
-}
+  "outputDirectory": "packages/webapp/build",
+  "rewrites": [{
+    "source": "/(.*)",
+    "destination": "/"
+  }]
+}