Release - 0.48.0 (#1926)

* Bump version number
* Add missing method header documentation
* Update changelog
* Update documentation

Author: calvincestari

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change log
 
+## v0.48.0
+- **Customizable subscription message identifiers:** The `WebSocketTransport` initializer can be configured with a subclass of `OperationMessageIdCreator` to provide a unique identifier per request. The default implementation is `ApolloSequencedOperationMessageIdCreator` and retains the current behavior of sequential message numbering. [#1919](https://github.com/apollographql/apollo-ios/pull/1919) - _Thank you to [Clark McNally](https://github.com/cmcnally-beachbody) for the contribution!_
+- **AWS AppSync Compatibility:** Apollo-ios will now correctly handle the `start_ack` message that AWS AppSync servers respond with when a subscription is requested. [#1919](https://github.com/apollographql/apollo-ios/pull/1919) - _Thank you to [Clark McNally](https://github.com/cmcnally-beachbody) for the contribution!_
+- **Updated to version 2.33.6 of the Apollo CLI:** Applies some new vulnerability patches to the CLI, but should not change any output. [#1929](https://github.com/apollographql/apollo-ios/pull/1929)
+- **Improved documentation:** Clarification of cache normalization concepts. [#1710](https://github.com/apollographql/apollo-ios/pull/1710) - _Thank you to [Daniel Morgan](https://github.com/morgz) for the contribution!_
+
 ## v0.47.1
 - **Fixed - Websocket default implementation not included in `ApolloWebSocket` via Cocoapods:** _Thank you to [ketenshi](https://github.com/ketenshi) for the contribution!_
 

Configuration/Shared/Project-Version.xcconfig

@@ -1 +1 @@
-CURRENT_PROJECT_VERSION = 0.47.1
+CURRENT_PROJECT_VERSION = 0.48.0

Sources/ApolloWebSocket/OperationMessageIdCreator.swift

@@ -9,14 +9,18 @@ public protocol OperationMessageIdCreator {
 
 // MARK: - Default Implementation
 
+/// The default implementation of `OperationMessageIdCreator` that uses a sequential numbering scheme.
 public struct ApolloSequencedOperationMessageIdCreator: OperationMessageIdCreator {
   private var sequenceNumberCounter = Atomic<Int>(0)
-  
-  // Internal init methods cannot be used in public methods
+
+  /// Designated initializer.
+  ///
+  /// - Parameter startAt: The number from which the sequenced numbering scheme should start.
   public init(startAt sequenceNumber: Int = 1) {
     sequenceNumberCounter = Atomic<Int>(sequenceNumber)
   }
-  
+
+  /// Returns the number in the current sequence. Will be incremented when calling this method.
   public func requestId() -> String {
     let id = sequenceNumberCounter.value
     _ = sequenceNumberCounter.increment()

Sources/ApolloWebSocket/WebSocketTransport.swift

@@ -87,9 +87,10 @@ public class WebSocketTransport {
   ///   - reconnect: Whether to auto reconnect when websocket looses connection. Defaults to true.
   ///   - reconnectionInterval: How long to wait before attempting to reconnect. Defaults to half a second.
   ///   - allowSendingDuplicates: Allow sending duplicate messages. Important when reconnected. Defaults to true.
-  ///  - connectOnInit: Whether the websocket connects immediately on creation. If false, remember to call `resumeWebSocketConnection()` to connect. Defaults to true.
+  ///   - connectOnInit: Whether the websocket connects immediately on creation. If false, remember to call `resumeWebSocketConnection()` to connect. Defaults to true.
   ///   - connectingPayload: [optional] The payload to send on connection. Defaults to an empty `GraphQLMap`.
   ///   - requestBodyCreator: The `RequestBodyCreator` to use when serializing requests. Defaults to an `ApolloRequestBodyCreator`.
+  ///   - operationMessageIdCreator: The `OperationMessageIdCreator` used to generate a unique message identifier per request. Defaults to `ApolloSequencedOperationMessageIdCreator`.
   public init(websocket: WebSocketClient,
               store: ApolloStore? = nil,
               clientName: String = WebSocketTransport.defaultClientName,

docs/source/api/ApolloWebSocket/README.md

@@ -2,13 +2,15 @@
 
 ## Protocols
 
+-   [OperationMessageIdCreator](protocols/OperationMessageIdCreator/)
 -   [SSLTrustValidator](protocols/SSLTrustValidator/)
 -   [WebSocketClient](protocols/WebSocketClient/)
 -   [WebSocketClientDelegate](protocols/WebSocketClientDelegate/)
 -   [WebSocketTransportDelegate](protocols/WebSocketTransportDelegate/)
 
 ## Structs
 
+-   [ApolloSequencedOperationMessageIdCreator](structs/ApolloSequencedOperationMessageIdCreator/)
 -   [SSLClientCertificateError](structs/SSLClientCertificateError/)
 -   [SSLSettings](structs/SSLSettings/)
 -   [WebSocket.WSError](structs/WebSocket.WSError/)

docs/source/api/ApolloWebSocket/classes/WebSocketTransport.md

@@ -32,7 +32,7 @@ public var clientVersion: String
 - NOTE: Setting this won't override immediately if the socket is still connected, only on reconnection.
 
 ## Methods
-### `init(websocket:store:clientName:clientVersion:sendOperationIdentifiers:reconnect:reconnectionInterval:allowSendingDuplicates:connectOnInit:connectingPayload:requestBodyCreator:)`
+### `init(websocket:store:clientName:clientVersion:sendOperationIdentifiers:reconnect:reconnectionInterval:allowSendingDuplicates:connectOnInit:connectingPayload:requestBodyCreator:operationMessageIdCreator:)`
 
 ```swift
 public init(websocket: WebSocketClient,
@@ -45,7 +45,8 @@ public init(websocket: WebSocketClient,
             allowSendingDuplicates: Bool = true,
             connectOnInit: Bool = true,
             connectingPayload: GraphQLMap? = [:],
-            requestBodyCreator: RequestBodyCreator = ApolloRequestBodyCreator())
+            requestBodyCreator: RequestBodyCreator = ApolloRequestBodyCreator(),
+            operationMessageIdCreator: OperationMessageIdCreator = ApolloSequencedOperationMessageIdCreator())
 ```
 
 Designated initializer
@@ -59,9 +60,10 @@ Designated initializer
   - reconnect: Whether to auto reconnect when websocket looses connection. Defaults to true.
   - reconnectionInterval: How long to wait before attempting to reconnect. Defaults to half a second.
   - allowSendingDuplicates: Allow sending duplicate messages. Important when reconnected. Defaults to true.
- - connectOnInit: Whether the websocket connects immediately on creation. If false, remember to call `resumeWebSocketConnection()` to connect. Defaults to true.
+  - connectOnInit: Whether the websocket connects immediately on creation. If false, remember to call `resumeWebSocketConnection()` to connect. Defaults to true.
   - connectingPayload: [optional] The payload to send on connection. Defaults to an empty `GraphQLMap`.
   - requestBodyCreator: The `RequestBodyCreator` to use when serializing requests. Defaults to an `ApolloRequestBodyCreator`.
+  - operationMessageIdCreator: The `OperationMessageIdCreator` used to generate a unique message identifier per request. Defaults to `ApolloSequencedOperationMessageIdCreator`.
 
 #### Parameters
 
@@ -75,6 +77,10 @@ Designated initializer
 | reconnect | Whether to auto reconnect when websocket looses connection. Defaults to true. |
 | reconnectionInterval | How long to wait before attempting to reconnect. Defaults to half a second. |
 | allowSendingDuplicates | Allow sending duplicate messages. Important when reconnected. Defaults to true. |
+| connectOnInit | Whether the websocket connects immediately on creation. If false, remember to call `resumeWebSocketConnection()` to connect. Defaults to true. |
+| connectingPayload | [optional] The payload to send on connection. Defaults to an empty `GraphQLMap`. |
+| requestBodyCreator | The `RequestBodyCreator` to use when serializing requests. Defaults to an `ApolloRequestBodyCreator`. |
+| operationMessageIdCreator | The `OperationMessageIdCreator` used to generate a unique message identifier per request. Defaults to `ApolloSequencedOperationMessageIdCreator`. |
 
 ### `isConnected()`
 

docs/source/api/ApolloWebSocket/protocols/OperationMessageIdCreator.md

@@ -0,0 +1,14 @@
+**PROTOCOL**
+
+# `OperationMessageIdCreator`
+
+```swift
+public protocol OperationMessageIdCreator
+```
+
+## Methods
+### `requestId()`
+
+```swift
+func requestId() -> String
+```

docs/source/api/ApolloWebSocket/structs/ApolloSequencedOperationMessageIdCreator.md

@@ -0,0 +1,34 @@
+**STRUCT**
+
+# `ApolloSequencedOperationMessageIdCreator`
+
+```swift
+public struct ApolloSequencedOperationMessageIdCreator: OperationMessageIdCreator
+```
+
+The default implementation of `OperationMessageIdCreator` that uses a sequential numbering scheme.
+
+## Methods
+### `init(startAt:)`
+
+```swift
+public init(startAt sequenceNumber: Int = 1)
+```
+
+Designated initializer.
+
+- Parameter startAt: The number from which the sequenced numbering scheme should start.
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| startAt | The number from which the sequenced numbering scheme should start. |
+
+### `requestId()`
+
+```swift
+public func requestId() -> String
+```
+
+Returns the number in the current sequence. Will be incremented when calling this method.