add support for gzipped text resources

Author: tayloraswift

Package.swift

@@ -543,6 +543,7 @@ let package:Package = .init(
                 .target(name: "GitHubAPI"),
                 .target(name: "UnidocLinker"),
                 .target(name: "UnixTime"),
+                .product(name: "LZ77", package: "swift-png"),
                 .product(name: "MongoDB", package: "swift-mongodb"),
             ]),
 
@@ -625,7 +626,6 @@ let package:Package = .init(
                 .target(name: "SwiftinitAssets"),
                 .target(name: "SwiftinitPages"),
                 .target(name: "SwiftinitPlugins"),
-                .product(name: "LZ77", package: "swift-png"),
             ]),
 
 

Sources/HTTP/HTTP.Resource.Content.swift

@@ -5,13 +5,21 @@ extension HTTP.Resource
     @frozen public
     enum Content:Equatable, Sendable
     {
-        case binary([UInt8])
+        case binary(ArraySlice<UInt8>)
         case buffer(ByteBuffer)
         case string(String)
         case length(Int)
     }
 }
 extension HTTP.Resource.Content
+{
+    @inlinable public static
+    func binary(_ bytes:[UInt8]) -> Self
+    {
+        .binary(bytes[...])
+    }
+}
+extension HTTP.Resource.Content
 {
     /// The size of the content to be transferred, in bytes. Unlike ``length``, this property
     /// is zero if the content is a ``length(_:)`` cache result.

Sources/HTTP/HTTP.Resource.swift

@@ -17,14 +17,21 @@ extension HTTP
         public
         var type:MediaType
         public
+        var gzip:Bool
+        public
         var hash:MD5?
 
         @inlinable public
-        init(headers:Headers = .init(), content:Content, type:MediaType, hash:MD5? = nil)
+        init(headers:Headers = .init(),
+            content:Content,
+            type:MediaType,
+            gzip:Bool,
+            hash:MD5? = nil)
         {
             self.headers = headers
             self.content = content
             self.type = type
+            self.gzip = gzip
             self.hash = hash
         }
     }
@@ -34,7 +41,9 @@ extension HTTP.Resource:ExpressibleByStringLiteral, ExpressibleByStringInterpola
     @inlinable public
     init(stringLiteral:String)
     {
-        self.init(content: .string(stringLiteral), type: .text(.plain, charset: .utf8))
+        self.init(content: .string(stringLiteral),
+            type: .text(.plain, charset: .utf8),
+            gzip: false)
     }
 }
 extension HTTP.Resource

Sources/HTTPServer/Channels/HTTP.ServerMessage.swift

@@ -47,7 +47,8 @@ extension HTTP.ServerMessage
             copying: .init(
                 headers: .init(),
                 content: .string(Authority.redact(error: error)),
-                type: .text(.plain, charset: .utf8)),
+                type: .text(.plain, charset: .utf8),
+                gzip: false),
             using: allocator)
     }
 }
@@ -119,5 +120,9 @@ extension HTTP.ServerMessage
         self.headers.add(name: "access-control-allow-origin", value: "*")
         self.headers.add(name: "content-length", value: "\(length)")
         self.headers.add(name: "content-type",   value: "\(resource.type)")
+        if  resource.gzip
+        {
+            self.headers.add(name: "content-encoding", value: "gzip")
+        }
     }
 }

Sources/JSONAST/JSON.EscapeCode.swift

@@ -31,7 +31,7 @@ extension JSON.EscapeCode
     }
 
     @inlinable internal static
-    func += (utf8:inout [UInt8], self:Self)
+    func += (utf8:inout ArraySlice<UInt8>, self:Self)
     {
         utf8.append(0x5C) // '\'
         switch self

Sources/JSONAST/JSON.swift

@@ -2,10 +2,10 @@
 struct JSON:Sendable
 {
     public
-    var utf8:[UInt8]
+    var utf8:ArraySlice<UInt8>
 
     @inlinable public
-    init(utf8:[UInt8])
+    init(utf8:ArraySlice<UInt8>)
     {
         self.utf8 = utf8
     }

Sources/PackageMetadataTests/Main.PackageResolved.swift

@@ -102,7 +102,7 @@ extension Main.PackageResolved:TestBattery
             tests.do
             {
                 let filepath:FilePath = "Package.resolved"
-                let json:JSON = .init(utf8: try filepath.read())
+                let json:JSON = .init(utf8: try filepath.read()[...])
                 let _:SPM.DependencyResolutions = try json.decode()
             }
         }

Sources/SwiftinitPages/Surfaces/Swiftinit.MediaEndpoint.swift

@@ -29,15 +29,26 @@ extension Swiftinit.MediaEndpoint
         }
 
         let content:HTTP.Resource.Content
-        switch output.utf8
+        let gzipped:Bool
+        switch output.text
         {
-        case .binary(let utf8):     content = .binary(utf8)
-        case .length(let bytes):    content = .length(bytes)
+        case .inline(.gzip(let gzip)):
+            content = .binary(gzip)
+            gzipped = true
+
+        case .inline(.utf8(let utf8)):
+            content = .binary(utf8)
+            gzipped = false
+
+        case .length(let bytes):
+            content = .length(bytes)
+            gzipped = false // ???
         }
 
         return .ok(.init(
             content: content,
             type: self.type,
+            gzip: gzipped,
             hash: output.hash))
     }
 }

Sources/SwiftinitPages/Surfaces/Swiftinit.SitemapEndpoint.swift

@@ -62,6 +62,7 @@ extension Swiftinit.SitemapEndpoint:HTTP.ServerEndpoint
 
         return .ok(.init(content: .string(string),
             type: .text(.plain, charset: .utf8),
+            gzip: false,
             hash: output.sitemap.hash))
     }
 }

Sources/SwiftinitPages/Surfaces/Swiftinit.VertexEndpoint.swift

@@ -48,7 +48,8 @@ extension Swiftinit.VertexEndpoint where Self:HTTP.ServerEndpoint
         {
             return .notFound(.init(
                 content: .string("Snapshot not found."),
-                type: .text(.plain, charset: .utf8)))
+                type: .text(.plain, charset: .utf8),
+                gzip: false))
         }
 
         guard