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

feat: enhances S3Download to filter by traced table names (backport #1374) #1380

Closed

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Jun 6, 2024

This PR updates the S3Download implementation to allow specifying the names of the traced tables when downloading from an S3 bucket. This enhancement enables file filtering and reduces the amount of data downloaded. It is a desirable feature when interacting with the traced data of large network tests. If no table name is provided, then S3Download downloads all the traced tables.


This is an automatic backport of pull request #1374 done by Mergify.

This PR updates the `S3Download` implementation to allow specifying the
names of the traced tables when downloading from an S3 bucket. This
enhancement enables file filtering and reduces the amount of data
downloaded. It is a desirable feature when interacting with the traced
data of large network tests. If no table name is provided, then
`S3Download` downloads all the traced tables.

(cherry picked from commit 800924f)
@mergify mergify bot requested a review from a team as a code owner June 6, 2024 14:47
@mergify mergify bot requested review from rootulp and staheri14 and removed request for a team June 6, 2024 14:47
func S3Download(dst, prefix string, cfg S3Config) error {
// fileNames is a list of traced jsonl file names to download. If it is empty, all traces are downloaded.
// fileNames should not have .jsonl suffix.
func S3Download(dst, prefix string, fileNames []string, cfg S3Config) error {
Copy link
Collaborator

@rootulp rootulp Jun 6, 2024

Choose a reason for hiding this comment

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

this is technically a Go API breaking change and pkg/trace is public. Are you sure this should be backported as is? @staheri14

Copy link
Collaborator

Choose a reason for hiding this comment

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

That is a good point, I'll defer it to @evan-forbes, do you think we should avoid merging this change? I can also re-implement it in a backward compatible way i.e., by introducing two different S3Download methods, with and without fileNames.

Copy link
Member

@evan-forbes evan-forbes Jun 7, 2024

Choose a reason for hiding this comment

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

nice let's do all things backwards compatible if we can out of good habit. If there significant cost to doing them backwards compatible then we can reevaluate.

ofc, we just need to add a deprecated note to this function

@staheri14
Copy link
Collaborator

We can close this PR, I will make another PR which introduces the same feature in a backward compatible fashion.

@staheri14 staheri14 closed this Jun 7, 2024
@mergify mergify bot deleted the mergify/bp/v0.34.x-celestia/pr-1374 branch June 7, 2024 16:00
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.

None yet

3 participants