Merge pull request #6286 from supabase/examples/edge-functions-test-client

feat Examples/edge functions test client

examples/edge-functions/README.md

@@ -15,7 +15,19 @@ The function examples are located in [`./supabase/functions`](./supabase/functio
 
 - Run `supabase start` (make sure your Docker daemon is running.)
 - Run `supabase functions serve your-function-name`
-- Run the CURL command in the example function, or use the [invoke method](https://supabase.com/docs/reference/javascript/invoke) on the Supabase client.
+- Run the CURL command in the example function, or use the [invoke method](https://supabase.com/docs/reference/javascript/invoke) on the Supabase client or use the test client [app](./app/).
+
+## Test
+
+This example includes a create-react-app in the [`./app/`](./app/) directory which you can use as a sort of postman to make test requests both locally and to your deployed functions.
+
+### Test locally
+
+- `cd app`
+- `npm install`
+- `npm start`
+
+Note: when testing locally, the select dropdown doesn't have any effect, and invoke simply calls whatever function is currently served by the CLI.
 
 ## Deploy
 
@@ -34,6 +46,16 @@ The function examples are located in [`./supabase/functions`](./supabase/functio
   - Within your project root run `supabase functions deploy payment-sheet`
 - In youre [`./app/.env`](./app/.env) file remove the `SUPA_FUNCTION_LOCALHOST` variable and restart your Expo app.
 
+### Test deployed functions
+
+This example includes a create-react-app in the [`./app/`](./app/) directory which you can use as a sort of postman to make test requests both locally and to your deployed functions.
+
+- `cd app`
+- `cp .env.example .env`
+- Fill in your env vars from https://app.supabase.io/project/_/settings/api
+- `npm install`
+- `npm start`
+
 ## 👁⚡️👁
 
 \o/ That's it, you can now invoke your Supabase Function via the [`supabase-js`](https://supabase.com/docs/reference/javascript/invoke) and [`supabase-dart`](https://supabase.com/docs/reference/dart/invoke) client libraries. (More client libraries coming soon. Check the [supabase-community](https://github.com/supabase-community#client-libraries) org for details).

examples/edge-functions/app/.env.example

@@ -0,0 +1,3 @@
+# Get these from your Dashboard: https://app.supabase.io/project/_/settings/api
+REACT_APP_SUPABASE_URL=
+REACT_APP_SUPABASE_ANON_KEY=

examples/edge-functions/app/.gitignore

@@ -0,0 +1,24 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+*lock.json

examples/edge-functions/app/README.md

@@ -0,0 +1,70 @@
+# Getting Started with Create React App
+
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm start`
+
+Runs the app in the development mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
+
+The page will reload when you make changes.\
+You may also see any lint errors in the console.
+
+### `npm test`
+
+Launches the test runner in the interactive watch mode.\
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.\
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.\
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `npm run eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can't go back!**
+
+If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
+
+You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).
+
+### Code Splitting
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
+
+### Analyzing the Bundle Size
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
+
+### Making a Progressive Web App
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
+
+### Advanced Configuration
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
+
+### Deployment
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
+
+### `npm run build` fails to minify
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)

examples/edge-functions/app/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "app",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "@supabase/supabase-js": "^1.33.3",
+    "@supabase/ui": "^0.36.4",
+    "@testing-library/jest-dom": "^5.16.3",
+    "@testing-library/react": "^12.1.4",
+    "@testing-library/user-event": "^13.5.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "react-json-editor-ajrm": "^2.5.13",
+    "react-scripts": "5.0.0"
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "build": "react-scripts build",
+    "test": "react-scripts test",
+    "eject": "react-scripts eject"
+  },
+  "eslintConfig": {
+    "extends": [
+      "react-app",
+      "react-app/jest"
+    ]
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  },
+  "devDependencies": {
+    "autoprefixer": "^10.4.4",
+    "postcss": "^8.4.12",
+    "tailwindcss": "^3.0.23"
+  }
+}

examples/edge-functions/app/postcss.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  plugins: {
+    tailwindcss: {},
+    autoprefixer: {},
+  },
+}

examples/edge-functions/app/public/index.html

@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <meta name="description" content="Web site created using create-react-app" />
+    <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
+    <!--
+      manifest.json provides metadata used when your web app is installed on a
+      user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
+    -->
+    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
+    <!--
+      Notice the use of %PUBLIC_URL% in the tags above.
+      It will be replaced with the URL of the `public` folder during the build.
+      Only files inside the `public` folder can be referenced from the HTML.
+
+      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
+      work correctly both with client-side routing and a non-root public URL.
+      Learn how to configure a non-root public URL by running `npm run build`.
+    -->
+    <title>Supabase Edge Functions Test Client</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>

examples/edge-functions/app/public/manifest.json

@@ -0,0 +1,25 @@
+{
+  "short_name": "React App",
+  "name": "Create React App Sample",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    },
+    {
+      "src": "logo192.png",
+      "type": "image/png",
+      "sizes": "192x192"
+    },
+    {
+      "src": "logo512.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}

examples/edge-functions/app/public/robots.txt

@@ -0,0 +1,3 @@
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *
+Disallow:

examples/edge-functions/app/src/App.js

@@ -0,0 +1,86 @@
+import React, { useState } from 'react'
+import { Auth, Button, Typography, Select } from '@supabase/ui'
+import JSONInput from 'react-json-editor-ajrm'
+import locale from 'react-json-editor-ajrm/locale/en'
+import { supabase } from './utils/supabaseClient'
+import { functionsList } from './functionsList'
+
+const { Title, Text } = Typography
+const sampleObject = { name: 'world' }
+
+function App() {
+  const { user } = Auth.useUser()
+  const [supaFunction, setSupaFunction] = useState(functionsList[0])
+  const [requestJson, setRequestJson] = useState(sampleObject)
+  const [responseJson, setResponseJson] = useState({})
+
+  const invokeFunction = async () => {
+    setResponseJson({ loading: true })
+    const { data, error } = await supabase.functions.invoke(supaFunction, {
+      body: JSON.stringify(requestJson),
+    })
+    if (error) alert(error)
+    setResponseJson(data)
+  }
+
+  return (
+    <div className="p-2">
+      <Title level={2} className="mb-2">
+        Supabase Egde Functions Test Client
+      </Title>
+      <div className="grid grid-cols-1 md:grid-cols-2">
+        <div className="p-2">
+          <Title level={3} className="mb-2">
+            Request
+          </Title>
+          <Title level={4}>Function</Title>
+          <Select onChange={(e) => setSupaFunction(e.target.value)}>
+            {functionsList.map((func) => (
+              <Select.Option value={func} key={func}>
+                {func}
+              </Select.Option>
+            ))}
+          </Select>
+          <Text className="mb-2">
+            Note: when using locally, this selection doesn't have any effect and the function that's
+            currently being served via the CLI is called instead.
+          </Text>
+          <Title level={4} className="mb-2">
+            Body
+          </Title>
+          <JSONInput
+            onChange={({ jsObject }) => setRequestJson(jsObject)}
+            placeholder={sampleObject}
+            locale={locale}
+            height="100"
+            width="100%"
+          />
+          <Button className="mt-2" onClick={invokeFunction}>
+            Invoke Function
+          </Button>
+        </div>
+        <div className="p-2">
+          <Title level={3} className="mb-2">
+            Response
+          </Title>
+          <pre className="p-2 bg-gray-300	">{JSON.stringify(responseJson, null, 2)}</pre>
+        </div>
+        <div className="p-2">
+          <Title level={3} className="mb-2">
+            Log in to see RLS in action
+          </Title>
+          {user ? (
+            <div>
+              <Title level={4} className="mb-2">{`Logged in as ${user.email}`}</Title>
+              <Button onClick={() => supabase.auth.signOut()}>Sign out</Button>
+            </div>
+          ) : (
+            <Auth supabaseClient={supabase} />
+          )}
+        </div>
+      </div>
+    </div>
+  )
+}
+
+export default App

examples/edge-functions/app/src/functionsList.js

@@ -0,0 +1,5 @@
+export const functionsList = [
+  'local: Whatever function is currently served by the CLI',
+  'browser-with-cors',
+  'select-from-table-with-auth-rls',
+]

examples/edge-functions/app/src/index.css

@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;

examples/edge-functions/app/src/index.js

@@ -0,0 +1,15 @@
+import React from 'react'
+import ReactDOM from 'react-dom'
+import './index.css'
+import App from './App'
+import { Auth } from '@supabase/ui'
+import { supabase } from './utils/supabaseClient'
+
+ReactDOM.render(
+  <React.StrictMode>
+    <Auth.UserContextProvider supabaseClient={supabase}>
+      <App />
+    </Auth.UserContextProvider>
+  </React.StrictMode>,
+  document.getElementById('root')
+)

examples/edge-functions/app/src/utils/supabaseClient.js

@@ -0,0 +1,7 @@
+import { createClient } from '@supabase/supabase-js'
+
+export const supabase = createClient(
+  process.env.REACT_APP_SUPABASE_URL ?? 'http://localhost:54321',
+  process.env.REACT_APP_SUPABASE_ANON_KEY ??
+    'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs'
+)

examples/edge-functions/app/tailwind.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+  content: ['./src/**/*.{js,jsx,ts,tsx}'],
+  theme: {
+    extend: {},
+  },
+  plugins: [],
+}

examples/edge-functions/edge-functions.code-workspace

@@ -0,0 +1,23 @@
+{
+  "folders": [
+    {
+      "name": "project-root",
+      "path": "./"
+    },
+    {
+      "name": "test-client",
+      "path": "app"
+    },
+    {
+      "name": "supabase-functions",
+      "path": "supabase/functions"
+    }
+  ],
+  "settings": {
+    "files.exclude": {
+      "node_modules/": true,
+      "app/": true,
+      "supabase/functions/": true
+    }
+  }
+}

examples/edge-functions/supabase/functions/.gitignore

@@ -0,0 +1 @@
+!.vscode

examples/edge-functions/supabase/functions/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "deno.enable": true,
+  "deno.lint": true,
+  "deno.unstable": true
+}

examples/edge-functions/supabase/functions/_shared/supabaseClient.ts

@@ -0,0 +1,8 @@
+import { createClient } from 'https://esm.sh/@supabase/supabase-js@^1.33.2'
+
+export const supabaseClient = createClient(
+  // Supabase API URL - env var exported by default when deployed.
+  Deno.env.get('SUPABASE_URL') ?? '',
+  // Supabase API ANON KEY - env var exported by default when deployed.
+  Deno.env.get('SUPABASE_ANON_KEY') ?? ''
+)

examples/edge-functions/supabase/functions/browser-with-cors/index.ts

@@ -5,7 +5,7 @@
 import { serve } from 'https://deno.land/std@0.131.0/http/server.ts'
 import { corsHeaders } from '../_shared/cors.ts'
 
-console.log('Hello from Functions!')
+console.log(`Function "browser-with-cors" up and running!`)
 
 serve(async (req) => {
   // This is needed if you're planning to invoke your function from a browser.
@@ -13,14 +13,22 @@ serve(async (req) => {
     return new Response('ok', { headers: corsHeaders })
   }
 
-  const { name } = await req.json()
-  const data = {
-    message: `Hello ${name}!`,
-  }
+  try {
+    const { name } = await req.json()
+    const data = {
+      message: `Hello ${name}!`,
+    }
 
-  return new Response(JSON.stringify(data), {
-    headers: { ...corsHeaders, 'Content-Type': 'application/json' },
-  })
+    return new Response(JSON.stringify(data), {
+      headers: { ...corsHeaders, 'Content-Type': 'application/json' },
+      status: 200,
+    })
+  } catch (error) {
+    return new Response(JSON.stringify({ error: error.message }), {
+      headers: { ...corsHeaders, 'Content-Type': 'application/json' },
+      status: 400,
+    })
+  }
 })
 
 // To invoke:

examples/edge-functions/supabase/functions/select-from-table-with-auth-rls/index.ts

@@ -3,16 +3,9 @@
 // This enables autocomplete, go to definition, etc.
 
 import { serve } from 'https://deno.land/std@0.131.0/http/server.ts'
-import { createClient } from 'https://esm.sh/@supabase/supabase-js@^1.33.2'
+import { supabaseClient } from '../_shared/supabaseClient.ts'
 import { corsHeaders } from '../_shared/cors.ts'
 
-const supabase = createClient(
-  // Supabase API URL - env var exported by default when deployed.
-  Deno.env.get('SUPABASE_URL') ?? '',
-  // Supabase API ANON KEY - env var exported by default when deployed.
-  Deno.env.get('SUPABASE_ANON_KEY') ?? ''
-)
-
 console.log(`Function "select-from-table-with-auth-rls" up and running!`)
 
 serve(async (req: Request) => {
@@ -20,16 +13,25 @@ serve(async (req: Request) => {
   if (req.method === 'OPTIONS') {
     return new Response('ok', { headers: corsHeaders })
   }
-  // Set the Auth context of the user that called the function.
-  // This way your row-level-security (RLS) policies are applied.
-  supabase.auth.setAuth(req.headers.get('Authorization')!.replace('Bearer ', ''))
 
-  const { data, error } = await supabase.from('users').select('*')
-  console.log({ data, error })
+  try {
+    // Set the Auth context of the user that called the function.
+    // This way your row-level-security (RLS) policies are applied.
+    supabaseClient.auth.setAuth(req.headers.get('Authorization')!.replace('Bearer ', ''))
 
-  return new Response(JSON.stringify({ data, error }), {
-    headers: { ...corsHeaders, 'Content-Type': 'application/json' },
-  })
+    const { data, error } = await supabaseClient.from('users').select('*')
+    console.log({ data, error })
+
+    return new Response(JSON.stringify({ data, error }), {
+      headers: { ...corsHeaders, 'Content-Type': 'application/json' },
+      status: 200,
+    })
+  } catch (error) {
+    return new Response(JSON.stringify({ error: error.message }), {
+      headers: { ...corsHeaders, 'Content-Type': 'application/json' },
+      status: 400,
+    })
+  }
 })
 
 // To invoke: