[PROF-6288] Enable -Werror to turn compiler warnings into errors in CI
#2358
Conversation
This file contains 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
**What does this PR do?**: This PR enables the `-Werror` compiler flag, which turns any compiler warnings into errors, when compiling profiler C code in CI. I also refreshed the `extconf.rb` for the `ddtrace_profiling_loader` to match the compiler flags from `ddtrace_profiling_native_extension` as well. **Motivation**: Most compiler warnings are quite useful at point out potential bugs, and we want to make sure our code is warning-free on all Ruby versions we support. **Additional Notes**: We don't enable `-Werror` always because we can't control what compiler our customers use. E.g. they may use a new compiler which introduces a new warning which we haven't seen and it doesn't make sense to "break" profiling for them just because of that. **How to test the change?**: Check that CI is still green.
ivoanjo
commented
Nov 9, 2022
Comment on lines
+31
to
38
| # Older gcc releases may not default to C99 and we need to ask for this. This is also used: | ||
| # * by upstream Ruby -- search for gnu99 in the codebase | ||
| # * by msgpack, another ddtrace dependency | ||
| # (https://github.com/msgpack/msgpack-ruby/blob/18ce08f6d612fe973843c366ac9a0b74c4e50599/ext/msgpack/extconf.rb#L8) | ||
| add_compiler_flag '-std=gnu99' | ||
|
|
||
| # Gets really noisy when we include the MJIT header, let's omit it | ||
| add_compiler_flag '-Wno-unused-function' |
There was a problem hiding this comment.
This flag, as well as others below were already in ext/ddtrace_profiling_native_extension/extconf.rb but I had forgot to enable them for ext/ddtrace_profiling_loader/extconf.rb so I took the opportunity to copy them over as well.
lloeki
approved these changes
Nov 10, 2022
ivoanjo
added a commit
that referenced
this pull request
Nov 17, 2022
**What does this PR do?**: In #2358 we changed how the profiling native extension is built in CI by adding the `-Werror` compiler option to turn warnings into errors. We did this automatically by checking if the `CI` environment variable was set to `true`. Unfortunately, this broke at least one user, see <DataDog/datadog-api-client-ruby#1137>. The warning that was triggered in that case was actually not relevant, see my investigation in <#2377>. The `CI=true` was never meant to trigger outside of our CI, but clearly it's too generic of a name for us to rely on that. To fix this, I've gone ahead and changed the configuration so that `-Werror` only gets added when `DD_PROFILING_CI=true`. I also changed our docker and CircleCI configurations to set this by default. **Motivation**: This issue affected one Datadog internal customer -- <DataDog/datadog-api-client-ruby#1137>. This should never happen -- we don't want any issues when compiling the profiling bits to affect ddtrace installation. **Additional Notes**: (Nothing) **How to test the change?**: Validate that `-Werror` only gets added when `DD_PROFILING_CI=true`. To trigger a warning for testing, try removing `DDTRACE_UNUSED` from function argument declarations, and you should see that the compiler starts failing due to that. --- Fixes #2377
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.
What does this PR do?:
This PR enables the
-Werrorcompiler flag, which turns any compiler warnings into errors, when compiling profiler C code in CI.I also refreshed the
extconf.rbfor theddtrace_profiling_loaderto match the compiler flags fromddtrace_profiling_native_extensionas well.Motivation:
Most compiler warnings are quite useful at point out potential bugs, and we want to make sure our code is warning-free on all Ruby versions we support.
Additional Notes:
We don't enable
-Werroralways because we can't control what compiler our customers use. E.g. they may use a new compiler which introduces a new warning which we haven't seen and it doesn't make sense to "break" profiling for them just because of that.This PR is on top of
ivoanjo/prof-5942-ractor-supportjust out of convenience and does not really depend on anything on that PR.How to test the change?:
Check that CI is still green.