https://github.com/mlafeldt/netlify-edge-bootstrap

Learn how Netlify Edge Functions work under the hood
https://github.com/mlafeldt/netlify-edge-bootstrap

deno edge-functions netlify playground

Last synced: 3 months ago
JSON representation

Learn how Netlify Edge Functions work under the hood

• Host: GitHub
• URL: https://github.com/mlafeldt/netlify-edge-bootstrap
• Owner: mlafeldt
• Created: 2022-05-11T10:57:50.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-27T00:05:01.000Z (6 months ago)
• Last Synced: 2024-08-28T02:27:54.661Z (6 months ago)
• Topics: deno, edge-functions, netlify, playground
• Language: TypeScript
• Homepage:
• Size: 1.17 MB
• Stars: 6
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# netlify-edge-bootstrap

This repo contains the "closed-source" [bootstrap code](src/bootstrap) used to initialize the environment of Netlify Edge Functions as well as the [bundler code](src/bundler) used for deploying them to Deno Deploy.

While the [Edge Functions API](https://docs.netlify.com/netlify-labs/experimental-features/edge-functions/api/) is decently documented, I was still curious how Netlify actually integrates [Deno](https://deno.land/) as a JavaScript/TypeScript runtime behind the scenes. To that end, I extracted the code and created a [playground](playground) that can run functions locally (similar to `netlify dev`).

I gathered all information contained here by reading the source code of Netlify's [CLI](https://github.com/netlify/cli/tree/main/src/lib/edge-functions) & [Edge Bundler](https://github.com/netlify/edge-bundler) and tinkering with `deno vendor`.

## Usage

(Make sure to [install Deno](https://deno.land/manual/getting_started/installation) version 1.22 or higher first.)

Download current bootstrap code to `src` folder:

```console

make bootstrap

```

Start playground webserver:

```console

make playground

```

Send requests to playground:

```console

❯ curl -H 'x-nf-edge-functions: hello' -H 'x-nf-request-id: 1234' http://localhost:8000

Hello world

❯ curl -H 'x-nf-edge-functions: up,hello' -H 'x-nf-request-id: 1234' http://localhost:8000

HELLO WORLD

❯ curl -H 'x-nf-edge-functions: up,skip,hello' -H 'x-nf-request-id: 1234' http://localhost:8000

HELLO WORLD

```

`x-nf-edge-functions` must contain a list of functions to be run in the given order. Function handlers are defined [here](playground/netlify/edge-functions).

Bundle functions like Netlify does before deploying to Deno Deploy:

```console

make bundle

```