-
Notifications
You must be signed in to change notification settings - Fork 2k
/
index.tsx
513 lines (459 loc) · 15.2 KB
/
index.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
/* eslint-disable wpcalypso/jsx-classname-namespace */
import { FormInputValidation } from '@automattic/components';
import { Subscriber } from '@automattic/data-stores';
import { localizeUrl } from '@automattic/i18n-utils';
import { Title, SubTitle, NextButton } from '@automattic/onboarding';
import { TextControl, FormFileUpload, Button } from '@wordpress/components';
import { useDispatch, useSelect } from '@wordpress/data';
import { createElement, createInterpolateElement } from '@wordpress/element';
import { sprintf } from '@wordpress/i18n';
import { Icon, check } from '@wordpress/icons';
import emailValidator from 'email-validator';
import { useTranslate } from 'i18n-calypso';
import {
ChangeEvent,
FormEvent,
FunctionComponent,
useState,
useEffect,
useRef,
useCallback,
} from 'react';
import { useActiveJobRecognition } from '../../hooks/use-active-job-recognition';
import { useInProgressState } from '../../hooks/use-in-progress-state';
import { RecordTrackEvents, useRecordAddFormEvents } from '../../hooks/use-record-add-form-events';
import { tip } from './icon';
import './style.scss';
interface Props {
siteId: number;
isSiteOnFreePlan?: boolean;
flowName?: string;
showTitle?: boolean;
showSubtitle?: boolean;
showCsvUpload?: boolean;
showFormManualListLabel?: boolean;
submitBtnName?: string;
submitBtnAlwaysEnable?: boolean;
allowEmptyFormSubmit?: boolean;
manualListEmailInviting?: boolean;
recordTracksEvent?: RecordTrackEvents;
onSkipBtnClick?: () => void;
onImportFinished?: () => void;
onChangeIsImportValid?: ( isValid: boolean ) => void;
titleText?: string;
subtitleText?: string;
}
export const AddSubscriberForm: FunctionComponent< Props > = ( props ) => {
const translate = useTranslate();
const HANDLED_ERROR = {
IMPORT_LIMIT: 'subscriber_import_limit_reached',
IMPORT_BLOCKED: 'blocked_import',
};
const {
siteId,
isSiteOnFreePlan,
flowName,
showTitle = true,
showSubtitle,
showCsvUpload,
showFormManualListLabel,
submitBtnName = translate( 'Add subscribers' ),
submitBtnAlwaysEnable,
allowEmptyFormSubmit,
manualListEmailInviting,
recordTracksEvent,
onImportFinished,
onChangeIsImportValid,
titleText,
subtitleText,
} = props;
const {
addSubscribers,
importCsvSubscribers,
importCsvSubscribersUpdate,
getSubscribersImports,
} = useDispatch( Subscriber.store );
/**
* ↓ Fields
*/
const emailControlMaxNum = 6;
const emailControlPlaceholder = [
translate( 'bestie@email.com' ),
translate( 'chrisfromwork@email.com' ),
translate( 'mom@email.com' ),
];
const inProgress = useInProgressState();
const prevInProgress = useRef( inProgress );
const prevSubmitAttemptCount = useRef< number >();
const [ selectedFile, setSelectedFile ] = useState< File >();
const [ isSelectedFileValid, setIsSelectedFileValid ] = useState( true );
const [ emails, setEmails ] = useState< string[] >( [] );
const [ isValidEmails, setIsValidEmails ] = useState< boolean[] >( [] );
const [ isDirtyEmails, setIsDirtyEmails ] = useState< boolean[] >( [] );
const [ emailFormControls, setEmailFormControls ] = useState( emailControlPlaceholder );
const [ submitAttemptCount, setSubmitAttemptCount ] = useState( 0 );
const [ submitBtnReady, setIsSubmitBtnReady ] = useState( isSubmitButtonReady() );
const importSelector = useSelect(
( select ) => select( Subscriber.store ).getImportSubscribersSelector(),
[]
);
const [ formFileUploadElement ] = useState(
createElement( FormFileUpload, {
name: 'import',
onChange: onFileInputChange,
disabled: inProgress,
} )
);
const getValidEmails = useCallback( () => {
return isValidEmails.map( ( x, i ) => x && emails[ i ] ).filter( ( x ) => !! x ) as string[];
}, [ isValidEmails, emails ] );
/**
* ↓ Effects
*/
// get initial list of jobs
useEffect( () => {
getSubscribersImports( siteId );
}, [] );
// run active job recognition process which updates state
useActiveJobRecognition( siteId );
useEffect( extendEmailFormControls, [ emails ] );
useEffect( importFinishedRecognition );
useEffect( () => {
prevInProgress.current = inProgress;
}, [ inProgress ] );
useEffect( () => {
prevSubmitAttemptCount.current = submitAttemptCount;
}, [ submitAttemptCount ] );
useEffect( () => {
setIsSubmitBtnReady( isSubmitButtonReady() );
}, [ isValidEmails, selectedFile, allowEmptyFormSubmit, submitBtnAlwaysEnable ] );
useEffect( () => {
if ( !! getValidEmails().length || ( isSelectedFileValid && selectedFile ) ) {
onChangeIsImportValid && onChangeIsImportValid( true );
} else {
onChangeIsImportValid && onChangeIsImportValid( false );
}
}, [ getValidEmails, isSelectedFileValid, selectedFile, onChangeIsImportValid ] );
useRecordAddFormEvents( recordTracksEvent, flowName );
/**
* ↓ Functions
*/
function onFormSubmit( e: FormEvent ) {
e.preventDefault();
setSubmitAttemptCount( submitAttemptCount + 1 );
const validEmails = getValidEmails();
if ( manualListEmailInviting ) {
// add subscribers with invite email
validEmails.length && addSubscribers( siteId, validEmails );
// import subscribers providing only CSV list of emails
selectedFile && importCsvSubscribers( siteId, selectedFile );
} else {
// import subscribers proving CSV and manual list of emails
( selectedFile || validEmails.length ) &&
importCsvSubscribers( siteId, selectedFile, validEmails );
}
! validEmails.length && ! selectedFile && allowEmptyFormSubmit && onImportFinished?.();
}
function onEmailChange( value: string, index: number ) {
const _value = value.trim();
setEmail( _value, index );
setIsValidEmail( _value, index );
}
function setEmail( value: string, index: number ) {
const _emails = Array.from( emails );
_emails[ index ] = value;
setEmails( _emails );
}
function setIsValidEmail( value: string, index: number ) {
const _isValidEmails = Array.from( isValidEmails );
_isValidEmails[ index ] = emailValidator.validate( value );
setIsValidEmails( _isValidEmails );
}
function setIsDirtyEmail( value: string, index: number ) {
const _isDirtyEmails = Array.from( isDirtyEmails );
_isDirtyEmails[ index ] = !! value;
setIsDirtyEmails( _isDirtyEmails );
}
function isValidExtension( fileName: string ) {
const extensionRgx = new RegExp( /[^\\]*\.(?<extension>\w+)$/ );
const validExtensions = [ 'csv' ];
const match = extensionRgx.exec( fileName );
return validExtensions.includes( match?.groups?.extension.toLowerCase() as string );
}
function onFileInputChange( e: ChangeEvent< HTMLInputElement > ) {
const f = e.target.files;
if ( ! f || ! f.length ) {
return;
}
const file = f[ 0 ];
const isValid = isValidExtension( file.name );
setIsSelectedFileValid( isValid );
isValid && setSelectedFile( file );
importCsvSubscribersUpdate( undefined );
}
function onFileRemoveClick() {
setSelectedFile( undefined );
importCsvSubscribersUpdate( undefined );
}
function extendEmailFormControls() {
const validEmailsNum = isValidEmails.filter( ( x ) => x ).length;
const currentEmailFormControlsNum = emailFormControls.length;
if (
currentEmailFormControlsNum < emailControlMaxNum &&
currentEmailFormControlsNum === validEmailsNum
) {
const controls = Array.from( emailFormControls );
controls.push( translate( 'Add another email' ) );
setEmailFormControls( controls );
}
}
function isSubmitButtonReady(): boolean {
return (
submitBtnAlwaysEnable ||
!! allowEmptyFormSubmit ||
!! getValidEmails().length ||
!! selectedFile
);
}
function resetFormState(): void {
setEmails( [] );
setSelectedFile( undefined );
importCsvSubscribersUpdate( undefined );
setIsSelectedFileValid( true );
setIsValidEmails( [] );
setIsDirtyEmails( [] );
}
function importFinishedRecognition() {
if ( ! importSelector?.error && prevInProgress.current && ! inProgress ) {
resetFormState();
onImportFinished?.();
}
}
function includesHandledError() {
return Object.values( HANDLED_ERROR ).includes( importSelector?.error?.code as string );
}
/**
* ↓ Templates
*/
function renderImportErrorMsg() {
const error = importSelector?.error;
return (
error && (
<FormInputValidation icon="tip" isError={ false } isWarning={ true } text="">
<>
<Icon icon={ tip } />
{ ( () => {
switch ( error.code ) {
case HANDLED_ERROR.IMPORT_LIMIT:
return createInterpolateElement(
translate(
'We couldn’t import your subscriber list as you’ve hit the 100 email limit for our free plan. The good news? You can upload a list of any size after upgrading to any paid plan. If you’d like to import a smaller list now, you can <uploadBtn>upload a different file</uploadBtn>.'
),
{ uploadBtn: formFileUploadElement }
);
case HANDLED_ERROR.IMPORT_BLOCKED:
return translate(
'We ran into a security issue with your subscriber list. It’s nothing to worry about. If you reach out to our support team when you’ve finished setting things up, they’ll help resolve this for you.'
);
default:
return error.message;
}
} )() }
</>
</FormInputValidation>
)
);
}
function renderFileValidationMsg() {
return (
! isSelectedFileValid && (
<FormInputValidation className="is-file-validation" isError={ true } text="">
{ createInterpolateElement(
translate(
'Sorry, you can only upload CSV files right now. Most providers will let you export this from your settings. <uploadBtn>Select another file</uploadBtn>'
),
{ uploadBtn: formFileUploadElement }
) }
</FormInputValidation>
)
);
}
function renderEmptyFormValidationMsg() {
const validationMsg = showCsvUpload
? translate(
"You'll need to add at least one email address " +
'or upload a CSV file of current subscribers to continue.'
)
: translate( "You'll need to add at least one subscriber to continue." );
return (
!! submitAttemptCount &&
submitAttemptCount !== prevSubmitAttemptCount.current &&
! emails.filter( ( x ) => !! x ).length &&
! selectedFile && <FormInputValidation isError={ true } text={ validationMsg } />
);
}
function renderEmailListInfoMsg() {
return (
emailControlMaxNum === isValidEmails.filter( ( x ) => x ).length && (
<FormInputValidation icon="tip" isError={ false } text="">
<Icon icon={ tip } />
{ translate( 'Great start! You’ll be able to add more subscribers after setup.' ) }
</FormInputValidation>
)
);
}
function renderImportCsvDisclaimerMsg() {
return (
( !! getValidEmails().length || ( isSelectedFileValid && selectedFile ) ) && (
<p className="add-subscriber__form--disclaimer">
{ createInterpolateElement(
sprintf(
/* translators: the first string variable shows CTA button name */
translate(
'By clicking "%s", you represent that you\'ve obtained the appropriate consent to email each person. <Button>Learn more</Button>.'
),
submitBtnName
),
{
Button: createElement( Button, {
variant: 'link',
target: '__blank',
href: localizeUrl(
'https://wordpress.com/support/launch-a-newsletter/import-subscribers-to-a-newsletter/'
),
} ),
}
) }
</p>
)
);
}
function renderImportCsvLabel() {
const ariaLabelMsg = isSiteOnFreePlan
? translate( 'Or upload a CSV file of up to 100 emails from your existing list. Learn more.' )
: translate( 'Or upload a CSV file of emails from your existing list. Learn more.' );
const interpolateElement = {
uploadBtn: formFileUploadElement,
Button: createElement( Button, {
variant: 'link',
target: '__blank',
rel: 'noreferrer',
href: localizeUrl(
'https://wordpress.com/support/launch-a-newsletter/import-subscribers-to-a-newsletter/'
),
} ),
};
const labelText = isSiteOnFreePlan
? createInterpolateElement(
translate(
'Or <uploadBtn>upload a CSV file</uploadBtn> of up to 100 emails from your existing list. <Button>Learn more</Button>.'
),
interpolateElement
)
: createInterpolateElement(
translate(
'Or <uploadBtn>upload a CSV file</uploadBtn> of emails from your existing list. <Button>Learn more</Button>.'
),
interpolateElement
);
return (
isSelectedFileValid &&
! selectedFile && (
<div aria-label={ ariaLabelMsg } className="add-subscriber__form--disclaimer">
{ labelText }
</div>
)
);
}
function renderImportCsvSelectedFileLabel() {
return (
isSelectedFileValid &&
selectedFile && (
<label className="add-subscriber__form-label-links">
{ createInterpolateElement(
sprintf(
/* translators: the first string variable shows a selected file name, Replace and Remove are links */
translate(
'<strong>%s</strong> <uploadBtn>Replace</uploadBtn> | <removeBtn>Remove</removeBtn>'
),
selectedFile?.name
),
{
strong: createElement( 'strong' ),
uploadBtn: formFileUploadElement,
removeBtn: createElement( Button, {
variant: 'link',
onClick: onFileRemoveClick,
} ),
}
) }
</label>
)
);
}
return (
<div className="add-subscriber">
{ ( showTitle || showSubtitle ) && (
<div className="add-subscriber__title-container">
{ showTitle && (
<Title>{ titleText ?? translate( 'Let’s add your first subscribers' ) }</Title>
) }
{ showSubtitle && (
<SubTitle>
{ subtitleText ??
translate(
'Your subscribers will receive an email notification whenever you publish a new post.'
) }
</SubTitle>
) }
</div>
) }
<div className="add-subscriber__form--container">
<form onSubmit={ onFormSubmit } autoComplete="off">
{ emailFormControls.map( ( placeholder, i ) => {
const showError = isDirtyEmails[ i ] && ! isValidEmails[ i ] && emails[ i ];
return (
<div key={ i }>
{ showFormManualListLabel && i === 0 && (
<label className="add-subscriber__form-label-emails">
<strong>{ translate( 'Emails' ) }</strong>
</label>
) }
<TextControl
className={ showError ? 'is-error' : '' }
disabled={ inProgress }
placeholder={ placeholder }
value={ emails[ i ] || '' }
help={ isValidEmails[ i ] ? <Icon icon={ check } /> : undefined }
onChange={ ( value: string ) => onEmailChange( value, i ) }
onBlur={ () => setIsDirtyEmail( emails[ i ], i ) }
/>
{ showError && (
<FormInputValidation
isError={ true }
text={ translate( 'The format of the email is invalid' ) }
/>
) }
</div>
);
} ) }
{ renderEmailListInfoMsg() }
{ renderFileValidationMsg() }
{ renderImportErrorMsg() }
{ ! includesHandledError() && renderImportCsvSelectedFileLabel() }
{ showCsvUpload && ! includesHandledError() && renderImportCsvLabel() }
{ renderEmptyFormValidationMsg() }
<NextButton
type="submit"
className="add-subscriber__form-submit-btn"
isBusy={ inProgress }
disabled={ ! submitBtnReady }
>
{ submitBtnName }
</NextButton>
{ showCsvUpload && ! includesHandledError() && renderImportCsvDisclaimerMsg() }
</form>
</div>
</div>
);
};