[GCSI-567] feat: handle ios build app to track build time and build path and + specs

Author: Yousif-Ahmed

lib/fastlane/plugin/instabug_stores_upload/actions/instabug_build_ios_app_action.rb

@@ -6,47 +6,67 @@ module Actions
     class InstabugBuildIosAppAction < Action
       def self.run(params)
         UI.message("Starting Instabug iOS build...")
-        
+
         # Extract Instabug-specific parameters
         branch_name = params.delete(:branch_name)
         instabug_api_key = params.delete(:instabug_api_key)
-        
+
         # Validate required parameters
         if branch_name.nil? || branch_name.empty?
           UI.user_error!("branch_name is required for Instabug reporting")
         end
-        
+
         begin
           # Report build start to Instabug
           Helper::InstabugStoresUploadHelper.report_status(
-            branch_name: branch_name,
+            branch_name:,
             api_key: instabug_api_key,
             status: "inprogress",
             step: "build_app"
           )
 
+          # Start timing the build
+          build_start_time = Time.now
+
           # Execute the actual iOS build
           result = Actions::BuildIosAppAction.run(params)
 
+          # Calculate build time in seconds
+          build_time = (Time.now - build_start_time).round
+
+          # Extract IPA path from Fastlane environment
+          build_path = Actions.lane_context[SharedValues::IPA_OUTPUT_PATH]
+
+          if build_path
+            UI.success("IPA Output Path: #{build_path}")
+          else
+            UI.error("No IPA path found.")
+          end
+
           # Report build success to Instabug
           Helper::InstabugStoresUploadHelper.report_status(
-            branch_name: branch_name,
+            branch_name:,
             api_key: instabug_api_key,
             status: "success",
-            step: "build_app"
+            step: "build_app",
+            extras: {
+              build_time:,
+              build_path:
+            }
           )
 
           UI.success("iOS build completed successfully!")
           result
-        rescue => e
+        rescue StandardError => e
           UI.error("iOS build failed: #{e.message}")
 
           # Report build failure to Instabug
           Helper::InstabugStoresUploadHelper.report_status(
-            branch_name: branch_name,
+            branch_name:,
             api_key: instabug_api_key,
             status: "failure",
-            step: "build_app"
+            step: "build_app",
+            error_message: e.message
           )
           raise e
         end
@@ -71,7 +91,7 @@ def self.details
       def self.available_options
         # Start with the original build_ios_app options
         options = Actions::BuildIosAppAction.available_options
-        
+
         # Add Instabug-specific options
         instabug_options = [
           FastlaneCore::ConfigItem.new(
@@ -88,9 +108,17 @@ def self.available_options
             optional: false,
             type: String,
             sensitive: true
-          ) 
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :instabug_api_base_url,
+            env_name: "INSTABUG_API_BASE_URL",
+            description: "Instabug API base URL (defaults to https://api.instabug.com)",
+            optional: true,
+            type: String,
+            skip_type_validation: true # Since we don't extract this param
+          )
         ]
-        
+
         # Combine both sets of options
         options + instabug_options
       end
@@ -117,4 +145,4 @@ def self.category
       end
     end
   end
-end 
+end

spec/instabug_build_ios_app_action_spec.rb

@@ -20,7 +20,12 @@
 
   describe '#run' do
     context 'when build succeeds' do
-      it 'reports inprogress, calls build action, and reports success' do
+      it 'reports inprogress, calls build action, and reports success with timing and path' do
+        # Mock the lane context to return an IPA path
+        allow(Fastlane::Actions).to receive(:lane_context).and_return({
+          Fastlane::Actions::SharedValues::IPA_OUTPUT_PATH => '/path/to/app.ipa'
+        })
+
         expect(Fastlane::Actions::BuildIosAppAction).to receive(:run)
           .with(hash_including(workspace: 'Test.xcworkspace', scheme: 'Test', export_method: 'app-store'))
           .and_return('build_result')
@@ -33,7 +38,9 @@
             body: {
               branch_name: 'crash-fix/instabug-crash-123',
               status: 'inprogress',
-              step: 'build_app'
+              step: 'build_app',
+              extras: {},
+              error_message: nil
             }.to_json,
             headers: {
               'Content-Type' => 'application/json',
@@ -43,18 +50,35 @@
           ).once
 
         expect(WebMock).to have_requested(:patch, api_endpoint)
-          .with(
-            body: {
-              branch_name: 'crash-fix/instabug-crash-123',
-              status: 'success',
-              step: 'build_app'
-            }.to_json,
-            headers: {
-              'Content-Type' => 'application/json',
-              'Authorization' => 'Bearer test-api-key',
-              'User-Agent' => 'fastlane-plugin-instabug-stores-upload'
-            }
-          ).once
+          .with { |req|
+            body = JSON.parse(req.body)
+            body['status'] == 'success' &&
+              body['branch_name'] == 'crash-fix/instabug-crash-123' &&
+              body['step'] == 'build_app' &&
+              body['extras']['build_path'] == '/path/to/app.ipa' &&
+              body['extras']['build_time'].kind_of?(Integer)
+          }.once
+      end
+
+      it 'handles missing IPA path gracefully' do
+        # Mock empty lane context
+        allow(Fastlane::Actions).to receive(:lane_context).and_return({})
+
+        expect(Fastlane::Actions::BuildIosAppAction).to receive(:run)
+          .and_return('build_result')
+
+        result = described_class.run(valid_params)
+
+        expect(result).to eq('build_result')
+        expect(WebMock).to have_requested(:patch, api_endpoint)
+          .with { |req|
+            body = JSON.parse(req.body)
+            body['status'] == 'success' &&
+              body['branch_name'] == 'crash-fix/instabug-crash-123' &&
+              body['step'] == 'build_app' &&
+              body['extras']['build_path'].nil? &&
+              body['extras']['build_time'].kind_of?(Integer)
+          }.once
       end
     end
 
@@ -64,16 +88,18 @@
         expect(Fastlane::Actions::BuildIosAppAction).to receive(:run)
           .and_raise(error)
 
-        expect {
+        expect do
           described_class.run(valid_params)
-        }.to raise_error(StandardError, 'Build failed')
+        end.to raise_error(StandardError, 'Build failed')
 
         expect(WebMock).to have_requested(:patch, api_endpoint)
           .with(
             body: {
               branch_name: 'crash-fix/instabug-crash-123',
               status: 'failure',
-              step: 'build_app'
+              step: 'build_app',
+              extras: {},
+              error_message: 'Build failed'
             }.to_json
           )
       end
@@ -83,26 +109,26 @@
       it 'raises user error' do
         params = valid_params.merge(branch_name: nil)
 
-        expect {
+        expect do
           described_class.run(params)
-        }.to raise_error(FastlaneCore::Interface::FastlaneError, 'branch_name is required for Instabug reporting')
+        end.to raise_error(FastlaneCore::Interface::FastlaneError, 'branch_name is required for Instabug reporting')
       end
     end
 
     context 'when branch_name is empty' do
       it 'raises user error' do
         params = valid_params.merge(branch_name: '')
 
-        expect {
+        expect do
           described_class.run(params)
-        }.to raise_error(FastlaneCore::Interface::FastlaneError, 'branch_name is required for Instabug reporting')
+        end.to raise_error(FastlaneCore::Interface::FastlaneError, 'branch_name is required for Instabug reporting')
       end
     end
 
     context 'when branch name does not match instabug pattern' do
       it 'does not make API calls but still runs build' do
         params = valid_params.merge(branch_name: 'feature/new-feature')
-        
+
         expect(Fastlane::Actions::BuildIosAppAction).to receive(:run)
           .and_return('build_result')
 
@@ -129,4 +155,4 @@
       expect(described_class.category).to eq(:building)
     end
   end
-end 
+end