swift-actor-persistence
affaan-m/everything-claude-code
Thread-safe data persistence in Swift using actors with in-memory cache and file-backed storage.
What is swift-actor-persistence?
A pattern for building thread-safe data persistence layers in Swift 5.5+ using the actor model. Combines in-memory caching with atomic file writes, eliminating data races at compile time without manual synchronization.
- Provides an actor-based generic repository for Codable & Identifiable types
- Implements O(1) in-memory cache lookups with automatic file persistence
- Guarantees thread-safe access through compiler-enforced actor isolation
- Handles atomic file writes to prevent data corruption on crashes
- Supports save, delete, find, and loadAll operations on cached data
- Integrates with @Observable ViewModels for reactive UI updates
How to install swift-actor-persistence
npx skills add https://github.com/affaan-m/everything-claude-code --skill swift-actor-persistence- Swift 5.5 or later
- Models conforming to Codable and Identifiable protocols
- Understanding of Swift async/await syntax
How to use swift-actor-persistence
- 1.Define your data model conforming to Codable and Identifiable with String ID
- 2.Create a LocalRepository instance parameterized with your model type
- 3.Call await repository.find(by:), await repository.loadAll(), try await repository.save(_:), or try await repository.delete(_:) from async contexts
- 4.Wrap the repository in an @Observable ViewModel to drive UI updates
- 5.Ensure all data types crossing actor boundaries conform to Sendable
Use cases
- Building local data storage for iOS/macOS apps with user data and settings
- Implementing offline-first architectures that sync to a server later
- Replacing legacy DispatchQueue-based thread safety with modern Swift concurrency
- Managing cached content that multiple parts of the app access concurrently
- Storing and retrieving domain models (questions, items, records) with type safety
- Swift developers building iOS/macOS apps
- Teams migrating from DispatchQueue to Swift concurrency
- Developers implementing offline-first or local-first architectures
- Anyone needing thread-safe access to shared mutable state in Swift
swift-actor-persistence FAQ
Actors provide compiler-enforced thread safety without manual synchronization. The compiler prevents data races at compile time, whereas locks and DispatchQueue require careful manual coordination and are error-prone.
No. Synchronous loading during initialization avoids async initializer complexity with minimal downside for local file access, which is typically fast. Async initializers add significant complexity for local storage scenarios.
The cache enables O(1) lookups by ID without disk I/O. Writes update both the cache and persist atomically to disk, giving you fast reads and durable storage.
Atomic file writes (using .atomic option) ensure the file is either fully updated or unchanged. Partial writes are prevented, protecting data integrity.
The current pattern uses JSON via Codable. For other formats, you would need to modify the persistToFile and loadSynchronously methods to handle your custom serialization logic.
Full instructions (SKILL.md)
Source of truth, from affaan-m/everything-claude-code.
name: swift-actor-persistence description: Thread-safe data persistence in Swift using actors — in-memory cache with file-backed storage, eliminating data races by design. metadata: origin: ECC
Swift Actors for Thread-Safe Persistence
Patterns for building thread-safe data persistence layers using Swift actors. Combines in-memory caching with file-backed storage, leveraging the actor model to eliminate data races at compile time.
When to Activate
- Building a data persistence layer in Swift 5.5+
- Need thread-safe access to shared mutable state
- Want to eliminate manual synchronization (locks, DispatchQueues)
- Building offline-first apps with local storage
Core Pattern
Actor-Based Repository
The actor model guarantees serialized access — no data races, enforced by the compiler.
public actor LocalRepository<T: Codable & Identifiable> where T.ID == String {
private var cache: [String: T] = [:]
private let fileURL: URL
public init(directory: URL = .documentsDirectory, filename: String = "data.json") {
self.fileURL = directory.appendingPathComponent(filename)
// Synchronous load during init (actor isolation not yet active)
self.cache = Self.loadSynchronously(from: fileURL)
}
// MARK: - Public API
public func save(_ item: T) throws {
cache[item.id] = item
try persistToFile()
}
public func delete(_ id: String) throws {
cache[id] = nil
try persistToFile()
}
public func find(by id: String) -> T? {
cache[id]
}
public func loadAll() -> [T] {
Array(cache.values)
}
// MARK: - Private
private func persistToFile() throws {
let data = try JSONEncoder().encode(Array(cache.values))
try data.write(to: fileURL, options: .atomic)
}
private static func loadSynchronously(from url: URL) -> [String: T] {
guard let data = try? Data(contentsOf: url),
let items = try? JSONDecoder().decode([T].self, from: data) else {
return [:]
}
return Dictionary(uniqueKeysWithValues: items.map { ($0.id, $0) })
}
}
Usage
All calls are automatically async due to actor isolation:
let repository = LocalRepository<Question>()
// Read — fast O(1) lookup from in-memory cache
let question = await repository.find(by: "q-001")
let allQuestions = await repository.loadAll()
// Write — updates cache and persists to file atomically
try await repository.save(newQuestion)
try await repository.delete("q-001")
Combining with @Observable ViewModel
@Observable
final class QuestionListViewModel {
private(set) var questions: [Question] = []
private let repository: LocalRepository<Question>
init(repository: LocalRepository<Question> = LocalRepository()) {
self.repository = repository
}
func load() async {
questions = await repository.loadAll()
}
func add(_ question: Question) async throws {
try await repository.save(question)
questions = await repository.loadAll()
}
}
Key Design Decisions
| Decision | Rationale |
|---|---|
| Actor (not class + lock) | Compiler-enforced thread safety, no manual synchronization |
| In-memory cache + file persistence | Fast reads from cache, durable writes to disk |
| Synchronous init loading | Avoids async initialization complexity |
| Dictionary keyed by ID | O(1) lookups by identifier |
Generic over Codable & Identifiable | Reusable across any model type |
Atomic file writes (.atomic) | Prevents partial writes on crash |
Best Practices
- Use
Sendabletypes for all data crossing actor boundaries - Keep the actor's public API minimal — only expose domain operations, not persistence details
- Use
.atomicwrites to prevent data corruption if the app crashes mid-write - Load synchronously in
init— async initializers add complexity with minimal benefit for local files - Combine with
@ObservableViewModels for reactive UI updates
Anti-Patterns to Avoid
- Using
DispatchQueueorNSLockinstead of actors for new Swift concurrency code - Exposing the internal cache dictionary to external callers
- Making the file URL configurable without validation
- Forgetting that all actor method calls are
await— callers must handle async context - Using
nonisolatedto bypass actor isolation (defeats the purpose)
When to Use
- Local data storage in iOS/macOS apps (user data, settings, cached content)
- Offline-first architectures that sync to a server later
- Any shared mutable state that multiple parts of the app access concurrently
- Replacing legacy
DispatchQueue-based thread safety with modern Swift concurrency
Related skills
More from affaan-m/everything-claude-code and the wider catalog.
security-review
Security checklist and patterns for authentication, input validation, secrets, and sensitive features.
golang-patterns
Idiomatic Go patterns, best practices, and conventions for building robust, efficient, and maintainable applications.
coding-standards
Baseline coding conventions for naming, readability, immutability, and quality across projects.
frontend-patterns
React and Next.js patterns for components, state management, performance, and modern frontend practices.
backend-patterns
REST/GraphQL API design, database optimization, and server-side patterns for Node.js, Express, and Next.js.
golang-testing
Go testing patterns: table-driven tests, subtests, benchmarks, fuzzing, and TDD methodology.