feat: add custom sms hook

[J0]

What kind of change does this PR introduce?

Allows devs to use a Custom SMS Provider via a HTTP Hook. SQL Hooks are not supported at this time as it requires significantly more effort to invoke a Hook via pg_net and handle errors as compared to using HTTP/HTTPS.

HTTP Hook invocation is done via the standardwebhooks library for symmetric hooks. Asymmetric hooks are being finalized by the committee and support will be added shortly.

The following changes are being made from the internal RFC:

• Hooks have a timeout of 5 seconds instead of 15 seconds so as not to run for too long
• Hooks have a size limit of 20kb. This is not stated in internal RFC but is part of the recommendations under the standard webhooks RFC.
• We allow hooks using the http protocol . This is to support local development. Restriction to https can be done on the dashboard page for connecting a hook.
• Add log statements where relevant and write proper error messages
• Add more Gock tests

[J0]

I've realized I'd need an endpoint to run any sort of load against in order for there to be a meaningful metric. I've considered the following options:

1. Add command to Makefile and script / yaml file for testing.

• Run benchmarks on an as needed basis, not in CI
• Doesn't have to live in CI, minimal overhead

2. Use testcontainers to spin up a docker container with an edge function container that can be hit

• Introduces a new dependency

3. Use a live Supabase project to test

• Couples the concept of Supabase with Auth / GoTrue
• Need to regularly swap out the URL and/or ensure project is not paused.

4. Port load tests to benchmarks repo

Let me know if there are any preferences

As an aside, I've realized I will likely need to allow for http with host.docker.internal as well, likely in the morrow.

[J0]

Test script for future reference (simulate periodic requests)

1. Create an export generate-phone.js

module.exports = {
  generatePhoneNumber: (context, events, done) => {
    const phonePrefix = "+1"; // Assuming US phone numbers for example
    const randomNumber = Math.floor(Math.random() * 9000000000) + 1000000000; // Generates a 10 digit number
    const phone = phonePrefix + randomNumber.toString();
    context.vars.phone = phone; // Set the generated phone number in the context
    return done();
  }
};

2. Create a phone-test.yml file:

config:
  target: 'http://localhost:9999'
  phases:
    - duration: 60 # Test duration in seconds
      arrivalRate: 5 # Number of new virtual users per second
  processor: "./generate-phone.js" # Custom JavaScript code for generating phone numbers

scenarios:
  - flow:
      - function: "generatePhoneNumber"
      - post:
          url: "/otp"
          json:
            phone: "{{ phone }}"

3. Run artillery run phone-test.yml. Ensure that these env vars are set:

GOTRUE_HOOK_CUSTOM_SMS_PROVIDER_ENABLED="true"
GOTRUE_HOOK_CUSTOM_SMS_PROVIDER_URI="http://host.docker.internal:54321/functions/v1/sms_sender"
GOTRUE_HOOK_CUSTOM_SMS_PROVIDER_SECRETS="v1,whsec_<base64_encoded>"

[hf]

Looks good, would improve the errors / logs a bit.

[J0]

For reference closer to release:

• We need to document that the compression header is set to identity and not gzip compression - see this comment
• Drop ContentLenght check if not relevant. See this comment for details.