Remove git.properties error log#3179
Merged
juan-fernandez merged 2 commits intoMay 23, 2023
Merged
Conversation
Contributor
Overall package sizeSelf size: 4.17 MB Dependency sizes
🤖 This report was automatically generated by heaviest-objects-in-the-universe |
Codecov Report
@@ Coverage Diff @@
## master #3179 +/- ##
==========================================
+ Coverage 86.54% 86.57% +0.02%
==========================================
Files 333 333
Lines 11892 11895 +3
Branches 33 33
==========================================
+ Hits 10292 10298 +6
+ Misses 1600 1597 -3
... and 2 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
juan-fernandez
marked this pull request as ready for review
May 23, 2023 11:02
uurien
approved these changes
May 23, 2023
szegedi
reviewed
May 23, 2023
Comment on lines
+567
to
+575
| let gitPropertiesString | ||
| try { | ||
| gitPropertiesString = fs.readFileSync(DD_GIT_PROPERTIES_FILE, 'utf8') | ||
| } catch (e) { | ||
| // Only log error if the user has set a git.properties path | ||
| if (process.env.DD_GIT_PROPERTIES_FILE) { | ||
| log.error(e) | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
Suggested change
| let gitPropertiesString | |
| try { | |
| gitPropertiesString = fs.readFileSync(DD_GIT_PROPERTIES_FILE, 'utf8') | |
| } catch (e) { | |
| // Only log error if the user has set a git.properties path | |
| if (process.env.DD_GIT_PROPERTIES_FILE) { | |
| log.error(e) | |
| } | |
| } | |
| let gitPropertiesString | |
| if (process.env.DD_GIT_PROPERTIES_FILE) { | |
| gitPropertiesString = maybeFile(DD_GIT_PROPERTIES_FILE); | |
| } |
How about this? It'd still delegate to maybeFile so we aren't duplicating much of its code here. You could even preserve this being const if you replaced the if with ?: but that's secondary (so sad if isn't an expression but a statement…)
Contributor
There was a problem hiding this comment.
ignore this, I realized it's resulting in different behavior. You still want to opportunistically load the file when it's present even if it isn't requested.
Collaborator
Author
There was a problem hiding this comment.
indeed. It isn't great but I don't want to pass DD_GIT_PROPERTIES_FILE to maybeFile, so this is what we're left with
thedavl
pushed a commit
that referenced
this pull request
May 30, 2023
uurien
pushed a commit
that referenced
this pull request
Jun 1, 2023
uurien
pushed a commit
that referenced
this pull request
Jun 1, 2023
uurien
pushed a commit
that referenced
this pull request
Jun 1, 2023
This was referenced Jun 1, 2023
Merged
Merged
Merged
uurien
pushed a commit
that referenced
this pull request
Jun 2, 2023
uurien
pushed a commit
that referenced
this pull request
Jun 2, 2023
uurien
pushed a commit
that referenced
this pull request
Jun 2, 2023
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What does this PR do?
Do not
log.errorifgit.propertiesis not found, unless the user has explicitly attempted to setDD_GIT_PROPERTIES_FILEMotivation
git.propertiesfile will often not be found, so logging an error if it isn't found is mostly noise.This PR changes the
log.errorlogic to only show if the user has explicitly set aDD_GIT_PROPERTIES_FILEenv var, at which point the user is trying to leveragegit.properties.