Add system sql command

Author: l7ssha

lib/src/commands/admin.dart

@@ -7,6 +7,8 @@ import 'package:running_on_dart/src/checks.dart';
 import 'package:running_on_dart/src/modules/poop_name.dart';
 import 'package:running_on_dart/src/init.dart';
 import 'package:running_on_dart/src/util/util.dart';
+import 'package:running_on_dart/src/services/db.dart';
+import 'package:running_on_dart/src/util/sql_result_formatter.dart';
 
 Stream<Member> searchMembers(String disallowedChar, int batchSize, Guild guild) {
   return (guild.manager.client as NyxxGateway).gateway.listGuildMembers(
@@ -135,6 +137,29 @@ final admin = ChatGroup(
             );
           }),
         ),
+        ChatCommand(
+          'sql',
+          'Execute a SQL query',
+          id('admin-sql', (
+            ChatContext context,
+            @Description('SQL query to execute') String query, [
+            @Description('Set to false to show response publicly') bool private = true,
+          ]) async {
+            final db = Injector.appInstance.get<DatabaseService>();
+            final responseLevel = private ? ResponseLevel.private : ResponseLevel.public;
+
+            try {
+              final result = await db.getConnection().execute(query);
+
+              final table = formatSqlResult(result);
+              final truncated = table.length > 3900 ? '${table.substring(0, 3900)}... (truncated)' : table;
+
+              await context.respond(MessageBuilder(content: '```\n$truncated\n```'), level: responseLevel);
+            } catch (e) {
+              await context.respond(MessageBuilder(content: 'Error executing query: $e'), level: responseLevel);
+            }
+          }),
+        ),
       ],
     ),
   ],

lib/src/services/db.dart

@@ -1,5 +1,4 @@
 import 'dart:async';
-import 'dart:io';
 
 import 'package:logging/logging.dart';
 import 'package:migent/migent.dart';
@@ -9,20 +8,10 @@ import 'package:running_on_dart/src/settings.dart';
 import 'package:running_on_dart/src/util/query_builder.dart';
 import 'package:running_on_dart/src/init.dart';
 
-/// The user to use when connecting to the database.
 String user = getEnv('POSTGRES_USER');
-
-/// The password to use when connecting to the database.
-// Optional password
 String? password = getEnv('POSTGRES_PASSWORD');
-
-/// The name of the database to connect to.
 String databaseName = getEnv('POSTGRES_DB');
-
-/// The host name of the database to connect to.
 String host = getEnv('DB_HOST', 'db');
-
-/// The port to connect to the database on.
 int port = getEnvInt('DB_PORT', 5432);
 
 class DatabaseService implements RequiresInitialization {

lib/src/util/sql_result_formatter.dart

@@ -0,0 +1,85 @@
+import 'dart:math';
+import 'package:postgres/postgres.dart';
+
+const int _maxColumnWidth = 30;
+const int _maxRowsToShow = 10;
+const String _nullPlaceholder = 'NULL';
+
+String formatSqlResult(Result result) {
+  return formatTableString(result.toList(), result.schema.columns.map((c) => c.columnName ?? '?').toList());
+}
+
+String formatTableString(List<List<dynamic>> rows, List<String> columnNames) {
+  if (rows.isEmpty) {
+    return "No results";
+  }
+
+  final truncatedHeaders = columnNames.map(_truncate).toList();
+
+  final truncatedRows = rows
+      .map((row) => row.map((cell) => _truncate(cell?.toString() ?? _nullPlaceholder)).toList())
+      .toList();
+
+  final List<int> columnWidths = _calculateColumnWidths(truncatedHeaders, truncatedRows);
+
+  final buffer = StringBuffer();
+
+  _appendHeader(buffer, truncatedHeaders, columnWidths);
+  _appendSeparator(buffer, columnWidths);
+  _appendRows(buffer, truncatedRows, columnWidths);
+
+  if (rows.length > _maxRowsToShow) {
+    buffer.writeln('... (${rows.length - _maxRowsToShow} more rows)');
+  }
+
+  return buffer.toString();
+}
+
+List<int> _calculateColumnWidths(List<String> headers, List<List<String>> rows) {
+  return List<int>.generate(headers.length, (columnIndex) {
+    final headerWidth = headers[columnIndex].length;
+    final cellWidths = rows.map((row) => row[columnIndex].length);
+
+    return max(headerWidth, cellWidths.fold(0, max));
+  });
+}
+
+void _appendHeader(StringBuffer buffer, List<String> headers, List<int> columnWidths) {
+  buffer.write('|');
+
+  for (int i = 0; i < headers.length; i++) {
+    buffer.write(' ${headers[i].padRight(columnWidths[i])} |');
+  }
+
+  buffer.writeln();
+}
+
+void _appendSeparator(StringBuffer buffer, List<int> columnWidths) {
+  buffer.write('|');
+
+  for (final width in columnWidths) {
+    buffer.write('${'-' * (width + 2)}|');
+  }
+
+  buffer.writeln();
+}
+
+void _appendRows(StringBuffer buffer, List<List<String>> rows, List<int> columnWidths) {
+  for (final row in rows.take(_maxRowsToShow)) {
+    buffer.write('|');
+
+    for (int i = 0; i < row.length; i++) {
+      buffer.write(' ${row[i].padRight(columnWidths[i])} |');
+    }
+
+    buffer.writeln();
+  }
+}
+
+String _truncate(String text) {
+  if (text.length > _maxColumnWidth) {
+    return '${text.substring(0, _maxColumnWidth - 3)}...';
+  }
+
+  return text;
+}

test/sql_result_formatter_test.dart

@@ -0,0 +1,85 @@
+import 'package:test/test.dart';
+import 'package:running_on_dart/src/util/sql_result_formatter.dart';
+
+void main() {
+  group('formatTableString', () {
+    test('returns "No results" for empty rows', () {
+      final result = formatTableString([], ['Column1', 'Column2']);
+      expect(result, equals('No results'));
+    });
+
+    test('formats basic table correctly', () {
+      final rows = [
+        ['Alice', 30],
+        ['Bob', 25],
+      ];
+      final columnNames = ['Name', 'Age'];
+
+      final result = formatTableString(rows, columnNames);
+
+      expect(
+        result,
+        equals(
+          '| Name  | Age |\n'
+          '|-------|-----|\n'
+          '| Alice | 30  |\n'
+          '| Bob   | 25  |\n',
+        ),
+      );
+    });
+
+    test('calculates column widths correctly', () {
+      final rows = [
+        ['Short', 'Very long value that exceeds max width'],
+        ['Another value', 'Short'],
+      ];
+      final columnNames = ['Header1', 'Header2'];
+
+      final result = formatTableString(rows, columnNames);
+
+      // Header1 width = max("Header1".length, "Short".length, "Another value".length) = 13
+      // Header2 width = max("Header2".length, truncated "Very long value ..." (30), "Short".length) = 30
+      expect(result, contains('| Header1       | Header2                        |'));
+      expect(result, contains('| Short         | Very long value that exceed... |'));
+      expect(result, contains('| Another value | Short                          |'));
+    });
+
+    test('truncates long values with ellipsis', () {
+      final longString = 'This is a very long string that needs to be truncated to fit in the column';
+      final rows = [
+        [longString],
+      ];
+      final columnNames = ['LongColumn'];
+
+      final result = formatTableString(rows, columnNames);
+
+      expect(result, contains('This is a very long string ...'));
+      expect(result, contains('| LongColumn                     |'));
+    });
+
+    test('handles null values as "NULL"', () {
+      final rows = [
+        [null, 'Valid'],
+        ['Valid', null],
+      ];
+      final columnNames = ['Column1', 'Column2'];
+
+      final result = formatTableString(rows, columnNames);
+
+      expect(result, contains('| NULL    | Valid   |'));
+      expect(result, contains('| Valid   | NULL    |'));
+    });
+
+    test('limits displayed rows to 10 with overflow message', () {
+      final rows = List.generate(15, (index) => ['Row ${index + 1}']);
+      final columnNames = ['Data'];
+
+      final result = formatTableString(rows, columnNames);
+
+      // Should show 10 rows + overflow message
+      final lines = result.split('\n');
+      expect(lines.length, 14); // Header + separator + 10 rows + message + empty line
+      expect(result, contains('... (5 more rows)'));
+    });
+  });
+}