Site Migration: Transfer with software API, update hooks (Automattic#102248)

* Update query hook types and tests

* Remove unused response params

* use correct response type

* Make siteId and transferId nullable; update success => completed

* Account for potentially null values

Author: sixhours

client/sites/hooks/test/use-transfer-with-software-start-mutation.tsx

@@ -67,9 +67,6 @@ describe( 'useRequestTransferWithSoftware', () => {
 				atomic_transfer_id: 456,
 				blog_id: SITE_ID,
 				atomic_transfer_status: 'pending',
-				plugins: { 'plugin-1': 'install' },
-				themes: { 'theme-1': 'activate' },
-				transfer_with_software_status: 'pending',
 			} );
 
 		const { result } = render();
@@ -83,9 +80,6 @@ describe( 'useRequestTransferWithSoftware', () => {
 					atomic_transfer_id: 456,
 					blog_id: SITE_ID,
 					atomic_transfer_status: 'pending',
-					plugins: { 'plugin-1': 'install' },
-					themes: { 'theme-1': 'activate' },
-					transfer_with_software_status: 'pending',
 				} );
 			},
 			{ timeout: 3000 }

client/sites/hooks/test/use-transfer-with-software-status-query.tsx

@@ -16,10 +16,7 @@ jest.mock( '@automattic/calypso-config', () => ( {
 const mockSuccessResponse = {
 	blog_id: 123,
 	atomic_transfer_id: 456,
-	transfer_with_software_status: 'pending',
-	atomic_transfer_status: 'success',
-	plugins: { 'wpcom-migration': true },
-	themes: { 'twenty-twenty-four': false },
+	atomic_transfer_status: 'completed',
 };
 
 describe( 'useTransferWithSoftwareStatus', () => {
@@ -44,8 +41,7 @@ describe( 'useTransferWithSoftwareStatus', () => {
 		await waitFor( () => {
 			expect( result.current.isSuccess ).toBe( true );
 			expect( result.current.data ).toEqual( {
-				transfer_with_software_status: 'pending',
-				atomic_transfer_status: 'success',
+				atomic_transfer_status: 'completed',
 			} );
 		} );
 	} );
@@ -71,22 +67,4 @@ describe( 'useTransferWithSoftwareStatus', () => {
 		expect( result.current.isFetching ).toBe( false );
 		expect( nock.isDone() ).toBe( true ); // No pending nock requests
 	} );
-
-	it( 'should ignore extra fields in the response', async () => {
-		const queryClient = new QueryClient();
-		const wrapper = ( { children }: { children: React.ReactNode } ) => (
-			<QueryClientProvider client={ queryClient }>{ children }</QueryClientProvider>
-		);
-		nock( 'https://public-api.wordpress.com' )
-			.get( '/wpcom/v2/sites/123/atomic/transfer-with-software/456' )
-			.query( { http_envelope: 1 } )
-			.reply( 200, mockSuccessResponse );
-
-		const { result } = renderHook( () => useTransferWithSoftwareStatus( 123, 456 ), { wrapper } );
-
-		await waitFor( () => {
-			expect( result.current.isSuccess ).toBe( true );
-			expect( result.current.data ).not.toContain( { extra_field: 'extra_value' } );
-		} );
-	} );
 } );

client/sites/hooks/use-transfer-with-software-start-mutation.ts

@@ -5,9 +5,6 @@ type TransferWithSoftwareResponse = {
 	blog_id: number;
 	atomic_transfer_id: number;
 	atomic_transfer_status: string;
-	plugins: Record< string, string >;
-	themes: Record< string, string >;
-	transfer_with_software_status: string;
 };
 
 type SoftwareSlug = string;

client/sites/hooks/use-transfer-with-software-status-query.ts

@@ -4,16 +4,20 @@ import wpcom from 'calypso/lib/wp';
 type TransferWithSoftwareStatusResponse = {
 	blog_id: number;
 	atomic_transfer_id: number;
-	plugins: { [ key: string ]: boolean };
-	themes: { [ key: string ]: boolean };
-	transfer_with_software_status: string;
 	atomic_transfer_status: string;
 };
 
-const getTransferWithSoftwareStatus = async (
-	siteId: number,
-	atomicTransferId: number
-): Promise< TransferWithSoftwareStatusResponse > => {
+const getTransferWithSoftwareStatus: (
+	siteId?: number,
+	atomicTransferId?: number
+) => Promise< TransferWithSoftwareStatusResponse > = async ( siteId, atomicTransferId ) => {
+	if ( ! siteId || ! atomicTransferId ) {
+		return {
+			blog_id: 0,
+			atomic_transfer_id: 0,
+			atomic_transfer_status: 'pending',
+		};
+	}
 	return wpcom.req.get(
 		`/sites/${ siteId }/atomic/transfer-with-software/${ atomicTransferId }?http_envelope=1`,
 		{
@@ -23,8 +27,8 @@ const getTransferWithSoftwareStatus = async (
 };
 
 export const useTransferWithSoftwareStatus = (
-	siteId: number,
-	atomicTransferId: number,
+	siteId?: number,
+	atomicTransferId?: number,
 	options?: {
 		retry?: UseQueryOptions[ 'retry' ];
 	}
@@ -33,7 +37,6 @@ export const useTransferWithSoftwareStatus = (
 		queryKey: [ 'software-transfer-status', siteId, atomicTransferId ],
 		queryFn: () => getTransferWithSoftwareStatus( siteId, atomicTransferId ),
 		select: ( data: TransferWithSoftwareStatusResponse ) => ( {
-			transfer_with_software_status: data.transfer_with_software_status,
 			atomic_transfer_status: data.atomic_transfer_status,
 		} ),
 		refetchOnWindowFocus: false,