woocommerce/plugins/woocommerce-blocks/tests/php/Domain/Services/CreateAccount.php

206 lines
5.5 KiB
PHP
Raw Normal View History

Support "create account" option in checkout block (https://github.com/woocommerce/woocommerce-blocks/pull/2851) * prototype 'create account' checkbox in checkout block * expose store config for generating password/username to blocks: + use FILTER_VALIDATE_BOOLEAN instead of hard-coded `yes` * stub out signup form in checkout block * context / provider to store checkout signup form data * revert signup form - checkout block will always generate username etc * persist signup checkbox in checkout state & pass to checkout API * add `create_account` param to order API, fix name in client POST * handle creating user account as part of order (first cut) * ensure the order is associated with the new customer * only show 'create account' checkbox when appropriate (guest checkout) * remove unnecessary username/password variables * refactor account-creation logic into functions: - clarify inputs and outputs - use RouteException for error handling - use woo options directly, avoid dependency on WC_Checkout * update "email exists" error message to use existing error message text * handle all known errors from wc_create_new_customer + use core message * only show "create account" checkbox to shopper when necessary: - if guest checkout is disabled, user must create account - not optional * only show "create account" if account creation is optional: - fixes incorrect logic in previous commit - add some comments to clarify * fix create account logic in API when checkout requires account: - use correct woo setting option name - reverse logic to match option = allow guest false means registration required * strip html tags from create account error messages * temporarily force enable autogenerate user/pass in new account API * fix rebase errors * add new allowCreateAccount attribute in checkout block * show/hide `Create account` checkbox dependent on block attribute: - previously was dependent on store setting * new create user API, with set initial password email (first cut): - use core register_new_user for creating the user - this triggers core "set new password" email - generate username using logic lifted from WC core - rough cut, lots to tidy/polish here * remove alternative/unused create account function * set `Customer` role for signups during checkout * eslint fix - switch case break * remove comments that mirror code & might go stale * tidy func comment * remove unused function * use store setting `allow signup` for default value of new block option * refactor order signup logic to service class first cut: - new CreateAccount service - hook up via custom action (for now at least) - paste over existing create account logic (temporary - will be replaced) * adapt wc_create_new_customer logic in CreateAccount service (WIP) * set default_password_nag on new account + throw instead of WP_Error * rename `createAccount` => `shouldCreateAccount` to clarify meaning * fix checkout block - renamed `shouldCreateAccount` (missed in prev commit) * prototype sending alternative email template for checkout signup * add magic link to set password to blocks new account html email * tidy up new account email templates - set password link, subject/heading * use same id so merchant setting tweaks apply to our new improved email * remove logging * code tidies in CreateAccount service: - remove unnecessary constructor - type-hint in should_create_customer_account - streamline logic in should_create_customer_account - remove unnecessary `empty` check - add comments to illuminate different use-cases handled by should_create_customer_account * don't provide password to new account email templates (no longer used) * declare dependencies in root namespace * code tidies on new account email class: - correct namespace and camelcase name - declare class in file, don't instantiate; instantiate in client code (CreateAccount service) when used - no require/file import, use `use` * move CustomerNewEmail to folder matching namespace * use Package->get_path for email template paths: - CreateAccount service now depends on Package - CreateAccount passes Package to email class so it can use `get_path` - note: CustomerNewAccount is not registered with DI container as it needs to be instantiated after Woo init (for `WC_Email`) - shift email templates to {plugin}/templates, consistent with WP convention * call CreateAccount::from_order_request directly, no custom hook: - custom hook is not appropriate as we may not want to allow extensibility in this way - TBD * add appropriate margin above create account checkbox * remove unnecessary direct-access protection * generalise name of error-handling method * simplify CustomerNewAccount - instantiate directly, when needed * remove unused new_account_email member - now instantiated on demand * numerous fixes and updates due to rebase changes * fix typo in name of CustomerNewAccount php file (missing `n`) * experiment - link to lost-password form in my-account (prototype branded screen) * Revert "experiment - link to lost-password form in my-account (prototype branded screen)" This reverts commit e1dc6dd5e9f0218ede81da92188d813c2d0856d9. * feature gate CreateAccount service init to dev build only + + remove stale comment * feature gate front end "Create account" checkbox to feature plugin only * feature gate editor "allow signup" option to dev build only * feature gate checkout api create account - dev build only * tweak feature gating PHP logic so it's robust: - all PHP feature gating is in the service class - all publicly-available methods return early if feature gate off - Checkout rest API transparently calls service - no explicit feature gate at API level * ensure frontend/editor features are feature gated (isExperimentalBuild is a function) * feature gate value of checkoutAllowsSignup - can only be true in feature plugin * fix a / an typo in comment Co-authored-by: Albert Juhé Lluveras <contact@albertjuhe.com> * remove commented code * hello world unit test (doesn't test anything yet) * add a command for running unit tests when container already up: - this should probably move to another PR/branch * basic tests of core logic in CreateAccount service * import isExperimentalBuild direct: - import from alias package was causing an issue, likely a dependency cycle * refactor from_order_request to return new user ID so it's easier to test * test creating a customer from an order + rest request: - i.e. a full end-to-end integration test * delete redundant test and tidy comments * generalise test to provider format * refactor create-dup-user err test to use same approach as success test * add test for when user should not be created * don't hard-code options in "create" test, remove redundant provider in no-account-requested test * de-generalise "user already signed up" test * add test for malformed email * flesh out & comment successful signup tests * flesh out "invalid email" tests * clarify no account requested test comment * remove phpunit:quick - I don't think it's needed * add comment explaining this is an integration test * experiment – disable feature flag, is this why the tests are failing? * revert test commit - restore feature gate (experimental flag) * skip all tests if CreateAccount is disabled due to feature flag * d'oh - expose CreateAccount:is_feature_enabled so can be used in tests * add jsdoc for checkout-state shouldCreateAccount field * remove unnecessary comment + fix whitespace/indentation * simulate logged-out user for createaccount signup tests * use a single, compound if statement for early return (review nitpick) * don't hide `checkoutAllowsSignup` store setting behind feature flag: - the feature flag should be used to enable/disable behaviour - it's dangerous to adjust store settings/options based on feature flag * rejig tests so they require woocommerce_blocks_phase==3: - make feature gate method private to avoid exposing - remove feature flag check & test skip for other builds - set blocks phase in travis config * remove redundant user-logout in test setup - cleaner to just require this * use WP function bracket style (same line) Co-authored-by: Darren Ethier <darren@roughsmootheng.in> Co-authored-by: Albert Juhé Lluveras <contact@albertjuhe.com>
2020-10-01 02:07:16 +00:00
<?php
namespace Automattic\WooCommerce\Blocks\Tests\Library;
use \WP_UnitTestCase;
use Automattic\WooCommerce\Blocks\Domain\Package;
use Automattic\WooCommerce\Blocks\Domain\Services\Email\CustomerNewAccount;
use Automattic\WooCommerce\Blocks\Domain\Services\CreateAccount as TestedCreateAccount;
/**
* Tests CreateAccount service class.
*
* Note: this feature is currently feature gated. This test class assumes
* that woocommerce_blocks_phase===3, i.e. dev build. Tests will fail
* with other builds (release feature plugin, woo core package).
* Related: https://github.com/woocommerce/woocommerce-gutenberg-products-block/issues/3211
*
* @since $VID:$
*/
class CreateAccount extends WP_UnitTestCase {
private function get_test_instance() {
return new TestedCreateAccount( new Package( 'test', './' ) );
}
/**
* Generalised routine for setting up test input and store state
* and calling from_order_request. Used for all tests.
*
* Note this requires (assumes) that there is no logged-in user.
*
* @return assoc array with keys [ 'user_id', 'order' ] if successful.
*/
private function execute_create_customer_from_order( $email, $first_name, $last_name, $options = [] ) {
/// -- Test-specific setup start.
$tmp_enable_guest_checkout = get_option( 'woocommerce_enable_guest_checkout' );
$enable_guest_checkout = array_key_exists( 'enable_guest_checkout', $options ) ? $options['enable_guest_checkout'] : false;
update_option( 'woocommerce_enable_guest_checkout', $enable_guest_checkout );
$test_request = new \WP_REST_Request();
$should_create_account = array_key_exists( 'should_create_account', $options ) ? $options['should_create_account'] : false;
$test_request->set_param( 'should_create_account', $should_create_account );
$test_order = new \WC_Order();
$test_order->set_billing_email( $email );
$test_order->set_billing_first_name( $first_name );
$test_order->set_billing_last_name( $last_name );
/// -- End test-specific setup.
$user_id = $this->get_test_instance()->from_order_request( $test_order, $test_request );
/// -- Undo test-specific setup; restore previous state.
update_option( 'woocommerce_enable_guest_checkout', $tmp_enable_guest_checkout );
return [
'user_id' => $user_id,
'order' => $test_order,
];
}
/**
* Test successful user signup cases.
*
* @dataProvider create_customer_data
*/
public function test_create_customer_from_order( $email, $first_name, $last_name, $options ) {
$result = $this->execute_create_customer_from_order(
$email,
$first_name,
$last_name,
$options
);
$test_user = $this->factory()->user->get_object_by_id( $result['user_id'] );
$test_order = $result['order'];
$this->assertEquals( get_current_user_id(), $result['user_id'] );
$this->assertEquals( $test_user->first_name, $first_name );
$this->assertEquals( $test_user->last_name, $last_name );
$this->assertEquals( $test_user->user_email, $email );
$this->assertArraySubset( $test_user->roles, [ 'customer' ] );
$this->assertEquals( $test_order->get_customer_id(), $result['user_id'] );
}
public function create_customer_data() {
return [
// User requested an account.
[
'maryjones@testperson.net',
'Mary',
'Jones',
[
'should_create_account' => true,
'enable_guest_checkout' => true,
],
],
// User requested an account + site doesn't allow guest.
[
'maryjones@testperson.net',
'Mary',
'Jones',
[
'should_create_account' => true,
'enable_guest_checkout' => false,
],
],
// User requested an account; name fields are not required.
[
'private_person@hotmail.com',
'',
'',
[
'should_create_account' => true,
'enable_guest_checkout' => true,
],
],
// Store does not allow guest - signup is required (automatic).
[
'henrykissinger@fbi.gov',
'Henry',
'Kissinger',
[
'should_create_account' => false,
'enable_guest_checkout' => false,
],
],
];
}
/**
* Test exception is thrown if user already signed up.
*/
public function test_customer_already_exists() {
$user_id = $this->factory()->user->create( [
'user_email' => 'maryjones@testperson.net',
] );
$this->expectException( \Exception::class );
$result = $this->execute_create_customer_from_order(
'maryjones@testperson.net',
'Mary',
'Jones',
[
'should_create_account' => true,
'enable_guest_checkout' => true,
],
);
}
/**
* Test exception is thrown if email is invalid or malformed.
*
* @dataProvider invalid_email_data
*/
public function test_invalid_email( $email ) {
$this->expectException( \Exception::class );
$result = $this->execute_create_customer_from_order(
$email,
'Mary',
'Jones',
[
'should_create_account' => true,
'enable_guest_checkout' => true,
],
);
}
public function invalid_email_data() {
return [
[ 'maryjones AT testperson DOT net' ],
[ 'lean@fast' ],
[ '' ],
[ ' ' ],
];
}
/**
* Test that a user is not created if not requested (and the site allows guest checkout).
*/
public function test_no_account_requested() {
$site_user_counts = count_users();
$result = $this->execute_create_customer_from_order(
'maryjones@testperson.net',
'Mary',
'Jones',
[
'should_create_account' => false,
'enable_guest_checkout' => true,
],
);
$site_user_counts_after = count_users();
$this->assertEquals( $site_user_counts['total_users'], $site_user_counts_after['total_users'] );
}
}