Setup lint and testing suites

.github/workflows/CI.yml

@@ -9,7 +9,7 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      
+
       - name: Setup Bun
         uses: oven-sh/setup-bun@v1
 
@@ -23,4 +23,64 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: Build-artifacts
-          path: dist/
+          path: dist/      
+
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+
+      - name: Install dependencies
+        run: bun install --frozen-lockfile
+
+      - name: Lint
+        run: bun run lint
+
+  unit-tests:
+    if: ${{ github.event_name == 'pull_request' }}
+    name: Unit tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+
+      - name: Install dependencies
+        run: bun install --frozen-lockfile
+
+      - name: Unit tests
+        run: bun run test --no-watch --no-progress --browsers=ChromeHeadless
+
+
+  unit-tests-upload:
+    # This job uses a secret
+    # Pull requests are untrusted
+    if: ${{ github.event_name == 'push' }}
+    name: Unit tests and upload to Codecov
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+
+      - name: Install dependencies
+        run: bun install --frozen-lockfile
+
+      - name: Unit tests
+        run: bun run test --no-watch --no-progress --browsers=ChromeHeadless
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v4.0.1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+

.gitignore

@@ -99,3 +99,7 @@ storage.rules
 /.next/
 /out/
 next-env.d.ts
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

.vscode/settings.json

@@ -10,5 +10,8 @@
     // Disable editor indentation detection
     "editor.insertSpaces": true,
     "editor.tabSize": 2,
-    "editor.detectIndentation": false
+    "editor.detectIndentation": false,
+
+    // ESLint
+    "eslint.useFlatConfig": false
 }

angular.json

@@ -99,15 +99,17 @@
         "test": {
           "builder": "@angular-devkit/build-angular:karma",
           "options": {
-            "main": "src/test.ts",
+            "codeCoverage": true,
             "polyfills": [
               "zone.js",
               "zone.js/testing"
             ],
             "tsConfig": "tsconfig.spec.json",
-            "karmaConfig": "karma.conf.js",
             "styles": [],
             "scripts": [],
+            "exclude": [
+              "src/app/unused/**/*.ts"
+            ],
             "assets": [
               {
                 "glob": "favicon.ico",
@@ -119,7 +121,8 @@
                 "input": "src/assets",
                 "output": "/assets"
               }
-            ]
+            ],
+            "karmaConfig": "karma.conf.js"
           },
           "configurations": {
             "ci": {

eslint.config.js

@@ -0,0 +1,45 @@
+// @ts-check
+const eslint = require('@eslint/js');
+const tseslint = require('typescript-eslint');
+const angular = require('angular-eslint');
+
+module.exports = tseslint.config(
+  {
+    files: ['**/*.ts'],
+    extends: [
+      eslint.configs.recommended,
+      ...tseslint.configs.recommended,
+      ...tseslint.configs.stylistic,
+      ...angular.configs.tsRecommended,
+    ],
+    processor: angular.processInlineTemplates,
+    rules: {
+      '@angular-eslint/directive-selector': [
+        'error',
+        {
+          type: 'attribute',
+          prefix: 'app',
+          style: 'camelCase',
+        },
+      ],
+      '@angular-eslint/component-selector': [
+        'error',
+        {
+          type: 'element',
+          prefix: 'app',
+          style: 'kebab-case',
+        },
+      ],
+      '@angular-eslint/component-class-suffix': 'off',
+      '@typescript-eslint/consistent-indexed-object-style': ['error', 'record'],
+    },
+  },
+  {
+    files: ['**/*.html'],
+    extends: [...angular.configs.templateRecommended, ...angular.configs.templateAccessibility],
+    rules: {},
+  },
+  {
+    ignores: ['functions/*', 'src/app/unused/*'],
+  }
+);

functions/src/certificates/issue-certificate.ts

@@ -11,7 +11,7 @@ exports.issueMajorEventCertificate = onCall(
     const data: MajorEventCertificateData = request.data;
     const context = request;
 
-    if (context.app == undefined) {
+    if (context.app === undefined) {
       throw new HttpsError('failed-precondition', 'The function must be called from an App Check verified app.');
     }
 

functions/src/claims/claims.ts

@@ -8,7 +8,7 @@ import { log } from 'firebase-functions/logger';
 exports.addAdminRole = onCall(async (request): Promise<MainReturnType> => {
   const data = request.data;
   const context = request;
-  if (context.app == undefined) {
+  if (context.app === undefined) {
     throw new HttpsError('failed-precondition', 'The function must be called from an App Check verified app.');
   }
 
@@ -50,7 +50,7 @@ exports.removeAdminRole = onCall(async (request): Promise<MainReturnType> => {
   const context = request;
   const remoteConfig = getRemoteConfig();
 
-  if (context.app == undefined) {
+  if (context.app === undefined) {
     throw new HttpsError('failed-precondition', 'The function must be called from an App Check verified app.');
   }
 
@@ -65,7 +65,7 @@ exports.removeAdminRole = onCall(async (request): Promise<MainReturnType> => {
   // Get whitelist array as string from remote config
   const template = await remoteConfig.getTemplate();
 
-  // @ts-ignore
+  // @ts-expect-error
   const whitelist: string = template.parameters.adminWhitelist.defaultValue?.value;
   // Check if email is included in whitelist array
   if (whitelist.includes(data.email)) {
@@ -110,7 +110,7 @@ exports.addProfessorRole = onCall(async (request): Promise<MainReturnType> => {
   const context = request;
   const db = getFirestore();
 
-  if (context.app == undefined) {
+  if (context.app === undefined) {
     throw new HttpsError('failed-precondition', 'The function must be called from an App Check verified app.');
   }
 
@@ -128,7 +128,7 @@ exports.addProfessorRole = onCall(async (request): Promise<MainReturnType> => {
   return remoteConfig
     .getTemplate()
     .then((template) => {
-      // @ts-ignore
+      // @ts-expect-error
       const professors: string = template.parameters.professors.defaultValue?.value;
 
       // Check if email is included in professors array

functions/src/unused/move-certificates.ts

@@ -7,7 +7,7 @@ exports.moveCertificates = onCall({ timeoutSeconds: 540, memory: '1GiB' }, async
     throw new HttpsError('failed-precondition', 'The function must be called while authenticated.');
   }
 
-  if (context.app == undefined) {
+  if (context.app === undefined) {
     throw new HttpsError('failed-precondition', 'The function must be called from an App Check verified app.');
   }
 

functions/src/utils/user/impersonate.ts

@@ -3,7 +3,7 @@
 // Attribution: amiregelz
 // https://stackoverflow.com/questions/36759627/firebase-login-as-other-user/71808501#71808501
 /*exports.impersonate = functions.https.onCall((data, context) => {
-  if (context.app == undefined) {
+  if (context.app===undefined) {
     throw new functions.https.HttpsError(
       'failed-precondition',
       'The function must be called from an App Check verified app.'
@@ -20,7 +20,7 @@
 
   // Get whitelist array as string from remote config
   return remoteConfig.getTemplate().then((template) => {
-    // @ts-ignore
+    // @ts-expect-error
     const whitelist: string = template.parameters.adminWhitelist.defaultValue?.value;
 
     if (context.auth?.uid) {

functions/src/utils/user/user-utils.ts

@@ -12,7 +12,7 @@ exports.getUserUid = onCall(async (context): Promise<StringDataReturnType> => {
     throw new HttpsError('failed-precondition', 'The function must be called while authenticated.');
   }
 
-  if (context.app == undefined) {
+  if (context.app === undefined) {
     throw new HttpsError('failed-precondition', 'The function must be called from an App Check verified app.');
   }
 

karma.conf.js

@@ -0,0 +1,40 @@
+// Karma configuration file, see link for more information
+// https://karma-runner.github.io/1.0/config/configuration-file.html
+
+module.exports = function (config) {
+  config.set({
+    basePath: '',
+    frameworks: ['jasmine', '@angular-devkit/build-angular'],
+    plugins: [
+      require('karma-jasmine'),
+      require('karma-chrome-launcher'),
+      require('karma-jasmine-html-reporter'),
+      require('karma-coverage'),
+      require('@angular-devkit/build-angular/plugins/karma'),
+    ],
+    preprocessors: {
+      'src/**/*.ts': ['coverage'],
+    },
+
+    client: {
+      jasmine: {
+        // you can add configuration options for Jasmine here
+        // the possible options are listed at https://jasmine.github.io/api/edge/Configuration.html
+        // for example, you can disable the random execution with `random: false`
+        // or set a specific seed with `seed: 4321`
+      },
+      clearContext: false, // leave Jasmine Spec Runner output visible in browser
+    },
+    jasmineHtmlReporter: {
+      suppressAll: true, // removes the duplicated traces
+    },
+    coverageReporter: {
+      dir: require('path').join(__dirname, './coverage/app'),
+      subdir: '.',
+      reporters: [{ type: 'html' }, { type: 'text-summary' }, { type: 'lcovonly' }],
+    },
+    reporters: ['progress', 'kjhtml', 'coverage'],
+    browsers: ['Chrome'],
+    restartOnFileChange: true,
+  });
+};

package.json

@@ -10,28 +10,28 @@
     "build": "ng build",
     "test": "ng test",
     "lint": "ng lint",
-    "e2e": "ng e2e"
+    "e2e": "playwright test"
   },
   "private": true,
   "dependencies": {
-    "@angular/animations": "18.0.0",
-    "@angular/common": "~18.0.0",
-    "@angular/core": "~18.0.0",
+    "@angular/animations": "18.0.1",
+    "@angular/common": "~18.0.1",
+    "@angular/core": "~18.0.1",
     "@angular/fire": "^18.0.1",
-    "@angular/forms": "~18.0.0",
-    "@angular/platform-browser": "~18.0.0",
-    "@angular/platform-browser-dynamic": "~18.0.0",
-    "@angular/router": "~18.0.0",
-    "@angular/service-worker": "^18.0.0",
+    "@angular/forms": "~18.0.1",
+    "@angular/platform-browser": "~18.0.1",
+    "@angular/platform-browser-dynamic": "~18.0.1",
+    "@angular/router": "~18.0.1",
+    "@angular/service-worker": "^18.0.1",
     "@ionic/angular": "^8.2.0",
     "@ngneat/until-destroy": "^10.0.0",
     "@notiz/ngx-plausible": "^0.7.0",
-    "@pdfme/generator": "^4.0.1",
+    "@pdfme/generator": "^4.0.2",
     "@sweetalert2/ngx-sweetalert2": "^12.3.0",
     "buffer": "^6.0.3",
     "bwip-js": "^4.3.2",
     "date-fns": "^3.6.0",
-    "highlight.run": "^8.12.3",
+    "highlight.run": "^8.13.0",
     "ionicons": "^7.4.0",
     "marked": "^12.0.2",
     "ngx-image-compress": "^15.1.6",
@@ -45,33 +45,41 @@
     "zxing-wasm": "^1.2.10"
   },
   "devDependencies": {
-    "@angular-devkit/build-angular": "~18.0.1",
-    "@angular-eslint/builder": "~17.5.1",
-    "@angular-eslint/eslint-plugin": "~17.5.1",
-    "@angular-eslint/eslint-plugin-template": "~17.5.1",
-    "@angular-eslint/template-parser": "~17.5.1",
-    "@angular/cli": "~18.0.1",
-    "@angular/compiler": "~18.0.0",
-    "@angular/compiler-cli": "~18.0.0",
-    "@angular/language-service": "~18.0.0",
+    "@angular-devkit/build-angular": "~18.0.2",
+    "@angular/cli": "~18.0.2",
+    "@angular/compiler": "~18.0.1",
+    "@angular/compiler-cli": "~18.0.1",
+    "@angular/language-service": "~18.0.1",
     "@ionic/angular-toolkit": "^11.0.1",
-    "@pdfme/common": "^4.0.1",
-    "@pdfme/schemas": "^4.0.1",
-    "@typescript-eslint/eslint-plugin": "7.11.0",
-    "@typescript-eslint/parser": "7.11.0",
+    "@pdfme/common": "^4.0.2",
+    "@pdfme/schemas": "^4.0.2",
+    "@playwright/test": "^1.44.1",
     "@types/google-one-tap": "^1.2.6",
+    "@types/jasmine": "^5.1.4",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.13.0",
     "@types/twemoji-parser": "^13.1.4",
+    "@web/test-runner": "^0.18.2",
+    "angular-eslint": "18.0.1",
     "eslint": "^9.3.0",
     "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-jsdoc": "48.2.6",
+    "eslint-plugin-jsdoc": "48.2.7",
     "eslint-plugin-prefer-arrow": "1.2.3",
+    "jasmine": "^5.1.0",
+    "jest-preset-angular": "^14.1.0",
+    "karma": "^6.4.3",
+    "karma-chrome-launcher": "^3.2.0",
+    "karma-coverage": "^2.2.1",
+    "karma-jasmine": "^5.1.0",
+    "karma-jasmine-html-reporter": "^2.1.0",
     "protractor": "~7.0.0",
     "react": "^18.3.1",
     "react-dom": "18.3.1",
     "terser": "5.31.0",
     "ts-node": "~10.9.2",
     "tslib": "^2.6.2",
     "typescript": "5.4.5",
+    "typescript-eslint": "8.0.0-alpha.20",
     "typescript-strict-plugin": "^2.4.3"
   },
   "trustedDependencies": [