Skip to content
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

Jump to bottom

Streaming in-place WACZ creation + CDXJ indexing #673

Merged
merged 76 commits into from
Aug 29, 2024
Merged

Streaming in-place WACZ creation + CDXJ indexing #673

merged 76 commits into from
Aug 29, 2024

Conversation

ikreymer
Copy link
Member

@ikreymer ikreymer commented Aug 26, 2024 •
edited
Loading

Fixes #674

This PR supersedes #505, and instead of using js-wacz for optimized WACZ creation:

  • generates an 'in-place' or 'streaming' WACZ in the crawler, without having to copy the data again.
  • WACZ contents are streamed to remote upload (or to disk) from existing files on disk
  • CDXJ indices are merged using the linux 'sort' command, and compressed to ZipNum if >50K (or always if using --generateCDX)
  • All data in the WACZ is read / written once
  • Should result in significant speed / disk usage improvements: previously WARC was written once, then read again (for CDXJ indexing), read again (for adding to new WACZ ZIP), written to disk (into new WACZ ZIP), read again (if upload to remote endpoint). Now, WARCs are written once, along with the per-WARC CDXJ, CDXJ is then merged on-disk, and all data is read once to either generate WACZ on disk or upload to remote.

ikreymer and others added 30 commits March 21, 2024 19:43
@ikreymer
switch to using js-wacz natively for wacz creation!
a457a5e 
remove python dependencies
@ikreymer
replace generateCDX with just moves files from tmp-cdx
c6723b0
@ikreymer
fix tests?
1595b35
@tw4l
Wait until after WACZ generation to delete tmp-cdx
952cd75
@tw4l
Add WACZLogger class for use with js-wacz
c68d117
@tw4l
Temporariy comment out validation tests using py-wacz
13b6385
@tw4l
Fix extra hops test to account for extraPages
97b1069
@tw4l
Fix custom driver test to account for extraPages
84c1ef2
@tw4l
Fix extra hops test
118ffb0
@tw4l
Fix typo
82169fe
@tw4l
Generate CDX with warcio CDXIndexer
a5d36ce
@tw4l
Switch js-wacz dependency to ^0.1.0
d5e5976
@ikreymer
Merge branch 'main' into use-js-wacz
3e76568
@ikreymer
Merge branch 'main' into use-js-wacz
9bbce0c
@ikreymer
reenable temp-cdx
280c0c4
@ikreymer
use tempCdxDir
1f02102
@ikreymer
test: clear saved state test dir for reentrancy
4eee5a7
@ikreymer
tests: fix test to account for extraPages.jsonl
58014e6
@ikreymer
Merge branch 'main' into use-js-wacz
dd92629
@ikreymer
Merge branch 'main' into use-js-wacz
e7de7a0
@ikreymer
Merge branch 'main' into use-js-wacz
22ddc92
@ikreymer
Merge branch 'main' into use-js-wacz
c29b1b2
@ikreymer
Merge branch 'main' into use-js-wacz
40a22fd
@ikreymer
Merge branch 'main' into use-js-wacz
2168dbd
@ikreymer
ensure the warcinfo record is also indexed via writeCDX, to ensure co…
d4fd9e7 
…rrect offsets
@ikreymer
Merge branch 'index-warcinfo' into use-js-wacz
8e89fa2
@ikreymer
remove unneeded await
6e4a401
@ikreymer
undo removal, fix tests
de40884
@ikreymer
Merge branch 'main' into use-js-wacz
eb2a3ab
@ikreymer
don't try to index warcinfo, just add offset
ad44858
@ikreymer ikreymer requested a review from tw4l August 26, 2024 21:31
@tw4l tw4l mentioned this pull request Aug 26, 2024
Closed
tw4l
tw4l reviewed Aug 28, 2024
View reviewed changes
Copy link
Contributor

@tw4l tw4l left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few initial comments/suggestions, continuing testing though so far it's looking pretty good!

src/util/wacz.ts Outdated Show resolved Hide resolved
src/util/wacz.ts Outdated Show resolved Hide resolved
src/util/wacz.ts Outdated Show resolved Hide resolved
src/util/wacz.ts Show resolved Hide resolved
tests/basic_crawl.test.js Outdated Show resolved Hide resolved
ikreymer and others added 5 commits August 28, 2024 10:22
@ikreymer @tw4l
Update src/util/wacz.ts
838ef4a 
Co-authored-by: Tessa Walsh <[email protected]>
@ikreymer
rename StartMarker -> CurrZipFileMarker, EndMarker -> EndOfZipFileMar…
36c02a8 
…ker for clarity

remove timezone offset, since running in docker always in UTC by default
(py-wacz did not have a timezone offset either)
@ikreymer
tests: validate wacz with py-wacz if '-validate' flag is passed in
c427658 
ci: add py-wacz for ci use
remove unused test (was never used)
@ikreymer
install py-wacz as root
d346685
@ikreymer
deps: update to warcio 2.3.0 + wombat 3.8.0
a12a08b
@ikreymer
Copy link
Member Author

Updated to latest released warcio.js / wabac.js, should be good to merge when everything else is resolved.

@ikreymer ikreymer marked this pull request as ready for review August 28, 2024 22:04
@ikreymer
Merge branch 'main' into streaming-wacz
2588bda
@ikreymer
rename tempCdxDir -> warcCdxDir and use 'warc-cdx' instead of 'tmp-cdx'
fb427ea 
to make it clear the directory is not temporary (unlike tmp-dl) and should
be kept after a crawl is done, to allow further addition to the same collection
tw4l
tw4l reviewed Aug 29, 2024
View reviewed changes
src/util/wacz.ts Outdated Show resolved Hide resolved
@ikreymer ikreymer merged commit 85a07af into main Aug 29, 2024
4 checks passed
@ikreymer ikreymer deleted the streaming-wacz branch August 29, 2024 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tw4l tw4l tw4l approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Use in-place streaming to generate WACZ files
2 participants
@ikreymer @tw4l