Skip to content

Commit 260c436

Browse files
kayjoostenkayjoosten
committed
feat(consent): add feature toggle for stable hash migration
Introduces `eb.stable_consent_hash_migration` (default: false) to control when the legacy `attribute` column is phased out. Toggle OFF (default): new consent writes both `attribute` and `attribute_stable` so old EB instances still find records during a rolling deploy; upgrades leave `attribute` intact for the same reason. Toggle ON: new consent writes only `attribute_stable` (attribute=NULL) and upgrades null the old column, cleaning it up over time once all instances are on the new version.
1 parent f05b277 commit 260c436

11 files changed

Lines changed: 183 additions & 19 deletions

File tree

‎config/packages/engineblock_features.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,4 @@ parameters:
1616
eb.stepup.sfo.override_engine_entityid: "%feature_stepup_sfo_override_engine_entityid%"
1717
eb.stepup.send_user_attributes: "%feature_stepup_send_user_attributes%"
1818
eb.feature_enable_sram_interrupt: "%feature_enable_sram_interrupt%"
19+
eb.stable_consent_hash_migration: "%feature_stable_consent_hash_migration%"

‎config/packages/parameters.yml.dist‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,7 @@ parameters:
224224
feature_stepup_sfo_override_engine_entityid: false
225225
feature_stepup_send_user_attributes: false
226226
feature_enable_sram_interrupt: false
227+
feature_stable_consent_hash_migration: false
227228

228229
##########################################################################################
229230
## PROFILE SETTINGS

‎config/services/services.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ services:
8080
public: false
8181
arguments:
8282
- '@OpenConext\EngineBlockBundle\Authentication\Repository\DbalConsentRepository'
83+
- '@OpenConext\EngineBlockBundle\Configuration\FeatureConfiguration'
8384

8485
OpenConext\EngineBlock\Service\Consent\ConsentService:
8586
arguments:

‎library/EngineBlock/Corto/Model/Consent.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,7 @@ private function _storeConsent(ServiceProvider $serviceProvider, $consentType):
169169
serviceId: $serviceProvider->entityId,
170170
attributeStableHash: $this->_getStableAttributesHash($this->_responseAttributes),
171171
consentType: $consentType,
172+
attributeHash: $this->_getAttributesHash($this->_responseAttributes),
172173
);
173174

174175
return $this->_hashService->storeConsentHash($parameters);

‎migrations/DoctrineMigrations/Version20260315000001.php‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ public function up(Schema $schema): void
4848

4949
public function down(Schema $schema): void
5050
{
51-
$this->addSql('ALTER TABLE consent DROP attribute_stable, CHANGE attribute attribute VARCHAR(80) CHARACTER SET utf8 NOT NULL COLLATE `utf8_unicode_ci`');
51+
$this->addSql('UPDATE consent SET attribute = attribute_stable WHERE attribute IS NULL AND attribute_stable IS NOT NULL');
52+
$this->addSql('ALTER TABLE consent CHANGE attribute attribute VARCHAR(80) NOT NULL');
53+
$this->addSql('ALTER TABLE consent DROP attribute_stable');
5254
}
5355
}

‎src/OpenConext/EngineBlock/Authentication/Value/ConsentStoreParameters.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ public function __construct(
2525
public readonly string $serviceId,
2626
public readonly string $attributeStableHash,
2727
public readonly string $consentType,
28+
public readonly ?string $attributeHash = null,
2829
) {
2930
}
3031
}

‎src/OpenConext/EngineBlock/Authentication/Value/ConsentUpdateParameters.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ public function __construct(
2626
public readonly string $hashedUserId,
2727
public readonly string $serviceId,
2828
public readonly string $consentType,
29+
public readonly bool $clearLegacyHash = false,
2930
) {
3031
}
3132
}

‎src/OpenConext/EngineBlock/Service/Consent/ConsentHashService.php‎

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
use OpenConext\EngineBlock\Authentication\Value\ConsentStoreParameters;
2424
use OpenConext\EngineBlock\Authentication\Value\ConsentUpdateParameters;
2525
use OpenConext\EngineBlock\Authentication\Value\ConsentVersion;
26+
use OpenConext\EngineBlockBundle\Configuration\FeatureConfigurationInterface;
2627
use SAML2\XML\saml\NameID;
2728
use function array_filter;
2829
use function array_keys;
@@ -40,14 +41,22 @@
4041

4142
final class ConsentHashService implements ConsentHashServiceInterface
4243
{
44+
private const FEATURE_MIGRATION = 'eb.stable_consent_hash_migration';
45+
4346
/**
4447
* @var ConsentRepository
4548
*/
4649
private $consentRepository;
4750

48-
public function __construct(ConsentRepository $consentHashRepository)
51+
/**
52+
* @var FeatureConfigurationInterface
53+
*/
54+
private $featureConfiguration;
55+
56+
public function __construct(ConsentRepository $consentHashRepository, FeatureConfigurationInterface $featureConfiguration)
4957
{
5058
$this->consentRepository = $consentHashRepository;
59+
$this->featureConfiguration = $featureConfiguration;
5160
}
5261

5362
public function retrieveConsentHash(ConsentHashQuery $query): ConsentVersion
@@ -57,11 +66,36 @@ public function retrieveConsentHash(ConsentHashQuery $query): ConsentVersion
5766

5867
public function storeConsentHash(ConsentStoreParameters $parameters): bool
5968
{
69+
$migrationEnabled = $this->featureConfiguration->isEnabled(self::FEATURE_MIGRATION);
70+
71+
if ($migrationEnabled) {
72+
$parameters = new ConsentStoreParameters(
73+
hashedUserId: $parameters->hashedUserId,
74+
serviceId: $parameters->serviceId,
75+
attributeStableHash: $parameters->attributeStableHash,
76+
consentType: $parameters->consentType,
77+
attributeHash: null,
78+
);
79+
}
80+
6081
return $this->consentRepository->storeConsentHash($parameters);
6182
}
6283

6384
public function updateConsentHash(ConsentUpdateParameters $parameters): bool
6485
{
86+
$migrationEnabled = $this->featureConfiguration->isEnabled(self::FEATURE_MIGRATION);
87+
88+
if ($migrationEnabled) {
89+
$parameters = new ConsentUpdateParameters(
90+
attributeStableHash: $parameters->attributeStableHash,
91+
attributeHash: $parameters->attributeHash,
92+
hashedUserId: $parameters->hashedUserId,
93+
serviceId: $parameters->serviceId,
94+
consentType: $parameters->consentType,
95+
clearLegacyHash: true,
96+
);
97+
}
98+
6599
return $this->consentRepository->updateConsentHash($parameters);
66100
}
67101

‎src/OpenConext/EngineBlockBundle/Authentication/Repository/DbalConsentRepository.php‎

Lines changed: 44 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -226,18 +226,33 @@ public function hasConsentHash(ConsentHashQuery $query): ConsentVersion
226226
*/
227227
public function storeConsentHash(ConsentStoreParameters $parameters): bool
228228
{
229-
$query = "INSERT INTO consent (hashed_user_id, service_id, attribute_stable, consent_type, consent_date, deleted_at)
230-
VALUES (?, ?, ?, ?, NOW(), '0000-00-00 00:00:00')
231-
ON DUPLICATE KEY UPDATE attribute_stable=VALUES(attribute_stable),
232-
consent_type=VALUES(consent_type), consent_date=NOW(), deleted_at='0000-00-00 00:00:00'";
233-
234-
try {
235-
$this->connection->executeStatement($query, [
229+
if ($parameters->attributeHash !== null) {
230+
$query = "INSERT INTO consent (hashed_user_id, service_id, attribute, attribute_stable, consent_type, consent_date, deleted_at)
231+
VALUES (?, ?, ?, ?, ?, NOW(), '0000-00-00 00:00:00')
232+
ON DUPLICATE KEY UPDATE attribute=VALUES(attribute), attribute_stable=VALUES(attribute_stable),
233+
consent_type=VALUES(consent_type), consent_date=NOW(), deleted_at='0000-00-00 00:00:00'";
234+
$bindings = [
236235
$parameters->hashedUserId,
237236
$parameters->serviceId,
237+
$parameters->attributeHash,
238238
$parameters->attributeStableHash,
239239
$parameters->consentType,
240-
]);
240+
];
241+
} else {
242+
$query = "INSERT INTO consent (hashed_user_id, service_id, attribute_stable, consent_type, consent_date, deleted_at)
243+
VALUES (?, ?, ?, ?, NOW(), '0000-00-00 00:00:00')
244+
ON DUPLICATE KEY UPDATE attribute_stable=VALUES(attribute_stable),
245+
consent_type=VALUES(consent_type), consent_date=NOW(), deleted_at='0000-00-00 00:00:00'";
246+
$bindings = [
247+
$parameters->hashedUserId,
248+
$parameters->serviceId,
249+
$parameters->attributeStableHash,
250+
$parameters->consentType,
251+
];
252+
}
253+
254+
try {
255+
$this->connection->executeStatement($query, $bindings);
241256
} catch (Exception $e) {
242257
throw new RuntimeException(
243258
sprintf('Error storing consent: "%s"', $e->getMessage())
@@ -252,7 +267,8 @@ public function storeConsentHash(ConsentStoreParameters $parameters): bool
252267
*/
253268
public function updateConsentHash(ConsentUpdateParameters $parameters): bool
254269
{
255-
$query = "
270+
if ($parameters->clearLegacyHash) {
271+
$query = "
256272
UPDATE
257273
consent
258274
SET
@@ -268,7 +284,25 @@ public function updateConsentHash(ConsentUpdateParameters $parameters): bool
268284
consent_type = ?
269285
AND
270286
deleted_at IS NULL
271-
";
287+
";
288+
} else {
289+
$query = "
290+
UPDATE
291+
consent
292+
SET
293+
attribute_stable = ?
294+
WHERE
295+
attribute = ?
296+
AND
297+
hashed_user_id = ?
298+
AND
299+
service_id = ?
300+
AND
301+
consent_type = ?
302+
AND
303+
deleted_at IS NULL
304+
";
305+
}
272306

273307
try {
274308
$affected = $this->connection->executeStatement($query, [

‎tests/library/EngineBlock/Test/Corto/Model/ConsentIntegrationTest.php‎

Lines changed: 92 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
use OpenConext\EngineBlock\Metadata\Entity\ServiceProvider;
2828
use OpenConext\EngineBlock\Service\Consent\ConsentHashService;
2929
use OpenConext\EngineBlockBundle\Authentication\Repository\DbalConsentRepository;
30+
use OpenConext\EngineBlockBundle\Configuration\FeatureConfiguration;
3031
use PHPUnit\Framework\Attributes\DataProvider;
3132
use PHPUnit\Framework\TestCase;
3233

@@ -56,8 +57,20 @@ public function setup(): void
5657

5758
$this->response = Mockery::mock(EngineBlock_Saml2_ResponseAnnotationDecorator::class);
5859
$this->consentRepository = Mockery::mock(ConsentRepository::class);
59-
$this->consentService = new ConsentHashService($this->consentRepository);
6060

61+
$this->buildConsentAndService(migrationEnabled: true);
62+
}
63+
64+
/**
65+
* Rebuilds $this->consentService and $this->consent with the given toggle state.
66+
* Call this in tests that need a specific toggle setting different from setUp's default.
67+
*/
68+
private function buildConsentAndService(bool $migrationEnabled): void
69+
{
70+
$featureConfig = new FeatureConfiguration([
71+
'eb.stable_consent_hash_migration' => $migrationEnabled,
72+
]);
73+
$this->consentService = new ConsentHashService($this->consentRepository, $featureConfig);
6174
$this->consent = new EngineBlock_Corto_Model_Consent(
6275
"consent",
6376
true,
@@ -151,14 +164,19 @@ public function test_stable_consent_given($consentType)
151164
}
152165
}
153166

167+
/**
168+
* Toggle ON (migration enabled): new consent stores only the stable hash.
169+
* The legacy attribute column must be left NULL so fully-migrated deployments
170+
* don't accumulate unnecessary data in the old column.
171+
*/
154172
#[DataProvider('consentTypeProvider')]
155-
public function test_give_consent_no_unstable_consent_given($consentType)
173+
public function test_give_consent_toggle_on_stores_only_stable_hash($consentType)
156174
{
175+
// setUp already builds with migrationEnabled=true
157176
$serviceProvider = new ServiceProvider("service-provider-entity-id");
158177
$this->response->shouldReceive('getNameIdValue')
159178
->once()
160179
->andReturn('collab:person:id:org-a:joe-a');
161-
// Now assert that the new stable consent hash is going to be set
162180
$this->consentRepository
163181
->shouldReceive('storeConsentHash')
164182
->once()
@@ -167,6 +185,7 @@ public function test_give_consent_no_unstable_consent_given($consentType)
167185
serviceId: 'service-provider-entity-id',
168186
attributeStableHash: '8739602554c7f3241958e3cc9b57fdecb474d508',
169187
consentType: $consentType,
188+
attributeHash: null,
170189
))
171190
->andReturn(true);
172191

@@ -180,14 +199,53 @@ public function test_give_consent_no_unstable_consent_given($consentType)
180199
}
181200
}
182201

202+
/**
203+
* Toggle OFF (migration disabled): new consent stores BOTH hashes so that
204+
* old EB instances (still reading only the `attribute` column) can still
205+
* find the consent record during a rolling deploy.
206+
*/
183207
#[DataProvider('consentTypeProvider')]
184-
public function test_upgrade_to_stable_consent($consentType)
208+
public function test_give_consent_toggle_off_stores_both_hashes($consentType)
185209
{
210+
$this->buildConsentAndService(migrationEnabled: false);
211+
$serviceProvider = new ServiceProvider("service-provider-entity-id");
212+
$this->response->shouldReceive('getNameIdValue')
213+
->once()
214+
->andReturn('collab:person:id:org-a:joe-a');
215+
$this->consentRepository
216+
->shouldReceive('storeConsentHash')
217+
->once()
218+
->with(new ConsentStoreParameters(
219+
hashedUserId: '0e54805079c56c2b1c1197a760af86ac337b7bac',
220+
serviceId: 'service-provider-entity-id',
221+
attributeStableHash: '8739602554c7f3241958e3cc9b57fdecb474d508',
222+
consentType: $consentType,
223+
attributeHash: '8739602554c7f3241958e3cc9b57fdecb474d508',
224+
))
225+
->andReturn(true);
226+
227+
switch ($consentType) {
228+
case ConsentType::TYPE_EXPLICIT:
229+
$this->assertTrue($this->consent->giveExplicitConsentFor($serviceProvider));
230+
break;
231+
case ConsentType::TYPE_IMPLICIT:
232+
$this->assertTrue($this->consent->giveImplicitConsentFor($serviceProvider));
233+
break;
234+
}
235+
}
236+
237+
/**
238+
* Toggle OFF (migration disabled): upgrading an old unstable consent leaves
239+
* the legacy `attribute` column intact so old instances keep working.
240+
*/
241+
#[DataProvider('consentTypeProvider')]
242+
public function test_upgrade_toggle_off_preserves_legacy_hash($consentType)
243+
{
244+
$this->buildConsentAndService(migrationEnabled: false);
186245
$serviceProvider = new ServiceProvider("service-provider-entity-id");
187246
$this->response->shouldReceive('getNameIdValue')
188247
->once()
189248
->andReturn('collab:person:id:org-a:joe-a');
190-
// Now assert that the new stable consent hash is going to be set
191249
$this->consentRepository
192250
->shouldReceive('updateConsentHash')
193251
->once()
@@ -197,10 +255,38 @@ public function test_upgrade_to_stable_consent($consentType)
197255
hashedUserId: '0e54805079c56c2b1c1197a760af86ac337b7bac',
198256
serviceId: 'service-provider-entity-id',
199257
consentType: $consentType,
258+
clearLegacyHash: false,
259+
))
260+
->andReturn(true);
261+
262+
$this->assertNull($this->consent->upgradeAttributeHashFor($serviceProvider, $consentType, ConsentVersion::unstable()));
263+
}
264+
265+
/**
266+
* Toggle ON (migration enabled): upgrading an old unstable consent nulls the
267+
* legacy `attribute` column so the old column is cleaned up over time.
268+
*/
269+
#[DataProvider('consentTypeProvider')]
270+
public function test_upgrade_toggle_on_clears_legacy_hash($consentType)
271+
{
272+
// setUp already builds with migrationEnabled=true
273+
$serviceProvider = new ServiceProvider("service-provider-entity-id");
274+
$this->response->shouldReceive('getNameIdValue')
275+
->once()
276+
->andReturn('collab:person:id:org-a:joe-a');
277+
$this->consentRepository
278+
->shouldReceive('updateConsentHash')
279+
->once()
280+
->with(new ConsentUpdateParameters(
281+
attributeStableHash: '8739602554c7f3241958e3cc9b57fdecb474d508',
282+
attributeHash: '8739602554c7f3241958e3cc9b57fdecb474d508',
283+
hashedUserId: '0e54805079c56c2b1c1197a760af86ac337b7bac',
284+
serviceId: 'service-provider-entity-id',
285+
consentType: $consentType,
286+
clearLegacyHash: true,
200287
))
201288
->andReturn(true);
202289

203-
// Pass the pre-fetched ConsentVersion (unstable) — no second DB query is made
204290
$this->assertNull($this->consent->upgradeAttributeHashFor($serviceProvider, $consentType, ConsentVersion::unstable()));
205291
}
206292

0 commit comments

Comments
 (0)