fix(config)!: use HOST and PORT env variables for cloud services

BREAKING CHANGE: `SERVICE_HOST` and `SERVICE_PORT` env variables renamed to `HOST` and `PORT` respectively.
Fdawgs · Sep 8, 2022 · 45ead4f · 45ead4f
1 parent a59a22f
commit 45ead4f
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 42 deletions.
diff --git a/.env.template b/.env.template
@@ -11,8 +11,8 @@ NODE_ENV="development"
 
 # NOTE: Needs to be kept at "0.0.0.0" if using Docker
 # Defaults to resolving to "localhost" if not set
-SERVICE_HOST=
-SERVICE_PORT=8204
+HOST=
+PORT=8204
 
 ### CORS ##################################################
 

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -27,9 +27,9 @@ services:
  LOG_ROTATION_DATE_FORMAT:
  LOG_ROTATION_FILENAME:
  NODE_ENV: production
- SERVICE_HOST: 0.0.0.0
+ HOST: 0.0.0.0
  healthcheck:
- test: curl "localhost:${SERVICE_PORT:-8204}/admin/healthcheck"
+ test: curl "localhost:${PORT:-8204}/admin/healthcheck"
  interval: 60s
  timeout: 3s
  start_period: 5s
@@ -45,7 +45,7 @@ services:
  max-file: "${LOG_ROTATION_MAX_LOGS:-10}"
  max-size: "${LOG_ROTATION_MAX_SIZE:-100m}"
  ports:
- - "127.0.0.1:${SERVICE_PORT:-8204}:${SERVICE_PORT:-8204}"
+ - "127.0.0.1:${PORT:-8204}:${PORT:-8204}"
  restart: "${DOCKER_RESTART_POLICY:-unless-stopped}"
 
 volumes:

diff --git a/src/config/config.test.js b/src/config/config.test.js
@@ -22,8 +22,8 @@ describe("Configuration", () => {
 
  test("Should use defaults if values missing and return values according to environment variables", async () => {
  const NODE_ENV = "development";
- const SERVICE_HOST = faker.internet.ip();
- const SERVICE_PORT = faker.datatype.number();
+ const HOST = faker.internet.ip();
+ const PORT = faker.datatype.number();
  const CORS_ORIGIN = "";
  const CORS_ALLOWED_HEADERS = "";
  const CORS_ALLOW_CREDENTIALS = "";
@@ -51,8 +51,8 @@ describe("Configuration", () => {
 
  Object.assign(process.env, {
  NODE_ENV,
- SERVICE_HOST,
- SERVICE_PORT,
+ HOST,
+ PORT,
  CORS_ORIGIN,
  CORS_ALLOWED_HEADERS,
  CORS_ALLOW_CREDENTIALS,
@@ -81,8 +81,8 @@ describe("Configuration", () => {
  const config = await getConfig();
 
  expect(config.fastify).toEqual({
- host: SERVICE_HOST,
- port: SERVICE_PORT,
+ host: HOST,
+ port: PORT,
  });
 
  expect(config.fastifyInit.logger).toEqual({
@@ -141,8 +141,8 @@ describe("Configuration", () => {
 
  test("Should return values according to environment variables - HTTPS (SSL cert) enabled and HTTP2 enabled", async () => {
  const NODE_ENV = "development";
- const SERVICE_HOST = faker.internet.ip();
- const SERVICE_PORT = faker.datatype.number();
+ const HOST = faker.internet.ip();
+ const PORT = faker.datatype.number();
  const HTTPS_SSL_CERT_PATH =
  "./test_resources/test_ssl_cert/server.cert";
  const HTTPS_SSL_KEY_PATH = "./test_resources/test_ssl_cert/server.key";
@@ -172,8 +172,8 @@ describe("Configuration", () => {
 
  Object.assign(process.env, {
  NODE_ENV,
- SERVICE_HOST,
- SERVICE_PORT,
+ HOST,
+ PORT,
  HTTPS_SSL_CERT_PATH,
  HTTPS_SSL_KEY_PATH,
  HTTPS_HTTP2_ENABLED,
@@ -199,8 +199,8 @@ describe("Configuration", () => {
  const config = await getConfig();
 
  expect(config.fastify).toEqual({
- host: SERVICE_HOST,
- port: SERVICE_PORT,
+ host: HOST,
+ port: PORT,
  });
 
  expect(config.fastifyInit.logger).toEqual({
@@ -257,8 +257,8 @@ describe("Configuration", () => {
  });
 
  test("Should return values according to environment variables - HTTPS (PFX cert) enabled and HTTP2 enabled", async () => {
- const SERVICE_HOST = faker.internet.ip();
- const SERVICE_PORT = faker.datatype.number();
+ const HOST = faker.internet.ip();
+ const PORT = faker.datatype.number();
  const HTTPS_PFX_FILE_PATH =
  "./test_resources/test_ssl_cert/server.cert"; // Not an actual PFX file
  const HTTPS_PFX_PASSPHRASE = faker.lorem.word();
@@ -272,8 +272,8 @@ describe("Configuration", () => {
  const ADMIN_PASSWORD = "password";
 
  Object.assign(process.env, {
- SERVICE_HOST,
- SERVICE_PORT,
+ HOST,
+ PORT,
  HTTPS_PFX_FILE_PATH,
  HTTPS_PFX_PASSPHRASE,
  HTTPS_HTTP2_ENABLED,
@@ -285,8 +285,8 @@ describe("Configuration", () => {
  const config = await getConfig();
 
  expect(config.fastify).toEqual({
- host: SERVICE_HOST,
- port: SERVICE_PORT,
+ host: HOST,
+ port: PORT,
  });
 
  expect(config.fastifyInit.https).toEqual({
@@ -349,8 +349,8 @@ describe("Configuration", () => {
  ])(
  "Should return values according to environment variables - $testName",
  async ({ envVariables, expected }) => {
- const SERVICE_HOST = faker.internet.ip();
- const SERVICE_PORT = faker.datatype.number();
+ const HOST = faker.internet.ip();
+ const PORT = faker.datatype.number();
  const CORS_ORIGIN = envVariables.CORS_ORIGIN;
  const CORS_ALLOWED_HEADERS =
  "Accept, Authorization, Content-Type, Origin, X-Requested-With";
@@ -367,8 +367,8 @@ describe("Configuration", () => {
  const ADMIN_PASSWORD = "password";
 
  Object.assign(process.env, {
- SERVICE_HOST,
- SERVICE_PORT,
+ HOST,
+ PORT,
  CORS_ORIGIN,
  CORS_ALLOWED_HEADERS,
  CORS_ALLOW_CREDENTIALS,
@@ -382,8 +382,8 @@ describe("Configuration", () => {
  const config = await getConfig();
 
  expect(config.fastify).toEqual({
- host: SERVICE_HOST,
- port: SERVICE_PORT,
+ host: HOST,
+ port: PORT,
  });
 
  expect(config.cors).toEqual({
@@ -415,8 +415,8 @@ describe("Configuration", () => {
  },
  },
  ])("Should throw error if $testName", async ({ envVariables }) => {
- const SERVICE_HOST = faker.internet.ip();
- const SERVICE_PORT = faker.datatype.number();
+ const HOST = faker.internet.ip();
+ const PORT = faker.datatype.number();
  const HTTPS_SSL_KEY_PATH = envVariables?.HTTPS_SSL_KEY_PATH || "";
  const HTTPS_SSL_CERT_PATH = envVariables?.HTTPS_SSL_CERT_PATH || "";
  const HTTPS_PFX_FILE_PATH = envVariables?.HTTPS_PFX_FILE_PATH || "";
@@ -430,8 +430,8 @@ describe("Configuration", () => {
  const ADMIN_PASSWORD = "password";
 
  Object.assign(process.env, {
- SERVICE_HOST,
- SERVICE_PORT,
+ HOST,
+ PORT,
  HTTPS_SSL_CERT_PATH,
  HTTPS_SSL_KEY_PATH,
  HTTPS_PFX_FILE_PATH,

diff --git a/src/config/index.js b/src/config/index.js
@@ -47,8 +47,8 @@ async function getConfig() {
  .prop("NODE_ENV", S.string())
 
  // Service
- .prop("SERVICE_HOST", S.string())
- .prop("SERVICE_PORT", S.number())
+ .prop("HOST", S.string())
+ .prop("PORT", S.number())
 
  // CORS
  .prop("CORS_ORIGIN", S.anyOf([S.string(), S.null()]))
@@ -129,8 +129,8 @@ async function getConfig() {
  .prop("DB_CONNECTION_STRING", S.string())
  .required([
  "NODE_ENV",
- "SERVICE_HOST",
- "SERVICE_PORT",
+ "HOST",
+ "PORT",
  "ADMIN_USERNAME",
  "ADMIN_PASSWORD",
  "DB_CONNECTION_STRING",
@@ -139,7 +139,7 @@ async function getConfig() {
 
  const config = {
  fastify: {
- port: env.SERVICE_PORT,
+ port: env.PORT,
  },
  fastifyInit: {
  /**
@@ -273,8 +273,8 @@ async function getConfig() {
  };
 
  // Ensure API listens on both IPv4 and IPv6 addresses
- if (env.SERVICE_HOST) {
- config.fastify.host = env.SERVICE_HOST;
+ if (env.HOST) {
+ config.fastify.host = env.HOST;
  }
 
  if (env.LOG_ROTATION_FILENAME) {

diff --git a/src/server.test.js b/src/server.test.js
@@ -638,8 +638,8 @@ describe("Server Deployment", () => {
 
  beforeAll(async () => {
  Object.assign(process.env, {
- SERVICE_HOST: "localhost",
- SERVICE_PORT: "8204",
+ HOST: "localhost",
+ PORT: "8204",
  HTTPS_PFX_PASSPHRASE: "",
  HTTPS_PFX_FILE_PATH: "",
  HTTPS_SSL_CERT_PATH: "",