Remove support for cached zip builds. (#3574)

ryanwilson · web-flow · commit 937a73649744 · 2019-08-23T15:03:13.000-04:00
* Remove support for cached zip builds.

This never really worked that well, and isn't used since we're now
building the zip file on Kokoro. Quick iterations can be handled with
changing the `podsToInstall` variable leaving this code outdated and
unnecessary.

* Remove unnecessary initializer.
diff --git a/ZipBuilder/Sources/ZipBuilder/CocoaPodUtils.swift b/ZipBuilder/Sources/ZipBuilder/CocoaPodUtils.swift
@@ -31,17 +31,6 @@ public enum CocoaPodUtils {
 
     /// The location of the pod on disk.
     var installedLocation: URL
-
-    /// A key that can be generated and used for identifying pods due to binary differences.
-    var cacheKey: String?
-
-    /// Default initializer. Explicitly declared to take advantage of default arguments.
-    init(name: String, version: String, installedLocation: URL, cacheKey: String? = nil) {
-      self.name = name
-      self.version = version
-      self.installedLocation = installedLocation
-      self.cacheKey = cacheKey
-    }
   }
 
   /// Executes the `pod cache clean --all` command to remove any cached CocoaPods.
@@ -97,14 +86,9 @@ public enum CocoaPodUtils {
           "information for installed Pods.")
       }
 
-      // Generate the cache key for this framework. We will use the list of subspecs used in the Pod
-      // to generate this, since a Pod like GoogleUtilities could build different sources based on
-      // what subspecs are included.
-      let cacheKey = self.cacheKey(forPod: podName, fromPodfileLock: podfileLock)
       let podInfo = PodInfo(name: podName,
                             version: version,
-                            installedLocation: podDir,
-                            cacheKey: cacheKey)
+                            installedLocation: podDir)
       installedPods.append(podInfo)
     }
 
@@ -228,73 +212,6 @@ public enum CocoaPodUtils {
     return (framework, version)
   }
 
-  /// Generates a key representing the unique combination of all subspecs used for that Pod. This is
-  /// necessary for Pods like GoogleUtilities, where we will need to include all subspecs as part of
-  /// a build. Otherwise we could accidentally use a cached framework that doesn't include all the
-  /// code necessary to function.
-  ///
-  /// - Parameters:
-  ///   - framework: The framework being built.
-  ///   - podfileLock: The contents of the Podfile.lock for the project.
-  /// - Returns: A key to describe the full set of subspecs used to build the framework, or an empty
-  ///            String if there were no specific subspecs used.
-  private static func cacheKey(forPod podName: String,
-                               fromPodfileLock podfileLock: String) -> String? {
-    // Ignore the umbrella Firebase pod, cacheing doesn't make sense.
-    guard podName != "Firebase" else { return nil }
-
-    // Get the first section of the Podfile containing only Pods installed, the only thing we care
-    // about.
-    guard let podsInstalled = podfileLock.components(separatedBy: "DEPENDENCIES:").first else {
-      fatalError("""
-      Could not generate cache key for \(podName) from Podfile.lock contents - is this a valid
-      Podfile.lock?
-      ---------- Podfile.lock contents ----------
-      \(podfileLock)
-      -------------------------------------------
-      """)
-    }
-
-    // Only get the lines that start with "  - ", and have the framework we're looking for since
-    // they are the top level pods that are installed.
-    // Example result of a single line: `- GoogleUtilities/Environment (~> 5.2)`.
-    let lines = podsInstalled.components(separatedBy: .newlines).filter {
-      $0.hasPrefix("  - ") && $0.contains(podName)
-    }
-
-    // Get a list of all the subspecs used to build this framework, and use that to generate the
-    // cache key.
-    var uniqueSubspecs = Set<String>()
-    for line in lines.sorted() {
-      // Separate the line into readable chunks, using a space and quote as a separator.
-      // Example result: `["-", "GoogleUtilities/Environment", "(~>", "5.2)"]`.
-      let components = line.components(separatedBy: CharacterSet(charactersIn: " \""))
-
-      // The Pod and subspec will be the only variables we care about, filter out the rest.
-      // Example result: 'GoogleUtilities/Environment' or `FirebaseCore`. Only Pods with a subspec
-      // should be included here, which are always in the format of `PodName/SubspecName`.
-      guard let fullPodName = components.filter({ $0.contains("\(podName)/") }).first else {
-        continue
-      }
-
-      // The fullPodName will be something like `GoogleUtilities/UserDefaults`, get the subspec
-      // name.
-      let subspec = fullPodName.replacingOccurrences(of: "\(podName)/", with: "")
-      if !subspec.isEmpty {
-        uniqueSubspecs.insert(subspec)
-      }
-    }
-
-    // Return nil if there are no subpsecs used, since no cache key is necessary.
-    guard !uniqueSubspecs.isEmpty else {
-      return nil
-    }
-
-    // Assemble the cache key based on the framework name, and all subspecs (sorted alphabetically
-    // for repeatability) separated by a `+` (as was previously used).
-    return podName + "+" + uniqueSubspecs.sorted().joined(separator: "+")
-  }
-
   /// Create the contents of a Podfile for an array of subspecs. This assumes the array of subspecs
   /// is not empty.
   private static func generatePodfile(for pods: [CocoaPod],
diff --git a/ZipBuilder/Sources/ZipBuilder/FrameworkBuilder.swift b/ZipBuilder/Sources/ZipBuilder/FrameworkBuilder.swift
@@ -76,78 +76,43 @@ struct FrameworkBuilder {
   /// - Parameters:
   ///   - framework: The name of the Framework being built.
   ///   - version: String representation of the version.
-  ///   - cacheKey: The key used for caching this framework build. If nil, the framework name will
-  ///               be used.
-  ///   - cacheEnabled: Flag for enabling the cache. Defaults to false.
   /// - Parameter logsOutputDir: The path to the directory to place build logs.
   /// - Returns: A URL to the framework that was built (or pulled from the cache).
   public func buildFramework(withName podName: String,
                              version: String,
-                             cacheKey: String?,
-                             cacheEnabled: Bool = false,
                              logsOutputDir: URL? = nil) -> URL {
     print("Building \(podName)")
 
-//  Cache is temporarily disabled due to pod cache list issues.
-    // Get the CocoaPods cache to see if we can pull from any frameworks already built.
-//    let podsCache = CocoaPodUtils.listPodCache(inDir: projectDir)
-//
-//    guard let cachedVersions = podsCache[podName] else {
-//      fatalError("Cannot find a pod cache for framework \(podName).")
-//    }
-//
-//    guard let podInfo = cachedVersions[version] else {
-//      fatalError("""
-//      Cannot find a pod cache for framework \(podName) at version \(version).
-//      Something could be wrong with your CocoaPods cache - try running the following:
-//
-//      pod cache clean '\(podName)' --all
-//      """)
-//    }
-//
-//    // TODO: Figure out if we need the MD5 at all.
-    let md5 = podName
-//    let md5 = Shell.calculateMD5(for: podInfo.installedLocation)
-
     // Get (or create) the cache directory for storing built frameworks.
     let fileManager = FileManager.default
     var cachedFrameworkRoot: URL
     do {
       let cacheDir = try fileManager.firebaseCacheDirectory()
-      cachedFrameworkRoot = cacheDir.appendingPathComponents([podName, version, md5])
-      if let cacheKey = cacheKey {
-        cachedFrameworkRoot.appendPathComponent(cacheKey)
-      }
+      cachedFrameworkRoot = cacheDir.appendingPathComponents([podName, version])
     } catch {
       fatalError("Could not create caches directory for building frameworks: \(error)")
     }
 
     // Build the full cached framework path.
     let cachedFrameworkDir = cachedFrameworkRoot.appendingPathComponent("\(podName).framework")
-    let cachedFrameworkExists = fileManager.directoryExists(at: cachedFrameworkDir)
-    if cachedFrameworkExists, cacheEnabled {
-      print("Framework \(podName) version \(version) has already been built and cached at " +
-        "\(cachedFrameworkDir)")
-      return cachedFrameworkDir
-    } else {
-      let frameworkDir = compileFrameworkAndResources(withName: podName)
-      do {
-        // Remove the previously cached framework, if it exists, otherwise the `moveItem` call will
-        // fail.
-        if cachedFrameworkExists {
-          try fileManager.removeItem(at: cachedFrameworkDir)
-        } else if !fileManager.directoryExists(at: cachedFrameworkRoot) {
-          // If the root directory doesn't exist, create it so the `moveItem` will succeed.
-          try fileManager.createDirectory(at: cachedFrameworkRoot,
-                                          withIntermediateDirectories: true)
-        }
-
-        // Move the newly built framework to the cache directory.
-        try fileManager.moveItem(at: frameworkDir, to: cachedFrameworkDir)
-        return cachedFrameworkDir
-      } catch {
-        fatalError("Could not move built frameworks into the cached frameworks directory: \(error)")
+    let frameworkDir = compileFrameworkAndResources(withName: podName)
+    do {
+      // Remove the previously cached framework if it exists, otherwise the `moveItem` call will
+      // fail.
+      fileManager.removeDirectoryIfExists(at: cachedFrameworkDir)
+
+      // Create the root cache directory if it doesn't exist.
+      if !fileManager.directoryExists(at: cachedFrameworkRoot) {
+        // If the root directory doesn't exist, create it so the `moveItem` will succeed.
+        try fileManager.createDirectory(at: cachedFrameworkRoot,
+                                        withIntermediateDirectories: true)
       }
+
+      // Move the newly built framework to the cache directory.
+      try fileManager.moveItem(at: frameworkDir, to: cachedFrameworkDir)
+      return cachedFrameworkDir
+    } catch {
+      fatalError("Could not move built frameworks into the cached frameworks directory: \(error)")
     }
   }
 
diff --git a/ZipBuilder/Sources/ZipBuilder/LaunchArgs.swift b/ZipBuilder/Sources/ZipBuilder/LaunchArgs.swift
@@ -39,10 +39,8 @@ extension FileManager: FileChecker {}
 struct LaunchArgs {
   /// Keys associated with the launch args. See `Usage` for descriptions of each flag.
   private enum Key: String, CaseIterable {
-    case cacheEnabled
     case carthageDir
     case customSpecRepos
-    case deleteCache
     case existingVersions
     case outputDir
     case releasingSDKs
@@ -53,16 +51,11 @@ struct LaunchArgs {
     /// Usage description for the key.
     var usage: String {
       switch self {
-      case .cacheEnabled:
-        return "A flag to control using the cache for frameworks."
       case .carthageDir:
         return "The directory pointing to all Carthage JSON manifests. Passing this flag enables" +
           "the Carthage build."
       case .customSpecRepos:
         return "A comma separated list of custom CocoaPod Spec repos."
-      case .deleteCache:
-        return "A flag to empty the cache. Note: if this flag and the `cacheEnabled` flag is " +
-          "set, it will fail since that's probably unintended."
       case .existingVersions:
         return "The file path to a textproto file containing the existing released SDK versions, " +
           "of type `ZipBuilder_FirebaseSDKs`."
@@ -106,12 +99,6 @@ struct LaunchArgs {
   /// based frameworks.
   let templateDir: URL
 
-  /// A flag to control using the cache for frameworks.
-  let cacheEnabled: Bool
-
-  /// A flag to delete the cache from the cache directory.
-  let deleteCache: Bool
-
   /// The release candidate number, zero indexed.
   let rcNumber: Int?
 
@@ -233,16 +220,6 @@ struct LaunchArgs {
     }
 
     updatePodRepo = defaults.bool(forKey: Key.updatePodRepo.rawValue)
-
-    // Parse the cache keys. If no value is provided for each, it defaults to `false`.
-    cacheEnabled = defaults.bool(forKey: Key.cacheEnabled.rawValue)
-    deleteCache = defaults.bool(forKey: Key.deleteCache.rawValue)
-
-    if deleteCache, cacheEnabled {
-      LaunchArgs.exitWithUsageAndLog("Invalid pair - attempted to delete the cache and enable " +
-        "it at the same time. Please remove on of the keys and try " +
-        "again.")
-    }
   }
 
   /// Prints an error that occurred, the proper usage String, and quits the application.
diff --git a/ZipBuilder/Sources/ZipBuilder/ZipBuilder.swift b/ZipBuilder/Sources/ZipBuilder/ZipBuilder.swift
@@ -115,22 +115,15 @@ struct ZipBuilder {
   /// Paths needed throughout the process of packaging the Zip file.
   private let paths: FilesystemPaths
 
-  /// Determines if the cache should be used or not.
-  private let useCache: Bool
-
   /// Default initializer. If allSDKsPath and currentReleasePath are provided, it will also verify
   /// that the
   ///
   /// - Parameters:
   ///   - paths: Paths that are needed throughout the process of packaging the Zip file.
   ///   - customSpecRepo: A custom spec repo to be used for fetching CocoaPods from.
-  ///   - useCache: Enables or disables the cache.
-  init(paths: FilesystemPaths,
-       customSpecRepos: [URL]? = nil,
-       useCache: Bool = false) {
+  init(paths: FilesystemPaths, customSpecRepos: [URL]? = nil) {
     self.paths = paths
     self.customSpecRepos = customSpecRepos
-    self.useCache = useCache
   }
 
   // TODO: This function contains a lot of "copy these paths to this directory, fail if there are
@@ -183,8 +176,8 @@ struct ZipBuilder {
       fatalError("Could not get contents of the README template: \(error)")
     }
 
-    // Break the `podsToInstall` into a variable since it's helpful when debugging non-cache builds
-    // to just install a subset of pods, like the following line:
+    // Break the `podsToInstall` into a variable since it's helpful when debugging builds to just
+    // install a subset of pods, like the following line:
 //    let podsToInstall: [CocoaPod] = [.core, .analytics, .storage]
     let podsToInstall = CocoaPod.allCases
 
@@ -219,9 +212,7 @@ struct ZipBuilder {
 
     // Generate the frameworks. Each key is the pod name and the URLs are all frameworks to be
     // copied in each product's directory.
-    let frameworks = generateFrameworks(fromPods: installedPods,
-                                        inProjectDir: projectDir,
-                                        useCache: useCache)
+    let frameworks = generateFrameworks(fromPods: installedPods, inProjectDir: projectDir)
 
     for (framework, paths) in frameworks {
       print("Frameworks for pod: \(framework) were compiled at \(paths)")
@@ -683,7 +674,6 @@ struct ZipBuilder {
   /// .framework file already).
   private func generateFrameworks(fromPods pods: [CocoaPodUtils.PodInfo],
                                   inProjectDir projectDir: URL,
-                                  useCache: Bool = false,
                                   carthageBuild: Bool = false) -> [String: [URL]] {
     // Verify the Pods folder exists and we can get the contents of it.
     let fileManager = FileManager.default
@@ -730,8 +720,6 @@ struct ZipBuilder {
         let builder = FrameworkBuilder(projectDir: projectDir)
         let framework = builder.buildFramework(withName: pod.name,
                                                version: pod.version,
-                                               cacheKey: pod.cacheKey,
-                                               cacheEnabled: useCache,
                                                logsOutputDir: paths.logsOutputDir)
 
         frameworks = [framework]
diff --git a/ZipBuilder/Sources/ZipBuilder/main.swift b/ZipBuilder/Sources/ZipBuilder/main.swift
@@ -16,19 +16,17 @@
 
 import Foundation
 
+// Delete the cache directory, if it exists.
+do {
+  let cacheDir = try FileManager.default.firebaseCacheDirectory()
+  FileManager.default.removeDirectoryIfExists(at: cacheDir)
+} catch {
+  fatalError("Could not remove the cache before packaging the release: \(error)")
+}
+
 // Get the launch arguments, parsed by user defaults.
 let args = LaunchArgs()
 
-// Clear the cache if requested.
-if args.deleteCache {
-  do {
-    let cacheDir = try FileManager.default.firebaseCacheDirectory()
-    try FileManager.default.removeItem(at: cacheDir)
-  } catch {
-    fatalError("Could not empty the cache before building the zip file: \(error)")
-  }
-}
-
 // Keep timing for how long it takes to build the zip file for information purposes.
 let buildStart = Date()
 var cocoaPodsUpdateMessage: String = ""
@@ -43,9 +41,7 @@ var paths = ZipBuilder.FilesystemPaths(templateDir: args.templateDir)
 paths.allSDKsPath = args.allSDKsPath
 paths.currentReleasePath = args.currentReleasePath
 paths.logsOutputDir = args.outputDir?.appendingPathComponent("build_logs")
-let builder = ZipBuilder(paths: paths,
-                         customSpecRepos: args.customSpecRepos,
-                         useCache: args.cacheEnabled)
+let builder = ZipBuilder(paths: paths, customSpecRepos: args.customSpecRepos)
 
 do {
   // Build the zip file and get the path.
