Skip to content

Add error handling and basic tracking to abl #13

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
TylerZeroMaster merged 7 commits into from
Feb 3, 2026
Merged

Add error handling and basic tracking to abl #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a3dc037
Add error handling and basic tracking to abl
TylerZeroMaster Jan 26, 2026
5ce002a
Refactor archive fallback logic with improved error handling and grac…
TylerZeroMaster Jan 28, 2026
c691ba7
Add test for multiple attempts
TylerZeroMaster Jan 28, 2026
fc71107
Add test for error being raised
TylerZeroMaster Jan 28, 2026
ec76fb2
Re-add `book.valid?` check
TylerZeroMaster Jan 28, 2026
28601a0
Small fixes
TylerZeroMaster Feb 2, 2026
230f807
Raise if partial data is not allowed
TylerZeroMaster Feb 3, 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
56 changes: 32 additions & 24 deletions lib/openstax/content/abl.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,11 @@ class OpenStax::Content::Abl
# If there are more than this number of archive versions still building, errors will happen
DEFAULT_MAX_ARCHIVE_ATTEMPTS = 5

attr_reader :partial_data

def initialize(url: nil)
@url = url
@partial_data = false
end

def url
Expand Down Expand Up @@ -39,51 +42,56 @@ def books(archive: OpenStax::Content::Archive.new)
end
end

def each_book_with_previous_archive_version_fallback(max_attempts: DEFAULT_MAX_ARCHIVE_ATTEMPTS, &block)
def each_book_with_previous_archive_version_fallback(max_attempts: DEFAULT_MAX_ARCHIVE_ATTEMPTS, allow_partial_data: true, &block)
raise ArgumentError, 'no block given' if block.nil?
raise ArgumentError, 'given block must accept the book as its first argument' if block.arity == 0

books = OpenStax::Content::Abl.new.books
attempt = 1
@partial_data = false

until books.empty?
books.each do |book|
attempt = 1
previous_version = nil
previous_archive = nil
retry_books = []

books.each do |book|
while attempt <= max_attempts
begin
block.call book
break
rescue StandardError => exception
raise exception if attempt >= max_attempts

# Sometimes books in the latest archive fails to load (when the new version is still building)
# Retry with an earlier version of archive, if possible
previous_version ||= book.archive.previous_version

if previous_version.nil?
# There are no more earlier archive versions
raise exception
previous_version = book.archive.previous_version
if previous_version.nil? || attempt >= max_attempts
raise exception unless allow_partial_data
@partial_data = true
OpenStax::Content::logger.warn do
"Failed to process book: #{book.uuid}. " \
"Error: #{exception.class}: #{exception.message}"
end
break
else
previous_archive ||= OpenStax::Content::Archive.new version: previous_version

retry_book = OpenStax::Content::Book.new(
previous_archive = OpenStax::Content::Archive.new version: previous_version
book = OpenStax::Content::Book.new(
archive: previous_archive,
uuid: book.uuid,
version: book.version,
slug: book.slug,
min_code_version: book.min_code_version,
committed_at: book.committed_at
)

# If the book requires an archive version that hasn't finished building yet, don't include it
retry_books << retry_book if retry_book.valid?
# NOTE: This assumes that subsequent archive versions are invalid
# after finding one invalid archive versions
unless book.valid?
raise exception unless allow_partial_data
@partial_data = true
OpenStax::Content::logger.warn do
"Failed to process book: #{book.uuid}. " \
"Error: invalid book for archive version #{previous_version}"
end
break
end
end
attempt += 1
end
end

books = retry_books
attempt += 1
end
end

Expand Down
Loading