Merge pull request #1 from composable-software/feature/pino-logger

Add pino logger middleware

Author: mateuszperlak

.eslintrc.yml

@@ -0,0 +1,55 @@
+env:
+  es6: true
+  node: true
+  jest: true
+
+extends:
+  - 'standard'
+  - 'eslint:recommended'
+  - 'plugin:@typescript-eslint/eslint-recommended'
+  - 'plugin:@typescript-eslint/recommended'
+  - 'plugin:@typescript-eslint/recommended-requiring-type-checking'
+
+plugins:
+  - '@typescript-eslint'
+  - '@typescript-eslint/eslint-plugin'
+
+parser: '@typescript-eslint/parser'
+parserOptions:
+  ecmaVersion: 2018
+  sourceType: module
+  project: ['./tsconfig.eslint.json']
+
+rules:
+  '@typescript-eslint/member-delimiter-style': [ error, { multiline: { delimiter: none } } ]
+  '@typescript-eslint/explicit-function-return-type': off
+  '@typescript-eslint/no-non-null-assertion': off
+  '@typescript-eslint/no-misused-promises': off
+  '@typescript-eslint/require-await': off
+  '@typescript-eslint/no-unsafe-call': off
+  '@typescript-eslint/no-unsafe-assignment': off
+  padded-blocks: 0
+  operator-linebreak: [ error, before ]
+  comma-dangle: [ error, always-multiline ]
+  key-spacing: [ error, { align: value } ]
+  no-multi-spaces: 0
+  camelcase: 0
+  array-callback-return: 0
+  space-before-function-paren: 0
+  no-useless-constructor: 0
+  no-void: 0
+  no-console: 1
+  indent:
+    - error
+    - 2
+
+overrides:
+  - files: ['tests/**']
+    rules:
+      '@typescript-eslint/no-explicit-any': off
+      '@typescript-eslint/no-unsafe-assignment': off
+      '@typescript-eslint/no-unsafe-call': off
+      '@typescript-eslint/unbound-method': off
+      '@typescript-eslint/no-unsafe-return': off
+
+ignorePatterns: ['.eslintrc.yml', 'example']

.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+---
+name: "ci"
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  ci:
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install
+        run: yarn
+
+      - name: Build
+        run: yarn build
+
+      - name: Lint
+        run: yarn lint
+
+      - name: Test
+        run: yarn test

.gitignore

@@ -0,0 +1,5 @@
+node_modules/
+dist/
+.idea
+.vscode
+example

.npmignore

@@ -0,0 +1,9 @@
+src
+tests
+yarn.lock
+.eslintrc.yml
+.github
+npm-debug.log
+tsconfig.json
+tsconfig.eslint.json
+.idea

.release-it.json

@@ -0,0 +1,14 @@
+{
+  "git": {
+    "requireBranch": "master",
+    "commitMessage": "chore: release v${version}"
+  },
+  "github": {
+    "release": true,
+    "autoGenerate": true,
+    "web": true
+  },
+  "npm": {
+    "publish": false
+  }
+}

README.md

@@ -1 +1,106 @@
 # commercetools-pino-middleware
+
+![npm](https://img.shields.io/npm/v/@composable-commerce/commercetools-pino-middleware?color=blue) ![npm](https://img.shields.io/npm/l/@composable-commerce/commercetools-pino-middleware)
+
+## Overview
+
+`commercetools-pino-middleware` is a library that provides a seamless integration of Pino logger with the commercetools SDK. It allows you to easily log SDK requests, responses, and other relevant information with Pino, a fast and minimalist Node.js logger. The middleware is designed to be flexible and can be set up with either an auto-generated Pino instance or a custom Pino logger with specific configurations.
+
+## Installation
+
+You can install the library via npm:
+
+```bash
+npm install @composable-commerce/commercetools-pino-middleware
+```
+or with yarn
+```bash
+yarn add @composable-commerce/commercetools-pino-middleware
+```
+
+## Usage
+
+### 1. Using Auto-generated Pino Instance
+
+If you prefer a hassle-free setup, you can let the middleware create and configure the Pino instance for you. Simply pass an empty object when setting up the middleware:
+
+```javascript
+import { createPinoMiddleware } from 'commercetools-pino-middleware';
+import { ClientBuilder } from '@commercetools/sdk-client-v2';
+
+/**
+ * Middleware with automatic Pino factory
+ */
+const client = new ClientBuilder()
+  .withMiddleware(createPinoMiddleware({}))
+  .build();
+```
+
+In this method, the middleware will handle the instantiation and configuration of the Pino logger automatically.
+
+### 2. Using a Custom Pino Instance
+
+If you need a more customized Pino logger, you can pass your own Pino instance through options:
+
+```javascript
+import pino from 'pino';
+import { createPinoMiddleware } from 'commercetools-pino-middleware';
+import { ClientBuilder } from '@commercetools/sdk-client-v2';
+
+/**
+ * Custom Pino logger instance that can be passed to the middleware
+ */
+const logger = pino({
+  name: 'custom-logger',
+  level: 'info',
+});
+
+const options = {
+  logger: logger,
+};
+
+const client = new ClientBuilder()
+  .withMiddleware(createPinoMiddleware(options))
+  .build();
+```
+
+In this case, the middleware will use the provided Pino instance to log the information, allowing you to have full control over the logger's configuration.
+
+## Logging Details
+
+The `commercetools-pino-middleware` logs essential details related to SDK requests and responses, including:
+
+- Request method and URL
+- Request headers
+- Request body (if applicable)
+- Response status code
+- Response headers
+- Response body (if applicable)
+
+All logs are output in a structured JSON format, which makes it easy to parse and analyze the logged data.
+
+## Examples
+
+Here are some examples of how the middleware logs different scenarios:
+
+- **Successful Request:**
+
+```json
+{"level":"info","time":1678376443924,"msg":"Request sent","method":"POST","url":"https://api.commercetools.com/products","headers":{"Authorization":"Bearer <access_token>","Content-Type":"application/json"},"body":{"typeId":"product","id":"abc123","version":5}}
+{"level":"info","time":1678376453920,"msg":"Response received","status":201,"headers":{"x-request-id":"abc123","content-type":"application/json"},"body":{"id":"abc123","version":5}}
+```
+
+- **Failed Request:**
+
+```json
+{"level":"error","time":1678376463922,"msg":"Request failed","method":"GET","url":"https://api.commercetools.com/products/xyz789","headers":{"Authorization":"Bearer <access_token>"}}
+{"level":"error","time":1678376473923,"msg":"Response received with error","status":404,"headers":{"x-request-id":"xyz789"},"body":{"statusCode":404,"message":"Not Found"}}
+```
+
+## Contributing
+
+We welcome contributions from the community! If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request on our [GitHub repository](https://github.com/your-github-account/commercetools-pino-middleware).
+
+## License
+
+This library is licensed under the [MIT License](https://opensource.org/licenses/MIT). See the [LICENSE](./LICENSE) file for more details.

package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@composable-commerce/commercetools-pino-middleware",
+  "version": "1.0.0",
+  "description": "Pino logger for commercetools SDK",
+  "main": "dist/index.js",
+  "license": "MIT",
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "prepack": "yarn build",
+    "build": "tsc",
+    "release": "release-it",
+    "lint": "eslint \"{src,tests}/**/*.ts\" --fix",
+    "test": "jest --coverage"
+  },
+  "keywords": [
+    "commercetools",
+    "pino",
+    "middleware",
+    "logger"
+  ],
+  "homepage": "https://github.com/composable-software/commercetools-pino-middleware",
+  "bugs": "https://github.com/composable-software/commercetools-pino-middleware/issues",
+  "devDependencies": {
+    "@commercetools/sdk-client-v2": "^2.2.0",
+    "@types/jest": "^27.0.2",
+    "@types/node": "^16.10.2",
+    "@typescript-eslint/eslint-plugin": "^4.31.2",
+    "@typescript-eslint/parser": "^4.31.2",
+    "eslint": "^7.32.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-import": "^2.24.2",
+    "eslint-plugin-jest": "^24.4.2",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^5.1.0",
+    "jest": "^27.2.4",
+    "pino": "^8.14.1",
+    "rambda": "^8.2.0",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^27.0.5",
+    "type-fest": "^4.0.0",
+    "typescript": "^4.4.3"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "testRegex": "(/tests/(.*))\\.test.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "src/*.ts",
+      "src/**/*.ts"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  },
+  "peerDependencies": {
+    "pino": "^8.14.1"
+  }
+}

src/index.ts

@@ -0,0 +1,3 @@
+export * from './types'
+
+export { default as createPinoMiddleware } from './middleware'

src/logger.ts

@@ -0,0 +1,14 @@
+import pino, { Logger } from 'pino'
+
+import { PinoLoggerOptions } from './types'
+
+export const getLogger = (options: PinoLoggerOptions): Logger => {
+  if (options.logger) {
+    return options.logger
+  }
+
+  return pino({
+    name:  'commercetools',
+    level: 'info',
+  })
+}

src/middleware.ts

@@ -0,0 +1,19 @@
+import type { Middleware, Dispatch, MiddlewareRequest, MiddlewareResponse } from '@commercetools/sdk-client-v2'
+
+import type { PinoLoggerOptions, Logger } from './types'
+import { getLogger } from './logger'
+
+export default function createPinoMiddleware(options: PinoLoggerOptions): Middleware  {
+  return (next: Dispatch): Dispatch => (
+    request: MiddlewareRequest,
+    response: MiddlewareResponse,
+  ) => {
+    // pino factory
+    const logger: Logger = getLogger(options)
+
+    logger.info(request, 'request')
+    logger.info(response, 'response')
+
+    return next(request, response)
+  }
+}