summaryrefslogtreecommitdiff
path: root/packages/integrations/netlify/src
diff options
context:
space:
mode:
authorGravatar Fred K. Schott <fkschott@gmail.com> 2022-04-10 14:34:49 -0700
committerGravatar GitHub <noreply@github.com> 2022-04-10 14:34:49 -0700
commitfbc32cf65566b50a85e78239826fbce2bb4a964f (patch)
treef06c399b32dec51e215efef500a32e0db667bfb8 /packages/integrations/netlify/src
parentd63dcd505a27c63b872a7bace0f530481b635457 (diff)
downloadastro-fbc32cf65566b50a85e78239826fbce2bb4a964f.tar.gz
astro-fbc32cf65566b50a85e78239826fbce2bb4a964f.tar.zst
astro-fbc32cf65566b50a85e78239826fbce2bb4a964f.zip
remove site requirement from netlify adapter (#3041)
* remove site requirement from netlify adapter * update readme
Diffstat (limited to 'packages/integrations/netlify/src')
-rw-r--r--packages/integrations/netlify/src/README.md46
-rw-r--r--packages/integrations/netlify/src/index.ts14
-rw-r--r--packages/integrations/netlify/src/netlify-functions.ts26
3 files changed, 64 insertions, 22 deletions
diff --git a/packages/integrations/netlify/src/README.md b/packages/integrations/netlify/src/README.md
new file mode 100644
index 000000000..1a77ed598
--- /dev/null
+++ b/packages/integrations/netlify/src/README.md
@@ -0,0 +1,46 @@
+# @astrojs/netlify
+
+Deploy your server-side rendered (SSR) Astro app to [Netlify](https://www.netlify.com/).
+
+Use this adapter in your Astro configuration file, alongside a valid deployment URL:
+
+```js
+import { defineConfig } from 'astro/config';
+import netlify from '@astrojs/netlify/functions';
+
+export default defineConfig({
+ adapter: netlify(),
+});
+```
+
+After you build your site the `netlify/` folder will contain [Netlify Functions](https://docs.netlify.com/functions/overview/) in the `netlify/functions/` folder.
+
+Now you can deploy!
+
+```shell
+netlify deploy
+```
+
+## Configuration
+
+### dist
+
+We build to a `netlify` directory at the base of your project. To change this, use the `dist` option:
+
+```js
+import { defineConfig } from 'astro/config';
+import netlify from '@astrojs/netlify/functions';
+
+export default defineConfig({
+ adapter: netlify({
+ dist: new URL('./dist/', import.meta.url)
+ })
+});
+```
+
+And then point to the dist in your `netlify.toml`:
+
+```toml
+[functions]
+ directory = "dist/functions"
+```
diff --git a/packages/integrations/netlify/src/index.ts b/packages/integrations/netlify/src/index.ts
index 67a036335..9a428e260 100644
--- a/packages/integrations/netlify/src/index.ts
+++ b/packages/integrations/netlify/src/index.ts
@@ -1,12 +1,12 @@
import type { AstroAdapter, AstroIntegration, AstroConfig } from 'astro';
import fs from 'fs';
-export function getAdapter(site: string | undefined): AstroAdapter {
+export function getAdapter(): AstroAdapter {
return {
name: '@astrojs/netlify',
serverEntrypoint: '@astrojs/netlify/netlify-functions.js',
exports: ['handler'],
- args: { site },
+ args: { },
};
}
@@ -28,15 +28,7 @@ function netlifyFunctions({ dist }: NetlifyFunctionsOptions = {}): AstroIntegrat
}
},
'astro:config:done': ({ config, setAdapter }) => {
- let site = null;
- try {
- site = new URL(config.base, config.site);
- } catch {
- throw new Error(
- 'The Netlify adapter requires a deployment URL. Ensure a "site" is specified in your astro.config. If you provided a "base" in your astro.config, ensure it is a valid path.'
- );
- }
- setAdapter(getAdapter(site.toString()));
+ setAdapter(getAdapter());
_config = config;
},
'astro:build:start': async ({ buildConfig }) => {
diff --git a/packages/integrations/netlify/src/netlify-functions.ts b/packages/integrations/netlify/src/netlify-functions.ts
index cb95f1f3f..474cac4b6 100644
--- a/packages/integrations/netlify/src/netlify-functions.ts
+++ b/packages/integrations/netlify/src/netlify-functions.ts
@@ -7,20 +7,24 @@ polyfill(globalThis, {
exclude: 'window document',
});
-interface Args {
- site?: string;
-}
+interface Args {}
export const createExports = (manifest: SSRManifest, args: Args) => {
const app = new App(manifest);
- const site = new URL(args.site ?? `https://netlify.com`);
const handler: Handler = async (event) => {
- const headers = new Headers(event.headers as any);
- const request = new Request(new URL(event.path, site).toString(), {
- method: event.httpMethod,
- headers,
- });
+ const { httpMethod, headers, rawUrl, body: requestBody, isBase64Encoded } = event;
+ const init: RequestInit = {
+ method: httpMethod,
+ headers: new Headers(headers as any),
+ };
+ // Attach the event body the the request, with proper encoding.
+ if (httpMethod !== 'GET' && httpMethod !== 'HEAD') {
+ const encoding = isBase64Encoded ? 'base64' : 'utf-8';
+ init.body =
+ typeof requestBody === 'string' ? Buffer.from(requestBody, encoding) : requestBody;
+ }
+ const request = new Request(rawUrl, init);
if (!app.match(request)) {
return {
@@ -30,12 +34,12 @@ export const createExports = (manifest: SSRManifest, args: Args) => {
}
const response = await app.render(request);
- const body = await response.text();
+ const responseBody = await response.text();
return {
statusCode: 200,
headers: Object.fromEntries(response.headers.entries()),
- body,
+ body: responseBody,
};
};