@oneuptime/common 14.0.12 → 14.0.14

package/build/dist/Server/Middleware/{IncidentFormRateLimit.js → FormRateLimit.js}

@@ -6,10 +6,10 @@ import ObjectID from "../../Types/ObjectID";
 import ServiceUnavailableException from "../../Types/Exception/ServiceUnavailableException";
 import TooManyRequestsException from "../../Types/Exception/TooManyRequestsException";
 /*
- * Rate limiting for the public incident form routes:
+ * Rate limiting for the public form routes:
  *
- *   GET  /api/incident-form/public/:shareKey          (the form's questions)
- *   POST /api/incident-form/public/:shareKey/submit   (declare an incident)
+ *   GET  /api/form/public/:shareKey          (the form's questions)
+ *   POST /api/form/public/:shareKey/submit   (create from a submission)
  *
  * Both are anonymous: anyone holding a form's link can call them, from any
  * network, with no session and no API key. A sibling of
@@ -18,35 +18,40 @@ import TooManyRequestsException from "../../Types/Exception/TooManyRequestsExcep
  *
  *  - reading a form is load control, like reading a public dashboard;
  *
- *  - submitting one declares an incident, and every incident pages on-call.
- *    The counter there is not protecting a database from load, it is the
- *    only thing standing between a leaked link and a night of pages. So the
- *    submit budget is sized for people rather than for load, adds a ceiling
- *    per form that no number of addresses gets around, and refuses to serve
- *    at all when it cannot count (see getMiddleware).
+ *  - submitting one creates an incident or a maintenance event, and an
+ *    incident pages on-call. The counter there is not protecting a database
+ *    from load, it is the only thing standing between a leaked link and a
+ *    night of pages. So the submit budget is sized for people rather than
+ *    for load, adds a ceiling per form that no number of addresses gets
+ *    around, and refuses to serve at all when it cannot count (see
+ *    getMiddleware).
  *
  * The per-address counters are middleware, so a flood is refused before it
  * costs a session lookup, a Postgres read or a captcha round trip. Only the
- * routes' own-page checks come before them (IncidentFormAPI): a request
- * another site's page had a browser send, a read without the header the
- * form's page sends, or a submission that is not JSON, is refused without
- * being counted, so such a page cannot use up the budget its visitors'
- * addresses share. The per-form ceiling is not middleware at all:
- * IncidentFormService spends it (reserveFormSubmission) only for a
- * submission that has passed every other check - the form, its plan, its
- * IP allowlist, the captcha, the answers, the severity - right before the
- * incident is declared. It bounds incidents, so only a submission about to
- * become one may count against it; were every attempt to count, anyone
- * holding the link - even from outside the allowlist, or without solving
- * the captcha - could use it up with requests that are refused, and lock the
- * form for everybody.
+ * routes' own-page checks come before them (FormAPI): a request another
+ * site's page had a browser send, a read without the header the form's page
+ * sends, or a submission that is not JSON, is refused without being
+ * counted, so such a page cannot use up the budget its visitors' addresses
+ * share. The per-form ceiling is not middleware at all: FormService spends
+ * it (reserveFormSubmission) only for a submission that has passed every
+ * other check - the form, its plan, its IP allowlist, the captcha, the
+ * answers - right before the record is created. It bounds what submissions
+ * create, so only a submission about to create something may count against
+ * it; were every attempt to count, anyone holding the link - even from
+ * outside the allowlist, or without solving the captcha - could use it up
+ * with requests that are refused, and lock the form for everybody.
+ *
+ * The limits are read from FORM_* environment variables. Each one still
+ * falls back to the INCIDENT_FORM_* variable of the same name that incident
+ * forms read before Forms replaced them, so an install tuned for those keeps
+ * its limits.
  */
 /*
  * Which counter rejected a request. Every request that reaches the
- * middleware consumes the first two; a submission about to declare an
- * incident consumes the third:
+ * middleware consumes the first two; a submission about to create its
+ * record consumes the third:
  *
- *  - FormAndIp, keyed on the form + client address: the budget one reporter
+ *  - FormAndIp, keyed on the form + client address: the budget one submitter
  *    (or one office behind one NAT) gets on one form.
  *
  *  - Ip, keyed on the client address alone. Without it the first counter is
@@ -63,69 +68,76 @@ import TooManyRequestsException from "../../Types/Exception/TooManyRequestsExcep
  * one it rejects, so a client that keeps hammering keeps its window pinned
  * rather than being handed a fresh allowance for free.
  */
-export var IncidentFormRateLimitScope;
-(function (IncidentFormRateLimitScope) {
-    IncidentFormRateLimitScope["FormAndIp"] = "form-and-ip";
-    IncidentFormRateLimitScope["Ip"] = "ip";
-    IncidentFormRateLimitScope["Form"] = "form";
-})(IncidentFormRateLimitScope || (IncidentFormRateLimitScope = {}));
-export var IncidentFormRateLimitBucket;
-(function (IncidentFormRateLimitBucket) {
-    // GET /incident-form/public/:shareKey. Fails open.
-    IncidentFormRateLimitBucket["Read"] = "read";
-    // POST /incident-form/public/:shareKey/submit. Fails closed.
-    IncidentFormRateLimitBucket["Submit"] = "submit";
-})(IncidentFormRateLimitBucket || (IncidentFormRateLimitBucket = {}));
-export var IncidentFormRateLimitOutcome;
-(function (IncidentFormRateLimitOutcome) {
-    IncidentFormRateLimitOutcome["Allowed"] = "allowed";
-    IncidentFormRateLimitOutcome["RateLimited"] = "rate-limited";
+export var FormRateLimitScope;
+(function (FormRateLimitScope) {
+    FormRateLimitScope["FormAndIp"] = "form-and-ip";
+    FormRateLimitScope["Ip"] = "ip";
+    FormRateLimitScope["Form"] = "form";
+})(FormRateLimitScope || (FormRateLimitScope = {}));
+export var FormRateLimitBucket;
+(function (FormRateLimitBucket) {
+    // GET /form/public/:shareKey. Fails open.
+    FormRateLimitBucket["Read"] = "read";
+    // POST /form/public/:shareKey/submit. Fails closed.
+    FormRateLimitBucket["Submit"] = "submit";
+})(FormRateLimitBucket || (FormRateLimitBucket = {}));
+export var FormRateLimitOutcome;
+(function (FormRateLimitOutcome) {
+    FormRateLimitOutcome["Allowed"] = "allowed";
+    FormRateLimitOutcome["RateLimited"] = "rate-limited";
     // Redis is unreachable, so no limit can be honoured either way.
-    IncidentFormRateLimitOutcome["CounterUnavailable"] = "counter-unavailable";
-})(IncidentFormRateLimitOutcome || (IncidentFormRateLimitOutcome = {}));
+    FormRateLimitOutcome["CounterUnavailable"] = "counter-unavailable";
+})(FormRateLimitOutcome || (FormRateLimitOutcome = {}));
 /*
  * What a refused caller is told. None of them names a number: the limits are
  * for the operator to tune, not for a caller to pace itself against.
  */
-export const INCIDENT_FORM_READ_RATE_LIMIT_MESSAGE = "Too many requests. Please try again later.";
-export const INCIDENT_FORM_SUBMIT_RATE_LIMIT_MESSAGE = "Too many submissions from your network. Please wait a few minutes and try again.";
+export const FORM_READ_RATE_LIMIT_MESSAGE = "Too many requests. Please try again later.";
+export const FORM_SUBMIT_RATE_LIMIT_MESSAGE = "Too many submissions from your network. Please wait a few minutes and try again.";
 /*
  * The per-form ceiling is not about the caller's network at all, so it gets
  * its own words: telling someone whose first report this is that "your
  * network" sent too many would send them hunting for a problem they do not
  * have.
  */
-export const INCIDENT_FORM_TOTAL_RATE_LIMIT_MESSAGE = "This form is receiving too many reports right now. Please try again later.";
-export const INCIDENT_FORM_RATE_LIMIT_UNAVAILABLE_MESSAGE = "Reports cannot be accepted right now. Please try again in a few minutes.";
+export const FORM_TOTAL_RATE_LIMIT_MESSAGE = "This form is receiving too many submissions right now. Please try again later.";
+export const FORM_RATE_LIMIT_UNAVAILABLE_MESSAGE = "Submissions cannot be accepted right now. Please try again in a few minutes.";
 /*
  * A submission the per-form ceiling refused. Thrown from inside
- * IncidentFormService (reserveFormSubmission), where there is no response to
+ * FormService (reserveFormSubmission), where there is no response to
  * write a header on, so it carries when to come back; the submit route
  * writes that as Retry-After (setRetryAfterFor) before the error handler
  * answers 429.
  */
-export class IncidentFormCeilingException extends TooManyRequestsException {
+export class FormCeilingException extends TooManyRequestsException {
     constructor(retryAfterSeconds) {
-        super(INCIDENT_FORM_TOTAL_RATE_LIMIT_MESSAGE);
+        super(FORM_TOTAL_RATE_LIMIT_MESSAGE);
         this.retryAfterSeconds = retryAfterSeconds;
     }
 }
-const parsePositiveIntFromEnv = (envKey, fallback) => {
-    const rawValue = process.env[envKey];
+const parsePositiveInt = (rawValue) => {
     if (!rawValue) {
-        return fallback;
+        return null;
     }
     const parsedValue = parseInt(rawValue, 10);
     if (!Number.isFinite(parsedValue) || parsedValue <= 0) {
-        return fallback;
+        return null;
     }
     return parsedValue;
 };
+/*
+ * A limit from the environment: FORM_<name>, else the INCIDENT_FORM_<name>
+ * incident forms read (see the note at the top), else the default.
+ */
+const parsePositiveIntFromEnv = (name, fallback) => {
+    var _a, _b;
+    return ((_b = (_a = parsePositiveInt(process.env[`FORM_${name}`])) !== null && _a !== void 0 ? _a : parsePositiveInt(process.env[`INCIDENT_FORM_${name}`])) !== null && _b !== void 0 ? _b : fallback);
+};
 /*
  * Read budget: 120 per minute per form + address, 600 per minute per
  * address.
  *
- * The page asks for the form once when it opens, so a real reporter uses one
+ * The page asks for the form once when it opens, so a real submitter uses one
  * or two of these. The headroom is for a whole office behind one NAT opening
  * the same link during an outage - which is exactly when a form gets used -
  * and the per-address ceiling for that office opening several forms. What
@@ -133,21 +145,22 @@ const parsePositiveIntFromEnv = (envKey, fallback) => {
  * operators who want it tighter have the environment variables.
  */
 const READ_BUCKET = {
-    windowSeconds: parsePositiveIntFromEnv("INCIDENT_FORM_RATE_LIMIT_WINDOW_SECONDS", 60),
-    perFormAndIpLimit: parsePositiveIntFromEnv("INCIDENT_FORM_RATE_LIMIT_PER_FORM_AND_IP_PER_WINDOW", 120),
-    perIpLimit: parsePositiveIntFromEnv("INCIDENT_FORM_RATE_LIMIT_PER_IP_PER_WINDOW", 600),
+    windowSeconds: parsePositiveIntFromEnv("RATE_LIMIT_WINDOW_SECONDS", 60),
+    perFormAndIpLimit: parsePositiveIntFromEnv("RATE_LIMIT_PER_FORM_AND_IP_PER_WINDOW", 120),
+    perIpLimit: parsePositiveIntFromEnv("RATE_LIMIT_PER_IP_PER_WINDOW", 600),
     failsClosed: false,
 };
 /*
  * Submit budget: 10 per 15 minutes per form + address, 30 per 15 minutes
- * per address, and 60 incidents per hour per form across every address.
+ * per address, and 60 records created per hour per form across every
+ * address.
  *
- * Sized for people. Ten reports to one form from one network in a quarter
+ * Sized for people. Ten submissions to one form from one network in a quarter
  * of an hour already covers a team that all saw the same outage, plus a few
  * attempts that failed validation (those count against the address budgets
  * - the middleware runs before the form is checked). The per-form ceiling
- * is the one that bounds pages: only a submission about to declare an
- * incident counts against it, so an hour of it is sixty incidents, far past
+ * is the one that bounds pages: only a submission about to create its
+ * incident (or event) counts against it, so an hour of it is sixty, far past
  * the point where more reports add information, and no number of addresses
  * raises it.
  *
@@ -157,20 +170,20 @@ const READ_BUCKET = {
  * allowance.
  */
 const SUBMIT_BUCKET = {
-    windowSeconds: parsePositiveIntFromEnv("INCIDENT_FORM_SUBMIT_RATE_LIMIT_WINDOW_SECONDS", 15 * 60),
-    perFormAndIpLimit: parsePositiveIntFromEnv("INCIDENT_FORM_SUBMIT_RATE_LIMIT_PER_FORM_AND_IP_PER_WINDOW", 10),
-    perIpLimit: parsePositiveIntFromEnv("INCIDENT_FORM_SUBMIT_RATE_LIMIT_PER_IP_PER_WINDOW", 30),
+    windowSeconds: parsePositiveIntFromEnv("SUBMIT_RATE_LIMIT_WINDOW_SECONDS", 15 * 60),
+    perFormAndIpLimit: parsePositiveIntFromEnv("SUBMIT_RATE_LIMIT_PER_FORM_AND_IP_PER_WINDOW", 10),
+    perIpLimit: parsePositiveIntFromEnv("SUBMIT_RATE_LIMIT_PER_IP_PER_WINDOW", 30),
     perForm: {
-        windowSeconds: parsePositiveIntFromEnv("INCIDENT_FORM_SUBMIT_RATE_LIMIT_PER_FORM_WINDOW_SECONDS", 60 * 60),
-        limit: parsePositiveIntFromEnv("INCIDENT_FORM_SUBMIT_RATE_LIMIT_PER_FORM_PER_WINDOW", 60),
+        windowSeconds: parsePositiveIntFromEnv("SUBMIT_RATE_LIMIT_PER_FORM_WINDOW_SECONDS", 60 * 60),
+        limit: parsePositiveIntFromEnv("SUBMIT_RATE_LIMIT_PER_FORM_PER_WINDOW", 60),
     },
     failsClosed: true,
 };
 /*
- * Redis namespace for every counter here, so a SCAN for incident form keys
+ * Redis namespace for every counter here, so a SCAN for form keys
  * never shows another surface's, and the two surfaces never share a count.
  */
-const KEY_PREFIX = "iform:rl:";
+const KEY_PREFIX = "form:rl:";
 /*
  * Counter keys outlive their window by one full window, so a request landing
  * on a boundary cannot read a key that was reclaimed mid-window.
@@ -180,10 +193,10 @@ const TTL_MULTIPLIER = 2;
 const MAX_KEY_SEGMENT_LENGTH = 64;
 // How often the "counter unavailable" condition may be logged, per bucket.
 const COUNTER_UNAVAILABLE_LOG_INTERVAL_MS = 60 * 1000;
-class IncidentFormRateLimit {
+class FormRateLimit {
     // The limits in force for a bucket, for tests and operators' diagnostics.
     static getBucketConfig(bucket) {
-        const config = IncidentFormRateLimit.getConfig(bucket);
+        const config = FormRateLimit.getConfig(bucket);
         return Object.assign(Object.assign({}, config), { perForm: config.perForm ? Object.assign({}, config.perForm) : undefined });
     }
     /*
@@ -192,14 +205,14 @@ class IncidentFormRateLimit {
      * The shared ClientIp helper reads X-Forwarded-For from the trusted
      * (right-hand) end under the instance-wide TRUSTED_PROXY_HOPS setting -
      * never the leftmost entry, which any caller can set, and which would hand
-     * a caller a fresh bucket per request. It is also what IncidentFormService
+     * a caller a fresh bucket per request. It is also what FormService
      * checks the form's IP allowlist against, so the limiter and the allowlist
      * always agree on who is calling.
      */
     static resolveClientIp(req) {
         const clientIp = resolveTrustedClientIp(req);
         if (clientIp) {
-            return IncidentFormRateLimit.sanitizeKeySegment(clientIp);
+            return FormRateLimit.sanitizeKeySegment(clientIp);
         }
         /*
          * No address at all. Everything in this state shares one bucket, which
@@ -218,16 +231,16 @@ class IncidentFormRateLimit {
      * not split a bucket, or varying them would be a way around the limit.
      *
      * The key is used as it is rather than hashed: a share key sits in an
-     * address bar and in access logs by design (see IncidentForm.shareKey), so
+     * address bar and in access logs by design (see Form.shareKey), so
      * it is a link identifier like a public dashboard id, not a secret.
      */
     static resolveFormKey(req) {
         var _a;
-        return IncidentFormRateLimit.getFormKey((_a = req.params) === null || _a === void 0 ? void 0 : _a["shareKey"]);
+        return FormRateLimit.getFormKey((_a = req.params) === null || _a === void 0 ? void 0 : _a["shareKey"]);
     }
     /*
      * The key segment for a share key, however it was read: from the path by
-     * the middleware, or handed over by IncidentFormService when it spends the
+     * the middleware, or handed over by FormService when it spends the
      * form's ceiling - so both always count the same form under one key.
      */
     static getFormKey(shareKey) {
@@ -250,7 +263,7 @@ class IncidentFormRateLimit {
             .replace(/[^a-zA-Z0-9._:%\-[\]]/g, "_"));
     }
     static getConfig(bucket) {
-        if (bucket === IncidentFormRateLimitBucket.Submit) {
+        if (bucket === FormRateLimitBucket.Submit) {
             return SUBMIT_BUCKET;
         }
         return READ_BUCKET;
@@ -268,15 +281,15 @@ class IncidentFormRateLimit {
         var _a, _b;
         const client = Redis.getClient();
         if (!client || !Redis.isConnected()) {
-            return { outcome: IncidentFormRateLimitOutcome.CounterUnavailable };
+            return { outcome: FormRateLimitOutcome.CounterUnavailable };
         }
-        const config = IncidentFormRateLimit.getConfig(data.bucket);
+        const config = FormRateLimit.getConfig(data.bucket);
         const keyPrefix = `${KEY_PREFIX}${data.bucket}:`;
-        const windowIndex = IncidentFormRateLimit.getWindowIndex(config.windowSeconds);
+        const windowIndex = FormRateLimit.getWindowIndex(config.windowSeconds);
         const formAndIpCounterKey = `${keyPrefix}fi:${data.formKey}:${data.clientIp}:${windowIndex}`;
         const ipCounterKey = `${keyPrefix}i:${data.clientIp}:${windowIndex}`;
         try {
-            const addressCounts = await IncidentFormRateLimit.incrementCounters({
+            const addressCounts = await FormRateLimit.incrementCounters({
                 client,
                 keys: [formAndIpCounterKey, ipCounterKey],
                 windowSeconds: config.windowSeconds,
@@ -289,22 +302,22 @@ class IncidentFormRateLimit {
              * in a log line.
              */
             if (formAndIpCount > config.perFormAndIpLimit) {
-                return IncidentFormRateLimit.rejected({
-                    scope: IncidentFormRateLimitScope.FormAndIp,
+                return FormRateLimit.rejected({
+                    scope: FormRateLimitScope.FormAndIp,
                     count: formAndIpCount,
                     limit: config.perFormAndIpLimit,
                     windowSeconds: config.windowSeconds,
                 });
             }
             if (ipCount > config.perIpLimit) {
-                return IncidentFormRateLimit.rejected({
-                    scope: IncidentFormRateLimitScope.Ip,
+                return FormRateLimit.rejected({
+                    scope: FormRateLimitScope.Ip,
                     count: ipCount,
                     limit: config.perIpLimit,
                     windowSeconds: config.windowSeconds,
                 });
             }
-            return { outcome: IncidentFormRateLimitOutcome.Allowed };
+            return { outcome: FormRateLimitOutcome.Allowed };
         }
         catch (err) {
             /*
@@ -312,81 +325,81 @@ class IncidentFormRateLimit {
              * branch: whatever broke Redis is unlikely to break it for one request
              * only, and a per-request log line buries the incident it reports.
              */
-            if (IncidentFormRateLimit.shouldLogCounterUnavailable(data.bucket)) {
-                logger.warn(`IncidentFormRateLimit: counter failed for incident form ${data.formKey}`);
+            if (FormRateLimit.shouldLogCounterUnavailable(data.bucket)) {
+                logger.warn(`FormRateLimit: counter failed for form ${data.formKey}`);
                 logger.warn(err);
             }
-            return { outcome: IncidentFormRateLimitOutcome.CounterUnavailable };
+            return { outcome: FormRateLimitOutcome.CounterUnavailable };
         }
     }
     /*
-     * Count one incident against the form's ceiling - across every address,
+     * Count one submission against the form's ceiling - across every address,
      * per clock hour - and decide. For a submission that has passed every
-     * other check and is about to declare its incident; see
+     * other check and is about to create its record; see
      * reserveFormSubmission, which is what the service calls.
      */
     static async consumeFormCeiling(data) {
         var _a;
         const client = Redis.getClient();
         if (!client || !Redis.isConnected()) {
-            return { outcome: IncidentFormRateLimitOutcome.CounterUnavailable };
+            return { outcome: FormRateLimitOutcome.CounterUnavailable };
         }
         const ceiling = SUBMIT_BUCKET.perForm;
         if (!ceiling) {
-            return { outcome: IncidentFormRateLimitOutcome.Allowed };
+            return { outcome: FormRateLimitOutcome.Allowed };
         }
-        const formCounterKey = `${KEY_PREFIX}${IncidentFormRateLimitBucket.Submit}:f:${data.formKey}:${IncidentFormRateLimit.getWindowIndex(ceiling.windowSeconds)}`;
+        const formCounterKey = `${KEY_PREFIX}${FormRateLimitBucket.Submit}:f:${data.formKey}:${FormRateLimit.getWindowIndex(ceiling.windowSeconds)}`;
         try {
-            const formCounts = await IncidentFormRateLimit.incrementCounters({
+            const formCounts = await FormRateLimit.incrementCounters({
                 client,
                 keys: [formCounterKey],
                 windowSeconds: ceiling.windowSeconds,
             });
             const formCount = (_a = formCounts[0]) !== null && _a !== void 0 ? _a : 0;
             if (formCount > ceiling.limit) {
-                return IncidentFormRateLimit.rejected({
-                    scope: IncidentFormRateLimitScope.Form,
+                return FormRateLimit.rejected({
+                    scope: FormRateLimitScope.Form,
                     count: formCount,
                     limit: ceiling.limit,
                     windowSeconds: ceiling.windowSeconds,
                 });
             }
-            return { outcome: IncidentFormRateLimitOutcome.Allowed };
+            return { outcome: FormRateLimitOutcome.Allowed };
         }
         catch (err) {
-            if (IncidentFormRateLimit.shouldLogCounterUnavailable(IncidentFormRateLimitBucket.Submit)) {
-                logger.warn(`IncidentFormRateLimit: form ceiling counter failed for incident form ${data.formKey}`);
+            if (FormRateLimit.shouldLogCounterUnavailable(FormRateLimitBucket.Submit)) {
+                logger.warn(`FormRateLimit: form ceiling counter failed for form ${data.formKey}`);
                 logger.warn(err);
             }
-            return { outcome: IncidentFormRateLimitOutcome.CounterUnavailable };
+            return { outcome: FormRateLimitOutcome.CounterUnavailable };
         }
     }
     /*
-     * Spend one of the form's hourly incidents, or refuse: 429
-     * (IncidentFormCeilingException, carrying when to come back) once the
+     * Spend one of the form's hourly submissions, or refuse: 429
+     * (FormCeilingException, carrying when to come back) once the
      * hour's allowance is used, and 503 when the counter cannot be reached -
      * the ceiling is what bounds the pages a link can cause, so without it the
      * submission fails closed, as the submit middleware does.
      *
-     * Called by IncidentFormService.submitPublicForm right before it declares
-     * the incident, once the form, its plan, its IP allowlist, the captcha,
-     * the answers and the severity have all been checked: a refused request
-     * never spends it.
+     * Called by FormService.submitPublicForm right before it creates the
+     * submission's record, once the form, its plan, its IP allowlist, the
+     * captcha and the answers have all been checked: a refused request never
+     * spends it.
      */
     static async reserveFormSubmission(data) {
-        const formKey = IncidentFormRateLimit.getFormKey(data.shareKey);
-        const decision = await IncidentFormRateLimit.consumeFormCeiling({ formKey });
-        if (decision.outcome === IncidentFormRateLimitOutcome.RateLimited) {
+        const formKey = FormRateLimit.getFormKey(data.shareKey);
+        const decision = await FormRateLimit.consumeFormCeiling({ formKey });
+        if (decision.outcome === FormRateLimitOutcome.RateLimited) {
             if (decision.isFirstRejectionInWindow) {
-                logger.warn(`IncidentFormRateLimit: rejected a submission to incident form ${formKey} (${IncidentFormRateLimitScope.Form} limit)`);
+                logger.warn(`FormRateLimit: rejected a submission to form ${formKey} (${FormRateLimitScope.Form} limit)`);
             }
-            throw new IncidentFormCeilingException(decision.retryAfterSeconds || 1);
+            throw new FormCeilingException(decision.retryAfterSeconds || 1);
         }
-        if (decision.outcome === IncidentFormRateLimitOutcome.CounterUnavailable) {
-            if (IncidentFormRateLimit.shouldLogCounterUnavailable(IncidentFormRateLimitBucket.Submit)) {
-                logger.error(`IncidentFormRateLimit: rate limit counter unavailable, refusing incident form submissions (incident form ${formKey})`);
+        if (decision.outcome === FormRateLimitOutcome.CounterUnavailable) {
+            if (FormRateLimit.shouldLogCounterUnavailable(FormRateLimitBucket.Submit)) {
+                logger.error(`FormRateLimit: rate limit counter unavailable, refusing form submissions (form ${formKey})`);
             }
-            throw new ServiceUnavailableException(INCIDENT_FORM_RATE_LIMIT_UNAVAILABLE_MESSAGE);
+            throw new ServiceUnavailableException(FORM_RATE_LIMIT_UNAVAILABLE_MESSAGE);
         }
     }
     /*
@@ -395,8 +408,8 @@ class IncidentFormRateLimit {
      * own refusals. Anything else is left alone.
      */
     static setRetryAfterFor(res, error) {
-        if (error instanceof IncidentFormCeilingException) {
-            IncidentFormRateLimit.setRetryAfterHeader(res, error.retryAfterSeconds);
+        if (error instanceof FormCeilingException) {
+            FormRateLimit.setRetryAfterHeader(res, error.retryAfterSeconds);
         }
     }
     /*
@@ -417,7 +430,7 @@ class IncidentFormRateLimit {
             throw new Error("Rate limit pipeline returned no result");
         }
         const counts = data.keys.map((_key, index) => {
-            return IncidentFormRateLimit.readCounterResult(pipelineResults[index]);
+            return FormRateLimit.readCounterResult(pipelineResults[index]);
         });
         const keysToExpire = data.keys.filter((_key, index) => {
             return counts[index] === 1;
@@ -433,8 +446,8 @@ class IncidentFormRateLimit {
     }
     static rejected(data) {
         return {
-            outcome: IncidentFormRateLimitOutcome.RateLimited,
-            retryAfterSeconds: IncidentFormRateLimit.getSecondsUntilWindowEnd(data.windowSeconds),
+            outcome: FormRateLimitOutcome.RateLimited,
+            retryAfterSeconds: FormRateLimit.getSecondsUntilWindowEnd(data.windowSeconds),
             scope: data.scope,
             isFirstRejectionInWindow: data.count === data.limit + 1,
         };
@@ -470,13 +483,13 @@ class IncidentFormRateLimit {
     /*
      * The middleware only ever refuses on the per-address counters, so a
      * refused submission is always about the caller's network. (The form's
-     * own ceiling has its own words: see IncidentFormCeilingException.)
+     * own ceiling has its own words: see FormCeilingException.)
      */
     static getRateLimitedMessage(bucket) {
-        if (bucket === IncidentFormRateLimitBucket.Read) {
-            return INCIDENT_FORM_READ_RATE_LIMIT_MESSAGE;
+        if (bucket === FormRateLimitBucket.Read) {
+            return FORM_READ_RATE_LIMIT_MESSAGE;
         }
-        return INCIDENT_FORM_SUBMIT_RATE_LIMIT_MESSAGE;
+        return FORM_SUBMIT_RATE_LIMIT_MESSAGE;
     }
     /*
      * Express middleware, mounted on each public form route ahead of
@@ -484,26 +497,26 @@ class IncidentFormRateLimit {
      * the route rather than the router), so a flood is refused before it costs
      * a session lookup, let alone a Postgres read or a captcha check.
      */
-    static getMiddleware(bucket = IncidentFormRateLimitBucket.Read) {
+    static getMiddleware(bucket = FormRateLimitBucket.Read) {
         return async (req, res, next) => {
-            const config = IncidentFormRateLimit.getConfig(bucket);
-            const formKey = IncidentFormRateLimit.resolveFormKey(req);
-            const clientIp = IncidentFormRateLimit.resolveClientIp(req);
-            const decision = await IncidentFormRateLimit.consume({
+            const config = FormRateLimit.getConfig(bucket);
+            const formKey = FormRateLimit.resolveFormKey(req);
+            const clientIp = FormRateLimit.resolveClientIp(req);
+            const decision = await FormRateLimit.consume({
                 formKey,
                 clientIp,
                 bucket,
             });
-            if (decision.outcome === IncidentFormRateLimitOutcome.RateLimited) {
+            if (decision.outcome === FormRateLimitOutcome.RateLimited) {
                 if (decision.retryAfterSeconds) {
-                    IncidentFormRateLimit.setRetryAfterHeader(res, decision.retryAfterSeconds);
+                    FormRateLimit.setRetryAfterHeader(res, decision.retryAfterSeconds);
                 }
                 if (decision.isFirstRejectionInWindow) {
-                    logger.warn(`IncidentFormRateLimit: rejected ${bucket} request for incident form ${formKey} from ${clientIp} (${decision.scope} limit)`);
+                    logger.warn(`FormRateLimit: rejected ${bucket} request for form ${formKey} from ${clientIp} (${decision.scope} limit)`);
                 }
-                return Response.sendErrorResponse(req, res, new TooManyRequestsException(IncidentFormRateLimit.getRateLimitedMessage(bucket)));
+                return Response.sendErrorResponse(req, res, new TooManyRequestsException(FormRateLimit.getRateLimitedMessage(bucket)));
             }
-            if (decision.outcome === IncidentFormRateLimitOutcome.CounterUnavailable) {
+            if (decision.outcome === FormRateLimitOutcome.CounterUnavailable) {
                 /*
                  * The two buckets fail in opposite directions, on purpose.
                  *
@@ -519,13 +532,13 @@ class IncidentFormRateLimit {
                  * 503 and can send the report when Redis is back.
                  */
                 if (config.failsClosed) {
-                    if (IncidentFormRateLimit.shouldLogCounterUnavailable(bucket)) {
-                        logger.error(`IncidentFormRateLimit: rate limit counter unavailable, refusing incident form submissions (incident form ${formKey})`);
+                    if (FormRateLimit.shouldLogCounterUnavailable(bucket)) {
+                        logger.error(`FormRateLimit: rate limit counter unavailable, refusing form submissions (form ${formKey})`);
                     }
-                    return Response.sendErrorResponse(req, res, new ServiceUnavailableException(INCIDENT_FORM_RATE_LIMIT_UNAVAILABLE_MESSAGE));
+                    return Response.sendErrorResponse(req, res, new ServiceUnavailableException(FORM_RATE_LIMIT_UNAVAILABLE_MESSAGE));
                 }
-                if (IncidentFormRateLimit.shouldLogCounterUnavailable(bucket)) {
-                    logger.warn("IncidentFormRateLimit: rate limit counter unavailable, serving incident forms unthrottled");
+                if (FormRateLimit.shouldLogCounterUnavailable(bucket)) {
+                    logger.warn("FormRateLimit: rate limit counter unavailable, serving forms unthrottled");
                     logger.warn(getLogAttributesFromRequest(req));
                 }
             }
@@ -540,11 +553,11 @@ class IncidentFormRateLimit {
      */
     static shouldLogCounterUnavailable(bucket) {
         const now = Date.now();
-        const lastLoggedAt = IncidentFormRateLimit.counterUnavailableLastLoggedAt.get(bucket) || 0;
+        const lastLoggedAt = FormRateLimit.counterUnavailableLastLoggedAt.get(bucket) || 0;
         if (now - lastLoggedAt < COUNTER_UNAVAILABLE_LOG_INTERVAL_MS) {
             return false;
         }
-        IncidentFormRateLimit.counterUnavailableLastLoggedAt.set(bucket, now);
+        FormRateLimit.counterUnavailableLastLoggedAt.set(bucket, now);
         return true;
     }
     static setRetryAfterHeader(res, retryAfterSeconds) {
@@ -554,6 +567,6 @@ class IncidentFormRateLimit {
         }
     }
 }
-IncidentFormRateLimit.counterUnavailableLastLoggedAt = new Map();
-export default IncidentFormRateLimit;
-//# sourceMappingURL=IncidentFormRateLimit.js.map
+FormRateLimit.counterUnavailableLastLoggedAt = new Map();
+export default FormRateLimit;
+//# sourceMappingURL=FormRateLimit.js.map

package/build/dist/Server/Middleware/FormRateLimit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FormRateLimit.js","sourceRoot":"","sources":["../../../../Server/Middleware/FormRateLimit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAqB,MAAM,yBAAyB,CAAC;AAO5D,OAAO,MAAM,EAAE,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAC;AACtE,OAAO,sBAA+C,MAAM,mBAAmB,CAAC;AAChF,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,2BAA2B,MAAM,mDAAmD,CAAC;AAC5F,OAAO,wBAAwB,MAAM,gDAAgD,CAAC;AAEtF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAEH;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAN,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,+CAAyB,CAAA;IACzB,+BAAS,CAAA;IACT,mCAAa,CAAA;AACf,CAAC,EAJW,kBAAkB,KAAlB,kBAAkB,QAI7B;AAED,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAA0C;IAC1C,oCAAa,CAAA;IAEb,oDAAoD;IACpD,wCAAiB,CAAA;AACnB,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B;AAED,MAAM,CAAN,IAAY,oBAMX;AAND,WAAY,oBAAoB;IAC9B,2CAAmB,CAAA;IACnB,oDAA4B,CAAA;IAE5B,gEAAgE;IAChE,kEAA0C,CAAA;AAC5C,CAAC,EANW,oBAAoB,KAApB,oBAAoB,QAM/B;AAwCD;;;GAGG;AACH,MAAM,CAAC,MAAM,4BAA4B,GACvC,4CAA4C,CAAC;AAE/C,MAAM,CAAC,MAAM,8BAA8B,GACzC,kFAAkF,CAAC;AAErF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,6BAA6B,GACxC,gFAAgF,CAAC;AAEnF,MAAM,CAAC,MAAM,mCAAmC,GAC9C,8EAA8E,CAAC;AAEjF;;;;;;GAMG;AACH,MAAM,OAAO,oBAAqB,SAAQ,wBAAwB;IAGhE,YAAmB,iBAAyB;QAC1C,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACrC,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,gBAAgB,GAAoD,CACxE,QAA4B,EACb,EAAE;IACjB,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,WAAW,GAAW,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAEnD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,WAAW,IAAI,CAAC,EAAE,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,uBAAuB,GAA+C,CAC1E,IAAY,EACZ,QAAgB,EACR,EAAE;;IACV,OAAO,CACL,MAAA,MAAA,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,mCAC7C,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC,mCACtD,QAAQ,CACT,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,WAAW,GAA8B;IAC7C,aAAa,EAAE,uBAAuB,CAAC,2BAA2B,EAAE,EAAE,CAAC;IACvE,iBAAiB,EAAE,uBAAuB,CACxC,uCAAuC,EACvC,GAAG,CACJ;IACD,UAAU,EAAE,uBAAuB,CAAC,8BAA8B,EAAE,GAAG,CAAC;IACxE,WAAW,EAAE,KAAK;CACnB,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,aAAa,GAA8B;IAC/C,aAAa,EAAE,uBAAuB,CACpC,kCAAkC,EAClC,EAAE,GAAG,EAAE,CACR;IACD,iBAAiB,EAAE,uBAAuB,CACxC,8CAA8C,EAC9C,EAAE,CACH;IACD,UAAU,EAAE,uBAAuB,CACjC,qCAAqC,EACrC,EAAE,CACH;IACD,OAAO,EAAE;QACP,aAAa,EAAE,uBAAuB,CACpC,2CAA2C,EAC3C,EAAE,GAAG,EAAE,CACR;QACD,KAAK,EAAE,uBAAuB,CAAC,uCAAuC,EAAE,EAAE,CAAC;KAC5E;IACD,WAAW,EAAE,IAAI;CAClB,CAAC;AAEF;;;GAGG;AACH,MAAM,UAAU,GAAW,UAAU,CAAC;AAEtC;;;GAGG;AACH,MAAM,cAAc,GAAW,CAAC,CAAC;AAEjC,gEAAgE;AAChE,MAAM,sBAAsB,GAAW,EAAE,CAAC;AAE1C,2EAA2E;AAC3E,MAAM,mCAAmC,GAAW,EAAE,GAAG,IAAI,CAAC;AAE9D,MAAqB,aAAa;IAChC,0EAA0E;IACnE,MAAM,CAAC,eAAe,CAC3B,MAA2B;QAE3B,MAAM,MAAM,GAA8B,aAAa,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAE1E,uCACK,MAAM,KACT,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,mBAAM,MAAM,CAAC,OAAO,EAAG,CAAC,CAAC,SAAS,IAC3D;IACJ,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,eAAe,CAAC,GAAmB;QAC/C,MAAM,QAAQ,GAAuB,sBAAsB,CACzD,GAAqC,CACtC,CAAC;QAEF,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,aAAa,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACpD,CAAC;QAED;;;;WAIG;QACH,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,MAAM,CAAC,cAAc,CAAC,GAAmB;;QAC9C,OAAO,aAAa,CAAC,UAAU,CAAC,MAAA,GAAG,CAAC,MAAM,0CAAG,UAAU,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,QAAiB;QACxC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjE,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,MAAM,KAAK,GAAW,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEtC,IAAI,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,OAAO,KAAK,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;QACpC,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,MAAM,CAAC,kBAAkB,CAAC,KAAa;QAC7C,OAAO,CACL,KAAK;aACF,KAAK,CAAC,CAAC,EAAE,sBAAsB,CAAC;YACjC;;;eAGG;aACF,OAAO,CAAC,wBAAwB,EAAE,GAAG,CAAC,CAC1C,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,SAAS,CACtB,MAA2B;QAE3B,IAAI,MAAM,KAAK,mBAAmB,CAAC,MAAM,EAAE,CAAC;YAC1C,OAAO,aAAa,CAAC;QACvB,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAM3B;;QACC,MAAM,MAAM,GAAsB,KAAK,CAAC,SAAS,EAAE,CAAC;QAEpD,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YACpC,OAAO,EAAE,OAAO,EAAE,oBAAoB,CAAC,kBAAkB,EAAE,CAAC;QAC9D,CAAC;QAED,MAAM,MAAM,GAA8B,aAAa,CAAC,SAAS,CAC/D,IAAI,CAAC,MAAM,CACZ,CAAC;QAEF,MAAM,SAAS,GAAW,GAAG,UAAU,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC;QACzD,MAAM,WAAW,GAAW,aAAa,CAAC,cAAc,CACtD,MAAM,CAAC,aAAa,CACrB,CAAC;QAEF,MAAM,mBAAmB,GAAW,GAAG,SAAS,MAAM,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,IAAI,WAAW,EAAE,CAAC;QACrG,MAAM,YAAY,GAAW,GAAG,SAAS,KAAK,IAAI,CAAC,QAAQ,IAAI,WAAW,EAAE,CAAC;QAE7E,IAAI,CAAC;YACH,MAAM,aAAa,GACjB,MAAM,aAAa,CAAC,iBAAiB,CAAC;gBACpC,MAAM;gBACN,IAAI,EAAE,CAAC,mBAAmB,EAAE,YAAY,CAAC;gBACzC,aAAa,EAAE,MAAM,CAAC,aAAa;aACpC,CAAC,CAAC;YAEL,MAAM,cAAc,GAAW,MAAA,aAAa,CAAC,CAAC,CAAC,mCAAI,CAAC,CAAC;YACrD,MAAM,OAAO,GAAW,MAAA,aAAa,CAAC,CAAC,CAAC,mCAAI,CAAC,CAAC;YAE9C;;;;eAIG;YACH,IAAI,cAAc,GAAG,MAAM,CAAC,iBAAiB,EAAE,CAAC;gBAC9C,OAAO,aAAa,CAAC,QAAQ,CAAC;oBAC5B,KAAK,EAAE,kBAAkB,CAAC,SAAS;oBACnC,KAAK,EAAE,cAAc;oBACrB,KAAK,EAAE,MAAM,CAAC,iBAAiB;oBAC/B,aAAa,EAAE,MAAM,CAAC,aAAa;iBACpC,CAAC,CAAC;YACL,CAAC;YAED,IAAI,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;gBAChC,OAAO,aAAa,CAAC,QAAQ,CAAC;oBAC5B,KAAK,EAAE,kBAAkB,CAAC,EAAE;oBAC5B,KAAK,EAAE,OAAO;oBACd,KAAK,EAAE,MAAM,CAAC,UAAU;oBACxB,aAAa,EAAE,MAAM,CAAC,aAAa;iBACpC,CAAC,CAAC;YACL,CAAC;YAED,OAAO,EAAE,OAAO,EAAE,oBAAoB,CAAC,OAAO,EAAE,CAAC;QACnD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb;;;;eAIG;YACH,IAAI,aAAa,CAAC,2BAA2B,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3D,MAAM,CAAC,IAAI,CAAC,0CAA0C,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;gBACtE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACnB,CAAC;YAED,OAAO,EAAE,OAAO,EAAE,oBAAoB,CAAC,kBAAkB,EAAE,CAAC;QAC9D,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,IAGtC;;QACC,MAAM,MAAM,GAAsB,KAAK,CAAC,SAAS,EAAE,CAAC;QAEpD,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YACpC,OAAO,EAAE,OAAO,EAAE,oBAAoB,CAAC,kBAAkB,EAAE,CAAC;QAC9D,CAAC;QAED,MAAM,OAAO,GAAyC,aAAa,CAAC,OAAO,CAAC;QAE5E,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,EAAE,OAAO,EAAE,oBAAoB,CAAC,OAAO,EAAE,CAAC;QACnD,CAAC;QAED,MAAM,cAAc,GAAW,GAAG,UAAU,GAAG,mBAAmB,CAAC,MAAM,MAAM,IAAI,CAAC,OAAO,IAAI,aAAa,CAAC,cAAc,CACzH,OAAO,CAAC,aAAa,CACtB,EAAE,CAAC;QAEJ,IAAI,CAAC;YACH,MAAM,UAAU,GAAkB,MAAM,aAAa,CAAC,iBAAiB,CAAC;gBACtE,MAAM;gBACN,IAAI,EAAE,CAAC,cAAc,CAAC;gBACtB,aAAa,EAAE,OAAO,CAAC,aAAa;aACrC,CAAC,CAAC;YAEH,MAAM,SAAS,GAAW,MAAA,UAAU,CAAC,CAAC,CAAC,mCAAI,CAAC,CAAC;YAE7C,IAAI,SAAS,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;gBAC9B,OAAO,aAAa,CAAC,QAAQ,CAAC;oBAC5B,KAAK,EAAE,kBAAkB,CAAC,IAAI;oBAC9B,KAAK,EAAE,SAAS;oBAChB,KAAK,EAAE,OAAO,CAAC,KAAK;oBACpB,aAAa,EAAE,OAAO,CAAC,aAAa;iBACrC,CAAC,CAAC;YACL,CAAC;YAED,OAAO,EAAE,OAAO,EAAE,oBAAoB,CAAC,OAAO,EAAE,CAAC;QACnD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IACE,aAAa,CAAC,2BAA2B,CAAC,mBAAmB,CAAC,MAAM,CAAC,EACrE,CAAC;gBACD,MAAM,CAAC,IAAI,CACT,uDAAuD,IAAI,CAAC,OAAO,EAAE,CACtE,CAAC;gBACF,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACnB,CAAC;YAED,OAAO,EAAE,OAAO,EAAE,oBAAoB,CAAC,kBAAkB,EAAE,CAAC;QAC9D,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,IAEzC;QACC,MAAM,OAAO,GAAW,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEhE,MAAM,QAAQ,GACZ,MAAM,aAAa,CAAC,kBAAkB,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QAEtD,IAAI,QAAQ,CAAC,OAAO,KAAK,oBAAoB,CAAC,WAAW,EAAE,CAAC;YAC1D,IAAI,QAAQ,CAAC,wBAAwB,EAAE,CAAC;gBACtC,MAAM,CAAC,IAAI,CACT,gDAAgD,OAAO,KAAK,kBAAkB,CAAC,IAAI,SAAS,CAC7F,CAAC;YACJ,CAAC;YAED,MAAM,IAAI,oBAAoB,CAAC,QAAQ,CAAC,iBAAiB,IAAI,CAAC,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,QAAQ,CAAC,OAAO,KAAK,oBAAoB,CAAC,kBAAkB,EAAE,CAAC;YACjE,IACE,aAAa,CAAC,2BAA2B,CAAC,mBAAmB,CAAC,MAAM,CAAC,EACrE,CAAC;gBACD,MAAM,CAAC,KAAK,CACV,kFAAkF,OAAO,GAAG,CAC7F,CAAC;YACJ,CAAC;YAED,MAAM,IAAI,2BAA2B,CACnC,mCAAmC,CACpC,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,GAAoB,EAAE,KAAc;QACjE,IAAI,KAAK,YAAY,oBAAoB,EAAE,CAAC;YAC1C,aAAa,CAAC,mBAAmB,CAAC,GAAG,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACK,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAItC;QACC,MAAM,QAAQ,GAAuC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAE5E,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YAC5B,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;QAED,MAAM,eAAe,GACnB,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA0C,CAAC;QAEnE,IAAI,CAAC,eAAe,IAAI,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YAClE,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;QAED,MAAM,MAAM,GAAkB,IAAI,CAAC,IAAI,CAAC,GAAG,CACzC,CAAC,IAAY,EAAE,KAAa,EAAU,EAAE;YACtC,OAAO,aAAa,CAAC,iBAAiB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;QACjE,CAAC,CACF,CAAC;QAEF,MAAM,YAAY,GAAkB,IAAI,CAAC,IAAI,CAAC,MAAM,CAClD,CAAC,IAAY,EAAE,KAAa,EAAW,EAAE;YACvC,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC,CACF,CAAC;QAEF,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5B,MAAM,cAAc,GAClB,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YAEzB,KAAK,MAAM,GAAG,IAAI,YAAY,EAAE,CAAC;gBAC/B,cAAc,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,aAAa,GAAG,cAAc,CAAC,CAAC;YAClE,CAAC;YAED,MAAM,cAAc,CAAC,IAAI,EAAE,CAAC;QAC9B,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,MAAM,CAAC,QAAQ,CAAC,IAKvB;QACC,OAAO;YACL,OAAO,EAAE,oBAAoB,CAAC,WAAW;YACzC,iBAAiB,EAAE,aAAa,CAAC,wBAAwB,CACvD,IAAI,CAAC,aAAa,CACnB;YACD,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,wBAAwB,EAAE,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK,GAAG,CAAC;SACxD,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAC9B,MAA2C;QAE3C,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC3D,CAAC;QAED,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,MAAM,CAAC;QAE9B,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,KAAK,CAAC;QACd,CAAC;QAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACrE,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,aAAqB;QACjD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;OAMG;IACK,MAAM,CAAC,wBAAwB,CAAC,aAAqB;QAC3D,MAAM,QAAQ,GAAW,aAAa,GAAG,IAAI,CAAC;QAC9C,MAAM,YAAY,GAAW,IAAI,CAAC,GAAG,EAAE,GAAG,QAAQ,CAAC;QAEnD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,GAAG,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACK,MAAM,CAAC,qBAAqB,CAAC,MAA2B;QAC9D,IAAI,MAAM,KAAK,mBAAmB,CAAC,IAAI,EAAE,CAAC;YACxC,OAAO,4BAA4B,CAAC;QACtC,CAAC;QAED,OAAO,8BAA8B,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CACzB,SAA8B,mBAAmB,CAAC,IAAI;QAMtD,OAAO,KAAK,EACV,GAAmB,EACnB,GAAoB,EACpB,IAAkB,EACH,EAAE;YACjB,MAAM,MAAM,GAA8B,aAAa,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAC1E,MAAM,OAAO,GAAW,aAAa,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;YAC1D,MAAM,QAAQ,GAAW,aAAa,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;YAE5D,MAAM,QAAQ,GAA0B,MAAM,aAAa,CAAC,OAAO,CAAC;gBAClE,OAAO;gBACP,QAAQ;gBACR,MAAM;aACP,CAAC,CAAC;YAEH,IAAI,QAAQ,CAAC,OAAO,KAAK,oBAAoB,CAAC,WAAW,EAAE,CAAC;gBAC1D,IAAI,QAAQ,CAAC,iBAAiB,EAAE,CAAC;oBAC/B,aAAa,CAAC,mBAAmB,CAAC,GAAG,EAAE,QAAQ,CAAC,iBAAiB,CAAC,CAAC;gBACrE,CAAC;gBAED,IAAI,QAAQ,CAAC,wBAAwB,EAAE,CAAC;oBACtC,MAAM,CAAC,IAAI,CACT,2BAA2B,MAAM,qBAAqB,OAAO,SAAS,QAAQ,KAAK,QAAQ,CAAC,KAAK,SAAS,CAC3G,CAAC;gBACJ,CAAC;gBAED,OAAO,QAAQ,CAAC,iBAAiB,CAC/B,GAAG,EACH,GAAG,EACH,IAAI,wBAAwB,CAC1B,aAAa,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAC5C,CACF,CAAC;YACJ,CAAC;YAED,IAAI,QAAQ,CAAC,OAAO,KAAK,oBAAoB,CAAC,kBAAkB,EAAE,CAAC;gBACjE;;;;;;;;;;;;;mBAaG;gBACH,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;oBACvB,IAAI,aAAa,CAAC,2BAA2B,CAAC,MAAM,CAAC,EAAE,CAAC;wBACtD,MAAM,CAAC,KAAK,CACV,kFAAkF,OAAO,GAAG,CAC7F,CAAC;oBACJ,CAAC;oBAED,OAAO,QAAQ,CAAC,iBAAiB,CAC/B,GAAG,EACH,GAAG,EACH,IAAI,2BAA2B,CAC7B,mCAAmC,CACpC,CACF,CAAC;gBACJ,CAAC;gBAED,IAAI,aAAa,CAAC,2BAA2B,CAAC,MAAM,CAAC,EAAE,CAAC;oBACtD,MAAM,CAAC,IAAI,CACT,0EAA0E,CAC3E,CAAC;oBACF,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,GAAuB,CAAC,CAAC,CAAC;gBACpE,CAAC;YACH,CAAC;YAED,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,2BAA2B,CACxC,MAA2B;QAE3B,MAAM,GAAG,GAAW,IAAI,CAAC,GAAG,EAAE,CAAC;QAC/B,MAAM,YAAY,GAChB,aAAa,CAAC,8BAA8B,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEhE,IAAI,GAAG,GAAG,YAAY,GAAG,mCAAmC,EAAE,CAAC;YAC7D,OAAO,KAAK,CAAC;QACf,CAAC;QAED,aAAa,CAAC,8BAA8B,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAE9D,OAAO,IAAI,CAAC;IACd,CAAC;IAOO,MAAM,CAAC,mBAAmB,CAChC,GAAoB,EACpB,iBAAyB;QAEzB,MAAM,SAAS,GAAa,GAA0C,CACpE,WAAW,CACZ,CAAC;QAEF,IAAI,OAAO,SAAS,KAAK,UAAU,EAAE,CAAC;YACnC,SAAmD,CAAC,IAAI,CACvD,GAAG,EACH,aAAa,EACb,MAAM,CAAC,iBAAiB,CAAC,CAC1B,CAAC;QACJ,CAAC;IACH,CAAC;;AApBc,4CAA8B,GAGzC,IAAI,GAAG,EAAE,CAAC;eAphBK,aAAa"}

package/build/dist/Server/Services/AlertEpisodeService.js

@@ -15,6 +15,7 @@ import ObjectID from "../../Types/ObjectID";
 import Model from "../../Models/DatabaseModels/AlertEpisode";
 import SortOrder from "../../Types/BaseDatabase/SortOrder";
 import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
+import NumberPrefixUtil from "../../Utils/Project/NumberPrefix";
 import logger from "../Utils/Logger";
 import AlertEpisodeStateTimeline from "../../Models/DatabaseModels/AlertEpisodeStateTimeline";
 import AlertEpisodeStateTimelineService from "./AlertEpisodeStateTimelineService";
@@ -128,9 +129,7 @@ export class Service extends DatabaseService {
         // Auto-generate episode number
         const episodeCounterResult = await ProjectService.incrementAndGetAlertEpisodeCounter(projectId);
         createBy.data.episodeNumber = episodeCounterResult.counter;
-        createBy.data.episodeNumberWithPrefix = episodeCounterResult.prefix
-            ? `${episodeCounterResult.prefix}${episodeCounterResult.counter}`
-            : `#${episodeCounterResult.counter}`;
+        createBy.data.episodeNumberWithPrefix = NumberPrefixUtil.formatNumber(episodeCounterResult.prefix, episodeCounterResult.counter);
         // Set initial lastAlertAddedAt
         if (!createBy.data.lastAlertAddedAt) {
             createBy.data.lastAlertAddedAt = OneUptimeDate.getCurrentDate();