Magento2: Incorrect caching subscription status in newsletter plugin

[wojtekn]

Preconditions

1. Magento 2.2.5

Steps to reproduce

I spot the issue during placing order with two different community modules installed. In short, during placing order the customer object is subscribed by custom code which utilizes newsletter module, then customer object is saved a couple times, and it results with subscribing him, unsubscribing and subscribing again.

It is a bit complicated to prepare such environment and to reproduce it so I prepared short steps which show incorrect framework behavior.

1. Load customer object using repository and check his subscription status:

$customer = $customerRepository->getById($customerId);
$extensionAttributes = $customer->getExtensionAttributes();
var_dump($extensionAttributes->getIsSubscribed()); // returns false

1. Subscribe customer to newsletter:

   $subscriber = $subscriberFactory->create();
   $subscriber->subscribeCustomerById($customerId);

2. Check subscription status again:

   $customer = $customerRepository->getById($customerId);
   $extensionAttributes = $customer->getExtensionAttributes();
   var_dump($extensionAttributes->getIsSubscribed()); // still returns false

Expected result

1. getIsSubscribed returns true when runs after subscribing customer

Actual result

1. getIsSubscribed returns false

[magento-engcom-team]

Hi @wojtekn. Thank you for your report.
To help us process this issue please make sure that you provided the following information:

• [ ] Summary of the issue
• [ ] Information on your environment
• [ ] Steps to reproduce
• [ ] Expected and actual results

Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:

@magento-engcom-team give me $VERSION instance

where $VERSION is version tags (starting from 2.2.0+) or develop branches (for example: 2.3-develop).
For more details, please, review the Magento Contributor Assistant documentation.

@wojtekn do you confirm that you was able to reproduce the issue on vanilla Magento instance following steps to reproduce?

• [ ] yes
• [ ] no

[orlangur]

@wojtekn,

then customer object is saved a couple times

Such problem is not observed when customer is saved using CustomerRepository.

[magento-engcom-team]

Hi @engcom-backlog-nazar. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: :point_down:

• [x] 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
  Details

  If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

• [x] 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

• [x] 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• [x] 4. Verify that the issue is reproducible on 2.3-develop branch

  Details

  - Add the comment @magento-engcom-team give me 2.3-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and _stop verification process here_!
  

• [x] 5. Verify that the issue is reproducible on 2.2-develop branch.

  Details

  - Add the comment @magento-engcom-team give me 2.2-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.2-develop branch, please add the label Reproduced on 2.2.x

• [x] 6. Add label Issue: Confirmed once verification is complete.

• [x] 7. Make sure that automatic system confirms that report has been added to the backlog.

[ghost]

Hi @wojtekn, Hi @orlangur thank you for your report, in first time when i run this on console command i'm have false, but another time always return true, so problem with registry, when you load customer from repository you have no choise to load from.

[magento-engcom-team]

@engcom-backlog-nazar Thank you for verifying the issue. Based on the provided information internal tickets MAGETWO-96607, MAGETWO-96608 were created

[orlangur]

@engcom-backlog-nazar correct, I noticed from subscribeCustomerById implementation that there is no way customer instance may be reloaded. What I was saying is that it is quite easy to circumvent in third-party code.

[ghost]

@orlangur we need some additional options like in productRepository force Reload = true.

[orlangur]

@engcom-backlog-nazar introducing such flags is _really_ lame. It would be better if invalidation occurs somewhere inside subscribeCustomerById, we already have push method to achieve this.

[wojtekn]

@engcom-backlog-nazar I think changing getById implementation to preserve extension attributes also makes sense. It wouldn't solve my use case, but it would fix other ones. Eg. I could write plugin for subscribeCustomerById and fill extension attribute there instead of removing this variable caching in the core file patch.

@orlangur it makes sense IMO.

[magento-engcom-team]

Hi @milindsingh. Thank you for working on this issue.
Looks like this issue is already verified and confirmed. But if your want to validate it one more time, please, go though the following instruction:

• [ ] 1. Add/Edit Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• [ ] 2. Verify that the issue is reproducible on 2.3-develop branch

  Details

  - Add the comment @magento-engcom-team give me 2.3-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and _stop verification process here_!
  

• [ ] 3. Verify that the issue is reproducible on 2.2-develop branch.

  Details

  - Add the comment @magento-engcom-team give me 2.2-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.2-develop branch, please add the label Reproduced on 2.2.x

• [ ] 4. If the issue is not relevant or is not reproducible any more, feel free to close it.