Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

feat(docs): route docs page feedback comments to Postgres (#46941)

Taha Le Brasde76c83238d3
diff --git a/apps/docs/components/Feedback/Feedback.tsx b/apps/docs/components/Feedback/Feedback.tsx
index ba4afd00ace..fc72544687e 100644
--- a/apps/docs/components/Feedback/Feedback.tsx
+++ b/apps/docs/components/Feedback/Feedback.tsx
@@ -2,9 +2,8 @@
import { createClient } from '@supabase/supabase-js'
import { IS_PLATFORM } from '~/lib/constants'
-import { useSendFeedbackMutation } from '~/lib/fetch/feedback'
import { useSendTelemetryEvent } from '~/lib/telemetry'
-import { useConstant, useIsLoggedIn, type Database } from 'common'
+import { gotrueClient, useConstant, useIsLoggedIn, type Database } from 'common'
import { Check, MessageSquareQuote, X } from 'lucide-react'
import { usePathname } from 'next/navigation'
import {
@@ -17,7 +16,7 @@ import {
} from 'react'
import { Button, cn } from 'ui'
-import { getLinearTeam, getSanitizedTabParams } from './Feedback.utils'
+import { getSanitizedTabParams, updateDocsFeedbackComment } from './Feedback.utils'
import { FeedbackModal, type FeedbackFields } from './FeedbackModal'
const FeedbackButton = forwardRef<
@@ -78,15 +77,20 @@ function Feedback({ className }: { className?: string }) {
const pathname = usePathname() ?? ''
const sendTelemetryEvent = useSendTelemetryEvent()
- const { mutate: sendFeedbackComment } = useSendFeedbackMutation()
const supabase = useConstant(() =>
IS_PLATFORM
? createClient<Database>(
process.env.NEXT_PUBLIC_SUPABASE_URL!,
- process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!
+ process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!,
+ {
+ accessToken: async () =>
+ (await gotrueClient.getSession()).data.session?.access_token ?? null,
+ }
)
: undefined
)
+ const isLoggedIn = useIsLoggedIn()
+ const feedbackInsertRef = useRef<Promise<number | null> | null>(null)
const unanswered = state.type === 'unanswered'
const isYes = 'response' in state && state.response === 'yes'
@@ -94,17 +98,26 @@ function Feedback({ className }: { className?: string }) {
const showYes = unanswered || isYes
const showNo = unanswered || isNo
- async function sendFeedbackVote(response: Response) {
- if (!supabase) return
-
- const { error } = await supabase.from('feedback').insert({
- vote: response,
- page: pathname,
- metadata: {
- query: getSanitizedTabParams(),
- },
- })
- if (error) console.error(error)
+ // Returns the new row's id for logged-in users (who can read their own row
+ // back) so an optional comment can be attached afterwards. Anonymous votes are
+ // insert-only and resolve to null.
+ async function sendFeedbackVote(response: Response): Promise<number | null> {
+ if (!supabase) return null
+
+ const row = { vote: response, page: pathname, metadata: { query: getSanitizedTabParams() } }
+
+ if (isLoggedIn) {
+ const { data, error } = await supabase.from('feedback').insert(row).select('id').single()
+ if (error) {
+ console.error(error)
+ return null
+ }
+ return data.id
+ } else {
+ const { error } = await supabase.from('feedback').insert(row)
+ if (error) console.error(error)
+ return null
+ }
}
function handleVote(response: Response) {
@@ -112,7 +125,7 @@ function Feedback({ className }: { className?: string }) {
action: 'docs_feedback_clicked',
properties: { response },
})
- sendFeedbackVote(response)
+ feedbackInsertRef.current = sendFeedbackVote(response)
dispatch({ event: 'VOTED', response })
// Focus so screen reader users are aware of the new element
setTimeout(() => {
@@ -128,15 +141,14 @@ function Feedback({ className }: { className?: string }) {
}, 100)
}
- async function handleSubmit({ page, comment, title }: FeedbackFields) {
- sendFeedbackComment({
- message: comment,
- pathname: page,
- title,
- // @ts-expect-error -- can't click this button without having a state.response
- isHelpful: state.response === 'yes',
- team: getLinearTeam(pathname),
- })
+ async function handleSubmit({ comment, title }: FeedbackFields) {
+ // Wait for the vote insert so the comment update can't run before the row
+ // (and its id) exists.
+ const id = await feedbackInsertRef.current
+ if (supabase && id !== null) {
+ const { error } = await updateDocsFeedbackComment(supabase, { id, title, comment })
+ if (error) console.error(error)
+ }
setModalOpen(false)
refocusButton()
}
diff --git a/apps/docs/components/Feedback/Feedback.utils.test.ts b/apps/docs/components/Feedback/Feedback.utils.test.ts
new file mode 100644
index 00000000000..ab1a600894a
--- /dev/null
+++ b/apps/docs/components/Feedback/Feedback.utils.test.ts
@@ -0,0 +1,25 @@
+import { describe, expect, it, vi } from 'vitest'
+
+import { updateDocsFeedbackComment } from './Feedback.utils'
+
+describe('updateDocsFeedbackComment', () => {
+ it('updates the feedback row by id with the comment', async () => {
+ const eq = vi.fn().mockResolvedValue({ error: null })
+ const update = vi.fn(() => ({ eq }))
+ const from = vi.fn(() => ({ update }))
+ const supabase = { from } as any
+
+ await updateDocsFeedbackComment(supabase, {
+ id: 42,
+ title: 'Great explanation',
+ comment: 'This page was really helpful.',
+ })
+
+ expect(from).toHaveBeenCalledWith('feedback')
+ expect(update).toHaveBeenCalledWith({
+ title: 'Great explanation',
+ comment: 'This page was really helpful.',
+ })
+ expect(eq).toHaveBeenCalledWith('id', 42)
+ })
+})
diff --git a/apps/docs/components/Feedback/Feedback.utils.ts b/apps/docs/components/Feedback/Feedback.utils.ts
index c93ebb55715..16b6ebf18ce 100644
--- a/apps/docs/components/Feedback/Feedback.utils.ts
+++ b/apps/docs/components/Feedback/Feedback.utils.ts
@@ -1,45 +1,18 @@
+import type { SupabaseClient } from '@supabase/supabase-js'
+import type { Database } from 'common'
import { pick } from 'lodash-es'
-/**
- * Gets the Notion team to send feedback to based on the pathname.
- */
-const getLinearTeam = (pathname: string) => {
- const DEFAULT_TEAM = 'Docs'
-
- // Pathname has format `/guides/(team)/**`
- const pathParts = pathname.split('/')
-
- if (pathParts[1] !== 'guides' || !pathParts[2]) return DEFAULT_TEAM
-
- switch (pathParts[2]) {
- case 'database':
- return 'Postgres'
- case 'auth':
- return 'Auth'
- case 'storage':
- return 'Storage'
- case 'functions':
- return 'Functions'
- case 'realtime':
- return 'Realtime'
- case 'ai':
- return 'AI'
- case 'local-development':
- case 'self-hosting':
- case 'deployment':
- return 'Dev Workflows'
- case 'integrations':
- return 'API'
- case 'security':
- return 'Security'
- case 'platform':
- case 'monitoring-troubleshooting':
- return 'Infra'
- default:
- return DEFAULT_TEAM
- }
+type FeedbackComment = {
+ id: number
+ title: string
+ comment: string
}
+const updateDocsFeedbackComment = (
+ supabase: SupabaseClient<Database>,
+ { id, title, comment }: FeedbackComment
+) => supabase.from('feedback').update({ title, comment }).eq('id', id)
+
/**
* Gets the tab selection state from the URL search params.
*
@@ -53,4 +26,4 @@ const getSanitizedTabParams = () => {
return pick(Object.fromEntries(searchParams.entries()), queryGroups)
}
-export { getLinearTeam, getSanitizedTabParams }
+export { updateDocsFeedbackComment, getSanitizedTabParams }
diff --git a/apps/docs/lib/fetch/feedback.ts b/apps/docs/lib/fetch/feedback.ts
deleted file mode 100644
index 8bafd80ff59..00000000000
--- a/apps/docs/lib/fetch/feedback.ts
+++ /dev/null
@@ -1,50 +0,0 @@
-import { type UseMutationOptions, useMutation } from '@tanstack/react-query'
-
-import { type ResponseError } from '~/types/fetch'
-import { post } from './fetchWrappers'
-
-type SendFeedbackVariables = {
- title: string
- message: string
- isHelpful: boolean
- pathname?: string
- team?: string
-}
-
-export async function sendFeedback({
- message,
- pathname,
- title,
- isHelpful,
- team,
-}: SendFeedbackVariables) {
- const { data, error } = await post('/platform/feedback/docs', {
- body: {
- page: pathname ?? '',
- isHelpful,
- title,
- feedback: message,
- team,
- },
- })
- if (error) throw Error(`Couldn't send feedback`, { cause: error })
- return data
-}
-
-type SendFeedbackData = Awaited<ReturnType<typeof sendFeedback>>
-
-export const useSendFeedbackMutation = (
- options: Omit<
- UseMutationOptions<SendFeedbackData, ResponseError, SendFeedbackVariables>,
- 'mutationFn'
- > = {}
-) => {
- return useMutation<SendFeedbackData, ResponseError, SendFeedbackVariables>({
- ...options,
- mutationFn: (vars) => sendFeedback(vars),
- onError: (error, vars, ctx) => {
- console.error(error)
- options.onError?.(error, vars, ctx)
- },
- })
-}
diff --git a/packages/common/database-types.ts b/packages/common/database-types.ts
index 1fe0d208dc7..cb90d269de9 100644
--- a/packages/common/database-types.ts
+++ b/packages/common/database-types.ts
@@ -129,24 +129,33 @@ export type Database = {
Tables: {
feedback: {
Row: {
+ comment: string | null
date_created: string
id: number
metadata: Json | null
page: string
+ title: string | null
+ user_id: string | null
vote: Database['public']['Enums']['feedback_vote']
}
Insert: {
+ comment?: string | null
date_created?: string
id?: never
metadata?: Json | null
page: string
+ title?: string | null
+ user_id?: string | null
vote: Database['public']['Enums']['feedback_vote']
}
Update: {
+ comment?: string | null
date_created?: string
id?: never
metadata?: Json | null
page?: string
+ title?: string | null
+ user_id?: string | null
vote?: Database['public']['Enums']['feedback_vote']
}
Relationships: []
diff --git a/supabase/migrations/20260616074454_add_docs_feedback_comment.sql b/supabase/migrations/20260616074454_add_docs_feedback_comment.sql
new file mode 100644
index 00000000000..f6934732170
--- /dev/null
+++ b/supabase/migrations/20260616074454_add_docs_feedback_comment.sql
@@ -0,0 +1,17 @@
+alter table feedback
+ add column user_id uuid default auth.uid(),
+ add column title text,
+ add column comment text;
+
+create policy "Users can read their own feedback"
+on feedback
+as permissive for select
+to authenticated
+using ((select auth.uid()) = user_id);
+
+create policy "Users can update their own feedback"
+on feedback
+as permissive for update
+to authenticated
+using ((select auth.uid()) = user_id)
+with check ((select auth.uid()) = user_id);