@oneuptime/common 11.7.3 → 12.0.0

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

@@ -0,0 +1,190 @@
+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 Model, { RumSessionErasureRequestStatus, RumSessionErasureRequestType, } from "../../Models/DatabaseModels/RumSessionErasureRequest";
+import BadDataException from "../../Types/Exception/BadDataException";
+import OneUptimeDate from "../../Types/Date";
+import SortOrder from "../../Types/BaseDatabase/SortOrder";
+import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
+/*
+ * Session replay erasure requests.
+ *
+ * The service owns the two invariants the model cannot express on its
+ * own: a request is always born Pending with zeroed counters no matter
+ * what the client sent, and a request must actually be actionable by the
+ * worker before it is accepted. A request that is accepted but can never
+ * be executed is worse than a rejected one - the requester believes their
+ * data is gone.
+ */
+export class Service extends DatabaseService {
+    constructor() {
+        super(Model);
+    }
+    async onBeforeCreate(createBy) {
+        const requestType = createBy.data.requestType;
+        if (!requestType) {
+            throw new BadDataException("requestType is required on a session replay erasure request.");
+        }
+        /*
+         * Validated here rather than only in the UI because the worker cannot
+         * do anything sensible with a request whose target is missing, and it
+         * would sit Pending forever looking like an erasure in progress.
+         */
+        if (requestType === RumSessionErasureRequestType.ByDateRange) {
+            if (!createBy.data.startDate || !createBy.data.endDate) {
+                throw new BadDataException("startDate and endDate are required for a ByDateRange erasure request.");
+            }
+            if (OneUptimeDate.isAfter(createBy.data.startDate, createBy.data.endDate)) {
+                throw new BadDataException("startDate must not be after endDate on a ByDateRange erasure request.");
+            }
+        }
+        else if (!createBy.data.targetValue) {
+            throw new BadDataException(`targetValue is required for a ${requestType} erasure request.`);
+        }
+        /*
+         * A ByRumApplication request stores the application id in targetValue
+         * as well as in the relation, because rumApplicationId is nulled out
+         * (not cascaded) when the application is deleted - which is precisely
+         * when the erasure still needs to run.
+         */
+        if (requestType === RumSessionErasureRequestType.ByRumApplication &&
+            createBy.data.rumApplicationId &&
+            !createBy.data.targetValue) {
+            createBy.data.targetValue = createBy.data.rumApplicationId.toString();
+        }
+        /*
+         * All five are overwritten unconditionally, never merged with what the
+         * client sent. Every one of them is declared `computed` on the model,
+         * which is what lets these assignments survive the create-column
+         * permission check that runs after this hook.
+         */
+        createBy.data.status = RumSessionErasureRequestStatus.Pending;
+        createBy.data.requestedAt = OneUptimeDate.getCurrentDate();
+        createBy.data.sessionsDeleted = 0;
+        createBy.data.chunksDeleted = 0;
+        if (createBy.props.userId) {
+            createBy.data.requestedByUserId = createBy.props.userId;
+        }
+        else {
+            /*
+             * No authenticated user (an API key, say). Deleting rather than
+             * leaving the field alone matters: a client-supplied value would
+             * otherwise persist and attribute the erasure to somebody who never
+             * asked for it.
+             */
+            delete createBy.data.requestedByUserId;
+        }
+        return { createBy, carryForward: null };
+    }
+    /*
+     * Outstanding requests for the erasure worker, oldest first so a
+     * request cannot be starved by newer ones.
+     *
+     * sessionsDeleted / chunksDeleted are in the select list because a
+     * requeued request has to ACCUMULATE its counters across runs; omitting
+     * them is what made the worker stop using this helper and inline its own
+     * copy of the query.
+     */
+    async getPendingRequests(data) {
+        return await this.findBy({
+            query: {
+                status: RumSessionErasureRequestStatus.Pending,
+            },
+            select: {
+                _id: true,
+                projectId: true,
+                rumApplicationId: true,
+                requestType: true,
+                targetValue: true,
+                startDate: true,
+                endDate: true,
+                requestedAt: true,
+                sessionsDeleted: true,
+                chunksDeleted: true,
+            },
+            sort: {
+                requestedAt: SortOrder.Ascending,
+            },
+            skip: 0,
+            limit: data.limit,
+            props: { isRoot: true },
+        });
+    }
+    async markInProgress(data) {
+        await this.updateOneById({
+            id: data.requestId,
+            data: {
+                status: RumSessionErasureRequestStatus.InProgress,
+            },
+            props: { isRoot: true },
+        });
+    }
+    async markCompleted(data) {
+        await this.updateOneById({
+            id: data.requestId,
+            data: {
+                status: RumSessionErasureRequestStatus.Completed,
+                completedAt: OneUptimeDate.getCurrentDate(),
+                sessionsDeleted: data.sessionsDeleted,
+                chunksDeleted: data.chunksDeleted,
+            },
+            props: { isRoot: true },
+        });
+    }
+    /*
+     * completedAt is set on failure too. It means "the attempt finished",
+     * not "the data is gone" - status is what says whether it worked, and
+     * leaving completedAt null would make a failed request indistinguishable
+     * from one still running.
+     */
+    async markFailed(data) {
+        await this.updateOneById({
+            id: data.requestId,
+            data: {
+                status: RumSessionErasureRequestStatus.Failed,
+                completedAt: OneUptimeDate.getCurrentDate(),
+                failureReason: data.failureReason,
+            },
+            props: { isRoot: true },
+        });
+    }
+}
+__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]),
+    __metadata("design:returntype", Promise)
+], Service.prototype, "getPendingRequests", null);
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], Service.prototype, "markInProgress", null);
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], Service.prototype, "markCompleted", null);
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], Service.prototype, "markFailed", null);
+export default new Service();
+//# sourceMappingURL=RumSessionErasureRequestService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RumSessionErasureRequestService.js","sourceRoot":"","sources":["../../../../Server/Services/RumSessionErasureRequestService.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,EAAE,EACZ,8BAA8B,EAC9B,4BAA4B,GAC7B,MAAM,sDAAsD,CAAC;AAC9D,OAAO,gBAAgB,MAAM,wCAAwC,CAAC;AAEtE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAC7C,OAAO,SAAS,MAAM,oCAAoC,CAAC;AAG3D,OAAO,WAAW,MAAM,gCAAgC,CAAC;AAEzD;;;;;;;;;GASG;AACH,MAAM,OAAO,OAAQ,SAAQ,eAAsB;IACjD;QACE,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;IAGwB,AAAN,KAAK,CAAC,cAAc,CACrC,QAAyB;QAEzB,MAAM,WAAW,GACf,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC;QAE5B,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,gBAAgB,CACxB,8DAA8D,CAC/D,CAAC;QACJ,CAAC;QAED;;;;WAIG;QACH,IAAI,WAAW,KAAK,4BAA4B,CAAC,WAAW,EAAE,CAAC;YAC7D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;gBACvD,MAAM,IAAI,gBAAgB,CACxB,uEAAuE,CACxE,CAAC;YACJ,CAAC;YAED,IACE,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EACrE,CAAC;gBACD,MAAM,IAAI,gBAAgB,CACxB,uEAAuE,CACxE,CAAC;YACJ,CAAC;QACH,CAAC;aAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtC,MAAM,IAAI,gBAAgB,CACxB,iCAAiC,WAAW,mBAAmB,CAChE,CAAC;QACJ,CAAC;QAED;;;;;WAKG;QACH,IACE,WAAW,KAAK,4BAA4B,CAAC,gBAAgB;YAC7D,QAAQ,CAAC,IAAI,CAAC,gBAAgB;YAC9B,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAC1B,CAAC;YACD,QAAQ,CAAC,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC;QACxE,CAAC;QAED;;;;;WAKG;QACH,QAAQ,CAAC,IAAI,CAAC,MAAM,GAAG,8BAA8B,CAAC,OAAO,CAAC;QAC9D,QAAQ,CAAC,IAAI,CAAC,WAAW,GAAG,aAAa,CAAC,cAAc,EAAE,CAAC;QAC3D,QAAQ,CAAC,IAAI,CAAC,eAAe,GAAG,CAAC,CAAC;QAClC,QAAQ,CAAC,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC;QAEhC,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YAC1B,QAAQ,CAAC,IAAI,CAAC,iBAAiB,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC;QAC1D,CAAC;aAAM,CAAC;YACN;;;;;eAKG;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC;QACzC,CAAC;QAED,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IAC1C,CAAC;IAED;;;;;;;;OAQG;IAEU,AAAN,KAAK,CAAC,kBAAkB,CAAC,IAE/B;QACC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC;YACvB,KAAK,EAAE;gBACL,MAAM,EAAE,8BAA8B,CAAC,OAAO;aAC/C;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,IAAI;gBACT,SAAS,EAAE,IAAI;gBACf,gBAAgB,EAAE,IAAI;gBACtB,WAAW,EAAE,IAAI;gBACjB,WAAW,EAAE,IAAI;gBACjB,SAAS,EAAE,IAAI;gBACf,OAAO,EAAE,IAAI;gBACb,WAAW,EAAE,IAAI;gBACjB,eAAe,EAAE,IAAI;gBACrB,aAAa,EAAE,IAAI;aACpB;YACD,IAAI,EAAE;gBACJ,WAAW,EAAE,SAAS,CAAC,SAAS;aACjC;YACD,IAAI,EAAE,CAAC;YACP,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;SACxB,CAAC,CAAC;IACL,CAAC;IAGY,AAAN,KAAK,CAAC,cAAc,CAAC,IAA6B;QACvD,MAAM,IAAI,CAAC,aAAa,CAAC;YACvB,EAAE,EAAE,IAAI,CAAC,SAAS;YAClB,IAAI,EAAE;gBACJ,MAAM,EAAE,8BAA8B,CAAC,UAAU;aAClD;YACD,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;SACxB,CAAC,CAAC;IACL,CAAC;IAGY,AAAN,KAAK,CAAC,aAAa,CAAC,IAI1B;QACC,MAAM,IAAI,CAAC,aAAa,CAAC;YACvB,EAAE,EAAE,IAAI,CAAC,SAAS;YAClB,IAAI,EAAE;gBACJ,MAAM,EAAE,8BAA8B,CAAC,SAAS;gBAChD,WAAW,EAAE,aAAa,CAAC,cAAc,EAAE;gBAC3C,eAAe,EAAE,IAAI,CAAC,eAAe;gBACrC,aAAa,EAAE,IAAI,CAAC,aAAa;aAClC;YACD,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;SACxB,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IAEU,AAAN,KAAK,CAAC,UAAU,CAAC,IAGvB;QACC,MAAM,IAAI,CAAC,aAAa,CAAC;YACvB,EAAE,EAAE,IAAI,CAAC,SAAS;YAClB,IAAI,EAAE;gBACJ,MAAM,EAAE,8BAA8B,CAAC,MAAM;gBAC7C,WAAW,EAAE,aAAa,CAAC,cAAc,EAAE;gBAC3C,aAAa,EAAE,IAAI,CAAC,aAAa;aAClC;YACD,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;SACxB,CAAC,CAAC;IACL,CAAC;CACF;AArK0B;IADxB,WAAW,EAAE;;;;6CA4Eb;AAYY;IADZ,WAAW,EAAE;;;;iDA2Bb;AAGY;IADZ,WAAW,EAAE;;;;6CASb;AAGY;IADZ,WAAW,EAAE;;;;4CAgBb;AASY;IADZ,WAAW,EAAE;;;;yCAcb;AAGH,eAAe,IAAI,OAAO,EAAE,CAAC"}

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

@@ -0,0 +1,208 @@
+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 Model from "../../Models/DatabaseModels/RumSessionPin";
+import BadDataException from "../../Types/Exception/BadDataException";
+import OneUptimeDate from "../../Types/Date";
+import QueryHelper from "../Types/Database/QueryHelper";
+import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
+/* Postgres unique_violation. https://www.postgresql.org/docs/current/errcodes-appendix.html */
+const UNIQUE_VIOLATION = "23505";
+/*
+ * TypeORM wraps driver failures in QueryFailedError, which hoists the pg
+ * fields onto itself but also keeps the original under `driverError`.
+ * Check both rather than assuming which one carries the code.
+ */
+const isUniqueViolation = (error) => {
+    if (!error || typeof error !== "object") {
+        return false;
+    }
+    if (error.code === UNIQUE_VIOLATION) {
+        return true;
+    }
+    const driverError = error.driverError;
+    return Boolean(driverError &&
+        typeof driverError === "object" &&
+        driverError.code === UNIQUE_VIOLATION);
+};
+/*
+ * Pins that keep a session recording past its retention window.
+ *
+ * The unique index on (projectId, rumApplicationId, sessionId) is the real
+ * guard against duplicate copies; this service turns the resulting
+ * constraint violation into an idempotent "already pinned" so that
+ * clicking Pin twice, or pinning the same recording from two incidents,
+ * is not an error the user has to interpret.
+ */
+export class Service extends DatabaseService {
+    constructor() {
+        super(Model);
+    }
+    async onBeforeCreate(createBy) {
+        if (!createBy.data.projectId) {
+            throw new BadDataException("projectId is required");
+        }
+        if (!createBy.data.rumApplicationId) {
+            throw new BadDataException("rumApplicationId is required");
+        }
+        if (!createBy.data.sessionId) {
+            throw new BadDataException("sessionId is required");
+        }
+        /*
+         * materializedAt is never client-supplied: it asserts that the
+         * recording has actually been copied out of the expiring table, and
+         * a client that could set it would make an unprotected recording look
+         * protected.
+         */
+        delete createBy.data.materializedAt;
+        /*
+         * Assigned or removed, never left as the client sent it. pinnedByUserId
+         * is declared `computed` on the model, which is what lets this
+         * assignment survive the create-column permission check that runs after
+         * this hook; the delete is what stops an API-key caller (no
+         * props.userId) attributing the pin to a colleague.
+         */
+        if (createBy.props.userId) {
+            createBy.data.pinnedByUserId = createBy.props.userId;
+        }
+        else {
+            delete createBy.data.pinnedByUserId;
+        }
+        return { createBy, carryForward: null };
+    }
+    /*
+     * Pinning is idempotent, which is the whole reason this override exists.
+     * Clicking Pin twice, or pinning the same recording from two incidents,
+     * hits the unique index on (projectId, rumApplicationId, sessionId) and
+     * would otherwise surface as a raw 500 carrying a Postgres constraint
+     * name: checkForUniqueValues only understands single-column `unique`
+     * metadata, not a composite @Index, so nothing else catches it.
+     *
+     * The pre-check handles the common case and the catch closes the race
+     * between two concurrent pins of the same session.
+     */
+    async create(createBy) {
+        const projectId = createBy.data.projectId;
+        const rumApplicationId = createBy.data.rumApplicationId;
+        const sessionId = createBy.data.sessionId;
+        if (!projectId || !rumApplicationId || !sessionId) {
+            /* Let onBeforeCreate produce the specific validation message. */
+            return await super.create(createBy);
+        }
+        const existingPin = await this.getPinForSession({
+            projectId: projectId,
+            rumApplicationId: rumApplicationId,
+            sessionId: sessionId,
+        });
+        if (existingPin) {
+            return existingPin;
+        }
+        try {
+            return await super.create(createBy);
+        }
+        catch (err) {
+            if (!isUniqueViolation(err)) {
+                throw err;
+            }
+            const racedPin = await this.getPinForSession({
+                projectId: projectId,
+                rumApplicationId: rumApplicationId,
+                sessionId: sessionId,
+            });
+            if (racedPin) {
+                return racedPin;
+            }
+            throw err;
+        }
+    }
+    /* Null when the recording is not pinned. */
+    async getPinForSession(data) {
+        return await this.findOneBy({
+            query: {
+                projectId: data.projectId,
+                rumApplicationId: data.rumApplicationId,
+                sessionId: data.sessionId,
+            },
+            select: {
+                _id: true,
+                reason: true,
+                incidentId: true,
+                alertId: true,
+                expiresAt: true,
+                materializedAt: true,
+                pinnedByUserId: true,
+            },
+            props: { isRoot: true },
+        });
+    }
+    /*
+     * Pins whose copy has not happened yet. This is the worker's queue, and
+     * it is also the honest answer to "is this recording safe?" - a pin
+     * without a materializedAt protects nothing.
+     */
+    async getUnmaterializedPins(data) {
+        return await this.findBy({
+            query: {
+                materializedAt: QueryHelper.isNull(),
+            },
+            select: {
+                _id: true,
+                projectId: true,
+                rumApplicationId: true,
+                sessionId: true,
+                expiresAt: true,
+            },
+            skip: 0,
+            limit: data.limit,
+            props: { isRoot: true },
+        });
+    }
+    async markMaterialized(data) {
+        await this.updateOneById({
+            id: data.pinId,
+            data: {
+                materializedAt: OneUptimeDate.getCurrentDate(),
+            },
+            props: { isRoot: true },
+        });
+    }
+}
+__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]),
+    __metadata("design:returntype", Promise)
+], Service.prototype, "create", null);
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], Service.prototype, "getPinForSession", null);
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], Service.prototype, "getUnmaterializedPins", null);
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], Service.prototype, "markMaterialized", null);
+export default new Service();
+//# sourceMappingURL=RumSessionPinService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RumSessionPinService.js","sourceRoot":"","sources":["../../../../Server/Services/RumSessionPinService.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,MAAM,2CAA2C,CAAC;AAC9D,OAAO,gBAAgB,MAAM,wCAAwC,CAAC;AAEtE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAG7C,OAAO,WAAW,MAAM,+BAA+B,CAAC;AACxD,OAAO,WAAW,MAAM,gCAAgC,CAAC;AAEzD,+FAA+F;AAC/F,MAAM,gBAAgB,GAAW,OAAO,CAAC;AAIzC;;;;GAIG;AACH,MAAM,iBAAiB,GAA8B,CACnD,KAAc,EACL,EAAE;IACX,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAK,KAAuC,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;QACvE,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,WAAW,GAAa,KAAmC,CAAC,WAAW,CAAC;IAE9E,OAAO,OAAO,CACZ,WAAW;QACT,OAAO,WAAW,KAAK,QAAQ;QAC9B,WAA6C,CAAC,IAAI,KAAK,gBAAgB,CAC3E,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,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,SAAS,EAAE,CAAC;YAC7B,MAAM,IAAI,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;QACtD,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACpC,MAAM,IAAI,gBAAgB,CAAC,8BAA8B,CAAC,CAAC;QAC7D,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YAC7B,MAAM,IAAI,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;QACtD,CAAC;QAED;;;;;WAKG;QACH,OAAO,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC;QAEpC;;;;;;WAMG;QACH,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YAC1B,QAAQ,CAAC,IAAI,CAAC,cAAc,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC;QACvD,CAAC;aAAM,CAAC;YACN,OAAO,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC;QACtC,CAAC;QAED,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IAC1C,CAAC;IAED;;;;;;;;;;OAUG;IAEmB,AAAN,KAAK,CAAC,MAAM,CAAC,QAAyB;QACpD,MAAM,SAAS,GAAyB,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;QAChE,MAAM,gBAAgB,GACpB,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC;QACjC,MAAM,SAAS,GAAuB,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;QAE9D,IAAI,CAAC,SAAS,IAAI,CAAC,gBAAgB,IAAI,CAAC,SAAS,EAAE,CAAC;YAClD,iEAAiE;YACjE,OAAO,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACtC,CAAC;QAED,MAAM,WAAW,GAAiB,MAAM,IAAI,CAAC,gBAAgB,CAAC;YAC5D,SAAS,EAAE,SAAS;YACpB,gBAAgB,EAAE,gBAAgB;YAClC,SAAS,EAAE,SAAS;SACrB,CAAC,CAAC;QAEH,IAAI,WAAW,EAAE,CAAC;YAChB,OAAO,WAAW,CAAC;QACrB,CAAC;QAED,IAAI,CAAC;YACH,OAAO,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACtC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC5B,MAAM,GAAG,CAAC;YACZ,CAAC;YAED,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,gBAAgB,CAAC;gBACzD,SAAS,EAAE,SAAS;gBACpB,gBAAgB,EAAE,gBAAgB;gBAClC,SAAS,EAAE,SAAS;aACrB,CAAC,CAAC;YAEH,IAAI,QAAQ,EAAE,CAAC;gBACb,OAAO,QAAQ,CAAC;YAClB,CAAC;YAED,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED,4CAA4C;IAE/B,AAAN,KAAK,CAAC,gBAAgB,CAAC,IAI7B;QACC,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC;YAC1B,KAAK,EAAE;gBACL,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;gBACvC,SAAS,EAAE,IAAI,CAAC,SAAS;aAC1B;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,IAAI;gBACT,MAAM,EAAE,IAAI;gBACZ,UAAU,EAAE,IAAI;gBAChB,OAAO,EAAE,IAAI;gBACb,SAAS,EAAE,IAAI;gBACf,cAAc,EAAE,IAAI;gBACpB,cAAc,EAAE,IAAI;aACrB;YACD,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;SACxB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEU,AAAN,KAAK,CAAC,qBAAqB,CAAC,IAElC;QACC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC;YACvB,KAAK,EAAE;gBACL,cAAc,EAAE,WAAW,CAAC,MAAM,EAAE;aACrC;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,IAAI;gBACT,SAAS,EAAE,IAAI;gBACf,gBAAgB,EAAE,IAAI;gBACtB,SAAS,EAAE,IAAI;gBACf,SAAS,EAAE,IAAI;aAChB;YACD,IAAI,EAAE,CAAC;YACP,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;SACxB,CAAC,CAAC;IACL,CAAC;IAGY,AAAN,KAAK,CAAC,gBAAgB,CAAC,IAAyB;QACrD,MAAM,IAAI,CAAC,aAAa,CAAC;YACvB,EAAE,EAAE,IAAI,CAAC,KAAK;YACd,IAAI,EAAE;gBACJ,cAAc,EAAE,aAAa,CAAC,cAAc,EAAE;aAC/C;YACD,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;SACxB,CAAC,CAAC;IACL,CAAC;CACF;AA3J0B;IADxB,WAAW,EAAE;;;;6CAsCb;AAcqB;IADrB,WAAW,EAAE;;;;qCAyCb;AAIY;IADZ,WAAW,EAAE;;;;+CAuBb;AAQY;IADZ,WAAW,EAAE;;;;oDAmBb;AAGY;IADZ,WAAW,EAAE;;;;+CASb;AAGH,eAAe,IAAI,OAAO,EAAE,CAAC"}

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

@@ -0,0 +1,180 @@
+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 Model from "../../Models/DatabaseModels/RumSessionReplayView";
+import ColumnLength from "../../Types/Database/ColumnLength";
+import { LIMIT_PER_PROJECT } from "../../Types/Database/LimitMax";
+import OneUptimeDate from "../../Types/Date";
+import SortOrder from "../../Types/BaseDatabase/SortOrder";
+import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
+/*
+ * Session replay read audit.
+ *
+ * Every write here happens as root from the playback API, not from a
+ * client, because the audit row has to be written whether or not the
+ * caller would have had permission to create it - and because the caller
+ * must not be able to choose what it says.
+ *
+ * No hardDeleteItemsOlderThanInDays: unlike the SCIM logs this table is
+ * modelled on, the whole point of the audit is that it outlives the
+ * recording it describes.
+ */
+export class Service extends DatabaseService {
+    constructor() {
+        super(Model);
+    }
+    /*
+     * Record that somebody opened a recording for playback. Called from the
+     * manifest endpoint BEFORE any payload byte is served, so a read that
+     * fails halfway through is still audited.
+     */
+    async recordView(data) {
+        const item = new Model();
+        item.projectId = data.projectId;
+        item.rumApplicationId = data.rumApplicationId;
+        item.sessionId = data.sessionId;
+        item.viewedAt = OneUptimeDate.getCurrentDate();
+        item.secondsWatched = 0;
+        if (data.viewedByUserId) {
+            item.viewedByUserId = data.viewedByUserId;
+            /*
+             * The row is created as root, so createdByUserId would otherwise be
+             * null and the audit would not name the human behind the read.
+             */
+            item.createdByUserId = data.viewedByUserId;
+        }
+        if (data.viewedByApiKeyId) {
+            item.viewedByApiKeyId = data.viewedByApiKeyId;
+        }
+        /*
+         * All three come straight off an untrusted request: a header, or a
+         * free-text field in the body. Truncated rather than validated because
+         * failing the audit write would fail the playback it is auditing, and
+         * DatabaseService.checkMaxLengthOfFields throws on anything longer
+         * than the column. An oversized user agent must not be able to stop a
+         * read from being recorded.
+         */
+        if (data.ipAddress) {
+            item.ipAddress = data.ipAddress.substring(0, ColumnLength.ShortText);
+        }
+        if (data.userAgent) {
+            item.userAgent = data.userAgent.substring(0, ColumnLength.LongText);
+        }
+        if (data.accessReason) {
+            item.accessReason = data.accessReason.substring(0, ColumnLength.LongText);
+        }
+        if (data.linkedIncidentId) {
+            item.linkedIncidentId = data.linkedIncidentId;
+        }
+        if (data.linkedExceptionFingerprint) {
+            item.linkedExceptionFingerprint = data.linkedExceptionFingerprint;
+        }
+        return await this.create({
+            data: item,
+            props: { isRoot: true },
+        });
+    }
+    /*
+     * Advance how much of the recording was actually watched, from the
+     * player's throttled heartbeat.
+     *
+     * Monotonic on purpose: the heartbeat carries a cumulative total, and a
+     * player that seeks backwards or reloads would otherwise walk the
+     * recorded figure back down and make a full viewing look like a glance.
+     */
+    async recordSecondsWatched(data) {
+        if (!Number.isFinite(data.secondsWatched) || data.secondsWatched <= 0) {
+            return;
+        }
+        const existing = await this.findOneBy({
+            query: {
+                _id: data.viewId.toString(),
+                projectId: data.projectId,
+            },
+            select: {
+                _id: true,
+                secondsWatched: true,
+            },
+            props: { isRoot: true },
+        });
+        if (!existing) {
+            return;
+        }
+        const seconds = Math.floor(data.secondsWatched);
+        if ((existing.secondsWatched || 0) >= seconds) {
+            return;
+        }
+        await this.updateOneById({
+            id: data.viewId,
+            data: {
+                secondsWatched: seconds,
+            },
+            props: { isRoot: true },
+        });
+    }
+    /*
+     * Who has watched this recording. Shown on the player itself, not only
+     * in a log - inward visibility changes behaviour more than an audit
+     * trail nobody reads.
+     */
+    async getViewsForSession(data) {
+        return await this.findBy({
+            query: {
+                projectId: data.projectId,
+                rumApplicationId: data.rumApplicationId,
+                sessionId: data.sessionId,
+            },
+            select: {
+                _id: true,
+                viewedAt: true,
+                secondsWatched: true,
+                accessReason: true,
+                viewedByUserId: true,
+                viewedByUser: {
+                    _id: true,
+                    name: true,
+                    email: true,
+                    profilePictureId: true,
+                },
+            },
+            sort: {
+                viewedAt: SortOrder.Descending,
+            },
+            skip: 0,
+            /*
+             * Clamped rather than passed through: findBy rejects anything above
+             * LIMIT_PER_PROJECT with an exception, and a too-large page is not
+             * worth failing an audit listing over.
+             */
+            limit: Math.min(Math.max(data.limit, 1), LIMIT_PER_PROJECT),
+            props: { isRoot: true },
+        });
+    }
+}
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], Service.prototype, "recordView", null);
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], Service.prototype, "recordSecondsWatched", null);
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], Service.prototype, "getViewsForSession", null);
+export default new Service();
+//# sourceMappingURL=RumSessionReplayViewService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RumSessionReplayViewService.js","sourceRoot":"","sources":["../../../../Server/Services/RumSessionReplayViewService.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,MAAM,kDAAkD,CAAC;AACrE,OAAO,YAAY,MAAM,mCAAmC,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAElE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAC7C,OAAO,SAAS,MAAM,oCAAoC,CAAC;AAC3D,OAAO,WAAW,MAAM,gCAAgC,CAAC;AAEzD;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,OAAQ,SAAQ,eAAsB;IACjD;QACE,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;IAED;;;;OAIG;IAEU,AAAN,KAAK,CAAC,UAAU,CAAC,IAWvB;QACC,MAAM,IAAI,GAAU,IAAI,KAAK,EAAE,CAAC;QAEhC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAChC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAC9C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,aAAa,CAAC,cAAc,EAAE,CAAC;QAC/C,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC;QAExB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;YAC1C;;;eAGG;YACH,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,cAAc,CAAC;QAC7C,CAAC;QAED,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAChD,CAAC;QAED;;;;;;;WAOG;QACH,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC;QACvE,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC;QACtE,CAAC;QAED,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC5E,CAAC;QAED,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAChD,CAAC;QAED,IAAI,IAAI,CAAC,0BAA0B,EAAE,CAAC;YACpC,IAAI,CAAC,0BAA0B,GAAG,IAAI,CAAC,0BAA0B,CAAC;QACpE,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC;YACvB,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;SACxB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IAEU,AAAN,KAAK,CAAC,oBAAoB,CAAC,IAIjC;QACC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,cAAc,IAAI,CAAC,EAAE,CAAC;YACtE,OAAO;QACT,CAAC;QAED,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,SAAS,CAAC;YAClD,KAAK,EAAE;gBACL,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;gBAC3B,SAAS,EAAE,IAAI,CAAC,SAAS;aAC1B;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,IAAI;gBACT,cAAc,EAAE,IAAI;aACrB;YACD,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;SACxB,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO;QACT,CAAC;QAED,MAAM,OAAO,GAAW,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAExD,IAAI,CAAC,QAAQ,CAAC,cAAc,IAAI,CAAC,CAAC,IAAI,OAAO,EAAE,CAAC;YAC9C,OAAO;QACT,CAAC;QAED,MAAM,IAAI,CAAC,aAAa,CAAC;YACvB,EAAE,EAAE,IAAI,CAAC,MAAM;YACf,IAAI,EAAE;gBACJ,cAAc,EAAE,OAAO;aACxB;YACD,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;SACxB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEU,AAAN,KAAK,CAAC,kBAAkB,CAAC,IAW/B;QACC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC;YACvB,KAAK,EAAE;gBACL,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;gBACvC,SAAS,EAAE,IAAI,CAAC,SAAS;aAC1B;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,IAAI;gBACT,QAAQ,EAAE,IAAI;gBACd,cAAc,EAAE,IAAI;gBACpB,YAAY,EAAE,IAAI;gBAClB,cAAc,EAAE,IAAI;gBACpB,YAAY,EAAE;oBACZ,GAAG,EAAE,IAAI;oBACT,IAAI,EAAE,IAAI;oBACV,KAAK,EAAE,IAAI;oBACX,gBAAgB,EAAE,IAAI;iBACvB;aACF;YACD,IAAI,EAAE;gBACJ,QAAQ,EAAE,SAAS,CAAC,UAAU;aAC/B;YACD,IAAI,EAAE,CAAC;YACP;;;;eAIG;YACH,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,iBAAiB,CAAC;YAC3D,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;SACxB,CAAC,CAAC;IACL,CAAC;CACF;AAtKc;IADZ,WAAW,EAAE;;;;yCAkEb;AAWY;IADZ,WAAW,EAAE;;;;mDAuCb;AAQY;IADZ,WAAW,EAAE;;;;iDA4Cb;AAGH,eAAe,IAAI,OAAO,EAAE,CAAC"}