Use path aliases for the server (#68)

.github/workflows/verify-reusable.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      
+
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
@@ -24,14 +24,14 @@ jobs:
         run: yarn install
         working-directory: ./server
         shell: bash
-      
+
       - name: Cypress run
         uses: cypress-io/github-action@v6
         with:
           install: false
           working-directory: ./client
           build: yarn build
-          start: yarn preview, yarn server:dev
+          start: yarn preview, yarn test:e2e:server
           wait-on: http://localhost:4173, http://localhost:3000
           config: baseUrl=http://localhost:4173
 

client/package.json

@@ -11,7 +11,7 @@
     "preview": "vite preview",
     "cypress:open": "cypress open",
     "test:e2e": "cypress run",
-    "server:dev": "cd ../server && yarn dev"
+    "test:e2e:server": "cd ../server && yarn build && yarn start"
   },
   "dependencies": {
     "@reduxjs/toolkit": "^2.2.1",

server/.prettierignore

@@ -0,0 +1,2 @@
+node_modules
+dist

server/jest.config.js

@@ -32,7 +32,7 @@ const config = {
   // ],
 
   // Indicates which provider should be used to instrument code for coverage
-  coverageProvider: "v8",
+  coverageProvider: 'v8',
 
   // A list of reporter names that Jest uses when writing coverage reports
   // coverageReporters: [
@@ -89,7 +89,10 @@ const config = {
   // ],
 
   // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
-  // moduleNameMapper: {},
+  moduleNameMapper: {
+    '@/(.*)': '<rootDir>/src/$1',
+    '@test/(.*)': '<rootDir>/test/$1',
+  },
 
   // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
   // modulePathIgnorePatterns: [],
@@ -101,7 +104,7 @@ const config = {
   // notifyMode: "failure-change",
 
   // A preset that is used as a base for Jest's configuration
-  preset: "ts-jest",
+  preset: 'ts-jest',
 
   // Run tests from one or more projects
   // projects: undefined,
@@ -193,6 +196,6 @@ const config = {
 
   // Whether to use watchman for file crawling
   // watchman: true,
-};
+}
 
-module.exports = config;
+module.exports = config

server/jest/__tests__/room.service.class.spec.ts

@@ -1,12 +1,15 @@
-// TODO support absolute paths. these are a mess.
-import { INACTIVITY_THRESHOLD, RoomService } from '../../../server/src/services/room.service/room-service.class'
-import { Room } from '../../src/services/room.service/room.class'
+import {
+  INACTIVITY_THRESHOLD,
+  RoomService,
+} from '@/services/room.service/room-service.class'
+import { Room } from '@/services/room.service/room.class'
 
 describe('room-service', () => {
   it('purges rooms past the inactivity threshold', () => {
     const room = new Room('room_id')
     // Forces lastActivityTs to be way past the inactivity threshold
-    jest.spyOn(room, 'lastActivityTs', 'get')
+    jest
+      .spyOn(room, 'lastActivityTs', 'get')
       .mockReturnValue(Date.now() - INACTIVITY_THRESHOLD * 2)
 
     const service = new RoomService()
@@ -15,16 +18,18 @@ describe('room-service', () => {
     service.rooms['dummy2'] = new Room('dummy2')
     service.rooms['dummy3'] = new Room('dummy3')
 
-    expect(service.rooms).toEqual(expect.objectContaining({
-      'room_id': expect.any(Room)
-    }))
+    expect(service.rooms).toEqual(
+      expect.objectContaining({
+        room_id: expect.any(Room),
+      })
+    )
     expect(Object.values(service.rooms)).toHaveLength(4)
 
     service.purgeInactiveRooms()
 
     expect(service.rooms).toEqual(
       expect.not.objectContaining({
-        'room_id': expect.any(Room)
+        room_id: expect.any(Room),
       })
     )
     expect(Object.values(service.rooms)).toHaveLength(3)

server/jest/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "target": "ES2017",
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "module": "CommonJS",
+    "baseUrl": "../",
+    "resolveJsonModule": true,
+    "outDir": "./dist",
+    "removeComments": true,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitReturns": false,
+    "noFallthroughCasesInSwitch": true,
+    "skipLibCheck": true,
+    "paths": {
+      "@/*": ["./src/*"],
+      "@test/*": ["./jest/*"]
+    }
+  },
+  "include": ["./**/*.ts"],
+  "exclude": ["./node_modules"]
+}

server/package.json

@@ -4,11 +4,11 @@
   "private": true,
   "license": "MIT",
   "scripts": {
-    "lint": "eslint src/**/*.ts",
-    "format": "prettier ./**/*.{ts,json} --w",
-    "build": "tsc",
-    "start": "node dist/index.js",
-    "dev": "nodemon src/index.ts",
+    "lint": "eslint ./**/*.ts",
+    "format": "prettier ./**/*.{ts,json,js} --w",
+    "build": "tsc && tsc-alias",
+    "start": "node dist/src/index.js",
+    "dev": "tsx src/index.ts",
     "test": "jest"
   },
   "dependencies": {
@@ -31,10 +31,11 @@
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-prettier": "^5.1.3",
     "jest": "^29.7.0",
-    "nodemon": "^3.1.0",
     "prettier": "^3.2.5",
     "ts-jest": "^29.1.2",
     "ts-node": "^10.9.2",
+    "tsc-alias": "^1.8.8",
+    "tsx": "^4.7.2",
     "typescript": "^5.4.2"
   }
 }

server/src/socket-controllers/pad-history.socket-controller.ts

@@ -1,6 +1,5 @@
 import { Socket } from 'socket.io'
-// TODO make absolute paths work
-import roomService from '../services/room.service'
+import roomService from '@/services/room.service'
 
 function saveEvent(roomId: string, event: unknown) {
   const room = roomService.getRoom(roomId)

server/tsconfig.json

@@ -14,7 +14,10 @@
     "strict": true,
     "noImplicitReturns": false,
     "noFallthroughCasesInSwitch": true,
-    "skipLibCheck": true
+    "skipLibCheck": true,
+    "paths": {
+      "@/*": ["./src/*"]
+    }
   },
   "include": ["./src/**/*.ts", "./*.d.ts"],
   "exclude": ["./node_modules", "./test/**/*.ts"]