Create typealias AppID = UInt64.

Use `AppID` everywhere appropriate.

Associated appID cleanup.

Partial #478

Signed-off-by: Ross Goldberg <484615+rgoldberg@users.noreply.github.com>

Sources/mas/AppStore/Downloader.swift

@@ -17,7 +17,7 @@ import StoreFoundation
 /// Only works for free apps. Defaults to false.
 /// - Returns: A promise that completes when the downloads are complete. If any fail,
 /// the promise is rejected with the first error, after all remaining downloads are attempted.
-func downloadAll(_ appIDs: [UInt64], purchase: Bool = false) -> Promise<Void> {
+func downloadAll(_ appIDs: [AppID], purchase: Bool = false) -> Promise<Void> {
     var firstError: Error?
     return appIDs.reduce(Guarantee<Void>.value(())) { previous, appID in
         previous.then {
@@ -34,7 +34,7 @@ func downloadAll(_ appIDs: [UInt64], purchase: Bool = false) -> Promise<Void> {
     }
 }
 
-private func downloadWithRetries(_ appID: UInt64, purchase: Bool = false, attempts: Int = 3) -> Promise<Void> {
+private func downloadWithRetries(_ appID: AppID, purchase: Bool = false, attempts: Int = 3) -> Promise<Void> {
     SSPurchase().perform(adamId: appID, purchase: purchase)
         .recover { error -> Promise<Void> in
             guard attempts > 1 else {

Sources/mas/AppStore/SSPurchase.swift

@@ -11,7 +11,7 @@ import PromiseKit
 import StoreFoundation
 
 extension SSPurchase {
-    func perform(adamId: UInt64, purchase: Bool) -> Promise<Void> {
+    func perform(adamId: AppID, purchase: Bool) -> Promise<Void> {
         var parameters: [String: Any] = [
             "productType": "C",
             "price": 0,

Sources/mas/Commands/Home.swift

@@ -17,7 +17,7 @@ extension Mas {
         )
 
         @Argument(help: "ID of app to show on MAS Preview")
-        var appId: Int
+        var appId: AppID
 
         /// Runs the command.
         func run() throws {

Sources/mas/Commands/Info.swift

@@ -18,7 +18,7 @@ extension Mas {
         )
 
         @Argument(help: "ID of app to show info")
-        var appId: Int
+        var appId: AppID
 
         /// Runs the command.
         func run() throws {

Sources/mas/Commands/Install.swift

@@ -19,7 +19,7 @@ extension Mas {
         @Flag(help: "force reinstall")
         var force = false
         @Argument(help: "app ID(s) to install")
-        var appIds: [UInt64]
+        var appIds: [AppID]
 
         /// Runs the command.
         func run() throws {

Sources/mas/Commands/Lucky.swift

@@ -28,7 +28,7 @@ extension Mas {
         }
 
         func run(appLibrary: AppLibrary, storeSearch: StoreSearch) throws {
-            var appId: Int?
+            var appId: AppID?
 
             do {
                 let results = try storeSearch.search(for: appName).wait()
@@ -44,7 +44,7 @@ extension Mas {
 
             guard let identifier = appId else { fatalError() }
 
-            try install(UInt64(identifier), appLibrary: appLibrary)
+            try install(identifier, appLibrary: appLibrary)
         }
 
         /// Installs an app.
@@ -52,7 +52,7 @@ extension Mas {
         /// - Parameters:
         ///   - appId: App identifier
         ///   - appLibrary: Library of installed apps
-        fileprivate func install(_ appId: UInt64, appLibrary: AppLibrary) throws {
+        fileprivate func install(_ appId: AppID, appLibrary: AppLibrary) throws {
             // Try to download applications with given identifiers and collect results
             if let product = appLibrary.installedApp(forId: appId), !force {
                 printWarning("\(product.appName) is already installed")

Sources/mas/Commands/Open.swift

@@ -9,7 +9,6 @@
 import ArgumentParser
 import Foundation
 
-private let markerValue = "appstore"
 private let masScheme = "macappstore"
 
 extension Mas {
@@ -21,7 +20,7 @@ extension Mas {
         )
 
         @Argument(help: "the app ID")
-        var appId: String = markerValue
+        var appId: AppID?
 
         /// Runs the command.
         func run() throws {
@@ -30,18 +29,12 @@ extension Mas {
 
         func run(storeSearch: StoreSearch, openCommand: ExternalCommand) throws {
             do {
-                if appId == markerValue {
+                guard let appId else {
                     // If no app ID is given, just open the MAS GUI app
                     try openCommand.run(arguments: masScheme + "://")
                     return
                 }
 
-                guard let appId = Int(appId)
-                else {
-                    printError("Invalid app ID")
-                    throw MASError.noSearchResultsFound
-                }
-
                 guard let result = try storeSearch.lookup(app: appId).wait()
                 else {
                     throw MASError.noSearchResultsFound

Sources/mas/Commands/Outdated.swift

@@ -33,7 +33,7 @@ extension Mas {
                 fulfilled:
                     appLibrary.installedApps.map { installedApp in
                         firstly {
-                            storeSearch.lookup(app: installedApp.itemIdentifier.intValue)
+                            storeSearch.lookup(app: installedApp.itemIdentifier.uint64Value)
                         }.done { storeApp in
                             guard let storeApp else {
                                 if verbose {

Sources/mas/Commands/Purchase.swift

@@ -16,7 +16,7 @@ extension Mas {
         )
 
         @Argument(help: "app ID(s) to install")
-        var appIds: [UInt64]
+        var appIds: [AppID]
 
         /// Runs the command.
         func run() throws {

Sources/mas/Commands/Uninstall.swift

@@ -21,7 +21,7 @@ extension Mas {
         @Flag(help: "dry run")
         var dryRun = false
         @Argument(help: "ID of app to uninstall")
-        var appId: Int
+        var appId: AppID
 
         /// Runs the uninstall command.
         func run() throws {
@@ -29,8 +29,6 @@ extension Mas {
         }
 
         func run(appLibrary: AppLibrary) throws {
-            let appId = UInt64(appId)
-
             guard let product = appLibrary.installedApp(forId: appId) else {
                 throw MASError.notInstalled
             }

Sources/mas/Commands/Upgrade.swift

@@ -58,11 +58,11 @@ extension Mas {
                 appIds.isEmpty
                 ? appLibrary.installedApps
                 : appIds.compactMap {
-                    if let appId = UInt64($0) {
+                    if let appId = AppID($0) {
-                        // if argument a UInt64, lookup app by id using argument
+                        // if argument an AppID, lookup app by id using argument
                         return appLibrary.installedApp(forId: appId)
                     } else {
-                        // if argument not a UInt64, lookup app by name using argument
+                        // if argument not an AppID, lookup app by name using argument
                         return appLibrary.installedApp(named: $0)
                     }
                 }
@@ -70,7 +70,7 @@ extension Mas {
             let promises = apps.map { installedApp in
                 // only upgrade apps whose local version differs from the store version
                 firstly {
-                    storeSearch.lookup(app: installedApp.itemIdentifier.intValue)
+                    storeSearch.lookup(app: installedApp.itemIdentifier.uint64Value)
                 }.map { result -> (SoftwareProduct, SearchResult)? in
                     guard let storeApp = result, installedApp.isOutdatedWhenComparedTo(storeApp) else {
                         return nil

Sources/mas/Commands/Vendor.swift

@@ -17,7 +17,7 @@ extension Mas {
         )
 
         @Argument(help: "the app ID to show the vendor's website")
-        var appId: Int
+        var appId: AppID
 
         /// Runs the command.
         func run() throws {

Sources/mas/Controllers/AppLibrary.swift

@@ -17,7 +17,7 @@ protocol AppLibrary {
     ///
     /// - Parameter forId: MAS ID for app.
     /// - Returns: Software Product of app if found; nil otherwise.
-    func installedApp(forId: UInt64) -> SoftwareProduct?
+    func installedApp(forId: AppID) -> SoftwareProduct?
 
     /// Uninstalls an app.
     ///
@@ -32,7 +32,7 @@ extension AppLibrary {
     ///
     /// - Parameter forId: MAS ID for app.
     /// - Returns: Software Product of app if found; nil otherwise.
-    func installedApp(forId identifier: UInt64) -> SoftwareProduct? {
+    func installedApp(forId identifier: AppID) -> SoftwareProduct? {
         let appId = NSNumber(value: identifier)
         return installedApps.first { $0.itemIdentifier == appId }
     }

Sources/mas/Controllers/MasStoreSearch.swift

@@ -53,7 +53,7 @@ class MasStoreSearch: StoreSearch {
         }
 
         // Combine the results, removing any duplicates.
-        var seenAppIDs = Set<Int>()
+        var seenAppIDs = Set<AppID>()
         return when(fulfilled: results).flatMapValues { $0 }.filterValues { result in
             seenAppIDs.insert(result.trackId).inserted
         }
@@ -64,7 +64,7 @@ class MasStoreSearch: StoreSearch {
     /// - Parameter appId: MAS ID of app
     /// - Returns: A Promise for the search result record of app, or nil if no apps match the ID,
     ///   or an Error if there is a problem with the network request.
-    func lookup(app appId: Int) -> Promise<SearchResult?> {
+    func lookup(app appId: AppID) -> Promise<SearchResult?> {
         guard let url = lookupURL(forApp: appId, inCountry: country) else {
             fatalError("Failed to build URL for \(appId)")
         }

Sources/mas/Controllers/StoreSearch.swift

@@ -11,7 +11,7 @@ import PromiseKit
 
 /// Protocol for searching the MAS catalog.
 protocol StoreSearch {
-    func lookup(app appId: Int) -> Promise<SearchResult?>
+    func lookup(app appId: AppID) -> Promise<SearchResult?>
     func search(for appName: String) -> Promise<[SearchResult]>
 }
 
@@ -49,7 +49,7 @@ extension StoreSearch {
     ///
     /// - Parameter appId: MAS app identifier.
     /// - Returns: URL for the lookup service or nil if appId can't be encoded.
-    func lookupURL(forApp appId: Int, inCountry country: String?) -> URL? {
+    func lookupURL(forApp appId: AppID, inCountry country: String?) -> URL? {
         guard var components = URLComponents(string: "https://itunes.apple.com/lookup") else {
             return nil
         }

Sources/mas/Formatters/SearchResultFormatter.swift

@@ -26,9 +26,9 @@ enum SearchResultFormatter {
             let price = result.price ?? 0.0
 
             if includePrice {
-                output += String(format: "%12d  %@  $%5.2f  (%@)\n", appId, appName, price, version)
+                output += String(format: "%12lu  %@  $%5.2f  (%@)\n", appId, appName, price, version)
             } else {
-                output += String(format: "%12d  %@ (%@)\n", appId, appName, version)
+                output += String(format: "%12lu  %@ (%@)\n", appId, appName, version)
             }
         }
 

Sources/mas/Mas.swift

@@ -9,6 +9,8 @@
 import ArgumentParser
 import PromiseKit
 
+typealias AppID = UInt64
+
 @main
 struct Mas: ParsableCommand {
     static let configuration = CommandConfiguration(

Sources/mas/Models/SearchResult.swift

@@ -14,7 +14,7 @@ struct SearchResult: Decodable {
     var price: Double?
     var sellerName: String
     var sellerUrl: String?
-    var trackId: Int
+    var trackId: AppID
     var trackName: String
     var trackViewUrl: String
     var version: String
@@ -27,7 +27,7 @@ struct SearchResult: Decodable {
         price: Double = 0.0,
         sellerName: String = "",
         sellerUrl: String = "",
-        trackId: Int = 0,
+        trackId: AppID = 0,
         trackName: String = "",
         trackViewUrl: String = "",
         version: String = ""

Tests/masTests/Commands/HomeSpec.swift

@@ -32,7 +32,7 @@ public class HomeSpec: QuickSpec {
                 expect {
                     try Mas.Home.parse(["--", "-999"]).run(storeSearch: storeSearch, openCommand: openCommand)
                 }
-                .to(throwError(MASError.searchFailed))
+                .to(throwError())
             }
             it("can't find app with unknown ID") {
                 expect {

Tests/masTests/Commands/InfoSpec.swift

@@ -46,7 +46,7 @@ public class InfoSpec: QuickSpec {
                 expect {
                     try Mas.Info.parse(["--", "-999"]).run(storeSearch: storeSearch)
                 }
-                .to(throwError(MASError.searchFailed))
+                .to(throwError())
             }
             it("can't find app with unknown ID") {
                 expect {

Tests/masTests/Commands/OpenSpec.swift

@@ -33,7 +33,7 @@ public class OpenSpec: QuickSpec {
                 expect {
                     try Mas.Open.parse(["--", "-999"]).run(storeSearch: storeSearch, openCommand: openCommand)
                 }
-                .to(throwError(MASError.searchFailed))
+                .to(throwError())
             }
             it("can't find app with unknown ID") {
                 expect {
@@ -55,7 +55,7 @@ public class OpenSpec: QuickSpec {
             }
             it("just opens MAS if no app specified") {
                 expect {
-                    try Mas.Open.parse(["appstore"]).run(storeSearch: storeSearch, openCommand: openCommand)
+                    try Mas.Open.parse([]).run(storeSearch: storeSearch, openCommand: openCommand)
                 }
                 .toNot(throwError())
                 expect(openCommand.arguments).toNot(beNil())

Tests/masTests/Commands/UninstallSpec.swift

@@ -18,7 +18,7 @@ public class UninstallSpec: QuickSpec {
             Mas.initialize()
         }
         describe("uninstall command") {
-            let appId = 12345
+            let appId: AppID = 12345
             let app = SoftwareProductMock(
                 appName: "Some App",
                 bundleIdentifier: "com.some.app",

Tests/masTests/Commands/VendorSpec.swift

@@ -32,7 +32,7 @@ public class VendorSpec: QuickSpec {
                 expect {
                     try Mas.Vendor.parse(["--", "-999"]).run(storeSearch: storeSearch, openCommand: openCommand)
                 }
-                .to(throwError(MASError.searchFailed))
+                .to(throwError())
             }
             it("can't find app with unknown ID") {
                 expect {

Tests/masTests/Controllers/MasStoreSearchSpec.swift

@@ -54,7 +54,7 @@ public class MasStoreSearchSpec: QuickSpec {
 
             context("when lookup used") {
                 it("can find slack") {
-                    let appId = 803_453_959
+                    let appId: AppID = 803_453_959
                     let networkSession = NetworkSessionMockFromFile(responseFile: "lookup/slack.json")
                     let storeSearch = MasStoreSearch(networkManager: NetworkManager(session: networkSession))
 

Tests/masTests/Controllers/StoreSearchMock.swift

@@ -11,7 +11,7 @@ import PromiseKit
 @testable import mas
 
 class StoreSearchMock: StoreSearch {
-    var apps: [Int: SearchResult] = [:]
+    var apps: [AppID: SearchResult] = [:]
 
     func search(for appName: String) -> Promise<[SearchResult]> {
         let filtered = apps.filter { $1.trackName.contains(appName) }
@@ -19,12 +19,7 @@ class StoreSearchMock: StoreSearch {
         return .value(results)
     }
 
-    func lookup(app appId: Int) -> Promise<SearchResult?> {
+    func lookup(app appId: AppID) -> Promise<SearchResult?> {
-        // Negative numbers are invalid
-        guard appId > 0 else {
-            return Promise(error: MASError.searchFailed)
-        }
-
         guard let result = apps[appId]
         else {
             return Promise(error: MASError.noSearchResultsFound)