Files
container/Sources/ContainerPersistence/EntityStore.swift
T
Kathryn Baldauf d6f052d206 Update license header on all files to include the current year (#1024)
## Motivation and Context
Now that we're in 2026, we need to update the license headers on all the
files. Unfortunately, Hawkeye doesn't have an attribute for the current
year to help us avoid this in the future. Instead, I had to work around
this by doing the following:

1. Update licenserc.toml with:
     ```
      [properties]
       ... (other properties)
       currentYear = "2026"
     ```
 
2. Update scripts/license-header.txt with
    ```
Copyright ©{{ " " }}{%- set created = attrs.git_file_created_year or
attrs.disk_file_created_year -%}{%- set modified = props["currentYear"]
-%}{%- if created != modified -%} {{created}}-{{modified}}{%- else
-%}{{created}}{%- endif -%}{{ " " }}{{ props["copyrightOwner"] }}.
    ```

Then I removed these two changes before committing. After this PR is
merged, all files will have recently had git updates, so the existing
code for setting the modified year should work as intended.

Signed-off-by: Kathryn Baldauf <k_baldauf@apple.com>
2026-01-05 13:09:34 -08:00

128 lines
4.4 KiB
Swift

//===----------------------------------------------------------------------===//
// Copyright © 2025-2026 Apple Inc. and the container project authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//===----------------------------------------------------------------------===//
import ContainerizationError
import Foundation
import Logging
let metadataFilename: String = "entity.json"
public protocol EntityStore<T> {
associatedtype T: Codable & Identifiable<String> & Sendable
func list() async throws -> [T]
func create(_ entity: T) async throws
func retrieve(_ id: String) async throws -> T?
func update(_ entity: T) async throws
func upsert(_ entity: T) async throws
func delete(_ id: String) async throws
}
public actor FilesystemEntityStore<T>: EntityStore where T: Codable & Identifiable<String> & Sendable {
typealias Index = [String: T]
private let path: URL
private let type: String
private var index: Index
private let log: Logger
private let encoder = JSONEncoder()
public init(path: URL, type: String, log: Logger) throws {
self.path = path
self.type = type
self.log = log
self.index = try Self.load(path: path, log: log)
}
public func list() async throws -> [T] {
Array(index.values)
}
public func create(_ entity: T) async throws {
let metadataUrl = metadataUrl(entity.id)
guard !FileManager.default.fileExists(atPath: metadataUrl.path) else {
throw ContainerizationError(.exists, message: "entity \(entity.id) already exist")
}
try FileManager.default.createDirectory(at: entityUrl(entity.id), withIntermediateDirectories: true)
let data = try encoder.encode(entity)
try data.write(to: metadataUrl)
index[entity.id] = entity
}
public func retrieve(_ id: String) throws -> T? {
index[id]
}
public func update(_ entity: T) async throws {
let metadataUrl: URL = metadataUrl(entity.id)
guard FileManager.default.fileExists(atPath: metadataUrl.path) else {
throw ContainerizationError(.notFound, message: "entity \(entity.id) not found")
}
let data = try encoder.encode(entity)
try data.write(to: metadataUrl)
index[entity.id] = entity
}
public func upsert(_ entity: T) async throws {
let metadataUrl: URL = metadataUrl(entity.id)
let data = try encoder.encode(entity)
try data.write(to: metadataUrl)
index[entity.id] = entity
}
public func delete(_ id: String) async throws {
let metadataUrl = entityUrl(id)
guard FileManager.default.fileExists(atPath: metadataUrl.path) else {
throw ContainerizationError(.notFound, message: "entity \(id) not found")
}
try FileManager.default.removeItem(at: metadataUrl)
index.removeValue(forKey: id)
}
public func entityUrl(_ id: String) -> URL {
path.appendingPathComponent(id)
}
private static func load(path: URL, log: Logger) throws -> Index {
let directories = try FileManager.default.contentsOfDirectory(at: path, includingPropertiesForKeys: nil)
var index: FilesystemEntityStore<T>.Index = Index()
let decoder = JSONDecoder()
for entityUrl in directories {
do {
let metadataUrl = entityUrl.appendingPathComponent(metadataFilename)
let data = try Data(contentsOf: metadataUrl)
let entity = try decoder.decode(T.self, from: data)
index[entity.id] = entity
} catch {
log.warning(
"failed to load entity, ignoring",
metadata: [
"path": "\(entityUrl)"
])
}
}
return index
}
private func metadataUrl(_ id: String) -> URL {
entityUrl(id).appendingPathComponent(metadataFilename)
}
}