2019-12-03 14:12:46 +00:00
|
|
|
/**
|
|
|
|
* External dependencies
|
|
|
|
*/
|
2020-08-14 11:08:16 +00:00
|
|
|
import classnames from 'classnames';
|
2020-08-31 10:17:42 +00:00
|
|
|
import { useEffect } from '@wordpress/element';
|
2019-12-06 13:18:55 +00:00
|
|
|
import { __ } from '@wordpress/i18n';
|
2020-03-06 12:20:17 +00:00
|
|
|
import {
|
2020-03-16 16:38:24 +00:00
|
|
|
PlaceOrderButton,
|
2020-03-30 13:04:27 +00:00
|
|
|
Policies,
|
2020-03-16 16:38:24 +00:00
|
|
|
ReturnToCartButton,
|
|
|
|
} from '@woocommerce/base-components/cart-checkout';
|
2020-03-17 11:45:33 +00:00
|
|
|
import {
|
|
|
|
CheckoutProvider,
|
2020-03-23 20:13:41 +00:00
|
|
|
useCheckoutContext,
|
2020-04-01 09:27:53 +00:00
|
|
|
useEditorContext,
|
2020-04-02 09:27:54 +00:00
|
|
|
useValidationContext,
|
2020-03-17 11:45:33 +00:00
|
|
|
} from '@woocommerce/base-context';
|
2020-08-31 10:17:42 +00:00
|
|
|
import { useStoreCart, useStoreNotices } from '@woocommerce/base-hooks';
|
|
|
|
import { CheckoutExpressPayment } from '@woocommerce/base-components/payment-methods';
|
2020-03-12 09:41:35 +00:00
|
|
|
import {
|
|
|
|
Sidebar,
|
|
|
|
SidebarLayout,
|
|
|
|
Main,
|
2020-03-13 15:49:33 +00:00
|
|
|
} from '@woocommerce/base-components/sidebar-layout';
|
2020-03-23 11:22:00 +00:00
|
|
|
import withScrollToTop from '@woocommerce/base-hocs/with-scroll-to-top';
|
2020-11-05 02:22:43 +00:00
|
|
|
import {
|
|
|
|
CHECKOUT_ALLOWS_GUEST,
|
|
|
|
CHECKOUT_ALLOWS_SIGNUP,
|
|
|
|
} from '@woocommerce/block-settings';
|
2020-10-15 01:13:49 +00:00
|
|
|
import { compareWithWooVersion, getSetting } from '@woocommerce/settings';
|
2020-01-06 22:28:09 +00:00
|
|
|
|
2019-12-03 14:12:46 +00:00
|
|
|
/**
|
|
|
|
* Internal dependencies
|
|
|
|
*/
|
2020-08-31 10:17:42 +00:00
|
|
|
import CheckoutForm from './form';
|
2020-04-06 15:35:09 +00:00
|
|
|
import CheckoutSidebar from './sidebar';
|
|
|
|
import CheckoutOrderError from './checkout-order-error';
|
2020-08-31 10:17:42 +00:00
|
|
|
import { LOGIN_TO_CHECKOUT_URL } from './utils';
|
2019-12-03 14:12:46 +00:00
|
|
|
import './style.scss';
|
|
|
|
|
2020-05-06 10:21:30 +00:00
|
|
|
/**
|
|
|
|
* Renders the Checkout block wrapped within the CheckoutProvider.
|
|
|
|
*
|
|
|
|
* @param {Object} props Component props.
|
|
|
|
* @return {*} The component.
|
|
|
|
*/
|
2020-04-08 15:03:39 +00:00
|
|
|
const Block = ( props ) => {
|
|
|
|
return (
|
|
|
|
<CheckoutProvider>
|
|
|
|
<Checkout { ...props } />
|
|
|
|
</CheckoutProvider>
|
|
|
|
);
|
|
|
|
};
|
2020-03-23 20:13:41 +00:00
|
|
|
|
2020-05-06 10:21:30 +00:00
|
|
|
/**
|
|
|
|
* Main Checkout Component.
|
|
|
|
*
|
|
|
|
* @param {Object} props Component props.
|
2020-09-20 23:54:08 +00:00
|
|
|
* @param {Object} props.attributes Incoming block attributes.
|
|
|
|
* @param {function(any):any} props.scrollToTop Function for scrolling to top.
|
2020-05-06 10:21:30 +00:00
|
|
|
*/
|
2020-04-07 15:41:22 +00:00
|
|
|
const Checkout = ( { attributes, scrollToTop } ) => {
|
2020-04-01 09:27:53 +00:00
|
|
|
const { isEditor } = useEditorContext();
|
2020-04-09 14:01:11 +00:00
|
|
|
const {
|
|
|
|
cartItems,
|
|
|
|
cartTotals,
|
|
|
|
cartCoupons,
|
|
|
|
cartNeedsPayment,
|
|
|
|
} = useStoreCart();
|
2020-04-04 17:36:46 +00:00
|
|
|
const {
|
|
|
|
hasOrder,
|
|
|
|
hasError: checkoutHasError,
|
2020-04-15 15:43:03 +00:00
|
|
|
isIdle: checkoutIsIdle,
|
2020-05-04 19:40:09 +00:00
|
|
|
customerId,
|
2020-04-04 17:36:46 +00:00
|
|
|
} = useCheckoutContext();
|
2020-04-20 10:11:32 +00:00
|
|
|
const {
|
|
|
|
hasValidationErrors,
|
|
|
|
showAllValidationErrors,
|
|
|
|
} = useValidationContext();
|
|
|
|
const { hasNoticesOfType } = useStoreNotices();
|
2020-03-30 14:32:23 +00:00
|
|
|
|
2020-04-20 10:11:32 +00:00
|
|
|
const hasErrorsToDisplay =
|
|
|
|
checkoutIsIdle &&
|
|
|
|
checkoutHasError &&
|
|
|
|
( hasValidationErrors || hasNoticesOfType( 'default' ) );
|
2020-05-06 10:21:30 +00:00
|
|
|
|
2020-10-15 01:13:49 +00:00
|
|
|
// Checkout signup is feature gated to WooCommerce 4.7 and newer;
|
|
|
|
// uses updated my-account/lost-password screen from 4.7+ for
|
|
|
|
// setting initial password.
|
|
|
|
const allowCreateAccount =
|
2020-10-28 21:42:49 +00:00
|
|
|
attributes.allowCreateAccount && compareWithWooVersion( '4.7.0', '<=' );
|
2020-10-15 01:13:49 +00:00
|
|
|
|
2020-04-02 09:27:54 +00:00
|
|
|
useEffect( () => {
|
2020-04-20 10:11:32 +00:00
|
|
|
if ( hasErrorsToDisplay ) {
|
2020-04-02 09:27:54 +00:00
|
|
|
showAllValidationErrors();
|
|
|
|
scrollToTop( { focusableSelector: 'input:invalid' } );
|
2020-04-04 17:36:46 +00:00
|
|
|
}
|
2020-07-31 15:17:01 +00:00
|
|
|
}, [ hasErrorsToDisplay, scrollToTop, showAllValidationErrors ] );
|
2020-04-02 09:27:54 +00:00
|
|
|
|
2020-03-30 14:32:23 +00:00
|
|
|
if ( ! isEditor && ! hasOrder ) {
|
2020-03-31 10:47:48 +00:00
|
|
|
return <CheckoutOrderError />;
|
2020-03-30 14:32:23 +00:00
|
|
|
}
|
|
|
|
|
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
|
|
|
if (
|
|
|
|
! isEditor &&
|
|
|
|
! customerId &&
|
|
|
|
! CHECKOUT_ALLOWS_GUEST &&
|
2020-11-05 02:22:43 +00:00
|
|
|
! ( allowCreateAccount && CHECKOUT_ALLOWS_SIGNUP )
|
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
|
|
|
) {
|
2020-05-04 19:40:09 +00:00
|
|
|
return (
|
|
|
|
<>
|
|
|
|
{ __(
|
|
|
|
'You must be logged in to checkout. ',
|
|
|
|
'woo-gutenberg-products-block'
|
|
|
|
) }
|
2020-08-31 10:17:42 +00:00
|
|
|
<a href={ LOGIN_TO_CHECKOUT_URL }>
|
2020-05-04 19:40:09 +00:00
|
|
|
{ __(
|
|
|
|
'Click here to log in.',
|
|
|
|
'woo-gutenberg-products-block'
|
|
|
|
) }
|
|
|
|
</a>
|
|
|
|
</>
|
|
|
|
);
|
|
|
|
}
|
2020-08-14 11:08:16 +00:00
|
|
|
const checkoutClassName = classnames( 'wc-block-checkout', {
|
|
|
|
'has-dark-controls': attributes.hasDarkControls,
|
|
|
|
} );
|
2019-12-03 14:12:46 +00:00
|
|
|
return (
|
2020-03-30 12:43:42 +00:00
|
|
|
<>
|
2020-08-14 11:08:16 +00:00
|
|
|
<SidebarLayout className={ checkoutClassName }>
|
2020-04-03 13:17:09 +00:00
|
|
|
<Main className="wc-block-checkout__main">
|
2020-08-20 14:14:12 +00:00
|
|
|
{ cartNeedsPayment && <CheckoutExpressPayment /> }
|
2020-08-31 10:17:42 +00:00
|
|
|
<CheckoutForm
|
|
|
|
showApartmentField={ attributes.showApartmentField }
|
|
|
|
showCompanyField={ attributes.showCompanyField }
|
|
|
|
showOrderNotes={ attributes.showOrderNotes }
|
|
|
|
showPhoneField={ attributes.showPhoneField }
|
|
|
|
requireCompanyField={ attributes.requireCompanyField }
|
|
|
|
requirePhoneField={ attributes.requirePhoneField }
|
2020-10-15 01:13:49 +00:00
|
|
|
allowCreateAccount={ allowCreateAccount }
|
2020-08-31 10:17:42 +00:00
|
|
|
/>
|
2020-03-23 20:13:41 +00:00
|
|
|
<div className="wc-block-checkout__actions">
|
|
|
|
{ attributes.showReturnToCart && (
|
|
|
|
<ReturnToCartButton
|
|
|
|
link={ getSetting(
|
|
|
|
'page-' + attributes?.cartPageId,
|
|
|
|
false
|
|
|
|
) }
|
2020-03-23 11:22:00 +00:00
|
|
|
/>
|
2020-03-23 20:13:41 +00:00
|
|
|
) }
|
2020-04-02 09:27:54 +00:00
|
|
|
<PlaceOrderButton />
|
2020-03-23 20:13:41 +00:00
|
|
|
</div>
|
|
|
|
{ attributes.showPolicyLinks && <Policies /> }
|
2020-03-30 12:43:42 +00:00
|
|
|
</Main>
|
2020-05-05 13:19:47 +00:00
|
|
|
<Sidebar className="wc-block-checkout__sidebar">
|
|
|
|
<CheckoutSidebar
|
|
|
|
cartCoupons={ cartCoupons }
|
|
|
|
cartItems={ cartItems }
|
|
|
|
cartTotals={ cartTotals }
|
|
|
|
/>
|
|
|
|
</Sidebar>
|
2020-03-30 12:43:42 +00:00
|
|
|
</SidebarLayout>
|
|
|
|
</>
|
2019-12-03 14:12:46 +00:00
|
|
|
);
|
|
|
|
};
|
|
|
|
|
2020-03-23 11:22:00 +00:00
|
|
|
export default withScrollToTop( Block );
|