@sentry/wizard 4.7.0 → 4.9.0

package/dist/src/apple/xcode-manager.js

@@ -32,8 +32,10 @@ exports.XcodeProject = void 0;
 const clack = __importStar(require("@clack/prompts"));
 const fs = __importStar(require("node:fs"));
 const path = __importStar(require("node:path"));
+const debug_1 = require("../utils/debug");
 const templates = __importStar(require("./templates"));
 const xcode_1 = require("xcode");
+const macos_system_helper_1 = require("./macos-system-helper");
 function setDebugInformationFormatAndSandbox(proj, targetName) {
     const xcObjects = proj.hash.project.objects;
     if (!xcObjects.PBXNativeTarget) {
@@ -196,6 +198,7 @@ function addUploadSymbolsScript(xcodeProject, sentryProject, targetName, uploadS
         }
         xcObjects.PBXShellScriptBuildPhase[key] = value;
     }
+    // Add the build phase to the target
     const isHomebrewInstalled = fs.existsSync('/opt/homebrew/bin/sentry-cli');
     xcodeProject.addBuildPhase([], 'PBXShellScriptBuildPhase', 'Upload Debug Symbols to Sentry', targetKey, {
         inputFileListPaths: [],
@@ -207,17 +210,32 @@ function addUploadSymbolsScript(xcodeProject, sentryProject, targetName, uploadS
     clack.log.step(`Added Sentry upload script to "${targetName}" build phase`);
 }
 class XcodeProject {
-    projectPath;
+    /**
+     * The directory where the Xcode project is located.
+     */
+    baseDir;
+    /**
+     * The path to the `<PROJECT>.xcodeproj` directory.
+     */
+    xcodeprojPath;
+    /**
+     * The path to the `project.pbxproj` file.
+     */
+    pbxprojPath;
+    /**
+     * The Xcode project object.
+     */
     project;
     objects;
-    files;
     /**
      * Creates a new XcodeProject instance, a wrapper around the Xcode project file `<PROJECT>.xcodeproj/project.pbxproj`.
      *
      * @param projectPath - The path to the Xcode project file
      */
     constructor(projectPath) {
-        this.projectPath = projectPath;
+        this.pbxprojPath = projectPath;
+        this.xcodeprojPath = path.dirname(projectPath);
+        this.baseDir = path.dirname(this.xcodeprojPath);
         this.project = (0, xcode_1.project)(projectPath);
         this.project.parseSync();
         this.objects = this.project.hash.project.objects;
@@ -244,85 +262,738 @@ class XcodeProject {
             addSentrySPM(this.project, target);
         }
         const newContent = this.project.writeSync();
-        fs.writeFileSync(this.projectPath, newContent);
+        fs.writeFileSync(this.pbxprojPath, newContent);
     }
-    filesForTarget(target) {
-        const files = this.projectFiles();
-        const fileDictionary = {};
-        files.forEach((file) => {
-            fileDictionary[file.key] = file.path;
-        });
-        const targets = this.objects.PBXNativeTarget || {};
-        const nativeTarget = Object.keys(targets).filter((key) => {
-            const value = targets[key];
-            return (!key.endsWith('_comment') &&
-                typeof value !== 'string' &&
-                value.name === target);
-        })[0];
-        if (nativeTarget === undefined) {
+    /**
+     * Retrieves all source files associated with a specific target in the Xcode project.
+     * This is used to find files where we can inject Sentry initialization code.
+     *
+     * @param targetName - The name of the target to get files for
+     * @returns An array of absolute file paths for the target's source files, or undefined if target not found
+     */
+    getSourceFilesForTarget(targetName) {
+        // ## Summary how Xcode Projects are structured:
+        // - Every Xcode Project has exactly one main group of type `PBXGroup`
+        // - The main group contains a list of children identifiers
+        // - Each child can be a `PBXGroup`, a `PBXFileReference` or a `PBXFileSystemSynchronizedRootGroup`
+        // - Each `PBXGroup` has a list of children identifiers which again can be `PBXGroup`, `PBXFileReference` or `PBXFileSystemSynchronizedRootGroup`
+        // - The target defines the list of `fileSystemSynchronizedGroups` which are `PBXFileSystemSynchronizedRootGroup` to be included in the build phase
+        // - The `PBXFileSystemSynchronizedRootGroup` has a list of `exceptions` which are `PBXFileSystemSynchronizedBuildFileExceptionSet`
+        // - Each `PBXFileSystemSynchronizedBuildFileExceptionSet` represents a folder to be excluded from the build.
+        // - The `PBXFileSystemSynchronizedBuildFileExceptionSet` has a list of `membershipExceptions` which are files to be excluded from being excluded, therefore included in the build.
+        // - The Xcode project has a build phase `PBXSourcesBuildPhase` which has a list of `files` which are `PBXBuildFile`
+        // - A file which is not part of a `PBXFileSystemSynchronizedRootGroup` must be added to the `files` list of the `PBXSourcesBuildPhase` build phase
+        // - Nested subfolders in `fileSystemSynchronizedGroups` are not declared but recursively included
+        //
+        // Based on the findings above the files included in the build phase are:
+        // - All files in the `files` of the `PBXSourcesBuildPhase` build phase `Sources` of the target
+        // - All files in directories of the `fileSystemSynchronizedGroups` of the target
+        // - Excluding all files in the `exceptions` of the `PBXFileSystemSynchronizedRootGroup` of the target
+        // - Including all files in the `membershipExceptions` of the `PBXFileSystemSynchronizedBuildFileExceptionSet` of the target
+        const nativeTarget = this.findNativeTargetByName(targetName);
+        if (!nativeTarget) {
+            (0, debug_1.debug)('Target not found: ' + targetName);
             return undefined;
         }
-        const buildPhaseKey = targets[nativeTarget].buildPhases?.filter((phase) => {
-            return this.objects.PBXSourcesBuildPhase?.[phase.value] !== undefined;
-        })[0];
-        if (buildPhaseKey === undefined) {
+        const filesInBuildPhase = this.findFilesInSourceBuildPhase(nativeTarget);
+        (0, debug_1.debug)(`Found ${filesInBuildPhase.length} files in build phase for target: ${targetName}`);
+        const filesInSynchronizedRootGroups = this.findFilesInSynchronizedRootGroups(nativeTarget);
+        (0, debug_1.debug)(`Found ${filesInSynchronizedRootGroups.length} files in synchronized root groups for target: ${targetName}`);
+        return [...filesInBuildPhase, ...filesInSynchronizedRootGroups];
+    }
+    // ================================ TARGET HELPERS ================================
+    /**
+     * Finds a native target by name.
+     *
+     * @param targetName - The name of the target to find
+     * @returns The native target, or undefined if the target is not found
+     */
+    findNativeTargetByName(targetName) {
+        (0, debug_1.debug)('Finding native target by name: ' + targetName);
+        if (!this.objects.PBXNativeTarget) {
+            (0, debug_1.debug)('No native targets found');
             return undefined;
         }
-        const buildPhase = this.objects.PBXSourcesBuildPhase?.[buildPhaseKey.value];
-        const buildPhaseFiles = buildPhase?.files ?? [];
-        const baseDir = path.dirname(path.dirname(this.projectPath));
-        return buildPhaseFiles
-            .map((file) => {
-            const fileRef = this.objects.PBXBuildFile?.[file.value]?.fileRef;
-            if (!fileRef) {
-                return '';
+        const nativeTargets = Object.entries(this.objects.PBXNativeTarget);
+        for (const [key, target] of nativeTargets) {
+            // Ignore comments
+            if (key.endsWith('_comment') || typeof target === 'string') {
+                continue;
             }
-            const buildFile = fileDictionary[fileRef];
-            if (!buildFile) {
-                return '';
+            // Ignore targets that are not the target we are looking for
+            if (target.name !== targetName) {
+                continue;
             }
-            return path.join(baseDir, buildFile);
-        })
-            .filter((f) => f.length > 0);
-    }
-    projectFiles() {
-        if (this.files === undefined) {
-            const proj = this.project.getFirstProject();
-            const mainGroupKey = proj.firstProject.mainGroup;
-            const mainGroup = this.objects.PBXGroup?.[mainGroupKey];
-            if (!mainGroup || typeof mainGroup === 'string') {
-                return [];
+            (0, debug_1.debug)('Found native target: ' + targetName);
+            return {
+                id: key,
+                obj: target,
+            };
+        }
+        (0, debug_1.debug)('Target not found: ' + targetName);
+        return undefined;
+    }
+    // ================================ BUILD PHASE HELPERS ================================
+    /**
+     * Finds the source build phase in a target.
+     *
+     * @param target - The target to find the source build phase in
+     * @returns The source build phase, or undefined if the target is not found or has no source build phase
+     */
+    findSourceBuildPhaseInTarget(target) {
+        (0, debug_1.debug)(`Finding source build phase in target: ${target.name}`);
+        if (!target.buildPhases) {
+            (0, debug_1.debug)('No build phases found for target: ' + target.name);
+            return undefined;
+        }
+        for (const phase of target.buildPhases) {
+            const buildPhaseId = phase.value;
+            const buildPhase = this.objects.PBXSourcesBuildPhase?.[buildPhaseId];
+            if (typeof buildPhase !== 'object') {
+                // Ignore comments
+                continue;
             }
-            this.files = this.buildGroup(mainGroup);
+            (0, debug_1.debug)(`Found source build phase: ${buildPhaseId} for target: ${target.name}`);
+            return {
+                id: buildPhaseId,
+                obj: buildPhase,
+            };
         }
-        return this.files;
+        (0, debug_1.debug)(`No source build phase found for target: ${target.name}`);
+        return undefined;
     }
-    buildGroup(group, path = '') {
+    // ================================ FILE HELPERS ================================
+    /**
+     * Finds all files in the source build phase of a target.
+     *
+     * @param nativeTarget - The target to find the files in
+     * @returns The files in the source build phase of the target, or an empty array if the target is not found or has no source build phase
+     */
+    findFilesInSourceBuildPhase(nativeTarget) {
+        (0, debug_1.debug)('Finding files in source build phase for target: ' +
+            nativeTarget.obj.name);
+        const buildPhase = this.findSourceBuildPhaseInTarget(nativeTarget.obj);
+        if (!buildPhase) {
+            (0, debug_1.debug)(`Sources build phase not found for target: ${nativeTarget.obj.name}`);
+            return [];
+        }
+        const buildPhaseFiles = buildPhase.obj.files;
+        if (!buildPhaseFiles) {
+            (0, debug_1.debug)(`No files found in sources build phase for target: ${nativeTarget.obj.name}`);
+            return [];
+        }
+        if (!this.objects.PBXBuildFile) {
+            (0, debug_1.debug)('PBXBuildFile is undefined');
+            return [];
+        }
+        if (!this.objects.PBXFileReference) {
+            (0, debug_1.debug)('PBXFileReference is undefined');
+            return [];
+        }
         const result = [];
-        for (const child of group.children ?? []) {
-            const fileReference = this.objects.PBXFileReference?.[child.value];
-            const groupReference = this.objects.PBXGroup?.[child.value];
-            if (fileReference) {
-                if (typeof fileReference === 'string') {
-                    continue;
-                }
+        for (const file of buildPhaseFiles) {
+            (0, debug_1.debug)(`Resolving build phase file: ${file.value}`);
+            // Find the related build file object
+            const buildFileObj = this.objects.PBXBuildFile[file.value];
+            if (!buildFileObj || typeof buildFileObj !== 'object') {
+                (0, debug_1.debug)(`Build file object not found for file: ${file.value}`);
+                continue;
+            }
+            (0, debug_1.debug)(`Build file object found for file: ${file.value}`);
+            const buildFileRefId = buildFileObj.fileRef;
+            if (!buildFileRefId) {
+                (0, debug_1.debug)(`File reference not found for file: ${file.value}`);
+                continue;
+            }
+            (0, debug_1.debug)(`Build file reference found for file: ${file.value}`);
+            // Find the related file reference object
+            const buildFile = this.objects.PBXFileReference[buildFileRefId];
+            if (!buildFile || typeof buildFile !== 'object') {
+                (0, debug_1.debug)(`File not found in file dictionary for file: ${file.value}`);
+                continue;
+            }
+            (0, debug_1.debug)(`Build file found in file dictionary for file: ${file.value}`);
+            // Resolve the path of the file based on the `sourceTree` property
+            const resolvedFilePath = this.resolveAbsolutePathOfFileReference({
+                id: buildFileRefId,
+                obj: buildFile,
+            });
+            if (!resolvedFilePath) {
+                (0, debug_1.debug)(`Failed to resolve file path for file: ${file.value}`);
+                continue;
+            }
+            (0, debug_1.debug)(`Resolved file ${file.value} to path: ${resolvedFilePath}`);
+            result.push(resolvedFilePath);
+        }
+        (0, debug_1.debug)(`Resolved ${result.length} files for target: ${nativeTarget.obj.name}`);
+        return result;
+    }
+    /**
+     * Resolves the absolute path of a file reference.
+     *
+     * @param fileRef - The file reference to resolve the path of
+     * @returns The absolute path of the file reference, or undefined if the file reference is not found or has no path
+     */
+    resolveAbsolutePathOfFileReference(fileRef) {
+        (0, debug_1.debug)(`Resolving path of file reference: ${fileRef.id} with path: ${fileRef.obj.path}`);
+        // File path is expected to be set, therefore typing is non-nullable.
+        // As the file is loaded from a project file, it is not guaranteed to be set,
+        // therefore we treat it as optional.
+        if (!fileRef.obj.path) {
+            (0, debug_1.debug)(`File reference path not found for file reference: ${fileRef.id}`);
+            return undefined;
+        }
+        // File references are resolved based on the `sourceTree` property
+        // which can have one of the following values:
+        // - '<absolute>': The file path is absolute
+        // - '<group>': The file path is relative to the parent group of the file reference
+        // - 'BUILT_PRODUCTS_DIR': The file path is relative to the built products directory, i.e. the build output directory in derived data
+        // - 'SOURCE_ROOT': The file path is relative to the source root, i.e. the directory where the Xcode project is located
+        // - 'SDKROOT': The file path is relative to the SDK root, i.e. the directory where the SDK is installed
+        // - 'DEVELOPER_DIR': The file path is relative to the developer directory, i.e. the directory where the Xcode command line tools are installed
+        // The default is '<group>'
+        const fileRefSourceTree = fileRef.obj.sourceTree?.replace(/"/g, '') ?? '';
+        switch (fileRefSourceTree) {
+            case '<absolute>':
+                return fileRef.obj.path.replace(/"/g, '');
+            case '<group>':
+                return this.resolveAbsoluteFilePathRelativeToGroup(fileRef);
+            case 'BUILT_PRODUCTS_DIR':
+                return this.resolveAbsoluteFilePathRelativeToBuiltProductsDir(fileRef);
+            case 'SOURCE_ROOT':
+                return this.resolveAbsoluteFilePathRelativeToSourceRoot(fileRef);
+            case 'SDKROOT':
+                return this.resolveAbsoluteFilePathRelativeToSdkRoot(fileRef);
+            case 'DEVELOPER_DIR':
+                return this.resolveAbsoluteFilePathRelativeToDeveloperDir(fileRef);
+            default:
+                (0, debug_1.debug)(`Unknown source tree '${fileRef.obj.sourceTree}' for build file: ${fileRef.obj.path}`);
+                return undefined;
+        }
+    }
+    /**
+     * Resolves the absolute path of a file reference relative to the parent group.
+     *
+     * @param fileRef - The file reference to resolve the path of
+     * @returns The absolute path of the file reference, or undefined if the file reference is not found or has no path
+     */
+    resolveAbsoluteFilePathRelativeToGroup(fileRef) {
+        (0, debug_1.debug)(`Resolving absolute file path relative to group for file reference: ${fileRef.id} with path: ${fileRef.obj.path ?? ''}`);
+        const fileRefPath = fileRef.obj.path?.replace(/"/g, '');
+        if (!fileRefPath) {
+            (0, debug_1.debug)(`File reference path not found for file reference: ${fileRef.id}`);
+            return undefined;
+        }
+        // Find the parent group of the file reference by searching for the reverse relationship
+        const parentGroup = this.findParentGroupByChildId(fileRef.id);
+        if (!parentGroup) {
+            (0, debug_1.debug)(`Parent group not found for file reference: ${fileRef.id} at path: ${fileRefPath}`);
+            return undefined;
+        }
+        // Resolve the path of the parent group
+        const absoluteGroupPath = this.resolveAbsolutePathOfGroup(parentGroup);
+        if (!absoluteGroupPath) {
+            (0, debug_1.debug)(`Failed to resolve path of group: ${parentGroup.id}`);
+            return undefined;
+        }
+        return path.join(absoluteGroupPath, fileRefPath);
+    }
+    /**
+     * Resolves the absolute path of a file reference relative to the built products directory.
+     *
+     * @param buildFile - The file reference to resolve the path of
+     * @returns The absolute path of the file reference, or undefined if the file reference is not found or has no path
+     */
+    resolveAbsoluteFilePathRelativeToBuiltProductsDir(buildFile) {
+        (0, debug_1.debug)(`Resolving absolute file path relative to built products directory for file reference: ${buildFile.id} with path: ${buildFile.obj.path ?? ''}`);
+        const builtProductsDir = this.getBuildProductsDirectoryPath();
+        if (!builtProductsDir) {
+            (0, debug_1.debug)(`Failed to resolve built products directory path`);
+            return undefined;
+        }
+        return path.join(builtProductsDir, buildFile.obj.path.replace(/"/g, ''));
+    }
+    /**
+     * Resolves the absolute path of a file reference relative to the source root.
+     *
+     * The source root is the directory where the `.xcodeproj` file is located.
+     *
+     * @param buildFile - The file reference to resolve the path of
+     * @returns The absolute path of the file reference, or undefined if the file reference is not found or has no path
+     */
+    resolveAbsoluteFilePathRelativeToSourceRoot(buildFile) {
+        return path.join(this.baseDir, buildFile.obj.path.replace(/"/g, ''));
+    }
+    /**
+     * Resolves the absolute path of a file reference relative to the SDK root.
+     *
+     * @param buildFile - The file reference to resolve the path of
+     * @returns The absolute path of the file reference, or undefined if the file reference is not found or has no path
+     */
+    resolveAbsoluteFilePathRelativeToSdkRoot(buildFile) {
+        (0, debug_1.debug)(`Resolving absolute file path relative to SDK root for file reference: ${buildFile.id} with path: ${buildFile.obj.path ?? ''}`);
+        const sdkRoot = macos_system_helper_1.MacOSSystemHelpers.findSDKRootDirectoryPath();
+        if (!sdkRoot) {
+            (0, debug_1.debug)(`Failed to resolve SDK root directory path`);
+            return undefined;
+        }
+        return path.join(sdkRoot, buildFile.obj.path.replace(/"/g, ''));
+    }
+    /**
+     * Resolves the absolute path of a file reference relative to the developer directory.
+     *
+     * @param buildFile - The file reference to resolve the path of
+     * @returns The absolute path of the file reference, or undefined if the file reference is not found or has no path
+     */
+    resolveAbsoluteFilePathRelativeToDeveloperDir(buildFile) {
+        (0, debug_1.debug)(`Resolving absolute file path relative to developer directory for file reference: ${buildFile.id} with path: ${buildFile.obj.path ?? ''}`);
+        const developerDir = macos_system_helper_1.MacOSSystemHelpers.findDeveloperDirectoryPath();
+        if (!developerDir) {
+            (0, debug_1.debug)(`Failed to resolve developer directory path`);
+            return undefined;
+        }
+        return path.join(developerDir, buildFile.obj.path.replace(/"/g, ''));
+    }
+    /**
+     * Resolves the absolute path of a group.
+     *
+     * @param group - The group to resolve the path of
+     * @returns The absolute path of the group, or undefined if the group is not found or has no path
+     */
+    resolveAbsolutePathOfGroup(group) {
+        (0, debug_1.debug)(`Resolving path of group: ${group.id} with path: ${group.obj.path ?? ''}`);
+        // Group paths are resolved based on the `sourceTree` property
+        // which can have one of the following values:
+        // - '<group>': The group path is relative to the parent group of the group
+        // - 'SOURCE_ROOT': The group path is relative to the source root, i.e. the directory where the Xcode project is located
+        // - 'BUILT_PRODUCTS_DIR': The group path is relative to the built products directory, i.e. the build output directory in derived data
+        // - 'SDKROOT': The group path is relative to the SDK root, i.e. the directory where the SDK is installed
+        // - 'DEVELOPER_DIR': The group path is relative to the developer directory, i.e. the directory where the Xcode command line tools are installed
+        // The default is '<group>'
+        const groupSourceTree = group.obj.sourceTree?.replace(/"/g, '') ?? '<group>';
+        switch (groupSourceTree) {
+            case '<group>':
+                return this.resolvePathOfGroupRelativeToGroup(group);
+            case 'SOURCE_ROOT':
+                return this.resolvePathOfGroupRelativeToSourceRoot(group);
+            case 'BUILT_PRODUCTS_DIR':
+                return this.resolvePathOfGroupRelativeToBuiltProductsDir(group);
+            case 'SDKROOT':
+                return this.resolvePathOfGroupRelativeToSdkRoot(group);
+            case 'DEVELOPER_DIR':
+                return this.resolvePathOfGroupRelativeToDeveloperDir(group);
+            default:
+                (0, debug_1.debug)(`Unknown source tree '${groupSourceTree}' for group: ${group.id}`);
+                return undefined;
+        }
+    }
+    /**
+     * Resolves the path of a group relative to the parent group.
+     *
+     * @param group - The group to resolve the path of
+     * @returns The path of the group relative to the parent group, or undefined if the group is not found or has no path
+     */
+    resolvePathOfGroupRelativeToGroup(group) {
+        const parentGroup = this.findParentGroupByChildId(group.id);
+        if (!parentGroup) {
+            (0, debug_1.debug)(`Parent group not found for group: ${group.id}`);
+            // If the parent group is not found, check if the group is the main group
+            // We assume the main group is at the root of the project
+            if (this.isMainGroup(group.id)) {
+                return this.baseDir;
+            }
+            return undefined;
+        }
+        const parentGroupPath = this.resolveAbsolutePathOfGroup(parentGroup);
+        if (!parentGroupPath) {
+            (0, debug_1.debug)(`Failed to resolve path of parent group: ${parentGroup.id}`);
+            return undefined;
+        }
+        const groupPath = group.obj.path?.replace(/"/g, '') ?? '';
+        if (!groupPath) {
+            (0, debug_1.debug)(`Group path not found for group: ${group.id}`);
+            return undefined;
+        }
+        return path.join(parentGroupPath, groupPath);
+    }
+    /**
+     * Resolves the path of a group relative to the source root.
+     *
+     * The source root is the directory where the `.xcodeproj` file is located.
+     *
+     * @param group - The group to resolve the path of
+     * @returns The path of the group relative to the source root, or undefined if the group is not found or has no path
+     */
+    resolvePathOfGroupRelativeToSourceRoot(group) {
+        const groupPath = group.obj.path?.replace(/"/g, '') ?? '';
+        if (!groupPath) {
+            (0, debug_1.debug)(`Group path not found for group: ${group.id}`);
+            return this.baseDir;
+        }
+        return path.join(this.baseDir, groupPath);
+    }
+    /**
+     * Resolves the path of a group relative to the built products directory.
+     *
+     * @param group - The group to resolve the path of
+     * @returns The path of the group relative to the built products directory, or undefined if the group is not found or has no path
+     */
+    resolvePathOfGroupRelativeToBuiltProductsDir(group) {
+        (0, debug_1.debug)(`Resolving path of group: ${group.id} relative to built products directory`);
+        const builtProductsDir = this.getBuildProductsDirectoryPath();
+        if (!builtProductsDir) {
+            (0, debug_1.debug)(`Failed to resolve built products directory path`);
+            return undefined;
+        }
+        return path.join(builtProductsDir, group.obj.path?.replace(/"/g, '') ?? '');
+    }
+    /**
+     * Resolves the path of a group relative to the SDK root.
+     *
+     * The SDK root is the directory where the SDK is installed.
+     *
+     * @param group - The group to resolve the path of
+     * @returns The path of the group relative to the SDK root, or undefined if the group is not found or has no path
+     */
+    resolvePathOfGroupRelativeToSdkRoot(group) {
+        (0, debug_1.debug)(`Resolving path of group: ${group.id} relative to SDK root`);
+        const sdkRoot = macos_system_helper_1.MacOSSystemHelpers.findSDKRootDirectoryPath();
+        if (!sdkRoot) {
+            (0, debug_1.debug)(`Failed to resolve SDK root directory path`);
+            return undefined;
+        }
+        return path.join(sdkRoot, group.obj.path?.replace(/"/g, '') ?? '');
+    }
+    /**
+     * Resolves the path of a group relative to the developer directory.
+     *
+     * The developer directory is the directory where the Xcode command line tools are installed.
+     *
+     * @param group - The group to resolve the path of
+     * @returns The path of the group relative to the developer directory, or undefined if the group is not found or has no path
+     */
+    resolvePathOfGroupRelativeToDeveloperDir(group) {
+        (0, debug_1.debug)(`Resolving path of group: ${group.id} relative to developer directory`);
+        const developerDir = macos_system_helper_1.MacOSSystemHelpers.findDeveloperDirectoryPath();
+        if (!developerDir) {
+            (0, debug_1.debug)(`Failed to resolve developer directory path`);
+            return undefined;
+        }
+        return path.join(developerDir, group.obj.path?.replace(/"/g, '') ?? '');
+    }
+    /**
+     * Resolves the absolute path of a group.
+     *
+     * @param group - The group to resolve the path of
+     * @returns The absolute path of the group, or undefined if the group is not found or has no path
+     */
+    resolveAbsolutePathOfSynchronizedRootGroup(group) {
+        (0, debug_1.debug)(`Resolving path of synchronized root group: ${group.id} with path: ${group.obj.path ?? ''}`);
+        // Group paths are resolved based on the `sourceTree` property
+        // which can have one of the following values:
+        // - '<group>': The group path is relative to the parent group of the group
+        // - 'SOURCE_ROOT': The group path is relative to the source root, i.e. the directory where the Xcode project is located
+        // - 'BUILT_PRODUCTS_DIR': The group path is relative to the built products directory, i.e. the build output directory in derived data
+        // - 'SDKROOT': The group path is relative to the SDK root, i.e. the directory where the SDK is installed
+        // - 'DEVELOPER_DIR': The group path is relative to the developer directory, i.e. the directory where the Xcode command line tools are installed
+        // The default is '<group>'
+        const groupSourceTree = group.obj.sourceTree?.replace(/"/g, '') ?? '<group>';
+        switch (groupSourceTree) {
+            case '<group>':
+                return this.resolvePathOfSynchronizedRootGroupRelativeToGroup(group);
+            case 'SOURCE_ROOT':
+                return this.resolvePathOfSynchronizedRootGroupRelativeToSourceRoot(group);
+            case 'BUILT_PRODUCTS_DIR':
+                return this.resolvePathOfSynchronizedRootGroupRelativeToBuiltProductsDir(group);
+            case 'SDKROOT':
+                return this.resolvePathOfSynchronizedRootGroupRelativeToSdkRoot(group);
+            case 'DEVELOPER_DIR':
+                return this.resolvePathOfSynchronizedRootGroupRelativeToDeveloperDir(group);
+            default:
+                (0, debug_1.debug)(`Unknown source tree '${groupSourceTree}' for group: ${group.id}`);
+                return undefined;
+        }
+    }
+    /**
+     * Resolves the path of a group relative to the parent group.
+     *
+     * @param group - The group to resolve the path of
+     * @returns The path of the group relative to the parent group, or undefined if the group is not found or has no path
+     */
+    resolvePathOfSynchronizedRootGroupRelativeToGroup(group) {
+        const parentGroup = this.findParentGroupByChildId(group.id);
+        if (!parentGroup) {
+            (0, debug_1.debug)(`Parent group not found for group: ${group.id}`);
+            // If the parent group is not found, check if the group is the main group
+            // We assume the main group is at the root of the project
+            if (this.isMainGroup(group.id)) {
+                return this.baseDir;
+            }
+            return undefined;
+        }
+        const parentGroupPath = this.resolveAbsolutePathOfGroup(parentGroup);
+        if (!parentGroupPath) {
+            (0, debug_1.debug)(`Failed to resolve path of parent group: ${parentGroup.id}`);
+            return undefined;
+        }
+        const groupPath = group.obj.path?.replace(/"/g, '') ?? '';
+        if (!groupPath) {
+            (0, debug_1.debug)(`Group path not found for group: ${group.id}`);
+            return undefined;
+        }
+        return path.join(parentGroupPath, groupPath);
+    }
+    /**
+     * Resolves the path of a group relative to the source root.
+     *
+     * The source root is the directory where the `.xcodeproj` file is located.
+     *
+     * @param group - The group to resolve the path of
+     * @returns The path of the group relative to the source root, or undefined if the group is not found or has no path
+     */
+    resolvePathOfSynchronizedRootGroupRelativeToSourceRoot(group) {
+        const groupPath = group.obj.path?.replace(/"/g, '') ?? '';
+        if (!groupPath) {
+            (0, debug_1.debug)(`Group path not found for group: ${group.id}`);
+            return this.baseDir;
+        }
+        return path.join(this.baseDir, groupPath);
+    }
+    /**
+     * Resolves the path of a group relative to the built products directory.
+     *
+     * @param group - The group to resolve the path of
+     * @returns The path of the group relative to the built products directory, or undefined if the group is not found or has no path
+     */
+    resolvePathOfSynchronizedRootGroupRelativeToBuiltProductsDir(group) {
+        (0, debug_1.debug)(`Resolving path of synchronized root group: ${group.id} relative to built products directory`);
+        const builtProductsDir = this.getBuildProductsDirectoryPath();
+        if (!builtProductsDir) {
+            (0, debug_1.debug)(`Failed to resolve built products directory path`);
+            return undefined;
+        }
+        return path.join(builtProductsDir, group.obj.path?.replace(/"/g, '') ?? '');
+    }
+    /**
+     * Resolves the path of a group relative to the SDK root.
+     *
+     * The SDK root is the directory where the SDK is installed.
+     *
+     * @param group - The group to resolve the path of
+     * @returns The path of the group relative to the SDK root, or undefined if the group is not found or has no path
+     */
+    resolvePathOfSynchronizedRootGroupRelativeToSdkRoot(group) {
+        (0, debug_1.debug)(`Resolving path of group: ${group.id} relative to SDK root`);
+        const sdkRoot = macos_system_helper_1.MacOSSystemHelpers.findSDKRootDirectoryPath();
+        if (!sdkRoot) {
+            (0, debug_1.debug)(`Failed to resolve SDK root directory path`);
+            return undefined;
+        }
+        return path.join(sdkRoot, group.obj.path?.replace(/"/g, '') ?? '');
+    }
+    /**
+     * Resolves the path of a group relative to the developer directory.
+     *
+     * The developer directory is the directory where the Xcode command line tools are installed.
+     *
+     * @param group - The group to resolve the path of
+     * @returns The path of the group relative to the developer directory, or undefined if the group is not found or has no path
+     */
+    resolvePathOfSynchronizedRootGroupRelativeToDeveloperDir(group) {
+        (0, debug_1.debug)(`Resolving path of synchronized root group: ${group.id} relative to developer directory`);
+        const developerDir = macos_system_helper_1.MacOSSystemHelpers.findDeveloperDirectoryPath();
+        if (!developerDir) {
+            (0, debug_1.debug)(`Failed to resolve developer directory path`);
+            return undefined;
+        }
+        return path.join(developerDir, group.obj.path?.replace(/"/g, '') ?? '');
+    }
+    /**
+     * Finds all files in the synchronized root groups of a target.
+     *
+     * @param nativeTarget - The target to find the files in
+     * @returns The files in the synchronized root groups of the target, or an empty array if the target is not found or has no synchronized root groups
+     */
+    findFilesInSynchronizedRootGroups(nativeTarget) {
+        (0, debug_1.debug)(`Finding files in synchronized root groups for target: ${nativeTarget.obj.name}`);
+        const synchronizedRootGroups = nativeTarget.obj.fileSystemSynchronizedGroups ?? [];
+        const result = [];
+        for (const group of synchronizedRootGroups) {
+            const groupObj = this.objects.PBXFileSystemSynchronizedRootGroup?.[group.value];
+            if (!groupObj || typeof groupObj !== 'object') {
+                (0, debug_1.debug)(`Synchronized root group not found: ${group.value}`);
+                continue;
+            }
+            (0, debug_1.debug)(`Found synchronized root group: ${group.value}`);
+            const files = this.getFilesInSynchronizedRootGroup({
+                id: group.value,
+                obj: groupObj,
+            });
+            (0, debug_1.debug)(`Found ${files.length} files in synchronized root group: ${group.value}`);
+            result.push(...files.map((file) => file.path));
+        }
+        (0, debug_1.debug)(`Found ${result.length} files in synchronized root groups for target: ${nativeTarget.obj.name}`);
+        return result;
+    }
+    getFilesInSynchronizedRootGroup(group) {
+        // Group path is expected to be set, therefore typing is non-nullable.
+        // As the group is loaded from a project file, it is not guaranteed to be set,
+        // therefore we treat it as optional.
+        if (!group.obj.path) {
+            (0, debug_1.debug)(`Group path not found for group: ${group.id}`);
+            return [];
+        }
+        // Resolve the path of the synchronized root group
+        const absoluteGroupPath = this.resolveAbsolutePathOfSynchronizedRootGroup(group);
+        if (!absoluteGroupPath) {
+            (0, debug_1.debug)(`Failed to resolve path of synchronized root group: ${group.id}`);
+            return [];
+        }
+        // Build a list of all exception paths for the group
+        const exceptionSets = this.getExceptionSetsForGroup(group);
+        // Resolve a list of all files in the group
+        const files = this.getAbsoluteFilePathsInDirectoryTree(absoluteGroupPath);
+        // Filter out files that are excluded by the exception sets
+        const filteredFiles = this.filterFilesByExceptionSets(files, exceptionSets);
+        return filteredFiles;
+    }
+    /**
+     * Returns all files in a directory tree.
+     *
+     * @param dirPath - The path of the directory to get the files in
+     * @returns All files in the directory tree, or an empty array if the directory does not exist
+     */
+    getAbsoluteFilePathsInDirectoryTree(dirPath) {
+        // If the directory does not exist, return an empty array
+        // This can happen if the group is not found in the project
+        if (!fs.existsSync(dirPath)) {
+            return [];
+        }
+        const result = [];
+        const files = fs.readdirSync(dirPath);
+        for (const file of files) {
+            // Ignore hidden files and directories
+            if (file.startsWith('.')) {
+                continue;
+            }
+            const filePath = path.join(dirPath, file);
+            // If the file is a directory, recursively get the files in the directory
+            if (fs.statSync(filePath).isDirectory()) {
+                result.push(...this.getAbsoluteFilePathsInDirectoryTree(filePath));
+                continue;
+            }
+            // If the file is a file, add it to the result
+            if (fs.statSync(filePath).isFile()) {
                 result.push({
-                    key: child.value,
-                    path: `${path}${fileReference.path.replace(/"/g, '')}`,
+                    name: file,
+                    path: filePath,
                 });
-            }
-            else if (groupReference) {
-                if (typeof groupReference === 'string') {
-                    continue;
-                }
-                const groupChildren = this.buildGroup(groupReference, groupReference.path
-                    ? `${path}${groupReference.path.replace(/"/g, '')}/`
-                    : path);
-                result.push(...groupChildren);
+                continue;
             }
         }
         return result;
     }
+    filterFilesByExceptionSets(files, exceptionSets) {
+        // Iterate over all files and filter out files that are excluded by any exception sets
+        return files.filter((file) => {
+            return !exceptionSets.some((exceptionSet) => {
+                const membershipExceptions = exceptionSet.obj.membershipExceptions ?? [];
+                return membershipExceptions.some((path) => {
+                    const unescapedPath = path.replace(/"/g, '');
+                    return file.path.includes(unescapedPath);
+                });
+            });
+        });
+    }
+    // ================================ GROUP HELPERS ================================
+    /**
+     * Returns all groups that are PBXGroup.
+     *
+     * This is a helper method to avoid having to map and filter the groups manually.
+     *
+     * @returns All groups that are PBXGroup, excluding comments and non-object values.
+     */
+    get groups() {
+        // Map and filter the groups to only include the groups that are PBXGroup
+        return Object.entries(this.objects.PBXGroup ?? {}).reduce((acc, [key, group]) => {
+            if (typeof group !== 'object') {
+                return acc;
+            }
+            return acc.concat([
+                {
+                    id: key,
+                    obj: group,
+                },
+            ]);
+        }, new Array());
+    }
+    /**
+     * Finds the parent group of a child group or file reference.
+     *
+     * @param childId - The ID of the child group or file reference
+     * @returns The parent group of the child group or file reference, or undefined if the child group or file reference is not found or has no parent group
+     */
+    findParentGroupByChildId(childId) {
+        return this.groups.find((group) => {
+            return (group.obj.children ?? []).some((child) => {
+                return child.value === childId;
+            });
+        });
+    }
+    /**
+     * Checks if a group is the main group of any project.
+     *
+     * @param groupId - The ID of the group to check
+     * @returns True if the group is the main group, false otherwise
+     */
+    isMainGroup(groupId) {
+        return Object.values(this.objects.PBXProject ?? {}).some((project) => {
+            if (typeof project !== 'object') {
+                return false;
+            }
+            return project.mainGroup === groupId;
+        });
+    }
+    getExceptionSetsForGroup(group) {
+        const exceptions = group.obj.exceptions ?? [];
+        const exceptionSets = [];
+        for (const exception of exceptions) {
+            const exceptionSet = this.objects.PBXFileSystemSynchronizedBuildFileExceptionSet?.[exception.value];
+            if (typeof exceptionSet !== 'object') {
+                continue;
+            }
+            exceptionSets.push({
+                id: exception.value,
+                obj: exceptionSet,
+                comment: exception.comment,
+            });
+        }
+        return exceptionSets;
+    }
+    /**
+     * The path to the build products directory for the project.
+     *
+     * This is cached to avoid having to read the build settings from Xcode for each call to `getBuildProductsDirectoryPath`.
+     */
+    buildProductsDir;
+    /**
+     * Returns the path to the build products directory for the project.
+     *
+     * @returns The path to the build products directory for the project, or undefined if the path is not found
+     */
+    getBuildProductsDirectoryPath() {
+        if (this.buildProductsDir) {
+            return this.buildProductsDir;
+        }
+        const buildSettings = macos_system_helper_1.MacOSSystemHelpers.readXcodeBuildSettings(this.xcodeprojPath);
+        if (!buildSettings) {
+            (0, debug_1.debug)(`Failed to read Xcode build settings`);
+            return undefined;
+        }
+        this.buildProductsDir =
+            buildSettings['TARGET_BUILD_DIR'] ?? buildSettings['BUILD_DIR'];
+        return this.buildProductsDir;
+    }
 }
 exports.XcodeProject = XcodeProject;
 //# sourceMappingURL=xcode-manager.js.map