@oneuptime/common 14.0.9 → 14.0.10

package/build/dist/Server/Utils/AI/ResourceAccess/ResourceAiDeleteCleanup.js

@@ -0,0 +1,226 @@
+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 AutoRemediationSuggestionService from "../../../Services/AutoRemediationSuggestionService";
+import QueryHelper from "../../../Types/Database/QueryHelper";
+import logger from "../../Logger";
+import CaptureSpan from "../../Telemetry/CaptureSpan";
+import { getResourceSentenceName } from "../../../../Types/AI/ResourceAiAccessPermissions";
+import { AiRemediationCommandExecutionStatus, AiRemediationCommandPlanUtil, } from "../../../../Types/AutoRemediation/AiRemediationCommandPlan";
+import AutoRemediationSuggestionStatus from "../../../../Types/AutoRemediation/AutoRemediationSuggestionStatus";
+import LIMIT_MAX from "../../../../Types/Database/LimitMax";
+import OneUptimeDate from "../../../../Types/Date";
+import ObjectID from "../../../../Types/ObjectID";
+// The resource columns the note names a resource by.
+const RESOURCE_SELECT = {
+    _id: true,
+    name: true,
+};
+/*
+ * The carry-forward a resource delete hook handed over, or null when it is
+ * not one (another hook's, or the before-hook never ran) or belongs to
+ * another resource type.
+ */
+export function getResourceAiDeleteCarryForward(carryForward, resourceType) {
+    if (carryForward &&
+        typeof carryForward === "object" &&
+        "inFlightRounds" in carryForward &&
+        "resourceNames" in carryForward &&
+        carryForward.resourceType ===
+            resourceType &&
+        Array.isArray(carryForward.inFlightRounds)) {
+        return carryForward;
+    }
+    return null;
+}
+export default class ResourceAiDeleteCleanup {
+    /*
+     * For a resource service's onBeforeDelete: the in-flight rounds of every
+     * resource the delete matches, and those resources' names. onBeforeDelete
+     * runs before the framework scopes the query to the caller's project, so
+     * scope it here. A failed read is only logged: the delete goes ahead and
+     * its agents are still removed; the rounds then fail on their next
+     * command, as the resource is gone.
+     */
+    static async beforeDelete(data) {
+        var _a, _b;
+        let inFlightRounds = [];
+        const resourceNames = {};
+        try {
+            const resources = await data.service.findBy({
+                query: Object.assign(Object.assign({}, data.deleteBy.query), (data.deleteBy.props.tenantId
+                    ? { projectId: data.deleteBy.props.tenantId }
+                    : {})),
+                select: RESOURCE_SELECT,
+                limit: LIMIT_MAX,
+                skip: 0,
+                props: { isRoot: true },
+            });
+            const resourceIds = [];
+            for (const resource of resources) {
+                const resourceId = ((_a = resource.id) === null || _a === void 0 ? void 0 : _a.toString()) || ((_b = resource._id) === null || _b === void 0 ? void 0 : _b.toString());
+                if (!resourceId) {
+                    continue;
+                }
+                const name = resource["name"];
+                resourceIds.push(new ObjectID(resourceId));
+                resourceNames[resourceId] = typeof name === "string" ? name.trim() : "";
+            }
+            if (resourceIds.length > 0) {
+                inFlightRounds = await AutoRemediationSuggestionService.findBy({
+                    query: {
+                        resourceType: data.resourceType,
+                        resourceId: QueryHelper.any(resourceIds),
+                        status: QueryHelper.any([
+                            AutoRemediationSuggestionStatus.Planning,
+                            AutoRemediationSuggestionStatus.Suggested,
+                        ]),
+                    },
+                    select: {
+                        _id: true,
+                        status: true,
+                        resourceType: true,
+                        resourceId: true,
+                        rationaleMarkdown: true,
+                        commandPlan: true,
+                    },
+                    limit: LIMIT_MAX,
+                    skip: 0,
+                    props: { isRoot: true },
+                });
+            }
+        }
+        catch (error) {
+            logger.error(`ResourceAiDeleteCleanup: could not read the in-flight AI remediation rounds of the ${getResourceSentenceName(data.resourceType)}(s) being deleted: ${error}`);
+        }
+        return {
+            resourceType: data.resourceType,
+            inFlightRounds,
+            resourceNames,
+        };
+    }
+    /*
+     * For a resource service's onDeleteSuccess, with the ids the delete
+     * actually removed: settle the in-flight rounds of those resources, then
+     * delete their AI agents. Never throws.
+     */
+    static async afterDelete(data) {
+        var _a;
+        if (data.deletedItemIds.length === 0) {
+            return;
+        }
+        const deleted = new Set(data.deletedItemIds.map((id) => {
+            return id.toString();
+        }));
+        const carryForward = getResourceAiDeleteCarryForward(data.onDelete.carryForward, data.resourceType);
+        for (const suggestion of (carryForward === null || carryForward === void 0 ? void 0 : carryForward.inFlightRounds) || []) {
+            const resourceId = ((_a = suggestion.resourceId) === null || _a === void 0 ? void 0 : _a.toString()) || "";
+            if (!deleted.has(resourceId)) {
+                continue;
+            }
+            await ResourceAiDeleteCleanup.settleRoundOfDeletedResource({
+                suggestion,
+                resourceType: data.resourceType,
+                resourceName: (carryForward === null || carryForward === void 0 ? void 0 : carryForward.resourceNames[resourceId]) || "",
+                deletedByUserId: data.onDelete.deleteBy.props.userId,
+            });
+        }
+        await ResourceAiDeleteCleanup.deleteAgentsOfDeletedResources({
+            resourceType: data.resourceType,
+            resourceIds: data.deletedItemIds,
+        });
+    }
+    /*
+     * The note a round of a deleted resource is dismissed with — and, for a
+     * round that had already run commands, that those changes were made and
+     * nothing was rolled back.
+     */
+    static getDeletedResourceNote(data) {
+        const resource = `the ${getResourceSentenceName(data.resourceType)}${data.resourceName ? ` "${data.resourceName}"` : ""}`;
+        const headline = `**Dismissed: ${resource} this remediation was for was deleted.**`;
+        return data.executedCount > 0
+            ? `${headline} ${data.executedCount} command(s) had already run on it before; nothing was rolled back and no further command will run.`
+            : `${headline} None of its commands ran, and none will.`;
+    }
+    /*
+     * Settle one in-flight round of a deleted resource the way a human
+     * dismissal settles it (the conditional status transition, so a planner
+     * finishing at the same moment loses cleanly and writes nothing), keeping
+     * the AI's own reasoning after the note. Best effort: a settle that fails
+     * must not fail the delete that already happened.
+     */
+    static async settleRoundOfDeletedResource(data) {
+        var _a;
+        const { suggestion } = data;
+        try {
+            const plan = AiRemediationCommandPlanUtil.parse(suggestion.commandPlan);
+            // A Skipped command never ran; any other execution record may have.
+            const executedCount = ((plan === null || plan === void 0 ? void 0 : plan.commands) || []).filter((command) => {
+                return (command.execution !== undefined &&
+                    command.execution.status !==
+                        AiRemediationCommandExecutionStatus.Skipped);
+            }).length;
+            const note = ResourceAiDeleteCleanup.getDeletedResourceNote({
+                resourceType: data.resourceType,
+                resourceName: data.resourceName,
+                executedCount,
+            });
+            await AutoRemediationSuggestionService.attemptStatusTransition({
+                suggestionId: suggestion.id,
+                fromStatus: suggestion.status,
+                set: Object.assign(Object.assign({ status: AutoRemediationSuggestionStatus.Dismissed, dismissedAt: OneUptimeDate.getCurrentDate() }, (data.deletedByUserId
+                    ? { dismissedByUserId: data.deletedByUserId.toString() }
+                    : {})), { rationaleMarkdown: suggestion.rationaleMarkdown
+                        ? `${note}\n\n${suggestion.rationaleMarkdown}`
+                        : note }),
+            });
+        }
+        catch (error) {
+            logger.error(`ResourceAiDeleteCleanup: could not settle AI remediation suggestion ${(_a = suggestion.id) === null || _a === void 0 ? void 0 : _a.toString()} of a deleted ${getResourceSentenceName(data.resourceType)}: ${error}`);
+        }
+    }
+    /*
+     * The AI agent rows of the deleted resources. Not scoped to a project:
+     * the ids are the ones the (already project-scoped) delete removed, and an
+     * agent row belongs to exactly one resource. Best effort: a row left
+     * behind is still removed by its agent's next heartbeat, which finds the
+     * resource gone.
+     */
+    static async deleteAgentsOfDeletedResources(data) {
+        try {
+            /*
+             * Required here, not imported: ResourceAiAgentService imports every
+             * resource service, and every resource service imports this file.
+             */
+            const resourceAiAgentService = 
+            // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires
+            require("../../../Services/ResourceAiAgentService").default;
+            await resourceAiAgentService.deleteAgentsForResources({
+                resourceType: data.resourceType,
+                resourceIds: data.resourceIds,
+            });
+        }
+        catch (error) {
+            logger.error(`ResourceAiDeleteCleanup: could not delete the AI agent(s) of the deleted ${getResourceSentenceName(data.resourceType)}(s): ${error}`);
+        }
+    }
+}
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], ResourceAiDeleteCleanup, "beforeDelete", null);
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], ResourceAiDeleteCleanup, "afterDelete", null);
+//# sourceMappingURL=ResourceAiDeleteCleanup.js.map

package/build/dist/Server/Utils/AI/ResourceAccess/ResourceAiDeleteCleanup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResourceAiDeleteCleanup.js","sourceRoot":"","sources":["../../../../../../Server/Utils/AI/ResourceAccess/ResourceAiDeleteCleanup.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,gCAAgC,MAAM,oDAAoD,CAAC;AAIlG,OAAO,WAAW,MAAM,qCAAqC,CAAC;AAC9D,OAAO,MAAM,MAAM,cAAc,CAAC;AAClC,OAAO,WAAW,MAAM,6BAA6B,CAAC;AAGtD,OAAO,EAAE,uBAAuB,EAAE,MAAM,kDAAkD,CAAC;AAC3F,OAAO,EAEL,mCAAmC,EAEnC,4BAA4B,GAC7B,MAAM,4DAA4D,CAAC;AACpE,OAAO,+BAA+B,MAAM,mEAAmE,CAAC;AAChH,OAAO,SAAS,MAAM,qCAAqC,CAAC;AAC5D,OAAO,aAAa,MAAM,wBAAwB,CAAC;AACnD,OAAO,QAAQ,MAAM,4BAA4B,CAAC;AAqClD,qDAAqD;AACrD,MAAM,eAAe,GAAyB;IAC5C,GAAG,EAAE,IAAI;IACT,IAAI,EAAE,IAAI;CACX,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,+BAA+B,CAC7C,YAAqB,EACrB,YAA4B;IAE5B,IACE,YAAY;QACZ,OAAO,YAAY,KAAK,QAAQ;QAChC,gBAAgB,IAAI,YAAY;QAChC,eAAe,IAAI,YAAY;QAC9B,YAA6C,CAAC,YAAY;YACzD,YAAY;QACd,KAAK,CAAC,OAAO,CAAE,YAA6C,CAAC,cAAc,CAAC,EAC5E,CAAC;QACD,OAAO,YAA4C,CAAC;IACtD,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,CAAC,OAAO,OAAO,uBAAuB;IAC1C;;;;;;;OAOG;IAEiB,AAAb,MAAM,CAAC,KAAK,CAAC,YAAY,CAA+B,IAI9D;;QACC,IAAI,cAAc,GAAqC,EAAE,CAAC;QAC1D,MAAM,aAAa,GAA2B,EAAE,CAAC;QAEjD,IAAI,CAAC;YACH,MAAM,SAAS,GAAsB,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;gBAC7D,KAAK,EAAE,gCACF,IAAI,CAAC,QAAQ,CAAC,KAAK,GACnB,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ;oBAC9B,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE;oBAC7C,CAAC,CAAC,EAAE,CAAC,CACC;gBACV,MAAM,EAAE,eAAwB;gBAChC,KAAK,EAAE,SAAS;gBAChB,IAAI,EAAE,CAAC;gBACP,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;aACxB,CAAC,CAAC;YAEH,MAAM,WAAW,GAAoB,EAAE,CAAC;YAExC,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBACjC,MAAM,UAAU,GACd,CAAA,MAAA,QAAQ,CAAC,EAAE,0CAAE,QAAQ,EAAE,MAAI,MAAA,QAAQ,CAAC,GAAG,0CAAE,QAAQ,EAAE,CAAA,CAAC;gBAEtD,IAAI,CAAC,UAAU,EAAE,CAAC;oBAChB,SAAS;gBACX,CAAC;gBAED,MAAM,IAAI,GAAa,QAA+C,CACpE,MAAM,CACP,CAAC;gBAEF,WAAW,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;gBAC3C,aAAa,CAAC,UAAU,CAAC,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1E,CAAC;YAED,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC3B,cAAc,GAAG,MAAM,gCAAgC,CAAC,MAAM,CAAC;oBAC7D,KAAK,EAAE;wBACL,YAAY,EAAE,IAAI,CAAC,YAAY;wBAC/B,UAAU,EAAE,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC;wBACxC,MAAM,EAAE,WAAW,CAAC,GAAG,CAAC;4BACtB,+BAA+B,CAAC,QAAQ;4BACxC,+BAA+B,CAAC,SAAS;yBAC1C,CAAC;qBACH;oBACD,MAAM,EAAE;wBACN,GAAG,EAAE,IAAI;wBACT,MAAM,EAAE,IAAI;wBACZ,YAAY,EAAE,IAAI;wBAClB,UAAU,EAAE,IAAI;wBAChB,iBAAiB,EAAE,IAAI;wBACvB,WAAW,EAAE,IAAI;qBAClB;oBACD,KAAK,EAAE,SAAS;oBAChB,IAAI,EAAE,CAAC;oBACP,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;iBACxB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CACV,sFAAsF,uBAAuB,CAC3G,IAAI,CAAC,YAAY,CAClB,sBAAsB,KAAK,EAAE,CAC/B,CAAC;QACJ,CAAC;QAED,OAAO;YACL,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,cAAc;YACd,aAAa;SACd,CAAC;IACJ,CAAC;IAED;;;;OAIG;IAEiB,AAAb,MAAM,CAAC,KAAK,CAAC,WAAW,CAA+B,IAI7D;;QACC,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrC,OAAO;QACT,CAAC;QAED,MAAM,OAAO,GAAgB,IAAI,GAAG,CAClC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,EAAY,EAAU,EAAE;YAC/C,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC;QACvB,CAAC,CAAC,CACH,CAAC;QAEF,MAAM,YAAY,GAChB,+BAA+B,CAC7B,IAAI,CAAC,QAAQ,CAAC,YAAY,EAC1B,IAAI,CAAC,YAAY,CAClB,CAAC;QAEJ,KAAK,MAAM,UAAU,IAAI,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,cAAc,KAAI,EAAE,EAAE,CAAC;YAC5D,MAAM,UAAU,GAAW,CAAA,MAAA,UAAU,CAAC,UAAU,0CAAE,QAAQ,EAAE,KAAI,EAAE,CAAC;YAEnE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC7B,SAAS;YACX,CAAC;YAED,MAAM,uBAAuB,CAAC,4BAA4B,CAAC;gBACzD,UAAU;gBACV,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC/B,YAAY,EAAE,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,aAAa,CAAC,UAAU,CAAC,KAAI,EAAE;gBAC3D,eAAe,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM;aACrD,CAAC,CAAC;QACL,CAAC;QAED,MAAM,uBAAuB,CAAC,8BAA8B,CAAC;YAC3D,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,WAAW,EAAE,IAAI,CAAC,cAAc;SACjC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,sBAAsB,CAAC,IAIpC;QACC,MAAM,QAAQ,GAAW,OAAO,uBAAuB,CAAC,IAAI,CAAC,YAAY,CAAC,GACxE,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,EAClD,EAAE,CAAC;QACH,MAAM,QAAQ,GAAW,gBAAgB,QAAQ,0CAA0C,CAAC;QAE5F,OAAO,IAAI,CAAC,aAAa,GAAG,CAAC;YAC3B,CAAC,CAAC,GAAG,QAAQ,IAAI,IAAI,CAAC,aAAa,oGAAoG;YACvI,CAAC,CAAC,GAAG,QAAQ,2CAA2C,CAAC;IAC7D,CAAC;IAED;;;;;;OAMG;IACK,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,IAKjD;;QACC,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QAE5B,IAAI,CAAC;YACH,MAAM,IAAI,GACR,4BAA4B,CAAC,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;YAC7D,oEAAoE;YACpE,MAAM,aAAa,GAAW,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,KAAI,EAAE,CAAC,CAAC,MAAM,CACzD,CAAC,OAA6B,EAAW,EAAE;gBACzC,OAAO,CACL,OAAO,CAAC,SAAS,KAAK,SAAS;oBAC/B,OAAO,CAAC,SAAS,CAAC,MAAM;wBACtB,mCAAmC,CAAC,OAAO,CAC9C,CAAC;YACJ,CAAC,CACF,CAAC,MAAM,CAAC;YAET,MAAM,IAAI,GAAW,uBAAuB,CAAC,sBAAsB,CAAC;gBAClE,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC/B,aAAa;aACd,CAAC,CAAC;YAEH,MAAM,gCAAgC,CAAC,uBAAuB,CAAC;gBAC7D,YAAY,EAAE,UAAU,CAAC,EAAG;gBAC5B,UAAU,EAAE,UAAU,CAAC,MAAO;gBAC9B,GAAG,gCACD,MAAM,EAAE,+BAA+B,CAAC,SAAS,EACjD,WAAW,EAAE,aAAa,CAAC,cAAc,EAAE,IACxC,CAAC,IAAI,CAAC,eAAe;oBACtB,CAAC,CAAC,EAAE,iBAAiB,EAAE,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,EAAE;oBACxD,CAAC,CAAC,EAAE,CAAC,KACP,iBAAiB,EAAE,UAAU,CAAC,iBAAiB;wBAC7C,CAAC,CAAC,GAAG,IAAI,OAAO,UAAU,CAAC,iBAAiB,EAAE;wBAC9C,CAAC,CAAC,IAAI,GACT;aACF,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CACV,uEAAuE,MAAA,UAAU,CAAC,EAAE,0CAAE,QAAQ,EAAE,iBAAiB,uBAAuB,CACtI,IAAI,CAAC,YAAY,CAClB,KAAK,KAAK,EAAE,CACd,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACK,MAAM,CAAC,KAAK,CAAC,8BAA8B,CAAC,IAGnD;QACC,IAAI,CAAC;YACH;;;eAGG;YACH,MAAM,sBAAsB;YAC1B,qGAAqG;YACrG,OAAO,CAAC,0CAA0C,CAAC,CAAC,OAAO,CAAC;YAE9D,MAAM,sBAAsB,CAAC,wBAAwB,CAAC;gBACpD,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC/B,WAAW,EAAE,IAAI,CAAC,WAAW;aAC9B,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CACV,4EAA4E,uBAAuB,CACjG,IAAI,CAAC,YAAY,CAClB,QAAQ,KAAK,EAAE,CACjB,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AA5OqB;IADnB,WAAW,EAAE;;;;iDA6Eb;AAQmB;IADnB,WAAW,EAAE;;;;gDAyCb"}