Client configuration

[tg666]

Hi,
when integrating the extension into our project, I found out that the Client configuration has an invalid structure and also that default (null) values are getting into the Client.

Current configuration example:

contributte.elastica:
	debug: %debugMode%
	hosts:
		es01:
			host: elasticsearch
			port: 9200

<?php
​
public function createServiceContributte__elastica__client(): Contributte\Elastica\Client
{
	$service = new Contributte\Elastica\Client(
		[
			'es01' => [
				'host' => 'elasticsearch',
				'port' => 9200,
				'path' => null,
				'url' => null,
				'proxy' => null,
				'transport' => null,
				'persistent' => null,
				'timeout' => null,
				'connections' => [],
				'roundRobin' => null,
				'compression' => null,
				'log' => null,
				'retryOnConflict' => null,
				'bigintConversion' => null,
				'username' => null,
				'password' => null,
			],
		],
		null,
		$this->getService('contributte.monolog.logger.default')
	);
	$this->getService('contributte.elastica.panel')->register($service);
	return $service;
}

But options for the default Client should be in the configuration root. In the case of multiple nodes, they are defined under the key connections.

New configuration example:

contributte.elastica:
	debug: %debugMode%
	config:
		host: elasticsearch
		port: 9200

public function createServiceContributte__elastica__client(): Contributte\Elastica\Client
{
	$service = new Contributte\Elastica\Client(
		['host' => 'elasticsearch`, 'port' => 9200],
		null,
		$this->getService('contributte.monolog.logger.default')
	);
	$this->getService('contributte.elastica.panel')->register($service);
	return $service;
}

I also marked options host, port, username, password and auth_type as dynamic - parameters, env variables etc. are allowed.

Package nette/schema is required because of usage of the method ::skipDefaults() that has been added in the version ^1.2.

[f3l1x]

Hi. Does it means there is not support for multiple configuration?

[tg666]

Ruflin/Elastica supports multiple connections. They can be defined under key connections:
https://github.com/ruflin/Elastica/blob/master/src/Client.php#L619

For example:

contributte.elastica:
	debug: %debugMode%
	config:
		connections:
			-
				host: host1
				port: 1234
				# ...
			-
				host: host2
				port: 5678
				# ...

[f3l1x]

Typo

[tg666]

Fixed

[f3l1x]

Here must be array of structure with predefined keys. Can you put it here?

[tg666]

Done

[f3l1x]

What about enum instead of string?

[tg666]

Good point, I changed it to an enum.

[f3l1x]

Oh, I see it now. Thanks. I've added some comments.

[f3l1x]

Why is it merged here? Can we skip merging?

[tg666]

Because a client config contains 16 options and the options are present in the root config and also under the key config.connections[].
Merging came to be better for me. But yeah if you insist we can skip merging and define the options duplicated.

[f3l1x]

nette/schema is tight with nette/di, we can skip it here.

[tg666]

As I wrote in the first post:

Package nette/schema is required because of usage of the method ::skipDefaults() that has been added in the version ^1.2.

All versions of nette/di requires nette/schema in versions ^1.0 or ^1.1 so here can be compatibility problem.
Another solution could be to remove nette/schema from requirements and add the section conflict:

{
	"conflict": {
		"nette/schema": "<1.2"
	}
}

[f3l1x]

Ping @tg666

[jiripudil]

Hi, is there anything I can help with to get this merged? Correct me if I'm wrong (please do!) but I think the package is now unusable e.g. with docker-compose where ES is usually accessible via a different hostname than the default localhost 🤔

[f3l1x]

It's OK, thanks for pinging me. @jiripudil