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.

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

Rename data processing class names to reflect functionality #176

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

hoytak
Copy link
Collaborator

@hoytak hoytak commented Feb 18, 2025

Renamed the following to more clearly reflect the current functionality:

  • PointerFileTranslator -> FileTranslationSession
  • Cleaner -> SingleFileCleaner

The mental model is that a call to download_files or upload_files defines a session, where a session may translate multiple files must fully complete, including completing any remote operations, before returning. This renaming makes this it clearer where the functionality of different parts of this model live.

@hoytak hoytak requested a review from seanses February 18, 2025 21:33
@@ -57,8 +57,10 @@ impl CASDataAggregator {
/// Manages the translation of files between the
/// MerkleDB / pointer file format and the materialized version.
///
/// This class handles the clean and smudge options.
pub struct PointerFileTranslator {
/// This class handles the clean and smudge options. It's meant to be a single atomic session
Copy link
Collaborator

Choose a reason for hiding this comment

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

The upload operation is "session"-based which has clear close session definition (finalize_cleaning) but download is not, each call can succeed or fail independently without interfering others.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ah, fair. I will clarify the comment...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants