Fix types and remove sendStopMessage

Author: fredrikekelund

cli/lib/types/wordpress-server-ipc.ts

@@ -1,10 +1,6 @@
 import { z } from 'zod';
 
 // Zod schemas for validating IPC messages from wordpress-server-manager
-const managerMessageBase = z.object( {
-	messageId: z.number(),
-} );
-
 const serverConfig = z.object( {
 	siteId: z.string(),
 	sitePath: z.string(),
@@ -21,30 +17,37 @@ const serverConfig = z.object( {
 
 export type ServerConfig = z.infer< typeof serverConfig >;
 
-const managerMessageStartServer = managerMessageBase.extend( {
+const managerMessageStartServer = z.object( {
 	topic: z.literal( 'start-server' ),
 	data: z.object( {
 		config: serverConfig,
 	} ),
 } );
 
-const managerMessageRunBlueprint = managerMessageBase.extend( {
+const managerMessageRunBlueprint = z.object( {
 	topic: z.literal( 'run-blueprint' ),
 	data: z.object( {
 		config: serverConfig,
 	} ),
 } );
 
-const managerMessageStopServer = managerMessageBase.extend( {
+const managerMessageStopServer = z.object( {
 	topic: z.literal( 'stop-server' ),
-	data: z.object( {} ),
 } );
 
-export const managerMessageSchema = z.discriminatedUnion( 'topic', [
+const _managerMessagePayloadSchema = z.discriminatedUnion( 'topic', [
 	managerMessageStartServer,
 	managerMessageRunBlueprint,
 	managerMessageStopServer,
 ] );
+export type ManagerMessagePayload = z.infer< typeof _managerMessagePayloadSchema >;
+
+const managerMessageBase = z.object( { messageId: z.number() } );
+export const managerMessageSchema = z.discriminatedUnion( 'topic', [
+	managerMessageBase.merge( managerMessageStartServer ),
+	managerMessageBase.merge( managerMessageRunBlueprint ),
+	managerMessageBase.merge( managerMessageStopServer ),
+] );
 export type ManagerMessage = z.infer< typeof managerMessageSchema >;
 
 // Zod schemas for validating IPC messages from wordpress-server-child

cli/lib/wordpress-server-manager.ts

@@ -23,6 +23,7 @@ import {
 	ServerConfig,
 	childMessagePm2Schema,
 	ManagerMessage,
+	ManagerMessagePayload,
 } from 'cli/lib/types/wordpress-server-ipc';
 
 function getProcessName( siteId: string ): string {
@@ -137,7 +138,8 @@ const messageActivityTrackers = new Map<
 
 async function sendMessage(
 	pmId: number,
-	message: Omit< ManagerMessage, 'messageId' >
+	message: ManagerMessagePayload,
+	maxTotalElapsedTime = PLAYGROUND_CLI_INACTIVITY_TIMEOUT
 ): Promise< unknown > {
 	const bus = await getPm2Bus();
 
@@ -162,12 +164,12 @@ async function sendMessage(
 
 			if (
 				timeSinceLastActivity > PLAYGROUND_CLI_INACTIVITY_TIMEOUT ||
-				totalElapsedTime > PLAYGROUND_CLI_MAX_TIMEOUT
+				totalElapsedTime > maxTotalElapsedTime
 			) {
 				cleanup();
 				const timeoutReason =
-					totalElapsedTime > PLAYGROUND_CLI_MAX_TIMEOUT
-						? `Maximum timeout of ${ PLAYGROUND_CLI_MAX_TIMEOUT / 1000 }s exceeded`
+					totalElapsedTime > maxTotalElapsedTime
+						? `Maximum timeout of ${ maxTotalElapsedTime / 1000 }s exceeded`
 						: `No activity for ${ PLAYGROUND_CLI_INACTIVITY_TIMEOUT / 1000 }s`;
 				reject(
 					new Error( `Timeout waiting for response to message ${ messageId }: ${ timeoutReason }` )
@@ -213,7 +215,7 @@ async function sendMessage(
 
 		bus.on( 'process:msg', responseHandler );
 
-		sendMessageToProcess( pmId, { ...message, messageId } as ManagerMessage ).catch( reject );
+		sendMessageToProcess( pmId, { ...message, messageId } ).catch( reject );
 	} );
 }
 
@@ -225,7 +227,7 @@ export async function stopWordPressServer( siteId: string ): Promise< void > {
 
 	if ( runningProcess ) {
 		try {
-			await sendStopMessage( runningProcess.pmId );
+			await sendMessage( runningProcess.pmId, { topic: 'stop-server' }, GRACEFUL_STOP_TIMEOUT );
 		} catch {
 			// Graceful shutdown failed, PM2 delete will handle it
 		}
@@ -234,63 +236,6 @@ export async function stopWordPressServer( siteId: string ): Promise< void > {
 	return stopProcess( processName );
 }
 
-/**
- * Send stop message to the child process with a timeout
- */
-async function sendStopMessage( pmId: number ): Promise< void > {
-	const bus = await getPm2Bus();
-
-	return new Promise( ( resolve, reject ) => {
-		const messageId = nextMessageId++;
-
-		const timeout = setTimeout( () => {
-			cleanup();
-			reject( new Error( 'Graceful stop timeout' ) );
-		}, GRACEFUL_STOP_TIMEOUT );
-
-		const cleanup = () => {
-			clearTimeout( timeout );
-			bus.off( 'process:msg', responseHandler );
-		};
-
-		const responseHandler = ( packet: unknown ) => {
-			const validationResult = childMessagePm2Schema.safeParse( packet );
-			if ( ! validationResult.success ) {
-				return;
-			}
-
-			const validPacket = validationResult.data;
-
-			if ( validPacket.process.pm_id !== pmId ) {
-				return;
-			}
-
-			if ( validPacket.raw.topic === 'error' && validPacket.raw.originalMessageId === messageId ) {
-				cleanup();
-				reject( new Error( validPacket.raw.errorMessage ) );
-			} else if (
-				validPacket.raw.topic === 'result' &&
-				validPacket.raw.originalMessageId === messageId
-			) {
-				cleanup();
-				resolve();
-			}
-		};
-
-		bus.on( 'process:msg', responseHandler );
-
-		const stopMessage = {
-			topic: 'stop-server' as const,
-			data: {},
-			messageId,
-		};
-		sendMessageToProcess( pmId, stopMessage ).catch( ( error ) => {
-			cleanup();
-			reject( error );
-		} );
-	} );
-}
-
 /**
  * Run a blueprint on a site without starting a server
  * 1. Start the PM2 process