Merge branch 'develop'

helje5 · helje5 · commit b6dbc8ab1e1a · 2023-04-16T17:10:26.000+02:00
diff --git a/.github/workflows/swift.yml b/.github/workflows/swift.yml
@@ -16,6 +16,7 @@ jobs:
           - swift:5.5.3-xenial
           - swift:5.6.1-bionic
           - swift:5.7.2-focal
+          - swift:5.8-jammy
     container: ${{ matrix.image }}
     steps:
       - name: Checkout Repository
diff --git a/Sources/MacroCore/Buffer/BufferData.swift b/Sources/MacroCore/Buffer/BufferData.swift
@@ -3,12 +3,14 @@
 //  Macro
 //
 //  Created by Helge Heß.
-//  Copyright © 2020-2021 ZeeZide GmbH. All rights reserved.
+//  Copyright © 2020-2023 ZeeZide GmbH. All rights reserved.
 //
 
 #if canImport(Foundation)
 
 import struct Foundation.Data
+import NIOCore
+import NIOFoundationCompat
 
 public extension Buffer {
   
diff --git a/Sources/MacroCore/Buffer/BufferDeprecations.swift b/Sources/MacroCore/Buffer/BufferDeprecations.swift
@@ -3,10 +3,11 @@
 //  Macro
 //
 //  Created by Helge Heß.
-//  Copyright © 2020-2021 ZeeZide GmbH. All rights reserved.
+//  Copyright © 2020-2023 ZeeZide GmbH. All rights reserved.
 //
 
 #if canImport(Foundation)
+import Foundation
 
 public extension Buffer {
   
diff --git a/Sources/MacroCore/Buffer/BufferHexEncoding.swift b/Sources/MacroCore/Buffer/BufferHexEncoding.swift
@@ -3,9 +3,11 @@
 //  Macro
 //
 //  Created by Helge Heß.
-//  Copyright © 2020-2021 ZeeZide GmbH. All rights reserved.
+//  Copyright © 2020-2023 ZeeZide GmbH. All rights reserved.
 //
 
+import NIOCore
+
 @usableFromInline
 internal let hexAlphabet = "0123456789abcdef".unicodeScalars.map { $0 }
 @usableFromInline
diff --git a/Sources/MacroCore/JSON.swift b/Sources/MacroCore/JSON.swift
@@ -103,14 +103,15 @@ public extension JSONModule {
   
   // MARK: - Encodable versions
 
+  @inlinable
   static func dataify<C: Encodable>(_ object : C?,
                                     outputFormatting:
                                       JSONEncoder.OutputFormatting
                                       = _defaultJSONEncoderOptions)
               -> Foundation.Data?
   {
     do {
-      let encoder = makeEncoder()
+      let encoder = JSONEncoderWithISO8601()
       encoder.outputFormatting = outputFormatting
       return try encoder.encode(object)
     }
@@ -158,14 +159,15 @@ public let _defaultJSONEncoderOptions : JSONEncoder.OutputFormatting = {
 public extension WritableStreamType where WritablePayload == Buffer {
 
   @discardableResult
+  @inlinable
   func write<S: Encodable>(_ jsonObject: S,
                            outputFormatting:
                              JSONEncoder.OutputFormatting
                              = _defaultJSONEncoderOptions,
                            whenDone : @escaping () -> Void = {}) -> Bool
   {
     do {
-      let encoder = makeEncoder()
+      let encoder = JSONEncoderWithISO8601()
       encoder.outputFormatting = outputFormatting
       let data = try encoder.encode(jsonObject)
       return write(data, whenDone: whenDone)
@@ -205,7 +207,8 @@ public extension WritableStreamType where WritablePayload == Buffer {
 }
 
 /// It is undocumented whether the encoder is threadsafe, so assume it is not.
-fileprivate func makeEncoder() -> JSONEncoder {
+@usableFromInline
+func JSONEncoderWithISO8601() -> JSONEncoder {
   let encoder = JSONEncoder()
   if #available(macOS 10.12, iOS 10.0, watchOS 3.0, tvOS 10.0, *) {
     // According to https://github.com/NozeIO/MicroExpress/pull/13 the default
diff --git a/Sources/MacroCore/JSStubs/StringStubs.swift b/Sources/MacroCore/JSStubs/StringStubs.swift
@@ -3,9 +3,12 @@
 //  Macro
 //
 //  Created by Helge Hess.
-//  Copyright © 2021 ZeeZide GmbH. All rights reserved.
+//  Copyright © 2021-2023 ZeeZide GmbH. All rights reserved.
 //
 
+#if canImport(Foundation)
+import Foundation
+
 @inlinable
 public func parseInt(_ string: String, _ radix: Int = 10) -> Int? {
   guard radix >= 2 && radix <= 36 else { return nil }
@@ -31,6 +34,7 @@ public extension String {
     return trimmingCharacters(in: .whitespacesAndNewlines)
   }
 }
+#endif // canImport(Foundation)
 
 public extension Sequence where Element: StringProtocol {
   
diff --git a/Sources/MacroCore/Process/Process.swift b/Sources/MacroCore/Process/Process.swift
@@ -3,11 +3,11 @@
 //  Macro
 //
 //  Created by Helge Hess.
-//  Copyright © 2020-2021 ZeeZide GmbH. All rights reserved.
+//  Copyright © 2020-2023 ZeeZide GmbH. All rights reserved.
 //
 
-import class Foundation.ProcessInfo
 import xsys
+import NIO
 
 #if os(Windows)
   import WinSDK
diff --git a/Sources/MacroCore/StringEncoding.swift b/Sources/MacroCore/StringEncoding.swift
@@ -3,9 +3,12 @@
 //  Macro
 //
 //  Created by Helge Hess.
-//  Copyright © 2020-2021 ZeeZide GmbH. All rights reserved.
+//  Copyright © 2020-2023 ZeeZide GmbH. All rights reserved.
 //
 
+#if canImport(Foundation)
+import Foundation
+
 @usableFromInline
 internal let stringEncodingNames : Set<String> = [
   "utf8", "utf-8",
@@ -66,3 +69,4 @@ public enum CharsetConversionError: Swift.Error {
   case failedToConverData   (encoding: String.Encoding)
   case failedToConvertString(encoding: String.Encoding)
 }
+#endif // canImport(Foundation)
diff --git a/Sources/http/BasicAuth.swift b/Sources/http/BasicAuth.swift
@@ -3,17 +3,24 @@
 //  Macro
 //
 //  Created by Helge Hess.
-//  Copyright © 2020 ZeeZide GmbH. All rights reserved.
+//  Copyright © 2020-2023 ZeeZide GmbH. All rights reserved.
 //
 
 public enum BasicAuthModule {}
 public typealias basicAuth = BasicAuthModule
 
-import Foundation
+#if canImport(Foundation)
+  import Foundation
+#endif
 import enum MacroCore.CharsetConversionError
 
 public extension BasicAuthModule {
 
+  /**
+   * HTTP Basic Authentication credentials as extracted by the
+   * ``auth(_:encoding:)`` function, i.e. the name/password associated
+   * with an ``IncomingMessage``.
+   */
   struct Credentials {
     public let name : String
     public let pass : String
@@ -28,10 +35,35 @@ public extension BasicAuthModule {
     case stringEncodingError
   }
 
-  static func auth(_ req: IncomingMessage, encoding: String.Encoding = .utf8)
+  #if canImport(Foundation) // `String.Encoding.utf8`, provide alternative!
+  /**
+   * Extract HTTP Basic authentication credentials (name/pass) from the given
+   * ```IncomingMessage```.
+   *
+   * - Parameters:
+   *   - request:  The ``IncomingMessage`` containing the `Authorization`
+   *               header.
+   *   - encoding: The encoding the String is using.
+   * - Throws: ``BasicAuthError/missingAuthorizationHeader`` if there is no
+   *   `Authorization` header,
+   *   ``BasicAuthError/unexpectedAuthorizationHeaderType`` if the header
+   *   existed, but wasn't a `String`,
+   *   ``BasicAuthError/invalidAuthorizationHeader`` if the header value
+   *   syntax could not be parsed,
+   *   ``BasicAuthError/differentAuthorization`` if the header was set, but
+   *   wasn't HTTP Basic authentication,
+   *   ``BasicAuthError/invalidBasicAuthorizationHeader`` if the header was
+   *   set, but didn't had the right Basic auth syntax,
+   *   ``BasicAuthError/invalidBasicAuthorizationHeader`` if the header could
+   *   be parsed, but the values could not be parsed using the given
+   *   `encoding` specified.
+   * - Returns: The ``Credentials``, i.e. `name`/`pass`.
+   */
+  static func auth(_ request: IncomingMessage,
+                   encoding: String.Encoding = .utf8)
                 throws -> Credentials
   {
-    guard let authorization = req.getHeader("Authorization") else {
+    guard let authorization = request.getHeader("Authorization") else {
       throw BasicAuthError.missingAuthorizationHeader
     }
     guard let authString = authorization as? String else {
@@ -69,4 +101,5 @@ public extension BasicAuthModule {
       pass: String(string[colIdx..<string.endIndex])
     )
   }
+  #endif // canImport(Foundation)
 }
