refactor Swiftinit.PipelineEndpoint into protocols

Author: tayloraswift

Package.resolved

@@ -95,8 +95,10 @@ let package:Package = .init(
 
         .package(url: "https://github.com/tayloraswift/swift-hash", .upToNextMinor(
             from: "0.5.0")),
-        .package(url: "https://github.com/tayloraswift/swift-mongodb", .upToNextMinor(
-            from: "0.9.1")),
+        // .package(url: "https://github.com/tayloraswift/swift-mongodb", .upToNextMinor(
+        //     from: "0.9.1")),
+        .package(url: "https://github.com/tayloraswift/swift-mongodb",
+            branch: "0.10.0"),
 
         .package(url: "https://github.com/apple/swift-atomics", .upToNextMinor(
             from: "1.2.0")),

Package.swift

@@ -0,0 +1,21 @@
+import Media
+
+@available(*, deprecated, renamed: "HTTP.ServerEndpoint")
+public
+typealias ServerResponseFactory = HTTP.ServerEndpoint
+
+extension HTTP
+{
+    public
+    typealias ServerEndpoint = _HTTPServerEndpoint
+}
+
+/// The name of this protocol is ``HTTP.ServerEndpoint``.
+public
+protocol _HTTPServerEndpoint<Format>
+{
+    associatedtype Format
+
+    consuming
+    func response(as format:Format) throws -> HTTP.ServerResponse
+}

Sources/HTTP/HTTP.ServerEndpoint.swift

@@ -0,0 +1,62 @@
+import HTTP
+import JSON
+import Media
+import MongoDB
+import SwiftinitRender
+import UnidocDB
+import UnidocQueries
+import UnidocRecords
+
+extension Swiftinit
+{
+    @frozen public
+    struct TagsEndpoint:Mongo.PipelineEndpoint, Mongo.SingleOutputEndpoint
+    {
+        public
+        let query:Unidoc.PackageQuery
+        public
+        var value:Unidoc.PackageQuery.Output?
+
+        @inlinable public
+        init(query:Unidoc.PackageQuery)
+        {
+            self.query = query
+            self.value = nil
+        }
+    }
+}
+extension Swiftinit.TagsEndpoint:HTTP.ServerEndpoint
+{
+    public consuming
+    func response(as format:Swiftinit.RenderFormat) -> HTTP.ServerResponse
+    {
+        guard
+        let output:Unidoc.PackageQuery.Output = self.value
+        else
+        {
+            return .error("Query for endpoint '\(Self.self)' returned no outputs!")
+        }
+
+        switch format.accept
+        {
+        case .application(.json):
+            guard
+            let status:Unidoc.PackageStatus = .init(from: output)
+            else
+            {
+                return .notFound(.init(content: .string(""),
+                    type: .text(.plain, charset: .utf8)))
+            }
+
+            let json:JSON = .object(with: status.encode(to:))
+
+            return .ok(.init(
+                content: .binary(json.utf8),
+                type: .application(.json, charset: .utf8)))
+
+        case _:
+            let page:Swiftinit.TagsPage = .init(from: output)
+            return .ok(page.resource(format: format))
+        }
+    }
+}

Sources/HTTP/HTTP.ServerResponseFactory.swift

@@ -0,0 +1,40 @@
+import HTTP
+import MongoDB
+import SwiftinitRender
+import UnidocDB
+import UnidocQueries
+
+extension Swiftinit
+{
+    @frozen public
+    struct RealmEndpoint:Mongo.PipelineEndpoint, Mongo.SingleOutputEndpoint
+    {
+        public
+        let query:Unidoc.RealmQuery
+        public
+        var value:Unidoc.RealmQuery.Output?
+
+        @inlinable public
+        init(query:Unidoc.RealmQuery)
+        {
+            self.query = query
+            self.value = nil
+        }
+    }
+}
+extension Swiftinit.RealmEndpoint:HTTP.ServerEndpoint
+{
+    public consuming
+    func response(as format:Swiftinit.RenderFormat) -> HTTP.ServerResponse
+    {
+        guard
+        let output:Unidoc.RealmQuery.Output = self.value
+        else
+        {
+            return .error("Query for endpoint '\(Self.self)' returned no outputs!")
+        }
+
+        let page:Swiftinit.RealmPage = .init(from: output)
+        return .ok(page.resource(format: format))
+    }
+}

Sources/SwiftinitPages/Surfaces/Editions/Swiftinit.TagsEndpoint.swift

@@ -0,0 +1,44 @@
+import HTTP
+import Media
+import MongoDB
+import SwiftinitRender
+import UnidocDB
+import UnidocQueries
+
+extension Swiftinit
+{
+    @frozen public
+    struct HomeEndpoint:Mongo.PipelineEndpoint, Mongo.SingleOutputEndpoint
+    {
+        public
+        let query:Unidoc.ActivityQuery
+        public
+        var value:Unidoc.ActivityQuery.Output?
+
+        @inlinable public
+        init(query:Unidoc.ActivityQuery)
+        {
+            self.query = query
+            self.value = nil
+        }
+    }
+}
+extension Swiftinit.HomeEndpoint:HTTP.ServerEndpoint
+{
+    public consuming
+    func response(as format:Swiftinit.RenderFormat) -> HTTP.ServerResponse
+    {
+        guard
+        let output:Unidoc.ActivityQuery.Output = self.value
+        else
+        {
+            return .error("Query for endpoint '\(Self.self)' returned no outputs!")
+        }
+
+        let page:Swiftinit.HomePage = .init(
+            repo: output.repo,
+            docs: output.docs)
+
+        return .ok(page.resource(format: format))
+    }
+}

Sources/SwiftinitPages/Surfaces/Editions/Unidoc.PackageQuery.Output (ext).swift

@@ -0,0 +1,62 @@
+import HTTP
+import Media
+import MongoDB
+import SwiftinitRender
+import UnidocDB
+import UnidocQueries
+import UnidocRecords
+import URI
+
+extension Swiftinit
+{
+    @frozen public
+    struct SitemapEndpoint:Mongo.PipelineEndpoint, Mongo.SingleOutputEndpoint
+    {
+        public
+        let query:Unidoc.SitemapQuery
+        public
+        var value:Unidoc.SitemapQuery.Output?
+
+        @inlinable public
+        init(query:Unidoc.SitemapQuery)
+        {
+            self.query = query
+            self.value = nil
+        }
+    }
+}
+extension Swiftinit.SitemapEndpoint:HTTP.ServerEndpoint
+{
+    /// Generates a plain text sitemap for the given package.
+    ///
+    /// We don’t have granular enough `<lastmod>` information to motivate generating XML
+    /// sitemaps, and all other XML sitemap features (like `<priority>`) are irrelevant to us,
+    /// since Google ignores them. Therefore, we use the plain text format.
+    public consuming
+    func response(as _:Swiftinit.RenderFormat) -> HTTP.ServerResponse
+    {
+        guard
+        let output:Unidoc.SitemapQuery.Output = self.value
+        else
+        {
+            return .error("Query for endpoint '\(Self.self)' returned no outputs!")
+        }
+
+        let prefix:String = "https://swiftinit.org/\(Swiftinit.Docs.root)/\(output.package)"
+        var string:String = ""
+
+        for page:Unidoc.Shoot in output.sitemap.elements
+        {
+            var uri:URI = []
+
+            uri.path += page.stem
+            uri["hash"] = page.hash?.description
+
+            string += "\(prefix)\(uri)\n"
+        }
+
+        return .ok(.init(content: .string(string),
+            type: .text(.plain, charset: .utf8),
+            hash: output.sitemap.hash))
+    }
+}