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

Add command profile to the BEP under a fixed name #22345

Closed
wants to merge 2 commits into from

Conversation

fmeum
Copy link
Collaborator

@fmeum fmeum commented May 13, 2024

If users specify a custom profile location with --profile, the file is added to the BES under its basename. This makes it harder for BES consumers to pick out the profile. Instead, always announce it under its default name command.profile.gz or command.profile if uncompressed. This additionally allows consumers to detect compression based on just the file name.

@github-actions github-actions bot added the awaiting-review PR is awaiting review from an assigned reviewer label May 13, 2024
@fmeum
Copy link
Collaborator Author

fmeum commented May 13, 2024

@tjgq Could you review this? It's a small change that seems like all upside to me, but curious to learn what you think about it.

If users specify a custom profile location with `--profile`, the file is added to the BES under its basename. This makes it harder for BES consumers to pick out the profile. Instead, always announce it under its default name `command.profile.gz`.
@tjgq
Copy link
Contributor

tjgq commented May 13, 2024

To be honest, I can see it being confusing both ways (from the standpoint of someone setting --profile=foo, how would they guess that command.profile.gz is what it's called in the BEP)?

@meisterT thoughts?

Copy link
Member

@meisterT meisterT left a comment

Choose a reason for hiding this comment

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

@sluongng
Copy link
Contributor

I think end users would not be consuming the profile data from BEP directly. Folks often consume it via some sort of automation system, like a Build Event Service implementation.

With more files being added to the build log tools, these service implementations might have a harder time telling which log is the timing profile data. The current workflow requires folks to parse the --profile flag value in the canonical command line event, then parse the file path (Windows vs Unix) to determine the base filename.

Using a constant name would help remove all these complications in the future.

@fmeum fmeum requested a review from a team as a code owner May 13, 2024 14:03
@fmeum
Copy link
Collaborator Author

fmeum commented May 13, 2024

I updated the tests and added a new one to cover the uncompressed format case.

@tjgq tjgq added awaiting-PR-merge PR has been approved by a reviewer and is ready to be merge internally and removed awaiting-review PR is awaiting review from an assigned reviewer labels May 13, 2024
@sgowroji sgowroji added the team-ExternalDeps External dependency handling, remote repositiories, WORKSPACE file. label May 14, 2024
@github-actions github-actions bot removed the awaiting-PR-merge PR has been approved by a reviewer and is ready to be merge internally label May 14, 2024
@fmeum fmeum deleted the fixed-profile-name branch May 14, 2024 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
team-ExternalDeps External dependency handling, remote repositiories, WORKSPACE file.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants