fix: ACI-2805 Always overwrite symlinks

Author: zsolt-marta-bitrise

cmd/restoreXcodeDerivedDataFiles.go

@@ -156,14 +156,14 @@ func restoreXcodeDerivedDataFilesCmdFn(ctx context.Context, authConfig common.Ca
 
 	if len(metadata.ProjectFiles.Symlinks) > 0 {
 		logger.TInfof("Restoring project symlinks")
-		if _, err = xcode.RestoreSymlinks(metadata.ProjectFiles.Symlinks, forceOverwrite, logger); err != nil {
+		if _, err = xcode.RestoreSymlinks(metadata.ProjectFiles.Symlinks, logger); err != nil {
 			return op, fmt.Errorf("restore project symlink: %w", err)
 		}
 	}
 
 	if len(metadata.DerivedData.Symlinks) > 0 {
 		logger.TInfof("Restoring DerivedData symlinks")
-		if _, err = xcode.RestoreSymlinks(metadata.DerivedData.Symlinks, forceOverwrite, logger); err != nil {
+		if _, err = xcode.RestoreSymlinks(metadata.DerivedData.Symlinks, logger); err != nil {
 			return op, fmt.Errorf("restore DerivedData symlink: %w", err)
 		}
 	}
@@ -182,7 +182,7 @@ func restoreXcodeDerivedDataFilesCmdFn(ctx context.Context, authConfig common.Ca
 
 	if len(metadata.XcodeCacheDir.Symlinks) > 0 {
 		logger.TInfof("Restoring Xcode cache symlinks")
-		if _, err = xcode.RestoreSymlinks(metadata.XcodeCacheDir.Symlinks, forceOverwrite, logger); err != nil {
+		if _, err = xcode.RestoreSymlinks(metadata.XcodeCacheDir.Symlinks, logger); err != nil {
 			return op, fmt.Errorf("restore xcode symlink: %w", err)
 		}
 	}
@@ -255,7 +255,7 @@ func logCacheMetadata(md *xcode.Metadata, logger log.Logger, isDebugLogMode bool
 	logger.Infof("  Git commit: %s", md.GitCommit)
 	logger.Infof("  Git branch: %s", md.GitBranch)
 	logger.Infof("  Project files: %d", len(md.ProjectFiles.Files))
-	logger.Infof("  Project sylinks: %d", len(md.ProjectFiles.Symlinks))
+	logger.Infof("  Project symlinks: %d", len(md.ProjectFiles.Symlinks))
 	logger.Infof("  DerivedData files: %d", len(md.DerivedData.Files))
 	logger.Infof("  DerivedData symlinks: %d", len(md.DerivedData.Symlinks))
 	logger.Infof("  Xcode cache files: %d", len(md.XcodeCacheDir.Files))

cmd/saveXcodeDerivedDataFiles.go

@@ -98,7 +98,7 @@ func init() {
 		panic(err)
 	}
 	saveXcodeDerivedDataFilesCmd.Flags().String("xcodecache-path", "", "Path to the Xcode cache directory folder to be saved. If not set, it will not be uploaded.")
-	saveXcodeDerivedDataFilesCmd.Flags().Bool("follow-symlinks", false, "Follow symlinks when calculating metadata (default: false)")
+	saveXcodeDerivedDataFilesCmd.Flags().Bool("follow-symlinks", false, "Follow symlinks when calculating metadata and save referenced files to the cache (default: false)")
 }
 
 func saveXcodeDerivedDataFilesCmdFn(ctx context.Context,

internal/xcode/file_group_info.go

@@ -286,14 +286,10 @@ func setAttributes(path string, attributes map[string]string) error {
 	return nil
 }
 
-func restoreSymlink(symlink SymlinkInfo, forceOverwrite bool, logger log.Logger) bool {
+func restoreSymlink(symlink SymlinkInfo, logger log.Logger) bool {
 	fileInfo, err := os.Lstat(symlink.Path)
 	if err == nil && fileInfo.Mode()&os.ModeSymlink != 0 {
-		if !forceOverwrite {
-			logger.Debugf("Symlink %s already exists", symlink.Path)
-
-			return false
-		}
+		logger.Debugf("Symlink %s already exists, overwriting...", symlink.Path)
 
 		err := os.Remove(symlink.Path)
 		if err != nil {

internal/xcode/metadata.go

@@ -143,13 +143,13 @@ func RestoreDirectoryInfos(dirInfos []*DirectoryInfo, rootDir string, logger log
 	return nil
 }
 
-func RestoreSymlinks(symlinks []*SymlinkInfo, forceOverwrite bool, logger log.Logger) (int, error) {
+func RestoreSymlinks(symlinks []*SymlinkInfo, logger log.Logger) (int, error) {
 	updated := 0
 
 	logger.Infof("(i) %d symlinks' info loaded from cache metadata", len(symlinks))
 
 	for _, si := range symlinks {
-		if restoreSymlink(*si, forceOverwrite, logger) {
+		if restoreSymlink(*si, logger) {
 			updated++
 		}
 	}