feat(functions) update functions template to match new 'server' style (#5063)

Author: kallebysantos

cmd/functions.go

@@ -85,6 +85,14 @@ var (
 		},
 	}
 
+	authMode = utils.EnumFlag{
+		Allowed: []string{
+			string(new_.AuthModeNone),
+			string(new_.AuthModeApiKey),
+			string(new_.AuthModeUser),
+		},
+		Value: string(new_.AuthModeApiKey),
+	}
 	functionsNewCmd = &cobra.Command{
 		Use:   "new <Function name>",
 		Short: "Create a new Function locally",
@@ -94,7 +102,9 @@ var (
 			return cmd.Root().PersistentPreRunE(cmd, args)
 		},
 		RunE: func(cmd *cobra.Command, args []string) error {
-			return new_.Run(cmd.Context(), args[0], afero.NewOsFs())
+			authMode := new_.AuthMode(authMode.Value)
+
+			return new_.Run(cmd.Context(), args[0], authMode, afero.NewOsFs())
 		},
 	}
 
@@ -172,6 +182,7 @@ func init() {
 	functionsDownloadCmd.MarkFlagsMutuallyExclusive("use-api", "use-docker", "legacy-bundle")
 	cobra.CheckErr(downloadFlags.MarkHidden("legacy-bundle"))
 	cobra.CheckErr(downloadFlags.MarkHidden("use-docker"))
+	functionsNewCmd.Flags().Var(&authMode, "auth", "use a specific auth mode")
 	functionsCmd.AddCommand(functionsListCmd)
 	functionsCmd.AddCommand(functionsDeleteCmd)
 	functionsCmd.AddCommand(functionsDeployCmd)

internal/functions/new/new.go

@@ -16,26 +16,49 @@ import (
 	"github.com/supabase/cli/internal/utils/flags"
 )
 
+type AuthMode string
+
+const (
+	AuthModeNone   AuthMode = "none"
+	AuthModeApiKey AuthMode = "apikey"
+	AuthModeUser   AuthMode = "user"
+)
+
 var (
-	//go:embed templates/index.ts
-	indexEmbed string
+	//go:embed templates/index_auth_mode_none.ts
+	indexAuthModeNoneEmbed string
+	//go:embed templates/index_auth_mode_apikey.ts
+	indexAuthModeApiKeyEmbed string
+	//go:embed templates/index_auth_mode_user.ts
+	indexAuthModeUserEmbed string
+
 	//go:embed templates/deno.json
 	denoEmbed string
 	//go:embed templates/.npmrc
 	npmrcEmbed string
 	//go:embed templates/config.toml
 	configEmbed string
 
-	indexTemplate  = template.Must(template.New("index").Parse(indexEmbed))
+	indexAuthTemplates = map[AuthMode]*template.Template{
+		AuthModeNone:   template.Must(template.New("index").Parse(indexAuthModeNoneEmbed)),
+		AuthModeApiKey: template.Must(template.New("index").Parse(indexAuthModeApiKeyEmbed)),
+		AuthModeUser:   template.Must(template.New("index").Parse(indexAuthModeUserEmbed)),
+	}
+
 	configTemplate = template.Must(template.New("config").Parse(configEmbed))
 )
 
 type indexConfig struct {
-	URL   string
-	Token string
+	URL            string
+	PublishableKey string
+}
+
+type functionConfig struct {
+	Slug      string
+	VerifyJWT bool
 }
 
-func Run(ctx context.Context, slug string, fsys afero.Fs) error {
+func Run(ctx context.Context, slug string, authMode AuthMode, fsys afero.Fs) error {
 	// 1. Sanity checks.
 	if err := utils.ValidateFunctionSlug(slug); err != nil {
 		return err
@@ -56,17 +79,18 @@ func Run(ctx context.Context, slug string, fsys afero.Fs) error {
 	if err := flags.LoadConfig(fsys); err != nil {
 		fmt.Fprintln(utils.GetDebugLogger(), err)
 	}
-	if err := createEntrypointFile(slug, fsys); err != nil {
+	if err := createEntrypointFile(slug, authMode, fsys); err != nil {
 		return err
 	}
-	if err := appendConfigFile(slug, fsys); err != nil {
+	verifyJWT := authMode == AuthModeUser
+	if err := appendConfigFile(slug, verifyJWT, fsys); err != nil {
 		return err
 	}
 	// 3. Create optional files
-	if err := afero.WriteFile(fsys, filepath.Join(funcDir, "deno.json"), []byte(denoEmbed), 0644); err != nil {
+	if err := afero.WriteFile(fsys, filepath.Join(funcDir, "deno.json"), []byte(denoEmbed), 0o644); err != nil {
 		return errors.Errorf("failed to create deno.json config: %w", err)
 	}
-	if err := afero.WriteFile(fsys, filepath.Join(funcDir, ".npmrc"), []byte(npmrcEmbed), 0644); err != nil {
+	if err := afero.WriteFile(fsys, filepath.Join(funcDir, ".npmrc"), []byte(npmrcEmbed), 0o644); err != nil {
 		return errors.Errorf("failed to create .npmrc config: %w", err)
 	}
 	fmt.Println("Created new Function at " + utils.Bold(funcDir))
@@ -79,33 +103,40 @@ func Run(ctx context.Context, slug string, fsys afero.Fs) error {
 	return nil
 }
 
-func createEntrypointFile(slug string, fsys afero.Fs) error {
+func createEntrypointFile(slug string, authMode AuthMode, fsys afero.Fs) error {
 	entrypointPath := filepath.Join(utils.FunctionsDir, slug, "index.ts")
-	f, err := fsys.OpenFile(entrypointPath, os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0644)
+	f, err := fsys.OpenFile(entrypointPath, os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0o644)
 	if err != nil {
 		return errors.Errorf("failed to create entrypoint: %w", err)
 	}
 	defer f.Close()
+	indexTemplate, hasTemplate := indexAuthTemplates[authMode]
+	if !hasTemplate {
+		return errors.Errorf("failed to write entrypoint: '%v' is not a valid template", authMode)
+	}
 	if err := indexTemplate.Option("missingkey=error").Execute(f, indexConfig{
-		URL:   utils.GetApiUrl("/functions/v1/" + slug),
-		Token: utils.Config.Auth.AnonKey.Value,
+		URL:            utils.GetApiUrl("/functions/v1/" + slug),
+		PublishableKey: utils.Config.Auth.PublishableKey.Value,
 	}); err != nil {
 		return errors.Errorf("failed to write entrypoint: %w", err)
 	}
 	return nil
 }
 
-func appendConfigFile(slug string, fsys afero.Fs) error {
+func appendConfigFile(slug string, verifyJWT bool, fsys afero.Fs) error {
 	if _, exists := utils.Config.Functions[slug]; exists {
 		fmt.Fprintf(os.Stderr, "[functions.%s] is already declared in %s\n", slug, utils.Bold(utils.ConfigPath))
 		return nil
 	}
-	f, err := fsys.OpenFile(utils.ConfigPath, os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
+	f, err := fsys.OpenFile(utils.ConfigPath, os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0o644)
 	if err != nil {
 		return errors.Errorf("failed to append config: %w", err)
 	}
 	defer f.Close()
-	if err := configTemplate.Option("missingkey=error").Execute(f, slug); err != nil {
+	if err := configTemplate.Option("missingkey=error").Execute(f, functionConfig{
+		Slug:      slug,
+		VerifyJWT: verifyJWT,
+	}); err != nil {
 		return errors.Errorf("failed to append template: %w", err)
 	}
 	return nil

internal/functions/new/new_test.go

@@ -2,6 +2,7 @@ package new
 
 import (
 	"context"
+	"fmt"
 	"path/filepath"
 	"testing"
 
@@ -16,7 +17,7 @@ func TestNewCommand(t *testing.T) {
 		// Setup in-memory fs
 		fsys := afero.NewMemMapFs()
 		// Run test
-		assert.NoError(t, Run(context.Background(), "test-func", fsys))
+		assert.NoError(t, Run(context.Background(), "test-func", AuthModeNone, fsys))
 		// Validate output
 		funcPath := filepath.Join(utils.FunctionsDir, "test-func", "index.ts")
 		content, err := afero.ReadFile(fsys, funcPath)
@@ -26,8 +27,11 @@ func TestNewCommand(t *testing.T) {
 		)
 
 		// Verify config.toml is updated
-		_, err = afero.ReadFile(fsys, utils.ConfigPath)
+		content, err = afero.ReadFile(fsys, utils.ConfigPath)
 		assert.NoError(t, err, "config.toml should be created")
+		assert.Contains(t, string(content), "[functions.test-func]")
+		// Always access mode should not verify jwt
+		assert.Contains(t, string(content), "verify_jwt = false")
 
 		// Verify deno.json exists
 		denoPath := filepath.Join(utils.FunctionsDir, "test-func", "deno.json")
@@ -40,23 +44,54 @@ func TestNewCommand(t *testing.T) {
 		assert.NoError(t, err, ".npmrc should be created")
 	})
 
+	t.Run("creates new function with apikey access", func(t *testing.T) {
+		fsys := afero.NewMemMapFs()
+		assert.NoError(t, Run(context.Background(), "test-func", AuthModeApiKey, fsys))
+
+		// Validate output
+		funcPath := filepath.Join(utils.FunctionsDir, "test-func", "index.ts")
+		content, _ := afero.ReadFile(fsys, funcPath)
+		// Should contain the PublishableKey as example
+		assert.Contains(t, string(content), fmt.Sprintf("--header 'apiKey: %v'", utils.Config.Auth.PublishableKey.Value))
+
+		// Verify config.toml is updated to not verify jwt
+		content, _ = afero.ReadFile(fsys, utils.ConfigPath)
+		assert.Contains(t, string(content), "verify_jwt = false")
+	})
+
+	t.Run("creates new function with user access", func(t *testing.T) {
+		fsys := afero.NewMemMapFs()
+		assert.NoError(t, Run(context.Background(), "test-func", AuthModeUser, fsys))
+
+		// Validate output
+		funcPath := filepath.Join(utils.FunctionsDir, "test-func", "index.ts")
+		content, _ := afero.ReadFile(fsys, funcPath)
+		// Should contain the PublishableKey as example as well placeholder for UserToken
+		assert.Contains(t, string(content), fmt.Sprintf("--header 'apiKey: %v'", utils.Config.Auth.PublishableKey.Value))
+		assert.Contains(t, string(content), "--header 'Authorization: Bearer <UserToken>'")
+
+		// Verify config.toml is updated and verify jwt enabled
+		content, _ = afero.ReadFile(fsys, utils.ConfigPath)
+		assert.Contains(t, string(content), "verify_jwt = true")
+	})
+
 	t.Run("throws error on malformed slug", func(t *testing.T) {
-		assert.Error(t, Run(context.Background(), "@", afero.NewMemMapFs()))
+		assert.Error(t, Run(context.Background(), "@", AuthModeNone, afero.NewMemMapFs()))
 	})
 
 	t.Run("throws error on duplicate slug", func(t *testing.T) {
 		// Setup in-memory fs
 		fsys := afero.NewMemMapFs()
 		funcPath := filepath.Join(utils.FunctionsDir, "test-func", "index.ts")
-		require.NoError(t, afero.WriteFile(fsys, funcPath, []byte{}, 0644))
+		require.NoError(t, afero.WriteFile(fsys, funcPath, []byte{}, 0o644))
 		// Run test
-		assert.Error(t, Run(context.Background(), "test-func", fsys))
+		assert.Error(t, Run(context.Background(), "test-func", AuthModeNone, fsys))
 	})
 
 	t.Run("throws error on permission denied", func(t *testing.T) {
 		// Setup in-memory fs
 		fsys := afero.NewReadOnlyFs(afero.NewMemMapFs())
 		// Run test
-		assert.Error(t, Run(context.Background(), "test-func", fsys))
+		assert.Error(t, Run(context.Background(), "test-func", AuthModeNone, fsys))
 	})
 }

internal/functions/new/templates/config.toml

@@ -1,11 +1,11 @@
 
-[functions.{{ . }}]
+[functions.{{ .Slug }}]
 enabled = true
-verify_jwt = true
-import_map = "./functions/{{ . }}/deno.json"
+verify_jwt = {{ .VerifyJWT }}
+import_map = "./functions/{{ .Slug }}/deno.json"
 # Uncomment to specify a custom file path to the entrypoint.
 # Supported file extensions are: .ts, .js, .mjs, .jsx, .tsx
-entrypoint = "./functions/{{ . }}/index.ts"
+entrypoint = "./functions/{{ .Slug }}/index.ts"
 # Specifies static files to be bundled with the function. Supports glob patterns.
 # For example, if you want to serve static HTML pages in your function:
-# static_files = [ "./functions/{{ . }}/*.html" ]
+# static_files = [ "./functions/{{ .Slug }}/*.html" ]

internal/functions/new/templates/deno.json

@@ -1,5 +1,6 @@
 {
   "imports": {
-    "@supabase/functions-js": "jsr:@supabase/functions-js@^2"
+    "@supabase/functions-js": "jsr:@supabase/functions-js@^2",
+    "@supabase/server": "npm:@supabase/server@^1"
   }
 }

internal/functions/new/templates/index_auth_mode_apikey.ts

@@ -0,0 +1,46 @@
+// Follow this setup guide to integrate the Deno language server with your editor:
+// https://deno.land/manual/getting_started/setup_your_environment
+// This enables autocomplete, go to definition, etc.
+
+// Setup type definitions for built-in Supabase Runtime APIs
+import "@supabase/functions-js/edge-runtime.d.ts";
+import { withSupabase } from "@supabase/server";
+
+console.log("Hello from Functions!");
+
+// This endpoint uses 'publishable' | 'secret' access, apiKey is required.
+// Use publishable for Client-facing, key-validated endpoints
+// Use secret for Server-to-server, internal calls
+export default {
+  fetch: withSupabase({ auth: ["publishable", "secret"] }, async (req, ctx) => {
+    // Called by another service with a secret key
+    // ctx.supabaseAdmin bypasses RLS — use for privileged operations
+    /*
+    if (ctx.authType === "secret") {
+      const { user_id } = await req.json();
+      const { data } = await ctx.supabaseAdmin.auth.admin.getUserById(user_id);
+
+      return Response.json({
+        email: data?.user?.email,
+      });
+    }
+    */
+
+    const { name } = await req.json();
+
+    return Response.json({
+      message: `Hello ${name}!`,
+    });
+  }),
+};
+
+/* To invoke locally:
+
+  1. Run `supabase start` (see: https://supabase.com/docs/reference/cli/supabase-start)
+  2. Make an HTTP request:
+
+  curl -i --location --request POST '{{ .URL }}' \
+    --header 'apiKey: {{ .PublishableKey }}' \
+    --data '{"name":"Functions"}'
+
+*/

internal/functions/new/templates/index_auth_mode_none.ts

@@ -0,0 +1,32 @@
+// Follow this setup guide to integrate the Deno language server with your editor:
+// https://deno.land/manual/getting_started/setup_your_environment
+// This enables autocomplete, go to definition, etc.
+
+// Setup type definitions for built-in Supabase Runtime APIs
+import "@supabase/functions-js/edge-runtime.d.ts";
+import { withSupabase } from "@supabase/server";
+
+console.log("Hello from Functions!");
+
+// This endpoint uses auth 'none', no credentials required, every request is accepted.
+// Use it for health checks, public APIs, or when you need to implement your own auth logic.
+export default {
+  fetch: withSupabase({ auth: "none" }, async (req, ctx) => {
+    const { name } = await req.json();
+
+    return Response.json({
+      message: `Hello ${name}!`,
+    });
+  }),
+};
+
+/* To invoke locally:
+
+  1. Run `supabase start` (see: https://supabase.com/docs/reference/cli/supabase-start)
+  2. Make an HTTP request:
+
+  curl -i --location --request POST '{{ .URL }}' \
+    --header 'Content-Type: application/json' \
+    --data '{"name":"Functions"}'
+
+*/

internal/functions/new/templates/index.ts …ns/new/templates/index_auth_mode_user.tsinternal/functions/new/templates/index.ts renamed to internal/functions/new/templates/index_auth_mode_user.ts internal/functions/new/templates/index.ts renamed to internal/functions/new/templates/index_auth_mode_user.ts

@@ -4,29 +4,27 @@
 
 // Setup type definitions for built-in Supabase Runtime APIs
 import "@supabase/functions-js/edge-runtime.d.ts"
+import { withSupabase } from "@supabase/server"
 
 console.log("Hello from Functions!")
 
-Deno.serve(async (req) => {
-  const { name } = await req.json()
-  const data = {
-    message: `Hello ${name}!`,
-  }
+// This endpoint uses 'user' access, credentials is required.
+export default {
+  fetch: withSupabase({ auth: "user" }, async (_req, ctx) => {
+    const email = ctx.userClaims?.email;
 
-  return new Response(
-    JSON.stringify(data),
-    { headers: { "Content-Type": "application/json" } },
-  )
-})
+    return Response.json({
+      message: `Hello ${email}!`,
+    })
+  }),
+}
 
 /* To invoke locally:
 
   1. Run `supabase start` (see: https://supabase.com/docs/reference/cli/supabase-start)
   2. Make an HTTP request:
 
   curl -i --location --request POST '{{ .URL }}' \
-    --header 'Authorization: Bearer {{ .Token }}' \
-    --header 'Content-Type: application/json' \
-    --data '{"name":"Functions"}'
-
+    --header 'apiKey: {{ .PublishableKey }}' \
+    --header 'Authorization: Bearer <UserToken>'
 */