wp-calypso/client/state/data-layer/wpcom/activity-log/update-credentials/index.js

import { ExternalLink } from '@wordpress/components';
import debugModule from 'debug';
import i18n from 'i18n-calypso';
import {
	JETPACK_CREDENTIALS_UPDATE,
	JETPACK_CREDENTIALS_UPDATE_SUCCESS,
	JETPACK_CREDENTIALS_UPDATE_FAILURE,
	JETPACK_CREDENTIALS_UPDATE_PROGRESS_START,
	JETPACK_CREDENTIALS_UPDATE_PROGRESS_UPDATE,
	JETPACK_CREDENTIALS_STORE,
	REWIND_STATE_UPDATE,
} from 'calypso/state/action-types';
import { recordTracksEvent } from 'calypso/state/analytics/actions';
import { registerHandlers } from 'calypso/state/data-layer/handler-registry';
import { transformApi } from 'calypso/state/data-layer/wpcom/sites/rewind/api-transformer';
import { http } from 'calypso/state/data-layer/wpcom-http/actions';
import { dispatchRequest } from 'calypso/state/data-layer/wpcom-http/utils';
import { markCredentialsAsValid } from 'calypso/state/jetpack/credentials/actions';
import { successNotice, errorNotice, infoNotice } from 'calypso/state/notices/actions';
import getJetpackCredentialsUpdateProgress from 'calypso/state/selectors/get-jetpack-credentials-update-progress';

const debug = debugModule( 'calypso:data-layer:update-credentials' );

const getMaybeNoticeId = ( action ) =>
	'noticeId' in action ? { noticeId: action.noticeId } : {};

export const request = ( action ) => {
	const maybeNotice = [];
	const maybeNoticeId = {};

	if ( action.shouldUseNotices ) {
		const notice = infoNotice( i18n.translate( 'Testing connection…' ), {
			duration: 30000,
			showDismiss: false,
		} );

		const {
			notice: { noticeId },
		} = notice;

		maybeNotice.push( notice );
		Object.assign( maybeNoticeId, { noticeId } );
	}

	const { path, ...otherCredentials } = action.credentials;
	const credentials = { ...otherCredentials, abspath: path };

	const tracksEvent = recordTracksEvent( 'calypso_rewind_creds_update_attempt', {
		site_id: action.siteId,
		protocol: action.credentials.protocol,
	} );

	return [
		...maybeNotice,
		tracksEvent,
		{
			type: JETPACK_CREDENTIALS_UPDATE_PROGRESS_START,
			siteId: action.siteId,
		},
		http(
			{
				apiNamespace: 'wpcom/v2',
				method: 'POST',
				path: `/sites/${ action.siteId }/rewind/credentials/update`,
				body: { credentials, stream: action.stream },
			},
			{ ...action, ...maybeNoticeId }
		),
	];
};

export const success = ( action, { rewind_state } ) =>
	[
		{
			type: JETPACK_CREDENTIALS_UPDATE_SUCCESS,
			siteId: action.siteId,
		},
		{
			type: JETPACK_CREDENTIALS_STORE,
			credentials: {
				[ action.credentials.role ]: action.credentials,
			},
			siteId: action.siteId,
		},
		action.credentials.role === 'main' &&
			action.shouldUseNotices &&
			successNotice( i18n.translate( 'Your site is now connected.' ), {
				duration: 4000,
				...getMaybeNoticeId( action ),
			} ),
		recordTracksEvent( 'calypso_rewind_creds_update_success', {
			site_id: action.siteId,
			protocol: action.credentials.protocol,
		} ),
		// the API transform could fail and the rewind data might
		// be unavailable so if that's the case just let it go
		// for now. we'll improve our rigor as time goes by.
		( () => {
			try {
				return {
					type: REWIND_STATE_UPDATE,
					siteId: action.siteId,
					data: transformApi( rewind_state ),
				};
			} catch ( e ) {}
		} )(),
		// The idea is to mark the credentials test as valid so
		// it doesn't need to be tested again.
		markCredentialsAsValid( action.siteId, action.credentials.role ),
	].filter( Boolean );

export const failure = ( action, error ) => ( dispatch, getState ) => {
	const baseOptions = { duration: 10000, ...getMaybeNoticeId( action ) };

	const dispatchFailure = ( message, options = {} ) => {
		if ( action.shouldUseNotices ) {
			dispatch( errorNotice( message, { ...baseOptions, ...options } ) );
		}

		const state = getState();
		const progress = getJetpackCredentialsUpdateProgress( state, action.siteId );

		dispatch(
			recordTracksEvent( 'calypso_rewind_creds_update_failure', {
				site_id: action.siteId,
				error: error.code,
				error_message: error.message,
				status_code: error.data ?? error.statusCode,
				transport_message: progress.lastError?.message ?? null,
				transport_stack: progress.lastError?.stack ?? null,
				host: action.credentials.host,
				kpri: action.credentials.kpri ? 'provided but [omitted here]' : 'not provided',
				pass: action.credentials.pass ? 'provided but [omitted here]' : 'not provided',
				path: action.credentials.path,
				port: action.credentials.port,
				protocol: action.credentials.protocol,
				user: action.credentials.user,
			} )
		);

		dispatch( {
			type: JETPACK_CREDENTIALS_UPDATE_FAILURE,
			siteId: action.siteId,
			error,
			wpcomError: error,
			translatedError: message,
			transportError: progress.lastError ?? undefined,
		} );
	};

	debug( 'failure: error=%o', error );

	const onLearnMoreClick = () => {
		dispatch(
			recordTracksEvent( 'calypso_jetpack_settings_credentials_error_learn_more_click', {
				error: error.code,
			} )
		);
	};

	switch ( error.code ) {
		case 'service_unavailable':
			dispatchFailure(
				i18n.translate(
					'A error occurred when we were trying to validate your site information. ' +
						'Please make sure your credentials and host URL are correct and try again. ' +
						'{{a}}Learn more{{/a}}',
					{
						components: {
							a: (
								<ExternalLink
									href="https://jetpack.com/support/backup/adding-credentials-to-jetpack/"
									onClick={ onLearnMoreClick }
								/>
							),
						},
					}
				)
			);
			break;

		case 'missing_args':
			dispatchFailure(
				i18n.translate( 'Something seems to be missing — please fill out all the required fields.' )
			);
			break;

		case 'invalid_args':
			dispatchFailure(
				i18n.translate(
					"The information you entered seems to be incorrect. Let's take " +
						'another look to ensure everything is in the right place.'
				)
			);
			break;

		case 'invalid_credentials':
			dispatchFailure(
				i18n.translate(
					"We couldn't connect to your site. Please verify that your credentials are correct and ensure that your host is not blocking the connection."
				)
			);
			break;

		case 'invalid_wordpress_path':
			dispatchFailure(
				i18n.translate(
					'We looked for `wp-config.php` in the WordPress installation ' +
						"path you provided but couldn't find it. " +
						'{{a}}Learn more{{/a}}',
					{
						components: {
							a: (
								<ExternalLink
									href="https://jetpack.com/support/backup/adding-credentials-to-jetpack/#troubleshoot-remote-server-credentials-errors"
									onClick={ onLearnMoreClick }
								/>
							),
						},
					}
				)
			);
			break;

		case 'read_only_install':
			dispatchFailure(
				i18n.translate(
					'It looks like your server is read-only. ' +
						'To create backups and restore your site, we need permission to write to your server. ' +
						'{{a}}Learn more{{/a}}',
					{
						components: {
							a: (
								<ExternalLink
									href="https://jetpack.com/support/backup/ssh-sftp-and-ftp-credentials/#file-access-permission"
									onClick={ onLearnMoreClick }
								/>
							),
						},
					}
				)
			);
			break;

		case 'unreachable_path':
			dispatchFailure(
				i18n.translate(
					'We tried to access your WordPress installation through its publicly available URL, ' +
						"but it didn't work. Please make sure the directory is accessible and try again."
				)
			);
			break;

		case 'helper_upload_failed':
			dispatchFailure(
				i18n.translate(
					'Error saving. ' +
						'Please ensure that the WordPress installation path has write permissions. ' +
						'{{a}}Learn more{{/a}}',
					{
						components: {
							a: (
								<ExternalLink
									href="https://jetpack.com/support/backup/ssh-sftp-and-ftp-credentials/#file-access-permission"
									onClick={ onLearnMoreClick }
								/>
							),
						},
					}
				)
			);
			break;
		default:
			dispatchFailure(
				i18n.translate( 'Error saving. Please check your credentials and try again.' )
			);
	}
};

export const streamRecord = ( action, record ) => ( {
	type: JETPACK_CREDENTIALS_UPDATE_PROGRESS_UPDATE,
	siteId: action.siteId,
	update: record,
} );

registerHandlers( 'state/data-layer/wpcom/activity-log/update-credentials/index.js', {
	[ JETPACK_CREDENTIALS_UPDATE ]: [
		dispatchRequest( {
			fetch: request,
			onSuccess: success,
			onError: failure,
			onStreamRecord: streamRecord,
		} ),
	],
} );