Structured logs and error reporting (#9)

Author: koistya

.vscode/settings.json

@@ -33,6 +33,7 @@
     "devtool",
     "downlevel",
     "envalid",
+    "envars",
     "eslintcache",
     "esmodules",
     "esnext",

README.md

@@ -19,6 +19,7 @@ of your choice, such as [GraphQL.js](https://www.npmjs.com/package/graphql).
 - Stateless sessions implemented with JWT tokens and a session cookie (compatible with SSR)
 - Database schema migration, seeds, and REPL shell tooling
 - Transactional emails using Handlebars templates and instant email previews
+- Structured logs and error reporting to Google StackDriver
 - Pre-configured unit testing tooling powered by [Jest](https://jestjs.io/) and [Supertest](https://github.com/visionmedia/supertest)
 - Application bundling with Rollup as an optimization technique for serverless deployments
 - Rebuilds and restarts the app on changes when running locally
@@ -31,17 +32,22 @@ Be sure to join our [Discord channel](https://discord.com/invite/GrqQaSnvmr) for
 
 ## Tech Stack
 
-- [Node.js](https://nodejs.org/) v14, [Yarn](https://yarnpkg.com/) package manager, [TypeScript](https://www.typescriptlang.org/), [Babel](https://babeljs.io/), [Rollup](https://rollupjs.org/)
+- [Node.js](https://nodejs.org/) v14, [Yarn](https://yarnpkg.com/) package manager,
+  [TypeScript](https://www.typescriptlang.org/), [Babel](https://babeljs.io/),
+  [Rollup](https://rollupjs.org/), [ESLint](https://eslint.org/),
+  [Prettier](https://prettier.io/), [Jest](https://jestjs.io/)
 - [PostgreSQL](https://www.postgresql.org/), [Knex](https://knesjs.org/),
-  [Express](https://expressjs.com/), [Handlebars](https://handlebarsjs.com/),
-  [Simple OAuth2](https://github.com/lelylan/simple-oauth2).
+  [Express](https://expressjs.com/), [Nodemailer](https://nodemailer.com/),
+  [Email Templates](https://email-templates.js.org/), [Handlebars](https://handlebarsjs.com/),
+  [Simple OAuth2](https://github.com/lelylan/simple-oauth2)
 
 ## Directory Structure
 
 `├──`[`.build`](.build) — Compiled and bundled output (per Cloud Function)<br>
 `├──`[`.vscode`](.vscode) — VSCode settings including code snippets, recommended extensions etc.<br>
 `├──`[`api`](./api) — Cloud Function for handling API requests<br>
 `├──`[`auth`](./auth) — Authentication and session middleware<br>
+`├──`[`core`](./core) — Common application modules (email, logging, etc.)<br>
 `├──`[`db`](./db) — Database client for PostgreSQL using [Knex](https://knexjs.org/)<br>
 `├──`[`emails`](./emails) — Email templates for transactional emails using [Handlebars](https://handlebarsjs.com/)<br>
 `├──`[`env`](./env) — Environment variables for `local`, `dev`, `test`, and `prod`<br>

api/errors.ts

@@ -3,6 +3,7 @@
 
 import { ErrorRequestHandler } from "express";
 import { isHttpError } from "http-errors";
+import { reportError } from "../core";
 
 /**
  * Renders an error page.
@@ -13,6 +14,8 @@ export const handleError: ErrorRequestHandler = function (
   res,
   next // eslint-disable-line @typescript-eslint/no-unused-vars
 ) {
+  reportError(err, req);
+
   const statusCode = isHttpError(err) ? err.statusCode : 500;
   res.status(statusCode);
 

api/index.ts

@@ -10,6 +10,9 @@ import { withViews } from "./views";
 
 export const api = withViews(express());
 
+api.enable("trust proxy");
+api.disable("x-powered-by");
+
 // OAuth 2.0 authentication endpoints and user sessions
 api.use(auth);
 
@@ -34,7 +37,7 @@ api.use(handleError);
 /**
  * Launch API for testing when in development mode.
  *
- * NOTE: This block will be removed in production build by Rollup.
+ * NOTE: This block will be removed from production build by Rollup.
  */
 if (process.env.NODE_ENV === "development") {
   const port = process.env.PORT ?? 8080;

api/email.ts core/email.ts

@@ -9,7 +9,7 @@ import env from "../env";
  *
  * @see https://github.com/forwardemail/email-templates
  */
-export default new Email({
+export const email = new Email({
   message: {
     from: `"${env.APP_NAME}" <${env.EMAIL_FROM}>`,
   },

core/index.ts

@@ -0,0 +1,5 @@
+/* SPDX-FileCopyrightText: 2016-present Kriasoft <[email protected]> */
+/* SPDX-License-Identifier: MIT */
+
+export * from "./email";
+export * from "./logging";

core/logging.ts

@@ -0,0 +1,67 @@
+/* SPDX-FileCopyrightText: 2016-present Kriasoft <[email protected]> */
+/* SPDX-License-Identifier: MIT */
+
+import { Logging } from "@google-cloud/logging";
+import { Request } from "express";
+import PrettyError from "pretty-error";
+import env from "../env";
+
+// https://googleapis.dev/nodejs/logging/latest/
+const logging = new Logging();
+const log = logging.log("cloudfunctions.googleapis.com/cloud-functions");
+
+// https://github.com/AriaMinaei/pretty-error#readme
+const pe = new PrettyError();
+
+/**
+ * Logs application errors to Google StackDriver when in production,
+ * otherwise just print them to the console using PrettyError formatter.
+ */
+export function reportError(
+  err: Error,
+  req: Request,
+  context?: Record<string, unknown>
+): void {
+  if (!env.isProduction) {
+    console.error(pe.render(err));
+    return;
+  }
+
+  // E.g. us-central-example.cloudfunctions.net
+  const host = req.get("host") as string;
+
+  // https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry
+  log.error(
+    log.entry(
+      {
+        resource: {
+          type: "cloud_function",
+          labels: {
+            region: host.substring(0, host.indexOf("-", host.indexOf("-") + 1)),
+            function_name: process.env.FUNCTION_TARGET as string,
+          },
+        },
+        httpRequest: {
+          requestMethod: req.method,
+          requestUrl: req.originalUrl,
+          userAgent: req.get("user-agent"),
+          remoteIp: req.ip,
+          referer: req.headers.referer,
+          latency: null,
+        },
+        labels: {
+          execution_id: req.get("function-execution-id") as string,
+        },
+      },
+      {
+        message: err.stack,
+        context: {
+          ...context,
+          user: req.user
+            ? { id: req.user.id, username: req.user.username }
+            : null,
+        },
+      }
+    )
+  );
+}

package.json

@@ -25,12 +25,13 @@
     "postinstall": "husky install"
   },
   "dependencies": {
+    "@google-cloud/logging": "^9.2.2",
     "chalk": "^4.1.1",
     "cookie": "^0.4.1",
     "email-templates": "^8.0.4",
     "envalid": "^7.1.0",
     "express": "^4.17.1",
-    "express-handlebars": "^5.3.0",
+    "express-handlebars": "^5.3.1",
     "google-auth-library": "^7.0.4",
     "got": "^11.8.2",
     "handlebars": "^4.7.7",
@@ -41,20 +42,22 @@
     "minimist": "^1.2.5",
     "nanoid": "^3.1.22",
     "pg": "^8.6.0",
-    "simple-oauth2": "^4.2.0"
+    "pretty-error": "^3.0.3",
+    "simple-oauth2": "^4.2.0",
+    "source-map-support": "^0.5.19"
   },
   "devDependencies": {
     "@babel/cli": "^7.13.16",
     "@babel/core": "^7.14.0",
     "@babel/plugin-proposal-class-properties": "^7.13.0",
-    "@babel/preset-env": "^7.14.0",
+    "@babel/preset-env": "^7.14.1",
     "@babel/preset-typescript": "^7.13.0",
     "@babel/register": "^7.13.16",
     "@jest/types": "^26.6.2",
     "@rollup/plugin-babel": "^5.3.0",
-    "@rollup/plugin-commonjs": "^18.0.0",
+    "@rollup/plugin-commonjs": "^18.1.0",
     "@rollup/plugin-json": "^4.1.0",
-    "@rollup/plugin-node-resolve": "^11.2.1",
+    "@rollup/plugin-node-resolve": "^13.0.0",
     "@rollup/plugin-replace": "^2.4.2",
     "@rollup/plugin-run": "^2.0.2",
     "@rollup/plugin-url": "^6.0.0",
@@ -68,11 +71,11 @@
     "@types/jsonwebtoken": "^8.5.1",
     "@types/lodash": "^4.14.168",
     "@types/minimist": "^1.2.1",
-    "@types/node": "^14.14.43",
+    "@types/node": "^14.14.44",
     "@types/simple-oauth2": "^4.1.0",
     "@types/supertest": "^2.0.11",
-    "@typescript-eslint/eslint-plugin": "^4.22.0",
-    "@typescript-eslint/parser": "^4.22.0",
+    "@typescript-eslint/eslint-plugin": "^4.22.1",
+    "@typescript-eslint/parser": "^4.22.1",
     "@yarnpkg/pnpify": "^3.0.0-rc.3",
     "babel-jest": "^26.6.3",
     "cross-spawn": "^7.0.3",
@@ -83,10 +86,9 @@
     "jest": "^26.6.3",
     "knex-types": "^0.2.0",
     "prettier": "^2.2.1",
-    "rollup": "^2.46.0",
+    "rollup": "^2.47.0",
     "rollup-plugin-copy": "^3.4.0",
     "rollup-plugin-delete": "^2.0.0",
-    "source-map-support": "^0.5.19",
     "supertest": "^6.1.3",
     "typescript": "^4.2.4"
   },

scripts/deploy.js

@@ -40,7 +40,7 @@ spawn(
     `--source=./.build`,
     `--timeout=30`,
     `--trigger-http`,
-    `--set-env-vars=NODE_OPTIONS=--require ./.pnp.js`,
+    `--set-env-vars=NODE_OPTIONS=-r ./.pnp.js -r source-map-support/register`,
     ...Object.keys(env).map((key) => `--set-env-vars=${key}=${env[key]}`),
   ],
   { stdio: "inherit" }