Skip to content

Emit error log on apply failure #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slashmo merged 2 commits into from
May 25, 2026
Merged

Emit error log on apply failure #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c558cb3
Emit error log on apply failure
slashmo May 25, 2026
9596fca
Unit-test log entries
slashmo May 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ let package = Package(
package: "swift-configuration",
condition: .when(traits: ["Configuration"])
),
.product(name: "InMemoryLogging", package: "swift-log"),
],
swiftSettings: sharedSwiftSettings
),
Expand Down
106 changes: 57 additions & 49 deletions Sources/Crane/Migrator.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
//
//===----------------------------------------------------------------------===//

import Logging
package import Logging

#if canImport(FoundationEssentials)
public import FoundationEssentials
Expand All @@ -38,72 +38,80 @@ public struct Migrator<Target: MigrationTarget>: Sendable {
package init(
resolver: some MigrationResolver,
target: Target,
logger: Logger = Logger(label: "Crane"),
measure: @escaping @Sendable (_ work: @Sendable () async throws -> Void) async throws -> Duration = {
try await ContinuousClock().measure($0)
},
now: @escaping @Sendable () -> Date = { .now }
) {
self.resolver = resolver
self.target = target
self.logger = Logger(label: "crane")
self.logger = logger
self.measure = measure
self.now = now
}

public func apply() async throws {
try await target.withLock {
try await target.setUpHistory()
let resolvedMigrations = try await resolver.migrations()
let history = try await target.history()
let state = try await validatedMigrationState(resolved: resolvedMigrations, history: history)
let user = try await target.currentUser()
var nextRank = history.count + 1
var appliedCount = 0
do {
try await target.withLock {
try await target.setUpHistory()
let resolvedMigrations = try await resolver.migrations()
let history = try await target.history()
let state = try await validatedMigrationState(resolved: resolvedMigrations, history: history)
let user = try await target.currentUser()
var nextRank = history.count + 1
var appliedCount = 0

for migration in resolvedMigrations {
switch migration.id {
case .apply(let version, _):
let key = VersionedHistoryKey(version: version, type: .apply)
if !state.appliedVersionedKeys.contains(key) {
for migration in resolvedMigrations {
switch migration.id {
case .apply(let version, _):
let key = VersionedHistoryKey(version: version, type: .apply)
if !state.appliedVersionedKeys.contains(key) {
let sqlScript = try await migration.sqlScript
try await executeMigration(
id: migration.id,
sqlScript: sqlScript,
rank: nextRank,
user: user
)
nextRank += 1
appliedCount += 1
}
case .undo:
continue
case .repeatable(let description):
let sqlScript = try await migration.sqlScript
try await executeMigration(
id: migration.id,
sqlScript: sqlScript,
rank: nextRank,
user: user
)
nextRank += 1
appliedCount += 1
}
case .undo:
continue
case .repeatable(let description):
let sqlScript = try await migration.sqlScript
let scriptChecksum = checksum(sqlScript: sqlScript)
let shouldExecute: Bool
if let lastChecksum = state.lastRepeatableChecksums[description] {
shouldExecute = scriptChecksum != lastChecksum
} else {
shouldExecute = true
}
if shouldExecute {
try await executeMigration(
id: migration.id,
sqlScript: sqlScript,
rank: nextRank,
user: user
)
nextRank += 1
appliedCount += 1
let scriptChecksum = checksum(sqlScript: sqlScript)
let shouldExecute: Bool
if let lastChecksum = state.lastRepeatableChecksums[description] {
shouldExecute = scriptChecksum != lastChecksum
} else {
shouldExecute = true
}
if shouldExecute {
try await executeMigration(
id: migration.id,
sqlScript: sqlScript,
rank: nextRank,
user: user
)
nextRank += 1
appliedCount += 1
}
}
}
}

if appliedCount == 0 {
logger.info("No pending migrations.")
} else {
logger.info("Applied pending migrations.", metadata: ["count": "\(appliedCount)"])
if appliedCount == 0 {
logger.info("No pending migrations.")
} else {
logger.info("Applied pending migrations.", metadata: ["count": "\(appliedCount)"])
}
}
} catch {
// Targets are expected to add their own structured logs when causing failures.
// This log is added on top to round off the reported failure and intentionally omits the `error` argument.
logger.error("Failed to apply pending migrations.")
throw error
}
}

Expand Down
Loading
Loading