ag-common 0.0.899 → 0.0.900

package/dist/api/helpers/enforceDynamoProvisionCap.d.ts

@@ -1,28 +1,9 @@
-interface DynamoTableConstruct {
-    node: {
-        _children: {
-            Resource: {
-                node: {
-                    scope: unknown;
-                };
-            };
-        };
-    };
-}
-/** ensure that dynamo tables in stack dont exceed passed in provisioned limits */
-export declare const enforceDynamoProvisionCap: ({ tables, readsMax, writesMax, mustEqual, }: {
-    tables: DynamoTableConstruct[];
-    /**
-     * default 25
-     */
+import { aws_dynamodb as dynamodb } from "aws-cdk-lib";
+export interface EnforceDynamoProvisionCapOptions {
+    tables: dynamodb.Table[];
     readsMax?: number;
-    /**
-     * default 25
-     */
     writesMax?: number;
-    /**
-     * default false. if true, will throw if cap isnt met. will still throw if exceeds.
-     */
     mustEqual?: boolean;
-}) => void;
-export {};
+}
+/** Ensure the supplied DynamoDB tables do not exceed the provisioned capacity limits. */
+export declare const enforceDynamoProvisionCap: ({ tables, readsMax, writesMax, mustEqual, }: EnforceDynamoProvisionCapOptions) => void;

package/dist/api/helpers/enforceDynamoProvisionCap.js

@@ -1,32 +1,123 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.enforceDynamoProvisionCap = void 0;
+const aws_cdk_lib_1 = require("aws-cdk-lib");
 const log_1 = require("../../common/helpers/log");
-const math_1 = require("../../common/helpers/math");
-const json_1 = require("../../common/helpers/string/json");
-const trim_1 = require("../../common/helpers/string/trim");
-const extractSum = ({ str, regex }) => (0, math_1.sumArray)(str
-    .match(regex)
-    ?.map((s2) => (0, trim_1.trim)(s2.substring(s2.indexOf(":") + 1), ":", ",", " "))
-    .filter((r) => r && Number(r))
-    .map((r) => Number(r)) ?? []);
-/** ensure that dynamo tables in stack dont exceed passed in provisioned limits */
+const ZERO_CAPACITY = {
+    reads: 0,
+    writes: 0,
+};
+const isResolvable = (value) => "resolve" in value && typeof value.resolve === "function";
+const isRecord = (value) => typeof value === "object" && value !== null;
+const isUnknownArray = (value) => Array.isArray(value);
+const getResolvedCapacity = ({ value, label }) => {
+    if (aws_cdk_lib_1.Token.isUnresolved(value)) {
+        throw new Error(`Cannot enforce DynamoDB provision cap with unresolved ${label}`);
+    }
+    return value;
+};
+const getProvisionedThroughput = ({ throughput, label, }) => {
+    if (!throughput) {
+        return ZERO_CAPACITY;
+    }
+    if (isResolvable(throughput)) {
+        throw new Error(`Cannot enforce DynamoDB provision cap with unresolved ${label}`);
+    }
+    return {
+        reads: getResolvedCapacity({
+            value: throughput.readCapacityUnits,
+            label: `${label} read capacity`,
+        }),
+        writes: getResolvedCapacity({
+            value: throughput.writeCapacityUnits,
+            label: `${label} write capacity`,
+        }),
+    };
+};
+const getResolvedIndexThroughput = ({ throughput, label, }) => {
+    if (throughput === undefined) {
+        return ZERO_CAPACITY;
+    }
+    if (!isRecord(throughput) || isResolvable(throughput)) {
+        throw new Error(`Cannot enforce DynamoDB provision cap with unresolved ${label}`);
+    }
+    const reads = throughput.readCapacityUnits;
+    const writes = throughput.writeCapacityUnits;
+    if (typeof reads !== "number" || aws_cdk_lib_1.Token.isUnresolved(reads)) {
+        throw new Error(`Cannot enforce DynamoDB provision cap with unresolved ${label} read capacity`);
+    }
+    if (typeof writes !== "number" || aws_cdk_lib_1.Token.isUnresolved(writes)) {
+        throw new Error(`Cannot enforce DynamoDB provision cap with unresolved ${label} write capacity`);
+    }
+    return { reads, writes };
+};
+const getTableResource = (table) => {
+    const resource = table.node.defaultChild;
+    if (!(resource instanceof aws_cdk_lib_1.aws_dynamodb.CfnTable)) {
+        throw new Error(`Unable to inspect DynamoDB table resource: ${table.node.path}`);
+    }
+    return resource;
+};
+const getGlobalSecondaryIndexCapacity = (table) => {
+    const indexes = table.globalSecondaryIndexes;
+    if (!indexes) {
+        return ZERO_CAPACITY;
+    }
+    const resolvedIndexes = isResolvable(indexes)
+        ? aws_cdk_lib_1.Stack.of(table).resolve(indexes)
+        : indexes;
+    if (resolvedIndexes === undefined) {
+        return ZERO_CAPACITY;
+    }
+    if (!isUnknownArray(resolvedIndexes)) {
+        throw new Error(`Cannot enforce DynamoDB provision cap with unresolved indexes for ${table.node.path}`);
+    }
+    return resolvedIndexes.reduce((total, index, indexPosition) => {
+        if (!isRecord(index) || isResolvable(index)) {
+            throw new Error(`Cannot enforce DynamoDB provision cap with unresolved index ${indexPosition} for ${table.node.path}`);
+        }
+        const capacity = getResolvedIndexThroughput({
+            throughput: index.provisionedThroughput,
+            label: `${table.node.path} index ${indexPosition}`,
+        });
+        return {
+            reads: total.reads + capacity.reads,
+            writes: total.writes + capacity.writes,
+        };
+    }, { ...ZERO_CAPACITY });
+};
+const getTableCapacity = (table) => {
+    const resource = getTableResource(table);
+    const tableCapacity = getProvisionedThroughput({
+        throughput: resource.provisionedThroughput,
+        label: resource.node.path,
+    });
+    const indexCapacity = getGlobalSecondaryIndexCapacity(resource);
+    return {
+        reads: tableCapacity.reads + indexCapacity.reads,
+        writes: tableCapacity.writes + indexCapacity.writes,
+    };
+};
+/** Ensure the supplied DynamoDB tables do not exceed the provisioned capacity limits. */
 const enforceDynamoProvisionCap = ({ tables, readsMax = 25, writesMax = 25, mustEqual = false, }) => {
     if (tables.length === 0) {
         (0, log_1.warn)("error in dynamo FT enforce");
         return;
     }
-    const t = tables[0];
-    const s = (0, json_1.safeStringify)(t.node._children.Resource.node.scope);
-    const reads = extractSum({ str: s, regex: /readCapacityUnits.*/gim });
-    const writes = extractSum({ str: s, regex: /writeCapacityUnits.*/gim });
-    (0, log_1.warn)(`dynamo table provisioned reads:${reads}/${readsMax}`);
-    (0, log_1.warn)(`dynamo table provisioned writes:${writes}/${writesMax}`);
-    if (reads > readsMax || writes > writesMax) {
+    const capacity = tables.reduce((total, table) => {
+        const tableCapacity = getTableCapacity(table);
+        return {
+            reads: total.reads + tableCapacity.reads,
+            writes: total.writes + tableCapacity.writes,
+        };
+    }, { ...ZERO_CAPACITY });
+    (0, log_1.warn)(`dynamo table provisioned reads:${capacity.reads}/${readsMax}`);
+    (0, log_1.warn)(`dynamo table provisioned writes:${capacity.writes}/${writesMax}`);
+    if (capacity.reads > readsMax || capacity.writes > writesMax) {
         throw new Error("exceeded dynamo provision cap");
     }
-    if (mustEqual && (reads !== readsMax || writes !== writesMax)) {
-        throw new Error(`dynamo provision cap not met`);
+    if (mustEqual && (capacity.reads !== readsMax || capacity.writes !== writesMax)) {
+        throw new Error("dynamo provision cap not met");
     }
 };
 exports.enforceDynamoProvisionCap = enforceDynamoProvisionCap;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ag-common",
-  "version": "0.0.899",
+  "version": "0.0.900",
   "license": "ISC",
   "author": "admin@gec.dev",
   "repository": {
@@ -39,7 +39,6 @@
     "@radix-ui/react-scroll-area": "^1.2.18",
     "@radix-ui/react-select": "^2.3.7",
     "@radix-ui/react-switch": "^1.3.7",
-    "aws-cdk-lib": "^2.262.1",
     "buffer": "^6.0.3",
     "class-variance-authority": "^0.7.1",
     "clsx": "^2.1.1",
@@ -61,6 +60,8 @@
     "@types/node": "^26.1.1",
     "@types/react": "^19.2.17",
     "@types/react-dom": "^19.2.3",
+    "aws-cdk-lib": "^2.265.0",
+    "constructs": "^10.8.1",
     "cross-env": "^10.1.0",
     "eslint-config-e7npm": "0.1.52",
     "globstar": "^1.0.0",
@@ -73,6 +74,10 @@
     "tsx": "^4.23.12",
     "typescript": "^7.0.2"
   },
+  "peerDependencies": {
+    "aws-cdk-lib": "^2.262.1",
+    "constructs": "^10.0.0"
+  },
   "scripts": {
     "preinstall": "npx only-allow pnpm",
     "format": "e7-oxfmt --config .oxfmtrc.json --disable-nested-config .",
@@ -81,6 +86,6 @@
     "build": "rimraf dist && tsc -p tsconfig.build.json",
     "start": "cross-env BROWSER=none cross-env storybook dev -p 6006",
     "build-storybook": "storybook build -o docs --quiet",
-    "test": "globstar -- node --import tsx --test \"src/**/*.test.ts\""
+    "test": "globstar -- node --import tsx --test \"src/tests/**/*.test.ts\""
   }
 }