fix(ios): added dSYM for Swift framework-based modules (#14369)

* fix(ios): added dSYM for Swift framework-based modules

* fix: improve code style

* fix(ios): further code improvements

---------

Co-authored-by: Hans Knöchel <[email protected]>

Author: hbugdoll

iphone/cli/commands/_buildModule.js

@@ -753,21 +753,20 @@ FRAMEWORK_SEARCH_PATHS = $(inherited) "$(TITANIUM_SDK)/iphone/Frameworks/**"`);
 	}
 
 	createUniversalBinary(next) {
-		this.logger.info('Creating universal library');
+		this.logger.info('Creating universal framework/library');
 
 		const moduleId = this.isFramework ? this.moduleIdAsIdentifier : this.moduleId;
 		const findLib = function (dest) {
-			let libPath = this.isFramework ? '.xcarchive/Products/Library/Frameworks/' + moduleId + '.framework' : '.xcarchive/Products/usr/local/lib/lib' + this.moduleId + '.a';
-
+			let libPath = this.isFramework ? `.xcarchive/Products/Library/Frameworks/${moduleId}.framework` : `.xcarchive/Products/usr/local/lib/lib${moduleId}.a`;
 			const lib = path.join(this.projectDir, 'build', dest + libPath);
 			this.logger.info(`Looking for ${lib}`);
 
 			if (!fs.existsSync(lib)) {
 				// unfortunately the initial module project template incorrectly
 				// used the camel-cased module id
-				libPath = '.xcarchive/Products/usr/local/lib/lib' + this.moduleIdAsIdentifier + '.a';
+				libPath = `.xcarchive/Products/usr/local/lib/lib${this.moduleIdAsIdentifier}.a`;
 				const newLib = path.join(this.projectDir, 'build', dest + libPath);
-				this.logger.debug('Searching library: ' + newLib);
+				this.logger.debug(`Searching library: ${newLib}`);
 				if (!fs.existsSync(newLib)) {
 					return new Error(`Unable to find the built Release-${dest} library`);
 				} else {
@@ -777,6 +776,18 @@ FRAMEWORK_SEARCH_PATHS = $(inherited) "$(TITANIUM_SDK)/iphone/Frameworks/**"`);
 			}
 			return lib;
 		}.bind(this);
+		// Find the debug symbols (dSYM) for the generated framework
+		const findDSYM = function (dest) {
+			const dSymPath = `.xcarchive/dSYMs/${moduleId}.framework.dSYM`;
+			const dSym = path.join(this.projectDir, 'build', dest + dSymPath);
+			this.logger.debug(`Looking for dSYM ${dSym}`);
+
+			if (!fs.existsSync(dSym)) {
+				this.logger.warn(`Unable to find the Release-${dest} dSYM. Crash reports for ${moduleId} may be unsymbolicated.`);
+				return null;
+			}
+			return dSym;
+		}.bind(this);
 
 		// Create xcframework
 		const args = [];
@@ -791,36 +802,41 @@ FRAMEWORK_SEARCH_PATHS = $(inherited) "$(TITANIUM_SDK)/iphone/Frameworks/**"`);
 		if (lib instanceof Error) {
 			return next(lib);
 		}
-
 		args.push('-create-xcframework');
-		args.push(buildType);
-		args.push(lib);
-
+		args.push(buildType, lib);
 		if (!this.isFramework) {
-			args.push('-headers');
-			args.push(headerPath);
+			args.push('-headers', headerPath);
+		} else {
+			// Include dSYM files in xcframework for symbolicated crash reports
+			const dSym = findDSYM('iphoneos');
+			dSym && args.push('-debug-symbols', dSym);
 		}
 
 		lib = findLib('iphonesimulator');
 		if (lib instanceof Error) {
 			return next(lib);
 		}
-		args.push(buildType);
-		args.push(lib);
+		args.push(buildType, lib);
 		if (!this.isFramework) {
-			args.push('-headers');
-			args.push(headerPath);
+			args.push('-headers', headerPath);
+		} else {
+			// Include dSYM files in xcframework for symbolicated crash reports
+			const dSym = findDSYM('iphonesimulator');
+			dSym && args.push('-debug-symbols', dSym);
 		}
+
 		if (this.isMacOSEnabled) {
 			lib = findLib('macosx');
 			if (lib instanceof Error) {
 				this.logger.warn('The module is missing macOS support. Ignoring mac target for this module...');
 			} else {
-				args.push(buildType);
-				args.push(lib);
+				args.push(buildType, lib);
 				if (!this.isFramework) {
-					args.push('-headers');
-					args.push(headerPath);
+					args.push('-headers', headerPath);
+				} else {
+					// Include dSYM files in xcframework for symbolicated crash reports
+					const dSym = findDSYM('macosx');
+					dSym && args.push('-debug-symbols', dSym);
 				}
 			}
 		}
@@ -857,7 +873,7 @@ FRAMEWORK_SEARCH_PATHS = $(inherited) "$(TITANIUM_SDK)/iphone/Frameworks/**"`);
 	}
 
 	async verifyBuildArch() {
-		this.logger.info('Verifying universal library');
+		this.logger.info('Verifying universal framework/library');
 
 		const moduleId = this.isFramework ? this.moduleIdAsIdentifier  : this.moduleId;
 		const frameworkPath = path.join(this.projectDir, 'build', moduleId + '.xcframework');
@@ -874,7 +890,7 @@ FRAMEWORK_SEARCH_PATHS = $(inherited) "$(TITANIUM_SDK)/iphone/Frameworks/**"`);
 				libraryPath = path.join(libraryPath, frameworkName);
 			}
 			if (!(await fs.pathExists(libraryPath))) {
-				throw new Error(`Unable to find the built library ${libraryPath}`);
+				throw new Error(`Unable to find the built framework/library ${libraryPath}`);
 			}
 		};
 
@@ -954,7 +970,7 @@ FRAMEWORK_SEARCH_PATHS = $(inherited) "$(TITANIUM_SDK)/iphone/Frameworks/**"`);
 			binarylibName = this.isFramework ? this.moduleIdAsIdentifier + '.xcframework' : moduleId + '.xcframework',
 			binarylibFile = path.join(this.projectDir, 'build', binarylibName);
 
-		this.logger.info(`binarylibFile is ${binarylibFile}`);
+		this.logger.info(`Binary framework/library file: ${binarylibFile}`);
 
 		this.moduleZipPath = moduleZipFullPath;