Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
@node-idempotency/core
Advanced tools
A Race-Condition free Node.js library that ensures idempotency for requests, preventing unintended duplicate operations.
makes any request idempotent.
Network requests are unpredictable; clients/proxies may send duplicate or concurrent requests due to retries or network issues. To ensure smooth operation, servers must process each request only once. This package detects and handles duplicates, preventing issues like double charging the customer. It's:
and powers
@node-idempotency/nestjs
- Plug and Play nestjs
wrapper for @node-idempotency/core
@node-idempotency/express
- Plug and Play express
middleware for @node-idempotency/core
@node-idempotency/fastify
- Plug and Play fastify
plugin for @node-idempotency/core
if above packages dont meet your needs, you can utilise the core package directly to tweek it as per your needs.
npm i @node-idempotency/core
The flow for idempotency is simple, you call the onRequest
handler, when you receieve the request from clients before it reaches your business logic/controller.
onRequest
handler validates request for conflicts, figerprint missmatch, no idempotency-key(when idempotency is enforced) and gives back the response if the key is already seen, you typically give back the "cached" response to the client.
if its a new request, it marks the request as progress generates fingerprint using body
(so that it can validate conflicts for duplicate requests and figure out fingerprint missmatch), and returns undefined, you are responsible here to pass the request to your controller/business logic.
onResponse
handler is called by you when your business logic completes for the first time, so that the response can be stored and the request can be marked as complete.
import { Idempotency } from "@node-idempotency/core";
import { MemoryStorageAdapter } from "@node-idempotency/storage-adapter-memory";
// Create an Idempotency instance using a MemoryStorageAdapter
const idempotency = new Idempotency(new MemoryStorageAdapter(), {
...idempotencyOptions,
});
// On receiving a request, call `onRequest` to validate idempotency
try {
const response = await idempotency.onRequest({
method: "POST",
headers: { "idempotency-key": "123" },
body: { pay: 100 },
path: "/charge",
options: { ...idempotencyOptions }, // Optional request-level overrides
});
if (!response) {
// New request, allow it to proceed
return;
}
// Duplicate request, return previous response
// Example: res.status(response.additional.status).send(response.body)
} catch (err) {
// Handle idempotency errors (conflict, in-progress, fingerprint mismatch, etc.)
// Refer to API documentation for specific error codes
}
// Intercept response to complete the idempotency cycle
const response = await idempotency.onResponse(
{
method: "POST",
headers: { "idempotency-key": "123" },
body: { pay: 100 },
path: "/charge",
options: { ...idempotencyOptions }, // Optional request-level overrides
},
{
body: { charge: "success" }, // or error: your_error
additional: { status: 201 },
},
);
check details about the api here
FAQs
A Race-Condition free Node.js library that ensures idempotency for requests, preventing unintended duplicate operations.
The npm package @node-idempotency/core receives a total of 74 weekly downloads. As such, @node-idempotency/core popularity was classified as not popular.
We found that @node-idempotency/core demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers 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.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.