@adminiumjs/manifest 0.3.16 → 0.3.18-rc.0

package/dist/ledger-indexes.js

@@ -0,0 +1,74 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+/**
+ * THE KEY AND THE INDEXES ADMINIUM MAKES FOR A LEDGER.
+ *
+ * An add-on declares its receipt table's columns and nothing about how the
+ * table is keyed. Adminium derives that itself, from the ledger declaration,
+ * so no manifest can get it wrong — and so the one unique key that makes a
+ * posting happen once (source, line, posting, phase and round) is always
+ * there, on a new table and on one an install reuses:
+ *
+ *  - the receipt table: unique on its six key columns; an index on
+ *    (`line_table`, `source_line`), which a line's guard reads by; an index
+ *    on `held_until`, which the timed job scans;
+ *  - every ledger table an action inserts into: an index on `receipt_id`,
+ *    which a reverse reads the round's rows by.
+ *
+ * One function, called by the path that creates the tables and by the
+ * planner that edits a reused one. Pure.
+ */
+import { RECEIPT_KEY } from './ledgers.js';
+import { MYSQL_UNIQUE_KEY_BYTES, uniqueSetBytes } from './key-bytes.js';
+import { ledgersOf } from './schema.js';
+/** Every key and index a manifest's ledgers need, each table and column set once, in declaration order. */
+export function ledgerIndexes(manifest) {
+    return indexesOf(ledgersOf(manifest));
+}
+function indexesOf(ledgers) {
+    const out = [];
+    const seen = new Set();
+    const add = (table, columns, unique) => {
+        const key = `${table}|${columns.join(',')}`;
+        if (seen.has(key))
+            return;
+        seen.add(key);
+        out.push({ table, columns: [...columns], unique });
+    };
+    for (const ledger of ledgers) {
+        add(ledger.receipts, RECEIPT_KEY, true);
+        add(ledger.receipts, ['line_table', 'source_line'], false);
+        add(ledger.receipts, ['held_until'], false);
+        for (const [table, scope] of Object.entries(ledger.writes)) {
+            if (scope.insert !== undefined)
+                add(table, ['receipt_id'], false);
+        }
+    }
+    return out;
+}
+/**
+ * A receipt key too wide for MySQL to index (3,072 bytes, four a character of
+ * text): the widths of its text columns are the add-on's to choose, so the
+ * manifest is refused before any database is asked to make the key.
+ */
+export function ledgerIndexIssues(manifest) {
+    const out = [];
+    const tables = (manifest.requiredSchema?.tables ?? []);
+    for (const index of ledgerIndexes(manifest)) {
+        if (!index.unique)
+            continue;
+        const t = tables.findIndex((candidate) => candidate.ref === index.table);
+        const table = tables[t];
+        if (table === undefined)
+            continue;
+        const bytes = uniqueSetBytes(index.columns, table, tables);
+        if (bytes > MYSQL_UNIQUE_KEY_BYTES) {
+            const widths = index.columns.map((ref) => `${ref} ${String(table.columns.find((column) => column.ref === ref)?.maxLength ?? '')}`.trim()).join(', ');
+            out.push({
+                path: `requiredSchema.tables.${String(t)}.columns`,
+                message: `the key of the receipt table "${index.table}" (${widths}) takes ${String(bytes)} bytes, and MySQL indexes at most ${String(MYSQL_UNIQUE_KEY_BYTES)}: shorten its text columns (four bytes a character)`,
+            });
+        }
+    }
+    return out;
+}
+//# sourceMappingURL=ledger-indexes.js.map

package/dist/ledger-indexes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ledger-indexes.js","sourceRoot":"","sources":["../src/ledger-indexes.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,EAAE,WAAW,EAAe,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACxE,OAAO,EAAE,SAAS,EAAsC,MAAM,aAAa,CAAC;AAS5E,2GAA2G;AAC3G,MAAM,UAAU,aAAa,CAAC,QAAkB;IAC9C,OAAO,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;AACxC,CAAC;AAED,SAAS,SAAS,CAAC,OAA0B;IAC3C,MAAM,GAAG,GAAkB,EAAE,CAAC;IAC9B,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,MAAM,GAAG,GAAG,CAAC,KAAa,EAAE,OAA0B,EAAE,MAAe,EAAE,EAAE;QACzE,MAAM,GAAG,GAAG,GAAG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAC5C,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO;QAC1B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACd,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IACrD,CAAC,CAAC;IACF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;QACxC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,YAAY,EAAE,aAAa,CAAC,EAAE,KAAK,CAAC,CAAC;QAC3D,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC,CAAC;QAC5C,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3D,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS;gBAAE,GAAG,CAAC,KAAK,EAAE,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC,CAAC;QACpE,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,QAAkB;IAClD,MAAM,GAAG,GAAwC,EAAE,CAAC;IACpD,MAAM,MAAM,GAAG,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,IAAI,EAAE,CAAmE,CAAC;IACzH,KAAK,MAAM,KAAK,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5C,IAAI,CAAC,KAAK,CAAC,MAAM;YAAE,SAAS;QAC5B,MAAM,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,KAAK,KAAK,CAAC,KAAK,CAAC,CAAC;QACzE,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QACxB,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAClC,MAAM,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;QAC3D,IAAI,KAAK,GAAG,sBAAsB,EAAE,CAAC;YACnC,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,KAAK,GAAG,CAAC,EAAE,SAAS,IAAI,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACrJ,GAAG,CAAC,IAAI,CAAC;gBACP,IAAI,EAAE,yBAAyB,MAAM,CAAC,CAAC,CAAC,UAAU;gBAClD,OAAO,EAAE,iCAAiC,KAAK,CAAC,KAAK,MAAM,MAAM,WAAW,MAAM,CAAC,KAAK,CAAC,qCAAqC,MAAM,CAAC,sBAAsB,CAAC,qDAAqD;aAClN,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}