Prefix all synchronous types with Sync (#334)

Author: kmahar

Sources/AtlasConnectivity/main.swift

@@ -12,7 +12,7 @@ for config in configs {
     }
 
     do {
-        let client = try MongoClient(uri)
+        let client = try SyncMongoClient(uri)
         // run isMaster
         let db = client.db("test")
         _ = try db.runCommand(["isMaster": 1])

Sources/MongoSwift/APM.swift

@@ -456,7 +456,7 @@ private func postNotification<T: MongoEvent>(type: T.Type,
     guard let context = contextFunc(event) else {
         fatalError("Missing context for \(type)")
     }
-    let client = Unmanaged<MongoClient>.fromOpaque(context).takeUnretainedValue()
+    let client = Unmanaged<SyncMongoClient>.fromOpaque(context).takeUnretainedValue()
     let notification = Notification(name: type.eventName, userInfo: ["event": eventStruct])
     client.notificationCenter.post(notification)
 }
@@ -493,7 +493,7 @@ extension Notification.Name {
 /// An extension of `ConnectionPool` to add monitoring capability for commands and server discovery and monitoring.
 extension ConnectionPool {
     /// Internal function to install monitoring callbacks for this pool.
-    internal func initializeMonitoring(commandMonitoring: Bool, serverMonitoring: Bool, client: MongoClient) {
+    internal func initializeMonitoring(commandMonitoring: Bool, serverMonitoring: Bool, client: SyncMongoClient) {
         guard let callbacks = mongoc_apm_callbacks_new() else {
             fatalError("failed to initialize new mongoc_apm_callbacks_t")
         }
@@ -517,8 +517,8 @@ extension ConnectionPool {
             mongoc_apm_set_server_heartbeat_failed_cb(callbacks, serverHeartbeatFailed)
         }
 
-        // we can pass the MongoClient as unretained because the callbacks are stored on clientHandle, so if the
-        // callback is being executed, this pool and therefore its parent `MongoClient` must still be valid.
+        // we can pass the SyncMongoClient as unretained because the callbacks are stored on clientHandle, so if the
+        // callback is being executed, this pool and therefore its parent `SyncMongoClient` must still be valid.
         switch self.mode {
         case let .single(clientHandle):
             mongoc_client_set_apm_callbacks(clientHandle, callbacks, Unmanaged.passUnretained(client).toOpaque())

Sources/MongoSwift/BSON/CodingStrategies.swift

@@ -35,8 +35,9 @@ public struct BSONCoderOptions: CodingStrategyProvider {
 
 /**
  * Enum representing the various encoding/decoding strategy pairs for `Date`s.
- * Set these on a `MongoClient`, `MongoDatabase`, or `MongoCollection` so that the strategies will be applied when
- * converting `Date`s between their BSON representations and their representations in (non `Document`) `Codable` types.
+ * Set these on a `MongoClient`, `MongoDatabase`, or `MongoCollection`, or a `SyncMongoClient`, `SyncMongoDatabase`, or
+ * `SyncMongoCollection`, so that the strategies will be applied when converting `Date`s between their BSON
+ * representations and their representations in (non `Document`) `Codable` types.
  *
  * As per the BSON specification, the default strategy is to encode `Date`s as BSON datetime objects.
  *
@@ -119,9 +120,10 @@ public enum DateCodingStrategy: RawRepresentable {
 }
 
 /**
- * Enum representing the various encoding/decoding strategy pairs for `UUID`s.
- * Set these on a `MongoClient`, `MongoDatabase`, or `MongoCollection` so that the strategies will be applied when
- * converting `UUID`s between their BSON representations and their representations in (non `Document`) `Codable` types.
+ * Enum representing the various encoding/decoding strategy pairs for `Date`s.
+ * Set these on a `MongoClient`, `MongoDatabase`, or `MongoCollection`, or a `SyncMongoClient`, `SyncMongoDatabase`, or
+ * `SyncMongoCollection`, so that the strategies will be applied when converting `UUID`s between their BSON
+ * representations and their representations in (non `Document`) `Codable` types.
  *
  * As per the BSON specification, the default strategy is to encode `UUID`s as BSON binary types with the UUID
  * subtype.
@@ -159,9 +161,10 @@ public enum UUIDCodingStrategy: RawRepresentable {
 }
 
 /**
- * Enum representing the various encoding/decoding strategy pairs for `Data`s.
- * Set these on a `MongoClient`, `MongoDatabase`, or `MongoCollection` so that the strategies will be applied when
- * converting `Data`s between their BSON representations and their representations in (non `Document`) `Codable` types.
+ * Enum representing the various encoding/decoding strategy pairs for `Date`s.
+ * Set these on a `MongoClient`, `MongoDatabase`, or `MongoCollection`, or a `SyncMongoClient`, `SyncMongoDatabase`, or
+ * `SyncMongoCollection`, so that the strategies will be applied when converting `Data`s between their BSON
+ * representations and their representations in (non `Document`) `Codable` types.
  *
  * As per the BSON specification, the default strategy is to encode `Data`s as BSON binary types with the generic
  * binary subtype.

Sources/MongoSwift/ChangeStream.swift

@@ -24,15 +24,18 @@ public struct ResumeToken: Codable, Equatable {
     }
 }
 
-/// A MongoDB ChangeStream.
+/// A synchronous MongoDB change stream.
 /// - SeeAlso: https://docs.mongodb.com/manual/changeStreams/
-public class ChangeStream<T: Codable>: Sequence, IteratorProtocol {
+public class SyncChangeStream<T: Codable>: Sequence, IteratorProtocol {
     /// Enum for tracking the state of a change stream.
     internal enum State {
         /// Indicates that the change stream is still open. Stores a pointer to the `mongoc_change_stream_t`, along
         /// with the source connection, client, and possibly session to ensure they are kept alive as long
         /// as the change stream is.
-        case open(changeStream: OpaquePointer, connection: Connection, client: MongoClient, session: ClientSession?)
+        case open(changeStream: OpaquePointer,
+                  connection: Connection,
+                  client: SyncMongoClient,
+                  session: SyncClientSession?)
         case closed
     }
 
@@ -134,15 +137,15 @@ public class ChangeStream<T: Codable>: Sequence, IteratorProtocol {
     }
 
     /**
-     * Initializes a `ChangeStream`.
+     * Initializes a `SyncChangeStream`.
      * - Throws:
      *   - `ServerError.commandError` if an error occurred on the server when creating the `mongoc_change_stream_t`.
      *   - `UserError.invalidArgumentError` if the `mongoc_change_stream_t` was created with invalid options.
      */
     internal init(stealing changeStream: OpaquePointer,
                   connection: Connection,
-                  client: MongoClient,
-                  session: ClientSession?,
+                  client: SyncMongoClient,
+                  session: SyncClientSession?,
                   decoder: BSONDecoder,
                   options: ChangeStreamOptions?
                   ) throws {

Sources/MongoSwift/ChangeStreamDocument.swift

@@ -37,7 +37,7 @@ public enum OperationType: String, Codable {
     case rename
 }
 
-/// The response document type from a `ChangeStream`.
+/// The response document type from a `ChangeStream` or a `SyncChangeStream`.
 public struct ChangeStreamEvent<T: Codable>: Codable {
     /// Describes the type of operation for this change.
     public let operationType: OperationType
@@ -64,7 +64,7 @@ public struct ChangeStreamEvent<T: Codable>: Codable {
     /**
      * Always present for operations of type `insert` and `replace`. Also present for operations of type `update` if
      * the user has specified `.updateLookup` for the `fullDocument` option in the `ChangeStreamOptions` used to create
-     * the `ChangeStream` that emitted this document.
+     * the change stream that emitted this document.
      *
      * For operations of type `insert’ and `replace’, this key will contain the document being inserted, or the new
      * version of the document that is replacing the existing document, respectively.

Sources/MongoSwift/ChangeStreamOptions.swift

@@ -26,7 +26,7 @@ public enum FullDocument: RawRepresentable, Codable {
     }
 }
 
-/// Options to use when creating a `ChangeStream`.
+/// Options to use when creating a `ChangeStream` or `SyncChangeStream`.
 public struct ChangeStreamOptions: Codable {
     /// The number of documents to return per batch. If omitted, the server will use its default batch size.
     /// - SeeAlso: https://docs.mongodb.com/manual/reference/command/aggregate

Sources/MongoSwift/ClientSession.swift

@@ -1,7 +1,7 @@
 import Foundation
 import mongoc
 
-/// Options to use when creating a ClientSession.
+/// Options to use when creating a `ClientSession` or `SyncClientSession`.
 public struct ClientSessionOptions {
     /// Whether to enable causal consistency for this session. By default, causal consistency is enabled.
     ///
@@ -31,7 +31,7 @@ private func withSessionOpts<T>(wrapping options: ClientSessionOptions?,
  * A MongoDB client session.
  * This class represents a logical session used for ordering sequential operations.
  *
- * To create a client session, use `startSession` or `withSession` on a `MongoClient`.
+ * To create a client session, use `startSession` or `withSession` on a `MongoClient` or a `SyncMongoClient`.
  *
  * If `causalConsistency` is not set to `false` when starting a session, read and write operations that use the session
  * will be provided causal consistency guarantees depending on the read and write concerns used. Using "majority"
@@ -55,12 +55,12 @@ private func withSessionOpts<T>(wrapping options: ClientSessionOptions?,
  *   - https://docs.mongodb.com/manual/core/read-isolation-consistency-recency/#sessions
  *   - https://docs.mongodb.com/manual/core/causal-consistency-read-write-concerns/
  */
-public final class ClientSession {
+public final class SyncClientSession {
     /// Error thrown when an inactive session is used.
     internal static let SessionInactiveError = UserError.logicError(message: "Tried to use an inactive session")
     /// Error thrown when a user attempts to use a session with a client it was not created from.
     internal static let ClientMismatchError = UserError.invalidArgumentError(
-        message: "Sessions may only be used with the MongoClient used to create them")
+        message: "Sessions may only be used with the client used to create them")
 
     /// Enum for tracking the state of a session.
     internal enum State {
@@ -83,7 +83,7 @@ public final class ClientSession {
     }
 
     /// The client used to start this session.
-    public let client: MongoClient
+    public let client: SyncMongoClient
 
     /// The session ID of this session.
     public let id: Document
@@ -122,7 +122,7 @@ public final class ClientSession {
     public let options: ClientSessionOptions?
 
     /// Initializes a new client session.
-    internal init(client: MongoClient, options: ClientSessionOptions? = nil) throws {
+    internal init(client: SyncMongoClient, options: ClientSessionOptions? = nil) throws {
         self.options = options
         self.client = client
 
@@ -144,12 +144,12 @@ public final class ClientSession {
 
     /// Retrieves this session's underlying connection. Throws an error if the provided client was not the client used
     /// to create this session, or if this session has been ended.
-    internal func getConnection(forUseWith client: MongoClient) throws -> Connection {
+    internal func getConnection(forUseWith client: SyncMongoClient) throws -> Connection {
         guard case let .active(_, connection) = self.state else {
-            throw ClientSession.SessionInactiveError
+            throw SyncClientSession.SessionInactiveError
         }
         guard self.client == client else {
-            throw ClientSession.ClientMismatchError
+            throw SyncClientSession.ClientMismatchError
         }
         return connection
     }
@@ -202,7 +202,7 @@ public final class ClientSession {
     ///   - `UserError.logicError` if this session is inactive
     internal func append(to doc: inout Document) throws {
         guard case let .active(session, _) = self.state else {
-            throw ClientSession.SessionInactiveError
+            throw SyncClientSession.SessionInactiveError
         }
 
         var error = bson_error_t()