[Lock] DynamoDB store #60138

natepage · 2025-04-04T05:02:55Z

Q	A
Branch?	7.3
Bug fix?	no
New feature?	yes
Deprecations?	no
Issues	Fix #59996
License	MIT

This PR introduces a new Lock store using AWS DynamoDb. The idea is coming from this article.

The implementation is heavily based on:

DoctrineDbalStore for the overall logic
AmazonSqsMessenger Connection for the DSN/options handling

stof · 2025-04-04T08:41:53Z

this new store should probably in a bridge package, so that we can manage its dependency properly.

natepage · 2025-04-09T06:00:30Z

@stof Thank you for your feedback, I did move it to its own bridge, I'm not sure if I've done everything required from a structural POV.

I still didn't touch the tests yet

src/Symfony/Component/Lock/Bridge/DynamoDb/CHANGELOG.md

src/Symfony/Component/Lock/Bridge/DynamoDb/LICENSE

src/Symfony/Component/Lock/Bridge/DynamoDb/README.md

…egration tests

OskarStark · 2025-04-09T10:14:22Z

this new store should probably in a bridge package, so that we can manage its dependency properly.

While I agree on that @stof, right now there is no Bridge namespace:

stof · 2025-04-09T10:37:31Z

@OskarStark this does not prevent us from adding it if we need it.

natepage · 2025-04-09T10:41:16Z

@stof @OskarStark thank you for taking the time to review this 😄

I've actually updated the PR to add this Bridge namespace following the structure from the Messenger SQS example, but the package validation is failing and I'm unsure why as I've placed the composer.json file exactly in the same level as the Messenger SQS one, trying to investigate that right now

…ges.php

natepage · 2025-04-09T10:55:49Z

Yay! Package checks are passing, the match case for component_bridge wasn't behaving as expected, back onto PHP tests 😄

OskarStark · 2025-04-09T11:00:50Z

Yes, we need to keep in mind, that we need to configure a proper split for the repo etc.

src/Symfony/Component/Lock/Bridge/DynamoDb/Store/DynamoDbStore.php

…ult of async-aws client

natepage · 2025-04-10T12:42:26Z

@stof @OskarStark

The current state of this is:

Moved the logic into its own component bridge
Implemented integration tests by using localstack in CI to have a local DynamoDB instance
Updated the default options logic based on feedback
Implemented unit tests for the store constructor logic (DSN/Options)

I have re-requested your reviews, thank you 😄

src/Symfony/Component/Lock/Bridge/DynamoDb/Tests/Functional/Store/AbstractStoreTestCase.php

src/Symfony/Component/Lock/Bridge/DynamoDb/composer.json

src/Symfony/Component/Lock/Store/StoreFactory.php

GromNaN

Just a few more adjustments for this new package, and it looks good to me. I haven't read over the implementation in detail.

src/Symfony/Component/Lock/Bridge/DynamoDb/composer.json

src/Symfony/Component/Lock/Store/StoreFactory.php

.github/get-modified-packages.php

GromNaN

SGTM.
Just a line of code that can be removed.

src/Symfony/Component/Lock/Store/StoreFactory.php

src/Symfony/Component/Lock/Tests/Store/RedisStoreTestCase.php

src/Symfony/Component/Lock/Bridge/DynamoDb/composer.json

src/Symfony/Component/Lock/Bridge/DynamoDb/Store/DynamoDbStore.php

src/Symfony/Component/Lock/Bridge/DynamoDb/README.md

src/Symfony/Component/Lock/Bridge/DynamoDb/Store/DynamoDbStore.php

GromNaN · 2025-05-06T21:11:27Z

src/Symfony/Component/Lock/Bridge/DynamoDb/Store/DynamoDbStore.php

+            if ('default' !== ($params['host'] ?? 'default')) {
+                $clientConfiguration['endpoint'] = \sprintf('%s://%s%s', ($options['sslmode'] ?? null) === 'disable' ? 'http' : 'https', $params['host'], ($params['port'] ?? null) ? ':'.$params['port'] : '');
+                if (preg_match(';^dynamodb\.([^\.]++)\.amazonaws\.com$;', $params['host'], $matches)) {
+                    $clientConfiguration['region'] = $matches[1];
+                }


I don't see where this code is tested. Can you add a test case with a custom host?

@GromNaN This test is setting host => localhost which tests that part

[Lock][WIP] Initial pass on DynamoDb lock store

11c3b24

This comment has been minimized.

Sign in to view

natepage marked this pull request as ready for review April 4, 2025 05:03

natepage requested a review from jderusse as a code owner April 4, 2025 05:03

carsonbot added Status: Needs Review Feature Lock labels Apr 4, 2025

carsonbot added this to the 7.3 milestone Apr 4, 2025

carsonbot changed the title ~~[Lock][WIP] Initial pass on DynamoDb lock store~~ [Lock] [WIP] Initial pass on DynamoDb lock store Apr 4, 2025

natepage changed the title ~~[Lock] [WIP] Initial pass on DynamoDb lock store~~ [Lock] DynamoDb store Apr 4, 2025

OskarStark changed the title ~~[Lock] DynamoDb store~~ [Lock] DynamoDB store Apr 7, 2025

[Lock][WIP] Move DynamoDbStore into its own bridge package

c606c47

OskarStark reviewed Apr 9, 2025

View reviewed changes

natepage added 5 commits April 9, 2025 17:34

[Lock][WIP] Test DynamoDbStore against local DynamoDB instance in int…

93677c8

…egration tests

[Lock][WIP] Address some of reviews comments and CS

03acce4

[Lock][WIP] Fix license headers

0fec459

[Lock][WIP] Fix license headers - 1

94bccf3

[Lock][WIP] Psalm InvalidArgument errors are confusing me...

4cef875

[Lock][WIP] Try to debug package tests failure

02b7368

[Lock][WIP] Try to debug package tests failure - 1

f34fe01

[Lock][WIP] Fix match case for component_bridge in get-modified-packa…

fa6c74d

…ges.php

natepage added 2 commits April 9, 2025 21:06

[Lock][WIP] Copy AbstractStoreTestCase from Lock component to bridge

ec36e98

[Lock][WIP] Disable ssl in integration tests

f877628

natepage added 3 commits April 9, 2025 22:30

[Lock][WIP] Fix :token attribute value in putOffExpiration

10579c6

[Lock][WIP] Debug exists function

cd78429

[Lock][WIP] Fix exists logic

0b16e0f

stof reviewed Apr 9, 2025

View reviewed changes

src/Symfony/Component/Lock/Bridge/DynamoDb/Store/DynamoDbStore.php Outdated Show resolved Hide resolved

natepage added 8 commits April 10, 2025 09:32

[Lock][WIP] Try to address psalm error

a3c7d91

[Lock][WIP] Make default region and endpoint options null to use defa…

6484cfa

…ult of async-aws client

[Lock][WIP] Move integration tests to Functional dir and add unit tests

abbc213

[Lock][WIP] Add unit tests with assertEquals for dsn process

106eeac

[Lock][WIP] Default options in case DynamoDbClient instance given

7dfb08a

[Lock][WIP] Replicate constructor testing from SQS Connection

170bcef

[Lock][WIP] Fix default region in tests

64e7380

[Lock][WIP] Fix invalid and unsupported DSN tests

dbb4ae2

natepage requested review from stof and OskarStark April 10, 2025 12:41

GromNaN reviewed Apr 10, 2025

View reviewed changes

natepage added 2 commits April 11, 2025 10:30

[Lock] Address review comments

c685c71

[Lock] Make fabbot happy

1ff0a60

GromNaN reviewed Apr 14, 2025

View reviewed changes

src/Symfony/Component/Lock/Bridge/DynamoDb/composer.json Outdated Show resolved Hide resolved

src/Symfony/Component/Lock/Store/StoreFactory.php Show resolved Hide resolved

.github/get-modified-packages.php Show resolved Hide resolved

natepage added 2 commits April 17, 2025 22:00

[Lock] Address review comments

fa64c21

[Lock] Fix RedisStoreTestCase filename

f357506

GromNaN approved these changes Apr 17, 2025

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Apr 17, 2025

stof mentioned this pull request Apr 17, 2025

Fix the lowest bound for the symfony/polyfill-uuid requirement async-aws/aws#1879

Merged

natepage added 2 commits April 18, 2025 05:49

[Lock] Address review comments

a0739ce

[Lock] Create DynamoDB table in save if it doesn't exist

ff40b91

GromNaN approved these changes May 6, 2025

View reviewed changes

[Lock] Address review comments

4f0a780

natepage mentioned this pull request May 7, 2025

[Lock] Add DynamoDbStore symfony/symfony-docs#20944

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Lock] DynamoDB store #60138

[Lock] DynamoDB store #60138

natepage commented Apr 4, 2025

This comment has been minimized.

stof commented Apr 4, 2025

natepage commented Apr 9, 2025

OskarStark commented Apr 9, 2025

stof commented Apr 9, 2025

natepage commented Apr 9, 2025

natepage commented Apr 9, 2025

OskarStark commented Apr 9, 2025

natepage commented Apr 10, 2025

GromNaN left a comment

GromNaN left a comment

GromNaN May 6, 2025

natepage May 7, 2025

[Lock] DynamoDB store #60138

Are you sure you want to change the base?

[Lock] DynamoDB store #60138

Conversation

natepage commented Apr 4, 2025

This comment has been minimized.

stof commented Apr 4, 2025

natepage commented Apr 9, 2025

OskarStark commented Apr 9, 2025

stof commented Apr 9, 2025

natepage commented Apr 9, 2025

natepage commented Apr 9, 2025

OskarStark commented Apr 9, 2025

natepage commented Apr 10, 2025

GromNaN left a comment

Choose a reason for hiding this comment

GromNaN left a comment

Choose a reason for hiding this comment

GromNaN May 6, 2025

Choose a reason for hiding this comment

natepage May 7, 2025

Choose a reason for hiding this comment