File size: 3,632 Bytes
1e92f2d | 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 | import config from '@automattic/calypso-config';
import { UseMutationResult } from '@tanstack/react-query';
import { useEffect } from 'react';
import { logToLogstash } from 'calypso/lib/logstash';
import { useRequestTransferWithSoftware } from 'calypso/sites/hooks/use-transfer-with-software-start-mutation';
import { useTransferWithSoftwareStatus } from 'calypso/sites/hooks/use-transfer-with-software-status-query';
import { useSiteMigrationKey } from './use-site-migration-key';
import type { TransferWithSoftwareResponse } from 'calypso/sites/hooks/use-transfer-with-software-start-mutation';
type Status = 'idle' | 'pending' | 'success' | 'error';
const safeLogToLogstash = ( message: string, properties: Record< string, unknown > ) => {
try {
logToLogstash( {
feature: 'calypso_client',
message,
properties: {
env: config( 'env_id' ),
type: 'calypso_prepare_site_for_migration',
...properties,
},
} );
} catch ( e ) {
// eslint-disable-next-line no-console
console.error( e );
}
};
const useLogMigration = (
completed: boolean,
siteTransferStatus: Status,
error?: Error | null,
siteId?: number
) => {
useEffect( () => {
if ( siteTransferStatus === 'pending' ) {
return safeLogToLogstash( 'Site migration preparation started', {
status: 'started',
site_id: siteId,
} );
}
}, [ siteTransferStatus, siteId ] );
useEffect( () => {
if ( error ) {
return safeLogToLogstash( 'Site migration preparation failed', {
status: 'error',
error: error.message,
error_type: error.name,
site_id: siteId,
} );
}
}, [ error, siteId ] );
useEffect( () => {
if ( completed ) {
return safeLogToLogstash( 'Site migration preparation completed', {
status: 'success',
site_id: siteId,
} );
}
}, [ completed, siteId ] );
};
type Options = {
retry?: number;
};
/**
* Hook to manage the site to prepare a site for migration.
* This hook manages the site transfer, plugin installation and migration key fetching.
*/
export const usePrepareSiteForMigration = (
siteId: number,
from?: string,
options: Options = {}
) => {
// Request the transfer with software
const transferMutation: UseMutationResult< TransferWithSoftwareResponse, Error, void > =
useRequestTransferWithSoftware( {
siteId,
apiSettings: {
migration_source_site_domain: from,
},
plugin_slug: 'wpcom-migration',
} );
// Trigger the mutation when the hook is first used
useEffect( () => {
if ( siteId && from ) {
transferMutation.mutate();
}
}, [ siteId, from ] ); // Dependencies that should trigger a new transfer
const {
data: { transfer_status } = {},
error: softwareTransferError,
status: softwareTransferStatus,
} = useTransferWithSoftwareStatus( siteId, transferMutation.data?.transfer_id ?? undefined, {
retry: options.retry ?? 0,
} );
const softwareTransferCompleted = 'completed' === transfer_status;
const {
data: { migrationKey } = {},
error: migrationKeyError,
status: migrationKeyStatus,
} = useSiteMigrationKey( siteId, {
enabled: Boolean( softwareTransferCompleted ),
retry: options.retry ?? 0,
} );
const error = softwareTransferError || migrationKeyError;
const criticalError = softwareTransferError;
const detailedStatus = {
siteTransferStatus: transfer_status ?? 'idle',
migrationKeyStatus: ! softwareTransferCompleted ? 'idle' : migrationKeyStatus,
};
useLogMigration(
softwareTransferCompleted,
softwareTransferStatus as Status,
criticalError,
siteId
);
return {
detailedStatus,
softwareTransferCompleted,
error,
migrationKey: migrationKey ?? null,
};
};
|