Try to stop server if site initialization failed

[fluiddot]

Related to #561 (comment) and https://github.com/Automattic/dotcom-forge/issues/9257.

Proposed Changes

• This PR doesn't fix 9257-gh-Automattic/dotcom-forge, but handles the case when there's an error during the site initialization and ensures the site can be started again. For instance, it addresses the following case:
  • Have a broken symlink inside the site's folder.
  • Start a site and get a failure.
  • Remove the broken symlink.
  • Start a site will work.

Testing Instructions

• Run the app with npm start.
• Create a site and stop it.
• Click on the Terminal button.
• Run the command ln -s unknown broken-symlink to create a broken symlink.
• Start the site.
• Observe an error message is displayed.
• Remove the symlink.
• Start the site again.
• Observe the site starts and works as expected.

Pre-merge Checklist

• Have you checked for TypeScript, React or other console errors?

[sejas]

Looks good. I confirm that adding a broken symlink it displays an error alert and do not start the site.
I left a comment about adding more context to the error message.

[sejas]

What do you think about including error.message to the alert?
I feel giving some tips to the user to fix the site will help the overall UX.

Something like:

[fluiddot]

Yeah, good point. This could be helpful when the user contacts support and we need to debug a failure.

[wojtekn]

Should we remove the underlying error, e.g., 'Error invoking remote method [...]'?

[fluiddot]

Not sure about removing it as it's part of the error message, it could be helpful when debugging issues in the future. What we could do is adding a title to that part conveying that's the raw error message, so users don't get confused about the content.

[fluiddot]

@sejas I'm going to merge this as-is and create a new GitHub issue as a follow-up to improve the error messaging.

UPDATE: Here's the issue: https://github.com/Automattic/dotcom-forge/issues/9309