appsignal-sourcemap 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7d2fe58d1cb99d73781c8cd4c78f96521fc579a2ad65c3a22b93d514db32db26
+  data.tar.gz: b8e192b02d922890abb3b0d50994aa9ee4a9e26445d50b4beaf89310c6aef8b2
+SHA512:
+  metadata.gz: fba417e39238ebcd339d60cf892b654bd71952bde0a76ab81b22e32ab5d98f3a48e6640422d7e16ed1442d9fca7aae06fdfcbddcbdfb80d97d05edf85796093c
+  data.tar.gz: fd9d1a66896f5880af43c5948b52f25aad637f03934db008b7754481de2075da5fa7c32cc72d78a21f4eec7dfd45894d937d562b2227977886dccdc3d45375da

data/README.md

@@ -0,0 +1,30 @@
+# Appsignal Sourcemaps
+This ruby gem uploads (private) sourcemaps to Appsignal using the [Sourcemaps API](https://docs.appsignal.com/api/sourcemaps.html).
+
+## Installation
+To start using this gem, add it to the `Gemfile` of your application:
+```ruby
+source 'https://rubygems.pkg.github.com/drieam' do
+  gem 'appsignal-sourcemap'
+end
+```
+After running `bundle install` you should enable the gem by adding `upload_sourcemaps: true` to your `config/appsignal.yml` file:
+
+```yaml
+default:
+  upload_sourcemaps: true
+```
+
+Also ensure that your `Rails.application.config.asset_host` is setup correctly since that is used to define the full URL of the assets.
+The gem then uploads the sourcemaps after the `assets:precompile` rake task. 
+It searches for all `.map` files within the `Rails.public_path` directory.
+
+### Heroku
+When building on heroku, make sure you set the revision based on the `SOURCE_VERSION` environment variable. This variable is set during the build phase and will be equal to the `HEROKU_SLUG_COMMIT` revision on runtime. Note that you should have [heroku dyno metadata](https://devcenter.heroku.com/articles/dyno-metadata) enabled.
+```yaml
+default:
+  revision: "<%= ENV['SOURCE_VERSION'] || ENV.fetch('HEROKU_SLUG_COMMIT', 'unknown') %>"
+```
+
+## Publishing a new version
+The [publish workflow](.github/workflows/publish.yml) listens to a new release in GitHub. 

data/lib/appsignal/sourcemap/hook.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "appsignal/hooks"
+
+module Appsignal
+  module Sourcemap
+    class SourcemapHook < Appsignal::Hooks::Hook
+      register :sourcemap
+
+      def dependencies_present?
+        defined?(::Rails) &&
+          defined?(::Rake::Task) &&
+          Rake::Task.task_defined?("assets:precompile") &&
+          Appsignal.config &&
+          Appsignal.config[:upload_sourcemaps]
+      end
+
+      def install
+        require "appsignal/sourcemap/supervisor"
+
+        Rake::Task["assets:precompile"].enhance do
+          Appsignal::Sourcemap::Supervisor.start
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/sourcemap/supervisor.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "parallel"
+require "appsignal/sourcemap/uploader"
+
+module Appsignal
+  module Sourcemap
+    class Supervisor
+      PARALLEL_THREADS = 10
+
+      def self.start
+        new.start
+      end
+
+      def start
+        return if invalid_preconditions
+
+        Rails.logger.info("Starting sourcemaps upload")
+
+        Parallel.each(source_map_paths, in_threads: PARALLEL_THREADS) do |source_map_path|
+          Uploader.upload(source_map_path)
+        end
+
+        Rails.logger.info("Finished sourcemaps upload")
+      end
+
+      private
+
+      def invalid_preconditions
+        unless Appsignal.config.valid?
+          return Rails.logger.error("Skipping sourcemaps upload since Appsignal config is invalid")
+        end
+        if asset_host.blank?
+          return Rails.logger.error("Skipping sourcemaps upload since Rails asset_host is not set")
+        end
+        return Rails.logger.info("Skipping sourcemaps upload since no javascript maps are found") if source_map_paths.empty?
+
+        false
+      end
+
+      def asset_host
+        Rails.application.config.asset_host
+      end
+
+      def source_map_paths
+        Dir.glob("**/*.map", base: Rails.public_path)
+      end
+    end
+  end
+end

data/lib/appsignal/sourcemap/uploader.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Appsignal
+  module Sourcemap
+    class Uploader
+      UPLOAD_URI = URI("https://appsignal.com/api/sourcemaps")
+
+      def self.upload(sourcemap_path)
+        new(sourcemap_path).upload
+      end
+
+      def initialize(sourcemap_path)
+        @sourcemap_path = sourcemap_path
+      end
+
+      def upload
+        Rails.logger.debug("Starting sourcemap upload '#{@sourcemap_path}' with parameters: #{request_form_data}")
+
+        response = Net::HTTP.start(UPLOAD_URI.hostname, UPLOAD_URI.port, use_ssl: true) do |http|
+          http.request(request)
+        end
+
+        if response.is_a?(Net::HTTPSuccess)
+          Rails.logger.debug("Finished sourcemap upload '#{@sourcemap_path}'")
+          File.delete(sourcemap_full_path)
+          return
+        end
+
+        Rails.logger.error <<~MESSAGE
+          Uploading sourcemap #{@sourcemap_path} failed with message '#{response.message}'.
+            Response: #{response.body}
+        MESSAGE
+      end
+
+      private
+
+      def sourcemap_full_path
+        Rails.public_path.join(@sourcemap_path)
+      end
+
+      def request
+        Net::HTTP::Post.new(UPLOAD_URI).tap do |request|
+          request.set_form request_form_data, "multipart/form-data"
+        end
+      end
+
+      def request_form_data
+        [
+          ["push_api_key", Appsignal.config[:push_api_key]],
+          ["app_name", Appsignal.config[:name]],
+          ["revision", Appsignal.config[:revision]],
+          ["environment", Appsignal.config.env],
+          ["name[]", source_url],
+          ["file", sourcemap_content]
+        ]
+      end
+
+      def sourcemap_content
+        File.open(Rails.public_path.join(@sourcemap_path))
+      end
+
+      def source_url
+        "#{asset_host}/#{js_path}"
+      end
+
+      def js_path
+        @sourcemap_path.delete_suffix(".map")
+      end
+
+      def asset_host
+        Rails.application.config.asset_host
+      end
+    end
+  end
+end

data/lib/appsignal/sourcemap/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Appsignal
+  module Sourcemap
+    VERSION = "1.2.0"
+  end
+end

data/lib/appsignal-sourcemap.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "appsignal/sourcemap/hook"

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: appsignal-sourcemap
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Drieam
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: appsignal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- dev@drieam.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/appsignal-sourcemap.rb
+- lib/appsignal/sourcemap/hook.rb
+- lib/appsignal/sourcemap/supervisor.rb
+- lib/appsignal/sourcemap/uploader.rb
+- lib/appsignal/sourcemap/version.rb
+homepage: https://github.com/drieam/appsignal-sourcemap
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Upload private sourcemaps to appsignal
+test_files: []