emerge 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4bfa9e9a7d920f4f41ca06eef1283b73be375bffda3d414c27b55eeb11c1cef
-  data.tar.gz: ed994835ee23a65f5ccfbec7acc84114f363f82f2464b4147939bb32b2664c3f
+  metadata.gz: f78e2be6724a6620a5135d20910b99fe76c8a959b00f6703bdad0c0d2c043742
+  data.tar.gz: 8366d036be25ec0b3da721346b1c71dcfcdccd2bf7b7f2bea9f3e6838cf62a8b
 SHA512:
-  metadata.gz: de61137a2b6d33d3c6e3e8f8ab63b705658098d42c613a991f69102f01b93d3b374010939c087af06c8becfd20cb77c1f4279092ff5dc12556d803b607698a30
-  data.tar.gz: bde1f8a729fd46b45600e8fcc50921399e334c1bf50b071c222bac4c81050a200819baeb643fbbab91fa1ef13c9b9dc5123258416e1c88fe2fd9cd284efb58f0
+  metadata.gz: 4359ea66070503dc5dc98d1040a39598df3d760bad78393724baa0f689caf18c5e26d2875375ba3751f2fb95d4641e078ff4111084c7acf51b63118955e6a3cc
+  data.tar.gz: 13d4cc4f14a5f6e794592ce12eb5f6acd785fa5d51fbb7d9241e69c78ab7317a5f7b374dbcf06b2bf641cff890b1a7baa941ad3c76f306e207bbc069492875f0

data/README.md

@@ -14,7 +14,7 @@ gem install emerge
 
 ## API Key
 
-Follow our guide to obtain an [API key](https://docs.emergetools.com/docs/uploading-basics#obtain-an-api-key) for your organization. The API Token is used by the CLI to authenticate with the Emerge API. The CLI will automatically pick up the API key if configured as an `EMERGE_API_TOKEN` environment variable, or you can manually pass it into individual commands.
+Follow our guide to obtain an [API key](https://docs.emergetools.com/docs/uploading-basics#obtain-an-api-key) for your organization. The API Token is used by the CLI to authenticate with the Emerge API. The CLI will automatically pick up the API key if configured as an `EMERGE_API_TOKEN` environment variable, or you can manually pass it into individual commands with the `--api-token` option.
 
 ## Snapshots
 
@@ -92,3 +92,49 @@ emerge upload snapshots \
   --client-library paparazzi \
   --project-root /my/awesomeapp/android/repo
 ```
+
+### Using with Roborazzi
+
+Snapshots generated via [Roborazzi](https://github.com/takahirom/roborazzi) are natively supported by the CLI by setting `--client-library roborazzi` and a `--project-root` directory. This will scan your project for all images found in `**/build/outputs/roborazzi` directories.
+
+Example:
+
+```shell
+emerge upload snapshots \
+  --name "AwesomeApp Roborazzi" \
+  --id "com.emerge.awesomeapp.roborazzi" \
+  --repo-name "EmergeTools/AwesomeApp" \
+  --client-library roborazzi \
+  --project-root /my/awesomeapp/android/repo
+```
+
+## Reaper
+
+Experimental support has been added to interactively examine [Reaper](https://docs.emergetools.com/docs/reaper) results and also **delete them from your codebase**.
+
+Use the `reaper` subcommand to get started, e.g.:
+
+```shell
+emerge reaper --upload-id 40f1dfe7-6c57-47c3-bc52-b621aec0ba8d \
+  --project-root /path/to/your/repo
+```
+
+After which it will prompt you to select classes to delete.
+
+### How it works
+
+Under the hood we are using [Tree Sitter](https://tree-sitter.github.io/tree-sitter/) to parse your source files into an AST which is then used for deletions. There are some obvious limitations to this approach, namely that Tree Sitter is designed for source code editors and only looks at a single file at a time. We are exploring some better long-term approaches but this works well enough for now!
+
+### Supported languages
+
+We currently support the following languages:
+
+- Swift
+- Kotlin
+- Java
+
+Please open an issue if you need an additional language grammar.
+
+### Building
+
+Because many of the language grammars we use are third-party, we have to package them with our CLI tool as shared libraries for distribution. We depend on [tsdl](https://github.com/stackmystack/tsdl) to build the grammars from our `parsers.toml` file.

data/lib/commands/config/orderfiles/orderfiles_ios.rb

@@ -18,8 +18,6 @@ module EmergeCLI
         ORDER_FILE = 'ORDER_FILE'.freeze
         ORDER_FILE_PATH = '$(PROJECT_DIR)/orderfiles/orderfile.txt'.freeze
 
-        def initialize; end
-
         def call(**options)
           @options = options
           before(options)

data/lib/commands/config/snapshots/snapshots_ios.rb

@@ -39,8 +39,6 @@ module EmergeCLI
 format KEY=VALUE".freeze
         AVAILABLE_OS_VERSIONS = ['17.2', '17.5', '18.0'].freeze
 
-        def initialize; end
-
         def call(**options)
           @options = options
           before(options)
@@ -204,12 +202,11 @@ format KEY=VALUE".freeze
         end
 
         def get_parsed_previews(previews_exact, previews_regex)
-          excluded = []
-          previews_exact.each do |preview|
-            excluded.push({
-                            'type' => 'exact',
-                            'value' => preview
-                          })
+          excluded = previews_exact.map do |preview|
+            {
+              'type' => 'exact',
+              'value' => preview
+            }
           end
           previews_regex.each do |preview|
             excluded.push({

data/lib/commands/global_options.rb

@@ -9,6 +9,8 @@ module EmergeCLI
       def before(args)
         log_level = args[:debug] ? ::Logger::DEBUG : ::Logger::INFO
         EmergeCLI::Logger.configure(log_level)
+
+        EmergeCLI::Utils::VersionCheck.new.check_version
       end
     end
   end

data/lib/commands/integrate/fastlane.rb

@@ -80,7 +80,7 @@ module EmergeCLI
 
           # Add app_size lane if not present
           unless current_content.match?(/^\s*lane\s*:app_size\s*do/)
-            app_size_lane = <<~'RUBY'.gsub(/^/, '  ')
+            app_size_lane = <<~RUBY.gsub(/^/, '  ')
               lane :app_size do
                 # NOTE: If you already have a lane setup to build your app, then you can that instead of this and call emerge() after it.
                 build_app(scheme: ENV["SCHEME_NAME"], export_method: "development")
@@ -92,7 +92,7 @@ module EmergeCLI
 
           # Add snapshots lane if not present
           unless current_content.match?(/^\s*lane\s*:build_upload_emerge_snapshot\s*do/)
-            snapshot_lane = <<~'RUBY'.gsub(/^/, '  ')
+            snapshot_lane = <<~RUBY.gsub(/^/, '  ')
               desc 'Build and upload snapshot build to Emerge Tools'
               lane :build_upload_emerge_snapshot do
                 emerge_snapshot(scheme: ENV["SCHEME_NAME"])

data/lib/commands/reaper/reaper.rb

@@ -0,0 +1,201 @@
+require 'dry/cli'
+require 'json'
+require 'tty-prompt'
+
+module EmergeCLI
+  module Commands
+    class Reaper < EmergeCLI::Commands::GlobalOptions
+      desc 'Analyze dead code from an Emerge upload'
+
+      option :upload_id, type: :string, required: true, desc: 'Upload ID to analyze'
+      option :project_root, type: :string, required: true,
+                            desc: 'Root directory of the project, defaults to current directory'
+
+      option :api_token, type: :string, required: false,
+                         desc: 'API token for authentication, defaults to ENV[EMERGE_API_TOKEN]'
+
+      option :profile, type: :boolean, default: false, desc: 'Enable performance profiling metrics'
+
+      option :skip_delete_usages, type: :boolean, default: false,
+                                  desc: 'Skip deleting usages of the type (experimental feature)'
+
+      def initialize(network: nil)
+        @network = network
+      end
+
+      def call(**options)
+        @options = options
+        @profiler = EmergeCLI::Profiler.new(enabled: options[:profile])
+        @prompt = TTY::Prompt.new
+        before(options)
+        success = false
+
+        begin
+          api_token = @options[:api_token] || ENV.fetch('EMERGE_API_TOKEN', nil)
+          raise 'API token is required' unless api_token
+
+          @network ||= EmergeCLI::Network.new(api_token:)
+          project_root = @options[:project_root] || Dir.pwd
+
+          Sync do
+            all_data = @profiler.measure('fetch_dead_code') { fetch_all_dead_code(@options[:upload_id]) }
+            result = @profiler.measure('parse_dead_code') { DeadCodeResult.new(all_data) }
+
+            Logger.info result.to_s
+
+            selected_types = prompt_class_selection(result.filtered_unseen_classes, result.metadata['platform'])
+            Logger.info 'Selected classes:'
+            selected_types.each do |selected_class|
+              Logger.info " - #{selected_class['class_name']}"
+            end
+
+            confirmed = confirm_deletion(selected_types.length)
+            if !confirmed
+              Logger.info 'Operation cancelled'
+              return false
+            end
+
+            Logger.info 'Proceeding with deletion...'
+            platform = result.metadata['platform']
+            deleter = EmergeCLI::Reaper::CodeDeleter.new(
+              project_root: project_root,
+              platform: platform,
+              profiler: @profiler,
+              skip_delete_usages: options[:skip_delete_usages]
+            )
+            @profiler.measure('delete_types') { deleter.delete_types(selected_types) }
+          end
+
+          @profiler.report if @options[:profile]
+          success = true
+        rescue StandardError => e
+          Logger.error "Failed to analyze dead code: #{e.message}"
+          raise e
+        ensure
+          @network&.close
+        end
+
+        success
+      end
+
+      private
+
+      def fetch_all_dead_code(upload_id)
+        Logger.info 'Fetching dead code analysis (this may take a while for large codebases)...'
+
+        page = 1
+        combined_data = nil
+
+        loop do
+          response = fetch_dead_code_page(upload_id, page)
+          data = JSON.parse(response.read)
+
+          if combined_data.nil?
+            combined_data = data
+          else
+            combined_data['dead_code'].concat(data.fetch('dead_code', []))
+          end
+
+          current_page = data.dig('pagination', 'current_page')
+          total_pages = data.dig('pagination', 'total_pages')
+
+          break unless current_page && total_pages && current_page < total_pages
+
+          page += 1
+          Logger.info "Fetching page #{page} of #{total_pages}..."
+        end
+
+        combined_data
+      end
+
+      def fetch_dead_code_page(upload_id, page)
+        @network.post(
+          path: '/deadCode/export',
+          query: {
+            uploadId: upload_id,
+            page: page
+          },
+          headers: { 'Accept' => 'application/json' },
+          body: nil
+        )
+      end
+
+      def prompt_class_selection(unseen_classes, platform)
+        return nil if unseen_classes.empty?
+
+        choices = unseen_classes.map do |item|
+          display_name = if item['paths']&.first && platform == 'ios'
+                           "#{item['class_name']} (#{item['paths'].first})"
+                         else
+                           item['class_name']
+                         end
+          {
+            name: display_name,
+            value: item
+          }
+        end
+
+        @prompt.multi_select(
+          'Select classes to delete:'.blue,
+          choices,
+          per_page: 15,
+          echo: false,
+          filter: true,
+          min: 1
+        )
+      end
+
+      def confirm_deletion(count)
+        @prompt.yes?("Are you sure you want to delete #{count} type#{count > 1 ? 's' : ''}?")
+      end
+
+      class DeadCodeResult
+        attr_reader :metadata, :dead_code, :counts, :pagination
+
+        def initialize(data)
+          @metadata = data['metadata']
+          @dead_code = data['dead_code']
+          @counts = data['counts']
+          @pagination = data['pagination']
+        end
+
+        def filtered_unseen_classes
+          @filtered_unseen_classes ||= dead_code
+                                       .reject { |item| item['seen'] }
+                                       .reject do |item|
+            paths = item['paths']
+            next false if paths.nil? || paths.empty?
+
+            next true if paths.any? do |path|
+              path.include?('/SourcePackages/checkouts/') ||
+              path.include?('/Pods/') ||
+              path.include?('/Carthage/') ||
+              path.include?('/Vendor/') ||
+              path.include?('/Sources/') ||
+              path.include?('/DerivedSources/')
+            end
+
+            next false if paths.none? do |path|
+              path.end_with?('.swift', '.java', '.kt')
+            end
+          end
+        end
+
+        def to_s
+          <<~SUMMARY.yellow
+
+            Dead Code Analysis Results:
+            App ID: #{@metadata['app_id']}
+            App Version: #{@metadata['version']}
+            Platform: #{@metadata['platform']}
+
+            Statistics:
+            - Total User Sessions: #{@counts['user_sessions']}
+            - Seen Classes: #{@counts['seen_classes']}
+            - Unseen Classes: #{@counts['unseen_classes']}
+          SUMMARY
+        end
+      end
+    end
+  end
+end

data/lib/commands/upload/snapshots/snapshots.rb

@@ -51,8 +51,8 @@ module EmergeCLI
           success = false
 
           begin
-            api_token = @options[:api_token] || ENV['EMERGE_API_TOKEN']
-            raise 'API token is required' unless api_token
+            api_token = @options[:api_token] || ENV.fetch('EMERGE_API_TOKEN', nil)
+            raise 'API token is required and cannot be blank' if api_token.nil? || api_token.strip.empty?
 
             @network ||= EmergeCLI::Network.new(api_token:)
             @git_info_provider ||= GitInfoProvider.new
@@ -133,8 +133,8 @@ module EmergeCLI
 
             if seen_files[file_name]
               Logger.warn "Duplicate file name detected: '#{file_name}'. " \
-                        "Previous occurrence: '#{seen_files[file_name]}'. " \
-                        'This upload will overwrite the previous one.'
+                          "Previous occurrence: '#{seen_files[file_name]}'. " \
+                          'This upload will overwrite the previous one.'
             end
             seen_files[file_name] = image_path
           end

data/lib/emerge_cli.rb

@@ -1,21 +1,28 @@
-require_relative './commands/global_options'
-require_relative './commands/upload/snapshots/snapshots'
-require_relative './commands/upload/snapshots/client_libraries/swift_snapshot_testing'
-require_relative './commands/upload/snapshots/client_libraries/paparazzi'
-require_relative './commands/upload/snapshots/client_libraries/roborazzi'
-require_relative './commands/upload/snapshots/client_libraries/default'
-require_relative './commands/integrate/fastlane'
-require_relative './commands/config/snapshots/snapshots_ios'
-require_relative './commands/config/orderfiles/orderfiles_ios'
-
-require_relative './utils/git_info_provider'
-require_relative './utils/git_result'
-require_relative './utils/github'
-require_relative './utils/git'
-require_relative './utils/logger'
-require_relative './utils/network'
-require_relative './utils/profiler'
-require_relative './utils/project_detector'
+require_relative 'version'
+
+require_relative 'commands/global_options'
+require_relative 'commands/upload/snapshots/snapshots'
+require_relative 'commands/upload/snapshots/client_libraries/swift_snapshot_testing'
+require_relative 'commands/upload/snapshots/client_libraries/paparazzi'
+require_relative 'commands/upload/snapshots/client_libraries/roborazzi'
+require_relative 'commands/upload/snapshots/client_libraries/default'
+require_relative 'commands/integrate/fastlane'
+require_relative 'commands/config/snapshots/snapshots_ios'
+require_relative 'commands/config/orderfiles/orderfiles_ios'
+require_relative 'commands/reaper/reaper'
+
+require_relative 'reaper/ast_parser'
+require_relative 'reaper/code_deleter'
+
+require_relative 'utils/git_info_provider'
+require_relative 'utils/git_result'
+require_relative 'utils/github'
+require_relative 'utils/git'
+require_relative 'utils/logger'
+require_relative 'utils/network'
+require_relative 'utils/profiler'
+require_relative 'utils/project_detector'
+require_relative 'utils/version_check'
 
 require 'dry/cli'
 
@@ -34,7 +41,9 @@ module EmergeCLI
     prefix.register 'snapshots-ios', Commands::Config::SnapshotsIOS
     prefix.register 'order-files-ios', Commands::Config::OrderFilesIOS
   end
+
+  register 'reaper', Commands::Reaper
 end
 
 # By default the log level is INFO, but can be overridden by the --debug flag
-EmergeCLI::Logger.configure(::Logger::INFO)
+EmergeCLI::Logger.configure(Logger::INFO)