From 34bacb5488e729fb1d9d88f2e92c80ae10f8d9ff Mon Sep 17 00:00:00 2001 From: tikoutare Date: Sun, 4 Oct 2020 22:24:49 +0200 Subject: [PATCH 01/11] Update user_provider.rst Fix provider name `backend_users` instead of `backend` --- security/user_provider.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/security/user_provider.rst b/security/user_provider.rst index 51a2fea56ed..13e6a8dfb49 100644 --- a/security/user_provider.rst +++ b/security/user_provider.rst @@ -332,7 +332,7 @@ providers until the user is found: all_users: chain: - providers: ['legacy_users', 'users', 'backend'] + providers: ['legacy_users', 'users', 'backend_users'] .. _custom-user-provider: From cb0c5260c3f8f04a3e24762541588cfc15b99de9 Mon Sep 17 00:00:00 2001 From: Nyholm Date: Tue, 13 Oct 2020 17:37:06 +0200 Subject: [PATCH 02/11] Remove Michelle from the CARE team --- contributing/code_of_conduct/care_team.rst | 6 ------ 1 file changed, 6 deletions(-) diff --git a/contributing/code_of_conduct/care_team.rst b/contributing/code_of_conduct/care_team.rst index ae342b89999..8f32d5befd1 100644 --- a/contributing/code_of_conduct/care_team.rst +++ b/contributing/code_of_conduct/care_team.rst @@ -29,12 +29,6 @@ of them at once by emailing **care@symfony.com**: * *Twitter*: `@EmilieLorenzo `_ * *SymfonyConnect*: `emilielorenzo `_ -* **Michelle Sanver** - - * *E-mail*: michelle [at] liip.ch - * *Twitter*: `@michellesanver `_ - * *SymfonyConnect*: `michellesanver `_ - * **Tobias Nyholm** * *E-mail*: tobias.nyholm [at] gmail.com From 9dd75a90d0ea067eadae91b8844ec44dcfcbb1ee Mon Sep 17 00:00:00 2001 From: Hamza Amrouche Date: Tue, 10 Mar 2020 17:01:41 +0100 Subject: [PATCH 03/11] feat: add amazon sqs to docs --- messenger.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/messenger.rst b/messenger.rst index 6107fcec87b..e22e2f02e21 100644 --- a/messenger.rst +++ b/messenger.rst @@ -1151,6 +1151,35 @@ during a request:: :class:`Symfony\\Bundle\\FrameworkBundle\\Test\\KernelTestCase` or :class:`Symfony\\Bundle\\FrameworkBundle\\Test\\WebTestCase`. +Amazon SQS +~~~~~~~~~~ + +.. versionadded:: 5.1 + + The Amazon SQS transport has been added in Symfony 5.1 + Install it by running: + + .. code-block:: terminal + + $ composer require symfony/amazon-sqs-messenger + +The ``SQS`` transport configuration looks like this: + +.. code-block:: bash + + # .env + MESSENGER_TRANSPORT_DSN=sqs://guest:guest@sqs.eu-west-3.amazonaws.com/test?region=eu-west-3 + + +.. note:: + + By default, the transport will automatically create queue that are needed. That can be disabled. + +The transport has a number of other options, including ways to configure +the exchange, queues binding keys and more. See the documentation on +:class:`Symfony\\Component\\Messenger\\Transport\\AmazonSqs\\Connection`. + + Serializing Messages ~~~~~~~~~~~~~~~~~~~~ From 47dbe33f5f0c5565d67686cf02c02845b8fcf4a5 Mon Sep 17 00:00:00 2001 From: Nyholm Date: Sun, 11 Oct 2020 22:36:05 +0200 Subject: [PATCH 04/11] Added SQS Messenger docs --- messenger.rst | 52 +++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 46 insertions(+), 6 deletions(-) diff --git a/messenger.rst b/messenger.rst index e22e2f02e21..0c71adc23c5 100644 --- a/messenger.rst +++ b/messenger.rst @@ -1168,17 +1168,54 @@ The ``SQS`` transport configuration looks like this: .. code-block:: bash # .env - MESSENGER_TRANSPORT_DSN=sqs://guest:guest@sqs.eu-west-3.amazonaws.com/test?region=eu-west-3 + MESSENGER_TRANSPORT_DSN=sqs://AKIAIOSFODNN7EXAMPLE:j17M97ffSVoKI0briFoo9a@sqs.eu-west-3.amazonaws.com/messages + #MESSENGER_TRANSPORT_DSN=sqs://localhost:9494/messages?sslmode=disable +.. note:: + + The transport will automatically create queues that are needed. This + can be disabled setting the "auto_setup" option to ``false``. + +A number of options can be configured via the DSN or via the ``options`` key +under the transport in ``messenger.yaml``: + +================== ===================================== ====================== + Option Description Default +================== ===================================== ====================== +endpoint Absolute URL to the SQS service https://sqs.eu-west-1.amazonaws.com +region Name of the AWS region eu-west-1 +queue_name Name of the queue messages +account Identifier of the AWS account The owner of the credentials +access_key AWS access key +secret_key AWS secret key +buffer_size Number of messages to prefetch 9 +wait_time `Long polling`_ duration in seconds 20 +poll_timeout Wait for new message duration in 0.1 + seconds +visibility_timeout Amount of seconds the message will Queue's configuration + not be visible (`Visibility Timeout`_) +auto_setup Whether the table should be created true + automatically during send / get. +================== ===================================== ====================== .. note:: - By default, the transport will automatically create queue that are needed. That can be disabled. - -The transport has a number of other options, including ways to configure -the exchange, queues binding keys and more. See the documentation on -:class:`Symfony\\Component\\Messenger\\Transport\\AmazonSqs\\Connection`. + The ``wait_time`` parameter define the maximum duration Amazon SQS should + wait until a message is available in a queue before sending a response. + It helps reducing the cost of using Amazon SQS by eliminating the number + of empty responses. + + The ``poll_timeout`` parameter define the duration the receiver should wait + before returning null. It avoids blocking other receivers from being called. + +.. note:: + + If the queue name is suffixed by ``.fifo``, AWS will creates a `FIFO queue`_ + Use the stamp :class:`Symfony\Component\Messenger\Bridge\AmazonSqs\Transport\AmazonSqsFifoStamp` + to define the ``Message group ID`` and the ``Message deduplication ID``. + FIFO queues don't support setting a delay per message, a value of ``delay: 0`` + is required in the retry strategy settings. Serializing Messages ~~~~~~~~~~~~~~~~~~~~ @@ -1753,3 +1790,6 @@ Learn more .. _`streams`: https://redis.io/topics/streams-intro .. _`Supervisor docs`: http://supervisord.org/ .. _`SymfonyCasts' message serializer tutorial`: https://symfonycasts.com/screencast/messenger/transport-serializer +.. _`Long polling`: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html +.. _`Visibility Timeout`: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html +.. _`FIFO queue': https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html From 689df8cf1142d0c00ffc5e8fdd5acb82e7fe3d37 Mon Sep 17 00:00:00 2001 From: Nyholm Date: Sun, 11 Oct 2020 22:40:43 +0200 Subject: [PATCH 05/11] cs --- messenger.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/messenger.rst b/messenger.rst index 0c71adc23c5..c0c7b72477f 100644 --- a/messenger.rst +++ b/messenger.rst @@ -1211,7 +1211,7 @@ auto_setup Whether the table should be created true .. note:: If the queue name is suffixed by ``.fifo``, AWS will creates a `FIFO queue`_ - Use the stamp :class:`Symfony\Component\Messenger\Bridge\AmazonSqs\Transport\AmazonSqsFifoStamp` + Use the stamp :class:`Symfony\\Component\\Messenger\\Bridge\\AmazonSqs\\Transport\\AmazonSqsFifoStamp` to define the ``Message group ID`` and the ``Message deduplication ID``. FIFO queues don't support setting a delay per message, a value of ``delay: 0`` From d2fdd03de2aa6ae6ee1eb4ff6d223a6be16442a2 Mon Sep 17 00:00:00 2001 From: Nyholm Date: Sun, 11 Oct 2020 22:50:38 +0200 Subject: [PATCH 06/11] syntax --- messenger.rst | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/messenger.rst b/messenger.rst index c0c7b72477f..b8ff1bcb795 100644 --- a/messenger.rst +++ b/messenger.rst @@ -1176,27 +1176,27 @@ The ``SQS`` transport configuration looks like this: The transport will automatically create queues that are needed. This can be disabled setting the "auto_setup" option to ``false``. -A number of options can be configured via the DSN or via the ``options`` key +A numbeXr of options can be configured via the DSN or via the ``options`` key under the transport in ``messenger.yaml``: -================== ===================================== ====================== - Option Description Default -================== ===================================== ====================== -endpoint Absolute URL to the SQS service https://sqs.eu-west-1.amazonaws.com -region Name of the AWS region eu-west-1 -queue_name Name of the queue messages -account Identifier of the AWS account The owner of the credentials +================== ====================================== ====================== + Option Description Default +================== ====================================== ====================== +endpoint Absolute URL to the SQS service https://sqs.eu-west-1.amazonaws.com +region Name of the AWS region eu-west-1 +queue_name Name of the queue messages +account Identifier of the AWS account The owner of the credentials access_key AWS access key secret_key AWS secret key -buffer_size Number of messages to prefetch 9 -wait_time `Long polling`_ duration in seconds 20 -poll_timeout Wait for new message duration in 0.1 +buffer_size Number of messages to prefetch 9 +wait_time `Long polling`_ duration in seconds 20 +poll_timeout Wait for new message duration in 0.1 seconds -visibility_timeout Amount of seconds the message will Queue's configuration +visibility_timeout Amount of seconds the message will Queue's configuration not be visible (`Visibility Timeout`_) -auto_setup Whether the table should be created true +auto_setup Whether the table should be created true automatically during send / get. -================== ===================================== ====================== +================== ====================================== ====================== .. note:: @@ -1210,7 +1210,7 @@ auto_setup Whether the table should be created true .. note:: - If the queue name is suffixed by ``.fifo``, AWS will creates a `FIFO queue`_ + If the queue name is suffixed by ``.fifo``, AWS will creates a `FIFO queue`_. Use the stamp :class:`Symfony\\Component\\Messenger\\Bridge\\AmazonSqs\\Transport\\AmazonSqsFifoStamp` to define the ``Message group ID`` and the ``Message deduplication ID``. From f56ddd3270f7c32538679ab3d4cba79672874448 Mon Sep 17 00:00:00 2001 From: Nyholm Date: Sun, 11 Oct 2020 22:52:48 +0200 Subject: [PATCH 07/11] Syntax fix --- messenger.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/messenger.rst b/messenger.rst index b8ff1bcb795..d80edfd273d 100644 --- a/messenger.rst +++ b/messenger.rst @@ -1792,4 +1792,4 @@ Learn more .. _`SymfonyCasts' message serializer tutorial`: https://symfonycasts.com/screencast/messenger/transport-serializer .. _`Long polling`: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html .. _`Visibility Timeout`: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html -.. _`FIFO queue': https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html +.. _`FIFO queue`: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html From 5fa1465dfeba211eff941a13184196c3d0b74c6c Mon Sep 17 00:00:00 2001 From: Nyholm Date: Sun, 11 Oct 2020 23:15:28 +0200 Subject: [PATCH 08/11] Typo --- messenger.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/messenger.rst b/messenger.rst index d80edfd273d..416f52c10a2 100644 --- a/messenger.rst +++ b/messenger.rst @@ -1176,7 +1176,7 @@ The ``SQS`` transport configuration looks like this: The transport will automatically create queues that are needed. This can be disabled setting the "auto_setup" option to ``false``. -A numbeXr of options can be configured via the DSN or via the ``options`` key +A number of options can be configured via the DSN or via the ``options`` key under the transport in ``messenger.yaml``: ================== ====================================== ====================== From d198bb747ef0750ffe3c111a6d76fa89db4b1dbe Mon Sep 17 00:00:00 2001 From: Nyholm Date: Mon, 12 Oct 2020 08:21:55 +0200 Subject: [PATCH 09/11] minor --- messenger.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/messenger.rst b/messenger.rst index 416f52c10a2..5949732cdab 100644 --- a/messenger.rst +++ b/messenger.rst @@ -1360,7 +1360,6 @@ by tagging the handler service with ``messenger.message_handler`` 'handles' => SmsNotification::class, ]); - Possible options to configure with tags are: * ``bus`` @@ -1661,7 +1660,6 @@ middleware and *only* include your own: ], ]); - .. note:: If a middleware service is abstract, a different instance of the service will From 7d530ac7227041614eea94ea347cfc3b397f65f6 Mon Sep 17 00:00:00 2001 From: Nyholm Date: Mon, 12 Oct 2020 13:51:13 +0200 Subject: [PATCH 10/11] Typos --- messenger.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/messenger.rst b/messenger.rst index 5949732cdab..bbd1015903f 100644 --- a/messenger.rst +++ b/messenger.rst @@ -1200,17 +1200,17 @@ auto_setup Whether the table should be created true .. note:: - The ``wait_time`` parameter define the maximum duration Amazon SQS should + The ``wait_time`` parameter defines the maximum duration Amazon SQS should wait until a message is available in a queue before sending a response. It helps reducing the cost of using Amazon SQS by eliminating the number of empty responses. - The ``poll_timeout`` parameter define the duration the receiver should wait + The ``poll_timeout`` parameter defines the duration the receiver should wait before returning null. It avoids blocking other receivers from being called. .. note:: - If the queue name is suffixed by ``.fifo``, AWS will creates a `FIFO queue`_. + If the queue name is suffixed by ``.fifo``, AWS will create a `FIFO queue`_. Use the stamp :class:`Symfony\\Component\\Messenger\\Bridge\\AmazonSqs\\Transport\\AmazonSqsFifoStamp` to define the ``Message group ID`` and the ``Message deduplication ID``. From cf4331b1d395aac5b81b637b064acde39e728059 Mon Sep 17 00:00:00 2001 From: Nyholm Date: Mon, 12 Oct 2020 17:42:42 +0200 Subject: [PATCH 11/11] Sort alphabetically --- messenger.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/messenger.rst b/messenger.rst index bbd1015903f..387c99bd47f 100644 --- a/messenger.rst +++ b/messenger.rst @@ -1182,20 +1182,20 @@ under the transport in ``messenger.yaml``: ================== ====================================== ====================== Option Description Default ================== ====================================== ====================== -endpoint Absolute URL to the SQS service https://sqs.eu-west-1.amazonaws.com -region Name of the AWS region eu-west-1 -queue_name Name of the queue messages -account Identifier of the AWS account The owner of the credentials access_key AWS access key -secret_key AWS secret key +account Identifier of the AWS account The owner of the credentials +auto_setup Whether the table should be created true + automatically during send / get. buffer_size Number of messages to prefetch 9 -wait_time `Long polling`_ duration in seconds 20 +endpoint Absolute URL to the SQS service https://sqs.eu-west-1.amazonaws.com poll_timeout Wait for new message duration in 0.1 seconds +queue_name Name of the queue messages +region Name of the AWS region eu-west-1 +secret_key AWS secret key visibility_timeout Amount of seconds the message will Queue's configuration not be visible (`Visibility Timeout`_) -auto_setup Whether the table should be created true - automatically during send / get. +wait_time `Long polling`_ duration in seconds 20 ================== ====================================== ====================== .. note::