@oneuptime/common 12.0.9 → 12.0.11

package/build/dist/Utils/NetworkAutomation/RuleRunSummary.js

@@ -0,0 +1,78 @@
+/*
+ * Turns a rule run's counters into the sentences the dashboard shows.
+ *
+ * Pure and dependency-free on purpose: "the rule matched 12 devices but
+ * assigned none of them" is the answer people actually need from this
+ * feature — a run that did nothing is the common case once a rule has been
+ * run once — and phrasing that badly is a support ticket. Keeping it out of
+ * the component makes every branch of it testable.
+ */
+function pluralize(count, singular, plural) {
+    return `${count} ${count === 1 ? singular : plural}`;
+}
+function devices(count) {
+    return pluralize(count, "device", "devices");
+}
+export class RuleRunSummary {
+    /*
+     * The headline sentence for a site assignment run: what changed, or the
+     * most useful reason nothing did.
+     */
+    static describeSiteAssignmentRun(result) {
+        const lines = [];
+        if (result.devicesAssigned > 0) {
+            lines.push(`Assigned ${devices(result.devicesAssigned)} to this rule's site.`);
+        }
+        else {
+            lines.push(`No devices were reassigned. This rule matched ${devices(result.devicesMatched)} out of the ${devices(result.devicesEvaluated)} it looked at.`);
+        }
+        /*
+         * The three ways a matched device can be left alone. Each is reported
+         * only when it happened, and each names the fix, because "12 matched, 0
+         * assigned" with no explanation reads as a broken button.
+         */
+        if (result.devicesAlreadyInRuleSite > 0) {
+            lines.push(`${devices(result.devicesAlreadyInRuleSite)} already belonged to this rule's site.`);
+        }
+        if (result.devicesSkippedAlreadyInAnotherSite > 0) {
+            lines.push(`${devices(result.devicesSkippedAlreadyInAnotherSite)} were left where they are because they already belong to another site. Re-run with "Move devices that are already assigned to a site" to include them.`);
+        }
+        if (result.devicesClaimedByHigherPriorityRule > 0) {
+            lines.push(`${devices(result.devicesClaimedByHigherPriorityRule)} matched a higher-priority rule as well, so this rule left them to it. Run that rule to place them.`);
+        }
+        if (result.devicesFailed > 0) {
+            lines.push(`${devices(result.devicesFailed)} could not be updated. Check the server logs for the reason.`);
+        }
+        if (result.isTruncated) {
+            lines.push(`Only the first ${devices(result.devicesEvaluated)} were evaluated. Run the rule again to continue through the rest of the project.`);
+        }
+        return lines.join(" ");
+    }
+    // The same, for a label rule run.
+    static describeLabelRun(result) {
+        const lines = [];
+        if (result.devicesLabeled > 0) {
+            lines.push(`Labelled ${devices(result.devicesLabeled)} (${pluralize(result.labelsAttached, "label", "labels")} attached).`);
+        }
+        else {
+            lines.push(`No labels were attached. This rule matched ${devices(result.devicesMatched)} out of the ${devices(result.devicesEvaluated)} it looked at.`);
+            /*
+             * Matching everything and attaching nothing is the signature of a rule
+             * that has already been run — say so, rather than leaving it looking
+             * like a failure.
+             */
+            if (result.devicesMatched > 0) {
+                lines.push("Every matching device already carries this rule's labels, so there was nothing to add.");
+            }
+        }
+        if (result.labelsFailed > 0) {
+            lines.push(`${pluralize(result.labelsFailed, "label", "labels")} could not be attached. Check the server logs for the reason.`);
+        }
+        if (result.isTruncated) {
+            lines.push(`Only the first ${devices(result.devicesEvaluated)} were evaluated. Run the rule again to continue through the rest of the project.`);
+        }
+        return lines.join(" ");
+    }
+}
+export default RuleRunSummary;
+//# sourceMappingURL=RuleRunSummary.js.map

package/build/dist/Utils/NetworkAutomation/RuleRunSummary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RuleRunSummary.js","sourceRoot":"","sources":["../../../../Utils/NetworkAutomation/RuleRunSummary.ts"],"names":[],"mappings":"AAKA;;;;;;;;GAQG;AAEH,SAAS,SAAS,CAAC,KAAa,EAAE,QAAgB,EAAE,MAAc;IAChE,OAAO,GAAG,KAAK,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;AACvD,CAAC;AAED,SAAS,OAAO,CAAC,KAAa;IAC5B,OAAO,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;AAC/C,CAAC;AAED,MAAM,OAAO,cAAc;IACzB;;;OAGG;IACI,MAAM,CAAC,yBAAyB,CACrC,MAAmC;QAEnC,MAAM,KAAK,GAAkB,EAAE,CAAC;QAEhC,IAAI,MAAM,CAAC,eAAe,GAAG,CAAC,EAAE,CAAC;YAC/B,KAAK,CAAC,IAAI,CACR,YAAY,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,uBAAuB,CACnE,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CACR,iDAAiD,OAAO,CACtD,MAAM,CAAC,cAAc,CACtB,eAAe,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,gBAAgB,CACjE,CAAC;QACJ,CAAC;QAED;;;;WAIG;QACH,IAAI,MAAM,CAAC,wBAAwB,GAAG,CAAC,EAAE,CAAC;YACxC,KAAK,CAAC,IAAI,CACR,GAAG,OAAO,CACR,MAAM,CAAC,wBAAwB,CAChC,wCAAwC,CAC1C,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,CAAC,kCAAkC,GAAG,CAAC,EAAE,CAAC;YAClD,KAAK,CAAC,IAAI,CACR,GAAG,OAAO,CACR,MAAM,CAAC,kCAAkC,CAC1C,wJAAwJ,CAC1J,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,CAAC,kCAAkC,GAAG,CAAC,EAAE,CAAC;YAClD,KAAK,CAAC,IAAI,CACR,GAAG,OAAO,CACR,MAAM,CAAC,kCAAkC,CAC1C,qGAAqG,CACvG,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,CAAC,aAAa,GAAG,CAAC,EAAE,CAAC;YAC7B,KAAK,CAAC,IAAI,CACR,GAAG,OAAO,CACR,MAAM,CAAC,aAAa,CACrB,8DAA8D,CAChE,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YACvB,KAAK,CAAC,IAAI,CACR,kBAAkB,OAAO,CACvB,MAAM,CAAC,gBAAgB,CACxB,kFAAkF,CACpF,CAAC;QACJ,CAAC;QAED,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAED,kCAAkC;IAC3B,MAAM,CAAC,gBAAgB,CAAC,MAA0B;QACvD,MAAM,KAAK,GAAkB,EAAE,CAAC;QAEhC,IAAI,MAAM,CAAC,cAAc,GAAG,CAAC,EAAE,CAAC;YAC9B,KAAK,CAAC,IAAI,CACR,YAAY,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,SAAS,CACtD,MAAM,CAAC,cAAc,EACrB,OAAO,EACP,QAAQ,CACT,aAAa,CACf,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CACR,8CAA8C,OAAO,CACnD,MAAM,CAAC,cAAc,CACtB,eAAe,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,gBAAgB,CACjE,CAAC;YAEF;;;;eAIG;YACH,IAAI,MAAM,CAAC,cAAc,GAAG,CAAC,EAAE,CAAC;gBAC9B,KAAK,CAAC,IAAI,CACR,wFAAwF,CACzF,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,MAAM,CAAC,YAAY,GAAG,CAAC,EAAE,CAAC;YAC5B,KAAK,CAAC,IAAI,CACR,GAAG,SAAS,CACV,MAAM,CAAC,YAAY,EACnB,OAAO,EACP,QAAQ,CACT,+DAA+D,CACjE,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YACvB,KAAK,CAAC,IAAI,CACR,kBAAkB,OAAO,CACvB,MAAM,CAAC,gBAAgB,CACxB,kFAAkF,CACpF,CAAC;QACJ,CAAC;QAED,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;CACF;AAED,eAAe,cAAc,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oneuptime/common",
-  "version": "12.0.9",
+  "version": "12.0.11",
   "description": "",
   "repository": {
     "type": "git",