@dalet-oss/express-http-context 1.0.0-DEV → 1.2.0

package/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to `@dalet-oss/express-http-context` project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2023-03-06
+
+First stable version released after being tested in a production environment with intense traffic.
+
+### Fixed
+
+- Improved `README.md` file.
+- Improved variable names in TS typings.
+
+### Changed
+
+- Upgrade dependencies: Eslint plugins and Node.js types.
+
+## [0.0.1] - 2023-03-04
+
+### Added
+
+- First version.

package/lib/cjs/index.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.set = exports.get = exports.middleware = void 0;
+const async_hooks_1 = require("async_hooks");
+if (!global.expressHttpContextStorage) {
+    global.expressHttpContextStorage = new async_hooks_1.AsyncLocalStorage();
+}
+/**
+ * Express.js middleware that is responsible for initializing the context for each request.
+ */
+const middleware = (_req, _res, next) => {
+    global.expressHttpContextStorage.run(new Map(), () => next());
+};
+exports.middleware = middleware;
+/**
+ * Gets a value from the context by key.
+ * Will return undefined if the context has not yet been initialized for this request
+ * or if a value is not found for the specified key.
+ */
+function get(key) {
+    const store = global.expressHttpContextStorage.getStore();
+    return store?.get(key);
+}
+exports.get = get;
+/**
+ * Adds a value to the context by key.
+ * If the key already exists, its value will be overwritten.
+ * No value will persist if the context has not yet been initialized.
+ */
+function set(key, value) {
+    const store = global.expressHttpContextStorage.getStore();
+    store?.set(key, value);
+}
+exports.set = set;
+exports.default = { get, middleware: exports.middleware, set };
+//# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,6CAA+C;AAS/C,IAAI,CAAC,MAAM,CAAC,yBAAyB,EAAE;IACtC,MAAM,CAAC,yBAAyB,GAAG,IAAI,+BAAiB,EAAoB,CAAA;CAC5E;AAID;;GAEG;AACI,MAAM,UAAU,GAAmB,CACzC,IAAa,EACb,IAAc,EACd,IAAkB,EACX,EAAE;IACT,MAAM,CAAC,yBAAyB,CAAC,GAAG,CAAC,IAAI,GAAG,EAAE,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAA;AAC9D,CAAC,CAAA;AANY,QAAA,UAAU,cAMtB;AAED;;;;GAIG;AACH,SAAgB,GAAG,CAAU,GAAW;IAEvC,MAAM,KAAK,GAAG,MAAM,CAAC,yBAAyB,CAAC,QAAQ,EAAE,CAAC;IAE1D,OAAO,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,CAAA;AACvB,CAAC;AALD,kBAKC;AAED;;;;GAIG;AACH,SAAgB,GAAG,CAAU,GAAW,EAAE,KAAQ;IAEjD,MAAM,KAAK,GAAG,MAAM,CAAC,yBAAyB,CAAC,QAAQ,EAAE,CAAC;IAE1D,KAAK,EAAE,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;AACvB,CAAC;AALD,kBAKC;AAED,kBAAe,EAAE,GAAG,EAAE,UAAU,EAAV,kBAAU,EAAE,GAAG,EAAE,CAAA"}

package/lib/cjs/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "commonjs"
+}

package/lib/esm/index.js

@@ -0,0 +1,30 @@
+import { AsyncLocalStorage } from 'async_hooks';
+if (!global.expressHttpContextStorage) {
+    global.expressHttpContextStorage = new AsyncLocalStorage();
+}
+/**
+ * Express.js middleware that is responsible for initializing the context for each request.
+ */
+export const middleware = (_req, _res, next) => {
+    global.expressHttpContextStorage.run(new Map(), () => next());
+};
+/**
+ * Gets a value from the context by key.
+ * Will return undefined if the context has not yet been initialized for this request
+ * or if a value is not found for the specified key.
+ */
+export function get(key) {
+    const store = global.expressHttpContextStorage.getStore();
+    return store?.get(key);
+}
+/**
+ * Adds a value to the context by key.
+ * If the key already exists, its value will be overwritten.
+ * No value will persist if the context has not yet been initialized.
+ */
+export function set(key, value) {
+    const store = global.expressHttpContextStorage.getStore();
+    store?.set(key, value);
+}
+export default { get, middleware, set };
+//# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAS/C,IAAI,CAAC,MAAM,CAAC,yBAAyB,EAAE;IACtC,MAAM,CAAC,yBAAyB,GAAG,IAAI,iBAAiB,EAAoB,CAAA;CAC5E;AAID;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAmB,CACzC,IAAa,EACb,IAAc,EACd,IAAkB,EACX,EAAE;IACT,MAAM,CAAC,yBAAyB,CAAC,GAAG,CAAC,IAAI,GAAG,EAAE,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAA;AAC9D,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,UAAU,GAAG,CAAU,GAAW;IAEvC,MAAM,KAAK,GAAG,MAAM,CAAC,yBAAyB,CAAC,QAAQ,EAAE,CAAC;IAE1D,OAAO,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,CAAA;AACvB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,GAAG,CAAU,GAAW,EAAE,KAAQ;IAEjD,MAAM,KAAK,GAAG,MAAM,CAAC,yBAAyB,CAAC,QAAQ,EAAE,CAAC;IAE1D,KAAK,EAAE,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;AACvB,CAAC;AAED,eAAe,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,CAAA"}

package/lib/esm/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "module"
+}

package/lib/types/index.d.ts

@@ -0,0 +1,29 @@
+/// <reference types="node" />
+/// <reference types="qs" />
+import { AsyncLocalStorage } from 'async_hooks';
+import type { RequestHandler } from 'express';
+declare global {
+    var expressHttpContextStorage: AsyncLocalStorage<Map<string, any>>;
+}
+/**
+ * Express.js middleware that is responsible for initializing the context for each request.
+ */
+export declare const middleware: RequestHandler;
+/**
+ * Gets a value from the context by key.
+ * Will return undefined if the context has not yet been initialized for this request
+ * or if a value is not found for the specified key.
+ */
+export declare function get<T = any>(key: string): T | undefined;
+/**
+ * Adds a value to the context by key.
+ * If the key already exists, its value will be overwritten.
+ * No value will persist if the context has not yet been initialized.
+ */
+export declare function set<T = any>(key: string, value: T): void;
+declare const _default: {
+    get: typeof get;
+    middleware: RequestHandler<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>;
+    set: typeof set;
+};
+export default _default;

package/package.json

@@ -1,57 +1,102 @@
 {
-  "name": "@dalet-oss/express-http-context",
-  "version": "1.0.0-DEV",
-  "description": "Get and set request-scoped context anywhere",
-  "main": "index.js",
-  "browser": "browser.js",
-  "types": "./index.d.ts",
-  "engines": {
-    "node": ">=16.0.0"
-  },
-  "scripts": {
-    "test": "node --unhandled-rejections=strict ./node_modules/.bin/mocha --config test/.mocharc.json",
-    "cover": "nyc --reporter lcov --reporter text-summary _mocha --config test/.mocharc.json",
-    "coveralls": "npm run cover -- --report lcovonly && cat ./coverage/lcov.info | coveralls"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/dalet-oss/express-http-context.git"
-  },
-  "keywords": [
-    "express",
-    "http",
-    "request",
-    "context"
-  ],
-  "author": "Oliver Lockwood",
-  "contributors": [
-    "Oliver Lockwood (@oliverlockwood)",
-    "Steve Konves (@skonves)",
-    "Amiram Korach (@amiram)",
-    "Yoni Rabinovitch (@yonirab)",
-    "DontRelaX (@dontrelax)",
-    "William Durand (@willdurand)"
-  ],
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/dalet-oss/express-http-context/issues"
-  },
-  "homepage": "https://github.com/dalet-oss/express-http-context#readme",
-  "directories": {
-    "test": "test"
-  },
-  "dependencies": {
-    "@types/cls-hooked": "^4.2.1",
-    "@types/express": "^4.17.17",
-    "cls-hooked": "^4.2.2"
-  },
-  "devDependencies": {
-    "chai": "^4.3.7",
-    "coveralls": "^3.1.1",
-    "express": "^4.18.2",
-    "nyc": "^15.1.0",
-    "mocha": "^10.2.0",
-    "mocha-lcov-reporter": "^1.3.0",
-    "supertest": "^6.3.3"
-  }
+    "name": "@dalet-oss/express-http-context",
+    "version": "1.2.0",
+    "description": "Modern request-scoped storage support for Express.js based on Asynchronous Local Storage.",
+    "author": {
+        "name": "Dalet OSS",
+        "url": "https://github.com/dalet-oss"
+    },
+    "contributors": [
+        {
+            "name": "Oliver Lockwood",
+            "url": "https://github.com/oliverlockwood"
+        },
+        {
+            "name": "Alberto Varela",
+            "email": "hello@albertovarela.net",
+            "url": "https://www.albertovarela.net"
+        }
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/dalet-oss/express-http-context.git"
+    },
+    "bugs": {
+        "url": "https://github.com/dalet-oss/express-http-context/issues"
+    },
+    "homepage": "https://github.com/dalet-oss/express-http-context",
+    "license": "MIT",
+    "main": "lib/cjs/index.js",
+    "module": "lib/esm/index.js",
+    "typings": "lib/types/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./lib/types/index.d.ts",
+            "import": "./lib/esm/index.js",
+            "require": "./lib/cjs/index.js",
+            "default": "./lib/cjs/index.js"
+        }
+    },
+    "engines": {
+        "node": ">=14.0.0"
+    },
+    "files": [
+        "lib",
+        "src",
+        "CHANGELOG.md",
+        "LICENSE"
+    ],
+    "scripts": {
+        "build": "yarn clean && yarn compile",
+        "clean": "rm -rf lib/ .nyc_output/ coverage/",
+        "compile": "concurrently \"yarn compile:cjs\" \"yarn compile:esm\" \"yarn compile:types\" && ./scripts/fixup.sh",
+        "compile:cjs": "tsc -p tsconfig.cjs.json",
+        "compile:esm": "tsc -p tsconfig.esm.json",
+        "compile:types": "tsc -p tsconfig.types.json",
+        "coverage:html": "tap --coverage-report=html",
+        "coverage:cobertura": "tap --coverage-report=cobertura",
+        "hook:commit-msg": "commitlint -e",
+        "hook:pre-commit": "yarn qa",
+        "lint": "eslint .",
+        "prepack": "yarn qa && yarn build",
+        "qa": "yarn lint && yarn type-check && yarn test",
+        "test": "yarn clean && TS_NODE_PROJECT=tsconfig.json tap --node-arg=--require=ts-node/register",
+        "test:watch": "TS_NODE_PROJECT=tsconfig.json tap --node-arg=--require=ts-node/register --watch",
+        "type-check": "tsc -p tsconfig.json --noEmit"
+    },
+    "keywords": [
+        "express",
+        "middleware",
+        "plugin",
+        "request",
+        "context",
+        "http-context",
+        "request-context",
+        "express-http-context",
+        "express-request-context",
+        "asynchronouslocalstorage",
+        "asynchronous-local-storage"
+    ],
+    "devDependencies": {
+        "@commitlint/cli": "^17.8.1",
+        "@commitlint/config-conventional": "^17.8.1",
+        "@oliverlockwood/express-http-context-intermediate-library": "0.0.4",
+        "@types/express": "^4.17.21",
+        "@types/node": "^18.19.84",
+        "@types/supertest": "^2.0.16",
+        "@types/tap": "^15.0.12",
+        "@typescript-eslint/eslint-plugin": "^5.62.0",
+        "@typescript-eslint/parser": "^5.62.0",
+        "concurrently": "^7.6.0",
+        "eslint": "^8.35.0",
+        "eslint-config-prettier": "^8.10.0",
+        "eslint-plugin-import": "^2.31.0",
+        "express": "^4.21.2",
+        "nanoid": "3.3.4",
+        "prettier": "^2.8.8",
+        "supertest": "^6.3.4",
+        "tap": "^16.3.10",
+        "ts-node": "^10.9.2",
+        "typescript": "^4.9.5"
+    }
 }

package/src/index.ts

@@ -0,0 +1,51 @@
+import { AsyncLocalStorage } from 'async_hooks'
+import type { NextFunction, RequestHandler, Request, Response } from 'express'
+
+declare global {
+	// eslint-disable-next-line no-var
+	var expressHttpContextStorage: AsyncLocalStorage<Map<string, any>>;
+}
+
+
+if (!global.expressHttpContextStorage) {
+	global.expressHttpContextStorage = new AsyncLocalStorage<Map<string, any>>()
+}
+
+
+
+/**
+ * Express.js middleware that is responsible for initializing the context for each request.
+ */
+export const middleware: RequestHandler = (
+	_req: Request,
+	_res: Response,
+	next: NextFunction
+): void => {
+	global.expressHttpContextStorage.run(new Map(), () => next())
+}
+
+/**
+ * Gets a value from the context by key.
+ * Will return undefined if the context has not yet been initialized for this request
+ * or if a value is not found for the specified key.
+ */
+export function get<T = any>(key: string): T | undefined {
+
+	const store = global.expressHttpContextStorage.getStore();
+
+	return store?.get(key)
+}
+
+/**
+ * Adds a value to the context by key.
+ * If the key already exists, its value will be overwritten.
+ * No value will persist if the context has not yet been initialized.
+ */
+export function set<T = any>(key: string, value: T): void {
+
+	const store = global.expressHttpContextStorage.getStore();
+
+	store?.set(key, value)
+}
+
+export default { get, middleware, set }

package/browser.js

@@ -1,12 +0,0 @@
-module.exports = {
-  middleware: function (req, res, next) {
-    throw new Error('`middleware` cannot be called from the browser code.');
-  },
-  get: function () {
-    return null;
-  },
-  set: function (key, value) {
-    // noop
-  },
-  ns: null,
-};

package/index.d.ts

@@ -1,24 +0,0 @@
-import { Request, Response, NextFunction } from "express";
-import { Namespace } from 'cls-hooked';
-
-/** Express.js middleware that is responsible for initializing the context for each request. */
-export declare function middleware(
-  req: Request,
-  res: Response,
-  next: NextFunction
-): void;
-
-/**
- * Gets a value from the context by key.  Will return undefined if the context has not yet been initialized for this request or if a value is not found for the specified key.
- */
-export declare function get(key: string): any;
-
-/**
- * Adds a value to the context by key.  If the key already exists, its value will be overwritten.  No value will persist if the context has not yet been initialized.
- */
-export declare function set(key: string, value: any): void;
-
-/**
- * Gets the underlying continuation namespace.
- */
-export declare const ns: Namespace;

package/index.js

@@ -1,39 +0,0 @@
-'use strict';
-
-const cls = require('cls-hooked');
-
-const nsid = 'a6a29a6f-6747-4b5f-b99f-07ee96e32f88';
-const ns = cls.createNamespace(nsid);
-
-/** Express.js middleware that is responsible for initializing the context for each request. */
-function middleware(req, res, next) {
-	ns.run(() => next());
-}
-
-/**
- * Gets a value from the context by key.  Will return undefined if the context has not yet been initialized for this request or if a value is not found for the specified key.
- * @param {string} key
- */
-function get(key) {
-	if (ns && ns.active) {
-		return ns.get(key);
-	}
-}
-
-/**
- * Adds a value to the context by key.  If the key already exists, its value will be overwritten.  No value will persist if the context has not yet been initialized.
- * @param {string} key 
- * @param {*} value 
- */
-function set(key, value) {
-	if (ns && ns.active) {
-		return ns.set(key, value);
-	}
-}
-
-module.exports = {
-	middleware,
-	get: get,
-	set: set,
-	ns: ns
-};