@cqrs-ddd/pipeline-rate-limit
Επιβάλλει πολιτικές περιορισμού ρυθμού (rate limiting) και quotas σε κατανεμημένα microservices. Συνεργάζεται με οποιονδήποτε limiter διαθέτει μέθοδο consume(), συμπεριλαμβανομένου του rate-limiter-flexible (Redis, Memory, PostgreSQL, MySQL).
Αιτήματα που υπερβαίνουν το quota απορρίπτονται πριν εκτελεστεί η επιχειρησιακή λογική, ρίχνοντας RateLimitExceededError το οποίο μεταφράζεται σε HTTP 429 Too Many Requests με υπολογισμένη επικεφαλίδα Retry-After.
Εγκατάσταση
Ενότητα με τίτλο «Εγκατάσταση»Συμβατό με όλους τους adapters του rate-limiter-flexible (RateLimiterRedis, RateLimiterMemory, RateLimiterPostgres, RateLimiterCluster).
Μοτίβα χρήσης
Ενότητα με τίτλο «Μοτίβα χρήσης»1. Plain Node.js / Μηχανή Pipeline
Ενότητα με τίτλο «1. Plain Node.js / Μηχανή Pipeline»2. Ενσωμάτωση NestJS (@cqrs-ddd/nestjs)
Ενότητα με τίτλο «2. Ενσωμάτωση NestJS (@cqrs-ddd/nestjs)»Καταχωρίστε το RateLimitBehavior σε ένα rate-limiting ή security module:
Διακοσμήστε handlers:
Το ErrorFilter αντιστοιχίζει αυτόματα το RateLimitExceededError σε HTTP 429 Too Many Requests και θέτει την επικεφαλίδα Retry-After: <seconds>.
Δυναμική κατανάλωση πόντων
Ενότητα με τίτλο «Δυναμική κατανάλωση πόντων»Αιτήματα μπορούν να καταναλώνουν διαφορετικό κόστος πόντων ανάλογα με το βάρος εκτέλεσης (π.χ. batch ενέργειες):
Διαχωρισμός κλειδιών (Partitioned Keys)
Ενότητα με τίτλο «Διαχωρισμός κλειδιών (Partitioned Keys)»Το createPartitionedRateLimitKeyFactory(partitionFn, options) κατασκευάζει κλειδιά στη μορφή <tenant>:<partition>:<requestName>:
| Επιλογή | Τύπος | Προεπιλογή | Περιγραφή |
|---|---|---|---|
onMissingPartition |
'throw' | 'request' |
'throw' |
Με 'throw', αιτήματα χωρίς ταυτοποιημένο καλούντα αποτυγχάνουν με MissingRateLimitPartitionError. Με 'request', μοιράζονται ένα bucket ανά αίτημα και tenant. |
includeTenant |
boolean |
true |
Προσαρτά το ενεργό tenant ID για αποφυγή διεκδίκησης quota μεταξύ tenants. |
requireTenant |
boolean |
includeTenant |
Ρίχνει MissingRateLimitPartitionError αν λείπει το tenant. |
Παραδείγματα:
- Αυθεντικοποιημένος χρήστης:
org_123:usr_456:searchCatalog - Διεύθυνση IP:
org_123:ip_192.168.1.1:searchCatalog
Επιλογές παραμετροποίησης
Ενότητα με τίτλο «Επιλογές παραμετροποίησης»| Επιλογή | Τύπος | Προεπιλογή | Περιγραφή |
|---|---|---|---|
keyFactory |
RateLimitKeyFactory |
υποχρεωτικό | Συνάρτηση παραγωγής του partition string. |
points |
number | ((ctx) => number) |
1 |
Κόστος πόντων για το αίτημα (ακέραιος $\ge 0$). Το 0 δεν καλεί τον limiter. |
keyPrefix |
string |
undefined |
Πρόσθετο πρόθεμα στο παραγόμενο κλειδί. |
limiter |
RateLimiterLike |
limiter του constructor | Παράκαμψη του προεπιλεγμένου limiter για τη συγκεκριμένη λειτουργία. |
failOpen |
boolean |
true |
Με true, σφάλματα του backend (π.χ. Redis offline) καταγράφουν log και επιτρέπουν την εκτέλεση. Με false, απορρίπτουν. |
Παρατηρησιμότητα
Ενότητα με τίτλο «Παρατηρησιμότητα»Το RateLimitBehavior καταγράφει στοιχεία στο context.items:
RATE_LIMIT_ITEM_TOKEN: το αποτέλεσμα του limiter με τους υπολειπόμενους πόντους και τα milliseconds μέχρι τον επόμενο πόντο.buildRateLimitAttributes(context):{ 'rate_limit.remaining_points': n }.
Μετατροπή σε HTTP απάντηση
Ενότητα με τίτλο «Μετατροπή σε HTTP απάντηση»Όταν εξαντληθούν οι πόντοι, ρίχνεται RateLimitExceededError: