CRM: Add Send_Email action + create a typical real automation scenario for a business

[cleacos]

Proposed changes:

With the goal of having a real example, this PR adds a basic Send_Email functionality. Most of the code was extracted from #33219 and updated/adapted in this one.

This is the automation we want to implement:

• On new Contact with the status Lead, tag it as Prospect.
• When the Contact Lead changes to Customer, add the New Client tag and remove the Prospect tag. Finally, send a Customer Welcome email with a special offer.

And these are the two Automation Workflows required:

$workflow_1 = new \Automattic\Jetpack\CRM\Automation\Automation_Workflow(
	[
		'name'         => 'New Contact Lead: Prospect',
		'description'  => 'On a new Contact Lead, apply the tag Prospect',
		'category'     => 'contact',
		'active'       => true,
		'triggers'     => [
			\Automattic\Jetpack\CRM\Automation\Triggers\Contact_Created::get_slug(),
		],
		'initial_step' => 1,
		'steps'        => [
			1 => [
				'slug'       => \Automattic\Jetpack\CRM\Automation\Conditions\Contact_Field_Changed::get_slug(),
				'attributes' => [
					'field'    => 'status',
					'operator' => 'is',
					'value'    => 'Lead'
				],
				'next_step_true'  => 2,
				'next_step_false' => null,
			],
			2 => [
				'slug'       => \Automattic\Jetpack\CRM\Automation\Actions\Add_Remove_Contact_Tag::get_slug(),
				'attributes' => [
					'mode'      => 'append',
					'tag_input' => ['Prospect'],
				],
				'next_step_true'  => null,
			],
		],
	]
);

$workflow_2 = new \Automattic\Jetpack\CRM\Automation\Automation_Workflow(
	[
		'name'         => 'Conversion Contact Lead to Customer',
		'description'  => 'This automation will remove/add tags and send a Welcome Email to the new customer.',
		'category'     => 'contact',
		'active'       => true,
		'triggers'     => [
			\Automattic\Jetpack\CRM\Automation\Triggers\Contact_Status_Updated::get_slug(),
		],
		'initial_step' => 1,
		'steps'        => [
			1 => [
				'slug'       => \Automattic\Jetpack\CRM\Automation\Conditions\Contact_Transitional_Status::get_slug(),
				'attributes' => [
					'operator'            => 'from_to',
					'previous_status_was' => 'Lead',
					'new_status_is'       => 'Customer'
				],
				'next_step_true'  => 2,
				'next_step_false' => null,
			],
			2 => [
				'slug'       => \Automattic\Jetpack\CRM\Automation\Actions\Add_Remove_Contact_Tag::get_slug(),
				'attributes' => [
					'mode'      => 'append',
					'tag_input' => ['New Client'],
				],
				'next_step_true'  => 3,
			],
			3 => [
				'slug'       => \Automattic\Jetpack\CRM\Automation\Actions\Add_Remove_Contact_Tag::get_slug(),
				'attributes' => [
					'mode'      => 'remove',
					'tag_input' => ['Prospect'],
				],
				'next_step_true'  => 4,
			],
			4 => [
				'slug'        => \Automattic\Jetpack\CRM\Automation\Actions\Send_Generic_Email::get_slug(),
				'attributes'  => [
					'subject' => 'Welcome to the store!',
					'body'    => 'Hey ##CONTACT-FNAME##!<br><p>Welcome to the App Services Store. We want to give you a special welcome offer, a 20% discount on your next month\'s renewal.</p><p>Kind Regards,<br>The App Services Store</p>',
				],
				'next_step_true'  => null,
			],
		],
	]
);

$repo = new \Automattic\Jetpack\CRM\Automation\Workflow\Workflow_Repository();
$repo->persist( $workflow_1 );
$repo->persist( $workflow_2 );

Other information:

• Have you written new tests for your changes, if applicable?
• Have you checked the E2E test CI results, and verified that your changes do not break them?
• Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

• Check the code of the action added.
• Tests should pass.
• In your JPCRM installation, remove any previous Workflow stored, and add the 2 Workflows defined in the description.
  • Create a Contact with status Lead (With name and email). Check that the Prospect tag was applied.
  • Then update the status of that Contact to Customer. Check that the Prospect tags was removed and the New Client tag was added.
  • Finally, check in your mail trapper app (Mailtrap or MailHog) the Welcome email to the Customer, with the Name placeholder changed by the Contact name.

[github-actions]

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

• ✅ Include a description of your PR changes.
  
• ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  
• ✅ Add testing instructions.
  
• ✅ Specify whether this PR includes any changes to data or privacy.
  
• ✅ Add changelog entries to affected projects
  

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

---

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

---

Once your PR is ready for review, check one last time that all required checks (other than "Required review") appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

---

Crm plugin:

• Next scheduled release: November 7, 2023.
• Scheduled code freeze: October 30, 2023.

[tbradsha]

This was a previously-created condition, but perhaps we should rename it to something simple, like Contact_Status_Changed. Or better yet, remove it, since I assume it's covered already in Contact_Field_Changed?

[tbradsha]

I fixed a few typos in the workflows above.

[tbradsha]

Testing works as intended, except for triggering a PHP notice on the second workflow (it's a generic message, but it's definitely triggered by us):

Notice: Trying to get property 'ID' of non-object in /wp-includes/link-template.php on line 456

See inline comments as well. I think we should keep the email action generic (as the current class name indicates), but otherwise we need to rename it.

[tbradsha]

The PHP notice is pre-existing; see Automattic/zero-bs-crm#3357.

[tbradsha]

Pushed some minor changes to comments/strings: ae4f83f

Looks good now!