-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathmigrations.go
More file actions
294 lines (256 loc) · 9.16 KB
/
migrations.go
File metadata and controls
294 lines (256 loc) · 9.16 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
package database
import (
"context"
"database/sql"
"fmt"
"regexp"
"sort"
"time"
"github.com/GoCodeAlone/modular"
cloudevents "github.com/cloudevents/sdk-go/v2"
)
// validateTableName validates table name to prevent SQL injection
func validateTableName(tableName string) error {
// Only allow alphanumeric characters and underscores
matched, err := regexp.MatchString(`^[a-zA-Z_][a-zA-Z0-9_]*$`, tableName)
if err != nil {
return fmt.Errorf("failed to validate table name: %w", err)
}
if !matched {
return ErrInvalidTableName
}
return nil
}
// logEmissionError is a helper function to handle event emission errors consistently
func logEmissionError(context string, err error) {
// For now, just ignore event emission errors as they shouldn't fail the operation
// In production, you might want to log these to a separate logging system
_ = context
_ = err
}
// Migration represents a database migration
type Migration struct {
ID string
Version string
SQL string
Up bool // true for up migration, false for down
}
// MigrationService provides migration functionality
type MigrationService interface {
// RunMigration executes a single migration
RunMigration(ctx context.Context, migration Migration) error
// GetAppliedMigrations returns a list of already applied migrations
GetAppliedMigrations(ctx context.Context) ([]string, error)
// CreateMigrationsTable creates the migrations tracking table
CreateMigrationsTable(ctx context.Context) error
}
// migrationServiceImpl implements MigrationService
type migrationServiceImpl struct {
db *sql.DB
eventEmitter EventEmitter
tableName string
}
// EventEmitter interface for emitting migration events
type EventEmitter interface {
// EmitEvent emits a cloud event with the provided context
EmitEvent(ctx context.Context, event cloudevents.Event) error
}
// NewMigrationService creates a new migration service
func NewMigrationService(db *sql.DB, eventEmitter EventEmitter) MigrationService {
return &migrationServiceImpl{
db: db,
eventEmitter: eventEmitter,
tableName: "schema_migrations",
}
}
// CreateMigrationsTable creates the migrations tracking table if it doesn't exist
func (m *migrationServiceImpl) CreateMigrationsTable(ctx context.Context) error {
// Validate table name to prevent SQL injection
if err := validateTableName(m.tableName); err != nil {
return fmt.Errorf("invalid table name: %w", err)
}
// #nosec G201 - table name is validated above
query := fmt.Sprintf(`
CREATE TABLE IF NOT EXISTS %s (
id TEXT PRIMARY KEY,
version TEXT NOT NULL,
applied_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP
)`, m.tableName)
_, err := m.db.ExecContext(ctx, query)
if err != nil {
return fmt.Errorf("failed to create migrations table: %w", err)
}
return nil
}
// GetAppliedMigrations returns a list of migration IDs that have been applied
func (m *migrationServiceImpl) GetAppliedMigrations(ctx context.Context) ([]string, error) {
// Validate table name to prevent SQL injection
if err := validateTableName(m.tableName); err != nil {
return nil, fmt.Errorf("invalid table name: %w", err)
}
// #nosec G201 - table name is validated above
query := fmt.Sprintf("SELECT id FROM %s ORDER BY applied_at", m.tableName)
rows, err := m.db.QueryContext(ctx, query)
if err != nil {
return nil, fmt.Errorf("failed to query applied migrations: %w", err)
}
defer rows.Close()
var migrations []string
for rows.Next() {
var id string
if err := rows.Scan(&id); err != nil {
return nil, fmt.Errorf("failed to scan migration row: %w", err)
}
migrations = append(migrations, id)
}
if err := rows.Err(); err != nil {
return nil, fmt.Errorf("error iterating migration rows: %w", err)
}
return migrations, nil
}
// RunMigration executes a migration and tracks it
func (m *migrationServiceImpl) RunMigration(ctx context.Context, migration Migration) error {
startTime := time.Now()
// Emit migration started event
if m.eventEmitter != nil {
event := modular.NewCloudEvent(EventTypeMigrationStarted, "database-migration", map[string]interface{}{
"migration_id": migration.ID,
"version": migration.Version,
}, nil)
if err := m.eventEmitter.EmitEvent(modular.WithSynchronousNotification(ctx), event); err != nil {
logEmissionError("migration started", err)
}
}
// Start a transaction for the migration
tx, err := m.db.BeginTx(ctx, nil)
if err != nil {
// Emit migration failed event
if m.eventEmitter != nil {
event := modular.NewCloudEvent(EventTypeMigrationFailed, "database-migration", map[string]interface{}{
"migration_id": migration.ID,
"version": migration.Version,
"error": err.Error(),
"duration_ms": time.Since(startTime).Milliseconds(),
}, nil)
if emitErr := m.eventEmitter.EmitEvent(modular.WithSynchronousNotification(ctx), event); emitErr != nil {
logEmissionError("migration failed", emitErr)
}
}
return fmt.Errorf("failed to begin migration transaction: %w", err)
}
defer func() {
if err != nil {
if rollbackErr := tx.Rollback(); rollbackErr != nil {
logEmissionError("transaction rollback", rollbackErr)
}
}
}()
// Execute the migration SQL
_, err = tx.ExecContext(ctx, migration.SQL)
if err != nil {
// Emit migration failed event
if m.eventEmitter != nil {
event := modular.NewCloudEvent(EventTypeMigrationFailed, "database-migration", map[string]interface{}{
"migration_id": migration.ID,
"version": migration.Version,
"error": err.Error(),
"duration_ms": time.Since(startTime).Milliseconds(),
}, nil)
if emitErr := m.eventEmitter.EmitEvent(modular.WithSynchronousNotification(ctx), event); emitErr != nil {
logEmissionError("migration failed", emitErr)
}
}
return fmt.Errorf("failed to execute migration %s: %w", migration.ID, err)
}
// Record the migration as applied
// Validate table name to prevent SQL injection
if err := validateTableName(m.tableName); err != nil {
return fmt.Errorf("invalid table name for migration record: %w", err)
}
// #nosec G201 - table name is validated above
recordQuery := fmt.Sprintf("INSERT INTO %s (id, version) VALUES (?, ?)", m.tableName)
_, err = tx.ExecContext(ctx, recordQuery, migration.ID, migration.Version)
if err != nil {
// Emit migration failed event
if m.eventEmitter != nil {
event := modular.NewCloudEvent(EventTypeMigrationFailed, "database-migration", map[string]interface{}{
"migration_id": migration.ID,
"version": migration.Version,
"error": err.Error(),
"duration_ms": time.Since(startTime).Milliseconds(),
}, nil)
if emitErr := m.eventEmitter.EmitEvent(modular.WithSynchronousNotification(ctx), event); emitErr != nil {
logEmissionError("migration record failed", emitErr)
}
}
return fmt.Errorf("failed to record migration %s: %w", migration.ID, err)
}
// Commit the transaction
err = tx.Commit()
if err != nil {
// Emit migration failed event
if m.eventEmitter != nil {
event := modular.NewCloudEvent(EventTypeMigrationFailed, "database-migration", map[string]interface{}{
"migration_id": migration.ID,
"version": migration.Version,
"error": err.Error(),
"duration_ms": time.Since(startTime).Milliseconds(),
}, nil)
if emitErr := m.eventEmitter.EmitEvent(modular.WithSynchronousNotification(ctx), event); emitErr != nil {
logEmissionError("migration commit failed", emitErr)
}
}
return fmt.Errorf("failed to commit migration %s: %w", migration.ID, err)
}
// Emit migration completed event
if m.eventEmitter != nil {
event := modular.NewCloudEvent(EventTypeMigrationCompleted, "database-migration", map[string]interface{}{
"migration_id": migration.ID,
"version": migration.Version,
"duration_ms": time.Since(startTime).Milliseconds(),
}, nil)
if err := m.eventEmitter.EmitEvent(modular.WithSynchronousNotification(ctx), event); err != nil {
logEmissionError("migration completed", err)
}
}
return nil
}
// MigrationRunner helps run multiple migrations
type MigrationRunner struct {
service MigrationService
}
// NewMigrationRunner creates a new migration runner
func NewMigrationRunner(service MigrationService) *MigrationRunner {
return &MigrationRunner{
service: service,
}
}
// RunMigrations runs a set of migrations in order
func (r *MigrationRunner) RunMigrations(ctx context.Context, migrations []Migration) error {
// Sort migrations by version to ensure correct order
sort.Slice(migrations, func(i, j int) bool {
return migrations[i].Version < migrations[j].Version
})
// Ensure migrations table exists
if err := r.service.CreateMigrationsTable(ctx); err != nil {
return fmt.Errorf("failed to create migrations table: %w", err)
}
// Get already applied migrations
applied, err := r.service.GetAppliedMigrations(ctx)
if err != nil {
return fmt.Errorf("failed to get applied migrations: %w", err)
}
appliedMap := make(map[string]bool)
for _, id := range applied {
appliedMap[id] = true
}
// Run pending migrations
for _, migration := range migrations {
if !appliedMap[migration.ID] {
if err := r.service.RunMigration(ctx, migration); err != nil {
return fmt.Errorf("failed to run migration %s: %w", migration.ID, err)
}
}
}
return nil
}