Integrations ordering

[florian-lefebvre]

Body

Summary

Allow integrations to have more control over ordering.

Background & Motivation

The vercel integration copies static assets at the of the build. If some files are added after it, those assets will not be copied. This is problematic in more advanced scenarios where integrations are injected from another etc. Ideally, the vercel integration would inject an integration marked as post which would ensure it runs at the end.

Goals

• Allow an integration to insert itself at the next position, at the start or the end of all integrations

Example

We could follow vite's API by adding a new top level property to integrations:

return {
	name: "my-intergation",
	enforce: "pre", // "pre" | "post" | undefined 
	hooks: {}
}

Another option would be to call this option order to be consistent with addMiddleware.

Such a change should be backward compatible, Astro versions that do not support order will just add integrations as they come

[delucis]

I guess the other option might be a hook for adapters to use when all integrations have done creating assets?

Are there other use cases we've seen apart from this Vercel one?

[florian-lefebvre]

I'll note my case is also related to the sitemap integration, added by another integration

[Fryuni]

I just double checked Vite's docs and this seems unclear and I don't remember what the exact behavior is. But just to be clear, my point of distinction is that the bubbling of web events gets processed in the reverse order while, I think, Vite's enforce: 'post' runs at the end of the list but still in the order they were added which would still allow the same problem to happen.

If I got that wrong and enforce: 'post' goes in reverse order then the proposal is already what I'd consider ideal.

[Adammatthiesen]

This was something i fought with a lot when StudioCMS was still a bunch of smaller integrations all added from the primary package... its a huge reason we merged everything together, because vite would get pissy with us

[ascorbic]

One option would be to treat adapters as a special case, and any "post" that they run is always last. They know their platform better than anyone, so should be allowed the final say.

[Fryuni]

Processing the post cases in reverse order as we do for middlewares would already guarantee that since the adapter is always the first integration (it is prepended to the list and any other change later is appended).

[ematipico]

The introduction of more control doesn't solve the problem though, right? There's no guarantee that a specific integration runs last

[florian-lefebvre]

I think that means that most integrations should not specify the order, and only a few ones should. Eg. the vercel adapter should inject a post integration to make sure it runs last. But I get your point, I don't have much ideas about how to fix this

[ascorbic]

I don't think we should try to automatically handle ordering. There's no way for us to know what's needed. I think it needs to be either a param to request to run after, or a new hook that runs later. I generally prefer the param approach because it matches Vite plugins and our middleware, and seems less likely to suffer from integrations needlessly choosing the later hook.