Multichannel Marketing - Changes to the marketing classes #36012

nima-karimi · 2022-12-15T12:53:19Z

All Submissions:

Have you followed the WooCommerce Contributing guideline?
Does your code follow the WordPress' coding standards?
Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Changes proposed in this Pull Request:

This PR implements the following changes to the core library (initially introduced in #35099):

Allow third-party channel registration without checking the extension's slug against a predetermined list. Any extension can now register as a marketing channel if they use the classes introduced in Multichannel Marketing - Core Library #35099. Previously, we checked if the extension's slug matches one of the values returned by the GET https://woocommerce.com/wp-json/wccom/marketing-tab/1.2/recommendations.json API before allowing them to register as a marketing channel.
Change the name of the method MarketingChannelInterface::get_error_no to get_error_count. The reasoning for this change was that get_error_count describes more clearly what the method returns. (reference: pe2C5g-zb-p2)
Revert the changes made to the InstalledExtensions.php class and its usage. This is a legacy class, and it's best to keep it intact since we are introducing the new marketing dashboard as an opt-in feature. The new feature will be implemented as a new API in Multichannel Marketing Backend MVP: API #34556

How to test the changes in this Pull Request:

Some of the changes in this PR can not be tested yet because they still require an API to be implemented in #34556 and a front-end as described in #34903.

We can test if the changes to InstalledExtensions have reverted the Marketing page to its original state (before #35099):

Install some marketing extensions returned by the GET https://woocommerce.com/wp-json/wccom/marketing-tab/1.2/recommendations.json API. For example, AutomateWoo, Facebook for WooCommerce, or Pinterest for WooCommerce.
Go to Marketing > Overview and confirm that all the installed extensions appear on the "Installed Extensions" list.

Other information:

Have you added an explanation of what your changes do and why you'd like us to include them?
Have you written new tests for your changes, as applicable?
Have you created a changelog file for each project being changed, ie pnpm --filter=<project> changelog add?

FOR PR REVIEWER ONLY:

I have reviewed that everything is sanitized/escaped appropriately for any SQL or XSS injection possibilities. I made sure Linting is not ignored or disabled.

Do not check if the marketing channel's slug exists in the list returned by WooCommerce.com Recommendation API. This essentially allows any third-party extension to register as a marketing channel.

The InstalledExtensions class will be used by the previous generation of Marketing dashboard (if the user has not enabled the new "Marketing" feature); therefore, it's best to restore it to the original code.

github-actions · 2022-12-15T12:57:07Z

New hook, template, or database changes in this PR

Template changes:

File: /plugins/woocommerce/templates/cart/cart-shipping.php
- WARNING: This template may require a version bump!
File: /plugins/woocommerce/templates/emails/customer-on-hold-order.php
- WARNING: This template may require a version bump!
File: /plugins/woocommerce/templates/emails/plain/customer-on-hold-order.php
- WARNING: This template may require a version bump!
File: /plugins/woocommerce/templates/global/quantity-input.php
- WARNING: This template may require a version bump!
File: /plugins/woocommerce/templates/taxonomy-product-attribute.php
- WARNING: This template may require a version bump!

github-actions · 2022-12-15T13:24:44Z

Test Results Summary

Commit SHA: 4e192e7

Test 🧪	Passed ✅	Failed 🚨	Broken 🚧	Skipped ⏭️	Unknown ❔	Total 📊	Duration ⏱️
API Tests	259	0	0	2	0	261	0m 53s
E2E Tests	189	0	0	6	0	195	17m 14s

To view the full API test report, click here.
To view the full E2E test report, click here.
To view all test reports, visit the WooCommerce Test Reports Dashboard.

…ure/35956-mcm-library-changes

layoutd

👍🏻 LGTM, I left a few notes about the changes made to (or missing from) MarketingChannels.php.

One of the tests was failing, but I re-ran them and everything came up green.

layoutd · 2022-12-27T12:29:23Z

plugins/woocommerce/src/Admin/Marketing/MarketingChannels.php

-
-			return;
+		if ( isset( $this->registered_channels[ $channel->get_slug() ] ) ) {
+			throw new Exception( 'Marketing channel cannot be registered because there is already a channel registered with the same slug!' );


Could/should this be included for translation? e.g.,

woocommerce/plugins/woocommerce/src/Admin/Notes/DataStore.php

Lines 126 to 128 in 527249f

} else {

throw new \Exception( __( 'Invalid admin note', 'woocommerce' ) );

}

layoutd · 2022-12-27T12:35:57Z

plugins/woocommerce/src/Admin/Marketing/MarketingChannels.php

-		$this->marketing_specs  = $marketing_specs;
-		$this->allowed_channels = $this->get_allowed_channels();
-	}
-
 	/**
 	 * Registers a marketing channel.
 	 *


There are still a few references to the "predetermined list of third party extension" in the method doc blocks that could be cleaned up.

…ure/35956-mcm-library-changes

* Multichannel Marketing - Core Library (#35099) * Create channel interface and campaign value class * Create MarketingChannels class * Register MarketingChannels class in DI container * Use the new MarketingChannels class to get the installed marketing extensions' data * Use DI container to access InstalledExtensions class * Add InstalledExtensions to the $provides array * Hint that campaign cost should also indicate the currency * Initialize the channels array * Add unit tests for MarketingCampaign * Add unit tests for MarketingChannels * Add Price class to represent a price with currency * Use Price class for marketing campaign's cost * Define a constant to indicate the MCM classes exist This constant will be checked by third-party extensions before utilizing any of the classes/interfaces defined for this feature. * Create MarketingSpecs class to include WC.com API calls * Remove WC.com API calls from Marketing class And replace them with calls from MarketingSpecs class. * Use the const from MarketingSpecs * Fix MarketingChannels unit tests * Add missing settings URL to the channel data Co-authored-by: Nima <nima.karimi@automattic.com> * Multichannel Marketing - Changes to the marketing classes (#36012) * Rename `get_errors_no` to `get_errors_count` * Remove the validation for marketing channel slugs Do not check if the marketing channel's slug exists in the list returned by WooCommerce.com Recommendation API. This allows any third-party extension to register as a marketing channel. * Revert InstalledExtensions The InstalledExtensions class will be used by the previous generation of the Marketing dashboard (if the user has not enabled the new "Marketing" feature); therefore, it's best to restore it to the original code. * Fix code style * Translate Exception message * Remove doc references to a predetermined list of marketing channels Co-authored-by: Nima <nima.karimi@automattic.com> * Multichannel Marketing - API (#36222) * Rename `get_errors_no` to `get_errors_count` * Remove the validation for marketing channel slugs Do not check if the marketing channel's slug exists in the list returned by WooCommerce.com Recommendation API. This essentially allows any third-party extension to register as a marketing channel. * Revert InstalledExtensions The InstalledExtensions class will be used by the previous generation of Marketing dashboard (if the user has not enabled the new "Marketing" feature); therefore, it's best to restore it to the original code. * Fix code style * Add channel property to MarketingCampaign * Add methods to filter the recommended marketing channels and extensions * Add `marketing/recommendations` API * Add unit tests for `marketing/recommendations` API * Add `marketing/channels` API * Add unit tests for `marketing/channels` API * Add `marketing/campaigns` API * Add unit tests for `marketing/campaigns` API * Translate Exception message * Remove doc references to predetermined list of marketing channels * Add `unregister_all` method To allow unregistering all marketing channels. * Unregister all channels on test tear down * Change API access denied authorization code * Change API access permission * Add MarketingCampaignType class This allows defining campaign types for each marketing channel. * Add campaign type property to campaign class * Add `marketing/campaign-types` API This API returns the aggregated list of supported marketing campaign types for all registered marketing channels. * Add unit tests for `marketing/campaign-types` API * Remove unused jsonSerialize method * Fix unit tests Co-authored-by: Nima <nima.karimi@automattic.com> * Add changelog * Add product listing status sync failed Co-authored-by: Nima <nima.karimi@automattic.com>

Nima added 3 commits December 14, 2022 14:33

Rename get_errors_no to get_errors_count

8d8f416

Remove the validation for marketing channel slugs

7734d41

Do not check if the marketing channel's slug exists in the list returned by WooCommerce.com Recommendation API. This essentially allows any third-party extension to register as a marketing channel.

Revert InstalledExtensions

91e0a0c

The InstalledExtensions class will be used by the previous generation of Marketing dashboard (if the user has not enabled the new "Marketing" feature); therefore, it's best to restore it to the original code.

nima-karimi added plugin: woocommerce Issues related to the WooCommerce Core plugin. focus: marketing Marketing page in WooCommerce Admin, i.e. `/wp-admin/admin.php?page=wc-admin&path=%2Fmarketing`. labels Dec 15, 2022

nima-karimi requested a review from a team December 15, 2022 12:53

nima-karimi self-assigned this Dec 15, 2022

github-actions bot added the focus: react admin label Dec 15, 2022

github-actions bot added the release: highlight Issues that have a high user impact and need to be discussed/paid attention to. label Dec 15, 2022

Nima added 2 commits December 15, 2022 15:08

Merge branch 'feature/34548-multichannel-marketing-backend' into feat…

08c5404

…ure/35956-mcm-library-changes

Fix code style

53dac1d

layoutd approved these changes Dec 27, 2022

View reviewed changes

Nima added 3 commits December 28, 2022 13:28

Translate Exception message

4404263

Remove doc references to predetermined list of marketing channels

f7be32d

Merge branch 'feature/34548-multichannel-marketing-backend' into feat…

4e192e7

…ure/35956-mcm-library-changes

nima-karimi merged commit 3fb9001 into feature/34548-multichannel-marketing-backend Dec 28, 2022

nima-karimi deleted the feature/35956-mcm-library-changes branch December 28, 2022 17:25

nima-karimi mentioned this pull request Jan 16, 2023

Multichannel marketing backend and API #36453

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Multichannel Marketing - Changes to the marketing classes #36012

Multichannel Marketing - Changes to the marketing classes #36012

nima-karimi commented Dec 15, 2022

github-actions bot commented Dec 15, 2022

github-actions bot commented Dec 15, 2022 •

edited

layoutd left a comment

layoutd Dec 27, 2022

layoutd Dec 27, 2022

	} else {
	throw new \Exception( __( 'Invalid admin note', 'woocommerce' ) );
	}

Multichannel Marketing - Changes to the marketing classes #36012

Multichannel Marketing - Changes to the marketing classes #36012

Conversation

nima-karimi commented Dec 15, 2022

All Submissions:

Changes proposed in this Pull Request:

How to test the changes in this Pull Request:

Other information:

FOR PR REVIEWER ONLY:

github-actions bot commented Dec 15, 2022

New hook, template, or database changes in this PR

Template changes:

github-actions bot commented Dec 15, 2022 • edited

Test Results Summary

layoutd left a comment

Choose a reason for hiding this comment

layoutd Dec 27, 2022

Choose a reason for hiding this comment

layoutd Dec 27, 2022

Choose a reason for hiding this comment

github-actions bot commented Dec 15, 2022 •

edited