-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
feat(emerge): Add new vcs fields to buildDetails API #97456
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
Merged
Merged
Conversation
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
This stack of pull requests is managed by Graphite. Learn more about stacking. |
Comment on lines
+129
to
+168
head_sha=( | ||
preprod_artifact.commit_comparison.head_sha | ||
if preprod_artifact.commit_comparison | ||
else None | ||
), | ||
base_sha=( | ||
preprod_artifact.commit_comparison.base_sha | ||
if preprod_artifact.commit_comparison | ||
else None | ||
), | ||
provider=( | ||
preprod_artifact.commit_comparison.provider | ||
if preprod_artifact.commit_comparison | ||
else None | ||
), | ||
head_repo_name=( | ||
preprod_artifact.commit_comparison.head_repo_name | ||
if preprod_artifact.commit_comparison | ||
else None | ||
), | ||
base_repo_name=( | ||
preprod_artifact.commit_comparison.base_repo_name | ||
if preprod_artifact.commit_comparison | ||
else None | ||
), | ||
head_ref=( | ||
preprod_artifact.commit_comparison.head_ref | ||
if preprod_artifact.commit_comparison | ||
else None | ||
), | ||
base_ref=( | ||
preprod_artifact.commit_comparison.base_ref | ||
if preprod_artifact.commit_comparison | ||
else None | ||
), | ||
pr_number=( | ||
preprod_artifact.commit_comparison.pr_number | ||
if preprod_artifact.commit_comparison | ||
else None | ||
), |
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.
Potential bug: The API response removes the `commit_id` field, but frontend code and tests still expect it, which will cause test failures and break UI components.
- Description: The
ProjectPreprodBuildDetailsEndpoint
is modified to no longer include thecommit_id
field in thevcs_info
dictionary of its API response. However, consumers of this endpoint have not been updated to reflect this change. Tests intest_project_preprod_build_details.py
explicitly assert the presence of this key, which will cause them to fail. Furthermore, the frontend componentbuildDetailsSidebarContent.tsx
accessesbuildDetailsData.vcs_info?.commit_id
, and its corresponding TypeScript interface expects the field to exist. Removing this field is a breaking API change that will cause test failures and result in incorrect data being displayed in the user interface. - Suggested fix: To maintain backward compatibility, re-introduce the
commit_id
field to the API response. Alternatively, update all consumers, including tests and frontend code, to use the new fields (e.g.,head_sha
) and remove their dependency oncommit_id
.
severity: 0.85, confidence: 0.98
Did we get this right? 👍 / 👎 to inform future reviews.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #97456 +/- ##
==========================================
- Coverage 80.58% 80.58% -0.01%
==========================================
Files 8557 8557
Lines 376468 376553 +85
Branches 24468 24468
==========================================
+ Hits 303381 303437 +56
- Misses 72717 72746 +29
Partials 370 370 |
a5b687e
to
de6b5e0
Compare
feac969
to
94ac7bd
Compare
94ac7bd
to
91c2113
Compare
Base automatically changed from
ryan/add_new_vcs_related_fields_to_preprod_artifact_assemble_endpoint
to
master
August 8, 2025 03:19
trevor-e
approved these changes
Aug 8, 2025
91c2113
to
5875175
Compare
andrewshie-sentry
pushed a commit
that referenced
this pull request
Aug 12, 2025
Add new vcs fields to buildDetails API Nullable fields
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add new vcs fields to buildDetails API
Nullable fields