Remove git.properties error log

[juan-fernandez]

What does this PR do?

Do not log.error if git.properties is not found, unless the user has explicitly attempted to set DD_GIT_PROPERTIES_FILE

Motivation

git.properties file will often not be found, so logging an error if it isn't found is mostly noise.

This PR changes the log.error logic to only show if the user has explicitly set a DD_GIT_PROPERTIES_FILE env var, at which point the user is trying to leverage git.properties.

[github-actions]

Overall package size

Self size: 4.17 MB
Deduped: 58.3 MB
No deduping: 58.34 MB

Dependency sizes

name	version	self size	total size
@datadog/pprof	2.2.1	14.24 MB	15.12 MB
@datadog/native-iast-taint-tracking	1.4.1	14.85 MB	14.86 MB
@datadog/native-appsec	3.1.0	13.31 MB	13.32 MB
protobufjs	7.1.2	2.76 MB	6.55 MB
@datadog/native-iast-rewriter	2.0.1	2.09 MB	2.1 MB
@datadog/native-metrics	2.0.0	898.77 kB	1.3 MB
opentracing	0.14.7	194.81 kB	194.81 kB
semver	7.3.8	88.2 kB	118.6 kB
@datadog/sketches-js	2.1.0	109.9 kB	109.9 kB
lodash.sortby	4.7.0	75.76 kB	75.76 kB
lru-cache	7.14.0	74.95 kB	74.95 kB
ipaddr.js	2.0.1	59.52 kB	59.52 kB
ignore	5.2.0	48.87 kB	48.87 kB
import-in-the-middle	1.3.5	34.34 kB	38.81 kB
istanbul-lib-coverage	3.2.0	29.34 kB	29.34 kB
retry	0.10.1	27.44 kB	27.44 kB
lodash.uniq	4.5.0	25.01 kB	25.01 kB
limiter	1.1.5	23.17 kB	23.17 kB
lodash.kebabcase	4.1.1	17.75 kB	17.75 kB
lodash.pick	4.4.0	16.33 kB	16.33 kB
node-abort-controller	3.0.1	14.33 kB	14.33 kB
crypto-randomuuid	1.0.0	11.18 kB	11.18 kB
diagnostics_channel	1.1.0	7.07 kB	7.07 kB
path-to-regexp	0.1.7	6.78 kB	6.78 kB
koalas	1.0.2	6.47 kB	6.47 kB
methods	1.1.2	5.29 kB	5.29 kB
module-details-from-path	1.0.3	4.47 kB	4.47 kB

_{🤖 This report was automatically generated by heaviest-objects-in-the-universe}

[codecov]

Codecov Report

Merging #3179 (29e8548) into master (4555ef6) will increase coverage by 0.02%.
The diff coverage is 100.00%.

@@            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     

Impacted Files	Coverage Δ
packages/dd-trace/src/config.js	99.00% <100.00%> (+0.01%)	⬆️

... and 2 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[szegedi]

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…)

[szegedi]

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.

[juan-fernandez]

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

[szegedi]

Thanks for fixing this!

[pr-commenter]

Benchmarks

Comparing candidate commit 29e8548 in PR branch juan-fernandez/remove-git-properties-log-error with baseline commit 4555ef6 in branch master.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 443 metrics, 29 unstable metrics.