@kazurolabs/psql-explorer 0.1.0 → 0.3.1

package/dist/explorer/session.js

@@ -99,7 +99,31 @@ export const openSession = async (params, options = {}) => {
                 durationMs,
             };
         }),
-        rows: (sql, values = []) => serial(async () => (await client.query(sql, [...values])).rows),
+        // Always the extended protocol, which takes one statement: without values node-postgres
+        // would use the simple one, which runs every statement in the text, COMMIT and BEGIN
+        // READ WRITE included, and so gets around a read only session.
+        rows: (sql, values = []) => serial(async () => (await client.query({
+            text: sql,
+            values: [...values],
+            queryMode: 'extended',
+        })).rows),
+        // From a connection of its own, since this one is busy with the statement to stop.
+        cancel: async () => {
+            const pid = client.processID;
+            if (!pid)
+                return;
+            const other = createClient(params, { ...options, statementTimeoutMs: 5000, readOnly: true });
+            try {
+                await other.connect();
+                await other.query('SELECT pg_catalog.pg_cancel_backend($1)', [pid]);
+            }
+            catch {
+                // The statement may have finished meanwhile, or the server cannot be reached.
+            }
+            finally {
+                await other.end().catch(() => undefined);
+            }
+        },
         close: () => serial(() => client.end().catch(() => undefined)),
     };
 };

package/dist/explorer/stats.js

@@ -0,0 +1,135 @@
+import { qualified } from './catalog.js';
+const utc = (column) => `to_char(${column} AT TIME ZONE 'UTC', 'YYYY-MM-DD"T"HH24:MI:SS"Z"')`;
+const kinds = {
+    r: 'table',
+    p: 'partitioned',
+    m: 'materialized',
+};
+const count = (value) => (value === null ? null : Number(value));
+const flag = (value) => value === 't';
+/**
+ * Tables and materialized views with their sizes and upkeep, biggest first. The schemas of the
+ * system are left out; `table` narrows it to one.
+ */
+export async function listTableStats(session, table) {
+    const rows = await session.rows(`WITH rel AS (
+			SELECT c.oid, n.nspname AS schema, c.relname AS name, c.relkind AS kind, c.reltuples,
+				c.relpages,
+				pg_catalog.pg_relation_size(c.oid) AS heap_bytes,
+				pg_catalog.pg_table_size(c.oid) AS table_and_toast_bytes,
+				pg_catalog.pg_indexes_size(c.oid) AS index_bytes,
+				CASE WHEN c.reltoastrelid = 0 THEN 0
+					ELSE pg_catalog.pg_total_relation_size(c.reltoastrelid) END AS toast_bytes,
+				pg_catalog.pg_total_relation_size(c.oid) AS total_bytes,
+				-- The bytes a row needs: its header, its pointer in the page, and its columns.
+				(SELECT 24 + 4 + sum(s.avg_width) FROM pg_catalog.pg_stats s
+					WHERE s.schemaname = n.nspname AND s.tablename = c.relname
+						AND NOT s.inherited) AS row_bytes,
+				coalesce((SELECT option_value::numeric
+					FROM pg_catalog.pg_options_to_table(c.reloptions)
+					WHERE option_name = 'fillfactor'), 100) AS fillfactor
+			FROM pg_catalog.pg_class c
+			JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
+			WHERE c.relkind IN ('r', 'p', 'm')
+				AND n.nspname !~ '^pg_' AND n.nspname <> 'information_schema'
+				AND ($1::text IS NULL OR c.oid = $1::regclass)
+		)
+		SELECT r.schema, r.name, r.kind,
+			CASE WHEN r.reltuples < 0 THEN NULL ELSE r.reltuples::int8 END AS estimated_rows,
+			r.table_and_toast_bytes - r.toast_bytes AS table_bytes,
+			r.index_bytes, r.toast_bytes, r.total_bytes,
+			CASE WHEN r.row_bytes IS NULL OR r.reltuples < 0 OR r.kind = 'p' THEN NULL
+				ELSE greatest(r.heap_bytes - ceil(r.reltuples * r.row_bytes
+					/ ((current_setting('block_size')::int - 24) * r.fillfactor / 100))
+					* current_setting('block_size')::int, 0)::int8
+			END AS bloat_bytes,
+			s.n_live_tup AS live_rows, s.n_dead_tup AS dead_rows,
+			s.seq_scan AS seq_scans, s.idx_scan AS index_scans,
+			${utc('s.last_vacuum')} AS last_vacuum, ${utc('s.last_autovacuum')} AS last_autovacuum,
+			${utc('s.last_analyze')} AS last_analyze, ${utc('s.last_autoanalyze')} AS last_autoanalyze
+		FROM rel r
+		LEFT JOIN pg_catalog.pg_stat_all_tables s ON s.relid = r.oid
+		ORDER BY r.total_bytes DESC, r.schema, r.name`, [table ? qualified(table) : null]);
+    return rows.map((row) => ({
+        schema: row.schema ?? '',
+        name: row.name ?? '',
+        kind: kinds[row.kind ?? ''] ?? 'table',
+        estimatedRows: count(row.estimated_rows),
+        tableBytes: Number(row.table_bytes),
+        indexBytes: Number(row.index_bytes),
+        toastBytes: Number(row.toast_bytes),
+        totalBytes: Number(row.total_bytes),
+        bloatBytes: count(row.bloat_bytes),
+        liveRows: count(row.live_rows),
+        deadRows: count(row.dead_rows),
+        seqScans: count(row.seq_scans),
+        indexScans: count(row.index_scans),
+        lastVacuum: row.last_vacuum,
+        lastAutovacuum: row.last_autovacuum,
+        lastAnalyze: row.last_analyze,
+        lastAutoanalyze: row.last_autoanalyze,
+    }));
+}
+/**
+ * Every index of the user's tables (or of one table) with its size, how often it was used, and the
+ * other indexes it duplicates: the same table, columns, operator classes, expressions and
+ * condition. Biggest first.
+ */
+export async function listIndexStats(session, table) {
+    const rows = await session.rows(`SELECT n.nspname AS schema, t.relname AS "table", i.relname AS name,
+			pg_catalog.pg_get_indexdef(x.indexrelid) AS definition,
+			pg_catalog.pg_relation_size(x.indexrelid) AS bytes,
+			x.indisprimary AS "primary", x.indisunique AS "unique", x.indisvalid AS valid,
+			EXISTS (SELECT 1 FROM pg_catalog.pg_constraint k WHERE k.conindid = x.indexrelid
+				AND k.conrelid = x.indrelid AND k.contype IN ('p', 'u', 'x')) AS "constraint",
+			coalesce(s.idx_scan, 0) AS scans,
+			array_to_json(ARRAY(SELECT o.relname FROM pg_catalog.pg_index y
+				JOIN pg_catalog.pg_class o ON o.oid = y.indexrelid
+				WHERE y.indrelid = x.indrelid AND y.indexrelid <> x.indexrelid
+					AND y.indkey::text = x.indkey::text AND y.indclass::text = x.indclass::text
+					AND y.indcollation::text = x.indcollation::text
+					AND o.relam = i.relam
+					AND coalesce(pg_catalog.pg_get_expr(y.indexprs, y.indrelid), '')
+						= coalesce(pg_catalog.pg_get_expr(x.indexprs, x.indrelid), '')
+					AND coalesce(pg_catalog.pg_get_expr(y.indpred, y.indrelid), '')
+						= coalesce(pg_catalog.pg_get_expr(x.indpred, x.indrelid), '')
+				ORDER BY o.relname))::text AS duplicate_of
+		FROM pg_catalog.pg_index x
+		JOIN pg_catalog.pg_class i ON i.oid = x.indexrelid
+		JOIN pg_catalog.pg_class t ON t.oid = x.indrelid
+		JOIN pg_catalog.pg_namespace n ON n.oid = t.relnamespace
+		LEFT JOIN pg_catalog.pg_stat_all_indexes s ON s.indexrelid = x.indexrelid
+		WHERE t.relkind IN ('r', 'p', 'm')
+			AND n.nspname !~ '^pg_' AND n.nspname <> 'information_schema'
+			AND ($1::text IS NULL OR x.indrelid = $1::regclass)
+		ORDER BY bytes DESC, n.nspname, t.relname, i.relname`, [table ? qualified(table) : null]);
+    return rows.map((row) => ({
+        schema: row.schema ?? '',
+        table: row.table ?? '',
+        name: row.name ?? '',
+        definition: row.definition ?? '',
+        bytes: Number(row.bytes),
+        primary: flag(row.primary),
+        unique: flag(row.unique),
+        constraint: flag(row.constraint),
+        valid: flag(row.valid),
+        scans: Number(row.scans),
+        duplicateOf: JSON.parse(row.duplicate_of ?? '[]'),
+    }));
+}
+/** The sizes and upkeep of every table and index of the database, biggest first. */
+export async function databaseStats(session) {
+    const [row] = await session.rows(`SELECT current_database() AS database,
+			pg_catalog.pg_database_size(current_database()) AS bytes,
+			(SELECT ${utc('stats_reset')} FROM pg_catalog.pg_stat_database
+				WHERE datname = current_database()) AS reset`);
+    const tables = await listTableStats(session);
+    const indexes = await listIndexStats(session);
+    return {
+        database: row?.database ?? '',
+        databaseBytes: Number(row?.bytes ?? 0),
+        statsReset: row?.reset ?? null,
+        tables,
+        indexes,
+    };
+}

package/dist/explorer/timeout.js

@@ -0,0 +1,13 @@
+/** Runs `work` with the session's statement timeout set to `ms`, and puts the old one back. */
+export async function withStatementTimeout(session, ms, work) {
+    const [before] = await session.rows("SELECT current_setting('statement_timeout') AS timeout");
+    await session.rows("SELECT pg_catalog.set_config('statement_timeout', $1, false)", [String(ms)]);
+    try {
+        return await work();
+    }
+    finally {
+        await session.rows("SELECT pg_catalog.set_config('statement_timeout', $1, false)", [
+            before?.timeout ?? '0',
+        ]);
+    }
+}

package/dist/screens/environments.js

@@ -38,6 +38,11 @@ function Status({ entry, outcome }) {
         return _jsx(Text, { color: "red", children: "\u2717" });
     return _jsx(Text, { dimColor: true, children: "untested" });
 }
+function WebNote({ url }) {
+    if (!url)
+        return null;
+    return (_jsx(Box, { marginTop: 1, paddingX: 1, children: _jsxs(Text, { dimColor: true, wrap: "truncate-end", children: ["Web UI is running on ", _jsx(Text, { color: "cyan", children: url })] }) }));
+}
 function Banner({ services }) {
     const error = services.configError;
     if (!error)
@@ -121,8 +126,6 @@ export default function Environments({ version, navigate, params, services, isIn
         }
         finally {
             running.current.delete(entry.key);
-            // Credentials issued for the test are not needed any more.
-            void services.groups?.release(entry.name);
         }
         setOutcome(entry.key, outcome);
     };
@@ -219,7 +222,7 @@ export default function Environments({ version, navigate, params, services, isIn
     const below = entries.length - first - shown.length;
     const current = entries[selected];
     const currentOutcome = current ? outcomes.get(current.key) : undefined;
-    return (_jsxs(Box, { flexDirection: "column", paddingX: 2, paddingTop: 1, flexGrow: 1, children: [_jsx(Header, { version: version, title: "Environments", width: width }), _jsx(Banner, { services: services }), _jsx(Box, { flexDirection: "column", marginTop: 1, paddingX: 1, children: 'error' in loaded ? (_jsxs(Text, { color: "red", children: ["\u2717 Could not read connections: ", loaded.error] })) : entries.length === 0 ? (_jsxs(Text, { children: ["No environments yet. Press ", _jsx(Text, { color: "cyan", children: "n" }), " to create one."] })) : (_jsxs(_Fragment, { children: [_jsxs(Box, { width: rowWidth, children: [_jsx(Box, { width: 2, flexShrink: 0 }), _jsx(Box, { width: nameWidth, marginRight: 2, flexShrink: 0, children: _jsx(Text, { bold: true, dimColor: true, children: "NAME" }) }), showTier ? (_jsx(Box, { width: tierWidth, flexShrink: 0, children: _jsx(Text, { bold: true, dimColor: true, children: "TIER" }) })) : null, _jsx(Box, { width: protectedWidth, flexShrink: 0 }), showSource ? (_jsx(Box, { width: sourceWidth, flexShrink: 0, children: _jsx(Text, { bold: true, dimColor: true, children: "SOURCE" }) })) : null, _jsx(Box, { flexGrow: 1, flexShrink: 1, flexBasis: 0, minWidth: 0, children: _jsx(Text, { bold: true, dimColor: true, wrap: "truncate-end", children: "ADDRESS" }) }), showAccess ? (_jsx(Box, { width: accessWidth, flexShrink: 0, children: _jsx(Text, { bold: true, dimColor: true, children: "ACCESS" }) })) : null, showTls ? (_jsx(Box, { width: tlsWidth, flexShrink: 0, children: _jsx(Text, { bold: true, dimColor: true, children: "TLS" }) })) : null, _jsx(Box, { width: statusWidth, flexShrink: 0, justifyContent: "flex-end", children: _jsx(Text, { bold: true, dimColor: true, children: "CONNECTION" }) })] }), _jsx(Text, { dimColor: true, children: above > 0 ? `  ↑ ${above} more` : ' ' }), shown.map((entry, index) => {
+    return (_jsxs(Box, { flexDirection: "column", paddingX: 2, paddingTop: 1, flexGrow: 1, children: [_jsx(Header, { version: version, title: "Environments", width: width }), _jsx(Banner, { services: services }), _jsx(WebNote, { url: services.webUrl }), _jsx(Box, { flexDirection: "column", marginTop: 1, paddingX: 1, children: 'error' in loaded ? (_jsxs(Text, { color: "red", children: ["\u2717 Could not read connections: ", loaded.error] })) : entries.length === 0 ? (_jsxs(Text, { children: ["No environments yet. Press ", _jsx(Text, { color: "cyan", children: "n" }), " to create one."] })) : (_jsxs(_Fragment, { children: [_jsxs(Box, { width: rowWidth, children: [_jsx(Box, { width: 2, flexShrink: 0 }), _jsx(Box, { width: nameWidth, marginRight: 2, flexShrink: 0, children: _jsx(Text, { bold: true, dimColor: true, children: "NAME" }) }), showTier ? (_jsx(Box, { width: tierWidth, flexShrink: 0, children: _jsx(Text, { bold: true, dimColor: true, children: "TIER" }) })) : null, _jsx(Box, { width: protectedWidth, flexShrink: 0 }), showSource ? (_jsx(Box, { width: sourceWidth, flexShrink: 0, children: _jsx(Text, { bold: true, dimColor: true, children: "SOURCE" }) })) : null, _jsx(Box, { flexGrow: 1, flexShrink: 1, flexBasis: 0, minWidth: 0, children: _jsx(Text, { bold: true, dimColor: true, wrap: "truncate-end", children: "ADDRESS" }) }), showAccess ? (_jsx(Box, { width: accessWidth, flexShrink: 0, children: _jsx(Text, { bold: true, dimColor: true, children: "ACCESS" }) })) : null, showTls ? (_jsx(Box, { width: tlsWidth, flexShrink: 0, children: _jsx(Text, { bold: true, dimColor: true, children: "TLS" }) })) : null, _jsx(Box, { width: statusWidth, flexShrink: 0, justifyContent: "flex-end", children: _jsx(Text, { bold: true, dimColor: true, children: "CONNECTION" }) })] }), _jsx(Text, { dimColor: true, children: above > 0 ? `  ↑ ${above} more` : ' ' }), shown.map((entry, index) => {
                             const isSelected = first + index === selected;
                             return (_jsxs(Box, { width: rowWidth, children: [_jsx(Box, { width: 2, flexShrink: 0, children: _jsx(Text, { color: "cyan", children: isSelected ? '›' : ' ' }) }), _jsx(Box, { width: nameWidth, marginRight: 2, flexShrink: 0, children: _jsx(Text, { bold: isSelected, color: locked.has(entry.key) ? 'red' : isSelected ? 'cyan' : undefined, wrap: "truncate-end", children: entry.name }) }), showTier ? (_jsx(Box, { width: tierWidth, flexShrink: 0, children: _jsx(Text, { color: tierColor[entry.tier], children: entry.tier }) })) : null, _jsx(Box, { width: protectedWidth, flexShrink: 0, children: entry.protected ? _jsx(Text, { color: "red", children: shield }) : null }), showSource ? (_jsx(Box, { width: sourceWidth, flexShrink: 0, children: _jsx(Text, { dimColor: true, children: entry.source }) })) : null, _jsx(Box, { flexGrow: 1, flexShrink: 1, flexBasis: 0, minWidth: 0, children: _jsx(Text, { dimColor: !isSelected, wrap: "truncate-end", children: addressOf(entry) }) }), locked.has(entry.key) ? (_jsx(Box, { flexShrink: 0, marginRight: 2, children: _jsx(Text, { color: "red", children: "credentials can't be retrieved" }) })) : null, showAccess ? (_jsx(Box, { width: accessWidth, flexShrink: 0, children: entry.readOnly ? (_jsx(Text, { color: "yellow", children: "read only" })) : (_jsx(Text, { dimColor: true, children: "read write" })) })) : null, showTls ? (_jsx(Box, { width: tlsWidth, flexShrink: 0, children: _jsx(Text, { dimColor: true, children: entry.tlsMode }) })) : null, _jsx(Box, { width: statusWidth, flexShrink: 0, justifyContent: "flex-end", children: _jsx(Status, { entry: entry, outcome: outcomes.get(entry.key) }) })] }, entry.key));
                         }), _jsx(Text, { dimColor: true, children: below > 0 ? `  ↓ ${below} more` : ' ' })] })) }), _jsx(Box, { marginTop: 1, paddingX: 1, width: width, children: deleting ? (_jsxs(Text, { color: "red", wrap: "truncate-end", children: ["Delete ", deleting.name, "? y to delete \u00B7 any other key cancels"] })) : note ? (_jsx(Text, { color: "yellow", wrap: "truncate-end", children: note })) : currentOutcome?.state === 'running' ? (_jsxs(Text, { dimColor: true, children: ["Testing ", current?.name, "\u2026"] })) : currentOutcome ? (_jsxs(Text, { color: currentOutcome.state === 'ok' ? 'green' : 'red', wrap: "truncate-end", children: [currentOutcome.state === 'ok' ? '✓' : '✗', " ", currentOutcome.message] })) : (_jsx(Text, { children: " " })) }), _jsx(Box, { flexGrow: 1 }), _jsx(Box, { marginTop: 1, paddingX: 1, width: width, flexWrap: "wrap", children: hints.map((hint, index) => (_jsxs(Text, { color: "gray", wrap: "truncate-end", children: [hint, index < hints.length - 1 ? ' · ' : ''] }, hint))) })] }));

package/dist/screens/explorer.js

@@ -68,9 +68,6 @@ export default function Explorer({ version, navigate, params, services, isInputA
             // eslint-disable-next-line react-hooks/exhaustive-deps
             generation.current++;
             void session.current?.close();
-            // Credentials issued for this visit end with it.
-            if (entry)
-                void services.groups?.release(entry.name);
         };
         // Connects once, when the screen opens.
         // eslint-disable-next-line react-hooks/exhaustive-deps

package/dist/screens/splash.js

@@ -69,8 +69,10 @@ export default function Splash({ version, navigate, services, isInputActive, })
     const stepsWidth = Math.max(20, Math.min(columns - 4, maxStepsWidth));
     useInput((input) => {
         // `q` is the global quit key, handled by <App>.
-        if (input !== 'q' && finished)
+        if (input === 'o' && services.webUrl)
+            services.openUrl?.(services.webUrl);
+        else if (input !== 'q' && finished)
             navigate('environments');
     }, { isActive: isInputActive });
-    return (_jsxs(Box, { flexDirection: "column", alignItems: "center", justifyContent: "center", minHeight: Math.max(1, rows - 1), paddingY: 1, children: [_jsx(Box, { "aria-label": "psql-explorer", marginBottom: columns >= tinyMinColumns ? 0 : 1, children: _jsx(Gradient, { name: "cristal", children: _jsx(Title, { columns: columns }) }) }), _jsx(Gradient, { name: "cristal", children: _jsx(Text, { children: rule(columns) }) }), _jsx(Box, { marginTop: 1, children: _jsx(Text, { dimColor: true, children: tagline }) }), _jsxs(Box, { marginTop: 1, children: [_jsx(Text, { dimColor: true, children: "by " }), _jsx(Gradient, { name: "vice", children: _jsx(Text, { bold: true, children: company }) })] }), columns >= highlightsMinColumns ? (_jsx(Box, { marginTop: 1, children: highlights.map((item, index) => (_jsxs(Text, { color: "gray", children: [index > 0 ? '   ' : '', _jsx(Text, { color: "cyan", children: "\u25C6" }), " ", item] }, item))) })) : null, _jsx(Box, { marginTop: 1, children: _jsxs(Text, { dimColor: true, children: ["v", version] }) }), steps.length > 0 ? (_jsx(Box, { flexDirection: "column", marginTop: 1, width: stepsWidth, children: steps.map((step) => (_jsx(StepLine, { step: step, now: now }, step.id))) })) : null, _jsx(Box, { marginTop: 1, children: !finished ? (_jsx(Text, { color: "gray", children: "Starting\u2026 \u00B7 q to quit" })) : columns >= tinyMinColumns ? (_jsx(Text, { color: "gray", children: "Press any key to continue \u00B7 q to quit" })) : (_jsxs(Box, { flexDirection: "column", alignItems: "center", children: [_jsx(Text, { color: "gray", children: "Press any key to continue" }), _jsx(Text, { color: "gray", children: "q to quit" })] })) })] }));
+    return (_jsxs(Box, { flexDirection: "column", alignItems: "center", justifyContent: "center", minHeight: Math.max(1, rows - 1), paddingY: 1, children: [_jsx(Box, { "aria-label": "psql-explorer", marginBottom: columns >= tinyMinColumns ? 0 : 1, children: _jsx(Gradient, { name: "cristal", children: _jsx(Title, { columns: columns }) }) }), _jsx(Gradient, { name: "cristal", children: _jsx(Text, { children: rule(columns) }) }), _jsx(Box, { marginTop: 1, children: _jsx(Text, { dimColor: true, children: tagline }) }), _jsxs(Box, { marginTop: 1, children: [_jsx(Text, { dimColor: true, children: "by " }), _jsx(Gradient, { name: "vice", children: _jsx(Text, { bold: true, children: company }) })] }), columns >= highlightsMinColumns ? (_jsx(Box, { marginTop: 1, children: highlights.map((item, index) => (_jsxs(Text, { color: "gray", children: [index > 0 ? '   ' : '', _jsx(Text, { color: "cyan", children: "\u25C6" }), " ", item] }, item))) })) : null, _jsx(Box, { marginTop: 1, children: _jsxs(Text, { dimColor: true, children: ["v", version] }) }), services.webUrl ? (_jsxs(Box, { marginTop: 1, children: [_jsx(Text, { dimColor: true, children: "Web UI " }), _jsx(Text, { color: "cyan", children: services.webUrl }), _jsx(Text, { dimColor: true, children: " \u00B7 press " }), _jsx(Text, { color: "cyan", children: "o" }), _jsx(Text, { dimColor: true, children: " to open" })] })) : null, steps.length > 0 ? (_jsx(Box, { flexDirection: "column", marginTop: 1, width: stepsWidth, children: steps.map((step) => (_jsx(StepLine, { step: step, now: now }, step.id))) })) : null, _jsx(Box, { marginTop: 1, children: !finished ? (_jsx(Text, { color: "gray", children: "Starting\u2026 \u00B7 q to quit" })) : columns >= tinyMinColumns ? (_jsx(Text, { color: "gray", children: "Press any key to continue \u00B7 q to quit" })) : (_jsxs(Box, { flexDirection: "column", alignItems: "center", children: [_jsx(Text, { color: "gray", children: "Press any key to continue" }), _jsx(Text, { color: "gray", children: "q to quit" })] })) })] }));
 }