Merge pull request #11777 from supabase/feat/add-next-js-13-server-components-example

Add next.js server components example

examples/caching/with-nextjs-13-server-components/.env.local.example

@@ -0,0 +1,5 @@
+# these values can be found in your project's API settings
+# https://app.supabase.com/project/_/settings/api
+
+NEXT_PUBLIC_SUPABASE_URL=your-supabase-url
+NEXT_PUBLIC_SUPABASE_ANON_KEY=your-supabase-anon-key

examples/caching/with-nextjs-13-server-components/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "next/core-web-vitals"
+}

examples/caching/with-nextjs-13-server-components/.gitignore

@@ -0,0 +1,36 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

examples/caching/with-nextjs-13-server-components/README.md

@@ -0,0 +1,3 @@
+This is an example repo to show how to fetch and cache Supabase data with Next.js Server Components.
+
+Check out [the article](https://supabase.com/blog/fetching-and-caching-supabase-data-in-next-js-server-components) to learn more.

examples/caching/with-nextjs-13-server-components/app/client-side/page.tsx

@@ -0,0 +1,21 @@
+'use client'
+
+import { useEffect, useState } from 'react'
+import supabase from '../../utils/supabase'
+
+export default function ClientPosts() {
+  const [isLoading, setIsLoading] = useState(true)
+  const [posts, setPosts] = useState<any>([])
+
+  useEffect(() => {
+    const fetchPosts = async () => {
+      const { data } = await supabase.from('posts').select()
+      setPosts(data)
+      setIsLoading(false)
+    }
+
+    fetchPosts()
+  }, [])
+
+  return isLoading ? <p>Loading</p> : <pre>{JSON.stringify(posts, null, 2)}</pre>
+}

examples/caching/with-nextjs-13-server-components/app/globals.css

@@ -0,0 +1,26 @@
+html,
+body {
+  padding: 0;
+  margin: 0;
+  font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Roboto, Oxygen, Ubuntu, Cantarell,
+    Fira Sans, Droid Sans, Helvetica Neue, sans-serif;
+}
+
+a {
+  color: inherit;
+  text-decoration: none;
+}
+
+* {
+  box-sizing: border-box;
+}
+
+@media (prefers-color-scheme: dark) {
+  html {
+    color-scheme: dark;
+  }
+  body {
+    color: white;
+    background: black;
+  }
+}

examples/caching/with-nextjs-13-server-components/app/head.tsx

@@ -0,0 +1,10 @@
+export default function Head() {
+  return (
+    <>
+      <title>Create Next App</title>
+      <meta content="width=device-width, initial-scale=1" name="viewport" />
+      <meta name="description" content="Generated by create next app" />
+      <link rel="icon" href="/favicon.ico" />
+    </>
+  )
+}

examples/caching/with-nextjs-13-server-components/app/layout.tsx

@@ -0,0 +1,14 @@
+import './globals.css'
+
+export default function RootLayout({ children }: { children: React.ReactNode }) {
+  return (
+    <html lang="en">
+      {/*
+        <head /> will contain the components returned by the nearest parent
+        head.tsx. Find out more at https://beta.nextjs.org/docs/api-reference/file-conventions/head
+      */}
+      <head />
+      <body>{children}</body>
+    </html>
+  )
+}

examples/caching/with-nextjs-13-server-components/app/page.module.css

@@ -0,0 +1,146 @@
+.container {
+  padding: 0 2rem;
+}
+
+.main {
+  min-height: 100vh;
+  padding: 4rem 0;
+  flex: 1;
+  display: flex;
+  flex-direction: column;
+  justify-content: center;
+  align-items: center;
+}
+
+.footer {
+  display: flex;
+  flex: 1;
+  padding: 2rem 0;
+  border-top: 1px solid #eaeaea;
+  justify-content: center;
+  align-items: center;
+}
+
+.footer a {
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  flex-grow: 1;
+}
+
+.title {
+  margin: 0;
+  line-height: 1.15;
+  font-size: 4rem;
+  font-style: normal;
+  font-weight: 800;
+  letter-spacing: -0.025em;
+}
+
+.title a {
+  text-decoration: none;
+  color: #0070f3;
+}
+
+.title a:hover,
+.title a:focus,
+.title a:active {
+  text-decoration: underline;
+}
+
+.title,
+.description {
+  text-align: center;
+}
+
+.description {
+  margin: 4rem 0;
+  line-height: 1.5;
+  font-size: 1.5rem;
+}
+
+.code {
+  background: #fafafa;
+  border-radius: 5px;
+  padding: 0.75rem;
+  font-size: 1.1rem;
+  font-family: Menlo, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono,
+    Bitstream Vera Sans Mono, Courier New, monospace;
+}
+
+.grid {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  flex-wrap: wrap;
+  max-width: 1200px;
+}
+
+.card {
+  margin: 1rem;
+  padding: 1.5rem;
+  text-align: left;
+  color: inherit;
+  text-decoration: none;
+  border: 1px solid #eaeaea;
+  border-radius: 10px;
+  transition: color 0.15s ease, border-color 0.15s ease;
+  max-width: 300px;
+}
+
+.card:hover,
+.card:focus,
+.card:active {
+  color: #0070f3;
+  border-color: #0070f3;
+}
+
+.card h2 {
+  margin: 0 0 1rem 0;
+  font-size: 1.5rem;
+}
+
+.card p {
+  margin: 0;
+  font-size: 1.25rem;
+  line-height: 1.5;
+}
+
+.logo {
+  height: 1em;
+  margin-left: 0.5rem;
+}
+
+@media (max-width: 600px) {
+  .grid {
+    width: 100%;
+    flex-direction: column;
+  }
+}
+
+@media (prefers-color-scheme: dark) {
+  .title {
+    background: linear-gradient(180deg, #ffffff 0%, #aaaaaa 100%);
+    -webkit-background-clip: text;
+    -webkit-text-fill-color: transparent;
+    background-clip: text;
+    text-fill-color: transparent;
+  }
+  .title a {
+    background: linear-gradient(180deg, #0070f3 0%, #0153af 100%);
+    -webkit-background-clip: text;
+    -webkit-text-fill-color: transparent;
+    background-clip: text;
+    text-fill-color: transparent;
+  }
+  .card,
+  .footer {
+    border-color: #222;
+  }
+  .code {
+    background: #111;
+  }
+  .logo img {
+    filter: invert(1);
+  }
+}

examples/caching/with-nextjs-13-server-components/app/page.tsx

@@ -0,0 +1,53 @@
+import Image from 'next/image'
+import styles from './page.module.css'
+
+export default function Home() {
+  return (
+    <div className={styles.container}>
+      <main className={styles.main}>
+        <h1 className={styles.title}>
+          Welcome to <a href="https://nextjs.org">Next.js 13!</a>
+        </h1>
+
+        <p className={styles.description}>
+          Get started by editing <code className={styles.code}>app/page.tsx</code>
+        </p>
+
+        <div className={styles.grid}>
+          <a href="https://beta.nextjs.org/docs" className={styles.card}>
+            <h2>Documentation &rarr;</h2>
+            <p>Find in-depth information about Next.js 13</p>
+          </a>
+
+          <a href="https://github.com/vercel/next.js/tree/canary/examples" className={styles.card}>
+            <h2>Examples &rarr;</h2>
+            <p>Explore the Next.js 13 playground.</p>
+          </a>
+
+          <a
+            href="https://vercel.com/templates/next.js/app-directory?utm_source=create-next-app&utm_medium=default-template&utm_campaign=create-next-app"
+            target="_blank"
+            rel="noopener noreferrer"
+            className={styles.card}
+          >
+            <h2>Deploy &rarr;</h2>
+            <p>Deploy your Next.js site to a public URL with Vercel.</p>
+          </a>
+        </div>
+      </main>
+
+      <footer className={styles.footer}>
+        <a
+          href="https://vercel.com?utm_source=create-next-app&utm_medium=default-template&utm_campaign=create-next-app"
+          target="_blank"
+          rel="noopener noreferrer"
+        >
+          Powered by{' '}
+          <span className={styles.logo}>
+            <Image src="/vercel.svg" alt="Vercel Logo" width={72} height={16} />
+          </span>
+        </a>
+      </footer>
+    </div>
+  )
+}

examples/caching/with-nextjs-13-server-components/app/realtime/page.tsx

@@ -0,0 +1,16 @@
+import supabase from '../../utils/supabase'
+import RealtimePosts from './realtime-posts'
+
+// do not cache this page
+export const revalidate = 0
+
+// this component fetches the current posts server-side
+// and subscribes to new posts client-side
+export default async function Realtime() {
+  const { data } = await supabase.from('posts').select('*')
+
+  // data can be passed from server components to client components
+  // this allows us to fetch the initial posts before rendering the page
+  // our <RealtimePosts /> component will then subscribe to new posts client-side
+  return <RealtimePosts serverPosts={data} />
+}

examples/caching/with-nextjs-13-server-components/app/realtime/realtime-posts.tsx

@@ -0,0 +1,34 @@
+'use client'
+
+import { useEffect, useState } from 'react'
+import supabase from '../../utils/supabase'
+
+// realtime subscriptions need to be set up client-side
+// this component takes initial posts as props and automatically
+// updates when new posts are inserted into Supabase's `posts` table
+export default function RealtimePosts({ serverPosts }: { serverPosts: any }) {
+  const [posts, setPosts] = useState(serverPosts)
+
+  useEffect(() => {
+    // this overwrites `posts` any time the `serverPosts` prop changes
+    // this happens when the parent Server Component is re-rendered
+    setPosts(serverPosts)
+  }, [serverPosts])
+
+  useEffect(() => {
+    // ensure you have enabled replication on the `posts` table
+    // https://app.supabase.com/project/_/database/replication
+    const channel = supabase
+      .channel('*')
+      .on('postgres_changes', { event: 'INSERT', schema: 'public', table: 'posts' }, (payload) =>
+        setPosts((posts: any) => [...posts, payload.new])
+      )
+      .subscribe()
+
+    return () => {
+      supabase.removeChannel(channel)
+    }
+  }, [serverPosts])
+
+  return <pre>{JSON.stringify(posts, null, 2)}</pre>
+}

examples/caching/with-nextjs-13-server-components/app/server-rendered/[id]/page.tsx

@@ -0,0 +1,23 @@
+import supabase from '../../../utils/supabase'
+import { notFound } from 'next/navigation'
+
+// do not cache this page
+export const revalidate = 0
+
+export async function generateStaticParams() {
+  const { data: posts } = await supabase.from('posts').select('id')
+
+  return posts?.map(({ id }) => ({
+    id,
+  }))
+}
+
+export default async function Post({ params: { id } }: { params: { id: string } }) {
+  const { data: post } = await supabase.from('posts').select().match({ id }).single()
+
+  if (!post) {
+    notFound()
+  }
+
+  return <pre>{JSON.stringify(post, null, 2)}</pre>
+}

examples/caching/with-nextjs-13-server-components/app/server-rendered/page.tsx

@@ -0,0 +1,19 @@
+import Link from 'next/link'
+import supabase from '../../utils/supabase'
+
+// do not cache this page
+export const revalidate = 0
+
+export default async function Posts() {
+  const { data: posts } = await supabase.from('posts').select('id, title')
+
+  if (!posts) {
+    return <p>No posts found.</p>
+  }
+
+  return posts.map((post) => (
+    <p key={post.id}>
+      <Link href={`/static/${post.id}`}>{post.title}</Link>
+    </p>
+  ))
+}

examples/caching/with-nextjs-13-server-components/app/static-with-revalidation/[id]/page.tsx

@@ -0,0 +1,23 @@
+import supabase from '../../../utils/supabase'
+import { notFound } from 'next/navigation'
+
+// cache this page for 1 minute
+export const revalidate = 60
+
+export async function generateStaticParams() {
+  const { data: posts } = await supabase.from('posts').select('id')
+
+  return posts?.map(({ id }) => ({
+    id,
+  }))
+}
+
+export default async function Post({ params: { id } }: { params: { id: string } }) {
+  const { data: post } = await supabase.from('posts').select().match({ id }).single()
+
+  if (!post) {
+    notFound()
+  }
+
+  return <pre>{JSON.stringify(post, null, 2)}</pre>
+}

examples/caching/with-nextjs-13-server-components/app/static-with-revalidation/page.tsx

@@ -0,0 +1,19 @@
+import Link from 'next/link'
+import supabase from '../../utils/supabase'
+
+// cache this page for 1 minute
+export const revalidate = 60
+
+export default async function Posts() {
+  const { data: posts } = await supabase.from('posts').select('id, title')
+
+  if (!posts) {
+    return <p>No posts found.</p>
+  }
+
+  return posts.map((post) => (
+    <p key={post.id}>
+      <Link href={`/static/${post.id}`}>{post.title}</Link>
+    </p>
+  ))
+}

examples/caching/with-nextjs-13-server-components/app/static/[id]/page.tsx

@@ -0,0 +1,20 @@
+import supabase from '../../../utils/supabase'
+import { notFound } from 'next/navigation'
+
+export async function generateStaticParams() {
+  const { data: posts } = await supabase.from('posts').select('id')
+
+  return posts?.map(({ id }) => ({
+    id,
+  }))
+}
+
+export default async function Post({ params: { id } }: { params: { id: string } }) {
+  const { data: post } = await supabase.from('posts').select().match({ id }).single()
+
+  if (!post) {
+    notFound()
+  }
+
+  return <pre>{JSON.stringify(post, null, 2)}</pre>
+}

examples/caching/with-nextjs-13-server-components/app/static/page.tsx

@@ -0,0 +1,16 @@
+import Link from 'next/link'
+import supabase from '../../utils/supabase'
+
+export default async function Posts() {
+  const { data: posts } = await supabase.from('posts').select('id, title')
+
+  if (!posts) {
+    return <p>No posts found.</p>
+  }
+
+  return posts.map((post) => (
+    <p key={post.id}>
+      <Link href={`/static/${post.id}`}>{post.title}</Link>
+    </p>
+  ))
+}

examples/caching/with-nextjs-13-server-components/next.config.js

@@ -0,0 +1,8 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  experimental: {
+    appDir: true,
+  },
+}
+
+module.exports = nextConfig

examples/caching/with-nextjs-13-server-components/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "next13",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint"
+  },
+  "dependencies": {
+    "@supabase/supabase-js": "^2.1.0",
+    "@types/node": "18.11.9",
+    "@types/react": "18.0.25",
+    "@types/react-dom": "18.0.9",
+    "eslint": "8.27.0",
+    "eslint-config-next": "13.0.3",
+    "next": "13.0.3",
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
+    "typescript": "4.8.4"
+  }
+}

examples/caching/with-nextjs-13-server-components/pages/api/hello.ts

@@ -0,0 +1,10 @@
+// Next.js API route support: https://nextjs.org/docs/api-routes/introduction
+import type { NextApiRequest, NextApiResponse } from 'next'
+
+type Data = {
+  name: string
+}
+
+export default function handler(req: NextApiRequest, res: NextApiResponse<Data>) {
+  res.status(200).json({ name: 'John Doe' })
+}

examples/caching/with-nextjs-13-server-components/public/vercel.svg

@@ -0,0 +1,4 @@
+<svg width="283" height="64" viewBox="0 0 283 64" fill="none" 
+    xmlns="http://www.w3.org/2000/svg">
+    <path d="M141.04 16c-11.04 0-19 7.2-19 18s8.96 18 20 18c6.67 0 12.55-2.64 16.19-7.09l-7.65-4.42c-2.02 2.21-5.09 3.5-8.54 3.5-4.79 0-8.86-2.5-10.37-6.5h28.02c.22-1.12.35-2.28.35-3.5 0-10.79-7.96-17.99-19-17.99zm-9.46 14.5c1.25-3.99 4.67-6.5 9.45-6.5 4.79 0 8.21 2.51 9.45 6.5h-18.9zM248.72 16c-11.04 0-19 7.2-19 18s8.96 18 20 18c6.67 0 12.55-2.64 16.19-7.09l-7.65-4.42c-2.02 2.21-5.09 3.5-8.54 3.5-4.79 0-8.86-2.5-10.37-6.5h28.02c.22-1.12.35-2.28.35-3.5 0-10.79-7.96-17.99-19-17.99zm-9.45 14.5c1.25-3.99 4.67-6.5 9.45-6.5 4.79 0 8.21 2.51 9.45 6.5h-18.9zM200.24 34c0 6 3.92 10 10 10 4.12 0 7.21-1.87 8.8-4.92l7.68 4.43c-3.18 5.3-9.14 8.49-16.48 8.49-11.05 0-19-7.2-19-18s7.96-18 19-18c7.34 0 13.29 3.19 16.48 8.49l-7.68 4.43c-1.59-3.05-4.68-4.92-8.8-4.92-6.07 0-10 4-10 10zm82.48-29v46h-9V5h9zM36.95 0L73.9 64H0L36.95 0zm92.38 5l-27.71 48L73.91 5H84.3l17.32 30 17.32-30h10.39zm58.91 12v9.69c-1-.29-2.06-.49-3.2-.49-5.81 0-10 4-10 10V51h-9V17h9v9.2c0-5.08 5.91-9.2 13.2-9.2z" fill="#000"/>
+</svg>

examples/caching/with-nextjs-13-server-components/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "incremental": true,
+    "plugins": [
+      {
+        "name": "next"
+      }
+    ]
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "exclude": ["node_modules"]
+}

examples/caching/with-nextjs-13-server-components/utils/supabase.ts

@@ -0,0 +1,6 @@
+import { createClient } from '@supabase/supabase-js'
+
+export default createClient(
+  process.env.NEXT_PUBLIC_SUPABASE_URL!,
+  process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!
+)