libddprof 0.2.0.beta2 → 0.5.0.1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab2d397b008650be1995c56f28fcf085e355fa4609c91669027f592715c04419
-  data.tar.gz: 11eb276ac1dc89cbf9d4e11fa618104f0307016a5010463ece61454a2cdac565
+  metadata.gz: f01692aa38a65d01c888aa33c8d49ae4dabf4344402e4c7efed79e3804fb3073
+  data.tar.gz: 52e7f4818b2a1cf39a08bd7fbe51208c7c20649fd2978b7b1ad4685073324caf
 SHA512:
-  metadata.gz: 8b4a4aa558f57d4b4ebf9002e93619e076b81b0bfed62eb149faf0d10c39c20bdde5b13e53218558a9213c8f4ca6928d45fa7a9683581e0a13386f64528e0c68
-  data.tar.gz: 0f4ec30dcf6401f5e55e7297162a17c36ab83ec47f70f91a8c55ce6414b80ad021f04f8d0434b277c6dc6f3dc0c5124977b8dc1e78910dc7c7a64e80e634415a
+  metadata.gz: 014be64f975e44baa87bb2766d3e2ad9ed5528f375aec84908e49daee883f9988f08530066c5487cf0d66feca901c58ae8683837e392e255ad8deabdfc6a0300
+  data.tar.gz: 83c1c491b99cf6c764405555c4d251be478e46f02d9147cecafd9bfb674f3debfaf4d4ca9c0976f902a091c037c177faaa452ef81675114feaf5024f195d0031

data/lib/libddprof/version.rb

@@ -2,8 +2,16 @@
 
 module Libddprof
   # Current libddprof version
-  LIB_VERSION = "0.2.0"
+  LIB_VERSION = "0.5.0"
 
-  # This is the Ruby gem version -- often it will match LIB_VERSION, but sometimes it may not
-  VERSION = "#{LIB_VERSION}.beta2"
+  GEM_MAJOR_VERSION = "1"
+  GEM_MINOR_VERSION = "0"
+  GEM_PRERELEASE_VERSION = ".beta1" # remember to include dot prefix, if needed!
+  private_constant :GEM_MAJOR_VERSION, :GEM_MINOR_VERSION, :GEM_PRERELEASE_VERSION
+
+  # The gem version scheme is lib_version.gem_major.gem_minor[.prerelease].
+  # This allows a version constraint such as ~> 0.2.0.1.0 in the consumer (ddtrace), in essence pinning the libddprof to
+  # a specific version like = 0.2.0, but still allow a) introduction of a gem-level breaking change by bumping gem_major
+  # and b) allow to push automatically picked up bugfixes by bumping gem_minor.
+  VERSION = "#{LIB_VERSION}.#{GEM_MAJOR_VERSION}.#{GEM_MINOR_VERSION}#{GEM_PRERELEASE_VERSION}"
 end

data/lib/libddprof.rb

@@ -3,21 +3,22 @@
 require_relative "libddprof/version"
 
 module Libddprof
-  # Is this a no-op libddprof release without binaries?
-  def self.no_binaries?
-    available_binaries.empty?
+  # Does this libddprof release include any binaries?
+  def self.binaries?
+    available_binaries.any?
   end
 
+  # This should only be used for debugging/logging
   def self.available_binaries
-    File.directory?(vendor_directory) ? Dir.children(vendor_directory) : []
+    File.directory?(vendor_directory) ? (Dir.entries(vendor_directory) - [".", ".."]) : []
   end
 
-  def self.pkgconfig_folder
+  def self.pkgconfig_folder(pkgconfig_file_name = "ddprof_ffi_with_rpath.pc")
     current_platform = Gem::Platform.local.to_s
 
     return unless available_binaries.include?(current_platform)
 
-    pkgconfig_file = Dir.glob("#{vendor_directory}/#{current_platform}/**/ddprof_ffi.pc").first
+    pkgconfig_file = Dir.glob("#{vendor_directory}/#{current_platform}/**/#{pkgconfig_file_name}").first
 
     return unless pkgconfig_file
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libddprof
 version: !ruby/object:Gem::Version
-  version: 0.2.0.beta2
+  version: 0.5.0.1.0.beta1
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-02 00:00:00.000000000 Z
+date: 2022-03-18 00:00:00.000000000 Z
 dependencies: []
 description: libddprof contains implementation bits used by Datadog's ddtrace gem
   as part of its Continuous Profiler feature.
@@ -18,12 +18,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".standard.yml"
-- README.md
-- Rakefile
-- docker-compose.yml
-- gems.rb
 - lib/libddprof.rb
 - lib/libddprof/version.rb
 homepage: https://docs.datadoghq.com/tracing/profiler/
@@ -49,7 +43,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Library of common code used by Datadog Continuous Profiler for Ruby

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.standard.yml

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

data/README.md

@@ -1,29 +0,0 @@
-# libddprof Ruby gem
-
-`libddprof` provides a shared library containing common code used in the implementation of Datadog's
-[Continuous Profilers](https://docs.datadoghq.com/tracing/profiler/).
-
-**NOTE**: If you're building a new profiler or want to contribute to Datadog's existing profilers, you've come to the
-right place!
-Otherwise, this is possibly not the droid you were looking for.
-
-## Development
-
-Run `bundle exec rake` to run the tests and the style autofixer.
-You can also run `bundle exec pry` for an interactive prompt that will allow you to experiment.
-
-## Releasing a new version to rubygems.org
-
-Note: No Ruby needed to run this! It all runs inside docker :)
-
-1. [ ] Locate the new libddprof release on GitHub: <https://github.com/DataDog/libddprof/releases>
-2. [ ] Update the `LIB_GITHUB_RELEASES` section of the <Rakefile> with the new version
-3. [ ] Update the <lib/libddprof/version.rb> file with the `LIB_VERSION` and `VERSION` to use
-4. [ ] Commit change, open PR, get it merged
-5. [ ] Release by running `docker-compose run push_to_rubygems`.
-    (When asked for rubygems credentials, check your local friendly 1Password.)
-6. [ ] Verify that release shows up correctly on: <https://rubygems.org/gems/libddprof>
-
-## Contributing
-
-See <../CONTRIBUTING.md>.

data/Rakefile

@@ -1,149 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "standard/rake" unless RUBY_VERSION < "2.5"
-
-require "fileutils"
-require "http"
-require "pry"
-require "rubygems/package"
-
-RSpec::Core::RakeTask.new(:spec)
-
-LIB_GITHUB_RELEASES = {
-  "0.2.0" => [
-    {
-      file: "libddprof-x86_64-unknown-linux-gnu.tar.gz",
-      sha256: "cba0f24074d44781d7252b912faff50d330957e84a8f40a172a8138e81001f27",
-      ruby_platform: "x86_64-linux"
-    },
-    {
-      file: "libddprof-x86_64-alpine-linux-musl.tar.gz",
-      sha256: "d519a6241d78260522624b8e79e98502510f11d5d9551f5f80fc1134e95fa146",
-      ruby_platform: "x86_64-linux-musl"
-    }
-  ]
-  # Add more versions here
-}
-
-task default: [
-  :spec,
-  (:'standard:fix' unless RUBY_VERSION < "2.5")
-].compact
-
-desc "Download lib release from github"
-task :fetch do
-  Helpers.each_github_release_variant do |file:, sha256:, target_directory:, target_file:, **_|
-    target_url = "https://github.com/DataDog/libddprof/releases/download/v#{Libddprof::LIB_VERSION}/#{file}"
-
-    if File.exist?(target_file)
-      if Digest::SHA256.hexdigest(File.read(target_file)) == sha256
-        puts "Found #{target_file} matching the expected sha256, skipping download"
-        next
-      else
-        puts "Found #{target_file} BUT IT DID NOT MATCH THE EXPECTED sha256, skipping download"
-      end
-    end
-
-    puts "Going to download #{target_url} into #{target_file}"
-
-    File.open(target_file, "wb") do |file|
-      HTTP.follow.get(target_url).body.each { |chunk| file.write(chunk) }
-    end
-
-    if Digest::SHA256.hexdigest(File.read(target_file)) == sha256
-      puts "Success!"
-    else
-      raise "Downloaded file is corrupt, does not match expected sha256"
-    end
-  end
-end
-
-desc "Extract lib downloaded releases"
-task extract: [:fetch] do
-  Helpers.each_github_release_variant do |target_directory:, target_file:, **_|
-    puts "Extracting #{target_file}"
-    File.open(target_file, "rb") do |file|
-      Gem::Package.new("").extract_tar_gz(file, target_directory)
-    end
-  end
-end
-
-desc "Package lib downloaded releases as gems"
-task package: [:spec, :'standard:fix', :extract] do
-  gemspec = eval(File.read("libddprof.gemspec"), nil, "libddprof.gemspec") # standard:disable Security/Eval
-  FileUtils.mkdir_p("pkg")
-
-  Helpers.package_without_binaries(gemspec)
-  Helpers.package_linux_x86_64(gemspec)
-end
-
-desc "Release all packaged gems"
-task push_to_rubygems: [
-  :package,
-  :'release:guard_clean'
-] do
-  system("gem signout") # make sure there are no existing credentials in use
-
-  system("gem push pkg/libddprof-#{Libddprof::VERSION}.gem")
-  system("gem push pkg/libddprof-#{Libddprof::VERSION}-x86_64-linux.gem")
-
-  system("gem signout") # leave no credentials behind
-end
-
-module Helpers
-  def self.each_github_release_variant(version: Libddprof::LIB_VERSION)
-    LIB_GITHUB_RELEASES.fetch(version).each do |variant|
-      file = variant.fetch(:file)
-      sha256 = variant.fetch(:sha256)
-      ruby_platform = variant.fetch(:ruby_platform)
-
-      # These two are so common that we just centralize them here
-      target_directory = "vendor/libddprof-#{version}/#{ruby_platform}"
-      target_file = "#{target_directory}/#{file}"
-
-      FileUtils.mkdir_p(target_directory)
-
-      yield(file: file, sha256: sha256, ruby_platform: ruby_platform, target_directory: target_directory, target_file: target_file)
-    end
-  end
-
-  def self.package_without_binaries(gemspec)
-    target_gemspec = gemspec.dup
-
-    puts "Building a variant without binaries including:"
-    pp target_gemspec.files
-
-    package = Gem::Package.build(target_gemspec)
-    FileUtils.mv(package, "pkg")
-    puts("-" * 80)
-  end
-
-  def self.package_linux_x86_64(gemspec)
-    # We include both glibc and musl variants in the same binary gem to avoid the issues
-    # documented in https://github.com/rubygems/rubygems/issues/3174
-    target_gemspec = gemspec.dup
-    target_gemspec.files += files_for("x86_64-linux", "x86_64-linux-musl")
-    target_gemspec.platform = "x86_64-linux"
-
-    puts "Building for x86_64-linux including: (this can take a while)"
-    pp target_gemspec.files
-
-    package = Gem::Package.build(target_gemspec)
-    FileUtils.mv(package, "pkg")
-    puts("-" * 80)
-  end
-
-  def self.files_for(*included_platforms, version: Libddprof::LIB_VERSION)
-    files = []
-
-    each_github_release_variant(version: version) do |ruby_platform:, target_directory:, target_file:, **_|
-      next unless included_platforms.include?(ruby_platform)
-
-      files += Dir.glob("#{target_directory}/**/*").select { |path| File.file?(path) } - [target_file]
-    end
-
-    files
-  end
-end

data/docker-compose.yml

@@ -1,14 +0,0 @@
-version: '3.2'
-services:
-  push_to_rubygems:
-    image: ruby:3.1
-    platform: linux/x86_64
-    stdin_open: true
-    tty: true
-    command: bash -c 'cd /libddprof/ruby && bundle install && bundle exec rake push_to_rubygems'
-    volumes:
-      - ..:/libddprof
-      - bundle-3.1:/usr/local/bundle
-
-volumes:
-  bundle-3.1:

data/gems.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in libddprof.gemspec
-gemspec
-
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.10"
-gem "standard", "~> 1.3" unless RUBY_VERSION < "2.5"
-gem "http", "~> 5.0"
-gem "pry"
-gem "pry-byebug"