Development

.github/workflows/check-sdk-version.yaml

@@ -14,12 +14,13 @@ jobs:
     steps:
       - name: 🏗 Setup repo
         uses: actions/checkout@v4
+
+      - name: Enable Corepack before setting up Node
+        run: corepack enable
 
       - name: 📦 Check it is using the latest version of the SDK
         uses: actions/setup-node@v4
         with:
-          node-version: 18.12.1
-      - run: corepack enable
-      - run: yarn -v
+          node-version: 22.3.0
       - run: yarn install --immutable
       - run: yarn run updateSdkVersion $GITHUB_BASE_REF check

.github/workflows/test.yaml

@@ -1,32 +1,31 @@
 name: Test - Pull Requests
 
 on:
-  pull_request:
-    branches:
-      - development
+  push
 
 jobs:
   tests:
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
+
+      - name: Enable Corepack before setting up Node
+        run: corepack enable
 
       - name: Install dependencies
         uses: actions/setup-node@v4
         with:
-          node-version: 18.12.1
-      - run: corepack enable
-      - run: yarn -v
+          node-version: 22.3.0
       - run: yarn install --immutable
 
       - name: Run lint and test
         uses: actions/setup-node@v4
         with:
-          node-version: 18.12.1
+          node-version: 22.3.0
       - run: yarn run build
       - run: yarn run lint
-      - run: yarn run test
+      - run: yarn run test:unit
       - run: yarn run test:e2e
 
       - name: Build and push
@@ -55,13 +54,14 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+
+      - name: Enable Corepack before setting up Node
+        run: corepack enable
 
       - name: Build and run server
         uses: actions/setup-node@v4
         with:
-          node-version: 18.12.1
-      - run: corepack enable
-      # corepack is needed to run yarn through npm
+          node-version: 22.3.0
       - run: yarn install --immutable
       - run: yarn run build
       - run: yarn run start:prod &
@@ -94,4 +94,4 @@ jobs:
           name: zap-scan-output
           path: "zap-api-scan-report.html"
       # Exit with the exit code of the ZAP scan
-      - run: exit "${{ steps.zap_scan.outputs.EXIT_CODE }}"
+      - run: exit "${{ steps.zap_scan.outputs.EXIT_CODE }}"

.vscode/settings.json

@@ -6,7 +6,7 @@
         "typescriptreact"
     ],
     "editor.codeActionsOnSave": {
-        "source.fixAll.eslint": true,
+        "source.fixAll.eslint": "explicit"
     },
     "jest.autoRun": {
         "onSave": false,
@@ -17,4 +17,10 @@
     "jest.testExplorer": {
         "enabled": true
     },
+    "git.branchPrefix": "feature/",
+    "git.branchProtection": [
+        "master",
+        "main",
+        "development"
+    ],
 }

.yarnrc.yml

@@ -1,3 +1 @@
 nodeLinker: node-modules
-
-yarnPath: .yarn/releases/yarn-3.1.1.cjs

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:18.12.1 AS tonomy_communication_base
+FROM node:22.3.0 AS tonomy_communication_base
 
 WORKDIR /app
 COPY . .

README.md

@@ -4,6 +4,8 @@
 
 [Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
 
+Requires nodejs v20+
+
 ## Installation
 
 ```bash
@@ -13,13 +15,11 @@ yarn install
 ## Running the app
 
 ```bash
-# development
+# development with watch mode
 yarn run start
 
-# watch mode
-yarn run start:dev
-
 # production mode
+yarn run build
 yarn run start:prod
 ```
 
@@ -50,6 +50,10 @@ yarn run test:e2e
 yarn run test:cov
 ```
 
+## Debugging
+
+Uses [debug](https://www.npmjs.com/package/debug) package. Use `export DEBUG="tonomy*"` to see all debug logs.
+
 ## API Documentation
 
 <https://localhost:5000/openapi> (for REST API with Open API)
@@ -59,12 +63,10 @@ yarn run test:cov
 
 Run in a Digital Ocean App which runs the nodejs project: <https://docs.digitalocean.com/products/app-platform/>
 
-Using Ubuntu 22.04 with Nodejs 18.x is enabled:
+Using Ubuntu 22.04 with Nodejs 20+ is enabled:
 
 - <https://docs.digitalocean.com/products/app-platform/reference/buildpacks/nodejs/#ubuntu-2204-stack-supporting-nodejs-18>
 
-Build command: `yarn -v && yarn install && yarn run build`
-
-- NOTE: we need to run `yarn install` again so that we install with `[email protected]` which we force via`.yarnrc.yml` and `.yarn/releases/yarn-3.1.1.cjs`. See <https://github.com/Tonomy-Foundation/Tonomy-Communication/issues/85> for more details.
+Build command: `yarn run build`
 
 Run command: `yarn run start:prod`

add-js-extension.js

@@ -0,0 +1,37 @@
+import fs from 'fs';
+import path from 'path';
+
+const directory = './dist';
+
+console.log('Adding .js extension to local imports...');
+
+function addJsExtension(filePath) {
+    const data = fs.readFileSync(filePath, 'utf8');
+    // Replace all local imports (Regex: from './filename') with .js extension (from './filename.js'
+    const data2 = data.replace(/from '(\.\/[^']+)'/g, "from '$1.js'");
+
+    // Replace all local imports (Regex: from '../filename') with .js extension (from '../filename.js'
+    const result = data2.replace(/from '\.\.\/([^']+)'/g, "from '../$1.js'");
+
+    fs.writeFileSync(filePath, result, 'utf8');
+}
+
+function fromDir(startPath, filter) {
+    if (!fs.existsSync(startPath)) {
+        console.log('Directory not found', startPath);
+        return;
+    }
+
+    const files = fs.readdirSync(startPath);
+
+    for (let i = 0; i < files.length; i++) {
+        const filename = path.join(startPath, files[i]);
+        const stat = fs.lstatSync(filename);
+
+        if (stat.isDirectory()) {
+            fromDir(filename, filter); // Recurse into subdirectories
+        } else if (filter.test(filename)) addJsExtension(filename);
+    }
+}
+
+fromDir(directory, /\.js$/); // Look for .js files

eslint.config.js

@@ -0,0 +1,53 @@
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import prettier from 'eslint-plugin-prettier/recommended';
+import globals from 'globals';
+
+export default [
+    eslint.configs.recommended,
+    ...tseslint.configs.recommended,
+    prettier,
+    {
+        rules: {
+            eqeqeq: 'error',
+            'no-console': 'warn',
+            'prettier/prettier': 'error',
+            '@typescript-eslint/ban-ts-comment': 'warn',
+            '@typescript-eslint/explicit-module-boundary-types': 'off',
+            '@typescript-eslint/explicit-function-return-type': 'off',
+            '@typescript-eslint/no-explicit-any': 'warn',
+            '@typescript-eslint/no-unused-vars': 'warn',
+            'padding-line-between-statements': [
+                'warn',
+                { blankLine: 'always', prev: 'block-like', next: '*' },
+                { blankLine: 'always', prev: 'block', next: '*' },
+                { blankLine: 'always', prev: '*', next: ['block', 'block-like'] },
+                { blankLine: 'always', prev: ['const', 'let', 'var'], next: '*' },
+                {
+                    blankLine: 'any',
+                    prev: ['const', 'let', 'var'],
+                    next: ['const', 'let', 'var'],
+                },
+                { blankLine: 'always', prev: ['export', 'import'], next: '*' },
+                { blankLine: 'any', prev: 'import', next: 'import' },
+                { blankLine: 'any', prev: 'export', next: 'export' },
+            ],
+        },
+        languageOptions: {
+            ecmaVersion: 6,
+            sourceType: 'module',
+            parserOptions: {
+                ecmaFeatures: {
+                    jsx: true,
+                },
+            },
+            globals: {
+                ...globals.node,
+                ...globals.es6,
+                ...globals.jest,
+            },
+        },
+        files: ['**/*.js', '**/*.ts'],
+        ignores: ['dist/**'],
+    },
+];

jest.config.ts

@@ -0,0 +1,41 @@
+import type { Config } from 'jest';
+
+// https://www.jenchan.biz/blog/dissecting-the-hell-jest-setup-esm-typescript-setup
+// https://kulshekhar.github.io/ts-jest/docs/guides/esm-support/
+const baseConfig: Config = {
+    moduleFileExtensions: ['js', 'json', 'ts'],
+    collectCoverageFrom: ['**/*.(t|j)s'],
+    coverageDirectory: '../coverage',
+    testEnvironment: 'node',
+    transform: {
+        '^.+\\.m?tsx?$': [
+            'ts-jest',
+            {
+                useESM: true,
+                tsconfig: './tsconfig.json',
+                diagnostics: process.env.CI ? true : false,
+            },
+        ],
+    },
+    transformIgnorePatterns: [],
+    extensionsToTreatAsEsm: ['.ts'],
+};
+
+const config: Config = {
+    projects: [
+        {
+            ...baseConfig,
+            displayName: 'Unit tests',
+            rootDir: './src',
+            testRegex: '.*\\.spec\\.ts$',
+        },
+        {
+            ...baseConfig,
+            displayName: 'End-to-end tests',
+            rootDir: './test',
+            testRegex: '.e2e-spec.ts$',
+        },
+    ],
+};
+
+export default config;

nodemon.json

@@ -0,0 +1,11 @@
+{
+    "watch": [
+        "src",
+        "test"
+    ],
+    "ext": "ts",
+    "ignore": [
+        "src/**/*.spec.ts"
+    ],
+    "exec": "node start-dev.js"
+}