Merge pull request #172 from AbsaOSS/boilerplate/update

Boilerplate update, refactoring, improve webhook callbacks

Author: mirgee

.github/workflows/main.yml

@@ -100,7 +100,7 @@ jobs:
 
           # change REBUILD_SEED if you want to manually enforce rebuilding all images
           REBUILD_SEED_REDIS="1"
-          REBUILD_SEED_BASE="2"
+          REBUILD_SEED_BASE="3"
           REBUILD_SEED_AGENCY="1"
 
           export CODE_AGENCY_HASH=${{ hashFiles('vcxagency-node') }}

vcxagency-base/build.sh

@@ -2,11 +2,11 @@
 
 SCRIPT_DIR_PATH=$(dirname "$0")
 
-INDYSDK_REPO="https://gitlab.com/evernym/verity/vdr-tools.git"
+VDRTOOLS_REPO="https://gitlab.com/evernym/verity/vdr-tools.git"
 INDYSDK_REVISION="7df4c69b"
 DOCKER_TAG="$1"
 
-docker build --build-arg "INDYSDK_REPO=$INDYSDK_REPO" \
+docker build --build-arg "VDRTOOLS_REPO=$VDRTOOLS_REPO" \
              --build-arg "INDYSDK_REVISION=$INDYSDK_REVISION" \
              -t "$DOCKER_TAG" \
              -f "$SCRIPT_DIR_PATH/vcxagency-base.Dockerfile" \

vcxagency-base/vcxagency-base.Dockerfile

@@ -1,11 +1,11 @@
-FROM alpine:3.15.4 AS builder
+FROM alpine:3.15.4 AS LIBINDY_BUILD
 
 ARG UID=1001
 ARG GID=1001
 
-ARG INDYSDK_PATH=/home/indy/vdr-tools
-ARG INDYSDK_REPO=https://gitlab.com/evernym/verity/vdr-tools.git
-ARG INDYSDK_REVISION=7df4c69b
+ARG VDRTOOLS_PATH=/home/indy/vdr-tools
+ARG VDRTOOLS_REPO=https://gitlab.com/evernym/verity/vdr-tools.git
+ARG VDRTOOLS_REVISION=7df4c69b
 
 ENV LC_ALL="C.UTF-8"
 ENV LANG="C.UTF-8"
@@ -31,39 +31,32 @@ ARG RUST_VER="1.52.0"
 RUN curl https://sh.rustup.rs -sSf | sh -s -- -y --default-toolchain $RUST_VER --default-host x86_64-unknown-linux-musl
 ENV PATH="/home/indy/.cargo/bin:$PATH" RUSTFLAGS="-C target-feature=-crt-static"
 
-RUN git clone $INDYSDK_REPO
-RUN cd $INDYSDK_PATH && git --no-pager log --decorate=short --pretty=oneline -n5
-RUN cd $INDYSDK_PATH && git checkout $INDYSDK_REVISION
+RUN git clone $VDRTOOLS_REPO
+RUN cd $VDRTOOLS_PATH && git --no-pager log --decorate=short --pretty=oneline -n5
+RUN cd $VDRTOOLS_PATH && git checkout $VDRTOOLS_REVISION
 
-RUN cargo build --release --manifest-path=$INDYSDK_PATH/libindy/Cargo.toml
+RUN cargo build --release --manifest-path=$VDRTOOLS_PATH/libindy/Cargo.toml
 
 USER root
-RUN mv $INDYSDK_PATH/libindy/target/release/libindy.so /usr/lib
+RUN mv $VDRTOOLS_PATH/libindy/target/release/libindy.so /usr/lib
 
 FROM alpine:3.15.4
 
 ARG UID=1001
 ARG GID=1001
 
-ENV LC_ALL="C.UTF-8"
 ENV LANG="C.UTF-8"
+ENV LC_ALL="C.UTF-8"
 
 RUN addgroup -g $GID node && adduser -u $UID -D -G node node
 
-COPY --from=builder /usr/lib/libindy.so /usr/lib/
+COPY --from=LIBINDY_BUILD /usr/lib/libindy.so /usr/lib/
 
 RUN apk update && apk upgrade
 RUN apk add --no-cache \
-        bash \
-        g++ \
-        gcc \
         libsodium-dev \
         libzmq \
-        make \
-        cmake \
-        npm \
         openssl-dev \
-        python2 \
         sqlite-dev \
         zeromq-dev
 
@@ -72,4 +65,4 @@ RUN apk add --no-cache nodejs=12.22.12-r0
 
 LABEL org.label-schema.schema-version="1.0"
 LABEL org.label-schema.name="indy-sdk"
-LABEL org.label-schema.version="${INDYSDK_REVISION}"
+LABEL org.label-schema.version="${VDRTOOLS_REVISION}"

vcxagency-node/Dockerfile

@@ -1,6 +1,14 @@
-ARG AGENCY_BASE_IMAGE=vcxagency-base:1.15.0
+ARG AGENCY_BASE_IMAGE
 FROM ${AGENCY_BASE_IMAGE}
 
+RUN apk add --no-cache \
+        npm \
+        bash \
+        g++ \
+        gcc \
+        make \
+        cmake \
+        python2
 RUN npm install -g yarn
 
 USER node
@@ -27,10 +35,4 @@ LABEL org.label-schema.schema-version="1.1.0"
 LABEL org.label-schema.name="vcxagency-node"
 LABEL org.label-schema.description="Node VCX Agency"
 
-ENV LOG_LEVEL ${LOG_LEVEL:-'true'}
-ENV LOG_ENABLE_INDYSDK ${LOG_ENABLE_INDYSDK:-'false'}
-ENV LOG_JSON_TO_CONSOLE ${LOG_JSON_TO_CONSOLE:-'true'}
-
-EXPOSE ${SERVER_PORT}
-
 CMD ["npm", "run", "serve"]

vcxagency-node/package.json

@@ -21,10 +21,12 @@
     "test:perf:generatedata": "node ./test/perf/storage/generate-dataset.js",
     "test:perf": "jest --runInBand  ./test/perf/storage/pgstorage.perf.spec.js",
     "test:unit": "SILENT_WINSTON=true jest --runInBand ./test/unit",
-    "test:unit:storage": "SILENT_WINSTON=true jest --runInBand ./test/unit/storage/",
-    "test:unit:messaging": "SILENT_WINSTON=true jest --runInBand ./test/unit/messaging/aries-msgs.spec.js",
+    "test:unit:configuration": "SILENT_WINSTON=true jest --runInBand ./test/unit/configuration",
     "test:unit:entities": "SILENT_WINSTON=true jest --runInBand ./test/unit/entities",
-    "test:unit:configuration": "SILENT_WINSTON=true jest --runInBand ./test/unit/configuration"
+    "test:unit:messaging": "SILENT_WINSTON=true jest --runInBand ./test/unit/messaging",
+    "test:unit:notifications": "SILENT_WINSTON=true jest --runInBand ./test/unit/notifications",
+    "test:unit:state": "SILENT_WINSTON=true jest --runInBand ./test/unit/state",
+    "test:unit:storage": "SILENT_WINSTON=true jest --runInBand ./test/unit/storage/"
   },
   "devDependencies": {
     "@types/jest": "^25.2.2",

vcxagency-node/src/configuration/app-config-loader.js

@@ -30,15 +30,15 @@ if (appConfigName) {
 
 function buildAppConfigFromEnvVariables () {
   const appConfig = {
-    LOG_LEVEL: process.env.LOG_LEVEL || 'info',
-    LOG_ENABLE_INDYSDK: process.env.LOG_ENABLE_INDYSDK || 'false',
+    LOG_LEVEL: process.env.LOG_LEVEL,
+    LOG_ENABLE_INDYSDK: process.env.LOG_ENABLE_INDYSDK,
     LOG_JSON_TO_CONSOLE: process.env.LOG_JSON_TO_CONSOLE,
     LOG_HEALTH_REQUESTS: process.env.LOG_HEALTH_REQUESTS,
     DEV_MODE: process.env.DEV_MODE,
 
     SERVER_PORT: process.env.SERVER_PORT,
     SERVER_HOSTNAME: process.env.SERVER_HOSTNAME,
-    SERVER_MAX_REQUEST_SIZE_KB: process.env.SERVER_MAX_REQUEST_SIZE_KB || '300',
+    SERVER_MAX_REQUEST_SIZE_KB: process.env.SERVER_MAX_REQUEST_SIZE_KB,
     SERVER_ENABLE_TLS: process.env.SERVER_ENABLE_TLS,
     CERTIFICATE_PATH: process.env.CERTIFICATE_PATH,
     CERTIFICATE_KEY_PATH: process.env.CERTIFICATE_KEY_PATH,
@@ -61,7 +61,11 @@ function buildAppConfigFromEnvVariables () {
 
     AWS_S3_PATH_CERT: process.env.AWS_S3_PATH_CERT,
     AWS_S3_BUCKET_CERT: process.env.AWS_S3_BUCKET_CERT,
-    AWS_S3_PATH_CERT_KEY: process.env.AWS_S3_PATH_CERT_KEY
+    AWS_S3_PATH_CERT_KEY: process.env.AWS_S3_PATH_CERT_KEY,
+
+    ECS_CONTAINER_METADATA_URI_V4: process.env.ECS_CONTAINER_METADATA_URI_V4,
+    WEBHOOK_RESPONSE_TIMEOUT_MS: process.env.WEBHOOK_RESPONSE_TIMEOUT_MS,
+    EXPLAIN_QUERIES: process.env.EXPLAIN_QUERIES
   }
   appConfig.SERVER_MAX_REQUEST_SIZE_KB = parseInt(appConfig.SERVER_MAX_REQUEST_SIZE_KB)
   appConfig.MYSQL_DATABASE_WALLET_CONNECTION_LIMIT = parseInt(appConfig.MYSQL_DATABASE_WALLET_CONNECTION_LIMIT)

vcxagency-node/src/configuration/app-config.js

@@ -17,7 +17,6 @@
 'use strict'
 
 const Joi = require('joi')
-const fs = require('fs')
 
 function stringifyAndHideSensitive (appConfig) {
   function hideSecrets (key, value) {
@@ -40,22 +39,22 @@ const MB_AS_KB = 1024
 
 const configValidation = Joi.object().keys({
   LOG_LEVEL: Joi.string().valid('silly', 'debug', 'info', 'warn', 'error'),
-  LOG_ENABLE_INDYSDK: Joi.string().valid('true', 'false'),
-  LOG_JSON_TO_CONSOLE: Joi.string().valid('true', 'false'),
-  LOG_HEALTH_REQUESTS: Joi.string().valid('true', 'false').default('false'),
-  DEV_MODE: Joi.string().valid('true', 'false').default('false'),
+  LOG_ENABLE_INDYSDK: Joi.boolean().default(false),
+  LOG_JSON_TO_CONSOLE: Joi.boolean().default(true),
+  LOG_HEALTH_REQUESTS: Joi.boolean().default(false),
+  DEV_MODE: Joi.boolean().default(false),
 
-  SERVER_PORT: Joi.number().integer().min(1025).max(65535).required(),
   SERVER_HOSTNAME: Joi.string().default('0.0.0.0'),
+  SERVER_PORT: Joi.number().integer().min(1025).max(65535).required(),
+  SERVER_ENABLE_TLS: Joi.boolean().default(true),
   SERVER_MAX_REQUEST_SIZE_KB: Joi.number().integer().min(1).max(MB_AS_KB * 10).default(512),
-  SERVER_ENABLE_TLS: Joi.string().valid('true', 'false').default('true'),
   CERTIFICATE_PATH: Joi.string(),
   CERTIFICATE_KEY_PATH: Joi.string(),
 
   AGENCY_WALLET_NAME: Joi.string().required(),
-  AGENCY_DID: Joi.string().required(),
-  AGENCY_SEED_SECRET: Joi.string().min(20).required(),
   AGENCY_WALLET_KEY_SECRET: Joi.string().min(20).required(),
+  AGENCY_SEED_SECRET: Joi.string().min(20).required(),
+  AGENCY_DID: Joi.string().required(),
 
   REDIS_URL: Joi.string(),
   AGENCY_TYPE: Joi.string().valid('enterprise', 'client').required(),
@@ -70,47 +69,26 @@ const configValidation = Joi.object().keys({
 
   AWS_S3_PATH_CERT: Joi.string(),
   AWS_S3_BUCKET_CERT: Joi.string(),
-  AWS_S3_PATH_CERT_KEY: Joi.string()
+  AWS_S3_PATH_CERT_KEY: Joi.string(),
+
+  ECS_CONTAINER_METADATA_URI_V4: Joi.string().uri(),
+  WEBHOOK_RESPONSE_TIMEOUT_MS: Joi.number().default(1000),
+  EXPLAIN_QUERIES: Joi.boolean().default(false)
 })
 
 function validateFinalConfig (appConfig) {
-  function testConfigPathExist (appConfig, key) {
-    const path = appConfig[key]
-    if (!fs.existsSync(path)) {
-      throw new Error(`${key} = ${path} is not a valid path or the path does not exist`)
+  if (appConfig.AGENCY_TYPE === 'client') {
+    if (!appConfig.REDIS_URL) {
+      throw new Error('Configuration for agency of type \'client\' must have REDIS_URL specified.')
     }
   }
-
   function validateTls () {
-    if (appConfig.AGENCY_TYPE === 'client') {
-      if (!appConfig.REDIS_URL) {
-        throw new Error('Configuration for agency of type \'client\' must have REDIS_URL specified.')
-      }
-    }
-    if (appConfig.SERVER_ENABLE_TLS === 'true') {
+    if (appConfig.SERVER_ENABLE_TLS === true) {
       if (!appConfig.CERTIFICATE_PATH || !appConfig.CERTIFICATE_KEY_PATH) {
         throw new Error('Valid certificate and key paths must be specified when TLS enabled!')
       }
-      testConfigPathExist(appConfig, 'CERTIFICATE_PATH')
-      testConfigPathExist(appConfig, 'CERTIFICATE_KEY_PATH')
-    }
-  }
-
-  if (appConfig.WALLET_TYPE === 'pgsql') {
-    throw new Error('WALLET_TYPE "pgsql" is not supported anymore')
-  }
-  if (appConfig.WALLET_TYPE === 'mysql') {
-    if (!appConfig.MYSQL_WALLET_HOST) {
-      throw new Error('"MYSQL_WALLET_HOST" is required')
-    }
-    if (!appConfig.MYSQL_WALLET_ACCOUNT) {
-      throw new Error('"MYSQL_WALLET_ACCOUNT" is required')
-    }
-    if (!appConfig.MYSQL_WALLET_PASSWORD_SECRET) {
-      throw new Error('"MYSQL_WALLET_PASSWORD_SECRET" is required')
     }
   }
-
   validateTls()
 }