Merge pull request #303 from tayloraswift/repo-privacy

Repo privacy

Author: tayloraswift

Assets/css/Main.css

@@ -49,10 +49,9 @@ extension GitHub
         public
         var fork:Bool
 
-        /// The repo’s visibility on GitHub. Some queries return only public repositories and so
-        /// omit this field.
+        /// The repo’s visibility on GitHub.
         public
-        var visibility:RepoVisibility?
+        var visibility:RepoVisibility
         /// The repo’s dominant language, if GitHub was able to detect one.
         public
         var language:String?
@@ -90,7 +89,7 @@ extension GitHub
             archived:Bool,
             disabled:Bool,
             fork:Bool,
-            visibility:RepoVisibility? = nil,
+            visibility:RepoVisibility,
             language:String? = nil,
             homepage:String? = nil,
             about:String? = nil,
@@ -172,7 +171,7 @@ extension GitHub.Repo:JSONObjectDecodable
             archived: try json[.archived].decode(),
             disabled: try json[.disabled].decode(),
             fork: try json[.fork].decode(),
-            visibility: try json[.visibility]?.decode(),
+            visibility: try json[.visibility].decode(),
             language: try json[.language]?.decode(),
             homepage: try json[.homepage]?.decode(),
             about: try json[.description]?.decode(),

Assets/css/Main.css.map

@@ -3,9 +3,47 @@ import JSON
 extension GitHub
 {
     @frozen public
-    enum RepoVisibility:String, JSONEncodable, JSONDecodable, Equatable, Sendable
+    enum RepoVisibility:Equatable, Comparable, Sendable
     {
-        case `public`
         case `private`
+        case `internal`
+        case `public`
+    }
+}
+extension GitHub.RepoVisibility:CustomStringConvertible
+{
+    @inlinable public
+    var description:String
+    {
+        switch self
+        {
+        case .private:  "private"
+        case .internal: "internal"
+        case .public:   "public"
+        }
     }
 }
+extension GitHub.RepoVisibility:LosslessStringConvertible
+{
+    @inlinable public
+    init?(_ description:String)
+    {
+        //  Note: the GraphQL API returns the visibility in all caps, for some reason.
+        switch description
+        {
+        case "PRIVATE":  self = .private
+        case "private":  self = .private
+
+        case "INTERNAL": self = .internal
+        case "internal": self = .internal
+
+        case "PUBLIC":   self = .public
+        case "public":   self = .public
+
+        default:         return nil
+        }
+    }
+}
+extension GitHub.RepoVisibility:JSONStringDecodable
+{
+}

Sources/GitHubAPI/GitHub.Repo.swift

@@ -26,16 +26,17 @@ extension GitHub.Client
         }
     }
 }
-extension GitHub.Client<GitHub.PersonalAccessToken>.Connection
+extension GitHub.Client<Void>.Connection
 {
     /// Run a GraphQL API request.
     ///
     /// The request will be charged to the user associated with the stored token. It is not
     /// possible to run a GraphQL API request without a token.
     @inlinable public
-    func post<Response>(query:String,
-        for _:Response.Type = Response.self) async throws -> GraphQL.Response<Response>
-        where Response:JSONDecodable
+    func post<T>(query:String,
+        expecting _:T.Type = T.self,
+        with authorization:GitHub.ClientAuthorization) async throws -> GraphQL.Response<T>
+        where T:JSONDecodable
     {
         let request:HTTP.Client2.Request = .init(headers:
             [
@@ -44,7 +45,7 @@ extension GitHub.Client<GitHub.PersonalAccessToken>.Connection
                 ":authority": self.http2.remote,
                 ":path": "/graphql",
 
-                "authorization": "Bearer \(self.app)",
+                "authorization": authorization.header,
 
                 //  GitHub will reject the API request if the user-agent is not set.
                 "user-agent": self.agent,
@@ -65,8 +66,7 @@ extension GitHub.Client<GitHub.PersonalAccessToken>.Connection
             if  let second:String = response.headers?["x-ratelimit-reset"].first,
                 let second:Int64 = .init(second)
             {
-                throw GitHub.Client<GitHub.PersonalAccessToken>.RateLimitError.init(
-                    until: .second(second))
+                throw GitHub.Client<Application>.RateLimitError.init(until: .second(second))
             }
             else
             {

Sources/GitHubAPI/GitHub.RepoVisibility.swift

@@ -27,17 +27,17 @@ extension GitHub
         }
     }
 }
-extension GitHub.Client<GitHub.PersonalAccessToken>
+extension GitHub.Client<Void>
 {
     public static
-    func graphql(pat:consuming GitHub.PersonalAccessToken,
+    func graphql(
         threads:consuming MultiThreadedEventLoopGroup,
         niossl:consuming NIOSSLContext,
-        as agent:String) -> GitHub.Client<GitHub.PersonalAccessToken>
+        as agent:String) -> GitHub.Client<Void>
     {
         .init(http2: .init(threads: threads, niossl: niossl, remote: "api.github.com"),
             agent: agent,
-            app: pat)
+            app: ())
     }
 }
 extension GitHub.Client where Application:GitHubApplication

Sources/GitHubClient/GitHub.Client.Connection.swift

@@ -4,13 +4,21 @@ import GitHubAPI
 extension GitHub
 {
     @frozen public
-    enum ClientAuthorization
+    enum ClientAuthorization:Sendable
     {
         case basic(GitHub.OAuth)
         case token(String)
     }
 }
 extension GitHub.ClientAuthorization
+{
+    @inlinable public
+    static func token(_ iat:GitHub.InstallationAccessToken) -> Self { .token(iat.rawValue) }
+
+    @inlinable public
+    static func token(_ pat:GitHub.PersonalAccessToken) -> Self { .token(pat.rawValue) }
+}
+extension GitHub.ClientAuthorization
 {
     @inlinable
     var header:String

Sources/GitHubClient/GitHub.Client.swift

@@ -12,8 +12,7 @@ extension Unidoc.PackageRepo
 {
     @inlinable public static
     func github(_ repo:GitHub.Repo,
-        crawled:UnixMillisecond,
-        installation:Int32? = nil) throws -> Self
+        crawled:UnixMillisecond) throws -> Self
     {
         /// We clip this to Midnights because we use this as a shard key, and also because
         /// Midnights are Swifty.
@@ -46,6 +45,7 @@ extension Unidoc.PackageRepo
             created: .init(created),
             updated: updated,
             license: repo.license.map { .init(spdx: $0.id, name: $0.name) },
+            private: repo.visibility < .public,
             topics: repo.topics,
             master: repo.master,
             origin: .github(.init(
@@ -59,8 +59,7 @@ extension Unidoc.PackageRepo
                 size: repo.size,
                 archived: repo.archived,
                 disabled: repo.disabled,
-                fork: repo.fork,
-                installation: installation)),
+                fork: repo.fork)),
             forks: repo.forks,
             stars: repo.stars)
     }

Sources/GitHubClient/GitHub.ClientAuthorization.swift

@@ -38,10 +38,6 @@ extension Unidoc
         public
         var fork:Bool
 
-        /// A GitHub App installation, currently only set for private repositories.
-        public
-        var installation:Int32?
-
         @inlinable public
         init(id:Int32,
             owner:String,
@@ -53,8 +49,7 @@ extension Unidoc
             size:Int,
             archived:Bool,
             disabled:Bool,
-            fork:Bool,
-            installation:Int32?)
+            fork:Bool)
         {
             self.id = id
             self.pushed = pushed
@@ -67,7 +62,6 @@ extension Unidoc
             self.archived = archived
             self.disabled = disabled
             self.fork = fork
-            self.installation = installation
         }
     }
 }
@@ -107,6 +101,8 @@ extension Unidoc.GitHubOrigin
         case archived = "X"
         case disabled = "D"
         case fork = "K"
+
+        @available(*, unavailable)
         case installation = "L"
     }
 }
@@ -129,7 +125,6 @@ extension Unidoc.GitHubOrigin:BSONDocumentEncodable
         bson[.archived] = self.archived
         bson[.disabled] = self.disabled
         bson[.fork] = self.fork
-        bson[.installation] = self.installation
     }
 }
 extension Unidoc.GitHubOrigin:BSONDocumentDecodable
@@ -147,7 +142,6 @@ extension Unidoc.GitHubOrigin:BSONDocumentDecodable
             size: try bson[.size].decode(),
             archived: try bson[.archived].decode(),
             disabled: try bson[.disabled].decode(),
-            fork: try bson[.fork].decode(),
-            installation: try bson[.installation]?.decode())
+            fork: try bson[.fork].decode())
     }
 }

Sources/UnidocDB/Packages/Unidoc.PackageRepo (ext).swift

@@ -33,6 +33,12 @@ extension Unidoc
         /// The repo’s license. All software repos have the concept of a license.
         public
         var license:PackageLicense?
+
+        /// Indicates if the repo is private, and therefore cannot be cloned without
+        /// authentication.
+        public
+        var `private`:Bool
+
         /// The repo’s topic memberships. Both GitHub and GitLab have topics.
         public
         var topics:[String]
@@ -57,6 +63,7 @@ extension Unidoc
             created:UnixMillisecond,
             updated:UnixMillisecond,
             license:PackageLicense?,
+            private:Bool,
             topics:[String],
             master:String?,
             origin:PackageOrigin,
@@ -69,6 +76,7 @@ extension Unidoc
             self.created = created
             self.updated = updated
             self.license = license
+            self.private = `private`
             self.topics = topics
             self.master = master
             self.origin = origin
@@ -95,6 +103,7 @@ extension Unidoc.PackageRepo
         case updated = "U"
 
         case license = "L"
+        case `private` = "X"
         case topics = "T"
         case master = "M"
 
@@ -115,6 +124,7 @@ extension Unidoc.PackageRepo:BSONDocumentEncodable
         bson[.updated] = self.updated
 
         bson[.license] = self.license
+        bson[.private] = self.private
         bson[.topics] = self.topics.isEmpty ? nil : self.topics
         bson[.master] = self.master
 
@@ -140,6 +150,8 @@ extension Unidoc.PackageRepo:BSONDocumentDecodable
             created: try bson[.created].decode(),
             updated: try bson[.updated].decode(),
             license: try bson[.license]?.decode(),
+            //  TODO: deoptionalize
+            private: try bson[.private]?.decode() ?? false,
             topics: try bson[.topics]?.decode() ?? [],
             master: try bson[.master]?.decode(),
             origin: origin,