@empire-builder-kit/nx 1.0.0-beta.9 → 1.0.0-rc.2

package/src/generators/workload/reliability-registration.js

@@ -0,0 +1,150 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WORKLOAD_RELIABILITY_REGISTRY_PATH = void 0;
+exports.planWorkloadReliabilityRegistration = planWorkloadReliabilityRegistration;
+const deterministic_order_js_1 = require("../../deterministic-order.js");
+const reliability_1 = require("@empire-builder-kit/runtime/reliability");
+const node_path_1 = require("node:path");
+exports.WORKLOAD_RELIABILITY_REGISTRY_PATH = 'operations/reliability.json';
+function readOperations(tree, path, slice) {
+    const source = tree.read(path, 'utf8');
+    if (source === null) {
+        throw new Error(`Product Slice reliability registry is missing from ${path}.`);
+    }
+    let value;
+    try {
+        value = JSON.parse(source);
+    }
+    catch {
+        throw new Error(`Product Slice reliability registry is invalid at ${path}.`);
+    }
+    if (!value ||
+        typeof value !== 'object' ||
+        Array.isArray(value) ||
+        value.schemaVersion !== 1 ||
+        value.slice !== slice ||
+        !Array.isArray(value.alarmRegistrations) ||
+        !Array.isArray(value.deployedAlarmResources) ||
+        !Array.isArray(value.workloadCoverage)) {
+        throw new Error(`Product Slice reliability registry lacks the v1 workload contract at ${path}.`);
+    }
+    const operations = value;
+    if (operations.alarmRegistrations.some((entry) => !entry ||
+        typeof entry !== 'object' ||
+        typeof entry.id !== 'string' ||
+        entry.id.trim() === '') ||
+        operations.deployedAlarmResources.some((entry) => !entry ||
+            typeof entry !== 'object' ||
+            typeof entry.id !== 'string' ||
+            typeof entry.name !== 'string') ||
+        operations.workloadCoverage.some((entry) => !entry ||
+            typeof entry !== 'object' ||
+            typeof entry.kind !== 'string' ||
+            typeof entry.registration !== 'string')) {
+        throw new Error(`Product Slice reliability registry contains an invalid workload entry at ${path}.`);
+    }
+    return operations;
+}
+function planWorkloadReliabilityRegistration(tree, input) {
+    const path = node_path_1.posix.join(input.sliceRoot, exports.WORKLOAD_RELIABILITY_REGISTRY_PATH);
+    const operations = readOperations(tree, path, input.slice);
+    const alarmId = input.kind === 'service'
+        ? `service-${input.name}-health`
+        : `job-${input.name}-failure`;
+    if (operations.alarmRegistrations.some(({ id }) => id === alarmId) ||
+        operations.workloadCoverage.some(({ registration }) => registration === alarmId)) {
+        throw new Error(`Reliability alarm ${alarmId} is already registered.`);
+    }
+    const owner = `${input.slice}-product`;
+    const runbookRef = `${input.kind === 'service' ? 'services' : 'jobs'}/${input.name}/RUNBOOK.md`;
+    operations.alarmRegistrations = [
+        ...operations.alarmRegistrations,
+        (0, reliability_1.validateAlarmRegistrationMetadata)({
+            businessSymptom: input.kind === 'service'
+                ? `${input.name} Service health checks are failing.`
+                : `${input.name} Job executions are failing.`,
+            condition: input.kind === 'service'
+                ? 'The AWS-native ECS RunningTaskCount signal is below one or missing for the exact Service.'
+                : 'An AWS-native ECS task-state event reports an essential container exit for the exact Job task family.',
+            dependencyAlarmIds: [],
+            escalationRouteKey: `${input.slice}-on-call`,
+            expectedFalseNegativeRisk: input.kind === 'service'
+                ? 'Container Insights delivery can be delayed; missing data is therefore treated as breaching.'
+                : 'ECS task-state events are durable but can be delayed before EventBridge reports a match.',
+            expectedFalsePositiveRisk: input.kind === 'service'
+                ? 'A synthetic health client can fail while the Service remains available.'
+                : 'A retried Job attempt can fail before a later attempt succeeds.',
+            id: alarmId,
+            missingData: 'missing',
+            owner,
+            runbookRef: `runbook:${runbookRef}`,
+            severity: 'high',
+            testRef: `evidence:reliability/${input.kind}-${input.name}-failure-recovery`,
+        }),
+    ].sort((left, right) => (0, deterministic_order_js_1.compareUtf16)(left.id, right.id));
+    const deployedAlarmResource = {
+        actions: 'primary-route',
+        comparisonOperator: input.kind === 'service'
+            ? 'LessThanThreshold'
+            : 'GreaterThanOrEqualToThreshold',
+        dimensionNames: input.kind === 'service' ? ['ClusterName', 'ServiceName'] : ['RuleName'],
+        evaluationPeriods: 1,
+        id: alarmId,
+        metricName: input.kind === 'service' ? 'RunningTaskCount' : 'MatchedEvents',
+        name: `${input.slice}-{stage}-${input.kind}-${input.name}-${input.kind === 'service' ? 'running' : 'hard-crash'}`,
+        namespace: input.kind === 'service' ? 'ECS/ContainerInsights' : 'AWS/Events',
+        owner,
+        period: 60,
+        route: `${input.slice}-on-call`,
+        runbook: runbookRef,
+        signal: 'metric',
+        statistic: 'Sum',
+        threshold: 1,
+        treatMissingData: input.kind === 'service' ? 'breaching' : 'notBreaching',
+    };
+    operations.deployedAlarmResources = [
+        ...operations.deployedAlarmResources,
+        deployedAlarmResource,
+    ].sort((left, right) => (0, deterministic_order_js_1.compareUtf16)(left.id, right.id));
+    operations.workloadCoverage = operations.workloadCoverage
+        .filter(({ kind, registration }) => !(kind === input.kind &&
+        registration ===
+            `required-when-generated-by-ebk-workload-${input.kind}-${input.kind === 'service' ? 'health' : 'failure'}`))
+        .concat({ kind: input.kind, registration: alarmId })
+        .sort((left, right) => (0, deterministic_order_js_1.compareUtf16)(`${left.kind}\0${left.registration}`, `${right.kind}\0${right.registration}`));
+    const performance = operations.performanceReferences;
+    if (!performance ||
+        !Array.isArray(performance.alarms) ||
+        !Array.isArray(performance.capacityControls) ||
+        !Array.isArray(performance.capacitySignals)) {
+        throw new Error(`Product Slice reliability registry lacks the v1 performance authority at ${path}.`);
+    }
+    const capacityControl = `control:${input.kind}-${input.name}-concurrency`;
+    const capacitySignal = input.kind === 'service'
+        ? `runtime:service-${input.name}-per-task-concurrency-utilization-percent`
+        : `alarm:job-${input.name}-failure`;
+    const replaceableService = input.kind === 'service';
+    performance.capacityControls = [
+        ...performance.capacityControls.filter((reference) => !replaceableService ||
+            reference !== 'control:service-extension-concurrency'),
+        capacityControl,
+    ].sort();
+    performance.capacitySignals = [
+        ...performance.capacitySignals.filter((reference) => !replaceableService ||
+            reference !== 'adopter:service-saturation-percent'),
+        capacitySignal,
+    ].sort();
+    if (capacitySignal.startsWith('alarm:')) {
+        performance.alarms = [
+            ...new Set([...performance.alarms, capacitySignal]),
+        ].sort();
+    }
+    return {
+        alarmId,
+        contents: `${JSON.stringify(operations, null, 2)}\n`,
+        metricName: input.kind === 'service' ? 'RunningTaskCount' : 'MatchedEvents',
+        path,
+        runbookRef,
+    };
+}
+//# sourceMappingURL=reliability-registration.js.map

package/src/generators/workload/reliability-registration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reliability-registration.js","sourceRoot":"","sources":["../../../../../../packages/nx/src/generators/workload/reliability-registration.ts"],"names":[],"mappings":";;;AA6HA,kFA0JC;AAvRD,yEAA4D;AAE5D,yEAGiD;AACjD,yCAAkC;AAErB,QAAA,kCAAkC,GAC7C,6BAAsC,CAAC;AAoDzC,SAAS,cAAc,CACrB,IAAU,EACV,IAAY,EACZ,KAAa;IAEb,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACvC,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CACb,sDAAsD,IAAI,GAAG,CAC9D,CAAC;IACJ,CAAC;IACD,IAAI,KAAc,CAAC;IACnB,IAAI,CAAC;QACH,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAY,CAAC;IACxC,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CACb,oDAAoD,IAAI,GAAG,CAC5D,CAAC;IACJ,CAAC;IACD,IACE,CAAC,KAAK;QACN,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACnB,KAA+B,CAAC,aAAa,KAAK,CAAC;QACnD,KAA+B,CAAC,KAAK,KAAK,KAAK;QAChD,CAAC,KAAK,CAAC,OAAO,CAAE,KAA+B,CAAC,kBAAkB,CAAC;QACnE,CAAC,KAAK,CAAC,OAAO,CAAE,KAA+B,CAAC,sBAAsB,CAAC;QACvE,CAAC,KAAK,CAAC,OAAO,CAAE,KAA+B,CAAC,gBAAgB,CAAC,EACjE,CAAC;QACD,MAAM,IAAI,KAAK,CACb,wEAAwE,IAAI,GAAG,CAChF,CAAC;IACJ,CAAC;IACD,MAAM,UAAU,GAAG,KAA8B,CAAC;IAClD,IACE,UAAU,CAAC,kBAAkB,CAAC,IAAI,CAChC,CAAC,KAAK,EAAE,EAAE,CACR,CAAC,KAAK;QACN,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ;QAC5B,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,CACzB;QACD,UAAU,CAAC,sBAAsB,CAAC,IAAI,CACpC,CAAC,KAAK,EAAE,EAAE,CACR,CAAC,KAAK;YACN,OAAO,KAAK,KAAK,QAAQ;YACzB,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ;YAC5B,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CACjC;QACD,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAC9B,CAAC,KAAK,EAAE,EAAE,CACR,CAAC,KAAK;YACN,OAAO,KAAK,KAAK,QAAQ;YACzB,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;YAC9B,OAAO,KAAK,CAAC,YAAY,KAAK,QAAQ,CACzC,EACD,CAAC;QACD,MAAM,IAAI,KAAK,CACb,4EAA4E,IAAI,GAAG,CACpF,CAAC;IACJ,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAgB,mCAAmC,CACjD,IAAU,EACV,KAMC;IAED,MAAM,IAAI,GAAG,iBAAK,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,0CAAkC,CAAC,CAAC;IAC7E,MAAM,UAAU,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAC3D,MAAM,OAAO,GACX,KAAK,CAAC,IAAI,KAAK,SAAS;QACtB,CAAC,CAAC,WAAW,KAAK,CAAC,IAAI,SAAS;QAChC,CAAC,CAAC,OAAO,KAAK,CAAC,IAAI,UAAU,CAAC;IAClC,IACE,UAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,OAAO,CAAC;QAC9D,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAC9B,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC,YAAY,KAAK,OAAO,CAC/C,EACD,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,qBAAqB,OAAO,yBAAyB,CAAC,CAAC;IACzE,CAAC;IAED,MAAM,KAAK,GAAG,GAAG,KAAK,CAAC,KAAK,UAAU,CAAC;IACvC,MAAM,UAAU,GAAG,GAAG,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,IAClE,KAAK,CAAC,IACR,aAAa,CAAC;IACd,UAAU,CAAC,kBAAkB,GAAG;QAC9B,GAAG,UAAU,CAAC,kBAAkB;QAChC,IAAA,+CAAiC,EAAC;YAChC,eAAe,EACb,KAAK,CAAC,IAAI,KAAK,SAAS;gBACtB,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,qCAAqC;gBACpD,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,8BAA8B;YACjD,SAAS,EACP,KAAK,CAAC,IAAI,KAAK,SAAS;gBACtB,CAAC,CAAC,2FAA2F;gBAC7F,CAAC,CAAC,uGAAuG;YAC7G,kBAAkB,EAAE,EAAE;YACtB,kBAAkB,EAAE,GAAG,KAAK,CAAC,KAAK,UAAU;YAC5C,yBAAyB,EACvB,KAAK,CAAC,IAAI,KAAK,SAAS;gBACtB,CAAC,CAAC,6FAA6F;gBAC/F,CAAC,CAAC,0FAA0F;YAChG,yBAAyB,EACvB,KAAK,CAAC,IAAI,KAAK,SAAS;gBACtB,CAAC,CAAC,yEAAyE;gBAC3E,CAAC,CAAC,iEAAiE;YACvE,EAAE,EAAE,OAAO;YACX,WAAW,EAAE,SAAS;YACtB,KAAK;YACL,UAAU,EAAE,WAAW,UAAU,EAAE;YACnC,QAAQ,EAAE,MAAM;YAChB,OAAO,EAAE,wBAAwB,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,mBAAmB;SAC7E,CAAC;KACH,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAA,qCAAY,EAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;IAEzD,MAAM,qBAAqB,GAA0B;QACnD,OAAO,EAAE,eAAe;QACxB,kBAAkB,EAChB,KAAK,CAAC,IAAI,KAAK,SAAS;YACtB,CAAC,CAAC,mBAAmB;YACrB,CAAC,CAAC,+BAA+B;QACrC,cAAc,EACZ,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;QAC1E,iBAAiB,EAAE,CAAC;QACpB,EAAE,EAAE,OAAO;QACX,UAAU,EAAE,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,eAAe;QAC3E,IAAI,EAAE,GAAG,KAAK,CAAC,KAAK,YAAY,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,IACtD,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YACzC,EAAE;QACF,SAAS,EACP,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,YAAY;QACnE,KAAK;QACL,MAAM,EAAE,EAAE;QACV,KAAK,EAAE,GAAG,KAAK,CAAC,KAAK,UAAU;QAC/B,OAAO,EAAE,UAAU;QACnB,MAAM,EAAE,QAAQ;QAChB,SAAS,EAAE,KAAK;QAChB,SAAS,EAAE,CAAC;QACZ,gBAAgB,EAAE,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,cAAc;KAC1E,CAAC;IACF,UAAU,CAAC,sBAAsB,GAAG;QAClC,GAAG,UAAU,CAAC,sBAAsB;QACpC,qBAAqB;KACtB,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAA,qCAAY,EAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;IAEzD,UAAU,CAAC,gBAAgB,GAAG,UAAU,CAAC,gBAAgB;SACtD,MAAM,CACL,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,EAAE,CACzB,CAAC,CACC,IAAI,KAAK,KAAK,CAAC,IAAI;QACnB,YAAY;YACV,2CAA2C,KAAK,CAAC,IAAI,IACnD,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SACxC,EAAE,CACL,CACJ;SACA,MAAM,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC;SACnD,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CACpB,IAAA,qCAAY,EACV,GAAG,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,YAAY,EAAE,EACpC,GAAG,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,YAAY,EAAE,CACvC,CACF,CAAC;IAEJ,MAAM,WAAW,GAAG,UAAU,CAAC,qBAAqB,CAAC;IACrD,IACE,CAAC,WAAW;QACZ,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC;QAClC,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,gBAAgB,CAAC;QAC5C,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,eAAe,CAAC,EAC3C,CAAC;QACD,MAAM,IAAI,KAAK,CACb,4EAA4E,IAAI,GAAG,CACpF,CAAC;IACJ,CAAC;IACD,MAAM,eAAe,GAAG,WAAW,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,cAAc,CAAC;IAC1E,MAAM,cAAc,GAClB,KAAK,CAAC,IAAI,KAAK,SAAS;QACtB,CAAC,CAAC,mBAAmB,KAAK,CAAC,IAAI,2CAA2C;QAC1E,CAAC,CAAC,aAAa,KAAK,CAAC,IAAI,UAAU,CAAC;IACxC,MAAM,kBAAkB,GAAG,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC;IACpD,WAAW,CAAC,gBAAgB,GAAG;QAC7B,GAAG,WAAW,CAAC,gBAAgB,CAAC,MAAM,CACpC,CAAC,SAAS,EAAE,EAAE,CACZ,CAAC,kBAAkB;YACnB,SAAS,KAAK,uCAAuC,CACxD;QACD,eAAe;KAChB,CAAC,IAAI,EAAE,CAAC;IACT,WAAW,CAAC,eAAe,GAAG;QAC5B,GAAG,WAAW,CAAC,eAAe,CAAC,MAAM,CACnC,CAAC,SAAS,EAAE,EAAE,CACZ,CAAC,kBAAkB;YACnB,SAAS,KAAK,oCAAoC,CACrD;QACD,cAAc;KACf,CAAC,IAAI,EAAE,CAAC;IACT,IAAI,cAAc,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxC,WAAW,CAAC,MAAM,GAAG;YACnB,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;SACpD,CAAC,IAAI,EAAE,CAAC;IACX,CAAC;IAED,OAAO;QACL,OAAO;QACP,QAAQ,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI;QACpD,UAAU,EAAE,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,eAAe;QAC3E,IAAI;QACJ,UAAU;KACX,CAAC;AACJ,CAAC"}

package/src/generators/workload/schema.d.ts

@@ -1,4 +1,5 @@
 export interface WorkloadGeneratorSchema {
+  feature: string;
   name: string;
   skipFormat?: boolean;
   skipInstall?: boolean;

package/src/generators/workload/schema.json

@@ -5,6 +5,11 @@
   "type": "object",
   "additionalProperties": false,
   "properties": {
+    "feature": {
+      "type": "string",
+      "description": "Existing Slice feature id",
+      "x-prompt": "Which registered feature owns this workload?"
+    },
     "name": {
       "type": "string",
       "$default": { "$source": "argv", "index": 0 }
@@ -17,5 +22,5 @@
     "skipFormat": { "type": "boolean", "default": false },
     "skipInstall": { "type": "boolean", "default": false }
   },
-  "required": ["name", "slice"]
+  "required": ["feature", "name", "slice"]
 }

package/src/generators/workload/service-performance-files.d.ts

@@ -0,0 +1,4 @@
+export declare function renderServicePerformanceFiles(input: {
+    slice: string;
+    workload: string;
+}): Readonly<Record<string, string>>;