|
| 1 | +// Package gosqlxgorm provides a GORM plugin that parses each executed query |
| 2 | +// with GoSQLX and records extracted metadata (tables, columns, statement type). |
| 3 | +package gosqlxgorm |
| 4 | + |
| 5 | +import ( |
| 6 | + "regexp" |
| 7 | + "strconv" |
| 8 | + "strings" |
| 9 | + "sync" |
| 10 | + |
| 11 | + "github.com/ajitpratap0/GoSQLX/pkg/gosqlx" |
| 12 | + "github.com/ajitpratap0/GoSQLX/pkg/sql/ast" |
| 13 | + "github.com/ajitpratap0/GoSQLX/pkg/sql/keywords" |
| 14 | + "gorm.io/gorm" |
| 15 | +) |
| 16 | + |
| 17 | +// reQuestionMark replaces GORM's ? positional placeholders. |
| 18 | +var reQuestionMark = regexp.MustCompile(`\?`) |
| 19 | + |
| 20 | +// QueryRecord holds metadata about a single recorded GORM query. |
| 21 | +type QueryRecord struct { |
| 22 | + SQL string |
| 23 | + Tables []string |
| 24 | + Columns []string |
| 25 | + Type string // SELECT, INSERT, UPDATE, DELETE, ... |
| 26 | + ParseOK bool |
| 27 | +} |
| 28 | + |
| 29 | +// PluginStats is the aggregate of all queries observed since initialization. |
| 30 | +type PluginStats struct { |
| 31 | + TotalQueries int |
| 32 | + ParseErrors int |
| 33 | + Queries []QueryRecord |
| 34 | +} |
| 35 | + |
| 36 | +// Plugin is a GORM plugin that parses each executed query with GoSQLX |
| 37 | +// and records extracted metadata (tables, columns, statement type). |
| 38 | +type Plugin struct { |
| 39 | + mu sync.Mutex |
| 40 | + queries []QueryRecord |
| 41 | +} |
| 42 | + |
| 43 | +// NewPlugin returns a new GoSQLX GORM plugin. |
| 44 | +func NewPlugin() *Plugin { return &Plugin{} } |
| 45 | + |
| 46 | +// Name implements gorm.Plugin. |
| 47 | +func (p *Plugin) Name() string { return "gosqlx" } |
| 48 | + |
| 49 | +// Initialize implements gorm.Plugin by registering after-callbacks. |
| 50 | +func (p *Plugin) Initialize(db *gorm.DB) error { |
| 51 | + db.Callback().Query().After("gorm:query").Register("gosqlx:after_query", p.afterStatement) |
| 52 | + db.Callback().Create().After("gorm:create").Register("gosqlx:after_create", p.afterStatement) |
| 53 | + db.Callback().Update().After("gorm:update").Register("gosqlx:after_update", p.afterStatement) |
| 54 | + db.Callback().Delete().After("gorm:delete").Register("gosqlx:after_delete", p.afterStatement) |
| 55 | + db.Callback().Raw().After("gorm:raw").Register("gosqlx:after_raw", p.afterStatement) |
| 56 | + return nil |
| 57 | +} |
| 58 | + |
| 59 | +func (p *Plugin) afterStatement(db *gorm.DB) { |
| 60 | + // Guard against nil Statement — this can happen during initialization callbacks. |
| 61 | + if db.Statement == nil { |
| 62 | + return |
| 63 | + } |
| 64 | + sql := db.Statement.SQL.String() |
| 65 | + if sql == "" { |
| 66 | + return |
| 67 | + } |
| 68 | + |
| 69 | + rec := QueryRecord{SQL: sql} |
| 70 | + |
| 71 | + // Normalize GORM-generated SQL for GoSQLX compatibility: |
| 72 | + // 1. Replace backtick-quoted identifiers with double-quoted identifiers |
| 73 | + // (GORM SQLite/MySQL driver uses backticks; GoSQLX standard mode uses double-quotes). |
| 74 | + // 2. Replace ? positional placeholders with $N (PostgreSQL style). |
| 75 | + normalized := normalizeSQLForParsing(sql) |
| 76 | + |
| 77 | + // Try PostgreSQL dialect (handles double-quoted identifiers and $N placeholders), |
| 78 | + // then fall back to standard SQL parsing. |
| 79 | + tree, err := gosqlx.ParseWithDialect(normalized, keywords.DialectPostgreSQL) |
| 80 | + if err != nil { |
| 81 | + tree, err = gosqlx.Parse(normalized) |
| 82 | + } |
| 83 | + if err != nil { |
| 84 | + rec.ParseOK = false |
| 85 | + } else { |
| 86 | + rec.ParseOK = true |
| 87 | + rec.Tables = gosqlx.ExtractTables(tree) |
| 88 | + rec.Columns = gosqlx.ExtractColumns(tree) |
| 89 | + if tree != nil && len(tree.Statements) > 0 { |
| 90 | + rec.Type = stmtTypeName(tree.Statements[0]) |
| 91 | + } |
| 92 | + } |
| 93 | + |
| 94 | + p.mu.Lock() |
| 95 | + p.queries = append(p.queries, rec) |
| 96 | + p.mu.Unlock() |
| 97 | +} |
| 98 | + |
| 99 | +// normalizeSQLForParsing converts GORM-generated SQL into a form that GoSQLX |
| 100 | +// can parse: backtick identifiers become double-quoted, and ? placeholders |
| 101 | +// become $N placeholders. |
| 102 | +func normalizeSQLForParsing(sql string) string { |
| 103 | + // Replace backtick-quoted identifiers with double-quoted identifiers. |
| 104 | + sql = strings.ReplaceAll(sql, "`", "\"") |
| 105 | + // Replace ? positional placeholders with $N. |
| 106 | + n := 0 |
| 107 | + sql = reQuestionMark.ReplaceAllStringFunc(sql, func(string) string { |
| 108 | + n++ |
| 109 | + return "$" + strconv.Itoa(n) |
| 110 | + }) |
| 111 | + return sql |
| 112 | +} |
| 113 | + |
| 114 | +// Stats returns a snapshot of all recorded queries. |
| 115 | +func (p *Plugin) Stats() PluginStats { |
| 116 | + p.mu.Lock() |
| 117 | + defer p.mu.Unlock() |
| 118 | + var errCount int |
| 119 | + for _, q := range p.queries { |
| 120 | + if !q.ParseOK { |
| 121 | + errCount++ |
| 122 | + } |
| 123 | + } |
| 124 | + qs := make([]QueryRecord, len(p.queries)) |
| 125 | + copy(qs, p.queries) |
| 126 | + return PluginStats{ |
| 127 | + TotalQueries: len(p.queries), |
| 128 | + ParseErrors: errCount, |
| 129 | + Queries: qs, |
| 130 | + } |
| 131 | +} |
| 132 | + |
| 133 | +// Reset clears all recorded queries. |
| 134 | +func (p *Plugin) Reset() { |
| 135 | + p.mu.Lock() |
| 136 | + p.queries = p.queries[:0] |
| 137 | + p.mu.Unlock() |
| 138 | +} |
| 139 | + |
| 140 | +// stmtTypeName returns a human-readable SQL statement type name. |
| 141 | +func stmtTypeName(stmt ast.Statement) string { |
| 142 | + switch stmt.(type) { |
| 143 | + case *ast.SelectStatement: |
| 144 | + return "SELECT" |
| 145 | + case *ast.InsertStatement: |
| 146 | + return "INSERT" |
| 147 | + case *ast.UpdateStatement: |
| 148 | + return "UPDATE" |
| 149 | + case *ast.DeleteStatement: |
| 150 | + return "DELETE" |
| 151 | + default: |
| 152 | + return "OTHER" |
| 153 | + } |
| 154 | +} |
0 commit comments