Merge pull request #3801 from DataDog/ivoanjo/profiler-adopt-standard

[NO-TICKET] RFC: Adopt standardrb for Profiler

Author: ivoanjo

.circleci/config.yml

@@ -159,6 +159,14 @@ step_rubocop: &step_rubocop
     # The workaround is to use `cpu.shares / 1024`:
     # https://discuss.circleci.com/t/environment-variable-set-to-the-number-of-available-cpus/32670/4
     command: PARALLEL_PROCESSOR_COUNT=$((`cat /sys/fs/cgroup/cpu/cpu.shares` / 1024)) bundle exec rake rubocop
+step_standardrb: &step_standardrb
+  run:
+    name: Delint with Standardrb
+    # There's no straightforward way to get the number of available processors & CPU threads in CircleCI.
+    # Currently it always return 18 physical processors and 36 threads, regardless of executor size.
+    # The workaround is to use `cpu.shares / 1024`:
+    # https://discuss.circleci.com/t/environment-variable-set-to-the-number-of-available-cpus/32670/4
+    command: PARALLEL_PROCESSOR_COUNT=$((`cat /sys/fs/cgroup/cpu/cpu.shares` / 1024)) bundle exec rake standard
 step_appraisal_install: &step_appraisal_install
   run:
     name: Install Appraisal gems
@@ -377,6 +385,7 @@ orbs:
               keys:
                 - bundle-{{ .Environment.CIRCLE_CACHE_VERSION }}-{{ checksum ".circleci/images/primary/binary_version" }}-<<parameters.ruby_version>>-{{ checksum "lib/datadog/version.rb" }}-{{ .Branch }}-{{ checksum ".circleci/bundle_checksum" }}
           - *step_rubocop
+          - *step_standardrb
       coverage:
         <<: *test_job_default
         steps:

.git-blame-ignore-revs

@@ -3,3 +3,20 @@
 372f7c20696e30f319cf20622758f7f0ef585875
 # First multi-line argument has line break
 6e8ae58d320d6a48f6c1d21db894d414bdf140b2
+# Profiling migration to standardrb
+ac6824dce79859fd8de45f3f0f6bf7a8924af9ec
+41851227391f27f0c1d4dd3c1c9ee6b472eca868
+1e575a7fe35f7ce3d4527d794c7a21e70b5da75b
+6af85872506508d1530bdd2fb27c1f892b399a71
+871794d8316e41f81a34137115f23f1f4e968436
+5a05ec39937d3166efaf735aec3dcb57fd864cb3
+4acf1e5cbf88c51b69025357ce3effc0a3ea3d9c
+dd4db277900ffe6826f5bd45f475340f7978fc38
+b16a6530321eae11f8456981892c36f3847026e6
+cc84721645bc75fc76a62bc6228c8b730ed3a30f
+74542fc1aab3b58606b91a89e4268d2fbb340a1d
+f89961150051276ea21bbca3fa00bda9b3cf4f1d
+9e7648e1bcce370ff7cf6aeaa1c32bf9ecacf0a6
+6924556fc9e38c244e2ff3d429d581819f275ee9
+aba860197ce4f708e917e27323884d8efe3692ca
+464dd7177b72d6fe2c7f6e1aba0e4a6d3826f0d9

.rubocop.yml

@@ -27,6 +27,22 @@ AllCops:
   NewCops: disable # Don't allow new cops to be enabled implicitly.
   SuggestExtensions: false # Stop pushing suggestions constantly.
 
+# Profiling has migrated to standard and is not managed by rubocop:
+Style:
+  Exclude:
+    - 'lib/datadog/profiling*'
+    - 'lib/datadog/profiling/**/*'
+    - 'spec/datadog/profiling*'
+    - 'spec/datadog/profiling/**/*'
+    - 'ext/datadog_profiling_*/**/*'
+Layout:
+  Exclude:
+    - 'lib/datadog/profiling/*'
+    - 'lib/datadog/profiling/**/**'
+    - 'spec/datadog/profiling/*'
+    - 'spec/datadog/profiling/**/**'
+    - 'ext/datadog_profiling_*/**/*'
+
 Layout/LineLength:
   Max: 124
   Exclude:

.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.5

.standard_todo.yml

@@ -0,0 +1,185 @@
+# This file is used to ignore specific rules for specific files or directories.
+---
+ignore:
+
+# After quite some discussion on the team, we decided to make an exception to the
+# "standard-isn't-supposed-to-be-configured" thing to allow for trailing comma, see
+# https://github.com/standardrb/standard/issues/611 for a discussion
+- '**/**':
+  - Style/TrailingCommaInArguments
+  - Style/TrailingCommaInArrayLiteral
+  - Style/TrailingCommaInHashLiteral
+
+# This disables standardrb for the rest of dd-trace-rb (other than profiling)
+- .pryrc
+- .simplecov
+- Appraisals
+- datadog.gemspec
+- Gemfile
+- Rakefile
+- Steepfile
+- appraisal/**/**
+- benchmarks/**/**
+- gemfiles/**/**
+- integration/**/**
+- lib-injection/**/**
+- ext/libdatadog_extconf_helpers.rb
+- ext/libdatadog_api/**/**
+- lib/*
+- lib/datadog/*
+- lib/datadog/appsec/**/**
+- lib/datadog/core/**/**
+- lib/datadog/kit/**/**
+- lib/datadog/opentelemetry/**/**
+- lib/datadog/tracing/**/**
+- spec/*
+- spec/datadog/*
+- spec/datadog/appsec/**/**
+- spec/datadog/benchmark/**/**
+- spec/datadog/core/**/**
+- spec/datadog/kit/**/**
+- spec/datadog/tracing/**/**
+- spec/support/**/**
+- tasks/**/**
+- yard/**/**
+
+# These profiling ignores are ALL going to be fixed in separate PRs
+- lib/datadog/profiling/collectors/code_provenance.rb:
+  - Style/StringLiterals
+  - Layout/SpaceInsideHashLiteralBraces
+- lib/datadog/profiling/collectors/cpu_and_wall_time_worker.rb:
+  - Style/StringLiterals
+  - Style/RedundantBegin
+- lib/datadog/profiling/collectors/idle_sampling_helper.rb:
+  - Style/RedundantBegin
+  - Style/StringLiterals
+- lib/datadog/profiling/collectors/info.rb:
+  - Style/StringLiterals
+- lib/datadog/profiling/component.rb:
+  - Layout/SpaceInsideHashLiteralBraces
+  - Style/StringLiterals
+- lib/datadog/profiling/crashtracker.rb:
+  - Style/StringLiterals
+  - Style/RedundantBegin
+- lib/datadog/profiling/exporter.rb:
+  - Style/StringLiterals
+- lib/datadog/profiling/ext.rb:
+  - Style/StringLiterals
+- lib/datadog/profiling/ext/dir_monkey_patches.rb:
+  - Style/StringLiterals
+- lib/datadog/profiling/ext/forking.rb:
+  - Style/StringLiterals
+- lib/datadog/profiling/flush.rb:
+  - Style/StringLiterals
+- lib/datadog/profiling/http_transport.rb:
+  - Style/StringLiterals
+- lib/datadog/profiling/load_native_extension.rb:
+  - Style/StringLiterals
+- lib/datadog/profiling/preload.rb:
+  - Style/StringLiterals
+- lib/datadog/profiling/profiler.rb:
+  - Style/StringLiterals
+- lib/datadog/profiling/scheduler.rb:
+  - Style/StringLiterals
+  - Style/RedundantBegin
+- lib/datadog/profiling/tag_builder.rb:
+  - Style/StringLiterals
+- lib/datadog/profiling/tasks/exec.rb:
+  - Style/StringLiterals
+- lib/datadog/profiling/tasks/setup.rb:
+  - Style/StringLiterals
+  - Style/RedundantBegin
+- lib/datadog/profiling.rb:
+  - Style/StringLiterals
+  - Style/RedundantBegin
+- spec/datadog/profiling/collectors/code_provenance_spec.rb:
+  - Style/StringLiterals
+- spec/datadog/profiling/collectors/cpu_and_wall_time_worker_spec.rb:
+  - Style/StringLiterals
+  - Layout/SpaceInsideHashLiteralBraces
+  - Style/QuotedSymbols
+  - Style/RedundantBegin
+- spec/datadog/profiling/collectors/discrete_dynamic_sampler_spec.rb:
+  - Style/StringLiterals
+- spec/datadog/profiling/collectors/dynamic_sampling_rate_spec.rb:
+  - Style/StringLiterals
+- spec/datadog/profiling/collectors/idle_sampling_helper_spec.rb:
+  - Style/StringLiterals
+- spec/datadog/profiling/collectors/info_spec.rb:
+  - Style/StringLiterals
+  - Layout/SpaceInsideHashLiteralBraces
+- spec/datadog/profiling/collectors/stack_spec.rb:
+  - Style/StringLiterals
+  - Layout/SpaceInsideHashLiteralBraces
+- spec/datadog/profiling/collectors/thread_context_spec.rb:
+  - Style/StringLiterals
+  - Style/QuotedSymbols
+  - Style/RedundantBegin
+  - Layout/SpaceInsideHashLiteralBraces
+- spec/datadog/profiling/component_spec.rb:
+  - Style/StringLiterals
+  - Layout/SpaceInsideHashLiteralBraces
+- spec/datadog/profiling/crashtracker_spec.rb:
+  - Style/StringLiterals
+  - Layout/SpaceInsideHashLiteralBraces
+  - Style/QuotedSymbols
+- spec/datadog/profiling/exporter_spec.rb:
+  - Style/StringLiterals
+  - Layout/SpaceInsideHashLiteralBraces
+- spec/datadog/profiling/ext/dir_monkey_patches_spec.rb:
+  - Style/StringLiterals
+  - Style/RedundantBegin
+- spec/datadog/profiling/ext/forking_spec.rb:
+  - Style/StringLiterals
+- spec/datadog/profiling/flush_spec.rb:
+  - Style/StringLiterals
+  - Layout/SpaceInsideHashLiteralBraces
+- spec/datadog/profiling/http_transport_spec.rb:
+  - Style/StringLiterals
+  - Layout/SpaceInsideHashLiteralBraces
+  - Style/RedundantBegin
+- spec/datadog/profiling/load_native_extension_spec.rb:
+  - Style/StringLiterals
+- spec/datadog/profiling/native_extension_helpers_spec.rb:
+  - Style/StringLiterals
+- spec/datadog/profiling/native_extension_spec.rb:
+  - Style/StringLiterals
+- spec/datadog/profiling/pprof/pprof_pb.rb:
+  - Style/StringLiterals
+- spec/datadog/profiling/preload_spec.rb:
+  - Style/StringLiterals
+- spec/datadog/profiling/profiler_spec.rb:
+  - Style/StringLiterals
+- spec/datadog/profiling/scheduler_spec.rb:
+  - Style/StringLiterals
+  - Layout/SpaceInsideHashLiteralBraces
+- spec/datadog/profiling/spec_helper.rb:
+  - Style/StringLiterals
+  - Style/QuotedSymbols
+- spec/datadog/profiling/stack_recorder_spec.rb:
+  - Style/StringLiterals
+  - Layout/SpaceInsideHashLiteralBraces
+  - Style/QuotedSymbols
+  - Style/RedundantBegin
+- spec/datadog/profiling/tag_builder_spec.rb:
+  - Style/StringLiterals
+  - Layout/SpaceInsideHashLiteralBraces
+- spec/datadog/profiling/tasks/exec_spec.rb:
+  - Style/StringLiterals
+- spec/datadog/profiling/tasks/help_spec.rb:
+  - Style/StringLiterals
+- spec/datadog/profiling/tasks/setup_spec.rb:
+  - Style/StringLiterals
+- spec/datadog/profiling/validate_benchmarks_spec.rb:
+  - Style/StringLiterals
+- spec/datadog/profiling_spec.rb:
+  - Style/StringLiterals
+  - Style/RedundantBegin
+- ext/datadog_profiling_loader/extconf.rb:
+  - Style/StringLiterals
+- ext/datadog_profiling_native_extension/extconf.rb:
+  - Style/StringLiterals
+- ext/datadog_profiling_native_extension/native_extension_helpers.rb:
+  - Style/StringLiterals
+  - Layout/SpaceInsideHashLiteralBraces
+  - Style/RedundantBegin

Appraisals

@@ -16,6 +16,7 @@ REMOVED_GEMS = {
   :check => [
     'rbs',
     'steep',
+    'standard',
   ],
   :dev => [
     'ruby-lsp',

Gemfile

@@ -82,6 +82,7 @@ group :check do
     gem 'rbs', '~> 3.2.0', require: false
     gem 'steep', '~> 1.6.0', require: false
   end
+  gem 'standard', require: false
 end
 
 group :dev do

Rakefile

@@ -1,6 +1,7 @@
 require 'bundler/gem_tasks'
 require 'datadog/version'
 require 'rubocop/rake_task' if Gem.loaded_specs.key? 'rubocop'
+require 'standard/rake' if Gem.loaded_specs.key? 'standard'
 require 'rspec/core/rake_task'
 require 'rake/extensiontask'
 require 'yard'
@@ -421,7 +422,7 @@ namespace :native_dev do
 end
 
 desc 'Runs rubocop + main test suite'
-task default: ['rubocop', 'typecheck', 'spec:main']
+task default: ['rubocop', 'standard', 'typecheck', 'spec:main']
 
 desc 'Runs the default task in parallel'
-multitask fastdefault: ['rubocop', 'typecheck', 'spec:main']
+multitask fastdefault: ['rubocop', 'standard', 'typecheck', 'spec:main']

ext/datadog_profiling_native_extension/extconf.rb

@@ -6,7 +6,11 @@
 
 SKIPPED_REASON_FILE = "#{__dir__}/skipped_reason.txt".freeze
 # Not a problem if the file doesn't exist or we can't delete it
-File.delete(SKIPPED_REASON_FILE) rescue nil
+begin
+  File.delete(SKIPPED_REASON_FILE)
+rescue
+  nil
+end
 
 def skip_building_extension!(reason)
   fail_install_if_missing_extension =
@@ -67,7 +71,7 @@ def skip_building_extension!(reason)
 require 'mkmf'
 
 Logging.message("[datadog] Using compiler:\n")
-xsystem("#{CONFIG['CC']} -v")
+xsystem("#{CONFIG["CC"]} -v")
 Logging.message("[datadog] End of compiler information\n")
 
 # mkmf on modern Rubies actually has an append_cflags that does something similar
@@ -191,8 +195,8 @@ def add_compiler_flag(flag)
 $defs << '-DNO_THREAD_INVOKE_ARG' if RUBY_VERSION < '2.6'
 
 # If we got here, libdatadog is available and loaded
-ENV['PKG_CONFIG_PATH'] = "#{ENV['PKG_CONFIG_PATH']}:#{Libdatadog.pkgconfig_folder}"
-Logging.message("[datadog] PKG_CONFIG_PATH set to #{ENV['PKG_CONFIG_PATH'].inspect}\n")
+ENV['PKG_CONFIG_PATH'] = "#{ENV["PKG_CONFIG_PATH"]}:#{Libdatadog.pkgconfig_folder}"
+Logging.message("[datadog] PKG_CONFIG_PATH set to #{ENV["PKG_CONFIG_PATH"].inspect}\n")
 $stderr.puts("Using libdatadog #{Libdatadog::VERSION} from #{Libdatadog.pkgconfig_folder}")
 
 unless pkg_config('datadog_profiling_with_rpath')

ext/datadog_profiling_native_extension/native_extension_helpers.rb

@@ -232,7 +232,7 @@ def self.render_skipped_reason_file(reason:, suggested:)
             'platform variant.',
             "(Your platform: `#{Libdatadog.current_platform}`)",
             '(Available binaries:',
-            "`#{Libdatadog.available_binaries.join('`, `')}`)",
+            "`#{Libdatadog.available_binaries.join("`, `")}`)",
             suggested: CONTACT_SUPPORT,
           )