Handling Routing in Functions
How to handle custom routing within Edge Functions.
Usually, an Edge Function is written to perform a single action (eg: write a record to the database). However, if your app's logic is split into multiple Edge Functions requests to each action may seem slower. This is because each Edge Function needs to be booted before serving a request (known as cold starts). If an action is performed less frequently (eg: deleting a record), there is a high-chance of that function experiencing a cold-start.
One way to reduce the cold starts and increase performance of your app is to combine multiple actions into a single Edge Function. This way only one instance of the Edge Function needs to be booted and it can handle multiple requests to different actions. For example, we can use a single Edge Function to create a typical CRUD API (create, read, update, delete records).
To combine multiple endpoints into a single Edge Function, you can use web application frameworks such as Express or Oak.
Let's dive into some examples.
Routing with Express
Here's a simple hello world example using popular web framework Express.
Create a new function called hello-world using Supabase CLI:
_10supabase functions new hello-world
Copy and paste the following code:
_18import express from 'npm:[email protected]'_18_18const app = express()_18app.use(express.json())_18const port = 3000_18_18app.get('/hello-world', (req, res) => {_18 res.send('Hello World!')_18})_18_18app.post('/hello-world', (req, res) => {_18 const { name } = req.body_18 res.send(`Hello ${name}!`)_18})_18_18app.listen(port, () => {_18 console.log(`Example app listening on port ${port}`)_18})
You will notice in the above example, we created two routes - GET and POST. The path for both routes are defined as /hello-world.
If you run an Express server outside of Edge Functions, you'd usually set the root path as / .
However, within Edge Functions, paths should always be prefixed with the function name (in this case hello-world).
You can deploy the function to Supabase via:
_10supabase functions deploy hello-world
Once the function is deployed, you can try to call the two endpoints using cURL (or Postman).
_10# https://supabase.com/docs/guides/functions/deploy#invoking-remote-functions_10curl --request GET 'https://<project_ref>.supabase.co/functions/v1/hello-world' \_10 --header 'Authorization: Bearer ANON_KEY' \
This should print the response as Hello World!, meaning it was handled by the GET route.
Similarly, we can make a request to the POST route.
We should see a response printing Hello Foo!.
Using Route Parameters
We can use route parameters to capture values at specific URL segments (eg: /tasks/:taskId/notes/:noteId).
Here's an example Edge Function implemented using Express for managing tasks using route parameters.
Keep in mind paths must be prefixed by function name (ie. tasks in this example). Route parameters can only be used after the function name prefix.
_29import express from 'npm:[email protected]'_29_29const app = express()_29app.use(express.json())_29_29app.get('/tasks', async (req, res) => {_29 // return all tasks_29})_29_29app.post('/tasks', async (req, res) => {_29 // create a task_29})_29_29app.get('/tasks/:id', async (req, res) => {_29 const id = req.params.id_29 const task = {} // get task_29_29 res.json(task)_29})_29_29app.patch('/tasks/:id', async (req, res) => {_29 const id = req.params.id_29 // modify task_29})_29_29app.delete('/tasks/:id', async (req, res) => {_29 const id = req.params.id_29 // delete task_29})
URL Patterns API
If you prefer not to use a web framework, you can directly use URLPattern API within your Edge Functions to implement routing. This is ideal for small apps with only couple of routes and you want to have a custom matching algorithm.
Here is an example Edge Function using URL Patterns API: https://github.com/supabase/supabase/blob/master/examples/edge-functions/supabase/functions/restful-tasks/index.ts