Bring-your-own logger

packages/gasket-cli/package.json

@@ -59,6 +59,7 @@
     "@gasket/plugin-command": "^6.43.0",
     "@gasket/plugin-git": "^6.43.0",
     "@gasket/plugin-lifecycle": "^6.43.0",
+    "@gasket/plugin-logger": "^6.43.0",
     "@gasket/plugin-metadata": "^6.43.1",
     "@gasket/plugin-start": "^6.43.0",
     "@gasket/resolve": "^6.43.1",

packages/gasket-cli/src/config/default-plugins.js

@@ -3,5 +3,6 @@ module.exports = [
   require('@gasket/plugin-lifecycle'),
   require('@gasket/plugin-metadata'),
   require('@gasket/plugin-start'),
-  require('@gasket/plugin-git')
+  require('@gasket/plugin-git'),
+  require('@gasket/plugin-logger')
 ];

packages/gasket-plugin-express/CHANGELOG.md

@@ -1,5 +1,7 @@
 # `@gasket/plugin-express`
 
+- Add a logger to the request object
+
 ### 6.41.2
 
 - Fix ordering of error middlewares so they come after API routes

packages/gasket-plugin-express/README.md

@@ -78,6 +78,22 @@ middleware are triggered for which requests.
   ]
 ```
 
+## Logging
+
+This plugin attaches a `logger` object to the request object. This object has a `metadata` method that allows you to attach details to any log entry related to the request. For example, you can add the user ID to each log entry. When logging within the context of a request, use the `req.logger` object instead of the global `gasket.logger` so that contextual information is included in the log entry. Here is an example of how to attach metadata to  `req.logger` object and how to use it:
+
+```js
+function someMiddleware(req, res, next) {
+  req.logger.metadata({ userId: req.user.id });
+  next();
+}
+
+function someOtherMiddleware(req, res, next) {
+  req.logger.info('Some log message');
+  next();
+}
+```
+
 ## Lifecycles
 
 ### middleware

packages/gasket-plugin-express/lib/index.js

@@ -48,6 +48,13 @@ module.exports = {
       const { root, express: { routes } = {}, http2, middleware: middlewareConfig } = config;
       const excludedRoutesRegex = config.express && config.express.excludedRoutesRegex;
       const app = http2 ? require('http2-express-bridge')(express) : express();
+      const conditionallyUse = (...middleware) => middleware.forEach(mw => {
+        if (excludedRoutesRegex) {
+          app.use(excludedRoutesRegex, mw);
+        } else {
+          app.use(mw);
+        }
+      });
 
       if (http2) {
         app.use(
@@ -66,12 +73,20 @@ module.exports = {
           });
       }
 
-      if (excludedRoutesRegex) {
-        app.use(excludedRoutesRegex, cookieParser());
-      } else {
-        app.use(cookieParser());
+      function attachLogEnhancer(req) {
+        req.logger.metadata = metadata => {
+          req.logger = req.logger.child(metadata);
+          attachLogEnhancer(req);
+        };
       }
 
+      conditionallyUse((req, res, next) => {
+        req.logger = gasket.logger;
+        attachLogEnhancer(req);
+        next();
+      });
+      conditionallyUse(cookieParser());
+
       const { compression: compressionConfig = true } = config.express || {};
       if (compressionConfig) {
         app.use(compression());
@@ -101,10 +116,8 @@ module.exports = {
         const { paths } = layer;
         if (paths) {
           app.use(paths, layer);
-        } else if (excludedRoutesRegex) {
-          app.use(excludedRoutesRegex, layer);
         } else {
-          app.use(layer);
+          conditionallyUse(layer);
         }
       });
 

packages/gasket-plugin-express/test/plugin.test.js

@@ -211,7 +211,7 @@ describe('createServers', () => {
 
   it('adds middleware from lifecycle (ignores falsy)', async () => {
     await plugin.hooks.createServers(gasket, {});
-    expect(app.use).toHaveBeenCalledTimes(2);
+    expect(app.use).toHaveBeenCalledTimes(3);
 
     app.use.mockClear();
     mockMwPlugins = [
@@ -220,7 +220,7 @@ describe('createServers', () => {
     ];
 
     await plugin.hooks.createServers(gasket, {});
-    expect(app.use).toHaveBeenCalledTimes(3);
+    expect(app.use).toHaveBeenCalledTimes(4);
   });
 
   it('supports async middleware hooks', async () => {
@@ -256,16 +256,35 @@ describe('createServers', () => {
     ];
     await plugin.hooks.createServers(gasket, {});
 
-    expect(app.use.mock.calls[2]).toContain(paths);
+    expect(app.use.mock.calls[3]).toContain(paths);
   });
 
   it('adds errorMiddleware from lifecycle (ignores falsy)', async () => {
     await plugin.hooks.createServers(gasket, {});
-    expect(app.use).toHaveBeenCalledTimes(2);
+    expect(app.use).toHaveBeenCalledTimes(3);
     lifecycles.errorMiddleware.mockResolvedValue([() => {}, null]);
     app.use.mockClear();
     await plugin.hooks.createServers(gasket, {});
-    expect(app.use).toHaveBeenCalledTimes(3);
+    expect(app.use).toHaveBeenCalledTimes(4);
+  });
+
+  it('attaches a logger to the request', async () => {
+    const augmentedLogger = { info: jest.fn() };
+    gasket.logger = { child: jest.fn().mockReturnValue(augmentedLogger) };
+    await plugin.hooks.createServers(gasket, {});
+
+    const req = {};
+    const res = {};
+    const next = jest.fn();
+
+    app.use.mock.calls.forEach(([middleware]) => middleware(req, res, next));
+    expect(req).toHaveProperty('logger', gasket.logger);
+
+    req.logger.metadata({ userId: '123' });
+    expect(gasket.logger.child).toHaveBeenCalledWith({ userId: '123' });
+
+    req.logger.info('test');
+    expect(augmentedLogger.info).toHaveBeenCalledWith('test');
   });
 
   function findCall(aSpy, aPredicate) {

packages/gasket-plugin-intl/lib/build-manifest.js

@@ -29,7 +29,7 @@ module.exports = async function buildManifest(gasket) {
     .filter(f => f !== manifestFilename);
 
   if (!files.length) {
-    logger.warning(`build:locales: No locale files found (${localesDir}).`);
+    logger?.warning?.(`build:locales: No locale files found (${localesDir}).`);
   }
 
   // generate a content hash for each file
@@ -57,9 +57,9 @@ module.exports = async function buildManifest(gasket) {
 
   try {
     await fs.writeFile(tgtFile, JSON.stringify(manifest), 'utf-8');
-    logger.log('build:locales: Wrote locales manifest.');
+    logger?.log?.('build:locales: Wrote locales manifest.');
   } catch (err) {
-    logger.error('build:locales: Unable to write locales manifest.');
+    logger?.error?.('build:locales: Unable to write locales manifest.');
     throw err;
   }
 };

packages/gasket-plugin-intl/lib/build-modules.js

@@ -133,7 +133,7 @@ class BuildModules {
       const pkgName = await this.getPackageName(srcDir);
       const tgtDir = path.join(this._outputDir, pkgName);
 
-      this._logger.log(`build:locales: Updating locale files for: ${pkgName}`);
+      this._logger?.log?.(`build:locales: Updating locale files for: ${pkgName}`);
 
       await fs.remove(tgtDir);
       await fs.mkdirp(tgtDir);
@@ -142,7 +142,7 @@ class BuildModules {
       await this.processFiles(srcDir, tgtDir, fileNames);
     }
 
-    this._logger.log(`build:locales: Completed locale files update.`);
+    this._logger?.log?.(`build:locales: Completed locale files update.`);
   }
 
   /**

packages/gasket-plugin-intl/lib/configure.js

@@ -32,9 +32,9 @@ function getIntlConfig(gasket) {
 function deprecatedOptions(gasket, intlConfig) {
   const { logger } = gasket;
   const { languageMap, defaultLanguage, assetPrefix } = intlConfig;
-  if (isDefined(languageMap)) logger.warning('DEPRECATED intl config `languageMap` - use `localesMap`');
-  if (isDefined(defaultLanguage)) logger.warning('DEPRECATED intl config `defaultLanguage` - use `defaultLocale`');
-  if (isDefined(assetPrefix)) logger.warning('DEPRECATED intl config `assetPrefix` - use `basePath`');
+  if (isDefined(languageMap)) logger?.warning?.('DEPRECATED intl config `languageMap` - use `localesMap`');
+  if (isDefined(defaultLanguage)) logger?.warning?.('DEPRECATED intl config `defaultLanguage` - use `defaultLocale`');
+  if (isDefined(assetPrefix)) logger?.warning?.('DEPRECATED intl config `assetPrefix` - use `basePath`');
   return { languageMap, defaultLanguage, assetPrefix };
 }
 

packages/gasket-plugin-intl/lib/index.js

@@ -12,7 +12,6 @@ const buildModules = require('./build-modules');
 const { getIntlConfig } = require('./configure');
 
 module.exports = {
-  dependencies: ['@gasket/plugin-log'],
   name,
   hooks: {
     init,

packages/gasket-plugin-intl/lib/middleware.js

@@ -142,7 +142,7 @@ function getPreferredLocale(gasket, req, locales, defaultLocale) {
       preferredLocale = formatLocale(accept.language(acceptLanguage, locales));
       debug(`Using ${preferredLocale} as starting locale`);
     } catch (error) {
-      gasket.logger.debug(`Unable to parse accept-language header: ${error.message}`);
+      gasket.logger?.debug?.(`Unable to parse accept-language header: ${error.message}`);
     }
   } else {
     debug(`No accept-language header; starting with default ${preferredLocale}`);

packages/gasket-plugin-intl/package.json

@@ -52,7 +52,6 @@
   },
   "devDependencies": {
     "@gasket/engine": "^6.43.0",
-    "@gasket/plugin-log": "^6.43.0",
     "@gasket/react-intl": "^6.42.0",
     "cross-env": "^7.0.3",
     "eslint": "^8.7.0",
@@ -66,9 +65,6 @@
     "setup-env": "^2.0.0",
     "webpack": "^5.21.2"
   },
-  "peerDependencies": {
-    "@gasket/plugin-log": "^6.0.0"
-  },
   "eslintConfig": {
     "extends": [
       "godaddy",

packages/gasket-plugin-logger/.eslintrc

@@ -0,0 +1,15 @@
+{
+  "extends": [
+    "godaddy-typescript",
+    "plugin:jest/recommended"
+  ],
+  "plugins": [
+    "unicorn",
+    "babel"
+  ],
+  "rules": {
+    "unicorn/filename-case": "error",
+    "no-redeclare": "off"
+  },
+  "ignorePatterns": "lib/*"
+}

packages/gasket-plugin-logger/.gitattributes

@@ -0,0 +1 @@
+package-lock.json binary

packages/gasket-plugin-logger/.gitignore

@@ -0,0 +1 @@
+lib

packages/gasket-plugin-logger/CHANGELOG.md

@@ -0,0 +1,3 @@
+# `@gasket/plugin-logger`
+
+- Initial release

packages/gasket-plugin-logger/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 GoDaddy Operating Company, LLC.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/gasket-plugin-logger/README.md

@@ -0,0 +1,48 @@
+# @gasket/plugin-logger
+
+Adds a logger to your Gasket application and introduces lifecycles for custom logger implementations. This plugin is included by default in all Gasket applications. At this time, there is only one plugin which implements a custom logger: `@gasket/plugin-winston`.
+
+## Lifecycles
+
+### createLogger
+
+To implement a custom logger, hook the `createLogger` lifecycle. Your hook, which may be asynchronous, must return an object with this shape:
+
+```typescript
+type Logger = {
+  [level: string]: (...args: Array<any>) => void,
+  child: (metadata: Object) => Logger,
+  close?: () => Promise<void> // Optional
+}
+```
+
+The `level` keys are the log levels that your logger supports. The values are functions that accept any number of arguments and write them to the log. Your logger must support, at minimum, the following levels:
+
+- `error`
+- `warn`
+- `info`
+- `verbose`
+- `debug`
+
+The `child` function is used to create a new logger with additional metadata. The `metadata` argument is set of properties that will be included in every log entry. The `child` function must return a new logger with the same shape as the parent logger.
+
+The `close` function, if supplied, is called when the application is shutting down and should be used to close any open resources.
+
+## Test
+
+If you are contributing to this plugin, use the following to run the tests:
+
+```shell
+npm test
+```
+
+## License
+
+[MIT](./LICENSE.md)
+
+<!-- LINKS -->
+
+[winston]: https://github.com/winstonjs/winston
+[winston documentation]: https://github.com/winstonjs/winston#creating-your-own-logger
+[@gasket/log]: /packages/gasket-log/README.md
+[Formats]: https://github.com/winstonjs/winston#formats

packages/gasket-plugin-logger/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node'
+};

packages/gasket-plugin-logger/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@gasket/plugin-logger",
+  "version": "6.43.0",
+  "description": "Gasket plugin for logging",
+  "main": "lib",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib",
+    "src"
+  ],
+  "scripts": {
+    "lint": "eslint ./src",
+    "lint:fix": "npm run lint -- --fix",
+    "test": "cross-env NODE_OPTIONS='--unhandled-rejections=strict' jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "posttest": "npm run lint",
+    "build": "tsc -P ./tsconfig.build.json",
+    "prepublishOnly": "npm test && npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/godaddy/gasket.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "gasket",
+    "plugin",
+    "logging"
+  ],
+  "author": "GoDaddy Operating Company, LLC",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/godaddy/gasket/issues"
+  },
+  "homepage": "https://github.com/godaddy/gasket/tree/main/packages/gasket-plugin-logger",
+  "devDependencies": {
+    "@gasket/engine": "^6.43.1",
+    "@gasket/plugin-command": "^6.43.0",
+    "@gasket/plugin-https": "^6.43.0",
+    "@gasket/plugin-metadata": "^6.43.1",
+    "@tsconfig/node18": "^18.2.2",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.55.0",
+    "eslint-config-godaddy-typescript": "^4.0.2",
+    "eslint-plugin-jest": "^27.6.0",
+    "eslint-plugin-unicorn": "^49.0.0",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.3.3"
+  }
+}