Merge pull request #258 from datlechin/feat/plugin-standardization-phase1

feat: standardize plugin system patterns

Author: datlechin

CHANGELOG.md

@@ -9,13 +9,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+- Result truncation at 100K rows now reported to UI via `PluginQueryResult.isTruncated` instead of being silently discarded
 - DELETE and UPDATE queries using all columns in WHERE clause instead of just the primary key for PostgreSQL, Redshift, MSSQL, and ClickHouse
 - SSL/TLS always being enabled for MongoDB, Redis, and ClickHouse connections due to case mismatch in SSL mode string comparison (#249)
 - Redis sidebar click showing data briefly then going empty due to double-navigation race condition (#251)
 - MongoDB showing "Invalid database name: ''" when connecting without a database name
 
 ### Changed
 
+- Unified error formatting across all database drivers via default `PluginDriverError.errorDescription`, removing 10 per-driver implementations
+- Standardized async bridging: 5 queue-based drivers (MySQL, PostgreSQL, MongoDB, Redis, MSSQL) now use shared `pluginDispatchAsync` helper
+- Added localization to remaining driver error messages (MySQL, PostgreSQL, ClickHouse, Oracle, Redis, MongoDB)
 - NoSQL query building moved from Core to MongoDB/Redis plugins via optional `PluginDatabaseDriver` protocol methods
 - Standardized parameter binding across all database drivers with improved default escaping (type-aware numeric handling, NUL byte stripping, NULL literal support)
 

Plugins/ClickHouseDriverPlugin/ClickHousePlugin.swift

@@ -28,11 +28,10 @@ final class ClickHousePlugin: NSObject, TableProPlugin, DriverPlugin {
 private struct ClickHouseError: Error, PluginDriverError {
     let message: String
 
-    var errorDescription: String? { "ClickHouse Error: \(message)" }
     var pluginErrorMessage: String { message }
 
-    static let notConnected = ClickHouseError(message: "Not connected to database")
-    static let connectionFailed = ClickHouseError(message: "Failed to establish connection")
+    static let notConnected = ClickHouseError(message: String(localized: "Not connected to database"))
+    static let connectionFailed = ClickHouseError(message: String(localized: "Failed to establish connection"))
 }
 
 // MARK: - Internal Query Result
@@ -42,6 +41,7 @@ private struct CHQueryResult {
     let columnTypeNames: [String]
     let rows: [[String?]]
     let affectedRows: Int
+    let isTruncated: Bool
 }
 
 // MARK: - Plugin Driver
@@ -139,7 +139,8 @@ final class ClickHousePluginDriver: PluginDatabaseDriver, @unchecked Sendable {
             columnTypeNames: result.columnTypeNames,
             rows: result.rows,
             rowsAffected: result.affectedRows,
-            executionTime: executionTime
+            executionTime: executionTime,
+            isTruncated: result.isTruncated
         )
     }
 
@@ -159,7 +160,8 @@ final class ClickHousePluginDriver: PluginDatabaseDriver, @unchecked Sendable {
             columnTypeNames: result.columnTypeNames,
             rows: result.rows,
             rowsAffected: result.affectedRows,
-            executionTime: executionTime
+            executionTime: executionTime,
+            isTruncated: result.isTruncated
         )
     }
 
@@ -584,7 +586,7 @@ final class ClickHousePluginDriver: PluginDatabaseDriver, @unchecked Sendable {
             return parseTabSeparatedResponse(data)
         }
 
-        return CHQueryResult(columns: [], columnTypeNames: [], rows: [], affectedRows: 0)
+        return CHQueryResult(columns: [], columnTypeNames: [], rows: [], affectedRows: 0, isTruncated: false)
     }
 
     private func executeRawWithParams(_ query: String, params: [String: String?], queryId: String? = nil) async throws -> CHQueryResult {
@@ -641,7 +643,7 @@ final class ClickHousePluginDriver: PluginDatabaseDriver, @unchecked Sendable {
             return parseTabSeparatedResponse(data)
         }
 
-        return CHQueryResult(columns: [], columnTypeNames: [], rows: [], affectedRows: 0)
+        return CHQueryResult(columns: [], columnTypeNames: [], rows: [], affectedRows: 0, isTruncated: false)
     }
 
     private func buildRequest(query: String, database: String, queryId: String? = nil, params: [String: String?]? = nil) throws -> URLRequest {
@@ -705,19 +707,20 @@ final class ClickHousePluginDriver: PluginDatabaseDriver, @unchecked Sendable {
 
     private func parseTabSeparatedResponse(_ data: Data) -> CHQueryResult {
         guard let text = String(data: data, encoding: .utf8), !text.isEmpty else {
-            return CHQueryResult(columns: [], columnTypeNames: [], rows: [], affectedRows: 0)
+            return CHQueryResult(columns: [], columnTypeNames: [], rows: [], affectedRows: 0, isTruncated: false)
         }
 
         let lines = text.components(separatedBy: "\n")
 
         guard lines.count >= 2 else {
-            return CHQueryResult(columns: [], columnTypeNames: [], rows: [], affectedRows: 0)
+            return CHQueryResult(columns: [], columnTypeNames: [], rows: [], affectedRows: 0, isTruncated: false)
         }
 
         let columns = lines[0].components(separatedBy: "\t")
         let columnTypes = lines[1].components(separatedBy: "\t")
 
         var rows: [[String?]] = []
+        var truncated = false
         for i in 2..<lines.count {
             let line = lines[i]
             if line.isEmpty { continue }
@@ -731,6 +734,7 @@ final class ClickHousePluginDriver: PluginDatabaseDriver, @unchecked Sendable {
             }
             rows.append(row)
             if rows.count >= PluginRowLimits.defaultMax {
+                truncated = true
                 break
             }
         }
@@ -739,7 +743,8 @@ final class ClickHousePluginDriver: PluginDatabaseDriver, @unchecked Sendable {
             columns: columns,
             columnTypeNames: columnTypes,
             rows: rows,
-            affectedRows: rows.count
+            affectedRows: rows.count,
+            isTruncated: truncated
         )
     }
 

Plugins/MSSQLDriverPlugin/MSSQLPlugin.swift

@@ -79,6 +79,7 @@ private struct FreeTDSQueryResult {
     let columnTypeNames: [String]
     let rows: [[String?]]
     let affectedRows: Int
+    let isTruncated: Bool
 }
 
 private final class FreeTDSConnection: @unchecked Sendable {
@@ -109,15 +110,8 @@ private final class FreeTDSConnection: @unchecked Sendable {
     }
 
     func connect() async throws {
-        try await withCheckedThrowingContinuation { (continuation: CheckedContinuation<Void, Error>) in
-            queue.async { [self] in
-                do {
-                    try self.connectSync()
-                    continuation.resume()
-                } catch {
-                    continuation.resume(throwing: error)
-                }
-            }
+        try await pluginDispatchAsync(on: queue) { [self] in
+            try self.connectSync()
         }
     }
 
@@ -153,17 +147,12 @@ private final class FreeTDSConnection: @unchecked Sendable {
     }
 
     func switchDatabase(_ database: String) async throws {
-        try await withCheckedThrowingContinuation { (continuation: CheckedContinuation<Void, Error>) in
-            queue.async { [self] in
-                guard let proc = self.dbproc else {
-                    continuation.resume(throwing: MSSQLPluginError.notConnected)
-                    return
-                }
-                if dbuse(proc, database) == FAIL {
-                    continuation.resume(throwing: MSSQLPluginError.queryFailed("Cannot switch to database '\(database)'"))
-                } else {
-                    continuation.resume()
-                }
+        try await pluginDispatchAsync(on: queue) { [self] in
+            guard let proc = self.dbproc else {
+                throw MSSQLPluginError.notConnected
+            }
+            if dbuse(proc, database) == FAIL {
+                throw MSSQLPluginError.queryFailed("Cannot switch to database '\(database)'")
             }
         }
     }
@@ -185,15 +174,8 @@ private final class FreeTDSConnection: @unchecked Sendable {
 
     func executeQuery(_ query: String) async throws -> FreeTDSQueryResult {
         let queryToRun = String(query)
-        return try await withCheckedThrowingContinuation { [self] (cont: CheckedContinuation<FreeTDSQueryResult, Error>) in
-            queue.async { [self] in
-                do {
-                    let result = try self.executeQuerySync(queryToRun)
-                    cont.resume(returning: result)
-                } catch {
-                    cont.resume(throwing: error)
-                }
-            }
+        return try await pluginDispatchAsync(on: queue) { [self] in
+            try self.executeQuerySync(queryToRun)
         }
     }
 
@@ -217,6 +199,7 @@ private final class FreeTDSConnection: @unchecked Sendable {
         var allTypeNames: [String] = []
         var allRows: [[String?]] = []
         var firstResultSet = true
+        var truncated = false
 
         while true {
             let resCode = dbresults(proc)
@@ -264,6 +247,7 @@ private final class FreeTDSConnection: @unchecked Sendable {
                 }
                 allRows.append(row)
                 if allRows.count >= PluginRowLimits.defaultMax {
+                    truncated = true
                     break
                 }
             }
@@ -274,7 +258,8 @@ private final class FreeTDSConnection: @unchecked Sendable {
             columns: allColumns,
             columnTypeNames: allTypeNames,
             rows: allRows,
-            affectedRows: affectedRows
+            affectedRows: affectedRows,
+            isTruncated: truncated
         )
     }
 
@@ -396,7 +381,8 @@ final class MSSQLPluginDriver: PluginDatabaseDriver, @unchecked Sendable {
             columnTypeNames: result.columnTypeNames,
             rows: result.rows,
             rowsAffected: result.affectedRows,
-            executionTime: Date().timeIntervalSince(startTime)
+            executionTime: Date().timeIntervalSince(startTime),
+            isTruncated: result.isTruncated
         )
     }
 
@@ -1043,18 +1029,10 @@ final class MSSQLPluginDriver: PluginDatabaseDriver, @unchecked Sendable {
 
 // MARK: - Errors
 
-enum MSSQLPluginError: LocalizedError {
+enum MSSQLPluginError: Error {
     case connectionFailed(String)
     case notConnected
     case queryFailed(String)
-
-    var errorDescription: String? {
-        switch self {
-        case .connectionFailed(let message): return "SQL Server Error: \(message)"
-        case .notConnected: return "SQL Server Error: Not connected to database"
-        case .queryFailed(let message): return "SQL Server Error: \(message)"
-        }
-    }
 }
 
 extension MSSQLPluginError: PluginDriverError {