Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
thread-context
Advanced tools
Readme
thread-context
This module is located at https://github.com/Aggtaa/thread-context. Any other location is either a fork or a copy.
This module helps to mitigate absense of "thread context" in node.js, where threads are missing. It utilizes cls-hooked
to access continuation local storage and provides a thin yet convenient wrapper around it.
It allows you to store data once and access it from any subsequent synchronous or asynchronous function call. Call stack from an express handler where every request can is given a unique ID makes a good example.
The usage is straightforward:
The threadContext
object that can be imported from the thread-context
module, is a Proxy
object with virtual getter and setter and implements undefined
type (for those of you using typescript). It allows storing data of any structure within one stack call ("thread")
You simply call threadContext.init()
once in the topmost function of a callstack (e.g. an express handler), giving a context a unique id. The id is later available as threadContext.threadId
.
Any read or write to threadContext
fields yields same result within one "thread" no matter how deep in call stack execution is.
The threadContext
"threads" are disposed automatically, there is nothing you need to do.
index.js
import debug from 'debug';
import express from 'express';
import { threadContext } from 'thread-context';
import { generateThreadReport } from './report';
import { generateSuperUniqueId } from './uniqueIdGenerator';
const app = new express.Express();
app.use(async (req, res, next) => {
// start a threadContext and give it a unique ID
await threadContext.init(generateSuperUniqueId());
// or simply threadContext.init();
// store some data for later
threadContext.requestMethod = req.method;
threadContext.requestPath = req.originalPath;
debug.log(`[${threadContext.threadId}] ${threadContext.requestMethod} ${threadContext.requestPath}: threadContext init`);
next();
});
app.get('/thread.json', (req, res, next) => {
res.json(generate);
});
app.get('/someOtherUrl', (req, res, next) => {
debug.log(`[${threadContext.threadId}] ${threadContext.requestMethod} ${threadContext.requestPath}: still in same threadContext`);
// ...
res.end();
});
report.js
import debug from 'debug';
import { threadContext as ctx } from 'thread-context';
export function generateThreadReport() {
debug.log(`[${ctx.threadId}] ${ctx.requestMethod} ${ctx.requestPath}: generating report`);
return {
threadId: ctx.threadId,
requestMethod: ctx.requestMethod,
requestPath: ctx.requestPath,
}
}
FAQs
"Thread context" emulation for Node.js based on continuation local storage
The npm package thread-context receives a total of 180 weekly downloads. As such, thread-context popularity was classified as not popular.
We found that thread-context demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.