Bounce processing command (#355)

* BounceManager

* Add bounce email

* Move to the processor dir

* SendProcess lock service

* ClientIp + SystemInfo

* ProcessBouncesCommand

* ProcessBouncesCommand all methods

* BounceProcessingService

* AdvancedBounceRulesProcessor

* UnidentifiedBounceReprocessor

* ConsecutiveBounceHandler

* Refactor

* BounceDataProcessor

* ClientFactory + refactor

* BounceProcessorPass

* Register services + phpstan fix

* PhpMd

* PhpMd CyclomaticComplexity

* PhpCodeSniffer

* Tests

* Refactor

* Add tests

* More tests

* Fix tests

---------

Co-authored-by: Tatevik <tatevikg1@gmail.com>

Author: TatevikGr

composer.json

@@ -68,7 +68,9 @@
         "symfony/sendgrid-mailer": "^6.4",
         "symfony/twig-bundle": "^6.4",
         "symfony/messenger": "^6.4",
-        "symfony/lock": "^6.4"
+        "symfony/lock": "^6.4",
+        "webklex/php-imap": "^6.2",
+        "ext-imap": "*"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",

config/PHPMD/rules.xml

@@ -51,7 +51,7 @@
     <!-- rules from the "naming" rule set -->
     <rule ref="rulesets/naming.xml/ShortVariable">
         <properties>
-            <property name="exceptions" value="id,ip,cc"/>
+            <property name="exceptions" value="id,ip,cc,io"/>
         </properties>
     </rule>
     <rule ref="rulesets/naming.xml/LongVariable">

config/PhpCodeSniffer/ruleset.xml

@@ -15,7 +15,6 @@
     <!-- Classes -->
     <rule ref="Generic.Classes.DuplicateClassName"/>
     <rule ref="Squiz.Classes.ClassFileName"/>
-    <rule ref="Squiz.Classes.DuplicateProperty"/>
     <rule ref="Squiz.Classes.LowercaseClassKeywords"/>
     <rule ref="Squiz.Classes.SelfMemberReference"/>
 
@@ -41,9 +40,6 @@
     <!-- Control structures -->
     <rule ref="PEAR.ControlStructures.ControlSignature"/>
 
-    <!-- Debug -->
-    <rule ref="Generic.Debug.ClosureLinter"/>
-
     <!-- Files -->
     <rule ref="Generic.Files.OneClassPerFile"/>
     <rule ref="Generic.Files.OneInterfacePerFile"/>
@@ -54,7 +50,6 @@
     <rule ref="PEAR.Formatting.MultiLineAssignment"/>
 
     <!-- Functions -->
-    <rule ref="Generic.Functions.CallTimePassByReference"/>
     <rule ref="Squiz.Functions.FunctionDuplicateArgument"/>
     <rule ref="Squiz.Functions.GlobalFunction"/>
 
@@ -66,9 +61,6 @@
     <rule ref="Generic.NamingConventions.ConstructorName"/>
     <rule ref="PEAR.NamingConventions.ValidClassName"/>
 
-    <!-- Objects -->
-    <rule ref="Squiz.Objects.ObjectMemberComma"/>
-
     <!-- Operators -->
     <rule ref="Squiz.Operators.IncrementDecrementUsage"/>
     <rule ref="Squiz.Operators.ValidLogicalOperators"/>
@@ -110,6 +102,5 @@
     <rule ref="Squiz.WhiteSpace.CastSpacing"/>
     <rule ref="Squiz.WhiteSpace.LogicalOperatorSpacing"/>
     <rule ref="Squiz.WhiteSpace.OperatorSpacing"/>
-    <rule ref="Squiz.WhiteSpace.PropertyLabelSpacing"/>
     <rule ref="Squiz.WhiteSpace.SemicolonSpacing"/>
 </ruleset>

config/parameters.yml.dist

@@ -32,6 +32,32 @@ parameters:
     app.password_reset_url: '%%env(PASSWORD_RESET_URL)%%'
     env(PASSWORD_RESET_URL): 'https://example.com/reset/'
 
+    # bounce email settings
+    imap_bounce.email: '%%env(BOUNCE_EMAIL)%%'
+    env(BOUNCE_EMAIL): 'bounce@phplist.com'
+    imap_bounce.password: '%%env(BOUNCE_IMAP_PASS)%%'
+    env(BOUNCE_IMAP_PASS): 'bounce@phplist.com'
+    imap_bounce.host: '%%env(BOUNCE_IMAP_HOST)%%'
+    env(BOUNCE_IMAP_HOST): 'imap.phplist.com'
+    imap_bounce.port: '%%env(BOUNCE_IMAP_PORT)%%'
+    env(BOUNCE_IMAP_PORT): '993'
+    imap_bounce.encryption: '%%env(BOUNCE_IMAP_ENCRYPTION)%%'
+    env(BOUNCE_IMAP_ENCRYPTION): 'ssl'
+    imap_bounce.mailbox: '%%env(BOUNCE_IMAP_MAILBOX)%%'
+    env(BOUNCE_IMAP_MAILBOX): '/var/spool/mail/bounces'
+    imap_bounce.mailbox_name: '%%env(BOUNCE_IMAP_MAILBOX_NAME)%%'
+    env(BOUNCE_IMAP_MAILBOX_NAME): 'INBOX,ONE_MORE'
+    imap_bounce.protocol: '%%env(BOUNCE_IMAP_PROTOCOL)%%'
+    env(BOUNCE_IMAP_PROTOCOL): 'imap'
+    imap_bounce.unsubscribe_threshold: '%%env(BOUNCE_IMAP_UNSUBSCRIBE_THRESHOLD)%%'
+    env(BOUNCE_IMAP_UNSUBSCRIBE_THRESHOLD): '5'
+    imap_bounce.blacklist_threshold: '%%env(BOUNCE_IMAP_BLACKLIST_THRESHOLD)%%'
+    env(BOUNCE_IMAP_BLACKLIST_THRESHOLD): '3'
+    imap_bounce.purge: '%%env(BOUNCE_IMAP_PURGE)%%'
+    env(BOUNCE_IMAP_PURGE): '0'
+    imap_bounce.purge_unprocessed: '%%env(BOUNCE_IMAP_PURGE_UNPROCESSED)%%'
+    env(BOUNCE_IMAP_PURGE_UNPROCESSED): '0'
+
     # Messenger configuration for asynchronous processing
     app.messenger_transport_dsn: '%%env(MESSENGER_TRANSPORT_DSN)%%'
     env(MESSENGER_TRANSPORT_DSN): 'doctrine://default?auto_setup=true'

config/services.yml

@@ -1,51 +1,51 @@
 imports:
-    - { resource: 'services/*.yml' }
+  - { resource: 'services/*.yml' }
 
 services:
-    _defaults:
-        autowire: true
-        autoconfigure: true
-        public: false
-
-    PhpList\Core\Core\ConfigProvider:
-        arguments:
-            $config: '%app.config%'
-
-    PhpList\Core\Core\ApplicationStructure:
-        public: true
-
-    PhpList\Core\Security\Authentication:
-        public: true
-
-    PhpList\Core\Security\HashGenerator:
-        public: true
-
-    PhpList\Core\Routing\ExtraLoader:
-        tags: [routing.loader]
-
-    PhpList\Core\Domain\Common\Repository\AbstractRepository:
-        abstract: true
-        autowire: true
-        autoconfigure: false
-        public: true
-        factory: ['@doctrine.orm.entity_manager', getRepository]
-
-    # controllers are imported separately to make sure they're public
-    # and have a tag that allows actions to type-hint services
-    PhpList\Core\EmptyStartPageBundle\Controller\:
-        resource: '../src/EmptyStartPageBundle/Controller'
-        public: true
-        tags: [controller.service_arguments]
-
-    doctrine.orm.metadata.annotation_reader:
-        alias: doctrine.annotation_reader
-
-    doctrine.annotation_reader:
-        class: Doctrine\Common\Annotations\AnnotationReader
-        autowire: true
-
-    doctrine.orm.default_annotation_metadata_driver:
-        class: Doctrine\ORM\Mapping\Driver\AnnotationDriver
-        arguments:
-            - '@annotation_reader'
-            - '%kernel.project_dir%/src/Domain/Model/'
+  _defaults:
+    autowire: true
+    autoconfigure: true
+    public: false
+
+  PhpList\Core\Core\ConfigProvider:
+    arguments:
+      $config: '%app.config%'
+
+  PhpList\Core\Core\ApplicationStructure:
+    public: true
+
+  PhpList\Core\Security\Authentication:
+    public: true
+
+  PhpList\Core\Security\HashGenerator:
+    public: true
+
+  PhpList\Core\Routing\ExtraLoader:
+    tags: [routing.loader]
+
+  PhpList\Core\Domain\Common\Repository\AbstractRepository:
+    abstract: true
+    autowire: true
+    autoconfigure: false
+    public: true
+    factory: ['@doctrine.orm.entity_manager', getRepository]
+
+  # controllers are imported separately to make sure they're public
+  # and have a tag that allows actions to type-hint services
+  PhpList\Core\EmptyStartPageBundle\Controller\:
+    resource: '../src/EmptyStartPageBundle/Controller'
+    public: true
+    tags: [controller.service_arguments]
+
+  doctrine.orm.metadata.annotation_reader:
+    alias: doctrine.annotation_reader
+
+  doctrine.annotation_reader:
+    class: Doctrine\Common\Annotations\AnnotationReader
+    autowire: true
+
+  doctrine.orm.default_annotation_metadata_driver:
+    class: Doctrine\ORM\Mapping\Driver\AnnotationDriver
+    arguments:
+      - '@annotation_reader'
+      - '%kernel.project_dir%/src/Domain/Model/'

config/services/builders.yml

@@ -20,6 +20,6 @@ services:
     autowire: true
     autoconfigure: true
 
-  PhpListPhpList\Core\Domain\Messaging\Service\Builder\MessageOptionsBuilder:
+  PhpList\Core\Domain\Messaging\Service\Builder\MessageOptionsBuilder:
     autowire: true
     autoconfigure: true

config/services/commands.yml

@@ -11,3 +11,7 @@ services:
   PhpList\Core\Domain\Identity\Command\:
     resource: '../../src/Domain/Identity/Command'
     tags: ['console.command']
+
+  PhpList\Core\Domain\Messaging\Command\ProcessBouncesCommand:
+    arguments:
+      $protocolProcessors: !tagged_iterator 'phplist.bounce_protocol_processor'

config/services/managers.yml

@@ -72,10 +72,22 @@ services:
     autowire: true
     autoconfigure: true
 
+  PhpList\Core\Domain\Messaging\Service\Manager\BounceManager:
+    autowire: true
+    autoconfigure: true
+
   PhpList\Core\Domain\Messaging\Service\Manager\ListMessageManager:
     autowire: true
     autoconfigure: true
 
   PhpList\Core\Domain\Configuration\Service\Manager\ConfigManager:
     autowire: true
     autoconfigure: true
+
+  PhpList\Core\Domain\Messaging\Service\Manager\BounceRuleManager:
+    autowire: true
+    autoconfigure: true
+
+  PhpList\Core\Domain\Messaging\Service\Manager\SendProcessManager:
+    autowire: true
+    autoconfigure: true

config/services/processor.yml

@@ -0,0 +1,21 @@
+services:
+  _defaults:
+    autowire: true
+    autoconfigure: true
+    public: false
+
+  PhpList\Core\Domain\Messaging\Service\Processor\PopBounceProcessor:
+    arguments:
+      $host: '%imap_bounce.host%'
+      $port: '%imap_bounce.port%'
+      $mailboxNames: '%imap_bounce.mailbox_name%'
+    tags: ['phplist.bounce_protocol_processor']
+
+  PhpList\Core\Domain\Messaging\Service\Processor\MboxBounceProcessor:
+    tags: ['phplist.bounce_protocol_processor']
+
+  PhpList\Core\Domain\Messaging\Service\Processor\AdvancedBounceRulesProcessor: ~
+
+  PhpList\Core\Domain\Messaging\Service\Processor\UnidentifiedBounceReprocessor: ~
+
+  PhpList\Core\Domain\Messaging\Service\Processor\BounceDataProcessor: ~

config/services/providers.yml

@@ -2,3 +2,7 @@ services:
   PhpList\Core\Domain\Subscription\Service\Provider\SubscriberProvider:
     autowire: true
     autoconfigure: true
+
+  PhpList\Core\Domain\Messaging\Service\Provider\BounceActionProvider:
+    autowire: true
+    autoconfigure: true