@oneuptime/common 12.0.1 → 12.0.3

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

@@ -0,0 +1,401 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import DatabaseService from "./DatabaseService";
+import StatusPageMonitorRuleEngineService from "./StatusPageMonitorRuleEngineService";
+import StatusPageGroupService from "./StatusPageGroupService";
+import StatusPageResourceService from "./StatusPageResourceService";
+import StatusPageService from "./StatusPageService";
+import Model from "../../Models/DatabaseModels/StatusPageMonitorRule";
+import { LIMIT_PER_PROJECT } from "../../Types/Database/LimitMax";
+import BadDataException from "../../Types/Exception/BadDataException";
+import ObjectID from "../../Types/ObjectID";
+import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
+import ProjectScopedReferenceValidator, { resolveReferenceId, } from "../Utils/Database/ProjectScopedReferenceValidator";
+import StatusPageMonitorRulePatternValidator from "../Utils/StatusPage/MonitorRulePatternValidator";
+import logger from "../Utils/Logger";
+export class Service extends DatabaseService {
+    constructor() {
+        super(Model);
+    }
+    async onBeforeCreate(createBy) {
+        if (!createBy.data.statusPageId) {
+            throw new BadDataException("Status Page ID is required to create a status page monitor rule.");
+        }
+        this.assertHasMatchCriteria({
+            monitorLabelCount: (createBy.data.monitorLabels || []).length,
+            monitorNamePattern: createBy.data.monitorNamePattern,
+            monitorDescriptionPattern: createBy.data.monitorDescriptionPattern,
+        });
+        StatusPageMonitorRulePatternValidator.validate({
+            namePattern: createBy.data.monitorNamePattern,
+            descriptionPattern: createBy.data.monitorDescriptionPattern,
+        });
+        await this.assertReferencesAreInScope({
+            projectId: createBy.props.tenantId || createBy.data.projectId,
+            statusPageId: resolveReferenceId(createBy.data.statusPageId || createBy.data.statusPage),
+            statusPageGroupId: resolveReferenceId(createBy.data.statusPageGroupId || createBy.data.statusPageGroup),
+        });
+        return {
+            createBy: createBy,
+            carryForward: null,
+        };
+    }
+    async onCreateSuccess(_onCreate, createdItem) {
+        /*
+         * Backfill: a rule the user just wrote should populate the page with the
+         * monitors that already match, not only with ones created after it.
+         */
+        if (createdItem.id) {
+            await this.syncQuietly(createdItem.id);
+        }
+        return createdItem;
+    }
+    async onBeforeUpdate(updateBy) {
+        StatusPageMonitorRulePatternValidator.validate({
+            namePattern: updateBy.data.monitorNamePattern,
+            descriptionPattern: updateBy.data.monitorDescriptionPattern,
+        });
+        /*
+         * An edit can empty a rule out just as easily as a create can, and the
+         * result is the same useless rule. The merged view is what matters, so
+         * fields the edit does not mention are read back off the stored row -
+         * clearing only the labels on a rule that also has a name pattern is
+         * perfectly fine, and must not be refused.
+         */
+        await this.assertUpdateKeepsMatchCriteria(updateBy);
+        /*
+         * Re-pointing a rule at a different group is an ordinary edit, so the same
+         * scope checks the create path makes apply here. statusPageId is
+         * create-only in the column ACL, so only the group can move.
+         */
+        const nextGroupId = resolveReferenceId(updateBy.data["statusPageGroupId"] ||
+            updateBy.data["statusPageGroup"]);
+        if (nextGroupId) {
+            for (const rule of await this.findRulesForQuery(updateBy)) {
+                await this.assertReferencesAreInScope({
+                    projectId: updateBy.props.tenantId || rule.projectId,
+                    statusPageId: rule.statusPageId,
+                    statusPageGroupId: nextGroupId,
+                });
+            }
+        }
+        return { updateBy, carryForward: null };
+    }
+    async onUpdateSuccess(onUpdate, updatedItemIds) {
+        /*
+         * Every editable field on this model changes what the rule matches or how
+         * the resources it owns are rendered, so any edit re-runs the rule. The
+         * sync is idempotent, so re-running it after a no-op edit costs a read.
+         */
+        for (const id of updatedItemIds) {
+            await this.syncQuietly(id);
+        }
+        return onUpdate;
+    }
+    /**
+     * Deleting a rule undoes it: the resources it added go too, and the monitors
+     * it was publishing are offered to the rules that survive.
+     *
+     * Every destructive step lives here rather than in onBeforeDelete, because
+     * DatabaseService applies checkDeleteQueryPermission *after* onBeforeDelete.
+     * A hook there sees the caller's raw, un-tenant-scoped query, so a
+     * root-privileged write from it would let a caller destroy another project's
+     * status page resources by naming that project's rule id, with the
+     * permission check only rejecting the (already moot) rule delete afterwards.
+     * `itemIdsBeforeDelete` is the permission-checked set, so acting on it is
+     * safe.
+     *
+     * By this point the StatusPageResource -> StatusPageMonitorRule foreign key
+     * has usually already cascaded the resources away, which makes the removal
+     * pass belt-and-braces rather than the primary mechanism. It is kept so the
+     * behaviour does not depend on the cascade staying as it is — and it is also
+     * why the monitor ids come from carryForward: after the cascade there is
+     * nothing left to read them off.
+     */
+    async onDeleteSuccess(onDelete, itemIdsBeforeDelete) {
+        var _a;
+        const monitorIdsByRuleId = ((_a = onDelete.carryForward) === null || _a === void 0 ? void 0 : _a.monitorIdsByRuleId) || {};
+        for (const statusPageMonitorRuleId of itemIdsBeforeDelete) {
+            try {
+                await StatusPageMonitorRuleEngineService.removeResourcesAddedByRule({
+                    statusPageMonitorRuleId: statusPageMonitorRuleId,
+                });
+            }
+            catch (error) {
+                logger.error(`Error removing resources added by status page monitor rule ${statusPageMonitorRuleId.toString()}: ${error}`, {
+                    statusPageMonitorRuleId: statusPageMonitorRuleId.toString(),
+                });
+            }
+            /*
+             * Deleting a rule must behave like disabling one. Disabling routes
+             * through syncResourcesForRule, which hands each released monitor to the
+             * other rules on the page; without this, deleting would instead drop a
+             * monitor that a sibling rule still claims — the same rule, switched off
+             * two different ways, giving two different pages.
+             */
+            for (const monitorId of monitorIdsByRuleId[statusPageMonitorRuleId.toString()] || []) {
+                try {
+                    await StatusPageMonitorRuleEngineService.syncRulesForMonitor({
+                        monitorId: new ObjectID(monitorId),
+                        projectId: onDelete.deleteBy.props.tenantId,
+                    });
+                }
+                catch (error) {
+                    logger.error(`Error re-homing monitor ${monitorId} after status page monitor rule ${statusPageMonitorRuleId.toString()} was deleted: ${error}`, { monitorId: monitorId });
+                }
+            }
+        }
+        return onDelete;
+    }
+    /**
+     * Notes down which monitors each doomed rule is publishing, so
+     * onDeleteSuccess can offer them to the rules that survive.
+     *
+     * This has to happen before the delete because the StatusPageResource ->
+     * StatusPageMonitorRule foreign key is ON DELETE CASCADE: by the time the
+     * rule row is gone, so are the resources that named the monitors.
+     *
+     * It is READ ONLY, and reads through the caller's own props rather than as
+     * root. onBeforeDelete runs before checkDeleteQueryPermission, so anything
+     * here sees the caller's raw query — a root-privileged write from this hook
+     * would let a caller destroy another project's status page resources by
+     * naming that project's rule id.
+     */
+    async onBeforeDelete(deleteBy) {
+        const monitorIdsByRuleId = {};
+        try {
+            const rules = await this.findBy({
+                query: deleteBy.query,
+                select: {
+                    _id: true,
+                },
+                limit: LIMIT_PER_PROJECT,
+                skip: 0,
+                props: deleteBy.props,
+            });
+            for (const rule of rules) {
+                if (!rule.id) {
+                    continue;
+                }
+                const resources = await StatusPageResourceService.findBy({
+                    query: {
+                        statusPageMonitorRuleId: rule.id,
+                    },
+                    select: {
+                        monitorId: true,
+                    },
+                    limit: LIMIT_PER_PROJECT,
+                    skip: 0,
+                    props: {
+                        isRoot: true,
+                    },
+                });
+                monitorIdsByRuleId[rule.id.toString()] = resources
+                    .map((resource) => {
+                    var _a;
+                    return ((_a = resource.monitorId) === null || _a === void 0 ? void 0 : _a.toString()) || "";
+                })
+                    .filter((monitorId) => {
+                    return monitorId !== "";
+                });
+            }
+        }
+        catch (error) {
+            /*
+             * Best effort. Failing to note the monitors down must not block the
+             * delete; the worst case is that a sibling rule re-adopts them on its
+             * next run instead of immediately.
+             */
+            logger.error(`Error collecting monitors published by status page monitor rules before delete: ${error}`);
+        }
+        return { deleteBy, carryForward: { monitorIdsByRuleId } };
+    }
+    /**
+     * A rule points at a status page, and optionally at a group on that page.
+     * Neither is checked by the framework, and both decide what ends up on a
+     * PUBLIC page, so both are checked here:
+     *
+     *   - a status page from another project would let one tenant publish its
+     *     monitors on another tenant's status page;
+     *   - a group belonging to a different status page would produce resources
+     *     that render nowhere, because the page only draws groups that are its
+     *     own — a rule that silently adds invisible monitors.
+     */
+    async assertReferencesAreInScope(data) {
+        var _a;
+        await ProjectScopedReferenceValidator.validateReferencesBelongToProject({
+            projectId: data.projectId,
+            subject: "status page monitor rule",
+            references: [
+                {
+                    modelName: "Status Page",
+                    id: data.statusPageId,
+                    service: StatusPageService,
+                },
+                {
+                    modelName: "Status Page Group",
+                    id: data.statusPageGroupId,
+                    service: StatusPageGroupService,
+                },
+            ],
+        });
+        if (!data.statusPageGroupId || !data.statusPageId) {
+            return;
+        }
+        const group = await StatusPageGroupService.findOneById({
+            id: new ObjectID(data.statusPageGroupId.toString()),
+            select: {
+                _id: true,
+                statusPageId: true,
+            },
+            props: {
+                isRoot: true,
+            },
+        });
+        /*
+         * A group id that matches no row at all is left to the foreign key to
+         * report, the same call the project-scope validator above makes.
+         */
+        if (!group) {
+            return;
+        }
+        if (((_a = group.statusPageId) === null || _a === void 0 ? void 0 : _a.toString()) !== data.statusPageId.toString()) {
+            throw new BadDataException("The group this rule adds monitors to belongs to a different status page. Pick a group on the status page the rule is for.");
+        }
+    }
+    /**
+     * A rule with no criteria would claim every monitor in the project. An empty
+     * form is much more likely to be an unfinished one, and the cost of guessing
+     * wrong is a private monitor on a public page — so say so instead.
+     */
+    assertHasMatchCriteria(data) {
+        if (data.monitorLabelCount === 0 &&
+            !data.monitorNamePattern &&
+            !data.monitorDescriptionPattern) {
+            throw new BadDataException("A status page monitor rule needs at least one match criterion: monitor labels, a monitor name pattern, or a monitor description pattern. Use .* as the name pattern to match every monitor.");
+        }
+    }
+    /**
+     * The rules an update actually touches, read for validation.
+     *
+     * onBeforeUpdate runs before DatabaseService applies the update query's
+     * permission check, so the query here is still the caller's raw one. The
+     * tenant is pinned onto it when the caller has one, so a validation read can
+     * never reach across projects and answer questions about another tenant's
+     * rules. Genuinely root callers (the engines, migrations) have no tenantId
+     * and are trusted.
+     */
+    async findRulesForQuery(updateBy) {
+        const query = Object.assign({}, updateBy.query);
+        if (updateBy.props.tenantId) {
+            query["projectId"] = updateBy.props.tenantId;
+        }
+        return await this.findBy({
+            query: query,
+            select: {
+                _id: true,
+                projectId: true,
+                statusPageId: true,
+                monitorLabels: {
+                    _id: true,
+                },
+                monitorNamePattern: true,
+                monitorDescriptionPattern: true,
+            },
+            limit: LIMIT_PER_PROJECT,
+            skip: 0,
+            props: {
+                isRoot: true,
+            },
+        });
+    }
+    /**
+     * The create-time criteria check, applied to what the rule will look like
+     * after this edit. Every rule the edit touches has to survive it.
+     */
+    async assertUpdateKeepsMatchCriteria(updateBy) {
+        const touchesCriteria = updateBy.data.monitorLabels !== undefined ||
+            updateBy.data.monitorNamePattern !== undefined ||
+            updateBy.data.monitorDescriptionPattern !== undefined;
+        if (!touchesCriteria) {
+            return;
+        }
+        const rules = await this.findRulesForQuery(updateBy);
+        const nextLabels = updateBy.data
+            .monitorLabels;
+        for (const rule of rules) {
+            this.assertHasMatchCriteria({
+                monitorLabelCount: (nextLabels === undefined
+                    ? rule.monitorLabels || []
+                    : nextLabels).length,
+                monitorNamePattern: updateBy.data.monitorNamePattern === undefined
+                    ? rule.monitorNamePattern
+                    : updateBy.data.monitorNamePattern,
+                monitorDescriptionPattern: updateBy.data.monitorDescriptionPattern === undefined
+                    ? rule.monitorDescriptionPattern
+                    : updateBy.data.monitorDescriptionPattern,
+            });
+        }
+    }
+    /**
+     * Rule CRUD must not fail because the sync did. The rule is already saved
+     * and the next monitor change (or the next edit) re-runs it.
+     */
+    async syncQuietly(statusPageMonitorRuleId) {
+        try {
+            await StatusPageMonitorRuleEngineService.syncResourcesForRule({
+                statusPageMonitorRuleId: statusPageMonitorRuleId,
+            });
+        }
+        catch (error) {
+            logger.error(`Error syncing status page monitor rule ${statusPageMonitorRuleId.toString()}: ${error}`, {
+                statusPageMonitorRuleId: statusPageMonitorRuleId.toString(),
+            });
+        }
+    }
+}
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], Service.prototype, "onBeforeCreate", null);
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object, Model]),
+    __metadata("design:returntype", Promise)
+], Service.prototype, "onCreateSuccess", null);
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], Service.prototype, "onBeforeUpdate", null);
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object, Array]),
+    __metadata("design:returntype", Promise)
+], Service.prototype, "onUpdateSuccess", null);
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object, Array]),
+    __metadata("design:returntype", Promise)
+], Service.prototype, "onDeleteSuccess", null);
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], Service.prototype, "onBeforeDelete", null);
+export default new Service();
+//# sourceMappingURL=StatusPageMonitorRuleService.js.map

package/build/dist/Server/Services/StatusPageMonitorRuleService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StatusPageMonitorRuleService.js","sourceRoot":"","sources":["../../../../Server/Services/StatusPageMonitorRuleService.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,kCAAkC,MAAM,sCAAsC,CAAC;AACtF,OAAO,sBAAsB,MAAM,0BAA0B,CAAC;AAC9D,OAAO,yBAAyB,MAAM,6BAA6B,CAAC;AACpE,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AACpD,OAAO,KAAK,MAAM,mDAAmD,CAAC;AAOtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,gBAAgB,MAAM,wCAAwC,CAAC;AACtE,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,WAAW,MAAM,gCAAgC,CAAC;AACzD,OAAO,+BAA+B,EAAE,EACtC,kBAAkB,GACnB,MAAM,mDAAmD,CAAC;AAC3D,OAAO,qCAAqC,MAAM,iDAAiD,CAAC;AACpG,OAAO,MAAyB,MAAM,iBAAiB,CAAC;AAExD,MAAM,OAAO,OAAQ,SAAQ,eAAsB;IACjD;QACE,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;IAGwB,AAAN,KAAK,CAAC,cAAc,CACrC,QAAyB;QAEzB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YAChC,MAAM,IAAI,gBAAgB,CACxB,kEAAkE,CACnE,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,sBAAsB,CAAC;YAC1B,iBAAiB,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,MAAM;YAC7D,kBAAkB,EAAE,QAAQ,CAAC,IAAI,CAAC,kBAAkB;YACpD,yBAAyB,EAAE,QAAQ,CAAC,IAAI,CAAC,yBAAyB;SACnE,CAAC,CAAC;QAEH,qCAAqC,CAAC,QAAQ,CAAC;YAC7C,WAAW,EAAE,QAAQ,CAAC,IAAI,CAAC,kBAAkB;YAC7C,kBAAkB,EAAE,QAAQ,CAAC,IAAI,CAAC,yBAAyB;SAC5D,CAAC,CAAC;QAEH,MAAM,IAAI,CAAC,0BAA0B,CAAC;YACpC,SAAS,EAAE,QAAQ,CAAC,KAAK,CAAC,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS;YAC7D,YAAY,EAAE,kBAAkB,CAC9B,QAAQ,CAAC,IAAI,CAAC,YAAY,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,CACvD;YACD,iBAAiB,EAAE,kBAAkB,CACnC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,IAAI,QAAQ,CAAC,IAAI,CAAC,eAAe,CACjE;SACF,CAAC,CAAC;QAEH,OAAO;YACL,QAAQ,EAAE,QAAQ;YAClB,YAAY,EAAE,IAAI;SACnB,CAAC;IACJ,CAAC;IAGwB,AAAN,KAAK,CAAC,eAAe,CACtC,SAA0B,EAC1B,WAAkB;QAElB;;;WAGG;QACH,IAAI,WAAW,CAAC,EAAE,EAAE,CAAC;YACnB,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACzC,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAGwB,AAAN,KAAK,CAAC,cAAc,CACrC,QAAyB;QAEzB,qCAAqC,CAAC,QAAQ,CAAC;YAC7C,WAAW,EAAE,QAAQ,CAAC,IAAI,CAAC,kBAAwC;YACnE,kBAAkB,EAAE,QAAQ,CAAC,IAAI,CAAC,yBAErB;SACd,CAAC,CAAC;QAEH;;;;;;WAMG;QACH,MAAM,IAAI,CAAC,8BAA8B,CAAC,QAAQ,CAAC,CAAC;QAEpD;;;;WAIG;QACH,MAAM,WAAW,GAAkC,kBAAkB,CAClE,QAAQ,CAAC,IAAgC,CAAC,mBAAmB,CAAC;YAC5D,QAAQ,CAAC,IAAgC,CAAC,iBAAiB,CAAC,CAChE,CAAC;QAEF,IAAI,WAAW,EAAE,CAAC;YAChB,KAAK,MAAM,IAAI,IAAI,MAAM,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC1D,MAAM,IAAI,CAAC,0BAA0B,CAAC;oBACpC,SAAS,EAAE,QAAQ,CAAC,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS;oBACpD,YAAY,EAAE,IAAI,CAAC,YAAY;oBAC/B,iBAAiB,EAAE,WAAW;iBAC/B,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IAC1C,CAAC;IAGwB,AAAN,KAAK,CAAC,eAAe,CACtC,QAAyB,EACzB,cAA+B;QAE/B;;;;WAIG;QACH,KAAK,MAAM,EAAE,IAAI,cAAc,EAAE,CAAC;YAChC,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAC7B,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IAEsB,AAAN,KAAK,CAAC,eAAe,CACtC,QAAyB,EACzB,mBAAoC;;QAEpC,MAAM,kBAAkB,GAAkC,CAAA,MACxD,QAAQ,CAAC,YAGV,0CAAE,kBAAkB,KAAI,EAAE,CAAC;QAE5B,KAAK,MAAM,uBAAuB,IAAI,mBAAmB,EAAE,CAAC;YAC1D,IAAI,CAAC;gBACH,MAAM,kCAAkC,CAAC,0BAA0B,CAAC;oBAClE,uBAAuB,EAAE,uBAAuB;iBACjD,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAC,KAAK,CACV,8DAA8D,uBAAuB,CAAC,QAAQ,EAAE,KAAK,KAAK,EAAE,EAC5G;oBACE,uBAAuB,EAAE,uBAAuB,CAAC,QAAQ,EAAE;iBAC3C,CACnB,CAAC;YACJ,CAAC;YAED;;;;;;eAMG;YACH,KAAK,MAAM,SAAS,IAAI,kBAAkB,CACxC,uBAAuB,CAAC,QAAQ,EAAE,CACnC,IAAI,EAAE,EAAE,CAAC;gBACR,IAAI,CAAC;oBACH,MAAM,kCAAkC,CAAC,mBAAmB,CAAC;wBAC3D,SAAS,EAAE,IAAI,QAAQ,CAAC,SAAS,CAAC;wBAClC,SAAS,EAAE,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAgC;qBACpE,CAAC,CAAC;gBACL,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,CAAC,KAAK,CACV,2BAA2B,SAAS,mCAAmC,uBAAuB,CAAC,QAAQ,EAAE,iBAAiB,KAAK,EAAE,EACjI,EAAE,SAAS,EAAE,SAAS,EAAmB,CAC1C,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;OAaG;IAEsB,AAAN,KAAK,CAAC,cAAc,CACrC,QAAyB;QAEzB,MAAM,kBAAkB,GAAkC,EAAE,CAAC;QAE7D,IAAI,CAAC;YACH,MAAM,KAAK,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC;gBAC5C,KAAK,EAAE,QAAQ,CAAC,KAAK;gBACrB,MAAM,EAAE;oBACN,GAAG,EAAE,IAAI;iBACV;gBACD,KAAK,EAAE,iBAAiB;gBACxB,IAAI,EAAE,CAAC;gBACP,KAAK,EAAE,QAAQ,CAAC,KAAK;aACtB,CAAC,CAAC;YAEH,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;oBACb,SAAS;gBACX,CAAC;gBAED,MAAM,SAAS,GACb,MAAM,yBAAyB,CAAC,MAAM,CAAC;oBACrC,KAAK,EAAE;wBACL,uBAAuB,EAAE,IAAI,CAAC,EAAE;qBACjC;oBACD,MAAM,EAAE;wBACN,SAAS,EAAE,IAAI;qBAChB;oBACD,KAAK,EAAE,iBAAiB;oBACxB,IAAI,EAAE,CAAC;oBACP,KAAK,EAAE;wBACL,MAAM,EAAE,IAAI;qBACb;iBACF,CAAC,CAAC;gBAEL,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,SAAS;qBAC/C,GAAG,CAAC,CAAC,QAA4B,EAAE,EAAE;;oBACpC,OAAO,CAAA,MAAA,QAAQ,CAAC,SAAS,0CAAE,QAAQ,EAAE,KAAI,EAAE,CAAC;gBAC9C,CAAC,CAAC;qBACD,MAAM,CAAC,CAAC,SAAiB,EAAE,EAAE;oBAC5B,OAAO,SAAS,KAAK,EAAE,CAAC;gBAC1B,CAAC,CAAC,CAAC;YACP,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf;;;;eAIG;YACH,MAAM,CAAC,KAAK,CACV,mFAAmF,KAAK,EAAE,CAC3F,CAAC;QACJ,CAAC;QAED,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,kBAAkB,EAAE,EAAE,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;OAUG;IACK,KAAK,CAAC,0BAA0B,CAAC,IAIxC;;QACC,MAAM,+BAA+B,CAAC,iCAAiC,CAAC;YACtE,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,OAAO,EAAE,0BAA0B;YACnC,UAAU,EAAE;gBACV;oBACE,SAAS,EAAE,aAAa;oBACxB,EAAE,EAAE,IAAI,CAAC,YAAY;oBACrB,OAAO,EAAE,iBAAiB;iBAC3B;gBACD;oBACE,SAAS,EAAE,mBAAmB;oBAC9B,EAAE,EAAE,IAAI,CAAC,iBAAiB;oBAC1B,OAAO,EAAE,sBAAsB;iBAChC;aACF;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YAClD,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GACT,MAAM,sBAAsB,CAAC,WAAW,CAAC;YACvC,EAAE,EAAE,IAAI,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,CAAC;YACnD,MAAM,EAAE;gBACN,GAAG,EAAE,IAAI;gBACT,YAAY,EAAE,IAAI;aACnB;YACD,KAAK,EAAE;gBACL,MAAM,EAAE,IAAI;aACb;SACF,CAAC,CAAC;QAEL;;;WAGG;QACH,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO;QACT,CAAC;QAED,IAAI,CAAA,MAAA,KAAK,CAAC,YAAY,0CAAE,QAAQ,EAAE,MAAK,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC;YACpE,MAAM,IAAI,gBAAgB,CACxB,2HAA2H,CAC5H,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;OAIG;IACK,sBAAsB,CAAC,IAI9B;QACC,IACE,IAAI,CAAC,iBAAiB,KAAK,CAAC;YAC5B,CAAC,IAAI,CAAC,kBAAkB;YACxB,CAAC,IAAI,CAAC,yBAAyB,EAC/B,CAAC;YACD,MAAM,IAAI,gBAAgB,CACxB,6LAA6L,CAC9L,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACK,KAAK,CAAC,iBAAiB,CAC7B,QAAyB;QAEzB,MAAM,KAAK,qBACL,QAAQ,CAAC,KAAiC,CAC/C,CAAC;QAEF,IAAI,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YAC5B,KAAK,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC;QAC/C,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC;YACvB,KAAK,EAAE,KAAiC;YACxC,MAAM,EAAE;gBACN,GAAG,EAAE,IAAI;gBACT,SAAS,EAAE,IAAI;gBACf,YAAY,EAAE,IAAI;gBAClB,aAAa,EAAE;oBACb,GAAG,EAAE,IAAI;iBACV;gBACD,kBAAkB,EAAE,IAAI;gBACxB,yBAAyB,EAAE,IAAI;aAChC;YACD,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,CAAC;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,IAAI;aACb;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,8BAA8B,CAC1C,QAAyB;QAEzB,MAAM,eAAe,GACnB,QAAQ,CAAC,IAAI,CAAC,aAAa,KAAK,SAAS;YACzC,QAAQ,CAAC,IAAI,CAAC,kBAAkB,KAAK,SAAS;YAC9C,QAAQ,CAAC,IAAI,CAAC,yBAAyB,KAAK,SAAS,CAAC;QAExD,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAiB,MAAM,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAEnE,MAAM,UAAU,GAA+B,QAAQ,CAAC,IAAI;aACzD,aAA2C,CAAC;QAE/C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,sBAAsB,CAAC;gBAC1B,iBAAiB,EAAE,CAAC,UAAU,KAAK,SAAS;oBAC1C,CAAC,CAAC,IAAI,CAAC,aAAa,IAAI,EAAE;oBAC1B,CAAC,CAAC,UAAU,CACb,CAAC,MAAM;gBACR,kBAAkB,EAChB,QAAQ,CAAC,IAAI,CAAC,kBAAkB,KAAK,SAAS;oBAC5C,CAAC,CAAC,IAAI,CAAC,kBAAkB;oBACzB,CAAC,CAAE,QAAQ,CAAC,IAAI,CAAC,kBAAyC;gBAC9D,yBAAyB,EACvB,QAAQ,CAAC,IAAI,CAAC,yBAAyB,KAAK,SAAS;oBACnD,CAAC,CAAC,IAAI,CAAC,yBAAyB;oBAChC,CAAC,CAAE,QAAQ,CAAC,IAAI,CAAC,yBAAgD;aACtE,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,WAAW,CAAC,uBAAiC;QACzD,IAAI,CAAC;YACH,MAAM,kCAAkC,CAAC,oBAAoB,CAAC;gBAC5D,uBAAuB,EAAE,uBAAuB;aACjD,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CACV,0CAA0C,uBAAuB,CAAC,QAAQ,EAAE,KAAK,KAAK,EAAE,EACxF;gBACE,uBAAuB,EAAE,uBAAuB,CAAC,QAAQ,EAAE;aAC3C,CACnB,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAxb0B;IADxB,WAAW,EAAE;;;;6CAmCb;AAGwB;IADxB,WAAW,EAAE;;6CAGC,KAAK;;8CAWnB;AAGwB;IADxB,WAAW,EAAE;;;;6CAyCb;AAGwB;IADxB,WAAW,EAAE;;6CAGI,KAAK;;8CAYtB;AAuBwB;IADxB,WAAW,EAAE;;6CAGS,KAAK;;8CA+C3B;AAiBwB;IADxB,WAAW,EAAE;;;;6CAyDb;AA2LH,eAAe,IAAI,OAAO,EAAE,CAAC"}

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

@@ -61,6 +61,7 @@ import { MASTER_PASSWORD_COOKIE_IDENTIFIER, MASTER_PASSWORD_REQUIRED_MESSAGE, }
 import StatusPageGroupService from "./StatusPageGroupService";
 import StatusPageGroupTreeUtil from "../../Utils/StatusPage/GroupTree";
 import StatusPageReportTreeUtil from "../../Utils/StatusPage/Report";
+import StatusPageReportPeriodUtil from "../../Utils/StatusPage/ReportPeriod";
 export class Service extends DatabaseService {
     constructor() {
         super(StatusPage);
@@ -720,6 +721,7 @@ export class Service extends DatabaseService {
         }
         if (updateBy.data.reportStartDateTime ||
             updateBy.data.reportRecurringInterval ||
+            updateBy.data.reportTimezone ||
             updateBy.data.sendNextReportBy) {
             const statusPages = await this.findBy({
                 query: updateBy.query,
@@ -727,6 +729,7 @@ export class Service extends DatabaseService {
                     _id: true,
                     reportStartDateTime: true,
                     reportRecurringInterval: true,
+                    reportTimezone: true,
                 },
                 props: {
                     isRoot: true,
@@ -735,13 +738,26 @@ export class Service extends DatabaseService {
                 limit: LIMIT_PER_PROJECT,
             });
             for (const statusPage of statusPages) {
-                const rerportStartDate = updateBy.data.reportStartDateTime ||
+                const reportStartDate = updateBy.data.reportStartDateTime ||
                     statusPage.reportStartDateTime;
                 const reportRecurringInterval = Recurring.fromJSON(updateBy.data.reportRecurringInterval ||
                     statusPage.reportRecurringInterval);
-                if (rerportStartDate && reportRecurringInterval) {
-                    const nextReportDate = Recurring.getNextDate(rerportStartDate, reportRecurringInterval);
-                    updateBy.data.sendNextReportBy = nextReportDate;
+                if (reportStartDate && reportRecurringInterval) {
+                    /*
+                     * Calendar-correct rather than Recurring.getNextDate's fixed
+                     * millisecond approximation, which walks a monthly schedule anchored
+                     * on the 1st backwards to the 31st, then the 30th, and eventually
+                     * skips a month. Resolved in the report timezone so "the 1st at
+                     * 09:00" survives a DST transition.
+                     */
+                    updateBy.data.sendNextReportBy = Recurring.getNextDateAfter({
+                        startDate: reportStartDate,
+                        recurring: reportRecurringInterval,
+                        afterDate: OneUptimeDate.getCurrentDate(),
+                        timezone: updateBy.data.reportTimezone ||
+                            statusPage.reportTimezone ||
+                            StatusPageReportPeriodUtil.DEFAULT_TIMEZONE,
+                    });
                 }
             }
         }
@@ -750,6 +766,20 @@ export class Service extends DatabaseService {
             updateBy: updateBy,
         };
     }
+    /*
+     * The window the next report off this status page will cover. Static because
+     * the settings screen resolves the very same window from the very same
+     * columns to show the user what they are about to schedule.
+     */
+    static getReportPeriodForStatusPage(statusPage, sentAt) {
+        return StatusPageReportPeriodUtil.getReportPeriod({
+            periodType: statusPage.reportPeriodType,
+            reportRecurringInterval: statusPage.reportRecurringInterval,
+            reportDataInDays: statusPage.reportDataInDays,
+            timezone: statusPage.reportTimezone,
+            sentAt: sentAt,
+        });
+    }
     async sendEmailReport(data) {
         var _a, _b, _c, _d;
         const host = await DatabaseConfig.getHost();
@@ -769,7 +799,7 @@ export class Service extends DatabaseService {
         const statusPageIdString = ((_a = statuspage.id) === null || _a === void 0 ? void 0 : _a.toString()) || ((_b = statuspage._id) === null || _b === void 0 ? void 0 : _b.toString()) || null;
         const report = await this.getReportByStatusPage({
             statusPageId: statuspage.id,
-            historyDays: statuspage.reportDataInDays || 14,
+            reportPeriod: Service.getReportPeriodForStatusPage(statuspage),
         });
         /*
          * Look up a custom report email template for this status page (if any).
@@ -888,38 +918,42 @@ export class Service extends DatabaseService {
         const statusPageResources = await this.getStatusPageResources({
             statusPageId: data.statusPageId,
         });
-        const numberOfDays = data.historyDays || 14;
-        const endDate = OneUptimeDate.getCurrentDate();
-        const startDate = OneUptimeDate.getSomeDaysAgo(numberOfDays);
-        const startAndEndDate = `${numberOfDays} days (${OneUptimeDate.getDateAsUserFriendlyLocalFormattedString(startDate, true)} - ${OneUptimeDate.getDateAsUserFriendlyLocalFormattedString(endDate, true)})`;
+        const startDate = data.reportPeriod.startDate;
+        const endDate = data.reportPeriod.endDate;
         /*
-         * The report is explicitly "the last N days", so this window is what every uptime number
-         * below has to be measured against. It used to be computed only to fetch the timeline and
-         * was then discarded, which let an event that started before the window contribute its
-         * whole duration to the downtime total, and made the denominator "first event -> now"
-         * instead of the window - so the reported percentage drifted upwards every day.
+         * This window is what every uptime number below has to be measured against.
+         * It used to be computed only to fetch the timeline and was then discarded,
+         * which let an event that started before the window contribute its whole
+         * duration to the downtime total, and made the denominator "first event ->
+         * now" instead of the window - so the reported percentage drifted upwards
+         * every day.
          */
         const reportWindow = {
             startDate: startDate,
             endDate: endDate,
         };
+        const periodStrings = {
+            reportDates: data.reportPeriod.reportDates,
+            reportPeriodName: data.reportPeriod.periodName,
+            reportStartDate: OneUptimeDate.getDateAsCustomFormattedStringInTimezone({
+                date: startDate,
+                format: "MMM D, YYYY",
+                timezone: data.reportPeriod.timezone,
+            }),
+            reportEndDate: OneUptimeDate.getDateAsCustomFormattedStringInTimezone({
+                date: endDate,
+                format: "MMM D, YYYY",
+                timezone: data.reportPeriod.timezone,
+            }),
+            reportTimezone: data.reportPeriod.timezone,
+        };
         if (statusPageResources.length === 0) {
-            return {
-                reportDates: startAndEndDate,
-                totalResources: 0,
-                totalIncidents: 0,
-                averageUptimePercent: "0%",
-                totalDowntimeInHoursAndMinutes: "0",
-                resources: [],
-                groups: [],
-                ungroupedResources: [],
-                rows: [],
-                hasGroups: false,
-            };
+            return Object.assign(Object.assign({}, periodStrings), { totalResources: 0, totalIncidents: 0, averageUptimePercent: "0%", totalDowntimeInHoursAndMinutes: "0", resources: [], groups: [], ungroupedResources: [], rows: [], hasGroups: false });
         }
         const incidentCount = await this.getIncidentCountOnStatusPage({
             statusPageId: data.statusPageId,
-            historyDays: data.historyDays,
+            startDate: startDate,
+            endDate: endDate,
         });
         const monitors = await this.getMonitorIdsOnStatusPage({
             statusPageId: data.statusPageId,
@@ -959,7 +993,8 @@ export class Service extends DatabaseService {
                     resourceName: resource.displayName || "",
                     totalIncidentCount: await this.getIncidentCountByMonitorIds({
                         monitorIds: monitorIdsForThisResource,
-                        historyDays: data.historyDays,
+                        startDate: startDate,
+                        endDate: endDate,
                     }),
                     uptimePercent: uptimePercent,
                     uptimePercentAsString: `${uptimePercent}%`,
@@ -989,25 +1024,13 @@ export class Service extends DatabaseService {
             timeline: timeline,
             downtimeMonitorStatuses: statusPage.downtimeMonitorStatuses || [],
             reportWindow: reportWindow,
-            historyDays: data.historyDays,
         });
         const structure = StatusPageReportTreeUtil.build({
             entries: entries,
             statusPageGroups: statusPageGroups,
             groupMetricsByGroupId: groupMetricsByGroupId,
         });
-        return {
-            reportDates: startAndEndDate,
-            totalResources: statusPageResources.length,
-            totalIncidents: incidentCount,
-            averageUptimePercent: avgUptimePercentString,
-            resources: structure.resources,
-            groups: structure.groups,
-            ungroupedResources: structure.resourcesWithoutGroup,
-            rows: structure.rows,
-            hasGroups: structure.groups.length > 0,
-            totalDowntimeInHoursAndMinutes: OneUptimeDate.convertMinutesToDaysHoursAndMinutes(Math.ceil(totalDowntimeInSeconds.totalDowntimeInSeconds / 60)),
-        };
+        return Object.assign(Object.assign({}, periodStrings), { totalResources: statusPageResources.length, totalIncidents: incidentCount, averageUptimePercent: avgUptimePercentString, resources: structure.resources, groups: structure.groups, ungroupedResources: structure.resourcesWithoutGroup, rows: structure.rows, hasGroups: structure.groups.length > 0, totalDowntimeInHoursAndMinutes: OneUptimeDate.convertMinutesToDaysHoursAndMinutes(Math.ceil(totalDowntimeInSeconds.totalDowntimeInSeconds / 60)) });
     }
     /*
      * Uptime, downtime and incidents for each group, measured over the group and
@@ -1077,7 +1100,8 @@ export class Service extends DatabaseService {
                     monitorIds.length > 0
                         ? await this.getIncidentCountByMonitorIds({
                             monitorIds: monitorIds,
-                            historyDays: data.historyDays,
+                            startDate: data.reportWindow.startDate,
+                            endDate: data.reportWindow.endDate,
                         })
                         : 0;
                 incidentCountByMonitorSet[monitorSetKey] = totalIncidentCount;
@@ -1113,12 +1137,10 @@ export class Service extends DatabaseService {
         });
     }
     async getIncidentCountByMonitorIds(data) {
-        const today = OneUptimeDate.getCurrentDate();
-        const historyDays = OneUptimeDate.getSomeDaysAgo(data.historyDays || 14);
         const incidentCount = await IncidentService.countBy({
             query: {
                 monitors: data.monitorIds,
-                createdAt: QueryHelper.inBetween(historyDays, today),
+                createdAt: QueryHelper.inBetween(data.startDate, data.endDate),
             },
             props: {
                 isRoot: true,
@@ -1132,7 +1154,8 @@ export class Service extends DatabaseService {
         });
         return this.getIncidentCountByMonitorIds({
             monitorIds: monitorsOnStatusPage.monitorsOnStatusPage,
-            historyDays: data.historyDays,
+            startDate: data.startDate,
+            endDate: data.endDate,
         });
     }
     async getMonitorIdsOnStatusPage(data) {