Merge branch 'main' into feature/jo/resp-benchmarker

Author: Joannis

Diff for: .github/release.yml

@@ -0,0 +1,18 @@
+changelog:
+  categories:
+    - title: SemVer Major
+      labels:
+        - semver/major
+    - title: SemVer Minor
+      labels:
+        - semver/minor
+    - title: SemVer Patch
+      labels:
+        - semver/patch
+    - title: Other Changes
+      labels:
+        - semver/none
+    - title: 🚨🚨🚨 Missing Labels - Add labels to the prs listed here and generate the release notes again
+      labels:
+        - "*"
+

Diff for: NOTICE.txt

@@ -26,7 +26,7 @@ components that this product depends on.
 
 -------------------------------------------------------------------------------
 
-This product was heavily influenced by implementations from the Vapor and NozeIO frameworks.
+This product was heavily influenced by Vapor and NozeIO.
 
     * NozeIO
       * LICENSE (Apache License 2.0)
@@ -41,71 +41,36 @@ This product was heavily influenced by implementations from the Vapor and NozeIO
 
 ---
 
-This product contains the entire library from Apple's SwiftLog API.
-
-* LICENSE (Apache License 2.0):
-    * https://github.com/apple/swift-log/blob/master/LICENSE.txt
-* HOMEPAGE:
-    * https://github.com/apple/swift-log
-
----
-
-This product contains the entire library from Apple's SwiftMetrics API.
-
-* LICENSE (Apache License 2.0):
-    * https://github.com/apple/swift-metrics/blob/master/LICENSE.txt
-* HOMEPAGE:
-    * https://github.com/apple/swift-metrics
-
----
-
-This product contains the entire library and derivations of various scripts from Apple's SwiftNIO.
-
-  * LICENSE (Apache License 2.0):
-    * https://github.com/apple/swift-nio/blob/master/LICENSE.txt
-  * HOMEPAGE:
-    * https://github.com/apple/swift-nio
-
----
-
-This product contains a derivation of the Tony Stone's 'process_test_files.rb'.
-
-  * LICENSE (Apache License 2.0):
-    * https://www.apache.org/licenses/LICENSE-2.0
-  * HOMEPAGE:
-    * https://codegists.com/snippet/ruby/generate_xctest_linux_runnerrb_tonystone_ruby
-
----
-
-This product contains NodeJS's http-parser.
-
-  * LICENSE (MIT):
-    * https://github.com/nodejs/http-parser/blob/master/LICENSE-MIT
-  * HOMEPAGE:
-    * https://github.com/nodejs/http-parser
-
----
-
-This product contains "cpp_magic.h" from Thomas Nixon & Jonathan Heathcote's uSHET
-
-  * LICENSE (MIT):
-    * https://github.com/18sg/uSHET/blob/master/LICENSE
-  * HOMEPAGE:
-    * https://github.com/18sg/uSHET
-
----
-
-This product contains "sha1.c" and "sha1.h" from FreeBSD (Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project)
-
-  * LICENSE (BSD-3):
-    * https://opensource.org/licenses/BSD-3-Clause
-  * HOMEPAGE:
-    * https://github.com/freebsd/freebsd/tree/master/sys/crypto
-
----
-This product contains "ifaddrs-android.c" and "ifaddrs-android.h" from dxr.mozilla.org. Webrtc is the owner, but we use edited version from mozilla repo (Copyright (c) 2011, The WebRTC project authors. All rights reserved)
-
-  * LICENSE (BSD):
-    * https://webrtc.googlesource.com/src/+/master/LICENSE
+This product contains a a derivation of Georges Menie's crc16 algorithm that was adopted
+to Redis coding style by Salvatore Sanfilippo.
+
+  * LICENSE:
+    /*
+     * Copyright 2001-2010 Georges Menie (www.menie.org)
+     * Copyright 2010 Salvatore Sanfilippo (adapted to Redis coding style)
+     * All rights reserved.
+     * Redistribution and use in source and binary forms, with or without
+     * modification, are permitted provided that the following conditions are met:
+     *
+     *     * Redistributions of source code must retain the above copyright
+     *       notice, this list of conditions and the following disclaimer.
+     *     * Redistributions in binary form must reproduce the above copyright
+     *       notice, this list of conditions and the following disclaimer in the
+     *       documentation and/or other materials provided with the distribution.
+     *     * Neither the name of the University of California, Berkeley nor the
+     *       names of its contributors may be used to endorse or promote products
+     *       derived from this software without specific prior written permission.
+     *
+     * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
+     * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+     * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+     * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
+     * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+     * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+     * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+     * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+     * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+     * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+     */
   * HOMEPAGE:
-    * https://webrtc.googlesource.com/
+    * https://redis.io/docs/reference/cluster-spec/#appendix-a-crc16-reference-implementation-in-ansi-c

Diff for: README.md

@@ -29,13 +29,14 @@ dependencies: [
 
 ## Getting Started
 
-**RediStack** is quick to use - all you need is an [`EventLoop`](https://apple.github.io/swift-nio/docs/current/NIO/Protocols/EventLoop.html) from **SwiftNIO**.
+**RediStack** is quick to use - all you need is an [`EventLoop`](https://swiftpackageindex.com/apple/swift-nio/main/documentation/niocore/eventloop) from **SwiftNIO**.
 
 ```swift
 import NIOCore
+import NIOPosix
 import RediStack
 
-let eventLoop: EventLoop = ...
+let eventLoop: EventLoop = NIOSingletons.posixEventLoopGroup.any()
 let connection = RedisConnection.make(
     configuration: try .init(hostname: "127.0.0.1"),
     boundEventLoop: eventLoop
@@ -76,7 +77,7 @@ Check out [CONTRIBUTORS.txt](https://github.com/swift-server/RediStack/blob/main
 
 | Proposal | Pitch | Discussion | Review | Vote |
 |:---:|:---:|:---:|:---:|:---:|
-| [SSWG-0004](https://github.com/swift-server/sswg/blob/master/proposals/0004-nio-redis.md) | [2019-01-07](https://forums.swift.org/t/swiftnio-redis-client/19325) | [2019-04-01](https://forums.swift.org/t/discussion-nioredis-nio-based-redis-driver/22455) | [2019-06-09](https://forums.swift.org/t/feedback-redisnio-a-nio-based-redis-driver/25521) | [2019-06-27](https://forums.swift.org/t/june-27th-2019/26580) |
+| [SSWG-0004](https://github.com/swift-server/sswg/blob/main/proposals/0004-nio-redis.md) | [2019-01-07](https://forums.swift.org/t/swiftnio-redis-client/19325) | [2019-04-01](https://forums.swift.org/t/discussion-nioredis-nio-based-redis-driver/22455) | [2019-06-09](https://forums.swift.org/t/feedback-redisnio-a-nio-based-redis-driver/25521) | [2019-06-27](https://forums.swift.org/t/june-27th-2019/26580) |
 
 ## Language and Platform Support
 

Diff for: Sources/RediStack/Cluster/RedisClusterNodeDescriptionProtocol.swift

@@ -0,0 +1,51 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the RediStack open source project
+//
+// Copyright (c) 2023 RediStack project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of RediStack project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import NIOCore
+
+/// A description of a single node that is part of a redis cluster
+public protocol RedisClusterNodeDescriptionProtocol: Sendable, Equatable {
+    /// The node's host name.
+    var host: String? { get }
+    /// The node's ip address.
+    var ip: String? { get }
+    /// The nodes endpoint. This should normally be the ``host`` if the node has a routable hostname.
+    /// Otherwise it is the ``ip``. This property is used to create connections to the node.
+    var endpoint: String { get }
+    /// The node's redis port
+    var port: Int { get }
+    /// Defines if TLS shall be used to create a connection to the node
+    var useTLS: Bool { get }
+
+    /// A resolved SocketAddress to the node. We will remove this property as soon as we have fixed
+    /// the underlying Redis implementation.
+    var socketAddress: SocketAddress { get }
+}
+
+extension RedisClusterNodeDescriptionProtocol {
+    func isSame<Other: RedisClusterNodeDescriptionProtocol>(_ other: Other) -> Bool {
+        return self.ip == other.ip
+            && self.port == other.port
+            && self.endpoint == other.endpoint
+            && self.useTLS == other.useTLS
+            && self.host == other.host
+    }
+}
+
+extension RedisClusterNodeDescriptionProtocol {
+    @inlinable
+    public var id: RedisClusterNodeID {
+        RedisClusterNodeID(endpoint: self.endpoint, port: self.port)
+    }
+}

Diff for: Sources/RediStack/Cluster/RedisClusterNodeID.swift

@@ -0,0 +1,26 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the RediStack open source project
+//
+// Copyright (c) 2023 RediStack project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of RediStack project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+/// Properties to identifiy a Node in a Redis cluster
+public struct RedisClusterNodeID: Hashable, Sendable {
+    /// The node's endpoint. This might be the hostname (preferred) or ip address
+    public var endpoint: String
+    /// The node's redis port
+    public var port: Int
+
+    public init(endpoint: String, port: Int) {
+        self.endpoint = endpoint
+        self.port = port
+    }
+}

Diff for: Sources/RediStack/Cluster/RedisClusterShardDescriptionProtocol.swift

@@ -0,0 +1,24 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the RediStack open source project
+//
+// Copyright (c) 2023 RediStack project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of RediStack project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+/// A description of a single shard that is part of a redis cluster
+public protocol RedisClusterShardDescriptionProtocol: Identifiable, Sendable {
+    associatedtype NodeDescription: RedisClusterNodeDescriptionProtocol
+
+    /// The shard's master node
+    var master: NodeDescription { get }
+
+    /// The shard's replica nodes
+    var replicas: [NodeDescription] { get }
+}