fastlane-plugin-bugsnag_sourcemaps_upload 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 181d0032cede24be37b56dfbb7974fe7ed61e66e9965492475e7f86cef2e4639
-  data.tar.gz: c359ea182ae35b65558486b9f019b0bdb304e5c6213034cc6e18673c956f452e
+  metadata.gz: 0a6aa2675005a171fe06f6667b361df3f9f73f49cf1dd63b7697c77da1e2d019
+  data.tar.gz: 82caee4e3f05b789b541b121330504355828e985ce6677ff15142e40babf45f7
 SHA512:
-  metadata.gz: 957b8efdb468c7cd6cbca70206e7e32ef021cdd8901fb12d34fb08098bf9b1a6da0a1e0f9f43cab39cfbf4971a7bb118206d2292e8c04ab8c8d0d8e4396dd0cb
-  data.tar.gz: d85c0a29bfae11fc0ff8d81ef281781e91a2c0ef8e46dab8718837a123ae28bb4eb1268ef3ad8aba41c4aa0019e74bfab1047df4eca0a60255e0ac37b7748e73
+  metadata.gz: f3738e4d74c96ac918a48a109f7c3ff19e78124d2ff6574cc4ec033e2030b05a3b7ec968ca49845573edb461bc149fff089528d1ab0fc2364f01b2f5272293ba
+  data.tar.gz: 53e3699c3e634f88e4c4dea6e739f8d503303eb8bce5ebcdb3bf24d79a566a88a913dcdad2258498f1af29f7273cc7b848c32aab39088436725af1c7d42c95d1

data/README.md

@@ -13,18 +13,53 @@ fastlane add_plugin bugsnag_sourcemaps_upload
 
 ## About bugsnag_sourcemaps_upload
 
-Helps to upload sourcemaps to Bugsnag
+Helps to generate and upload React Native sourcemaps to Bugsnag
 
 
-## Example
+### Example
 
-```
+```ruby
+# Generate and upload soucemaps
+bugsnag_sourcemaps_upload(
+  api_key: 'YOUR_BUGSNAG_API_KEY',
+  app_version: '1.0.0'
+)
+
+# Uploading Hermes generated soucemaps
 bugsnag_sourcemaps_upload(
   api_key: 'YOUR_BUGSNAG_API_KEY',
-  os: ['ios', 'android']
+  app_version: '1.0.0',
+  generate_sourcemaps: false,
+  platform: 'android',
+  sourcemaps_dir: 'android/app/build/generated',
+  sourcemap: 'sourcemaps/react/release/index.android.bundle.map',
+  bundle: 'assets/react/release/index.android.bundle'
 )
 ```
 
+### Available options
+
+| Option | Description | Environment variable | Default value |
+| - | - | - | - |
+| api_key* | API key | BUGSNAG_API_KEY |  |
+| app_version | Target app version | BUGSNAG_SOURCEMAPS_APP_VERSION |  |
+| code_bundle_id | CodePush bundle ID | BUGSNAG_SOURCEMAPS_CODE_BUNDLE |  |
+| platform | Target platform | BUGSNAG_SOURCEMAPS_PLATFORM | ios |
+| sourcemaps_dir | Sourcemaps directory | BUGSNAG_SOURCEMAPS_DIR | /tmp |
+| sourcemap | Override path to sourcemaps(relative path to sourcemaps_dir) | BUGSNAG_SOURCEMAPS_NAME | *platform*.bundle.map  |
+| bundle | Override path to minified file(relative path to sourcemaps_dir) | BUGSNAG_SOURCEMAPS_BUNDLE_NAME | *platform*.bundle |
+| minified_url | Override minified url| BUGSNAG_SOURCEMAPS_MINIFIED_URL | index.android.bundle *or* main.jsbundle  |
+| overwrite | Overwrite sourcemaps in Bugsnag | BUGSNAG_SOURCEMAPS_OVERWRITE | true |
+| strip | Strip root | BUGSNAG_SOURCEMAPS_STRIP_PROJECT_ROOT | true |
+| wildcard_prefix | Add wildcard prefix | BUGSNAG_SOURCEMAPS_WILDCARD_PREFIX | false |
+| generate_sourcemaps | Generate sourcemaps using react-native bundle | BUGSNAG_SOURCEMAPS_GENERATE | true |
+| upload_sources | Upload source files referenced by the source map | BUGSNAG_SOURCEMAPS_UPLOAD_SOURCES | true |
+| upload_modules | Upload dependency files referenced by the source map | BUGSNAG_SOURCEMAPS_UPLOAD_MODULES | false
+| entry_file | React-native app index file path | BUGSNAG_SOURCEMAPS_ENTRY_FILE | index.js |
+| endpoint | Bugsnag endpoint(when using Bugsnag On-premise) | BUGSNAG_SOURCEMAPS_ENDPOINT |  |
+
+\* - required
+
 ## Run tests for this plugin
 
 To run both the tests, and code style validation, run

data/lib/fastlane/plugin/bugsnag_sourcemaps_upload/actions/bugsnag_sourcemaps_upload_action.rb

@@ -5,18 +5,48 @@ module Fastlane
   module Actions
     class BugsnagSourcemapsUploadAction < Action
       def self.run(params)
-        params[:os].each do |os|
-          Helper::BugsnagSourcemapsUploadHelper.create_bundle(os)
-          Helper::BugsnagSourcemapsUploadHelper.upload_bundle(params[:api_key], os)
+        api_key = params[:api_key]
+        app_version = params[:app_version]
+        code_bundle_id = params[:code_bundle_id]
+        platform = params[:platform]
+        dir = params[:sourcemaps_dir]
+        sourcemap = params[:sourcemap]
+        bundle = params[:bundle]
+        minified_url = params[:minified_url]
+        overwrite = params[:overwrite]
+        strip = params[:strip]
+        wildcard_prefix = params[:wildcard_prefix]
+        generate_sourcemaps = params[:generate_sourcemaps]
+        upload_sources = params[:upload_sources]
+        upload_modules = params[:upload_modules]
+        entry_file = params[:entry_file]
+        endpoint = params[:endpoint]
+
+        path = ""
+        if sourcemap
+          path = "#{dir}/#{sourcemap}".to_s
+        else
+          path = "#{dir}/#{platform}.bundle.map".to_s
+        end
+        bundle_path = ""
+        if bundle
+          bundle_path = "#{dir}/#{bundle}".to_s
+        else
+          bundle_path = "#{dir}/#{platform}.bundle".to_s
+        end
+
+        if generate_sourcemaps
+          Helper::BugsnagSourcemapsUploadHelper.create_bundle(platform, entry_file, path, bundle_path)
         end
+        Helper::BugsnagSourcemapsUploadHelper.upload_bundle(api_key, platform, app_version, code_bundle_id, path, bundle_path, minified_url, strip, overwrite, wildcard_prefix, upload_sources, upload_modules, endpoint)
       end
 
       def self.description
-        "Helps to upload sourcemaps to Bugsnag"
+        "Upload sourcemaps to Bugsnag"
       end
 
       def self.authors
-        ["Evgrafov Denis"]
+        ["Evgrafov Denis", "Ivan Sokolovskii"]
       end
 
       def self.return_value
@@ -25,33 +55,108 @@ module Fastlane
 
       def self.details
         # Optional:
-        "Helps to upload sourcemaps to Bugsnag"
+        "Helps to generate and upload React-Native sourcemaps to Bugsnag"
       end
 
       def self.available_options
         [
-          # FastlaneCore::ConfigItem.new(key: :your_option,
-          #                         env_name: "BUGSNAG_SOURCEMAPS_UPLOAD_YOUR_OPTION",
-          #                      description: "A description of your option",
-          #                         optional: false,
-          #                             type: String)
           FastlaneCore::ConfigItem.new(key: :api_key,
-                                       description: "Bugsnag API key",
-                                       optional: false,
-                                       type: String),
-          FastlaneCore::ConfigItem.new(key: :os,
-                                       description: "OS list",
-                                       optional: false,
-                                       type: Array)
+                                  env_name: "BUGSNAG_API_KEY",
+                               description: "Bugsnag API key",
+                                  optional: false,
+                              verify_block: proc do |value|
+                                UI.user_error!("No Bugsnag API key given, pass using `api_key: 'key'`") unless value && !value.empty?
+                              end,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :app_version,
+                                  env_name: "BUGSNAG_SOURCEMAPS_APP_VERSION",
+                               description: "Target app version",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :code_bundle_id,
+                                  env_name: "BUGSNAG_SOURCEMAPS_CODE_BUNDLE",
+                               description: "Codepush bundle ID",
+                                  optional: true,
+                                     type: String),
+          FastlaneCore::ConfigItem.new(key: :platform,
+                                  env_name: "BUGSNAG_SOURCEMAPS_PLATFORM",
+                               description: "Platform",
+                                  optional: true,
+                             default_value: 'ios',
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :sourcemaps_dir,
+                                  env_name: "BUGSNAG_SOURCEMAPS_DIR",
+                               description: "Bugsnag sourcemaps directory",
+                                  optional: true,
+                             default_value: "/tmp",
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :sourcemap,
+                                  env_name: "BUGSNAG_SOURCEMAPS_NAME",
+                               description: "Override path(relative to sourcemaps_dir) to sourcemaps, default is platform-specific",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :bundle,
+                                  env_name: "BUGSNAG_SOURCEMAPS_BUNDLE_NAME",
+                               description: "Override path(relative to sourcemaps_dir) bundle to upload, default is platform-specific",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :minified_url,
+                                  env_name: "BUGSNAG_SOURCEMAPS_MINIFIED_URL",
+                               description: "Override Bugsnag mified url, default is platform specific",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :overwrite,
+                                  env_name: "BUGSNAG_SOURCEMAPS_OVERWRITE",
+                               description: "Overwrite existing sourcemaps in Bugsnag",
+                                  optional: true,
+                             default_value: true,
+                                      type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :strip,
+                                  env_name: "BUGSNAG_SOURCEMAPS_STRIP_PROJECT_ROOT",
+                               description: "Strip project root",
+                                  optional: true,
+                             default_value: true,
+                                      type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :wildcard_prefix,
+                                  env_name: "BUGSNAG_SOURCEMAPS_WILDCARD_PREFIX",
+                               description: "Add wildcard prefix for Bugsnag",
+                                  optional: true,
+                             default_value: false,
+                                      type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :generate_sourcemaps,
+                                  env_name: "BUGSNAG_SOURCEMAPS_GENERATE",
+                               description: "Generate React-Native sourcemaps",
+                                  optional: true,
+                             default_value: true,
+                                      type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :upload_sources,
+                                  env_name: "BUGSNAG_SOURCEMAPS_UPLOAD_MODULES",
+                               description: "Upload source files referenced by the source map",
+                                  optional: true,
+                             default_value: true,
+                                      type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :upload_modules,
+                                  env_name: "BUGSNAG_SOURCEMAPS_UPLOAD_MODULES",
+                               description: "Upload dependency files referenced by the source map",
+                                  optional: true,
+                             default_value: false,
+                                      type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :entry_file,
+                                  env_name: "BUGSNAG_SOURCEMAPS_ENTRY_FILE",
+                               description: "React Native index file for soucemaps generation",
+                                  optional: true,
+                             default_value: "index.js",
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :endpoint,
+                                  env_name: "BUGSNAG_SOURCEMAPS_ENDPOINT",
+                               description: "Bugsnag endpoint(when using Bugsnag On-premise)",
+                                  optional: true,
+                                      type: String)
         ]
       end
 
       def self.is_supported?(platform)
-        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
-        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
-        #
-        # [:ios, :mac, :android].include?(platform)
-        true
+        [:ios, :android].include?(platform)
       end
     end
   end

data/lib/fastlane/plugin/bugsnag_sourcemaps_upload/helper/bugsnag_sourcemaps_upload_helper.rb

@@ -8,14 +8,53 @@ module Fastlane
       # class methods that you define here become available in your action
       # as `Helper::BugsnagSourcemapsUploadHelper.your_method`
       #
-      def self.create_bundle(os)
+      def self.create_bundle(platform, entry_file, path, bundle_path)
         UI.message("Creating React Native bundle")
-        Action.sh("react-native bundle --platform #{os} --dev false --entry-file index.js --bundle-output /tmp/#{os}.bundle --sourcemap-output /tmp/#{os}.bundle.map")
+        Action.sh("react-native bundle \
+          --dev false \
+          --platform #{platform} \
+          --bundle-output #{bundle_path} \
+          --sourcemap-output #{path} \
+          --entry-file #{entry_file}")
       end
 
-      def self.upload_bundle(api_key, os)
+      def self.upload_bundle(api_key, platform, app_version, code_bundle_id, path, bundle_path, minified_url, strip, overwrite, wildcard_prefix, upload_sources, upload_modules, endpoint)
+        command = "bugsnag-sourcemaps upload --api-key #{api_key} --source-map #{path} --minified-file #{bundle_path} "
+        if upload_sources
+          command += "--upload-sources "
+        end
+        if upload_modules
+          command += "--upload-node-modules "
+        end
+        if minified_url
+          command += "--minified-url #{minified_url} "
+        else
+          if platform == "ios"
+            command += "--minified-url main.jsbundle "
+          else
+            command += "--minified-url index.android.bundle "
+          end
+        end
+        if app_version
+          command += "--app-version=#{app_version} "
+        end
+        if code_bundle_id
+          command += " --code-bundle-id #{code_bundle_id} "
+        end
+        if strip
+          command += "--strip-project-root "
+        end
+        if overwrite
+          command += "--overwrite "
+        end
+        if wildcard_prefix
+          command += "--add-wildcard-prefix "
+        end
+        if endpoint
+          command += "--endpoint #{endpoint} "
+        end
         UI.message("Uploading React Native bundle to Bugsnag")
-        Action.sh("bugsnag-sourcemaps upload --api-key #{api_key} --source-map /tmp/#{os}.bundle.map --strip-project-root --minified-file /tmp/#{os}.bundle --minified-url index.#{os}.bundle --upload-sources --overwrite")
+        Action.sh(command.to_s)
       end
 
       def self.show_message

data/lib/fastlane/plugin/bugsnag_sourcemaps_upload/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module BugsnagSourcemapsUpload
-    VERSION = "0.1.2"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-bugsnag_sourcemaps_upload
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Evgrafov Denis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-11 00:00:00.000000000 Z
+date: 2020-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry