implement github social login flow

Author: tayloraswift

.gitignore

@@ -4,6 +4,7 @@
 .unidoc
 .vscode
 
+Assets/secrets/
 TestDeployment/data/
 
 node_modules/

Assets/js/Main.js

@@ -14,8 +14,11 @@ let package:Package = .init(
         .library(name: "DoclinkResolution", targets: ["DoclinkResolution"]),
         .library(name: "FNV1", targets: ["FNV1"]),
 
+        .library(name: "GitHubIntegration", targets: ["GitHubIntegration"]),
+
         .library(name: "HTML", targets: ["HTML"]),
 
+        .library(name: "HTTPClient", targets: ["HTTPClient"]),
         .library(name: "HTTPServer", targets: ["HTTPServer"]),
 
         .library(name: "LexicalPaths", targets: ["LexicalPaths"]),
@@ -24,7 +27,7 @@ let package:Package = .init(
         .library(name: "MarkdownParsing", targets: ["MarkdownParsing"]),
         .library(name: "MarkdownRendering", targets: ["MarkdownRendering"]),
         .library(name: "MarkdownSemantics", targets: ["MarkdownSemantics"]),
-        .library(name: "MarkdownTrees", targets: ["MarkdownTrees"]),
+        .library(name: "MarkdownAST", targets: ["MarkdownAST"]),
 
         .library(name: "Media", targets: ["Media"]),
 
@@ -51,6 +54,7 @@ let package:Package = .init(
         .library(name: "System", targets: ["System"]),
 
         .library(name: "Unidoc", targets: ["Unidoc"]),
+        .library(name: "UnidocAnalysis", targets: ["UnidocAnalysis"]),
         .library(name: "UnidocDatabase", targets: ["UnidocDatabase"]),
         .library(name: "UnidocDiagnostics", targets: ["UnidocDiagnostics"]),
         .library(name: "UnidocLinker", targets: ["UnidocLinker"]),
@@ -64,15 +68,17 @@ let package:Package = .init(
     ],
     dependencies:
     [
-        .package(url: "https://github.com/tayloraswift/swift-json", .upToNextMinor(
-            from: "0.6.0")),
+        //.package(url: "https://github.com/tayloraswift/swift-json", .upToNextMinor(
+        //    from: "0.6.0")),
         .package(url: "https://github.com/tayloraswift/swift-grammar", .upToNextMinor(
             from: "0.3.2")),
         .package(url: "https://github.com/tayloraswift/swift-mongodb", .upToNextMinor(
            from: "0.7.2")),
 
         .package(url: "https://github.com/apple/swift-nio", .upToNextMinor(
             from: "2.57.0")),
+        .package(url: "https://github.com/apple/swift-nio-http2", .upToNextMinor(
+            from: "1.27.0")),
         .package(url: "https://github.com/apple/swift-nio-ssl", .upToNextMinor(
             from: "2.24.0")),
         .package(url: "https://github.com/apple/swift-markdown", .upToNextMinor(
@@ -117,6 +123,12 @@ let package:Package = .init(
 
         .target(name: "FNV1"),
 
+        .target(name: "GitHubIntegration", dependencies:
+            [
+                .target(name: "JSON"),
+                .target(name: "HTTPClient"),
+            ]),
+
         .target(name: "HTML", dependencies:
             [
                 .target(name: "HTMLDOM"),
@@ -130,6 +142,17 @@ let package:Package = .init(
                 .target(name: "HTMLDOM"),
             ]),
 
+        .target(name: "HTTPClient", dependencies:
+            [
+                .target(name: "HTML"),
+                .target(name: "Media"),
+                .target(name: "MD5"),
+                .product(name: "NIOHTTP1", package: "swift-nio"),
+                .product(name: "NIOHTTP2", package: "swift-nio-http2"),
+                .product(name: "NIOSSL", package: "swift-nio-ssl"),
+                .product(name: "TraceableErrors", package: "swift-grammar"),
+            ]),
+
         .target(name: "HTTPServer", dependencies:
             [
                 .target(name: "HTML"),
@@ -142,6 +165,37 @@ let package:Package = .init(
 
         .target(name: "InlineBuffer"),
 
+
+        .target(name: "JSONAST"),
+
+        .target(name: "JSONDecoding", dependencies:
+            [
+                .target(name: "JSONAST"),
+            ]),
+
+        .target(name: "JSONEncoding", dependencies:
+            [
+                .target(name: "JSONAST"),
+            ]),
+
+        .target(name: "JSONLegacy", dependencies:
+            [
+                .target(name: "JSONDecoding"),
+            ]),
+
+        .target(name: "JSONParsing", dependencies:
+            [
+                .target(name: "JSONAST"),
+                .product(name: "Grammar", package: "swift-grammar"),
+            ]),
+
+        .target(name: "JSON", dependencies:
+            [
+                .target(name: "JSONDecoding"),
+                .target(name: "JSONEncoding"),
+                .target(name: "JSONParsing"),
+            ]),
+
         .target(name: "LexicalPaths"),
 
         .target(name: "MarkdownABI"),
@@ -152,15 +206,15 @@ let package:Package = .init(
                 .target(name: "MarkdownABI"),
             ]),
 
-        .target(name: "MarkdownTrees", dependencies:
+        .target(name: "MarkdownAST", dependencies:
             [
                 .target(name: "MarkdownABI"),
                 .target(name: "Sources"),
             ]),
 
         .target(name: "MarkdownParsing", dependencies:
             [
-                .target(name: "MarkdownTrees"),
+                .target(name: "MarkdownAST"),
                 //  TODO: this links Foundation. Need to find a replacement.
                 .product(name: "Markdown", package: "swift-markdown"),
             ]),
@@ -175,7 +229,7 @@ let package:Package = .init(
         .target(name: "MarkdownSemantics", dependencies:
             [
                 .target(name: "Codelinks"),
-                .target(name: "MarkdownTrees"),
+                .target(name: "MarkdownAST"),
             ]),
 
         .target(name: "MD5", dependencies:
@@ -204,10 +258,8 @@ let package:Package = .init(
 
         .target(name: "PackageMetadata", dependencies:
             [
+                .target(name: "JSON"),
                 .target(name: "PackageGraphs"),
-
-                .product(name: "JSONDecoding", package: "swift-json"),
-                .product(name: "JSONEncoding", package: "swift-json"),
             ]),
 
         .target(name: "SemanticVersions"),
@@ -262,13 +314,12 @@ let package:Package = .init(
 
         .target(name: "SymbolGraphParts", dependencies:
             [
+                .target(name: "JSON"),
                 .target(name: "LexicalPaths"),
                 .target(name: "ModuleGraphs"),
                 .target(name: "Signatures"),
                 .target(name: "Symbols"),
                 .target(name: "Unidoc"),
-                .product(name: "JSONDecoding", package: "swift-json"),
-                .product(name: "JSONEncoding", package: "swift-json"),
             ]),
 
         .target(name: "SymbolGraphs", dependencies:
@@ -302,8 +353,9 @@ let package:Package = .init(
 
         .target(name: "UnidocAnalysis", dependencies:
             [
-                .target(name: "UnidocSelectors"),
+                .target(name: "JSONEncoding"),
                 .target(name: "MD5"),
+                .target(name: "UnidocSelectors"),
             ]),
 
         .target(name: "UnidocDatabase", dependencies:
@@ -329,6 +381,7 @@ let package:Package = .init(
 
         .target(name: "UnidocPages", dependencies:
             [
+                .target(name: "GitHubIntegration"),
                 .target(name: "HTTPServer"),
                 .target(name: "MarkdownRendering"),
                 .target(name: "UnidocQueries"),

Assets/js/Main.js.map

@@ -0,0 +1,74 @@
+import HTTPClient
+import JSON
+import NIOCore
+import NIOHPACK
+
+extension GitHubApplication
+{
+    @frozen public
+    struct Client
+    {
+        private
+        let http2:ClientInterface
+        public
+        let app:GitHubApplication
+
+        public
+        init(http2:ClientInterface, app:GitHubApplication)
+        {
+            self.http2 = http2
+            self.app = app
+        }
+    }
+}
+extension GitHubApplication.Client
+{
+    public
+    func exchange(code:String) async -> Result<GitHubTokens, GitHubAuthenticationError>
+    {
+        let request:HPACKHeaders =
+        [
+            ":method": "POST",
+            ":scheme": "https",
+            ":authority": "github.com",
+            ":path": """
+                /login/oauth/access_token?\
+                client_id=\(self.app.id)&client_secret=\(self.app.secret)&code=\(code)
+                """,
+
+            "accept": "application/vnd.github+json",
+        ]
+
+        let response:ClientInterface.Facet
+        do
+        {
+            response = try await self.http2.fetch(request)
+        }
+        catch let error
+        {
+            return .failure(.fetch(error))
+        }
+
+        guard   let headers:HPACKHeaders = response.headers,
+                    headers[canonicalForm: ":status"] == ["200"]
+        else
+        {
+            return .failure(.status)
+        }
+
+        var json:JSON = .init(utf8: [])
+        for buffer:ByteBuffer in response.buffers
+        {
+            json.utf8 += buffer.readableBytesView
+        }
+
+        do
+        {
+            return .success(try json.decode())
+        }
+        catch let error
+        {
+            return .failure(.response(error))
+        }
+    }
+}

Package.resolved

@@ -0,0 +1,20 @@
+import HTTPClient
+import JSON
+import NIOCore
+import NIOHPACK
+
+@frozen public
+struct GitHubApplication:Identifiable, Equatable, Hashable, Sendable
+{
+    public
+    let secret:String
+    public
+    let id:String
+
+    @inlinable public
+    init(_ id:String, secret:String = "3a892428d6381dbcfdafab55ad2fbec6d4847430")
+    {
+        self.id = id
+        self.secret = secret
+    }
+}

Package.swift

@@ -0,0 +1,7 @@
+@frozen public
+enum GitHubAuthenticationError:Error, Sendable
+{
+    case fetch(any Error)
+    case status
+    case response(any Error)
+}

Sources/GitHubIntegration/GitHubApplication.Client.swift

@@ -0,0 +1,15 @@
+@frozen public
+struct GitHubToken:Equatable, Hashable, Sendable
+{
+    public
+    let secondsRemaining:Int
+    public
+    let value:String
+
+    @inlinable public
+    init(value:String, secondsRemaining:Int)
+    {
+        self.value = value
+        self.secondsRemaining = secondsRemaining
+    }
+}

Sources/GitHubIntegration/GitHubApplication.swift

@@ -0,0 +1,38 @@
+import JSON
+
+@frozen public
+struct GitHubTokens:Equatable, Hashable, Sendable
+{
+    public
+    let refresh:GitHubToken
+    public
+    let access:GitHubToken
+
+    @inlinable public
+    init(refresh:GitHubToken, access:GitHubToken)
+    {
+        self.refresh = refresh
+        self.access = access
+    }
+}
+extension GitHubTokens:JSONObjectDecodable
+{
+    public
+    enum CodingKey:String
+    {
+        case access_value = "access_token"
+        case access_secondsRemaining = "expires_in"
+        case refresh_value = "refresh_token"
+        case refresh_secondsRemaining = "refresh_token_expires_in"
+    }
+
+    public
+    init(json:JSON.ObjectDecoder<CodingKey>) throws
+    {
+        self.init(
+            refresh: .init(value: try json[.refresh_value].decode(),
+                secondsRemaining: try json[.refresh_secondsRemaining].decode()),
+            access:  .init(value: try json[.access_value].decode(),
+                secondsRemaining: try json[.access_secondsRemaining].decode()))
+    }
+}