feat: add server islands support for MDX

[apatel369]

Changes

reopening #12446 for main
Closes #12252

Server Islands are not rendering as islands in .mdx files because server islands metadata is not added for JSX components in MDX files.
Even after adding server islands metadata, the issue persists because transform function in vite-plugin-server-islands.ts file runs before server metadata is added in rehype.ts file.

I found that vite-plugin-server-islands.ts is added last in create-vite.ts and has enforce: 'post' but still transform function is running before the server meta data is added.

I am looking for feedback and guidance from Astro contributors on how to fix it.

Testing

TODO

Docs

Not needed

[changeset-bot]

⚠️ No Changeset found

Latest commit: 585dc3c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[codspeed-hq]

CodSpeed Performance Report

Merging #12574 will not alter performance

_{Comparing apatel369:arpan-#12252-mdx-islands (585dc3c) with main (5339f17)}

Summary

✅ 6 untouched benchmarks

[ematipico]

@apatel369 any updates?

[apatel369]

@ematipico I applied the changes suggested by @matthewp. Tests are still failing.

[ematipico]

@apatel369 the PR was in draft for a long time without any updates. What suggestions are you referring to? What kind of help do you need?