Add lead to the log only after persisted to avoid cascade persist error

[escopecz]

Q	A
Bug fix?	Y
New feature?	N
Automated tests included?	Y
Related user documentation PR URL	/
Related developer documentation PR URL	/
Issues addressed (#s or URLs)	/
BC breaks?	N
Deprecations?	N

Description:

I'm trying to fix this error:

Doctrine\ORM\ORMInvalidArgumentException: A new entity was found through the relationship 'Mautic\LeadBundle\Entity\LeadEventLog#lead' that was not configured to cascade persist operations for entity: Mautic\LeadBundle\Entity\Lead with ID #. To solve this issue: Either explicitly call EntityManager#persist() on this unknown entity or configure cascade persist  this association in the mapping for example @ManyToOne(..,cascade={"persist"}). in vendor/doctrine/orm/lib/Doctrine/ORM/ORMInvalidArgumentException.php:92
Stack trace:
#0 vendor/doctrine/orm/lib/Doctrine/ORM/UnitOfWork.php(852): Doctrine\ORM\ORMInvalidArgumentException::newEntityFoundThroughRelationship(Array, Object(Mautic\LeadBundle\Entity\Lead))
#1 vendor/doctrine/orm/lib/Doctrine/ORM/UnitOfWork.php(740): Doctrine\ORM\UnitOfWork->computeAssociationChanges(Array, Object(Mautic\LeadBundle\Entity\Lead))
#2 vendor/doctrine/orm/lib/Doctrine/ORM/UnitOfWork.php(452): Doctrine\ORM\UnitOfWork->computeChangeSet(Object(Doctrine\ORM\Mapping\ClassMetadata), Object(Mautic\LeadBundle\Entity\LeadEventLog))
#3 vendor/doctrine/orm/lib/Doctrine/ORM/UnitOfWork.php(485): Doctrine\ORM\UnitOfWork->computeScheduleInsertsChangeSets()
#4 vendor/doctrine/orm/lib/Doctrine/ORM/UnitOfWork.php(342): Doctrine\ORM\UnitOfWork->computeSingleEntityChangeSet(Object(Mautic\LeadBundle\Entity\LeadEventLog))
#5 vendor/doctrine/orm/lib/Doctrine/ORM/EntityManager.php(356): Doctrine\ORM\UnitOfWork->commit(Object(Mautic\LeadBundle\Entity\LeadEventLog))
#6 app/bundles/CoreBundle/Entity/CommonRepository.php(782): Doctrine\ORM\EntityManager->flush(Object(Mautic\LeadBundle\Entity\LeadEventLog))
#7 app/bundles/LeadBundle/Model/ImportModel.php(510): Mautic\CoreBundle\Entity\CommonRepository->saveEntity(Object(Mautic\LeadBundle\Entity\LeadEventLog))
#8 app/bundles/LeadBundle/Model/ImportModel.php(393): Mautic\LeadBundle\Model\ImportModel->logImportRowError(Object(Mautic\LeadBundle\Entity\LeadEventLog), 'Lead limit exce...')
#9 app/bundles/LeadBundle/Controller/ImportController.php(240): Mautic\LeadBundle\Model\ImportModel->process(Object(Mautic\LeadBundle\Entity\Import), Object(Mautic\LeadBundle\Helper\Progress))
#10 app/bundles/CoreBundle/Controller/CommonController.php(475): Mautic\LeadBundle\Controller\ImportController->newAction(0, '')
#11 [internal function]: Mautic\CoreBundle\Controller\CommonController->executeAction('new', 0, 0, '')

The problem is that I don't quite know how to replicate it. But from the code I think it happens like this:

1. A contact is being imported.
2. The LeadEventLog is instantiated.
3. The Lead is associated to the LeadEventLog
4. The Lead is being saved but failed by throwing an exception.
5. The exception is caught and the LeadEventLog is saved but it fails because it has a Lead entity associated from 3.

So my solution is to associate Lead with LeadEventLog only if the Lead save ends with a success.

Steps to reproduce the bug:

1. Dunno

Steps to test this PR:

1. Run $ bin/phpunit -d memory_limit=2048M --bootstrap vendor/autoload.php --configuration app/phpunit.xml.dist --filter LeadModelTest
2. Try to import a CSV and check that it was a success.

[Maxell92]

Are you sure this change will be saved to database? No flush is called here.

[escopecz]

Yep. Because of https://github.com/mautic/mautic/pull/5804/files#diff-9784b7fe0e4e02b9768b1efa4c50fe25R393 and https://github.com/mautic/mautic/pull/5804/files#diff-9784b7fe0e4e02b9768b1efa4c50fe25R396.

I also tested it and it stores all rows to the log table. Before the last commit it stored only errors.

[Maxell92]

Works for me

[javjim]

tests pass