Skip to content

in progress #2572

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

in progress #2572

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion dist/checkout-6837841f.css
View file
Open in desktop

Large diffs are not rendered by default.

342 changes: 342 additions & 0 deletions packages/braintree-integration/src/BraintreeCreditCardsPaymentMethod.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,342 @@
import { type CardInstrument, type LegacyHostedFormOptions } from '@bigcommerce/checkout-sdk';
import { compact, forIn } from 'lodash';
import React, {
createRef,
type FunctionComponent,
type ReactNode,
type RefObject,
useCallback,
useRef,
useState,
} from 'react';

import {
CreditCardPaymentMethodComponent,
type CreditCardPaymentMethodProps,
} from '@bigcommerce/checkout/credit-card-integration';
import {
getHostedCreditCardValidationSchema,
getHostedInstrumentValidationSchema,
HostedCreditCardFieldset,
HostedCreditCardValidation,
} from '@bigcommerce/checkout/hosted-credit-card-integration';
import {
CreditCardCustomerCodeField,
CreditCardInputStylesType,
getCreditCardInputStyles,
isInstrumentCardCodeRequiredSelector,
isInstrumentCardNumberRequiredSelector,
} from '@bigcommerce/checkout/instrument-utils';
import {
type PaymentMethodProps,
type PaymentMethodResolveId,
toResolvableComponent,
} from '@bigcommerce/checkout/payment-integration-api';
import { Modal } from '@bigcommerce/checkout/ui';
import { TranslatedString } from '@bigcommerce/checkout/locale';

interface BraintreeCreditCardPaymentMethodRef {
threeDSecureContentRef: RefObject<HTMLDivElement>;
cancelThreeDSecureVerification?(): void;
}

const BraintreeCreditCardsPaymentMethod: FunctionComponent<PaymentMethodProps> = (props) => {
const { checkoutService, checkoutState, paymentForm, language, method, onUnhandledError } = props;

const [threeDSecureContent, setThreeDSecureContent] = useState<HTMLElement>();
const [focusedFieldType, setFocusedFieldType] = useState<string>();

const ref = useRef<BraintreeCreditCardPaymentMethodRef>({
threeDSecureContentRef: createRef(),
});

const { cardCode, showCardHolderName, requireCustomerCode } = method.config;
const { setFieldTouched, setFieldValue, setSubmitted, submitForm } = paymentForm;
const isInstrumentCardCodeRequiredProp = isInstrumentCardCodeRequiredSelector(checkoutState);
const isInstrumentCardNumberRequiredProp =
isInstrumentCardNumberRequiredSelector(checkoutState);

const isCardCodeRequired = cardCode || cardCode === null;
const isCardHolderNameRequired = showCardHolderName ?? true;

const getHostedFieldId: (name: string) => string = useCallback(
(name) => {
return `${compact([method.gateway, method.id]).join('-')}-${name}`;
},
[method],
);

const getHostedFormOptions: (
selectedInstrument?: CardInstrument,
) => Promise<LegacyHostedFormOptions> = useCallback(
async (selectedInstrument) => {
const styleProps = ['color', 'fontFamily', 'fontSize', 'fontWeight'];

const isInstrumentCardNumberRequired = selectedInstrument
? isInstrumentCardNumberRequiredProp(selectedInstrument, method)
: false;
const isInstrumentCardCodeRequired = selectedInstrument
? isInstrumentCardCodeRequiredProp(selectedInstrument, method)
: false;

// Info: to generate valid nonce for vaulted instrument with untrusted shipping address, all hosted fields must be rendered
const shouldRenderHostedFields =
isInstrumentCardNumberRequired || isInstrumentCardCodeRequired;

let styleContainerId;

if (selectedInstrument && shouldRenderHostedFields) {
styleContainerId = getHostedFieldId('ccCvv');
}

if (!selectedInstrument) {
styleContainerId = getHostedFieldId('ccNumber');
}

return {
fields: selectedInstrument
? {
cardCodeVerification: shouldRenderHostedFields
? {
accessibilityLabel: language.translate(
'payment.credit_card_cvv_label',
),
containerId: getHostedFieldId('ccCvv'),
instrumentId: selectedInstrument.bigpayToken,
}
: undefined,
cardNumberVerification: shouldRenderHostedFields
? {
accessibilityLabel: language.translate(
'payment.credit_card_number_label',
),
containerId: getHostedFieldId('ccNumber'),
instrumentId: selectedInstrument.bigpayToken,
}
: undefined,
cardExpiryVerification: shouldRenderHostedFields
? {
accessibilityLabel: language.translate(
'payment.credit_card_expiry_label',
),
containerId: getHostedFieldId('ccExpiry'),
instrumentId: selectedInstrument.bigpayToken,
}
: undefined,
}
: {
cardCode: isCardCodeRequired
? {
accessibilityLabel: language.translate(
'payment.credit_card_cvv_label',
),
containerId: getHostedFieldId('ccCvv'),
}
: undefined,
cardExpiry: {
accessibilityLabel: language.translate(
'payment.credit_card_expiration_label',
),
containerId: getHostedFieldId('ccExpiry'),
placeholder: language.translate(
'payment.credit_card_expiration_placeholder_text',
),
},
cardName: {
accessibilityLabel: language.translate(
'payment.credit_card_name_label',
),
containerId: getHostedFieldId('ccName'),
},
cardNumber: {
accessibilityLabel: language.translate(
'payment.credit_card_number_label',
),
containerId: getHostedFieldId('ccNumber'),
},
},
styles: styleContainerId
? {
default: await getCreditCardInputStyles(styleContainerId, styleProps),
error: await getCreditCardInputStyles(
styleContainerId,
styleProps,
CreditCardInputStylesType.Error,
),
focus: await getCreditCardInputStyles(
styleContainerId,
styleProps,
CreditCardInputStylesType.Focus,
),
}
: {},
onBlur: ({ fieldType }) => {
if (focusedFieldType === fieldType) {
setFocusedFieldType(undefined);
}
},
onCardTypeChange: ({ cardType }) => {
setFieldValue('hostedForm.cardType', cardType);
},
onEnter: () => {
setSubmitted(true);
submitForm();
},
onFocus: ({ fieldType }) => {
setFocusedFieldType(fieldType);
},
onValidate: ({ errors = {} }) => {
forIn(errors, (fieldErrors, fieldType) => {
const errorKey = `hostedForm.errors.${fieldType}`;

setFieldValue(
errorKey,
fieldErrors && fieldErrors[0].type ? fieldErrors[0].type : '',
);

if (fieldErrors && fieldErrors[0]) {
setFieldTouched(errorKey);
}
});
},
};
},
[
focusedFieldType,
getHostedFieldId,
isCardCodeRequired,
isCardHolderNameRequired,
isInstrumentCardCodeRequiredProp,
isInstrumentCardNumberRequiredProp,
language,
method,
setFieldValue,
setFieldTouched,
setFocusedFieldType,
setSubmitted,
submitForm,
],
);

const getHostedStoredCardValidationFieldset: (
selectedInstrument?: CardInstrument,
) => ReactNode = useCallback(
(selectedInstrument) => {
const isInstrumentCardNumberRequired = selectedInstrument
? isInstrumentCardNumberRequiredProp(selectedInstrument, method)
: false;
const isInstrumentCardCodeRequired = selectedInstrument
? isInstrumentCardCodeRequiredProp(selectedInstrument, method)
: false;

return (
<HostedCreditCardValidation
cardCodeId={
isInstrumentCardCodeRequired ? getHostedFieldId('ccCvv') : undefined
}
cardNumberId={
isInstrumentCardNumberRequired ? getHostedFieldId('ccNumber') : undefined
}
focusedFieldType={focusedFieldType}
/>
);
},
[
focusedFieldType,
getHostedFieldId,
isInstrumentCardCodeRequiredProp,
isInstrumentCardNumberRequiredProp,
method,
],
);

const initializePayment = checkoutService.initializePayment;

const initializeBraintreePayment: CreditCardPaymentMethodProps['initializePayment'] =
useCallback(
async (options, selectedInstrument) => {
return initializePayment({
...options,
braintree: {
threeDSecure: {
addFrame(error, content, cancel) {
if (error) {
return onUnhandledError(error);
}

setThreeDSecureContent(content);
ref.current.cancelThreeDSecureVerification = cancel;
},
removeFrame() {
setThreeDSecureContent(undefined);
ref.current.cancelThreeDSecureVerification = undefined;
},
},
form:
getHostedFormOptions &&
(await getHostedFormOptions(selectedInstrument)),
},
});
},
[getHostedFormOptions, initializePayment, onUnhandledError],
);

const appendThreeDSecureContent = useCallback(() => {
if (ref.current.threeDSecureContentRef.current && threeDSecureContent) {
ref.current.threeDSecureContentRef.current.appendChild(threeDSecureContent);
}
}, [threeDSecureContent]);

const cancelThreeDSecureModalFlow = useCallback(() => {
setThreeDSecureContent(undefined);

if (ref.current.cancelThreeDSecureVerification) {
ref.current.cancelThreeDSecureVerification();
ref.current.cancelThreeDSecureVerification = undefined;
}
}, []);

return (
<>
<CreditCardPaymentMethodComponent
{...props}
cardFieldset={
<HostedCreditCardFieldset
additionalFields={
requireCustomerCode && <CreditCardCustomerCodeField name="ccCustomerCode" />
}
cardCodeId={isCardCodeRequired ? getHostedFieldId('ccCvv') : undefined}
cardExpiryId={getHostedFieldId('ccExpiry')}
cardNameId={getHostedFieldId('ccName')}
cardNumberId={getHostedFieldId('ccNumber')}
focusedFieldType={focusedFieldType}
/>
}
cardValidationSchema={getHostedCreditCardValidationSchema({ language })}
deinitializePayment={checkoutService.deinitializePayment}
getHostedFormOptions={getHostedFormOptions}
getStoredCardValidationFieldset={getHostedStoredCardValidationFieldset}
initializePayment={initializeBraintreePayment}
storedCardValidationSchema={getHostedInstrumentValidationSchema({
language,
isCardExpiryRequired: true,
})}
/>

<Modal
additionalBodyClassName="modal-body--center"
closeButtonLabel={<TranslatedString id="common.close_action" />}
isOpen={!!threeDSecureContent}
onAfterOpen={appendThreeDSecureContent}
onRequestClose={cancelThreeDSecureModalFlow}
>
<div ref={ref.current.threeDSecureContentRef} />
</Modal>
</>
);
};

export default toResolvableComponent<PaymentMethodProps, PaymentMethodResolveId>(
BraintreeCreditCardsPaymentMethod,
[{ id: 'braintree' }],
);
1 change: 1 addition & 0 deletions packages/braintree-integration/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
export { default as BraintreeAchPaymentMethod } from './BraintreeAch/BraintreeAchPaymentMethod';
export { default as BraintreeCreditCardsPaymentMethod } from './BraintreeCreditCardsPaymentMethod';
export { default as BraintreeFastlanePaymentMethod } from './BraintreeFastlane';
export { default as BraintreeLocalPaymentMethod } from './BraintreeLocalPaymentMethod';
export { default as BraintreePaypalPaymentMethod } from './BraintreePaypalPaymentMethod';
Expand Down
8 changes: 4 additions & 4 deletions packages/core/src/app/payment/paymentMethod/PaymentMethod.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { type CheckoutContextProps } from '@bigcommerce/checkout/payment-integra

import { withCheckout } from '../../checkout';

const BraintreeCreditCardPaymentMethod = lazy(() => import(/* webpackChunkName: "braintree-credit-card-payment-method" */'./BraintreeCreditCardPaymentMethod'));
// const BraintreeCreditCardPaymentMethod = lazy(() => import(/* webpackChunkName: "braintree-credit-card-payment-method" */'./BraintreeCreditCardPaymentMethod'));
const HostedCreditCardPaymentMethod = lazy(() => import(/* webpackChunkName: "hosted-credit-card-payment-method" */'./HostedCreditCardPaymentMethod'));
const HostedPaymentMethod = lazy(() => import(/* webpackChunkName: "hosted-payment-method" */'./HostedPaymentMethod'));
const PaypalPaymentsProPaymentMethod = lazy(() => import(/* webpackChunkName: "paypal-payments-pro-payment-method" */'./PaypalPaymentsProPaymentMethod'));
Expand Down Expand Up @@ -51,9 +51,9 @@ const PaymentMethodComponent: FunctionComponent<
> = (props) => {
const { method } = props;

if (method.id === PaymentMethodId.Braintree) {
return <Suspense><BraintreeCreditCardPaymentMethod {...props} /></Suspense>;
}
// if (method.id === PaymentMethodId.Braintree) {
// return <Suspense><BraintreeCreditCardPaymentMethod {...props} /></Suspense>;
// }

if (
method.type !== PaymentMethodProviderType.Hosted &&
Expand Down
4 changes: 2 additions & 2 deletions webpack.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,11 +159,11 @@ function appConfig(options, argv) {
].filter(Boolean),
module: {
rules: [
...(isProduction ? [{
{
test: /\.[tj]sx?$/,
enforce: 'pre',
loader: require.resolve('source-map-loader'),
}]: []),
},
{
test: /\.tsx?$/,
include: tsLoaderIncludes,
Expand Down