Merge pull request #257 from bugsnag/release/v3.7.0

v3.7.0 Release

Author: joshedney

.buildkite/pipeline.yml

@@ -50,6 +50,7 @@ steps:
 
   - label: "Node {{matrix}} Package Installation Tests"
     depends_on: build
+    branches: "!release/*"
     matrix:
       - "18"
       - "20"

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [3.7.0] - 2026-01-19
+
+### Changed
+
+- Update the logic and order when checking for empty dSYMS and missing DWARF information for dSYM uploads. [#256](https://github.com/bugsnag/bugsnag-cli/pull/256)
+
 ## [3.6.1] - 2026-01-07
 
 ### Fixed

features/steps/steps.rb

@@ -34,6 +34,18 @@
   Maze.check.include(run_output, message)
 end
 
+Then('I should see a log level of {string} when the dSYM files is empty') do |log_level|
+  message_regex = /#{Regexp.escape(log_level)}\s+Error\ locating\ dSYM\ files:\s+(\/[^\/\s]+)+\.dSYM\s+is\ empty/
+  regex = Regexp.new(message_regex)
+  Maze.check.match(regex, run_output)
+end
+
+Then('I should see a log level of {string} when the DWARF file is not valid') do |log_level|
+  message_regex = /#{Regexp.escape(log_level)}\s+Error\ locating\ dSYM\ files:\s+(\/[^\/\s]+)+\.dSYM\s+does\ not\ contain\ valid\ DWARF\ information/
+  regex = Regexp.new(message_regex)
+  Maze.check.match(regex, run_output)
+end
+
 Then('I should see a log level of {string} when no dSYM files could be uploaded') do |log_level|
   message = log_level + ' failed after'
   Maze.check.include(run_output, message)

features/xcode/expected_err_and_warn_scenarios.feature

@@ -6,20 +6,20 @@ Feature: dSYM Expected Error and Warning scenario Integration Tests
 
   Scenario: If --ignore-empty-dsym is not set, then the log message returned should be [ERROR]
     When I run bugsnag-cli with upload xcode-build --upload-api-root-url=http://localhost:$MAZE_RUNNER_PORT --api-key=1234567890ABCDEF1234567890ABCDEF --project-root=/path/to/project/root --scheme=test features/xcode/fixtures/ZeroByteDsym
-    Then I should see a log level of "[FATAL]" when no dSYM files could be found
+    Then I should see a log level of "[FATAL]" when the dSYM files is empty
 
   Scenario: If --ignore-missing-dwarf is set to true, then the log message returned should be [WARN]
     When I run bugsnag-cli with upload xcode-build --upload-api-root-url=http://localhost:$MAZE_RUNNER_PORT --api-key=1234567890ABCDEF1234567890ABCDEF --project-root=/path/to/project/root --scheme=test --ignore-missing-dwarf=true features/xcode/fixtures/MissingDWARFdSYM
     Then I should see a log level of "[FATAL]" when no dSYM files could be found
 
   Scenario: If --ignore-missing-dwarf is not set, then the log message returned should be [ERROR]
     When I run bugsnag-cli with upload xcode-build --upload-api-root-url=http://localhost:$MAZE_RUNNER_PORT --api-key=1234567890ABCDEF1234567890ABCDEF --project-root=/path/to/project/root --scheme=test features/xcode/fixtures/MissingDWARFdSYM
-    Then I should see a log level of "[FATAL]" when no dSYM files could be found
+    Then I should see a log level of "[FATAL]" when the DWARF file is not valid
 
   Scenario: If --ignore-missing-dwarf is set to true, then the log message returned should be [WARN]
     When I run bugsnag-cli with upload xcode-build --upload-api-root-url=http://localhost:$MAZE_RUNNER_PORT --api-key=1234567890ABCDEF1234567890ABCDEF --project-root=/path/to/project/root --scheme=test --ignore-missing-dwarf=true features/xcode/fixtures/MissingDWARFdSYM
     Then I should see a log level of "[FATAL]" when no dSYM files could be found
 
   Scenario: If --ignore-missing-dwarf is not set, then the log message returned should be [ERROR]
     When I run bugsnag-cli with upload xcode-build --upload-api-root-url=http://localhost:$MAZE_RUNNER_PORT --api-key=1234567890ABCDEF1234567890ABCDEF --project-root=/path/to/project/root --scheme=test features/xcode/fixtures/MissingDWARFdSYM
-    Then I should see a log level of "[FATAL]" when no dSYM files could be found
+    Then I should see a log level of "[FATAL]" when the DWARF file is not valid

install.sh

@@ -91,7 +91,7 @@ display_help() {
 EOS
 }
 
-VERSION="3.6.1"
+VERSION="3.7.0"
 
 while [[ "$#" -gt 0 ]]; do
   case "$1" in

js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bugsnag/cli",
-  "version": "3.6.1",
+  "version": "3.7.0",
   "description": "BugSnag CLI",
   "main": "dist/bugsnag-cli-wrapper.js",
   "types": "dist/bugsnag-cli-wrapper.d.ts",

main.go

@@ -11,7 +11,7 @@ import (
 	"github.com/bugsnag/bugsnag-cli/pkg/upload"
 )
 
-var package_version = "3.6.1"
+var package_version = "3.7.0"
 
 func main() {
 	commands := options.CLI{}

pkg/ios/dsym-utils.go

@@ -37,12 +37,12 @@ func FindDsymsInPath(path string, ignoreEmptyDsym, ignoreMissingDwarf bool, logg
 	var tempDir string
 	var dsymLocations []string
 	var dwarfInfo []*DwarfInfo
+	var dwarfLocation string
 
 	// If path is set and is a directory
 	if utils.IsDir(path) {
 		// Check for dSYMs within it
 		dsymLocations = findDsyms(path)
-
 	} else {
 
 		// If path is pointing to a .zip file, we will extract it and look for dSYMS within it to get dsymLocations
@@ -60,12 +60,10 @@ func FindDsymsInPath(path string, ignoreEmptyDsym, ignoreMissingDwarf bool, logg
 				logger.Debug(fmt.Sprintf("Unzipped %s to %s for uploading", fileName, tempDir))
 				dsymLocations = findDsyms(tempDir)
 			}
-
 		} else {
 			// If path points to a file, then we will assume it is a dSYM and use it as-is
 			dsymLocations = append(dsymLocations, path)
 		}
-
 	}
 
 	// If we have found dSYMs, use dwarfdump to get the UUID etc for each dSYM
@@ -75,10 +73,28 @@ func FindDsymsInPath(path string, ignoreEmptyDsym, ignoreMissingDwarf bool, logg
 		}
 
 		for _, dsymLocation := range dsymLocations {
-			filesFound, err := os.ReadDir(dsymLocation)
+			fileInfo, err := os.Stat(dsymLocation)
 
 			if err != nil {
-				// If not a directory, then we'll assume that the path is pointing straight to a file
+				return nil, tempDir, err
+			}
+
+			// Skip empty *.dSYM if requested
+			if fileInfo.Size() == 0 {
+				if ignoreEmptyDsym {
+					logger.Info(fmt.Sprintf("%s is empty, skipping", dsymLocation))
+					continue
+				} else {
+					return nil, tempDir, fmt.Errorf("%s is empty", dsymLocation)
+				}
+			}
+
+			dwarfLocation = filepath.Join(dsymLocation, "Contents", "Resources", "DWARF")
+
+			filesFound, err := os.ReadDir(dwarfLocation)
+
+			if err != nil {
+				// If not a directory, then we'll assume that the path is pointing straight to a DWARF file
 				if strings.Contains(err.Error(), "not a directory") {
 					fileName := filepath.Base(dsymLocation)
 					dsymLocation = filepath.Dir(dsymLocation)
@@ -87,24 +103,18 @@ func FindDsymsInPath(path string, ignoreEmptyDsym, ignoreMissingDwarf bool, logg
 			}
 
 			for _, file := range filesFound {
-				fileInfo, _ := os.Stat(filepath.Join(dsymLocation, file.Name()))
-
-				if fileInfo.Size() > 0 {
-					info := getDwarfFileInfo(dsymLocation, file.Name())
-					if len(info) == 0 {
-						if ignoreMissingDwarf {
-							logger.Info(fmt.Sprintf("%s is not a valid DWARF file, skipping", fileInfo.Name()))
-						} else {
-							return nil, tempDir, fmt.Errorf("%s is not a valid DWARF file", fileInfo.Name())
-						}
-					}
+				// Extract DWARF info
+				info := getDwarfFileInfo(dwarfLocation, file.Name())
+				if len(info) > 0 {
 					dwarfInfo = append(dwarfInfo, info...)
+				}
+			}
+
+			if len(dwarfInfo) == 0 {
+				if ignoreMissingDwarf {
+					logger.Info(fmt.Sprintf("%s does not contain valid DWARF information, skipping", dsymLocation))
 				} else {
-					if ignoreEmptyDsym {
-						logger.Info(fmt.Sprintf("%s is empty, skipping", file.Name()))
-					} else {
-						return nil, tempDir, fmt.Errorf("%s is empty", file.Name())
-					}
+					return nil, tempDir, fmt.Errorf("%s does not contain valid DWARF information", dsymLocation)
 				}
 			}
 		}
@@ -168,7 +178,7 @@ func findDsyms(root string) []string {
 
 		// If the file is a dSYM, add it to the list (unless it resides within the __MACOSX directory)
 		if strings.HasSuffix(strings.ToLower(info.Name()), ".dsym") && !strings.Contains(strings.ToLower(path), "__macosx") {
-			dsyms = append(dsyms, filepath.Join(path, "Contents", "Resources", "DWARF"))
+			dsyms = append(dsyms, path)
 		}
 
 		return nil

pkg/ios/xcarchive.go

@@ -3,15 +3,16 @@ package ios
 import (
 	"bytes"
 	"fmt"
-	"github.com/bugsnag/bugsnag-cli/pkg/log"
-	"github.com/bugsnag/bugsnag-cli/pkg/options"
-	"github.com/bugsnag/bugsnag-cli/pkg/utils"
 	"os"
 	"os/exec"
 	"os/user"
 	"path/filepath"
 	"strings"
 	"time"
+
+	"github.com/bugsnag/bugsnag-cli/pkg/log"
+	"github.com/bugsnag/bugsnag-cli/pkg/options"
+	"github.com/bugsnag/bugsnag-cli/pkg/utils"
 )
 
 // GetLatestXcodeArchiveForScheme retrieves the latest xcarchive for a given scheme.