Show npm workspace monorepo changes against main

.dockerignore

@@ -3,3 +3,4 @@ Dockerfile
 .dockerignore
 node_modules
 .git
+.env

.github/dependabot.yml

@@ -3,11 +3,11 @@ updates:
   - package-ecosystem: "npm"
     directories:
       - "/"
-      - "/spark-publish"
     schedule:
       interval: "daily"
       time: "09:00"
       timezone: "Europe/Berlin"
+    versioning-strategy: increase
     commit-message:
       prefix: "deps"
       prefix-development: "deps(dev)"

.github/workflows/ci.yml

@@ -3,7 +3,6 @@ on:
   push:
     branches: [main]
   pull_request:
-    branches: [main]
 
 jobs:
   build-api:
@@ -25,6 +24,7 @@ jobs:
     env:
       DATABASE_URL: postgres://postgres:postgres@localhost:5432/postgres
       GLIF_TOKEN: ${{ secrets.GLIF_TOKEN }}
+      NPM_CONFIG_WORKSPACE: spark-api
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
@@ -51,17 +51,27 @@ jobs:
           --health-retries 5
     env:
       DATABASE_URL: postgres://postgres:postgres@localhost:5432/postgres
+      NPM_CONFIG_WORKSPACE: spark-publish
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: 20
       - run: npm ci
-      - run: npm run migrate
-      - run: cd spark-publish && npm ci
-      - run: cd spark-publish && npm test
+      - run: node bin/migrate.js
+      - run: npm test
 
-  docker-build-api:
+  lint-all:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npm ci
+      - run: npm run lint
+
+  docker-build:
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -77,44 +87,30 @@ jobs:
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Build Docker image
+      - name: Build spark-api Docker image
         uses: docker/build-push-action@v5
         with:
           context: .
+          build-args: "SERVICE=api"
           cache-from: type=registry,ref=ghcr.io/filecoin-station/core
           cache-to: type=inline
 
-  docker-build-publish:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: read
-    env:
-      REGISTRY: ghcr.io
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: docker/login-action@v3
-        with:
-          registry: ${{ env.REGISTRY }}
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Build Docker image
+      - name: Build spark-publish Docker image
         uses: docker/build-push-action@v5
         with:
-          context: spark-publish
+          context: .
+          build-args: "SERVICE=publish"
           cache-from: type=registry,ref=ghcr.io/filecoin-station/core
           cache-to: type=inline
 
   deploy-api:
     if: github.ref == 'refs/heads/main'
-    needs: [build-api, build-publish, docker-build-api, docker-build-publish]
+    needs: [build-api, build-publish, docker-build]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: superfly/flyctl-actions/setup-flyctl@master
-      - run: flyctl deploy --remote-only
+      - run: cd spark-api && flyctl deploy --remote-only
         env:
           FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}
       - if: failure()
@@ -138,7 +134,7 @@ jobs:
           SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
   deploy-publish:
     if: github.ref == 'refs/heads/main'
-    needs: [build-api, build-publish, docker-build-api, docker-build-publish]
+    needs: [build-api, build-publish, docker-build]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

Dockerfile

@@ -12,23 +12,27 @@ WORKDIR /app
 # Set production environment
 ENV NODE_ENV production
 ENV SENTRY_ENVIRONMENT production
-ENV DOMAIN api.filspark.com
-ENV REQUEST_LOGGING false
 
 #######################################################################
 # Throw-away build stage to reduce size of final image
 FROM base as build
 
 # Install packages needed to build node modules
 RUN apt-get update -qq && \
-  apt-get install -y build-essential pkg-config python-is-python3
+    apt-get install -y build-essential pkg-config python-is-python3
 
 # Install node modules
 # NPM will not install any package listed in "devDependencies" when NODE_ENV is set to "production",
 # to install all modules: "npm install --production=false".
 # Ref: https://docs.npmjs.com/cli/v9/commands/npm-install#description
 COPY --link package-lock.json package.json ./
-RUN npm ci
+
+# We cannot use a wildcard until `COPY --parents` is stabilised
+# See https://docs.docker.com/reference/dockerfile/#copy---parents
+COPY --link spark-api/package.json ./spark-api/
+COPY --link spark-publish/package.json ./spark-publish/
+
+RUN npm ci --workspaces
 
 # Copy application code
 COPY --link . .
@@ -40,5 +44,12 @@ FROM base
 # Copy built application
 COPY --from=build /app /app
 
-# Start the server by default, this can be overwritten at runtime
-CMD [ "npm", "run", "start" ]
+# Set to `publish` or `api`
+# This argument controls what npm script is executed as the CMD.
+ARG SERVICE
+
+# ARGs are not preserved at runtime, we need to store the value
+# as a default value of an ENV var
+ENV WORKSPACE="spark-${SERVICE}"
+
+CMD npm start --workspace ${WORKSPACE}

README.md

@@ -89,13 +89,14 @@ docker run -d --name spark-db \
 Start the API service:
 
 ```bash
-npm start
+npm start --workspace spark-api
 ```
 
 Run tests and linters:
 
 ```bash
-npm test
+npm test --workspace spark-api
+npm run lint --workspace spark-api
 ```
 
 ## Deployment
@@ -105,5 +106,5 @@ Pushes to `main` will be deployed automatically.
 Perform manual devops using [Fly.io](https://fly.io):
 
 ```bash
-$ fly deploy
+$ fly deploy spark-api
 ```

bin/migrate.js

@@ -1,4 +1,4 @@
-import { migrate } from '../lib/migrate.js'
+import { migrate } from '../migrations/index.js'
 import pg from 'pg'
 
 const { DATABASE_URL } = process.env