Skip to content

[PST-2078] Allow invalid PKs and force-fallback to legacy manifest in that case #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 30, 2024
Merged

[PST-2078] Allow invalid PKs and force-fallback to legacy manifest in that case #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e70287
feat: allow invalid PKs and force-fallback to legacy manifest in that…
AdamVyborny Sep 26, 2024
b19872b
test: testing legacy primary keys with non-existing columns
AdamVyborny Sep 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/Manifest/ManifestManager/Options/OutTable/Serializer/LegacyManifestNormalizer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,12 @@ public function normalize($object, ?string $format = null, array $context = []):
/** @var ManifestOptions $object */
$this->normalizeBasicProperties($object, $data);
$this->normalizeTableMetadata($object, $data);
$this->normalizeSchema($object, $data);
if ($object->getLegacyPrimaryKeys() !== null) {
$data['primary_key'] = $object->getLegacyPrimaryKeys();
} else {
$this->normalizeSchema($object, $data);
if (!isset($data['primary_key'])) {
$data['primary_key'] = [];
}
$data['primary_key'] = array_unique(array_merge($data['primary_key'], $object->getLegacyPrimaryKeys()));
Comment on lines +25 to +28
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to mi dalo trochu k zamyšlení co to vlastně dělá :D

}

return $data;
Expand Down
161 changes: 161 additions & 0 deletions tests/Manifest/ManifestManagerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

namespace Keboola\Component\Tests\Manifest;

use Generator;
use Keboola\Component\Manifest\ManifestManager;
use Keboola\Component\Manifest\ManifestManager\Options\OptionsValidationException;
use Keboola\Component\Manifest\ManifestManager\Options\OutFileManifestOptions;
Expand Down Expand Up @@ -168,6 +169,166 @@ public function testManifestWithOnlyPrimaryKeysSpecified(): void
);
}

/**
* @dataProvider legacyPrimaryKeysDataProvider
*/
public function testManifestObjectWithExtraPrimaryKeysSpecified(
array $legacyPrimaryKeys,
array $schema,
array $expectedManifest,
): void {
$manifest = (new ManifestOptions())
->setDestination('destination-table')
->setLegacyPrimaryKeys($legacyPrimaryKeys)
->setSchema($schema);

$this->assertEqualsCanonicalizing($expectedManifest, $manifest->toArray());

// Test that toArray(legacy: false) force fallbacks to the same result
$this->assertEqualsCanonicalizing(
$expectedManifest,
$manifest->toArray(false),
);
}

public function legacyPrimaryKeysDataProvider(): Generator
{
yield 'two columns, three legacy primary keys merging with two non-legacy' => [
['id', 'number', 'name'],
[
new ManifestOptionsSchema(
'id',
[],
false,
true,
),
new ManifestOptionsSchema(
'number',
['base' => ['type' => 'INTEGER', 'default' => '0']],
false,
true,
),
],
[
'destination' => 'destination-table',
'columns' => ['id', 'number'],
'primary_key' => ['id', 'number', 'name'],
'column_metadata' => [
'id' => [
[
'key' => 'KBC.datatype.nullable',
'value' => false,
],
],
'number' => [
[
'key' => 'KBC.datatype.nullable',
'value' => false,
],
[
'key' => 'KBC.datatype.basetype',
'value' => 'INTEGER',
],
[
'key' => 'KBC.datatype.default',
'value' => '0',
],
],
],
],
];

yield 'two columns, one legacy primary key, two non-legacy' => [
['name'],
[
new ManifestOptionsSchema(
'id',
[],
false,
true,
),
new ManifestOptionsSchema(
'number',
['base' => ['type' => 'INTEGER', 'default' => '0']],
false,
true,
),
],
[
'destination' => 'destination-table',
'columns' => ['id', 'number'],
'primary_key' => ['id', 'number', 'name'],
'column_metadata' => [
'id' => [
[
'key' => 'KBC.datatype.nullable',
'value' => false,
],
],
'number' => [
[
'key' => 'KBC.datatype.nullable',
'value' => false,
],
[
'key' => 'KBC.datatype.basetype',
'value' => 'INTEGER',
],
[
'key' => 'KBC.datatype.default',
'value' => '0',
],
],
],
],
];

yield 'two columns, three legacy primary keys' => [
['id', 'number', 'name'],
[
new ManifestOptionsSchema(
'id',
[],
false,
false,
),
new ManifestOptionsSchema(
'number',
['base' => ['type' => 'INTEGER', 'default' => '0']],
false,
false,
),
],
[
'destination' => 'destination-table',
'columns' => ['id', 'number'],
'primary_key' => ['id', 'number', 'name'],
'column_metadata' => [
'id' => [
[
'key' => 'KBC.datatype.nullable',
'value' => false,
],
],
'number' => [
[
'key' => 'KBC.datatype.nullable',
'value' => false,
],
[
'key' => 'KBC.datatype.basetype',
'value' => 'INTEGER',
],
[
'key' => 'KBC.datatype.default',
'value' => '0',
],
],
],
],
];
}

public function testNonexistentManifestReturnsEmptyArray(): void
{
$manager = new ManifestManager(__DIR__ . '/fixtures/manifest-data-dir');
Expand Down
Loading