Bc-7808 - Adjust eslint config in tldraw-server

.eslintrc.cjs

@@ -1,25 +1,63 @@
 module.exports = {
-  parser: '@typescript-eslint/parser',
-  parserOptions: {
-    project: 'tsconfig.json',
-    tsconfigRootDir: __dirname,
-    sourceType: 'module',
-  },
-  plugins: ['@typescript-eslint/eslint-plugin'],
-  extends: [
-    'plugin:@typescript-eslint/recommended',
-    'plugin:prettier/recommended',
-  ],
-  root: true,
-  env: {
-    node: true,
-    jest: true,
-  },
-  ignorePatterns: ['.eslintrc.cjs'],
-  rules: {
-    '@typescript-eslint/interface-name-prefix': 'off',
-    '@typescript-eslint/explicit-function-return-type': 'off',
-    '@typescript-eslint/explicit-module-boundary-types': 'off',
-    '@typescript-eslint/no-explicit-any': 'off',
-  },
+	parser: '@typescript-eslint/parser',
+	parserOptions: {
+		project: 'tsconfig.json',
+		tsconfigRootDir: __dirname,
+		sourceType: 'module',
+	},
+	plugins: ['@typescript-eslint/eslint-plugin', 'jest'],
+	// https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/stylistic-type-checked.ts
+	extends: ['plugin:@typescript-eslint/stylistic-type-checked', 'plugin:prettier/recommended'],
+	root: true,
+	env: {
+		node: true,
+		jest: true,
+	},
+	ignorePatterns: ['.eslintrc.cjs'],
+	rules: {
+		'newline-before-return': 'error',
+		'require-await': 'error',
+		'no-return-assign': 'error',
+		'max-classes-per-file': 'error',
+		'@typescript-eslint/explicit-member-accessibility': 'error',
+		'@typescript-eslint/explicit-function-return-type': 'error',
+		'@typescript-eslint/explicit-module-boundary-types': 'error',
+		'@typescript-eslint/no-explicit-any': 'error',
+		'@typescript-eslint/unbound-method': 'error',
+		'@typescript-eslint/no-unused-vars': 'error',
+		'@typescript-eslint/no-non-null-assertion': 'error',
+		'@typescript-eslint/naming-convention': [
+			'error',
+			{
+				selector: 'interface',
+				format: ['PascalCase'],
+				custom: {
+					regex: '^I[A-Z]',
+					match: false,
+				},
+			},
+		],
+		'@typescript-eslint/no-empty-interface': [
+			'error',
+			{
+				allowSingleExtends: true,
+			},
+		],
+	},
+	overrides: [
+		{
+			files: ['**/*spec.ts'],
+			plugins: ['jest'],
+			env: {
+				jest: true,
+			},
+			rules: {
+				// you should turn the original rule off *only* for test files
+				'@typescript-eslint/unbound-method': 'off',
+				'@typescript-eslint/explicit-function-return-type': 'off',
+				'jest/unbound-method': 'error',
+				'jest/prefer-spy-on': 'error',
+			},
+		},
+	],
 };

.github/workflows/test.yml

@@ -0,0 +1,84 @@
+name: Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+env:
+  NODE_VERSION: '20'
+jobs:
+  tests_cov:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        shard: [1]
+    services:
+      rabbitmq:
+        image: rabbitmq:3
+        ports:
+          - 5672:5672
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+      - name: npm ci
+        run: npm ci --prefer-offline --no-audit
+      - name: test:cov - test all with coverage
+        timeout-minutes: 15
+        run: export RUN_WITHOUT_JEST_COVERAGE='true' && export NODE_OPTIONS='--max_old_space_size=4096' && ./node_modules/.bin/jest --shard=${{ matrix.shard }}/${{ strategy.job-total }} --coverage --force-exit
+      - name: save-coverage
+        run: mv coverage/lcov.info coverage/${{matrix.shard}}.info
+      - name: "upload-artifacts"
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-artifacts-${{ matrix.shard }}
+          path: coverage/
+  sonarcloud:
+      name: SonarCloud coverage
+      runs-on: ubuntu-latest
+      needs: [tests_cov]
+      steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: coverage-artifacts-*
+          path: coverage
+          merge-multiple: true
+      - name: Merge Code Coverage
+        run: |
+          sudo apt-get install -y lcov
+          find coverage -name *.info -exec echo -a {} \; | xargs lcov -o merged-lcov.info
+      - uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+      - name: SonarCloud upload coverage
+        uses: SonarSource/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONARCLOUD_TOKEN }}
+  lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 6
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+      - name: npm ci
+        run: npm ci --prefer-offline --no-audit
+      - name: lint
+        run: npm run lint

nest-cli.json

@@ -9,7 +9,7 @@
 		"server": {
 			"type": "application",
 			"root": ".",
-			"entryFile": "apps/tldraw-server.js",
+			"entryFile": "apps/tldraw-server.app.js",
 			"sourceRoot": "src",
 			"compilerOptions": {
 				"tsConfigPath": "tsconfig.json"
@@ -18,7 +18,7 @@
 		"worker": {
 			"type": "application",
 			"root": ".",
-			"entryFile": "apps/tldraw-worker.js",
+			"entryFile": "apps/tldraw-worker.app.js",
 			"sourceRoot": "src",
 			"compilerOptions": {
 				"tsConfigPath": "tsconfig.json"

package.json

@@ -16,10 +16,10 @@
 		"start": "nest start server",
 		"start:server:dev": "nest start server --watch",
 		"start:server:debug": "nest start server --debug --watch",
-		"start:server:prod": "node dist/apps/tldraw-server.js",
+		"start:server:prod": "node dist/apps/tldraw-server.app.js",
 		"start:worker:dev": "nest start worker --watch",
 		"start:worker:debug": "nest start worker --debug --watch",
-		"start:worker:prod": "node dist/apps/tldraw-worker.js",
+		"start:worker:prod": "node dist/apps/tldraw-worker.app.js",
 		"lint": "eslint \"src/**/*.ts\" ",
 		"lint:fix": "eslint \"src/**/*.ts\" --fix",
 		"test": "jest",
@@ -53,6 +53,7 @@
 		"@typescript-eslint/parser": "^7.0.0",
 		"eslint": "^8.0.0",
 		"eslint-config-prettier": "^9.1.0",
+		"eslint-plugin-jest": "^28.8.3",
 		"eslint-plugin-prettier": "^5.2.1",
 		"jest": "^29.7.0",
 		"prettier": "^3.3.3",

sonar-project.properties

@@ -0,0 +1,10 @@
+sonar.organization=schulcloud-verbund
+sonar.projectKey=hpi-schul-cloud_tldraw-server
+sonar.sources=.
+sonar.tests=.
+sonar.test.inclusions=**/*.spec.ts
+sonar.exclusions=**/*.app.ts,
+sonar.coverage.exclusions=**/*.factory.ts
+sonar.cpd.exclusions=**/controller/dto/*.ts
+sonar.javascript.lcov.reportPaths=merged-lcov.info
+sonar.typescript.tsconfigPaths=tsconfig.json

src/apps/tldraw-server.ts → src/apps/tldraw-server.app.ts

@@ -3,7 +3,7 @@ import { Logger } from '../infra/logging/logger.js';
 import { MetricsModule } from '../infra/metrics/metrics.module.js';
 import { ServerModule } from '../modules/server/server.module.js';
 
-async function bootstrap() {
+async function bootstrap(): Promise<void> {
 	const httpPort = 3347;
 	const nestApp = await NestFactory.create(ServerModule);
 	nestApp.enableCors();

src/apps/tldraw-worker.ts → src/apps/tldraw-worker.app.ts

@@ -1,7 +1,7 @@
 import { NestFactory } from '@nestjs/core';
 import { WorkerModule } from '../modules/worker/worker.module.js';
 
-async function bootstrap() {
+async function bootstrap(): Promise<void> {
 	const nestApp = await NestFactory.createApplicationContext(WorkerModule);
 
 	await nestApp.init();