Add SourceArchiver that uses tar command

Author: mattt

Sources/PackageRegistry/CMakeLists.txt

@@ -9,7 +9,8 @@
 add_library(PackageRegistry
   Registry.swift
   RegistryConfiguration.swift
-  RegistryManager.swift)
+  RegistryManager.swift
+  SourceArchiver.swift)
 target_link_libraries(PackageRegistry PUBLIC
   TSCBasic
   PackageLoading

Sources/PackageRegistry/RegistryManager.swift

@@ -33,7 +33,7 @@ public enum RegistryError: Error {
 
 public final class RegistryManager {
     internal static var archiverFactory: (FileSystem) -> Archiver = { fileSystem in
-        return ZipInPlaceArchiver(fileSystem: fileSystem)
+        return SourceArchiver(fileSystem: fileSystem)
     }
 
     private static let sharedClient: HTTPClientProtocol = HTTPClient()
@@ -295,48 +295,3 @@ private extension URLComponents {
         path += (path.last == "/" ? "" : "/") + components.joined(separator: "/")
     }
 }
-
-// FIXME: Update existing archiver to support `-j` argument
-private struct ZipInPlaceArchiver: Archiver {
-    public var supportedExtensions: Set<String> { ["zip"] }
-
-    /// The file-system implementation used for various file-system operations and checks.
-    private let fileSystem: FileSystem
-
-    /// Creates a `ZipArchiver`.
-    ///
-    /// - Parameters:
-    ///   - fileSystem: The file-system to used by the `ZipArchiver`.
-    public init(fileSystem: FileSystem = localFileSystem) {
-        self.fileSystem = fileSystem
-    }
-
-    public func extract(
-        from archivePath: AbsolutePath,
-        to destinationPath: AbsolutePath,
-        completion: @escaping (Result<Void, Error>) -> Void
-    ) {
-        guard fileSystem.exists(archivePath) else {
-            completion(.failure(FileSystemError(.noEntry, archivePath)))
-            return
-        }
-
-        guard fileSystem.isDirectory(destinationPath) else {
-            completion(.failure(FileSystemError(.notDirectory, destinationPath)))
-            return
-        }
-
-        DispatchQueue.global(qos: .userInitiated).async {
-            do {
-                let result = try Process.popen(args: "unzip", "-j", archivePath.pathString, "-d", destinationPath.pathString)
-                guard result.exitStatus == .terminated(code: 0) else {
-                    throw try StringError(result.utf8stderrOutput())
-                }
-
-                completion(.success(()))
-            } catch {
-                completion(.failure(error))
-            }
-        }
-    }
-}

Sources/PackageRegistry/SourceArchiver.swift

@@ -0,0 +1,72 @@
+/*
+ This source file is part of the Swift.org open source project
+
+ Copyright (c) 2021 Apple Inc. and the Swift project authors
+ Licensed under Apache License v2.0 with Runtime Library Exception
+
+ See http://swift.org/LICENSE.txt for license information
+ See http://swift.org/CONTRIBUTORS.txt for Swift project authors
+ */
+
+import Basics
+import TSCBasic
+import TSCUtility
+
+import Dispatch
+
+/// An `Archiver` that handles source archives.
+///
+/// Source archives created with `swift package archive-source`
+/// have a top-level directory prefix (for example, `LinkedList-1.1.1/`).
+/// Unfortunately, the `unzip` command used by `ZipArchiver` doesn't have an option for
+/// ignoring this top-level prefix.
+/// Rather than performing additional (possibly unsafe) file system operations,
+/// this `Archiver` delegates to `tar`, which has a built-in `--strip-components=` option.
+struct SourceArchiver: Archiver {
+    public var supportedExtensions: Set<String> { ["zip"] }
+
+    /// The file-system implementation used for various file-system operations and checks.
+    private let fileSystem: FileSystem
+
+    /// Creates a `SourceArchiver`.
+    ///
+    /// - Parameters:
+    ///   - fileSystem: The file-system to used by the `SourceArchiver`.
+    public init(fileSystem: FileSystem = localFileSystem) {
+        self.fileSystem = fileSystem
+    }
+
+    public func extract(
+        from archivePath: AbsolutePath,
+        to destinationPath: AbsolutePath,
+        completion: @escaping (Result<Void, Error>) -> Void
+    ) {
+        guard fileSystem.exists(archivePath) else {
+            completion(.failure(FileSystemError(.noEntry, archivePath)))
+            return
+        }
+
+        guard fileSystem.isDirectory(destinationPath) else {
+            completion(.failure(FileSystemError(.notDirectory, destinationPath)))
+            return
+        }
+
+        // TODO: consider calling `libarchive` or some other library directly instead of spawning a process
+        DispatchQueue.global(qos: .userInitiated).async {
+            do {
+                let result = try Process.popen(args: "bsdtar",
+                                                     "--strip-components=1",
+                                                     "-xvf",
+                                                     archivePath.pathString,
+                                                     "-C", destinationPath.pathString)
+                guard result.exitStatus == .terminated(code: 0) else {
+                    throw try StringError(result.utf8stderrOutput())
+                }
+
+                completion(.success(()))
+            } catch {
+                completion(.failure(error))
+            }
+        }
+    }
+}