Skip to content

Commit eee55d5

Browse files
paulinevospaulinevos
committed
Extract driver options into value objects
So we can unit test options, as we're transforming some of the options that are passed stuff
1 parent 98c020d commit eee55d5

File tree

5 files changed

+495
-0
lines changed

5 files changed

+495
-0
lines changed

‎src/Client.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ public function __construct(?string $uri = null, array $uriOptions = [], array $
141141
$driverOptions = array_diff_key($driverOptions, ['builderEncoder' => 1, 'typeMap' => 1]);
142142

143143
$this->manager = new Manager($uri, $uriOptions, $driverOptions);
144+
144145
$this->readConcern = $this->manager->getReadConcern();
145146
$this->readPreference = $this->manager->getReadPreference();
146147
$this->writeConcern = $this->manager->getWriteConcern();

‎src/ValueObject/AutoEncryptionOptions.php‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
<?php
2+
3+
namespace MongoDB\ValueObject;
4+
5+
use MongoDB\Client;
6+
use MongoDB\Driver\Manager;
7+
use MongoDB\Exception\InvalidArgumentException;
8+
use stdClass;
9+
10+
use function array_diff_key;
11+
use function array_filter;
12+
use function is_array;
13+
use function sprintf;
14+
15+
/** @internal */
16+
final class AutoEncryptionOptions
17+
{
18+
private const KEY_KEY_VAULT_CLIENT = 'keyVaultClient';
19+
private const KEY_KMS_PROVIDERS = 'kmsProviders';
20+
21+
private function __construct(
22+
private readonly ?Manager $keyVaultClient,
23+
private readonly array $kmsProviders,
24+
private readonly array $miscOptions,
25+
) {
26+
}
27+
28+
public static function fromArray(array $options): self
29+
{
30+
self::ensureValidArrayOptions($options);
31+
32+
// The server requires an empty document for automatic credentials.
33+
if (isset($options[self::KEY_KMS_PROVIDERS]) && is_array($options[self::KEY_KMS_PROVIDERS])) {
34+
foreach ($options[self::KEY_KMS_PROVIDERS] as $name => $provider) {
35+
if ($provider === []) {
36+
$options[self::KEY_KMS_PROVIDERS][$name] = new stdClass();
37+
}
38+
}
39+
}
40+
41+
$keyVaultClient = $options[self::KEY_KEY_VAULT_CLIENT];
42+
43+
return new self(
44+
keyVaultClient: $keyVaultClient instanceof Client ? $keyVaultClient->getManager() : $keyVaultClient,
45+
kmsProviders: $options[self::KEY_KMS_PROVIDERS] ?? [],
46+
miscOptions: array_diff_key($options, [self::KEY_KEY_VAULT_CLIENT => 1, self::KEY_KMS_PROVIDERS => 1]),
47+
);
48+
}
49+
50+
public function toArray(): array
51+
{
52+
return array_filter(
53+
[
54+
self::KEY_KEY_VAULT_CLIENT => $this->keyVaultClient,
55+
self::KEY_KMS_PROVIDERS => $this->kmsProviders,
56+
] + $this->miscOptions,
57+
fn ($option) => $option !== null,
58+
);
59+
}
60+
61+
/** @throws InvalidArgumentException */
62+
private static function ensureValidArrayOptions(array $options): void
63+
{
64+
$keyVaultClient = $options[self::KEY_KEY_VAULT_CLIENT] ?? null;
65+
66+
if ($keyVaultClient !== null && ! $keyVaultClient instanceof Client && ! $keyVaultClient instanceof Manager) {
67+
throw InvalidArgumentException::invalidType(
68+
sprintf('"%s" option', self::KEY_KEY_VAULT_CLIENT),
69+
$keyVaultClient,
70+
[Client::class, Manager::class],
71+
);
72+
}
73+
}
74+
}

‎src/ValueObject/DriverOptions.php‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
<?php
2+
3+
namespace MongoDB\ValueObject;
4+
5+
use Composer\InstalledVersions;
6+
use MongoDB\Builder\BuilderEncoder;
7+
use MongoDB\Codec\Encoder;
8+
use MongoDB\Exception\InvalidArgumentException;
9+
use MongoDB\Model\BSONArray;
10+
use MongoDB\Model\BSONDocument;
11+
use Throwable;
12+
13+
use function array_diff_key;
14+
use function array_filter;
15+
use function is_array;
16+
use function is_string;
17+
use function sprintf;
18+
use function trim;
19+
20+
/** @internal */
21+
final class DriverOptions
22+
{
23+
private const KEY_TYPE_MAP = 'typeMap';
24+
private const KEY_BUILDER_ENCODER = 'builderEncoder';
25+
private const KEY_AUTO_ENCRYPTION = 'autoEncryption';
26+
private const KEY_DRIVER = 'driver';
27+
private const DEFAULT_TYPE_MAP = [
28+
'array' => BSONArray::class,
29+
'document' => BSONDocument::class,
30+
'root' => BSONDocument::class,
31+
];
32+
33+
private const HANDSHAKE_SEPARATOR = '/';
34+
35+
private static ?string $version = null;
36+
37+
private function __construct(
38+
public readonly array $typeMap,
39+
public readonly Encoder $builderEncoder,
40+
public readonly ?array $autoEncryption,
41+
public readonly array $driver,
42+
private readonly array $miscOptions,
43+
) {
44+
}
45+
46+
public static function fromArray(array $options): self
47+
{
48+
$options += ['typeMap' => self::DEFAULT_TYPE_MAP];
49+
50+
self::ensureValidArrayOptions($options);
51+
52+
$autoEncryption = isset($options[self::KEY_AUTO_ENCRYPTION])
53+
? AutoEncryptionOptions::fromArray($options[self::KEY_AUTO_ENCRYPTION])->toArray()
54+
: null;
55+
56+
return (new self(
57+
typeMap: $options[self::KEY_TYPE_MAP],
58+
builderEncoder: $options[self::KEY_BUILDER_ENCODER] ?? new BuilderEncoder(),
59+
autoEncryption: $autoEncryption,
60+
driver: [],
61+
miscOptions: array_diff_key($options, [
62+
self::KEY_TYPE_MAP => 1,
63+
self::KEY_BUILDER_ENCODER => 1,
64+
self::KEY_AUTO_ENCRYPTION => 1,
65+
self::KEY_DRIVER => 1,
66+
]),
67+
))->withDriverInfo($options[self::KEY_DRIVER] ?? []);
68+
}
69+
70+
public function isAutoEncryptionEnabled(): bool
71+
{
72+
return isset($this->autoEncryption['keyVaultNamespace']);
73+
}
74+
75+
public function toArray(): array
76+
{
77+
return array_filter(
78+
[
79+
'typeMap' => $this->typeMap,
80+
'builderEncoder' => $this->builderEncoder,
81+
'autoEncryption' => $this->autoEncryption,
82+
'driver' => $this->driver,
83+
] + $this->miscOptions,
84+
fn ($option) => $option !== null,
85+
);
86+
}
87+
88+
/** @throws InvalidArgumentException */
89+
private static function ensureValidArrayOptions(array $options): void
90+
{
91+
if (! is_array($options[self::KEY_TYPE_MAP])) {
92+
throw InvalidArgumentException::invalidType(
93+
sprintf('"%s" driver option', self::KEY_TYPE_MAP),
94+
$options[self::KEY_TYPE_MAP],
95+
'array',
96+
);
97+
}
98+
99+
if (isset($options[self::KEY_BUILDER_ENCODER]) && ! $options[self::KEY_BUILDER_ENCODER] instanceof Encoder) {
100+
throw InvalidArgumentException::invalidType(
101+
sprintf('"%s" option', self::KEY_BUILDER_ENCODER),
102+
$options[self::KEY_BUILDER_ENCODER],
103+
Encoder::class,
104+
);
105+
}
106+
107+
$driver = $options[self::KEY_DRIVER] ?? [];
108+
if (isset($driver['name'])) {
109+
if (! is_string($driver['name'])) {
110+
throw InvalidArgumentException::invalidType('"name" handshake option', $driver['name'], 'string');
111+
}
112+
}
113+
114+
if (isset($driver['version'])) {
115+
if (! is_string($driver['version'])) {
116+
throw InvalidArgumentException::invalidType('"version" handshake option', $driver['version'], 'string');
117+
}
118+
}
119+
}
120+
121+
private static function getVersion(): string
122+
{
123+
if (self::$version === null) {
124+
try {
125+
self::$version = InstalledVersions::getPrettyVersion('mongodb/mongodb') ?? 'unknown';
126+
} catch (Throwable) {
127+
self::$version = 'error';
128+
}
129+
}
130+
131+
return self::$version;
132+
}
133+
134+
private function withDriverInfo(array $driver): self
135+
{
136+
$mergedDriver = [
137+
'name' => 'PHPLIB',
138+
'version' => self::getVersion(),
139+
];
140+
141+
if (isset($driver['name'])) {
142+
$mergedDriver['name'] .= self::HANDSHAKE_SEPARATOR . $driver['name'];
143+
}
144+
145+
if (isset($driver['version'])) {
146+
$mergedDriver['version'] .= self::HANDSHAKE_SEPARATOR . $driver['version'];
147+
}
148+
149+
if (isset($driver['platform'])) {
150+
$mergedDriver['platform'] = $driver['platform'];
151+
}
152+
153+
if ($this->isAutoEncryptionEnabled()) {
154+
$mergedDriver['platform'] = trim(sprintf('iue %s', $driver['platform'] ?? ''));
155+
}
156+
157+
return new self(
158+
typeMap: $this->typeMap,
159+
builderEncoder: $this->builderEncoder,
160+
autoEncryption: $this->autoEncryption,
161+
driver: $mergedDriver,
162+
miscOptions: $this->miscOptions,
163+
);
164+
}
165+
}

‎tests/ValueObject/AutoEncryptionOptionsTest.php‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
<?php
2+
3+
namespace MongoDB\Tests\ValueObject;
4+
5+
use Generator;
6+
use MongoDB\Client;
7+
use MongoDB\Exception\InvalidArgumentException;
8+
use MongoDB\ValueObject\AutoEncryptionOptions;
9+
use PHPUnit\Framework\Attributes\DataProvider;
10+
use PHPUnit\Framework\TestCase;
11+
use stdClass;
12+
13+
class AutoEncryptionOptionsTest extends TestCase
14+
{
15+
#[DataProvider('fromArrayProvider')]
16+
public function testFromArray(array $options, array $expected): void
17+
{
18+
$actual = AutoEncryptionOptions::fromArray($options);
19+
$this->assertEquals($expected, $actual->toArray());
20+
}
21+
22+
public function testFromArrayFailsForInvalidOptions(): void
23+
{
24+
$this->expectException(InvalidArgumentException::class);
25+
26+
AutoEncryptionOptions::fromArray([
27+
'keyVaultClient' => new StdClass(),
28+
]);
29+
}
30+
31+
public static function fromArrayProvider(): Generator
32+
{
33+
$client = new Client();
34+
35+
yield 'with manager passed for `keyVaultClient`' => [
36+
[
37+
'keyVaultClient' => $client->getManager(),
38+
'kmsProviders' => [
39+
'foo' => new StdClass(),
40+
'aws' => ['foo' => 'bar'],
41+
],
42+
],
43+
[
44+
'keyVaultClient' => $client->getManager(),
45+
'kmsProviders' => [
46+
'foo' => new StdClass(),
47+
'aws' => ['foo' => 'bar'],
48+
],
49+
],
50+
];
51+
52+
yield 'with client passed for `keyVaultClient`' => [
53+
['keyVaultClient' => $client],
54+
[
55+
'keyVaultClient' => $client->getManager(),
56+
],
57+
];
58+
59+
yield 'with extra options' => [
60+
[
61+
'kmsProviders' => [
62+
'foo' => [],
63+
'aws' => ['foo' => 'bar'],
64+
],
65+
'tlsProviders' => [
66+
['foo' => 'bar'],
67+
],
68+
'disableClientPersistence' => false,
69+
],
70+
[
71+
'kmsProviders' => [
72+
'foo' => new StdClass(),
73+
'aws' => ['foo' => 'bar'],
74+
],
75+
'tlsProviders' => [
76+
['foo' => 'bar'],
77+
],
78+
'disableClientPersistence' => false,
79+
],
80+
];
81+
}
82+
}

0 commit comments

Comments
 (0)