RUBY-1136 Allow ODM name and version to be included in app_metadata

Author: estolfo

lib/mongo/client.rb

@@ -47,6 +47,8 @@ class Client
       :max_read_retries,
       :min_pool_size,
       :monitoring,
+      :odm_name,
+      :odm_version,
       :password,
       :read,
       :read_retry_interval,
@@ -222,6 +224,11 @@ def hash
     #   for documents. Must respond to #generate.
     # @option options [ String, Symbol ] :app_name Application name that is printed to the
     #   mongod logs upon establishing a connection in server versions >= 3.4.
+    # @option options [ String, Symbol ] :odm_name ODM name that is printed to the
+    #   mongod logs upon establishing a connection in server versions >= 3.4.
+    # @option options [ String, Symbol ] :odm_version ODM version that is printed to the
+    #   mongod logs upon establishing a connection in server versions >= 3.4. Note that the
+    #   ODM version will only be included if an ODM name is also provided.
     #
     # @since 2.0.0
     def initialize(addresses_or_uri, options = Options::Redacted.new)

lib/mongo/cluster/app_metadata.rb

@@ -53,6 +53,8 @@ class AppMetadata
       # @since 2.4.0
       def initialize(cluster)
         @app_name = cluster.options[:app_name]
+        @odm_name = cluster.options[:odm_name]
+        @odm_version = cluster.options[:odm_version]
       end
 
       # Get the bytes of the ismaster message including this metadata.
@@ -108,7 +110,16 @@ def driver_doc
         {
           name: DRIVER_NAME,
           version: Mongo::VERSION
-        }
+        }.tap do |doc|
+          doc.merge!(odm: odm_doc) if odm_doc
+        end
+      end
+
+      def odm_doc
+        @odm_doc ||= if @odm_name
+          doc = { name: @odm_name }
+          @odm_version ? doc.merge!(version: @odm_version) : doc
+        end
       end
 
       def os_doc

spec/mongo/client_spec.rb

@@ -271,6 +271,58 @@
           expect(client.cluster.options[:heartbeat_frequency]).to eq(client.options[:heartbeat_frequency])
         end
       end
+
+      context 'when odm details are specified' do
+
+        let(:app_metadata) do
+          client.cluster.app_metadata
+        end
+
+        context 'when there is an odm name provided' do
+
+          let(:client) do
+            described_class.new(['127.0.0.1:27017'], :odm_name => 'mongoid')
+          end
+
+          it 'includes the odm name in the app metadata' do
+            expect(app_metadata.send(:full_client_document)[:driver][:odm][:name]).to eq('mongoid')
+          end
+
+          context 'when there is an odm version provided' do
+
+            let(:client) do
+              described_class.new(['127.0.0.1:27017'], odm_name: 'mongoid', odm_version: '6.0.2')
+            end
+
+            it 'includes the odm name and version in the app metadata' do
+              expect(app_metadata.send(:full_client_document)[:driver][:odm][:version]).to eq('6.0.2')
+              expect(app_metadata.send(:full_client_document)[:driver][:odm][:name]).to eq('mongoid')
+            end
+          end
+        end
+
+        context 'when there is no odm name provided' do
+
+          let(:client) do
+            described_class.new(['127.0.0.1:27017'])
+          end
+
+          it 'does not include an odm name in the app metadata' do
+            expect(app_metadata.send(:full_client_document)[:driver][:odm]).to be_nil
+          end
+
+          context 'when there is an odm version provided' do
+
+            let(:client) do
+              described_class.new(['127.0.0.1:27017'], odm_version: '6.0.2')
+            end
+
+            it 'does not include an odm doc in the app metadata' do
+              expect(app_metadata.send(:full_client_document)[:driver][:odm]).to be_nil
+            end
+          end
+        end
+      end
     end
 
     context 'when providing a connection string' do