feat(@astrojs/netlify): Add on-demand builders Netlify functions

[juanmiguelguerrero]

Changes

• A new configuration option is added to the Netlify adapter to enable On-Demand Builder feature.

Testing

• I don't know how to add a test with chai.
• In any case, by adding this configuration, it is possible to test the functionality:

import { defineConfig } from 'astro/config';
import netlify from '@astrojs/netlify/functions';

export default defineConfig({
  output: 'server',
  adapter: netlify({
    builders: true
  }),
});

Docs

• A new heading "On-Demand Builders" must be added to the "Configuration" section, including the above example and a link to the official documentation (https://docs.netlify.com/configure-builds/on-demand-builders/)

/cc @withastro/maintainers-docs for feedback!

[changeset-bot]

🦋 Changeset detected

Latest commit: 39d5035

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

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

[matthewp]

Very nice! Can you add a changeset? pnpm changeset, this would be a minor change since it's a new feature.

[juanmiguelguerrero]

@matthewp There is a CI failure on macOS. It's related to a timeout in an Astro CLI test . I think this should not be impacted by this pull request. Thanks.

[matthewp]

@juanmiguelguerrero Yeah thanks, I believe that's a flaky test. I'll rerun.

[juanmiguelguerrero]

I found an error in the example code.

This is the correct code:

import { defineConfig } from 'astro/config';
import netlify from '@astrojs/netlify/functions';

export default defineConfig({
  output: 'server',
  adapter: netlify({
    builders: true
  }),
});

Note: I have edited the previous comment.

[sarah11918]

@juanmiguelguerrero Here is the file that needs to be edited to add something to the docs configuration-reference page: https://github.com/withastro/astro/blob/main/packages/astro/src/%40types/astro.ts

Can you please document the necessary changes there, following the style of the other items at https://docs.astro.build/en/reference/configuration-reference/ ? Let me know if you need/want assistance with this.

Then the docs team will review them!

[juanmiguelguerrero]

@sarah11918 I think there is nothing to change in that file.

This code changes do not affect the general Astro configuration. They only affect the Netlify adapter configuration.

The doc to update is this one: https://docs.astro.build/en/guides/integrations-guide/netlify/

https://github.com/withastro/docs/blob/099aba24730af21f81770302c0a6796163b11c4c/src/pages/en/guides/integrations-guide/netlify.mdx

In my opinion, the place to insert this change is inside the "Configuration" section, between the "dist" and "binaryMediaTypes" options.

The text we should include would be something like this:

builders

On-demand Builders are serverless functions used to generate web content as needed that’s automatically cached on Netlify’s Edge CDN. To activate rendering with this type of functions, use the builders option:

import { defineConfig } from 'astro/config';
import netlify from '@astrojs/netlify/functions';

export default defineConfig({
  output: 'server',
  adapter: netlify({
    builders: true
  }),
});

This functionality is only available whith the @astrojs/netlify/functions adapter and is not compatible with Edge Functions.

For more information about Netlify On-demand Builders visit the Netlify documentation.

[sarah11918]

@juanmiguelguerrero Gotcha! In that case, you'll want to edit this page: https://github.com/withastro/astro/blob/main/packages/integrations/netlify/README.md

This content is pulled into the Docs site from this README. Would you mind opening a PR with proposed changes there? Docs will get notification of that PR automatically, and that's where we can finalize the wording together. Thanks!

[juanmiguelguerrero]

@sarah11918 I have just updated the documentation.

[juanmiguelguerrero]

@matthewp Jhon, can you resolve these conflicts?

@sarah11918 Have you seen the changes I made to the README? Are they correct?

Can I help? Thanks... 🚀

[sarah11918]

Thanks for the ping to let me know this was updated! Here are my suggestions for documentation text, if they don't lose your original intention!

[juanmiguelguerrero]

@matthewp I have already reviewed the pending conflicts.

[matthewp]

Thanks @juanmiguelguerrero! This is looking great.

@sarah11918 just need your approval if there's nothing else.

[sarah11918]

Docs is happy! Thanks @juanmiguelguerrero 🙌

[betabong]

Netlify on-demand builders allow setting a Time to Live duration – this can be very useful for content like e-commerce or larger CMS setups. Ideally this could be configured per route (Astro.response). I was hoping that setting a header could accomplish it, but it seems like Netlify expects to have this set in the response. So may be "builders" could become a more complex option?

a. builder: true
b. builder: 3600
c. builder: (event, context) => event.path.startsWith("/archive") ? false : 60

[juanmiguelguerrero]

@betabong It is an interesting functionality and is not difficult to implement.

My only doubt is how would be the best configuration option?

I think the simplest is something like this:

import { defineConfig } from 'astro/config';
import netlify from '@astrojs/netlify/functions';

export default defineConfig({
  output: 'server',
  adapter: netlify({
    builders: true,
    ttl: 3600
  }),
});

Anyway I would like to know before the opinion of @matthewp

[betabong]

Hey @juanmiguelguerrero I have made a pull request here #6219

Please have a look, thanks 🙏