feat: hot server reload & debugging over docker

.github/workflows/node-build.yml

@@ -265,7 +265,7 @@ jobs:
         with:
           push: false
           platforms: ${{ matrix.platform.arch }}
-          file: packages/${{ matrix.package }}/Dockerfile
+          file: packages/${{ matrix.package }}/Dockerfile.prod
           tags: ghcr.io/${{ github.repository_owner }}/rafiki-${{ matrix.package }}:${{ needs.version-generator.outputs.version }}
           outputs: type=docker,dest=/tmp/${{ github.sha }}-${{ matrix.package }}-${{ matrix.platform.name }}-${{ needs.version-generator.outputs.version }}.tar
       - name: Save docker image to cache

localenv/README.md

@@ -139,6 +139,47 @@ Note that you have to go through an additional "login" step by providing you IPv
 
 After stopping the script it is necessary to clear the environment using the command described in [Shutting down](#Shutting-down). This is necessary as on a new run of the scripts (with autopeering or not) the wallet address url will differ.
 
+### Debugging
+
+Debuggers for the services are exposed on the following ports:
+
+| IP and Port    | Services                |
+| -------------- | ----------------------- |
+| 127.0.0.1:9229 | Cloud Nine Backend      |
+| 127.0.0.1:9230 | Cloud Nine Auth         |
+| 127.0.0.1:9231 | Happy Life Bank Backend |
+| 127.0.0.1:9232 | Happy Life Bank Auth    |
+
+#### With a chromium browser:
+
+- go to `chrome://inspect`
+- Click "Configure" and add the IP addresses and ports detailed above
+- start docker containers
+- click "inspect" on the service you want to debug to open the chromium debugger
+
+You can either trigger the debugger by adding `debugger` statements in code and restarting, or by adding breakpoints directly in the chromium debugger after starting the docker containers.
+
+#### With Vscode:
+
+For debugging with Vscode, you can add this configuration to your `.vscode/launch.json`):
+
+```json
+{
+    "name": "Attach to docker (cloud-nine-backend)",
+    "type": "node",
+    "request": "attach",
+    "port": 9229,
+    "address": "localhost",
+    "localRoot": "${workspaceFolder}",
+    "remoteRoot": "/home/rafiki/",
+    "restart": true
+},
+```
+
+`localRoot` will vary depending on the location of `launch.json` relative to rafiki's root directory.
+
+For more ways to connect debuggers, see the Node docs for debugging: https://nodejs.org/en/learn/getting-started/debugging
+
 ### Shutting down
 
 ```

localenv/cloud-nine-wallet/docker-compose.yml

@@ -32,13 +32,19 @@ services:
     image: rafiki-backend
     build:
       context: ../..
-      dockerfile: ./packages/backend/Dockerfile
+      dockerfile: ./packages/backend/Dockerfile.dev
+    volumes:
+      - type: bind
+        source: ../../packages/backend/src
+        target: /home/rafiki/packages/backend/src
+        read_only: true
     restart: always
     privileged: true
     ports:
       - '3000:80'
       - '3001:3001'
       - '3002:3002'
+      - "9229:9229"
     networks:
       - rafiki
     environment:
@@ -73,13 +79,19 @@ services:
     image: rafiki-auth
     build:
       context: ../..
-      dockerfile: ./packages/auth/Dockerfile
+      dockerfile: ./packages/auth/Dockerfile.dev
+    volumes:
+      - type: bind
+        source: ../../packages/auth/src
+        target: /home/rafiki/packages/auth/src
+        read_only: true
     restart: always
     networks:
       - rafiki
     ports:
       - '3003:3003'
       - '3006:3006'
+      - "9230:9229"
     environment:
       NODE_ENV: ${NODE_ENV:-development}
       TRUST_PROXY: ${TRUST_PROXY}
@@ -112,7 +124,7 @@ services:
     image: rafiki-frontend
     build:
       context: ../..
-      dockerfile: ./packages/frontend/devDockerfile
+      dockerfile: ./packages/frontend/Dockerfile.dev
     volumes:
       - type: bind
         source: ../../packages/frontend/app

localenv/happy-life-bank/docker-compose.yml

@@ -28,11 +28,17 @@ services:
     hostname: happy-life-bank-backend
     image: rafiki-backend
     pull_policy: never
+    volumes:
+      - type: bind
+        source: ../../packages/backend/src
+        target: /home/rafiki/packages/backend/src
+        read_only: true
     restart: always
     privileged: true
     ports:
       - "4000:80"
       - "4001:3001"
+      - '9231:9229'
     networks:
       - rafiki
     environment:
@@ -64,11 +70,17 @@ services:
     image: rafiki-auth
     pull_policy: never
     restart: always
+    volumes:
+      - type: bind
+        source: ../../packages/auth/src
+        target: /home/rafiki/packages/auth/src
+        read_only: true
     networks:
       - rafiki
     ports:
       - '4003:3003'
       - '4006:3006'
+      - '9232:9229'
     environment:
       NODE_ENV: development
       AUTH_DATABASE_URL: postgresql://happy_life_bank_auth:happy_life_bank_auth@shared-database/happy_life_bank_auth

packages/auth/Dockerfile.dev

@@ -0,0 +1,24 @@
+FROM node:20-alpine3.18
+
+WORKDIR /home/rafiki
+
+RUN corepack enable
+RUN corepack prepare [email protected] --activate
+
+COPY pnpm-lock.yaml package.json pnpm-workspace.yaml .npmrc tsconfig.json tsconfig.build.json ./
+
+RUN --mount=type=cache,id=pnpm,target=/pnpm/store \
+    pnpm fetch \
+    | grep -v "cross-device link not permitted\|Falling back to copying packages from store"
+
+COPY . ./
+
+RUN --mount=type=cache,id=pnpm,target=/pnpm/store \
+    pnpm install \
+    --recursive \
+    --offline \
+    --frozen-lockfile
+
+RUN pnpm --filter auth build:deps
+
+CMD pnpm --filter auth dev

packages/auth/package.json

@@ -18,7 +18,8 @@
     "prepack": "pnpm build",
     "postinstall": "pnpm copy-op-schemas",
     "copy-op-schemas": "cp ./node_modules/@interledger/open-payments/dist/openapi/specs/auth-server.yaml ./node_modules/@interledger/open-payments/dist/openapi/specs/schemas.yaml ./src/openapi/specs/",
-    "copy-files": "cp src/graphql/schema.graphql dist/graphql/ && cp -r ./src/openapi ./dist/"
+    "copy-files": "cp src/graphql/schema.graphql dist/graphql/ && cp -r ./src/openapi ./dist/",
+    "dev": "ts-node-dev --inspect=0.0.0.0:9229 --respawn --transpile-only src/index.ts"
   },
   "dependencies": {
     "@adonisjs/fold": "^8.2.0",
@@ -47,6 +48,7 @@
     "pg": "^8.11.3",
     "pino": "^8.19.0",
     "token-introspection": "workspace:*",
+    "ts-node-dev": "^2.0.0",
     "uuid": "^9.0.1"
   },
   "devDependencies": {
@@ -66,6 +68,7 @@
     "jest-openapi": "^0.14.2",
     "nock": "^13.5.4",
     "node-mocks-http": "^1.14.1",
+    "nodemon": "^3.1.0",
     "openapi-types": "^12.1.3",
     "pino-pretty": "^11.0.0",
     "testcontainers": "^10.7.2"

packages/auth/tsconfig.json

@@ -6,5 +6,8 @@
     "rootDir": "./src",
     "declaration": true
   },
-  "include": ["src/**/*"]
+  "include": ["src/**/*"],
+  "ts-node": {
+    "swc": true
+  }
 }

packages/backend/Dockerfile.dev

@@ -0,0 +1,24 @@
+FROM node:20-alpine3.18
+
+WORKDIR /home/rafiki
+
+RUN corepack enable
+RUN corepack prepare [email protected] --activate
+
+COPY pnpm-lock.yaml package.json pnpm-workspace.yaml .npmrc tsconfig.json tsconfig.build.json ./
+
+RUN --mount=type=cache,id=pnpm,target=/pnpm/store \
+    pnpm fetch \
+    | grep -v "cross-device link not permitted\|Falling back to copying packages from store"
+
+COPY . ./
+
+RUN --mount=type=cache,id=pnpm,target=/pnpm/store \
+    pnpm install \
+    --recursive \
+    --offline \
+    --frozen-lockfile
+
+RUN pnpm --filter backend build:deps
+
+CMD pnpm --filter backend dev

packages/backend/package.json

@@ -14,7 +14,8 @@
     "copy-files": "cp src/graphql/schema.graphql dist/graphql/ && cp -r ./src/openapi ./dist/",
     "copy-op-schemas": "cp ./node_modules/@interledger/open-payments/dist/openapi/specs/schemas.yaml ./src/openapi/specs/",
     "prepack": "pnpm build",
-    "postinstall": "pnpm copy-op-schemas"
+    "postinstall": "pnpm copy-op-schemas",
+    "dev": "ts-node-dev --inspect=0.0.0.0:9229 --respawn --transpile-only src/index.ts"
   },
   "devDependencies": {
     "@apollo/client": "^3.9.9",
@@ -38,11 +39,13 @@
     "jest-openapi": "^0.14.2",
     "nock": "^13.5.4",
     "node-mocks-http": "^1.14.1",
+    "nodemon": "^3.1.0",
     "openapi-types": "^12.1.3",
     "react": "~18.2.0",
     "rosie": "^2.1.1",
     "testcontainers": "^10.7.2",
-    "tmp": "^0.2.3"
+    "tmp": "^0.2.3",
+    "ts-node-dev": "^2.0.0"
   },
   "dependencies": {
     "@adonisjs/fold": "^8.2.0",

packages/backend/tsconfig.json

@@ -5,5 +5,8 @@
     "outDir": "./dist",
     "rootDir": "./src"
   },
-  "include": ["src/**/*"]
+  "include": ["src/**/*"],
+  "ts-node": {
+    "swc": true
+  }
 }

packages/documentation/src/content/docs/playground/overview.md

@@ -114,6 +114,47 @@ The secondary Happy Life Bank docker compose file (`./happy-life-bank/docker-com
 data stores created by the primary Rafiki instance so it can't be run by itself.
 The `pnpm localenv:compose up` command starts both the primary instance and the secondary.
 
+### Debugging
+
+Debuggers for the services are exposed on the following ports:
+
+| IP and Port    | Services                |
+| -------------- | ----------------------- |
+| 127.0.0.1:9229 | Cloud Nine Backend      |
+| 127.0.0.1:9230 | Cloud Nine Auth         |
+| 127.0.0.1:9231 | Happy Life Bank Backend |
+| 127.0.0.1:9232 | Happy Life Bank Auth    |
+
+#### With a chromium browser:
+
+- go to `chrome://inspect`
+- Click "Configure" and add the IP addresses and ports detailed above
+- start docker containers
+- click "inspect" on the service you want to debug to open the chromium debugger
+
+You can either trigger the debugger by adding `debugger` statements in code and restarting, or by adding breakpoints directly in the chromium debugger after starting the docker containers.
+
+#### With Vscode:
+
+For debugging with Vscode, you can add this configuration to your `.vscode/launch.json`):
+
+```json
+{
+    "name": "Attach to docker (cloud-nine-backend)",
+    "type": "node",
+    "request": "attach",
+    "port": 9229,
+    "address": "localhost",
+    "localRoot": "${workspaceFolder}",
+    "remoteRoot": "/home/rafiki/",
+    "restart": true
+},
+```
+
+`localRoot` will vary depending on the location of `launch.json` relative to rafiki's root directory.
+
+For more ways to connect debuggers, see the Node docs for debugging: https://nodejs.org/en/learn/getting-started/debugging
+
 ### Shutting down
 
 ```