Merge branch 'develop'

Author: helje5

.github/workflows/swift.yml

@@ -13,14 +13,12 @@ jobs:
       fail-fast: false
       matrix:
         image:
-          - swift:5.5.3-xenial
-          - swift:5.6.1-bionic
-          - swift:5.7.2-focal
           - swift:5.8-jammy
+          - swift:6.0-noble
     container: ${{ matrix.image }}
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Build Swift Debug Package
         run: swift build -c debug
       - name: Build Swift Release Package
@@ -33,9 +31,9 @@ jobs:
       - name: Select latest available Xcode
         uses: maxim-lobanov/setup-xcode@v1.5.1
         with:
-          xcode-version: 13.2.1
+          xcode-version: latest
       - name: Checkout Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Build Swift Debug Package
         run: swift build -c debug
       - name: Build Swift Release Package

.gitignore

@@ -95,4 +95,6 @@ xcuserdata
 .docker.build
 .swiftpm
 .vscode
+.DS_Store
+*.swp
 

README.md

@@ -85,14 +85,8 @@ would require custom executors. Which are not yet available.
 ### Who
 
 **Macro** is brought to you by
-the
-[Always Right Institute](http://www.alwaysrightinstitute.com)
-and
-[ZeeZide](http://zeezide.de).
-We like 
-[feedback](https://twitter.com/ar_institute), 
-GitHub stars, 
-cool [contract work](http://zeezide.com/en/services/services.html),
+[Helge Heß](https://github.com/helje5/) / [ZeeZide](https://zeezide.de).
+We like feedback, GitHub stars, cool contract work, 
 presumably any form of praise you can think of.
 
 There is a `#microexpress` channel on the 

Sources/MacroCore/Events/ErrorEmitter.swift

@@ -3,7 +3,7 @@
 //  Macro
 //
 //  Created by Helge Hess.
-//  Copyright © 2020 ZeeZide GmbH. All rights reserved.
+//  Copyright © 2020-2023 ZeeZide GmbH. All rights reserved.
 //
 
 public protocol ErrorEmitterType {
@@ -42,7 +42,8 @@ open class ErrorEmitter : ErrorEmitterType, ErrorEmitterTarget {
   @inlinable
   open func emit(error: Error) {
     if errorListeners.isEmpty {
-      let objectInfo = "\(type(of: self)):\(ObjectIdentifier(self))"
+      let id = String(Int(bitPattern: ObjectIdentifier(self)), radix: 16)
+      let objectInfo = "\(type(of: self)):0x\(id)"
       errorLog.error("[\(objectInfo)] Error not handled: \(error)")
     }
     else {

Sources/MacroCore/Process/DetectXcode.swift

@@ -22,8 +22,13 @@ public extension process {
   #else
     static let isRunningInXCode : Bool = {
       // TBD: is there a better way?
-      guard let s = xsys.getenv("XPC_SERVICE_NAME") else { return false }
-      return strstr(s, "Xcode") != nil
+      if let s = xsys.getenv("XPC_SERVICE_NAME") { // not in Xcode 16 anymore
+        if strstr(s, "Xcode") != nil { return true }
+      }
+      if xsys.getenv("__XCODE_BUILT_PRODUCTS_DIR_PATHS") != nil { // Xcode 16
+        return true
+      }
+      return false
     }()
   #endif
 }

Sources/MacroCore/Streams/Concat.swift

@@ -3,7 +3,7 @@
 //  Macro
 //
 //  Created by Helge Hess.
-//  Copyright © 2020 ZeeZide GmbH. All rights reserved.
+//  Copyright © 2020-2023 ZeeZide GmbH. All rights reserved.
 //
 
 /**
@@ -13,6 +13,20 @@
  *
  * Be careful w/ using that. You don't want to baloon payloads in memory!
  *
+ * Usage:
+ * ```
+ * request | concat { buffer in
+ *   console.log("The size of the request body is:", buffer.count)
+ * }
+ * ```
+ *
+ * Pushes a ``ConcatError`` if the maximum size was exceeded.
+ *
+ * - Parameters:
+ *   - maximumSize: The maximum size of the request body. Can be configured
+ *                  using the `macro.concat.maxsize` environment variable.
+ *   - yield:       A closure called with the loaded data (a ``Buffer``).
+ * - Returns: The ``ConcatByteStream``.
  */
 @inlinable
 public func concat(maximumSize: Int = _defaultConcatMaximumSize,
@@ -33,6 +47,20 @@ public func concat(maximumSize: Int = _defaultConcatMaximumSize,
  *
  * Be careful w/ using that. You don't want to baloon payloads in memory!
  *
+ * Usage:
+ * ```
+ * request | concat { buffer in
+ *   console.log("The size of the request body is:", buffer.count)
+ * }
+ * ```
+ *
+ * Pushes a ``ConcatError`` if the maximum size was exceeded.
+ *
+ * - Parameters:
+ *   - maximumSize: The maximum size of the request body. Can be configured
+ *                  using the `macro.concat.maxsize` environment variable.
+ *   - yield:       A closure called with the loaded data (a ``Buffer``).
+ * - Returns: The ``ConcatByteStream``.
  */
 @inlinable
 public func concat(maximumSize: Int = _defaultConcatMaximumSize,
@@ -124,7 +152,8 @@ public class ConcatByteStream: WritableByteStream,
   // MARK: - CustomStringConvertible
 
   open var description: String {
-    var ms = "<Concat[\(ObjectIdentifier(self))]:"
+    let id = String(Int(bitPattern: ObjectIdentifier(self)), radix: 16)
+    var ms = "<Concat[0x\(id)]:"
     defer { ms += ">" }
 
     let count = writableBuffer.count
@@ -146,10 +175,20 @@ public class ConcatByteStream: WritableByteStream,
   }
 }
 
+/**
+ * The ``concat`` middleware failed.
+ */
 public enum ConcatError: Swift.Error {
+  /// The maximum allowed size was exceeded.
   case maximumSizeExceeded(maximumSize: Int, availableSize: Int)
 }
 
+/**
+ * The default maximum request size for the ``concat`` middleware.
+ *
+ * Can be set using the `macro.concat.maxsize` environment variable (in bytes),
+ * and defaults to 1MB.
+ */
 public let _defaultConcatMaximumSize =
   process.getenv("macro.concat.maxsize",
                  defaultValue      : 1024 * 1024, // 1MB

Sources/MacroCore/Streams/ReadableStreamBase.swift

@@ -3,7 +3,7 @@
 //  Macro
 //
 //  Created by Helge Hess.
-//  Copyright © 2020 ZeeZide GmbH. All rights reserved.
+//  Copyright © 2020-2023 ZeeZide GmbH. All rights reserved.
 //
 
 /**
@@ -37,10 +37,12 @@ open class ReadableStreamBase<ReadablePayload>: ErrorEmitter {
   #if DEBUG && false // cycle debugging
   public override init() {
     super.init()
-    print("INIT:\(ObjectIdentifier(self)) \(type(of:self))")
+    let id = String(Int(bitPattern: ObjectIdentifier(self)), radix: 16)
+    print("INIT:0x\(id) \(type(of:self))")
   }
   deinit {
-    print("DEINIT:\(ObjectIdentifier(self)) \(type(of:self))")
+    let id = String(Int(bitPattern: ObjectIdentifier(self)), radix: 16)
+    print("DEINIT:0x\(id) \(type(of:self))")
   }
   #else
   public override init() {

Sources/MacroCore/Streams/WritableStreamBase.swift

@@ -3,7 +3,7 @@
 //  Macro
 //
 //  Created by Helge Hess.
-//  Copyright © 2020 ZeeZide GmbH. All rights reserved.
+//  Copyright © 2020-2023 ZeeZide GmbH. All rights reserved.
 //
 
 /**
@@ -43,10 +43,12 @@ open class WritableStreamBase<WritablePayload>: ErrorEmitter {
   #if DEBUG && false // cycle debugging
   public override init() {
     super.init()
-    print("INIT:\(ObjectIdentifier(self)) \(type(of:self))")
+    let id = String(Int(bitPattern: ObjectIdentifier(self)), radix: 16)
+    print("INIT:0x\(id) \(type(of:self))")
   }
   deinit {
-    print("DEINIT:\(ObjectIdentifier(self)) \(type(of:self))")
+    let id = String(Int(bitPattern: ObjectIdentifier(self)), radix: 16)
+    print("DEINIT:0x\(id) \(type(of:self))")
   }
   #endif
 

Sources/MacroTestUtilities/TestServerResponse.swift

@@ -3,7 +3,7 @@
 //  Macro
 //
 //  Created by Helge Hess.
-//  Copyright © 2020 ZeeZide GmbH. All rights reserved.
+//  Copyright © 2020-2023 ZeeZide GmbH. All rights reserved.
 //
 
 import struct Logging.Logger
@@ -155,7 +155,8 @@ open class TestServerResponse: ServerResponse {
   // MARK: - CustomStringConvertible
 
   override open var description: String {
-    var ms = "<TestResponse[\(ObjectIdentifier(self))]:"
+    let id = String(Int(bitPattern: ObjectIdentifier(self)), radix: 16)
+    var ms = "<TestResponse[0x\(id)]:"
     defer { ms += ">" }
 
     ms += " \(statusCode)"