feat(cli): Setup command and codemod for OG image middleware

[Josh-Walker-GM]

This PR introduces a setup command for the OG image generation middleware.

---

It did involve moving around some of the codemod utilities we have. Either because we needed to include them where we previously didn't or because they no longer made sense in the directory they were in.

[Josh-Walker-GM]

@cannikin Two points to add when you go to look at this:

1. I noticed that the OG image middleware package doesn't actually export the things being imported here. I think this is currently being introduced in feat(og-gen): Implement middleware and hooks  #10469. We should ensure that whatever the exports end up looking like that the imports are consistent with them.
2. I see that this feature is still "experimental"? Currently, this PR puts the setup command in the stable cli section. If you want to move it then I'm fine with that. My only concern is that we keep the experimental CLI flat so we would be undoing the middleware directory and just have it be a single command within the experimental directory. If that makes any sense?

[Josh-Walker-GM]

I also noticed the codemod tests don't cover the case where the middleware is already setup. After thinking about it for a moment, I don't want to consider this case. The reward from doing so given the complexity required to determine if that is the case is too low in my opinion.

[cannikin]

I'm okay with it being yarn rw setup middleware ogimage as I think we'll have other ones that use this going forward, maybe even before SSR is ready in a regular Redwood release.

Even though SSR support is experimental, the ogimage stuff should be stable and ready to go. Maybe there's a check that if you run that command, but SSR hasn't already been enabled, it errors and lists the command to run to install it? yarn rw setup experimental setup-streaming-ssr

[cannikin]

I also noticed the codemod tests don't cover the case where the middleware is already setup. After thinking about it for a moment, I don't want to consider this case. The reward from doing so given the complexity required to determine if that is the case is too low in my opinion.

That's fine, as long as it just stops and doesn't end up mangling the file because it couldn't figure out what to do? Can it just error out, say something about the file contents are unexpected, and give a sample output of the import and what registerMiddleware() needs to include to get it to work? Then the user can edit themselves.

[dac09]

Nice one @Josh-Walker-GM - I think missing step is updating Vite.config.js to include the plugin too! :)

[cannikin]

Looking good! Can we add post-setup instructions:

og:image generation is almost ready to go! You'll need to add 
playwright as a dependency to the api side and then install the 
headless browser packages:

  yarn workspace api add playwright
  cd api
  yarn playwright install

Depending on how your host is configured you may need to 
install additional dependencies first. If so, the `playwright install` 
step will error out and give you the command to run to install 
those deps.

[cannikin]

I forgot to test this, but should this script (or maybe it does already?) error out if you try to setup og-image but haven't already setup-experimental-ssr? Like you won't have entry.server.js if you haven't setup SSR yet. It probably already errors, but does the error message tell you how to resolve?

[Josh-Walker-GM]

I forgot to test this, but should this script (or maybe it does already?) error out if you try to setup og-image but haven't already setup-experimental-ssr? Like you won't have entry.server.js if you haven't setup SSR yet. It probably already errors, but does the error message tell you how to resolve?

Yeah the first task in the command handler checks that you have setup streaming ssr.

redwood/packages/cli/src/commands/setup/middleware/ogImage/ogImageHandler.ts

Lines 21 to 29 in 700341b

	title: 'Check prerequisites',
	skip: force,
	task: () => {
	if (!getConfig().experimental?.streamingSsr?.enabled) {
	throw new Error(
	'The Streaming SSR experimental feature must be enabled before you can setup middleware',
	)
	}
	},