[#175014199] Health checks

Info/__tests__/handler.test.ts

@@ -0,0 +1,27 @@
+import { taskEither, fromLeft } from "fp-ts/lib/TaskEither";
+import { HealthCheck } from "../../utils/healthcheck";
+import { InfoHandler } from "../handler";
+
+afterEach(() => {
+  jest.clearAllMocks();
+});
+
+describe("InfoHandler", () => {
+  it("should return an internal error if the application is not healthy", async () => {
+    const healthCheck: HealthCheck = fromLeft(["failure 1", "failure 2"]);
+    const handler = InfoHandler(healthCheck);
+
+    const response = await handler();
+
+    expect(response.kind).toBe("IResponseErrorInternal");
+  });
+
+  it("should return a success if the application is healthy", async () => {
+    const healthCheck: HealthCheck = taskEither.of(true);
+    const handler = InfoHandler(healthCheck);
+
+    const response = await handler();
+
+    expect(response.kind).toBe("IResponseSuccessJson");
+  });
+});

Info/handler.ts

@@ -1,27 +1,37 @@
 import * as express from "express";
 import { wrapRequestHandler } from "io-functions-commons/dist/src/utils/request_middleware";
 import {
+  IResponseErrorInternal,
   IResponseSuccessJson,
+  ResponseErrorInternal,
   ResponseSuccessJson
 } from "italia-ts-commons/lib/responses";
 import * as packageJson from "../package.json";
+import { checkApplicationHealth, HealthCheck } from "../utils/healthcheck";
 
 interface IInfo {
   version: string;
 }
 
-type InfoHandler = () => Promise<IResponseSuccessJson<IInfo>>;
+type InfoHandler = () => Promise<
+  IResponseSuccessJson<IInfo> | IResponseErrorInternal
+>;
 
-export function InfoHandler(): InfoHandler {
-  return async () => {
-    return ResponseSuccessJson({
-      version: packageJson.version
-    });
-  };
+export function InfoHandler(healthCheck: HealthCheck): InfoHandler {
+  return () =>
+    healthCheck
+      .fold<IResponseSuccessJson<IInfo> | IResponseErrorInternal>(
+        problems => ResponseErrorInternal(problems.join("\n\n")),
+        _ =>
+          ResponseSuccessJson({
+            version: packageJson.version
+          })
+      )
+      .run();
 }
 
 export function Info(): express.RequestHandler {
-  const handler = InfoHandler();
+  const handler = InfoHandler(checkApplicationHealth());
 
   return wrapRequestHandler(handler);
 }

openapi/index.yaml

@@ -23,6 +23,22 @@ schemes:
 security:
   - SubscriptionKey: []
 paths:
+  "/info":
+    get:
+      operationId: getServerInfo
+      summary: Runtime server info
+      description: >
+        Returns runtime information about the server.
+      security: []
+      responses:
+        "200":
+          description: Runtime server info.
+          schema:
+            $ref: "#/definitions/ServerInfo"
+        "500":
+          description: The server is misconfigured
+          schema:
+            $ref: "#/definitions/ProblemJson"
   "/services/{service_id}":
     parameters:
       - name: service_id
@@ -643,6 +659,14 @@ definitions:
         type: string
       version:
         type: integer
+  ServerInfo:
+    type: object
+    title: Server information
+    properties:
+      version:
+        type: string
+    required:
+     - version
 responses: {}
 parameters:
   SandboxFiscalCode:

utils/__tests__/config.test.ts

@@ -0,0 +1,199 @@
+import { Either } from "fp-ts/lib/Either";
+import { NonEmptyString } from "italia-ts-commons/lib/strings";
+import { MailerConfig } from "../config";
+
+const aMailFrom = "example@test.com";
+
+const noop = () => {};
+const expectRight = <L, R>(e: Either<L, R>, t: (r: R) => void = noop) =>
+  e.fold(
+    _ =>
+      fail(`Expecting right, received left. Value: ${JSON.stringify(e.value)}`),
+    _ => t(_)
+  );
+
+const expectLeft = <L, R>(e: Either<L, R>, t: (l: L) => void = noop) =>
+  e.fold(
+    _ => t(_),
+    _ =>
+      fail(`Expecting left, received right. Value: ${JSON.stringify(e.value)}`)
+  );
+
+describe("MailerConfig", () => {
+  it("should decode configuration for sendgrid", () => {
+    const rawConf = {
+      MAIL_FROM: aMailFrom,
+      NODE_ENV: "production",
+      SENDGRID_API_KEY: "a-sg-key"
+    };
+    const result = MailerConfig.decode(rawConf);
+
+    expectRight(result, value => {
+      expect(value.SENDGRID_API_KEY).toBe("a-sg-key");
+      expect(typeof value.MAILUP_USERNAME).toBe("undefined");
+    });
+  });
+
+  it("should decode configuration for sendgrid", () => {
+    const rawConf = {
+      MAIL_FROM: aMailFrom,
+      NODE_ENV: "production",
+      SENDGRID_API_KEY: "a-sg-key"
+    };
+    const result = MailerConfig.decode(rawConf);
+
+    expectRight(result, value => {
+      expect(value.SENDGRID_API_KEY).toBe("a-sg-key");
+      expect(typeof value.MAILUP_USERNAME).toBe("undefined");
+    });
+  });
+
+  it("should decode configuration for sendgrid even if mailup conf is passed", () => {
+    const rawConf = {
+      MAIL_FROM: aMailFrom,
+      NODE_ENV: "production",
+      SENDGRID_API_KEY: "a-sg-key",
+      MAILUP_USERNAME: "a-mu-username",
+      MAILUP_SECRET: "a-mu-secret"
+    };
+    const result = MailerConfig.decode(rawConf);
+
+    expectRight(result, value => {
+      expect(value.SENDGRID_API_KEY).toBe("a-sg-key");
+    });
+  });
+
+  it("should decode configuration for mailup", () => {
+    const rawConf = {
+      MAIL_FROM: aMailFrom,
+      NODE_ENV: "production",
+      MAILUP_USERNAME: "a-mu-username",
+      MAILUP_SECRET: "a-mu-secret"
+    };
+    const result = MailerConfig.decode(rawConf);
+
+    expectRight(result, value => {
+      expect(value.MAILUP_USERNAME).toBe("a-mu-username");
+      expect(value.MAILUP_SECRET).toBe("a-mu-secret");
+      // check types
+      const _: NonEmptyString = value.MAILUP_SECRET;
+      const __: NonEmptyString = value.MAILUP_USERNAME;
+    });
+  });
+
+  it("should decode configuration with multi transport", () => {
+    const aTransport = {
+      password: "abc".repeat(5),
+      transport: "transport-name",
+      username: "t-username"
+    };
+    const aRawTrasport = [
+      aTransport.transport,
+      aTransport.username,
+      aTransport.password
+    ].join(":");
+
+    const rawConf = {
+      MAIL_FROM: aMailFrom,
+      NODE_ENV: "production",
+      MAIL_TRANSPORTS: [aRawTrasport, aRawTrasport].join(";")
+    };
+    const result = MailerConfig.decode(rawConf);
+
+    expectRight(result, value => {
+      expect(value.MAIL_TRANSPORTS).toEqual([aTransport, aTransport]);
+    });
+  });
+
+  it("should decode configuration for mailhog", () => {
+    const rawConf = {
+      MAIL_FROM: aMailFrom,
+      NODE_ENV: "dev",
+      MAILHOG_HOSTNAME: "a-mh-host"
+    };
+    const result = MailerConfig.decode(rawConf);
+
+    expectRight(result, value => {
+      expect(value.MAILHOG_HOSTNAME).toBe("a-mh-host");
+    });
+  });
+
+  it("should require mailhog if not in prod", () => {
+    const rawConf = {
+      MAIL_FROM: aMailFrom,
+      NODE_ENV: "dev"
+    };
+    const result = MailerConfig.decode(rawConf);
+
+    expectLeft(result);
+  });
+
+  it("should require at least on transporter if in prod", () => {
+    const rawConf = {
+      MAIL_FROM: aMailFrom,
+      NODE_ENV: "production"
+    };
+    const result = MailerConfig.decode(rawConf);
+
+    expectLeft(result);
+  });
+
+  it("should not allow mailhog if in prod", () => {
+    const rawConf = {
+      MAIL_FROM: aMailFrom,
+      NODE_ENV: "production",
+      MAILHOG_HOSTNAME: "a-mh-host"
+    };
+    const result = MailerConfig.decode(rawConf);
+
+    expectLeft(result);
+  });
+
+  it("should not decode configuration with empty transport", () => {
+    const rawConf = {
+      MAIL_FROM: aMailFrom,
+      NODE_ENV: "production",
+      MAIL_TRANSPORTS: ""
+    };
+    const result = MailerConfig.decode(rawConf);
+
+    expectLeft(result);
+  });
+
+  it("should not decode configuration when no transporter is specified", () => {
+    const rawConf = {
+      MAIL_FROM: aMailFrom
+    };
+    const result = MailerConfig.decode(rawConf);
+
+    expectLeft(result);
+  });
+
+  it("should not decode ambiguos configuration", () => {
+    const withMailUp = {
+      MAILUP_USERNAME: "a-mu-username",
+      MAILUP_SECRET: "a-mu-secret"
+    };
+    const withSendGrid = {
+      SENDGRID_API_KEY: "a-sg-key"
+    };
+    const withMultiTransport = {
+      MAIL_TRANSPORTS: "a-trasnport-name"
+    };
+    const base = {
+      MAIL_FROM: aMailFrom,
+      NODE_ENV: "production"
+    };
+
+    const examples = [
+      // the following configuration is not ambiguos as sendgrid would override mailup anyway
+      // see here for the rationale: https://github.com/pagopa/io-functions-admin/pull/89#commitcomment-42917672
+      // { ...base, ...withMailUp, ...withSendGrid },
+      { ...base, ...withMultiTransport, ...withSendGrid },
+      { ...base, ...withMailUp, ...withMultiTransport },
+      { ...base, ...withMailUp, ...withSendGrid, ...withMultiTransport }
+    ];
+
+    examples.map(MailerConfig.decode).forEach(_ => expectLeft(_));
+  });
+});