Dockerize Airseeker

Author: amarthadan

README.md

@@ -1 +1,51 @@
-# airseeker
+# Airseeker
+
+A tool to update a beacons with signed responses from Airnode's gateway
+
+# Installation
+
+```sh
+yarn install
+```
+
+## Build
+
+```sh
+yarn build
+```
+
+## Usage
+
+```sh
+yarn start
+```
+
+### Running with process mamnager
+
+You can use [PM2](https://pm2.keymetrics.io/) process manager to run Airseeker. PM2 is also used in the
+[Dockerized](#docker) version.
+
+```sh
+# Starting Airseeker
+yarn pm2:start
+# PM2 status
+yarn pm2:status
+# Logs
+yarn pm2:logs
+# Stopping Airseeker
+yarn pm2:stop
+```
+
+## Docker
+
+The container is running the Airseeker with the [PM2](https://pm2.keymetrics.io/) process manager and running a cronjob
+taking care of log rotation with [logrotate](https://linux.die.net/man/8/logrotate). We're using a default
+[generated logrotate configuration from PM2](https://pm2.keymetrics.io/docs/usage/log-management/#setting-up-a-native-logrotate).
+
+### Build
+
+```sh
+yarn docker:build
+```
+
+Resulting image is named `api3/airseeker`.

docker/Dockerfile

@@ -0,0 +1,77 @@
+ARG build=local
+
+# Environment
+FROM node:14.17-alpine3.14 AS environment
+
+ENV name="airseeker" \
+    appDir="/app" \
+    buildDir="/build"
+ENV packageDir="${buildDir}/package"
+
+# Build preparation
+FROM environment AS preparation
+
+WORKDIR ${buildDir}
+
+RUN apk add --update --no-cache git
+
+# Source preparation - local
+FROM preparation as sourcelocal
+
+COPY . ${buildDir}
+
+# Source preparation - git
+FROM preparation as sourcegit
+
+ARG branch=main
+ARG repository=https://github.com/api3dao/airseeker.git
+
+RUN git clone --single-branch --branch ${branch} ${repository} ${buildDir}
+
+# Production dependencies
+FROM source${build} AS deps
+
+RUN yarn install --production --no-optional --ignore-scripts
+
+# Production source code
+FROM source${build} AS build
+
+RUN yarn install && \
+    yarn build && \
+    yarn pack && \
+    mkdir -p ${packageDir} && \
+    tar -xf *.tgz -C ${packageDir} --strip-components 1
+
+# Result image
+FROM environment
+
+ENV cronjob="/etc/cron.d/logrotate"
+
+WORKDIR ${appDir}
+
+LABEL application=${name} \
+      description="A tool to update a beacons with signed responses from Airnode's gateway"
+
+COPY --from=deps ${buildDir}/node_modules ./node_modules
+COPY --from=build ${packageDir} .
+COPY docker/entrypoint.sh /entrypoint.sh
+COPY docker/logrotate-crontab ${cronjob}
+
+    # Create Airseeker user
+RUN addgroup -S ${name} && \
+    adduser -h ${appDir} -s /bin/false -S -D -H -G ${name} ${name} && \
+    chown -R ${name} ${appDir} && \
+    # Install pm2
+    yarn global add pm2 && \
+    # Install dependencies
+    apk add --update --no-cache logrotate su-exec && \
+    # Clear any default logrotate configurations
+    rm /etc/logrotate.d/* && \
+    # Enable logrotate cronjob
+    chmod +x ${cronjob} && \
+    crontab -u ${name} ${cronjob}
+
+# Need to do this after the RUN directive because we first want to clear the /etc/logrotate.d directory
+COPY docker/pm2-airseeker /etc/logrotate.d/pm2-airseeker
+
+ENTRYPOINT ["/entrypoint.sh"]

docker/entrypoint.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+# Starting cron (as root) to run logrotate (as non-root) once a day
+crond
+
+# Starting pm2 under non-root user
+# Using `exec` to pass signals from shell to the binary
+exec su-exec ${name}:${name} pm2-runtime /app/ecosystem.config.js --env production

docker/logrotate-crontab

@@ -0,0 +1 @@
+0 2 * * * logrotate -s /app/.pm2/logrotate.status /etc/logrotate.conf

docker/pm2-airseeker

@@ -0,0 +1,10 @@
+/app/.pm2/pm2.log /app/.pm2/logs/*.log {
+        rotate 12
+        weekly
+        missingok
+        notifempty
+        compress
+        delaycompress
+        copytruncate
+        create 0640 airseeker airseeker
+}

ecosystem.config.js

@@ -0,0 +1,16 @@
+/* eslint-disable functional/immutable-data */
+module.exports = {
+  apps: [
+    {
+      name: 'airseeker',
+      script: './dist/src/main.js',
+      kill_timeout: 10000,
+      env: {
+        NODE_ENV: 'development',
+      },
+      env_production: {
+        NODE_ENV: 'production',
+      },
+    },
+  ],
+};

package.json

@@ -4,17 +4,26 @@
   "version": "1.0.0",
   "description": "A tool to update a beacons with signed responses from Airnode's gateway",
   "main": "./dist/src/main.js",
+  "files": [
+    "dist",
+    "ecosystem.config.js"
+  ],
   "scripts": {
     "build": "yarn clean && yarn compile",
     "clean": "rimraf -rf ./dist *.tgz",
     "compile": "tsc -p tsconfig.json",
+    "docker:build": "docker build -t api3/airseeker:latest -f docker/Dockerfile .",
     "format": "yarn prettier",
     "format:fix": "yarn prettier:fix",
     "lint": "yarn format && yarn eslint",
     "lint:fix": "yarn format:fix && yarn eslint:fix",
     "eslint": "eslint . --ext .js,.ts",
     "eslint:fix": "eslint . --ext .js,.ts --fix",
     "postinstall": "husky install",
+    "pm2:logs": "yarn pm2 logs",
+    "pm2:start": "yarn pm2 start ecosystem.config.js",
+    "pm2:status": "yarn pm2 status",
+    "pm2:stop": "yarn pm2 delete ecosystem.config.js",
     "prettier": "prettier --check \"./**/*.{js,ts,md,yml,json}\"",
     "prettier:fix": "prettier --write \"./**/*.{js,ts,md,yml,json}\" --ignore-unknown",
     "start": "ts-node src/main.ts",
@@ -32,6 +41,7 @@
     "eslint-plugin-jest": "^26.1.3",
     "husky": "^7.0.4",
     "jest": "^27.5.1",
+    "pm2": "^5.2.0",
     "prettier": "^2.6.1",
     "rimraf": "^3.0.2",
     "ts-jest": "^27.1.3",

src/main.ts

@@ -1 +1,35 @@
-console.log('main process');
+const DATA_FETCH_FREQUENCY_MS = 5000;
+const BEACON_UPDATE_FREQUENCY_MS = 10_000;
+
+let stopSignalReceived = false;
+
+const handleStopSignal = (signal: string) => {
+  console.log(`Signal ${signal} received`);
+  console.log('Stopping Airseeeker...');
+  // Let the process wait for the last cycles instead of killing it immediately
+  stopSignalReceived = true;
+};
+
+const fetchData = async () => {
+  console.log('Fetching data');
+  if (!stopSignalReceived) {
+    setTimeout(() => {
+      fetchData();
+    }, DATA_FETCH_FREQUENCY_MS);
+  }
+};
+
+const updateBeacons = async () => {
+  console.log('Updating beacons');
+  if (!stopSignalReceived) {
+    setTimeout(() => {
+      updateBeacons();
+    }, BEACON_UPDATE_FREQUENCY_MS);
+  }
+};
+
+fetchData();
+updateBeacons();
+
+process.on('SIGINT', handleStopSignal);
+process.on('SIGTERM', handleStopSignal);