[ENH]: add operator for garbage collection to list all files used by collection version

[codetheweb]

Description of changes

Does what the title says. Given a version file and a version, the operator constructs a complete list of files used by the collection version (including block files by traversing all sparse indices).

Test plan

How are these changes tested?

• Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Tested in the next PR.

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs section?

n/a

[github-actions]

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

• Can you think of any use case in which the code does not behave as intended? Have they been tested?
• Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
• If appropriate, are there adequate property based tests?
• If appropriate, are there adequate unit tests?
• Should any logging, debugging, tracing information be added or removed?
• Are error messages user-friendly?
• Have all documentation changes needed been made?
• Have all non-obvious changes been commented?

System Compatibility

• Are there any potential impacts on other parts of the system or backward compatibility?
• Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

• Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

[codetheweb]

• [ENH]: wire GC v2 to new cleanup modes & call FinishDatabaseDeletion from garbage collector #4671
• [ENH]: soft delete databases, add FinishDatabaseDeletion gRPC method to hard delete databases #4627
• [ENH]: perform collection hard deletes from garbage collector #4605
• [ENH]: sysdb changes to support moving collection hard deletes to garbage collector #4607
• [ENH]: add validation during garbage collection for empty file paths #4586
• [ENH]: garbage collector v2 orchestrator (supports forking) #4468
• [ENH]: allow deleting v0 from version file & correctly propagate errors on DeleteCollectionVersion #4579
• [ENH]: add operator for garbage collection to list all files used by collection version #4466 👈 (View in Graphite)
• [ENH]: add operator to compute versions to garbage collect from version graph #4464
• [ENH]: add orchestrator to construct version graph for garbage collection #4463
• [ENH]: add batch get version file paths method to Sysdb #4432 : 1 other dependent PR (#4447 )
• [ENH]: SysDb should return lineage, version file paths and root collection ID on collections #4557
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[propel-code-bot]

Add Operator to List All Files Used by a Collection Version (for Garbage Collection)

This PR introduces a new garbage collection operator that, given a collection version file and version number, enumerates all file paths associated with that collection version, including block files (by traversing sparse indices), HNSW index files, and sparse index files. Additionally, it registers the new operator in the module system and improves RootManager's debug output by implementing a Debug trait.

Key Changes:
• Added rust/garbage_collector/src/operators/list_files_at_version.rs: Implements ListFilesAtVersionsOperator to output all files relevant for a specific collection version, including careful traversal of version metadata and asynchronous fetching of block IDs from RootManager.
• Registered the new operator in rust/garbage_collector/src/operators/mod.rs.
• Implemented std::fmt::Debug for RootManager in rust/blockstore/src/arrow/provider.rs, aiding diagnostics.

Affected Areas:
• Garbage collector operators
• Blockstore's RootManager (Debug trait implementation)
• Module registration

This summary was automatically generated by @propel-code-bot

[sanketkedia]

why two traces here?

[codetheweb]

they have different log levels
the second one is very verbose

[codetheweb]

Merge activity

• May 23, 2:06 AM UTC: @codetheweb merged this pull request with Graphite.