Unify WARC writing + CDXJ indexing into single class #507
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
unify warc-writing into single WARCWriter class to support cdx indexing for all records create dedicated writers for screenshots and text
tw4l
reviewed
Mar 26, 2024
Co-authored-by: Tessa Walsh <tessa@bitarchivist.net>
tw4l
approved these changes
Mar 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, we had the main WARCWriter as well as utility WARCResourceWriter that was used for screenshots, text, pageinfo and only generated resource records. This separate WARC writing path did not generate CDX, and used appendFile() to append new WARC records to an existing WARC.
This PR refactors into a single WARCWriter, which uses a writable stream to append records, and can also generate CDX on the fly. This PR is a pre-requisite to the js-wacz conversion (#484) since all WARCs need to have generated CDX.
However, as this is a big enough change, it made sense to refactor into its own PR for now.