-
Notifications
You must be signed in to change notification settings - Fork 133
Add catalist match download retry logic #1853
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
Open
sharinetmc
wants to merge
2
commits into
ian/patch/catalist-zip-operation
Choose a base branch
from
add-catalist=match-download-retry
base: ian/patch/catalist-zip-operation
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -339,7 +339,45 @@ def await_completion( | |
| result = self.load_matches(id=id) | ||
| return result | ||
|
|
||
| def load_matches(self, id: str) -> Table: | ||
| def fetch_zip_with_retry( | ||
| self, remote_path: str, job_id: str, max_retries: int = 3, backoff_factor: int = 2 | ||
| ): | ||
| last_exception = None | ||
|
|
||
| for attempt in range(1, max_retries + 1): | ||
| try: | ||
| # 1. Attempt the download | ||
| temp_file_zip = self.sftp.get_file( | ||
| remote_path=remote_path, export_chunk_size=DEFAULT_EXPORT_CHUNK_SIZE | ||
| ) | ||
|
|
||
| # 2. Validate the integrity of the file | ||
| if not is_zipfile(temp_file_zip): | ||
| size = temp_file_zip.stat().st_size | ||
| raise RuntimeError(f"Corrupt zip (Size: {size} bytes)") | ||
|
Comment on lines
+342
to
+357
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. curious why we don't just decorate this function with |
||
|
|
||
| # 3. Success: Return the file | ||
| return temp_file_zip | ||
|
|
||
| except RuntimeError as e: | ||
| last_exception = e | ||
| if attempt < max_retries: | ||
| sleep_time = backoff_factor**attempt | ||
| logger.warning( | ||
| f"Attempt {attempt} failed for job {job_id}: {e}. " | ||
| f"Retrying in {sleep_time}s..." | ||
| ) | ||
| time.sleep(sleep_time) | ||
| else: | ||
| logger.error(f"Final attempt failed for job {job_id}.") | ||
|
|
||
| # If the loop finishes without returning, raise the final error | ||
| raise RuntimeError( | ||
| f"Failed to download valid zip for job {job_id} after {max_retries} attempts. " | ||
| f"Remote path: {remote_path}. Error: {last_exception}" | ||
| ) | ||
|
|
||
| def load_matches(self, id: str, max_retries: int = 3, backoff_factor: int = 2) -> Table: | ||
| """Take a completed job ID, download and open the match file as a Table. | ||
|
|
||
| Result will be a Table with all the original columns along with columns 'DWID', | ||
|
|
@@ -372,17 +410,13 @@ def load_matches(self, id: str) -> Table: | |
| remote_filename = [filename for filename in remote_filepaths if id in filename][0] | ||
| remote_filepath = "/myDownloads/" + remote_filename | ||
|
|
||
| temp_file_zip = self.sftp.get_file( | ||
| remote_path=remote_filepath, export_chunk_size=DEFAULT_EXPORT_CHUNK_SIZE | ||
| temp_file_zip = self.fetch_zip_with_retry( | ||
| job_id=id, | ||
| remote_path=remote_filepath, | ||
| max_retries=max_retries, | ||
| backoff_factor=backoff_factor, | ||
| ) | ||
|
|
||
| if not is_zipfile(temp_file_zip): | ||
| raise RuntimeError( | ||
| f"Downloaded file for job {id} is not a valid zip file " | ||
| f"(size: {temp_file_zip.stat().st_size} bytes, remote path: {remote_filepath}). " | ||
| "The SFTP download may be corrupt or incomplete." | ||
| ) | ||
|
|
||
| logger.debug( | ||
| f"Download complete for job {id} (local size: {temp_file_zip.stat().st_size} bytes)." | ||
| ) | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will solve your test failure