Class: Mongo::Server::AppMetadata Private

Relationships & Source Files
Namespace Children
Classes: `Environment`, `Platform`, `Truncator`
Extension / Inclusion / Inheritance Descendants
Subclasses: Monitor::AppMetadata
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, Forwardable
Inherits:	Object
Defined in:	lib/mongo/server/app_metadata.rb, lib/mongo/server/app_metadata/environment.rb, lib/mongo/server/app_metadata/platform.rb, lib/mongo/server/app_metadata/truncator.rb

Overview

Application metadata that is sent to the server during a handshake, when a new connection is established.

Since:

2.0.0

Constant Summary

AUTH_OPTION_KEYS =

Option keys that affect auth mechanism negotiation.
Since:
- 2.0.0
# File 'lib/mongo/server/app_metadata.rb', line 37
```
%i[ user auth_source auth_mech].freeze
```
DRIVER_NAME =

The driver name.
Since:
- 2.0.0
# File 'lib/mongo/server/app_metadata.rb', line 34
```
'mongo-ruby-driver'
```
MAX_APP_NAME_SIZE =

The max application name byte size.
Since:
- 2.0.0
# File 'lib/mongo/server/app_metadata.rb', line 31
```
128
```
PURPOSES =

Possible connection purposes.
Since:
- 2.0.0
# File 'lib/mongo/server/app_metadata.rb', line 40
```
%i[ application monitor push_monitor ].freeze
```

Class Method Summary

.new(options = {}) ⇒ AppMetadata constructor Internal use only

Instantiate the new AppMetadata object.

Instance Attribute Summary

#platform ⇒ String readonly Internal use only
#purpose ⇒ Symbol readonly Internal use only
#server_api ⇒ Hash | nil readonly Internal use only
#wrapping_libraries ⇒ Array<Hash> | nil readonly Internal use only

Instance Method Summary

#client_document ⇒ BSON::Document Internal use only

Get BSON::Document to be used as value for client key in handshake document.
#validated_document ⇒ BSON::Document Internal use only

Get the metadata as BSON::Document to be sent to as part of the handshake.
#architecture private Internal use only
#check_purpose!(purpose) ⇒ String | nil private Internal use only

Verifies that the given purpose is either nil, or is one of the allowed purposes.
#document ⇒ BSON::Document private Internal use only

Get the metadata as BSON::Document to be sent to as part of the handshake.
#driver_doc private Internal use only
#env_doc ⇒ Hash | nil private Internal use only

Returns the environment doc describing the current execution environment.
#name private Internal use only
#os_doc private Internal use only
#platform_string private Internal use only
#type private Internal use only
#validate! private Internal use only

Check whether it is possible to build a valid app metadata document with params provided on initialization.

Constructor Details

.new(options = {}) ⇒ `AppMetadata`

Instantiate the new AppMetadata object.

Examples:

Instantiate the app metadata.

Mongo::Server::AppMetadata.new(options)

Parameters:

options (Hash) (defaults to: {}) —
Metadata options.

Options Hash (options):

:app_name (String, Symbol) —
Application name that is printed to the mongod logs upon establishing a connection
:auth_mech (Symbol) —
The authentication mechanism to use. One of :mongodb_cr, :mongodb_x509, :plain, :scram, :scram256
:auth_source (String) —
The source to authenticate from.
:compressors (Array<String>) —
A list of potential compressors to use, in order of preference. The driver chooses the first compressor that is also supported by the server. Currently the driver only supports 'zstd', 'snappy' and 'zlib'.
:platform (String) —
AppMetadata::Platform information to include in the metadata printed to the mongod logs upon establishing a connection
:purpose (Symbol) —
The purpose of this connection.
:server_api (Hash) —
The requested server API version. This hash can have the following items:
- :version -- string
- :strict -- boolean
- :deprecation_errors -- boolean
:user (String) —
The user name.
:wrapping_libraries (Array<Hash>) —
Information about libraries such as ODMs that are wrapping the driver. Specify the lower level libraries first. Allowed hash keys: :name, :version, :platform.

Since:

2.4.0

[ GitHub ]

# File 'lib/mongo/server/app_metadata.rb', line 72


def initialize(options = {})
  @app_name = options[:app_name].to_s if options[:app_name]
  @platform = options[:platform]

  @purpose = check_purpose!(options[:purpose])

  @compressors = options[:compressors] || []
  @wrapping_libraries = options[:wrapping_libraries]
  @server_api = options[:server_api]

  return unless options[:user] && !options[:auth_mech]

  auth_db = options[:auth_source] || 'admin'
  @request_auth_mech = "#{auth_db}.#{options[:user]}"
end

Instance Attribute Details

#platform ⇒ `String` (readonly)

Returns:

(String) —
The platform information given when the object was instantiated.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/app_metadata.rb', line 94


attr_reader :platform

#purpose ⇒ Symbol (readonly)

Returns:

(Symbol) —
The purpose of the connection for which this app metadata is created.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/app_metadata.rb', line 90


attr_reader :purpose

#server_api ⇒ `Hash` | `nil` (readonly)

Returns:

(Hash | nil) —
The requested server API version.

This hash can have the following items:
- :version -- string
- :strict -- boolean
- :deprecation_errors -- boolean

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/app_metadata.rb', line 102


attr_reader :server_api

#wrapping_libraries ⇒ `Array`<`Hash`> | `nil` (readonly)

Returns:

(Array<Hash> | nil) —
Information about libraries wrapping the driver.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/app_metadata.rb', line 106


attr_reader :wrapping_libraries

Instance Method Details

#architecture (private)

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/app_metadata.rb', line 211


def architecture
  RbConfig::CONFIG['target_cpu']
end

#check_purpose!(purpose) ⇒ `String` | `nil` (private)

Verifies that the given purpose is either nil, or is one of the allowed purposes.

Parameters:

purpose (String | nil) —
The purpose to validate

Returns:

(String | nil) —
the {purpose} argument

Raises:

(ArgumentError) —
if the purpose is invalid

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/app_metadata.rb', line 227


def check_purpose!(purpose)
  return purpose unless purpose && !PURPOSES.include?(purpose)

  raise ArgumentError, "Invalid purpose: #{purpose}"
end

#client_document ⇒ `BSON::Document`

Get BSON::Document to be used as value for client key in handshake document.

Returns:

(BSON::Document) —
Document describing client for handshake.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/app_metadata.rb', line 126


def client_document
  @client_document ||=
    BSON::Document.new.tap do |doc|
      doc[:application] = { name: @app_name } if @app_name
      doc[:driver] = driver_doc
      doc[:os] = os_doc
      doc[:platform] = platform_string
      doc[:backpressure] = true
      env_doc.tap { |env| doc[:env] = env if env }
    end
end

#document ⇒ `BSON::Document` (private)

Get the metadata as BSON::Document to be sent to as part of the handshake. The document should be appended to a suitable handshake command.

Returns:

(BSON::Document) —
Document for connection's handshake.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/app_metadata.rb', line 157


def document
  @document ||= begin
    client = Truncator.new(client_document).document
    BSON::Document.new(compression: @compressors, client: client).tap do |doc|
      doc[:saslSupportedMechs] = @request_auth_mech if @request_auth_mech
      doc.update(Utils.transform_server_api(@server_api)) if @server_api
    end
  end
end

#driver_doc (private)

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/app_metadata.rb', line 167


def driver_doc
  names = [ DRIVER_NAME ]
  versions = [ Mongo::VERSION ]
  wrapping_libraries&.each do |library|
    names << (library[:name] || '')
    versions << (library[:version] || '')
  end

  {
    name: names.join('|'),
    version: versions.join('|'),
  }
end

#env_doc ⇒ `Hash` | `nil` (private)

Returns the environment doc describing the current execution environment.

Returns:

(Hash | nil) —
the environment doc (or nil if no relevant environment info was detected)

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/app_metadata.rb', line 194


def env_doc
  env = Environment.new
  env.present? ? env.to_h : nil
end

#name (private)

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/app_metadata.rb', line 207


def name
  RbConfig::CONFIG['host_os']
end

#os_doc (private)

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/app_metadata.rb', line 181


def os_doc
  {
    type: type,
    name: name,
    architecture: architecture,
  }
end

#platform_string (private)

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/app_metadata.rb', line 215


def platform_string
  Platform.new(self).to_s
end

#type (private)

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/app_metadata.rb', line 199


def type
  if RbConfig::CONFIG && RbConfig::CONFIG['host_os']
    RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase
  else
    'unknown'
  end
end

#validate! (private)

Check whether it is possible to build a valid app metadata document with params provided on initialization.

Raises:

(Error::InvalidApplicationName) —
When the metadata are invalid.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/app_metadata.rb', line 144


def validate!
  if @app_name && @app_name.bytesize > MAX_APP_NAME_SIZE
    raise Error::InvalidApplicationName.new(@app_name, MAX_APP_NAME_SIZE)
  end

  true
end

#validated_document ⇒ `BSON::Document`

Get the metadata as BSON::Document to be sent to as part of the handshake. The document should be appended to a suitable handshake command.

This method ensures that the metadata are valid.

Returns:

(BSON::Document) —
Valid document for connection's handshake.

Raises:

(Error::InvalidApplicationName) —
When the metadata are invalid.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/app_metadata.rb', line 117


def validated_document
  validate!
  document
end

Class: Mongo::Server::AppMetadata Private

Overview

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(options = {}) ⇒ AppMetadata

Instance Attribute Details

#platform ⇒ String (readonly)

#purpose ⇒ Symbol (readonly)

#server_api ⇒ Hash | nil (readonly)

#wrapping_libraries ⇒ Array<Hash> | nil (readonly)

Instance Method Details

#architecture (private)

#check_purpose!(purpose) ⇒ String | nil (private)

#client_document ⇒ BSON::Document

#document ⇒ BSON::Document (private)

#driver_doc (private)

#env_doc ⇒ Hash | nil (private)

#name (private)

#os_doc (private)

#platform_string (private)

#type (private)

#validate! (private)

#validated_document ⇒ BSON::Document

.new(options = {}) ⇒ `AppMetadata`

#platform ⇒ `String` (readonly)

#server_api ⇒ `Hash` | `nil` (readonly)

#wrapping_libraries ⇒ `Array`<`Hash`> | `nil` (readonly)

#check_purpose!(purpose) ⇒ `String` | `nil` (private)

#client_document ⇒ `BSON::Document`

#document ⇒ `BSON::Document` (private)

#env_doc ⇒ `Hash` | `nil` (private)

#validated_document ⇒ `BSON::Document`