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

Fix circular requires #2826

Merged
merged 1 commit into from
May 5, 2023
Merged

Fix circular requires #2826

merged 1 commit into from
May 5, 2023

Conversation

mscrivo
Copy link
Contributor

@mscrivo mscrivo commented May 1, 2023

What does this PR do?
This is to fix an issue we're seeing when running tests in our codebase. It should not be necessary to include core everywhere since these files should not be required directly as far as I understand.

Motivation
To fix this warning:

Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/tracing/trace_operation.rb:1: warning:
/Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/tracing/trace_operation.rb:1: warning: loading in progress, circular require considered harmful -
/Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/core.rb
	from -e:1:in  `<main>'
	from <internal:/Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/3.2.0/rubygems/core_ext/kernel_require.rb>:37:in  `require'
	from <internal:/Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/3.2.0/rubygems/core_ext/kernel_require.rb>:37:in  `require'
	from /Users/michaelscrivo/affinity/ruby/gems/enrichers_datadog/test/lib/base.rb:2:in  `<top (required)>'
	from /Users/michaelscrivo/affinity/ruby/gems/enrichers_datadog/test/lib/base.rb:2:in  `require_relative'
	from /Users/michaelscrivo/affinity/ruby/gems/enrichers_datadog/lib/enrichers_datadog.rb:3:in  `<top (required)>'
	from /Users/michaelscrivo/affinity/ruby/gems/enrichers_datadog/lib/enrichers_datadog.rb:3:in  `require_relative'
	from /Users/michaelscrivo/affinity/ruby/gems/enrichers_datadog/lib/datadog_trace_enricher.rb:7:in  `<top (required)>'
	from <internal:/Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/3.2.0/rubygems/core_ext/kernel_require.rb>:37:in  `require'
	from <internal:/Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/3.2.0/rubygems/core_ext/kernel_require.rb>:37:in  `require'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/ddtrace.rb:4:in  `<top (required)>'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/ddtrace.rb:4:in  `require_relative'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/tracing.rb:3:in  `<top (required)>'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/tracing.rb:3:in  `require_relative'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/core.rb:3:in  `<top (required)>'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/core.rb:3:in  `require_relative'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/core/extensions.rb:3:in  `<top (required)>'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/core/extensions.rb:3:in  `require_relative'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/core/configuration.rb:1:in  `<top (required)>'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/core/configuration.rb:1:in  `require_relative'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/core/configuration/components.rb:10:in  `<top (required)>'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/core/configuration/components.rb:10:in  `require_relative'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/tracing/component.rb:3:in  `<top (required)>'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/tracing/component.rb:3:in  `require_relative'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/tracing/tracer.rb:15:in  `<top (required)>'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/tracing/tracer.rb:15:in  `require_relative'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/tracing/trace_operation.rb:1:in  `<top (required)>'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/tracing/trace_operation.rb:1:in  `require_relative'

This is to fix an issue we're seeing when running tests in our codebase:

```
Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/tracing/trace_operation.rb:1: warning:
/Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/tracing/trace_operation.rb:1: warning: loading in progress, circular require considered harmful -
/Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/core.rb
	from -e:1:in  `<main>'
	from <internal:/Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/3.2.0/rubygems/core_ext/kernel_require.rb>:37:in  `require'
	from <internal:/Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/3.2.0/rubygems/core_ext/kernel_require.rb>:37:in  `require'
	from /Users/michaelscrivo/affinity/ruby/gems/enrichers_datadog/test/lib/base.rb:2:in  `<top (required)>'
	from /Users/michaelscrivo/affinity/ruby/gems/enrichers_datadog/test/lib/base.rb:2:in  `require_relative'
	from /Users/michaelscrivo/affinity/ruby/gems/enrichers_datadog/lib/enrichers_datadog.rb:3:in  `<top (required)>'
	from /Users/michaelscrivo/affinity/ruby/gems/enrichers_datadog/lib/enrichers_datadog.rb:3:in  `require_relative'
	from /Users/michaelscrivo/affinity/ruby/gems/enrichers_datadog/lib/datadog_trace_enricher.rb:7:in  `<top (required)>'
	from <internal:/Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/3.2.0/rubygems/core_ext/kernel_require.rb>:37:in  `require'
	from <internal:/Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/3.2.0/rubygems/core_ext/kernel_require.rb>:37:in  `require'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/ddtrace.rb:4:in  `<top (required)>'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/ddtrace.rb:4:in  `require_relative'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/tracing.rb:3:in  `<top (required)>'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/tracing.rb:3:in  `require_relative'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/core.rb:3:in  `<top (required)>'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/core.rb:3:in  `require_relative'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/core/extensions.rb:3:in  `<top (required)>'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/core/extensions.rb:3:in  `require_relative'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/core/configuration.rb:1:in  `<top (required)>'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/core/configuration.rb:1:in  `require_relative'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/core/configuration/components.rb:10:in  `<top (required)>'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/core/configuration/components.rb:10:in  `require_relative'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/tracing/component.rb:3:in  `<top (required)>'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/tracing/component.rb:3:in  `require_relative'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/tracing/tracer.rb:15:in  `<top (required)>'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/tracing/tracer.rb:15:in  `require_relative'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/tracing/trace_operation.rb:1:in  `<top (required)>'
	from /Users/michaelscrivo/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/ddtrace-1.11.0/lib/datadog/tracing/trace_operation.rb:1:in  `require_relative'
```
@github-actions github-actions bot added integrations Involves tracing integrations tracing labels May 1, 2023
@@ -2,7 +2,7 @@

# typed: ignore

require_relative 'patcher'
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this was just requiring itself

@mscrivo mscrivo marked this pull request as ready for review May 1, 2023 21:06
@mscrivo mscrivo requested a review from a team May 1, 2023 21:06
Copy link
Member

@marcotc marcotc left a comment

Choose a reason for hiding this comment

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

Thank you, @mscrivo!

@marcotc marcotc merged commit 99997b7 into DataDog:master May 5, 2023
40 of 41 checks passed
@github-actions github-actions bot added this to the 1.12.0 milestone May 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integrations Involves tracing integrations tracing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants