Edge Functions

Testing your Edge Functions

Writing Unit Tests for Edge Functions using Deno Test

Testing is an essential step in the development process to ensure the correctness and performance of your Edge Functions.

Testing in Deno

Deno has a built-in test runner that you can use for testing JavaScript or TypeScript code. You can read the official documentation for more information and details about the available testing functions.

Folder structure

We recommend creating your testing in a supabase/functions/tests directory, using the same name as the Function followed by -test.ts:


_10
└── supabase
_10
├── functions
_10
│ ├── function-one
_10
│ │ └── index.ts
_10
│ └── function-two
_10
│ │ └── index.ts
_10
│ └── tests
_10
│ └── function-one-test.ts # Tests for function-one
_10
│ └── function-two-test.ts # Tests for function-two
_10
└── config.toml

Example script

The following script is a good example to get started with testing your Edge Functions:

function-one-test.ts

_58
// Import required libraries and modules
_58
import { assert, assertEquals } from 'https://deno.land/[email protected]/testing/asserts.ts'
_58
import { createClient, SupabaseClient } from 'https://esm.sh/@supabase/[email protected]'
_58
_58
// Set up the configuration for the Supabase client
_58
const supabaseUrl = Deno.env.get('SUPABASE_URL') ?? ''
_58
const supabaseKey = Deno.env.get('SUPABASE_ANON_KEY') ?? ''
_58
const options = {
_58
auth: {
_58
autoRefreshToken: false,
_58
persistSession: false,
_58
detectSessionInUrl: false,
_58
},
_58
}
_58
_58
// Test the creation and functionality of the Supabase client
_58
const testClientCreation = async () => {
_58
var client: SupabaseClient = createClient(supabaseUrl, supabaseKey, options)
_58
_58
// Verify if the Supabase URL and key are provided
_58
if (!supabaseUrl) throw new Error('supabaseUrl is required.')
_58
if (!supabaseKey) throw new Error('supabaseKey is required.')
_58
_58
// Test a simple query to the database
_58
const { data: table_data, error: table_error } = await client
_58
.from('my_table')
_58
.select('*')
_58
.limit(1)
_58
if (table_error) {
_58
throw new Error('Invalid Supabase client: ' + table_error.message)
_58
}
_58
assert(table_data, 'Data should be returned from the query.')
_58
}
_58
_58
// Test the 'hello-world' function
_58
const testHelloWorld = async () => {
_58
var client: SupabaseClient = createClient(supabaseUrl, supabaseKey, options)
_58
_58
// Invoke the 'hello-world' function with a parameter
_58
const { data: func_data, error: func_error } = await client.functions.invoke('hello-world', {
_58
body: { name: 'bar' },
_58
})
_58
_58
// Check for errors from the function invocation
_58
if (func_error) {
_58
throw new Error('Invalid response: ' + func_error.message)
_58
}
_58
_58
// Log the response from the function
_58
console.log(JSON.stringify(func_data, null, 2))
_58
_58
// Assert that the function returned the expected result
_58
assertEquals(func_data.message, 'Hello bar!')
_58
}
_58
_58
// Register and run the tests
_58
Deno.test('Client Creation Test', testClientCreation)
_58
Deno.test('Hello-world Function Test', testHelloWorld)

This test case consists of two parts. The first part tests the client library and verifies that the database can be connected to and returns values from a table (my_table). The second part tests the edge function and checks if the received value matches the expected value. Here's a brief overview of the code:

  • We import various testing functions from the Deno standard library, including assert, assertExists, and assertEquals.
  • We import the createClient and SupabaseClient classes from the @supabase/supabase-js library to interact with the Supabase client.
  • We define the necessary configuration for the Supabase client, including the Supabase URL, API key, and authentication options.
  • The testClientCreation function tests the creation of a Supabase client instance and queries the database for data from a table. It verifies that data is returned from the query.
  • The testHelloWorld function tests the "Hello-world" Edge Function by invoking it using the Supabase client's functions.invoke method. It checks if the response message matches the expected greeting.
  • We run the tests using the Deno.test function, providing a descriptive name for each test case and the corresponding test function.

Running Edge Functions locally

To locally test and debug Edge Functions, you can utilize the Supabase CLI. Let's explore how to run Edge Functions locally using the Supabase CLI:

  1. Ensure that the Supabase server is running by executing the following command:


    _10
    supabase start

  2. In your terminal, use the following command to serve the Edge Functions locally:


    _10
    supabase functions serve

    This command starts a local server that runs your Edge Functions, enabling you to test and debug them in a development environment.

  3. Create the environment variables file:


    _10
    # creates the file
    _10
    touch .env.local
    _10
    # adds the SUPABASE_URL secret
    _10
    echo "SUPABASE_URL=http://localhost:54321" >> .env.local
    _10
    # adds the SUPABASE_ANON_KEY secret
    _10
    echo "SUPABASE_ANON_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24iLCJleHAiOjE5ODM4MTI5OTZ9.CRXP1A7WOeoJeXxjNni43kdQwgnWNReilDMblYTn_I0" >> .env.local
    _10
    # Alternatively, you can open it in your editor:
    _10
    open .env.local

  4. To run the tests, use the following command in your terminal:


    _10
    deno test --allow-all supabase/functions/tests/function-one-test.ts --env=.env.local

Resources