bugsnag_sourcemap_uploader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e3ee3d07e9ff42067679369032d166482470b4e291927413a08a8f389e8cb471
+  data.tar.gz: a39c50a2b02d82d2e39cb62e47fe8c6c14ad37dbfea251f1ab2a7c4c1c079c59
+SHA512:
+  metadata.gz: 2ae31e25fa1f4aacdf7072de250c2b166022c4182cc3dad68349255bdd57749ba788e4073b85f8fd8a0e990e5e9c0a0038f29d05b1ebd9db4d0a66d8d7a2423e
+  data.tar.gz: 89a4404a75a7c435edc91c5bfbc81b6fc3a319316c913d93c5c86f0db455e3c833c0ba5f0e1d10698c14711ee7f3fcd6a409375f27772df9a1b2ffd06a0be62a

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rubocop.yml

@@ -0,0 +1,16 @@
+Layout/LineLength:
+  Max: 120
+  AllowHeredoc: true
+  AllowURI: true
+  URISchemes:
+  - http
+  - https
+  IgnoredPatterns:
+  - '\A\s*(remote_)?test(_\w+)?\s.*(do|->)(\s|\Z)'
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+## TL;DR;
+
+Respect each other, be nice.

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+group :test do
+  gem 'mocha'
+end
+
+group :development do
+  gem 'rubocop'
+  gem 'yard'
+end

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    bugsnag_sourcemap_uploader (0.1.0)
+      concurrent-ruby (~> 1.1.4)
+      httparty (~> 0.17.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    concurrent-ruby (1.1.5)
+    httparty (0.17.3)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    jaro_winkler (1.5.4)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    minitest (5.14.0)
+    mocha (1.11.2)
+    multi_xml (0.6.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.1)
+    yard (0.9.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bugsnag_sourcemap_uploader!
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  mocha
+  rake (~> 10.0)
+  rubocop
+  yard
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Bernardo Araujo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# BugsnagSourcemapUploader
+
+Upload your sourcemaps to Bugsnag in parallel.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bugsnag_sourcemap_uploader'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install bugsnag_sourcemap_uploader
+
+## Usage
+
+```ruby
+BugsnagSourcemapUploader.upload(assets_metadata, bugsnag_api_key)
+```
+
+### Asset Metadata
+
+Any object that responds to the following methods:
+
+* #script_path
+* #source_map_path
+* #cdn_url
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bernardoamc/bugsnag_sourcemap_uploader.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the BugsnagSourcemapUploader project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bernardoamc/bugsnag_sourcemap_uploader/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bugsnag_sourcemap_uploader'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bugsnag_sourcemap_uploader.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bugsnag_sourcemap_uploader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bugsnag_sourcemap_uploader'
+  spec.version       = BugsnagSourcemapUploader::VERSION
+  spec.authors       = ['Bernardo Chaves']
+  spec.email         = ['bernardo.amc@gmail.com']
+
+  spec.summary       = 'Upload sourcemaps to Bugsnag in parallel.'
+  spec.homepage      = 'https://rubygems.org/gems/bugsnag_sourcemap_uploader'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'concurrent-ruby', '~> 1.1.4'
+  spec.add_dependency 'httparty', '~> 0.17.0'
+end

data/examples/webpacker_asset_repository.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module BugsnagSourcemapUploader
+  # Aggregates assets generated by Webpacker
+  class WebpackerAssetRepository
+    attr_reader :path
+
+    # @param path [Pathname] the path where assets can be found
+    # @return [WebpackerAssetRepository] the instance of this class
+    def initialize(path)
+      @path = path
+    end
+
+    # Aggregates every .js file in the path with its respective .js.map file
+    #
+    # @return [Array<AssetMetadata>] the list of aggregated JS and Sourcemap files.
+    def assets_metadata
+      scripts_by_prefix.each_with_object([]) do |(prefix, script), assets|
+        unless source_maps_by_prefix.key?(prefix)
+          Rails.logger.info("Found script without source map: #{script}")
+          next
+        end
+
+        assets << AssetMetadata.new(script, source_maps_by_prefix[prefix])
+      end
+    end
+
+    private
+
+    def scripts
+      @scripts ||= Dir.glob("#{path}/**/*.js")
+    end
+
+    def source_maps
+      @source_maps ||= Dir.glob("#{path}/**/*.js.map")
+    end
+
+    def scripts_by_prefix
+      @scripts_by_prefix ||= begin
+        scripts.each_with_object({}) do |script, prefixes|
+          match_data = script.match(/\A(.*)-[a-f0-9]{64}\.js\z/)
+          next if match_data.nil?
+
+          prefix = match_data[1]
+          prefixes[prefix] = script
+        end
+      end
+    end
+
+    def source_maps_by_prefix
+      @source_maps_by_prefix ||= begin
+        source_maps.each_with_object({}) do |source_map, prefixes|
+          match_data = source_map.match(/\A(.*)-[a-f0-9]{64}\.js\.map\z/)
+          next if match_data.nil?
+
+          prefix = match_data[1]
+          prefixes[prefix] = source_map
+        end
+      end
+    end
+
+    ##
+    # A Class with an instance that responds to methods required by BugsnagSourcemapUploader
+    class AssetMetadata
+      CDN_HOST_URL = 'https://cdn.sourcemap.com/bundles/'
+
+      attr_reader :script_path, :source_map_path
+
+      def initialize(script_path, source_map_path)
+        @script_path = script_path
+        @source_map_path = source_map_path
+      end
+
+      def script_name
+        @script_name ||= File.basename(script_path)
+      end
+
+      def cdn_url
+        @cdn_url ||= begin
+          Addressable::URI
+            .parse(CDN_HOST_URL)
+            .join("#{parent_dir}/")
+            .join(script_name)
+            .to_s
+        end
+      end
+
+      private
+
+      def parent_dir
+        File.dirname(script_path).split('/').last
+      end
+    end
+  end
+end

data/lib/bugsnag_sourcemap_uploader.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'bugsnag_sourcemap_uploader/version'
+require 'bugsnag_sourcemap_uploader/upload_task'
+require 'concurrent'
+
+##
+# BugsnagSourcemapUploader is a library to enable parallel sourcemap uploads to Bugsnag.
+module BugsnagSourcemapUploader
+  TASK_TIMEOUT_IN_SECONDS = 10 # Task timeout in seconds
+
+  # Upload sourcemaps to Bugsnag.
+  #
+  # @param assets_metadata [Array] object
+  #   Each item in this Array must be an object that responds to
+  #   `#script_path`, `#source_map_path` and `#cdn_url`.
+  # @param bugsnag_api_key [String] key
+  #   The Bugsnag API key.
+  # @param http_options [Hash] HTTP options
+  #   Options accepted by HTTParty.
+  #   Useful to set headers or logging details.
+  #
+  # @return [BugsnagSourcemapUploader::Result] The object with the results of our operation.
+  def self.upload(assets_metadata:, bugsnag_api_key:, http_options: {})
+    pool = Concurrent::ThreadPoolExecutor.new(
+      min_threads: 4,
+      max_threads: Concurrent.processor_count
+    )
+
+    futures = assets_metadata.map do |asset_metadata|
+      Concurrent::Promise.execute(executor: pool) do
+        UploadTask.new(
+          asset_metadata: asset_metadata,
+          bugsnag_api_key: bugsnag_api_key
+        ).run(http_options)
+      end
+    end
+
+    responses = futures.map do |future|
+      future.value(TASK_TIMEOUT_IN_SECONDS)
+    end
+
+    Result.new(responses)
+  end
+
+  ##
+  # Represents the result of the BugsnagSourcemapUploader.upload operation
+  class Result
+    attr_reader :tasks_results
+
+    def initialize(tasks_results)
+      @tasks_results = tasks_results
+    end
+
+    # Answers whether every upload task was successful or not.
+    #
+    # @return [Boolean] value.
+    def success?
+      @success ||= @tasks_results.all?(&:success?)
+    end
+
+    # Answers whether we had failures among upload tasks.
+    #
+    # @return [Boolean] value.
+    def failure?
+      !success?
+    end
+
+    # Filters upload tasks that were successful.
+    #
+    # @return [Array] The list of tasks that were succesful.
+    def successful_tasks
+      @successful_tasks ||= @tasks_results.select(&:success?)
+    end
+
+    # Filters upload tasks that failed with HTTP errors. This includes HTTP failures
+    # or execution errors.
+    #
+    # @return [Array] The list of tasks that failed.
+    def failed_tasks
+      @failed_tasks ||= @tasks_results.select(&:failure?)
+    end
+
+    # Filters upload tasks that had execution errors.
+    #
+    # @return [Array] The list of tasks with execution errors.
+    def execution_error_tasks
+      @execution_error_tasks ||= failed_tasks.select(&:execution_error?)
+    end
+  end
+end

data/lib/bugsnag_sourcemap_uploader/upload_task.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+module BugsnagSourcemapUploader
+  # The unit of work to send a sourcemap with its associated minified javascript
+  # file to Bugsnag.
+  class UploadTask
+    UPLOAD_URL = 'https://upload.bugsnag.com/' # Bugsnag upload URL
+
+    def initialize(asset_metadata:, bugsnag_api_key:)
+      @asset_metadata = asset_metadata
+      @bugsnag_api_key = bugsnag_api_key
+    end
+
+    def run(http_options: {})
+      body_payload = {
+        'apiKey' => @bugsnag_api_key,
+        'minifiedUrl' => @asset_metadata.cdn_url,
+        'sourceMap' => source_map_contents,
+        'minifiedFile' => script_contents,
+        'overwrite' => true
+      }
+
+      payload = http_options.merge(body: body_payload)
+
+      Result.new(
+        @asset_metadata,
+        HTTParty.post(UPLOAD_URL, payload)
+      )
+    rescue StandardError => e
+      ExecutionErrorResult.new(@asset_metadata, e)
+    end
+
+    private
+
+    def source_map_contents
+      File.open(@asset_metadata.source_map_path)
+    end
+
+    def script_contents
+      File.open(@asset_metadata.script_path)
+    end
+
+    # Represents the result of the UploadTask#upload method.
+    class Result
+      HTTP_TIMEOUT_CODE = 408 # HTTP status code for timeouts
+      HTTP_TOO_MANY_REQUESTS_CODE = 429 # HTTP status code for too many requests
+
+      attr_reader :asset_metadata
+
+      def initialize(asset_metadata, http_response)
+        @asset_metadata = asset_metadata
+        @http_response = http_response
+      end
+
+      def reason
+        @http_response.body
+      end
+
+      def status_code
+        @http_response.code
+      end
+
+      def success?
+        @http_response.success?
+      end
+
+      def failure?
+        !success?
+      end
+
+      def execution_error?
+        false
+      end
+
+      def retryable?
+        status_code < 400 ||
+          status_code > 499 ||
+          [HTTP_TIMEOUT_CODE, HTTP_TOO_MANY_REQUESTS_CODE].include?(status_code)
+      end
+    end
+
+    # Represents the result of the UploadTask#upload method when an exception occurred.
+    class ExecutionErrorResult
+      attr_reader :asset_metadata, :exception
+
+      def initialize(asset_metadata, exception)
+        @asset_metadata = asset_metadata
+        @exception = exception
+      end
+
+      def status_code
+        nil
+      end
+
+      def reason
+        @exception.message
+      end
+
+      def success?
+        false
+      end
+
+      def failure?
+        true
+      end
+
+      def execution_error?
+        true
+      end
+
+      def retryable?
+        true
+      end
+    end
+  end
+end

data/lib/bugsnag_sourcemap_uploader/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BugsnagSourcemapUploader
+  VERSION = '0.1.0' # The current gem version
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: bugsnag_sourcemap_uploader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bernardo Chaves
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+description: 
+email:
+- bernardo.amc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/setup
+- bugsnag_sourcemap_uploader.gemspec
+- examples/webpacker_asset_repository.rb
+- lib/bugsnag_sourcemap_uploader.rb
+- lib/bugsnag_sourcemap_uploader/upload_task.rb
+- lib/bugsnag_sourcemap_uploader/version.rb
+homepage: https://rubygems.org/gems/bugsnag_sourcemap_uploader
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Upload sourcemaps to Bugsnag in parallel.
+test_files: []