refactor: monorepo layout (#118)

Rework the repository to be ready to add spark-observer as the second
service.

See CheckerNetwork/spark-api#323

Signed-off-by: Miroslav Bajtoš <[email protected]>

Author: bajtos

.github/dependabot.yml

@@ -2,6 +2,7 @@ version: 2
 updates:
   - package-ecosystem: "npm"
     directory: "/"
+    versioning-strategy: increase
     schedule:
       interval: "daily"
       time: "09:00"

.github/workflows/ci.yml

@@ -6,7 +6,7 @@ on:
     branches: [main]
 
 jobs:
-  build:
+  build-stats:
     runs-on: ubuntu-latest
     services:
       postgres:
@@ -24,6 +24,7 @@ jobs:
           --health-retries 5
     env:
       DATABASE_URL: postgres://postgres:postgres@localhost:5432/postgres
+      NPM_CONFIG_WORKSPACE: stats
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
@@ -33,6 +34,16 @@ jobs:
       - run: npm run migrate
       - run: npm test
 
+  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:
@@ -49,7 +60,7 @@ jobs:
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Build Docker image
+      - name: Build monorepo Docker image
         uses: docker/build-push-action@v5
         with:
           context: .
@@ -58,12 +69,12 @@ jobs:
 
   deploy:
     if: github.ref == 'refs/heads/main'
-    needs: [build,  docker-build]
+    needs: [build-stats,  docker-build]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: superfly/flyctl-actions/setup-flyctl@master
-      - run: flyctl deploy --remote-only
+      - run: flyctl deploy --remote-only -c stats/fly.toml
         env:
           FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}
       - if: failure()

Dockerfile

@@ -12,7 +12,6 @@ WORKDIR /app
 # Set production environment
 ENV NODE_ENV production
 ENV SENTRY_ENVIRONMENT production
-ENV REQUEST_LOGGING false
 
 #######################################################################
 # Throw-away build stage to reduce size of final image
@@ -27,7 +26,12 @@ RUN apt-get update -qq && \
 # 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 stats/package.json ./stats/
+
+RUN npm ci --workspaces
 
 # Copy application code
 COPY --link . .
@@ -39,5 +43,8 @@ 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 the value passed to npm start --workspace parameter
+ENV SERVICE=""
+
+CMD npm start --workspace ${SERVICE}

README.md

@@ -80,7 +80,7 @@ npm test
 ### Run the service
 
 ```sh
-npm start
+npm start --workspace stats
 ```
 
 You can also run the service against live data in Spark DB running on Fly.io.