SWIFT-985 Add client metadata support for wrapping libraries (#608)

Author: kmahar

Sources/CLibMongoC/include/CLibMongoC_bson-version.h

@@ -31,30 +31,30 @@
  *
  * BSON minor version component (e.g. 2 if %BSON_VERSION is 1.2.3)
  */
-#define BSON_MINOR_VERSION (16)
+#define BSON_MINOR_VERSION (17)
 
 
 /**
  * BSON_MICRO_VERSION:
  *
  * BSON micro version component (e.g. 3 if %BSON_VERSION is 1.2.3)
  */
-#define BSON_MICRO_VERSION (0)
+#define BSON_MICRO_VERSION (4)
 
 
 /**
  * BSON_PRERELEASE_VERSION:
  *
  * BSON prerelease version component (e.g. pre if %BSON_VERSION is 1.2.3-pre)
  */
-#define BSON_PRERELEASE_VERSION (pre)
+#define BSON_PRERELEASE_VERSION ()
 
 /**
  * BSON_VERSION:
  *
  * BSON version.
  */
-#define BSON_VERSION (1.16.0-pre)
+#define BSON_VERSION (1.17.4)
 
 
 /**
@@ -63,7 +63,7 @@
  * BSON version, encoded as a string, useful for printing and
  * concatenation.
  */
-#define BSON_VERSION_S "1.16.0-pre"
+#define BSON_VERSION_S "1.17.4"
 
 
 /**

Sources/CLibMongoC/include/CLibMongoC_mongoc-version.h

@@ -31,31 +31,31 @@
  *
  * MONGOC minor version component (e.g. 2 if %MONGOC_VERSION is 1.2.3)
  */
-#define MONGOC_MINOR_VERSION (16)
+#define MONGOC_MINOR_VERSION (17)
 
 
 /**
  * MONGOC_MICRO_VERSION:
  *
  * MONGOC micro version component (e.g. 3 if %MONGOC_VERSION is 1.2.3)
  */
-#define MONGOC_MICRO_VERSION (0)
+#define MONGOC_MICRO_VERSION (4)
 
 
 /**
  * MONGOC_PRERELEASE_VERSION:
  *
  * MONGOC prerelease version component (e.g. pre if %MONGOC_VERSION is 1.2.3-pre)
  */
-#define MONGOC_PRERELEASE_VERSION (pre)
+#define MONGOC_PRERELEASE_VERSION ()
 
 
 /**
  * MONGOC_VERSION:
  *
  * MONGOC version.
  */
-#define MONGOC_VERSION (1.16.0-pre)
+#define MONGOC_VERSION (1.17.4)
 
 
 /**
@@ -64,7 +64,7 @@
  * MONGOC version, encoded as a string, useful for printing and
  * concatenation.
  */
-#define MONGOC_VERSION_S "1.16.0-pre"
+#define MONGOC_VERSION_S "1.17.4"
 
 
 /**

Sources/MongoSwift/MongoSwift.swift

@@ -3,12 +3,34 @@ import CLibMongoC
 /// MongoSwift only supports MongoDB 3.6+.
 internal let MIN_SUPPORTED_WIRE_VERSION = 6
 
+/// Store optionally provided metadata about a library wrapping the driver.
+private var clientMetadataLibraryName: String?
+private var clientMetadataLibraryVersion: String?
+
+/// Adds metadata to include the in the handshake performed with the MongoDB server. This is intended for use by
+/// libraries wrapping the driver e.g. MongoDBVapor or an ODM. If used, this method should be called exactly once.
+/// This method will only have an effect if called before any `MongoClient`s are initialized.
+public func addWrappingLibraryMetadata(name: String, version: String) {
+    clientMetadataLibraryName = name
+    clientMetadataLibraryVersion = version
+}
+
 private final class MongocInitializer {
     internal static let shared = MongocInitializer()
 
     private init() {
         mongoc_init()
-        mongoc_handshake_data_append("MongoSwift", MongoSwiftVersionString, nil)
+        var libraryName = "MongoSwift"
+        if let additionalName = clientMetadataLibraryName {
+            libraryName += " / \(additionalName)"
+        }
+
+        var libraryVersion = MongoSwiftVersionString
+        if let additionalVersion = clientMetadataLibraryVersion {
+            libraryVersion += " / \(additionalVersion)"
+        }
+
+        mongoc_handshake_data_append(libraryName, libraryVersion, nil)
     }
 }
 

etc/generated_headers/bson-version.h

@@ -31,30 +31,30 @@
  *
  * BSON minor version component (e.g. 2 if %BSON_VERSION is 1.2.3)
  */
-#define BSON_MINOR_VERSION (16)
+#define BSON_MINOR_VERSION (17)
 
 
 /**
  * BSON_MICRO_VERSION:
  *
  * BSON micro version component (e.g. 3 if %BSON_VERSION is 1.2.3)
  */
-#define BSON_MICRO_VERSION (0)
+#define BSON_MICRO_VERSION (4)
 
 
 /**
  * BSON_PRERELEASE_VERSION:
  *
  * BSON prerelease version component (e.g. pre if %BSON_VERSION is 1.2.3-pre)
  */
-#define BSON_PRERELEASE_VERSION (pre)
+#define BSON_PRERELEASE_VERSION ()
 
 /**
  * BSON_VERSION:
  *
  * BSON version.
  */
-#define BSON_VERSION (1.16.0-pre)
+#define BSON_VERSION (1.17.4)
 
 
 /**
@@ -63,7 +63,7 @@
  * BSON version, encoded as a string, useful for printing and
  * concatenation.
  */
-#define BSON_VERSION_S "1.16.0-pre"
+#define BSON_VERSION_S "1.17.4"
 
 
 /**

etc/generated_headers/mongoc-version.h

@@ -31,31 +31,31 @@
  *
  * MONGOC minor version component (e.g. 2 if %MONGOC_VERSION is 1.2.3)
  */
-#define MONGOC_MINOR_VERSION (16)
+#define MONGOC_MINOR_VERSION (17)
 
 
 /**
  * MONGOC_MICRO_VERSION:
  *
  * MONGOC micro version component (e.g. 3 if %MONGOC_VERSION is 1.2.3)
  */
-#define MONGOC_MICRO_VERSION (0)
+#define MONGOC_MICRO_VERSION (4)
 
 
 /**
  * MONGOC_PRERELEASE_VERSION:
  *
  * MONGOC prerelease version component (e.g. pre if %MONGOC_VERSION is 1.2.3-pre)
  */
-#define MONGOC_PRERELEASE_VERSION (pre)
+#define MONGOC_PRERELEASE_VERSION ()
 
 
 /**
  * MONGOC_VERSION:
  *
  * MONGOC version.
  */
-#define MONGOC_VERSION (1.16.0-pre)
+#define MONGOC_VERSION (1.17.4)
 
 
 /**
@@ -64,7 +64,7 @@
  * MONGOC version, encoded as a string, useful for printing and
  * concatenation.
  */
-#define MONGOC_VERSION_S "1.16.0-pre"
+#define MONGOC_VERSION_S "1.17.4"
 
 
 /**