Skip to content

refactor: Extract individual file imports into a dedicated method #311

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
jbmorley merged 1 commit into from
Jan 22, 2026
Merged

refactor: Extract individual file imports into a dedicated method #311

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
137 changes: 75 additions & 62 deletions Sources/InContextCore/Builder.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,10 +168,10 @@ public class Builder {
return false
}

private func render(session: Session,
document: Document,
documents: [Document],
renderStatus: RenderStatus?) async throws {
private func renderDocument(_ document: Document,
documents: [Document],
renderStatus: RenderStatus?,
session: Session) async throws {

let destinationDirectoryURL = site.filesURL.appendingPathComponent(document.url)
let destinationFileURL = destinationDirectoryURL
Expand Down Expand Up @@ -217,81 +217,93 @@ public class Builder {
try await self.store.forgetAssets(for: relativePath)
}

func importContent(session: Session) async throws {

let task = session.startTask("Scanning files...")
let sourceFiles = try FileManager.default.listFiles(at: site.contentURL)
task.success()
/**
* Import a single file using a specific handler.
*
* This function is currently repsonsible for performing any clean-up from previous builds (though perhaps it
* shouldn't be), and returns a relative URL representing the resulting file path in the database.
*/
func importFile(_ file: File, task: SessionTask) async throws -> URL? {

let fileURLs = try await withTaskRunner(of: URL.self, concurrent: !serializeImport) { tasks in
for file in sourceFiles {
let task = session.startTask("Importing '\(file.url.relativePath)'...")
// Get the handler for the file.
guard let handler = try self.site.handler(for: file.url) else {
task.warning("Ignoring unsupported file '\(file.url.relativePath)'.")
task.success(.skipped)
return nil
}

// Get the handler for the file.
guard let handler = try self.site.handler(for: file.url) else {
task.warning("Ignoring unsupported file '\(file.url.relativePath)'.")
task.success(.skipped)
continue
}
// TODO: Templates are stored in cached data so input settings need to invalidate the cache.

// Schedule the import.
// Cache metadata about the importer instance / handler.
let handlerFingerprint = try handler.fingerprint()

tasks.add {
// Check to see if the file already exists in the store and has a matching modification date.
if let status = try await self.store.status(for: file.url.relativePath,
contentURL: self.site.contentURL) {

// TODO: Templates are stored in cached data so input settings need to invalidate the cache.
let fileModified = (status.contentModificationDate.millisecondsSinceReferenceDate !=
file.contentModificationDate.millisecondsSinceReferenceDate)
let differentImporterVersion = status.fingerprint != handlerFingerprint

// Cache metadata about the importer instance / handler.
let handlerFingerprint = try handler.fingerprint()
if !fileModified && !differentImporterVersion {
task.debug("File unchanged")
task.success(.skipped)
return file.url
}

// Check to see if the file already exists in the store and has a matching modification date.
if let status = try await self.store.status(for: file.url.relativePath,
contentURL: self.site.contentURL) {
// Clean up the existing assets.
try await self.removeIntermediates(for: file.url.relativePath,
filesURL: self.site.filesURL,
task: task)
}

let fileModified = (status.contentModificationDate.millisecondsSinceReferenceDate !=
file.contentModificationDate.millisecondsSinceReferenceDate)
let differentImporterVersion = status.fingerprint != handlerFingerprint
task.debug("File new or changed; re-importing")

// Import the file.
do {
// TODO: Inject the task into the process operation.
let result = try await handler.process(file: file, outputURL: self.site.filesURL)
let status = Status(fileURL: file.url,
contentModificationDate: file.contentModificationDate,
importer: handler.identifier,
fingerprint: handlerFingerprint)
try await self.store.save(document: result.document, assets: result.assets, status: status)
task.success()
return file.url
} catch {
task.failure(error)
throw InContextError.importError(file.url, error)
}
}

if !fileModified && !differentImporterVersion {
task.debug("File unchanged")
task.success(.skipped)
return file.url
}
/**
* Perform an incremental import of all the site content.
*/
func importContent(session: Session) async throws {

// Clean up the existing assets.
try await self.removeIntermediates(for: file.url.relativePath,
filesURL: self.site.filesURL,
task: task)
}
// Get all the site source files in the content directory.
let task = session.startTask("Scanning files...")
let sourceFiles = try FileManager.default.listFiles(at: site.contentURL)
task.success()

task.debug("File new or changed; re-importing")

// Import the file.
do {
// TODO: Inject the task into the process operation.
let result = try await handler.process(file: file, outputURL: self.site.filesURL)
let status = Status(fileURL: file.url,
contentModificationDate: file.contentModificationDate,
importer: handler.identifier,
fingerprint: handlerFingerprint)
try await self.store.save(document: result.document, assets: result.assets, status: status)
task.success()
return file.url
} catch {
task.failure(error)
throw InContextError.importError(file.url, error)
}
// Enqueue and wait on tasks to import each individual file.
let fileURLs = try await withTaskRunner(of: URL.self, concurrent: !serializeImport) { tasks in
for file in sourceFiles {
let task = session.startTask("Importing '\(file.url.relativePath)'...")
tasks.add {
return try await self.importFile(file, task: task)
}
}
}

// Remove the documents associated with the files that don't exist any more.
// TODO: Remove the assets associated with the files that don't exist anymore.
// TODO: Remove the render output for documents that no longer exist.
let documentSourcePaths = Set(try await store.documentRelativeSourcePaths())
let sourcePaths = Set(fileURLs.map { $0.relativePath })
let deletedSourcePaths = documentSourcePaths.subtracting(sourcePaths)
try await store.deleteDocuments(relativeSourcePaths: Array(deletedSourcePaths))

// TODO: Remove the assets associated with the files that don't exist anymore.
// TODO: Remove the render output for documents that no longer exist.
}

func renderContent(session: Session, concurrent: Bool) async throws {
Expand All @@ -308,6 +320,7 @@ public class Builder {
return try store.documents()
}

// TODO: withTaskRunner?
let updates = try await session.withTask("Checking for changes...") { _ in
return try await withThrowingTaskGroup(of: (Document?).self) { group in
for document in documents {
Expand Down Expand Up @@ -335,10 +348,10 @@ public class Builder {
_ = try await withTaskRunner(of: Void.self, concurrent: concurrent) { tasks in
for document in updates {
tasks.add {
try await self.render(session: session,
document: document,
documents: documents,
renderStatus: renderStatuses[document.url])
try await self.renderDocument(document,
documents: documents,
renderStatus: renderStatuses[document.url],
session: session)
}
}
}
Expand Down