From 2ad97e4d8af7f0c6d64d49fa05d6a7b8f01a241c Mon Sep 17 00:00:00 2001 From: Probir Sarkar Date: Thu, 25 Jan 2024 14:02:58 +0530 Subject: [PATCH 1/3] Added example of hono js with supabase functions --- supabase/.gitignore | 4 + supabase/README.md | 27 ++++ supabase/config.toml | 159 ++++++++++++++++++++++++ supabase/functions/hono-server/index.ts | 14 +++ 4 files changed, 204 insertions(+) create mode 100644 supabase/.gitignore create mode 100644 supabase/README.md create mode 100644 supabase/config.toml create mode 100644 supabase/functions/hono-server/index.ts diff --git a/supabase/.gitignore b/supabase/.gitignore new file mode 100644 index 0000000..a3ad880 --- /dev/null +++ b/supabase/.gitignore @@ -0,0 +1,4 @@ +# Supabase +.branches +.temp +.env diff --git a/supabase/README.md b/supabase/README.md new file mode 100644 index 0000000..8aed207 --- /dev/null +++ b/supabase/README.md @@ -0,0 +1,27 @@ +# Writing Supabase Edge Functions with Hono Server + +This example demonstrates how to create a Supabase function using Hono Server. + +## Run Locally + +To run the function locally, use the following command: + +```bash +supabase functions serve --no-verify-jwt +``` + +Make a POST request using cURL or Postman to `http://127.0.0.1:54321/functions/v1/hono-server/hello-world`: + +```bash +curl --location 'http://127.0.0.1:54321/functions/v1/hono-server/hello-world' +``` + +## Deploy + +Deploy the function with the following command: + +```bash +supabase functions deploy hono-server --no-verify-jwt +``` + +Feel free to replace "hono-server" and "hello-world" with your specific function and endpoint names. diff --git a/supabase/config.toml b/supabase/config.toml new file mode 100644 index 0000000..a790919 --- /dev/null +++ b/supabase/config.toml @@ -0,0 +1,159 @@ +# A string used to distinguish different Supabase projects on the same host. Defaults to the +# working directory name when running `supabase init`. +project_id = "hono-examples" + +[api] +enabled = true +# Port to use for the API URL. +port = 54321 +# Schemas to expose in your API. Tables, views and stored procedures in this schema will get API +# endpoints. public and storage are always included. +schemas = ["public", "storage", "graphql_public"] +# Extra schemas to add to the search_path of every request. public is always included. +extra_search_path = ["public", "extensions"] +# The maximum number of rows returns from a view, table, or stored procedure. Limits payload size +# for accidental or malicious requests. +max_rows = 1000 + +[db] +# Port to use for the local database URL. +port = 54322 +# Port used by db diff command to initialize the shadow database. +shadow_port = 54320 +# The database major version to use. This has to be the same as your remote database's. Run `SHOW +# server_version;` on the remote database to check. +major_version = 15 + +[db.pooler] +enabled = false +# Port to use for the local connection pooler. +port = 54329 +# Specifies when a server connection can be reused by other clients. +# Configure one of the supported pooler modes: `transaction`, `session`. +pool_mode = "transaction" +# How many server connections to allow per user/database pair. +default_pool_size = 20 +# Maximum number of client connections allowed. +max_client_conn = 100 + +[realtime] +enabled = true +# Bind realtime via either IPv4 or IPv6. (default: IPv6) +# ip_version = "IPv6" +# The maximum length in bytes of HTTP request headers. (default: 4096) +# max_header_length = 4096 + +[studio] +enabled = true +# Port to use for Supabase Studio. +port = 54323 +# External URL of the API server that frontend connects to. +api_url = "http://127.0.0.1" + +# Email testing server. Emails sent with the local dev setup are not actually sent - rather, they +# are monitored, and you can view the emails that would have been sent from the web interface. +[inbucket] +enabled = true +# Port to use for the email testing server web interface. +port = 54324 +# Uncomment to expose additional ports for testing user applications that send emails. +# smtp_port = 54325 +# pop3_port = 54326 + +[storage] +enabled = true +# The maximum file size allowed (e.g. "5MB", "500KB"). +file_size_limit = "50MiB" + +[auth] +enabled = true +# The base URL of your website. Used as an allow-list for redirects and for constructing URLs used +# in emails. +site_url = "http://127.0.0.1:3000" +# A list of *exact* URLs that auth providers are permitted to redirect to post authentication. +additional_redirect_urls = ["https://127.0.0.1:3000"] +# How long tokens are valid for, in seconds. Defaults to 3600 (1 hour), maximum 604,800 (1 week). +jwt_expiry = 3600 +# If disabled, the refresh token will never expire. +enable_refresh_token_rotation = true +# Allows refresh tokens to be reused after expiry, up to the specified interval in seconds. +# Requires enable_refresh_token_rotation = true. +refresh_token_reuse_interval = 10 +# Allow/disallow new user signups to your project. +enable_signup = true +# Allow/disallow testing manual linking of accounts +enable_manual_linking = false + +[auth.email] +# Allow/disallow new user signups via email to your project. +enable_signup = true +# If enabled, a user will be required to confirm any email change on both the old, and new email +# addresses. If disabled, only the new email is required to confirm. +double_confirm_changes = true +# If enabled, users need to confirm their email address before signing in. +enable_confirmations = false + +# Uncomment to customize email template +# [auth.email.template.invite] +# subject = "You have been invited" +# content_path = "./supabase/templates/invite.html" + +[auth.sms] +# Allow/disallow new user signups via SMS to your project. +enable_signup = true +# If enabled, users need to confirm their phone number before signing in. +enable_confirmations = false +# Template for sending OTP to users +template = "Your code is {{ .Code }} ." + +# Use pre-defined map of phone number to OTP for testing. +[auth.sms.test_otp] +# 4152127777 = "123456" + +# This hook runs before a token is issued and allows you to add additional claims based on the authentication method used. +[auth.hook.custom_access_token] +# enabled = true +# uri = "pg-functions:////" + + +# Configure one of the supported SMS providers: `twilio`, `twilio_verify`, `messagebird`, `textlocal`, `vonage`. +[auth.sms.twilio] +enabled = false +account_sid = "" +message_service_sid = "" +# DO NOT commit your Twilio auth token to git. Use environment variable substitution instead: +auth_token = "env(SUPABASE_AUTH_SMS_TWILIO_AUTH_TOKEN)" + +# Use an external OAuth provider. The full list of providers are: `apple`, `azure`, `bitbucket`, +# `discord`, `facebook`, `github`, `gitlab`, `google`, `keycloak`, `linkedin_oidc`, `notion`, `twitch`, +# `twitter`, `slack`, `spotify`, `workos`, `zoom`. +[auth.external.apple] +enabled = false +client_id = "" +# DO NOT commit your OAuth provider secret to git. Use environment variable substitution instead: +secret = "env(SUPABASE_AUTH_EXTERNAL_APPLE_SECRET)" +# Overrides the default auth redirectUrl. +redirect_uri = "" +# Overrides the default auth provider URL. Used to support self-hosted gitlab, single-tenant Azure, +# or any other third-party OIDC providers. +url = "" + +[analytics] +enabled = false +port = 54327 +vector_port = 54328 +# Configure one of the supported backends: `postgres`, `bigquery`. +backend = "postgres" + +# Experimental features may be deprecated any time +[experimental] +# Configures Postgres storage engine to use OrioleDB (S3) +orioledb_version = "" +# Configures S3 bucket URL, eg. .s3-.amazonaws.com +s3_host = "env(S3_HOST)" +# Configures S3 bucket region, eg. us-east-1 +s3_region = "env(S3_REGION)" +# Configures AWS_ACCESS_KEY_ID for S3 bucket +s3_access_key = "env(S3_ACCESS_KEY)" +# Configures AWS_SECRET_ACCESS_KEY for S3 bucket +s3_secret_key = "env(S3_SECRET_KEY)" diff --git a/supabase/functions/hono-server/index.ts b/supabase/functions/hono-server/index.ts new file mode 100644 index 0000000..e04495c --- /dev/null +++ b/supabase/functions/hono-server/index.ts @@ -0,0 +1,14 @@ +import { serve } from "https://deno.land/std@0.168.0/http/server.ts"; +import { Context, Hono } from "https://deno.land/x/hono@v3.0.1/mod.ts"; + +const app = new Hono(); + +app.get( + "/hello-world", + (c: Context) => c.text("Hello World from hono-server!"), +); + +// This is your supabase function name, change accordingly +const functionName = "hono-server"; +const mainRouter = new Hono().route(`/${functionName}`, app).fetch; +serve(mainRouter); \ No newline at end of file From 6873c170e7b38cbccbe0ec992e1c398eb09be9b2 Mon Sep 17 00:00:00 2001 From: Probir Sarkar Date: Thu, 25 Jan 2024 18:16:45 +0530 Subject: [PATCH 2/3] Updated example of hono with supabase functions --- supabase/functions/hono-server/index.ts | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/supabase/functions/hono-server/index.ts b/supabase/functions/hono-server/index.ts index e04495c..b39c437 100644 --- a/supabase/functions/hono-server/index.ts +++ b/supabase/functions/hono-server/index.ts @@ -1,14 +1,10 @@ -import { serve } from "https://deno.land/std@0.168.0/http/server.ts"; -import { Context, Hono } from "https://deno.land/x/hono@v3.0.1/mod.ts"; +import type { Context } from "https://deno.land/x/hono@v3.12.7/mod.ts"; +import { Hono } from "https://deno.land/x/hono@v3.12.7/mod.ts"; -const app = new Hono(); +// change this to your function name +const functionName = "hono-server"; +const app = new Hono().basePath(`/${functionName}`); -app.get( - "/hello-world", - (c: Context) => c.text("Hello World from hono-server!"), -); +app.get("/hello-world", (c: Context) => c.text("Hello World from hono-server!")); -// This is your supabase function name, change accordingly -const functionName = "hono-server"; -const mainRouter = new Hono().route(`/${functionName}`, app).fetch; -serve(mainRouter); \ No newline at end of file +Deno.serve(app.fetch); From eeeeeae95812ddb7d38038878cebed2b3308aaf0 Mon Sep 17 00:00:00 2001 From: Probir Sarkar Date: Thu, 25 Jan 2024 19:22:08 +0530 Subject: [PATCH 3/3] correct request type error in hono-example --- supabase/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/supabase/README.md b/supabase/README.md index 8aed207..5eb6a13 100644 --- a/supabase/README.md +++ b/supabase/README.md @@ -10,7 +10,7 @@ To run the function locally, use the following command: supabase functions serve --no-verify-jwt ``` -Make a POST request using cURL or Postman to `http://127.0.0.1:54321/functions/v1/hono-server/hello-world`: +Make a GET request using cURL or Postman to `http://127.0.0.1:54321/functions/v1/hono-server/hello-world`: ```bash curl --location 'http://127.0.0.1:54321/functions/v1/hono-server/hello-world'