Skip to content

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

fix: Update roles in query performance to make them less confusing (#41828)

Ali Waseem52587d49e9c4
diff --git a/apps/studio/components/interfaces/QueryPerformance/QueryPerformanceFilterBar.tsx b/apps/studio/components/interfaces/QueryPerformance/QueryPerformanceFilterBar.tsx
index a692bd1c2c9..a1208c6673d 100644
--- a/apps/studio/components/interfaces/QueryPerformance/QueryPerformanceFilterBar.tsx
+++ b/apps/studio/components/interfaces/QueryPerformance/QueryPerformanceFilterBar.tsx
@@ -1,19 +1,17 @@
-import { useDebounce } from '@uidotdev/usehooks'
-import { Lightbulb, Search, X } from 'lucide-react'
import { parseAsArrayOf, parseAsJson, parseAsString, useQueryStates } from 'nuqs'
-import { ChangeEvent, ReactNode, useEffect, useState } from 'react'
+import { ReactNode, useEffect, useState } from 'react'
import {
NumericFilter,
ReportsNumericFilter,
} from 'components/interfaces/Reports/v2/ReportsNumericFilter'
-import { FilterPopover } from 'components/ui/FilterPopover'
-import { useDatabaseRolesQuery } from 'data/database-roles/database-roles-query'
-import { useSelectedProjectQuery } from 'hooks/misc/useSelectedProject'
-import { Button, Tooltip, TooltipContent, TooltipTrigger, cn } from 'ui'
-import { Input } from 'ui-patterns/DataInputs/Input'
+import { FilterInput } from './components/FilterInput'
+import { IndexAdvisorFilter } from './components/IndexAdvisorFilter'
+import { RolesFilterDropdown } from './components/RolesFilterDropdown'
+import { SortIndicator } from './components/SortIndicator'
import { useIndexAdvisorStatus } from './hooks/useIsIndexAdvisorStatus'
import { useQueryPerformanceSort } from './hooks/useQueryPerformanceSort'
+import { useDebouncedValue } from 'hooks/misc/useDebouncedValue'
export const QueryPerformanceFilterBar = ({
actions,
@@ -22,7 +20,6 @@ export const QueryPerformanceFilterBar = ({
actions?: ReactNode
showRolesFilter?: boolean
}) => {
- const { data: project } = useSelectedProjectQuery()
const { sort, clearSort } = useQueryPerformanceSort()
const { isIndexAdvisorEnabled } = useIndexAdvisorStatus()
@@ -38,19 +35,11 @@ export const QueryPerformanceFilterBar = ({
} as NumericFilter),
indexAdvisor: parseAsString.withDefault('false'),
})
- const { data, isPending: isLoadingRoles } = useDatabaseRolesQuery({
- projectRef: project?.ref,
- connectionString: project?.connectionString,
- })
- const roles = (data ?? []).sort((a, b) => a.name.localeCompare(b.name))
const [filters, setFilters] = useState<{ roles: string[] }>({
roles: defaultFilterRoles,
})
const [inputValue, setInputValue] = useState(searchQuery)
- const debouncedInputValue = useDebounce(inputValue, 500)
- // const debouncedMinCalls = useDebounce(minCallsInput, 300)
- const searchValue = inputValue.length === 0 ? inputValue : debouncedInputValue
const onSearchQueryChange = (value: string) => {
setSearchParams({ search: value || '' })
@@ -61,47 +50,22 @@ export const QueryPerformanceFilterBar = ({
setSearchParams({ roles })
}
- const onIndexAdvisorChange = (options: string[]) => {
- setSearchParams({ indexAdvisor: options.includes('true') ? 'true' : 'false' })
- }
+ const debouncedInputValue = useDebouncedValue(inputValue, 300)
const onIndexAdvisorToggle = () => {
setSearchParams({ indexAdvisor: indexAdvisor === 'true' ? 'false' : 'true' })
}
useEffect(() => {
- onSearchQueryChange(searchValue)
+ onSearchQueryChange(debouncedInputValue)
// eslint-disable-next-line react-hooks/exhaustive-deps
- }, [searchValue])
-
- const indexAdvisorOptions = [{ value: 'true', label: 'Index Advisor' }]
+ }, [debouncedInputValue])
return (
<div className="px-4 py-1.5 bg-surface-200 border-t -mt-px flex justify-between items-center overflow-x-auto overflow-y-hidden w-full flex-shrink-0">
<div className="flex items-center gap-x-4">
<div className="flex items-center gap-x-2">
- <Input
- size="tiny"
- autoComplete="off"
- icon={<Search />}
- value={inputValue}
- onChange={(e: ChangeEvent<HTMLInputElement>) => setInputValue(e.target.value)}
- name="keyword"
- id="keyword"
- placeholder="Filter by query"
- className="w-56"
- actions={[
- inputValue && (
- <Button
- size="tiny"
- type="text"
- icon={<X />}
- onClick={() => setInputValue('')}
- className="p-0 h-5 w-5"
- />
- ),
- ]}
- />
+ <FilterInput value={inputValue} onChange={setInputValue} />
<ReportsNumericFilter
label="Calls"
@@ -115,48 +79,20 @@ export const QueryPerformanceFilterBar = ({
/>
{showRolesFilter && (
- <FilterPopover
- name="Roles"
- options={roles}
- labelKey="name"
- valueKey="name"
- activeOptions={isLoadingRoles ? [] : filters.roles}
+ <RolesFilterDropdown
+ activeOptions={filters.roles}
onSaveFilters={onFilterRolesChange}
- className="w-56"
/>
)}
{isIndexAdvisorEnabled && (
- <Button
- type={indexAdvisor === 'true' ? 'default' : 'outline'}
- size="tiny"
- className={cn(indexAdvisor === 'true' ? 'bg-surface-300' : 'border-dashed')}
- onClick={onIndexAdvisorToggle}
- iconRight={indexAdvisor === 'true' ? <X size={14} /> : undefined}
- >
- <span className="flex items-center gap-x-2">
- <Lightbulb
- size={12}
- className={indexAdvisor === 'true' ? 'text-warning' : 'text-foreground-lighter'}
- />
- <span>Index Advisor</span>
- </span>
- </Button>
+ <IndexAdvisorFilter
+ isActive={indexAdvisor === 'true'}
+ onToggle={onIndexAdvisorToggle}
+ />
)}
- {sort && (
- <div className="text-xs border rounded-md px-1.5 md:px-2.5 py-1 h-[26px] flex items-center gap-x-2">
- <p className="md:inline-flex gap-x-1 hidden truncate">
- Sort: {sort.column} <span className="text-foreground-lighter">{sort.order}</span>
- </p>
- <Tooltip>
- <TooltipTrigger onClick={clearSort}>
- <X size={14} className="text-foreground-light hover:text-foreground" />
- </TooltipTrigger>
- <TooltipContent side="bottom">Clear sort</TooltipContent>
- </Tooltip>
- </div>
- )}
+ {sort && <SortIndicator sort={sort} onClearSort={clearSort} />}
</div>
</div>
<div className="flex gap-2 items-center pl-2">{actions}</div>
diff --git a/apps/studio/components/interfaces/QueryPerformance/components/FilterInput.tsx b/apps/studio/components/interfaces/QueryPerformance/components/FilterInput.tsx
new file mode 100644
index 00000000000..4ea5ef34c40
--- /dev/null
+++ b/apps/studio/components/interfaces/QueryPerformance/components/FilterInput.tsx
@@ -0,0 +1,38 @@
+import { Search, X } from 'lucide-react'
+
+import { Button } from 'ui'
+import { Input } from 'ui-patterns/DataInputs/Input'
+
+interface FilterInputProps {
+ value: string
+ onChange: (value: string) => void
+ placeholder?: string
+ className?: string
+}
+
+export const FilterInput = ({ value, onChange, placeholder, className }: FilterInputProps) => {
+ return (
+ <Input
+ size="tiny"
+ autoComplete="off"
+ icon={<Search />}
+ value={value}
+ onChange={(e) => onChange(e.target.value)}
+ name="keyword"
+ id="keyword"
+ placeholder={placeholder || 'Filter by query'}
+ className={className || 'w-56'}
+ actions={[
+ value && (
+ <Button
+ size="tiny"
+ type="text"
+ icon={<X />}
+ onClick={() => onChange('')}
+ className="p-0 h-5 w-5"
+ />
+ ),
+ ]}
+ />
+ )
+}
diff --git a/apps/studio/components/interfaces/QueryPerformance/components/IndexAdvisorFilter.tsx b/apps/studio/components/interfaces/QueryPerformance/components/IndexAdvisorFilter.tsx
new file mode 100644
index 00000000000..b9d3823c4ea
--- /dev/null
+++ b/apps/studio/components/interfaces/QueryPerformance/components/IndexAdvisorFilter.tsx
@@ -0,0 +1,24 @@
+import { Lightbulb, X } from 'lucide-react'
+import { Button, cn } from 'ui'
+
+interface IndexAdvisorFilterProps {
+ isActive: boolean
+ onToggle: () => void
+}
+
+export const IndexAdvisorFilter = ({ isActive, onToggle }: IndexAdvisorFilterProps) => {
+ return (
+ <Button
+ type={isActive ? 'default' : 'outline'}
+ size="tiny"
+ className={cn(isActive ? 'bg-surface-300' : 'border-dashed')}
+ onClick={onToggle}
+ iconRight={isActive ? <X size={14} /> : undefined}
+ >
+ <span className="flex items-center gap-x-2">
+ <Lightbulb size={12} className={isActive ? 'text-warning' : 'text-foreground-lighter'} />
+ <span>Index Advisor</span>
+ </span>
+ </Button>
+ )
+}
diff --git a/apps/studio/components/interfaces/QueryPerformance/components/RoleTooltip.tsx b/apps/studio/components/interfaces/QueryPerformance/components/RoleTooltip.tsx
new file mode 100644
index 00000000000..30964c3cff9
--- /dev/null
+++ b/apps/studio/components/interfaces/QueryPerformance/components/RoleTooltip.tsx
@@ -0,0 +1,33 @@
+import { cn } from 'ui'
+import { Tooltip, TooltipContent, TooltipTrigger } from 'ui'
+
+interface RoleTooltipProps {
+ htmlFor: string
+ label: string
+ description?: string
+ className?: string
+}
+
+export const RoleTooltip = ({ htmlFor, label, description, className }: RoleTooltipProps) => {
+ const labelElement = (
+ <label
+ htmlFor={htmlFor}
+ className={cn('flex items-center gap-x-2 text-xs cursor-pointer', className)}
+ >
+ <span>{label}</span>
+ </label>
+ )
+
+ if (!description) {
+ return labelElement
+ }
+
+ return (
+ <Tooltip>
+ <TooltipTrigger asChild>{labelElement}</TooltipTrigger>
+ <TooltipContent side="right">
+ <p className="text-xs max-w-xs">{description}</p>
+ </TooltipContent>
+ </Tooltip>
+ )
+}
diff --git a/apps/studio/components/interfaces/QueryPerformance/components/RolesFilterDropdown.tsx b/apps/studio/components/interfaces/QueryPerformance/components/RolesFilterDropdown.tsx
new file mode 100644
index 00000000000..13903c5247a
--- /dev/null
+++ b/apps/studio/components/interfaces/QueryPerformance/components/RolesFilterDropdown.tsx
@@ -0,0 +1,35 @@
+import { FilterPopover } from 'components/ui/FilterPopover'
+import { RoleTooltip } from './RoleTooltip'
+import { useRolesFilter, type RoleWithDescription } from '../hooks/useRolesFilter'
+
+interface RolesFilterDropdownProps {
+ activeOptions: string[]
+ onSaveFilters: (options: string[]) => void
+ className?: string
+}
+
+export const RolesFilterDropdown = ({
+ activeOptions,
+ onSaveFilters,
+ className,
+}: RolesFilterDropdownProps) => {
+ const { roles, roleGroups, isLoadingRoles } = useRolesFilter()
+
+ const renderLabel = (option: RoleWithDescription, value: string) => (
+ <RoleTooltip htmlFor={value} label={option.displayName} description={option.description} />
+ )
+
+ return (
+ <FilterPopover
+ name="Roles"
+ options={roles}
+ labelKey="displayName"
+ valueKey="name"
+ activeOptions={isLoadingRoles ? [] : activeOptions}
+ onSaveFilters={onSaveFilters}
+ className={className || 'w-60'}
+ groups={roleGroups}
+ renderLabel={renderLabel}
+ />
+ )
+}
diff --git a/apps/studio/components/interfaces/QueryPerformance/components/SortIndicator.tsx b/apps/studio/components/interfaces/QueryPerformance/components/SortIndicator.tsx
new file mode 100644
index 00000000000..65de8f26a21
--- /dev/null
+++ b/apps/studio/components/interfaces/QueryPerformance/components/SortIndicator.tsx
@@ -0,0 +1,24 @@
+import { X } from 'lucide-react'
+
+import { Tooltip, TooltipContent, TooltipTrigger } from 'ui'
+
+interface SortIndicatorProps {
+ sort: { column: string; order: string }
+ onClearSort: () => void
+}
+
+export const SortIndicator = ({ sort, onClearSort }: SortIndicatorProps) => {
+ return (
+ <div className="text-xs border rounded-md px-1.5 md:px-2.5 py-1 h-[26px] flex items-center gap-x-2">
+ <p className="md:inline-flex gap-x-1 hidden truncate">
+ Sort: {sort.column} <span className="text-foreground-lighter">{sort.order}</span>
+ </p>
+ <Tooltip>
+ <TooltipTrigger onClick={onClearSort}>
+ <X size={14} className="text-foreground-light hover:text-foreground" />
+ </TooltipTrigger>
+ <TooltipContent side="bottom">Clear sort</TooltipContent>
+ </Tooltip>
+ </div>
+ )
+}
diff --git a/apps/studio/components/interfaces/QueryPerformance/constants/roles.ts b/apps/studio/components/interfaces/QueryPerformance/constants/roles.ts
new file mode 100644
index 00000000000..1c7f8d0a3b1
--- /dev/null
+++ b/apps/studio/components/interfaces/QueryPerformance/constants/roles.ts
@@ -0,0 +1,83 @@
+export type KnownRole =
+ | 'anon'
+ | 'authenticated'
+ | 'service_role'
+ | 'postgres'
+ | 'authenticator'
+ | 'supabase_auth_admin'
+ | 'supabase_storage_admin'
+ | 'supabase_etl_admin'
+ | 'supabase_realtime_admin'
+ | 'supabase_replication_admin'
+ | 'supabase_read_only_user'
+ | 'dashboard_user'
+ | 'supabase_admin'
+
+export const APP_ACCESS_ROLES: KnownRole[] = ['anon', 'authenticated', 'service_role'] as const
+export const SUPABASE_SYSTEM_ROLES: KnownRole[] = [
+ 'postgres',
+ 'authenticator',
+ 'supabase_auth_admin',
+ 'supabase_storage_admin',
+ 'supabase_etl_admin',
+ 'supabase_realtime_admin',
+ 'supabase_replication_admin',
+ 'supabase_read_only_user',
+ 'dashboard_user',
+ 'supabase_admin',
+] as const
+
+export type RoleInfo = {
+ displayName: string
+}
+
+export const ROLE_INFO: Record<KnownRole, RoleInfo> = {
+ anon: {
+ displayName: 'Anonymous (Logged Out)',
+ },
+ authenticated: {
+ displayName: 'Authenticated (Logged In)',
+ },
+ service_role: {
+ displayName: 'Service Role',
+ },
+ postgres: {
+ displayName: 'Postgres',
+ },
+ authenticator: {
+ displayName: 'Authenticator',
+ },
+ supabase_auth_admin: {
+ displayName: 'Auth Admin',
+ },
+ supabase_storage_admin: {
+ displayName: 'Storage Admin',
+ },
+ supabase_etl_admin: {
+ displayName: 'ETL Admin',
+ },
+ supabase_realtime_admin: {
+ displayName: 'Realtime Admin',
+ },
+ supabase_replication_admin: {
+ displayName: 'Replication Admin',
+ },
+ supabase_read_only_user: {
+ displayName: 'Read-Only User',
+ },
+ dashboard_user: {
+ displayName: 'Dashboard User',
+ },
+ supabase_admin: {
+ displayName: 'Supabase Admin',
+ },
+}
+
+export function isKnownRole(role: string): role is KnownRole {
+ return role in ROLE_INFO
+}
+
+export type RoleGroup = {
+ name: string
+ options: string[]
+}
diff --git a/apps/studio/components/interfaces/QueryPerformance/hooks/useRolesFilter.ts b/apps/studio/components/interfaces/QueryPerformance/hooks/useRolesFilter.ts
new file mode 100644
index 00000000000..c6f939b3c1d
--- /dev/null
+++ b/apps/studio/components/interfaces/QueryPerformance/hooks/useRolesFilter.ts
@@ -0,0 +1,64 @@
+import { useMemo } from 'react'
+
+import { useDatabaseRolesQuery } from 'data/database-roles/database-roles-query'
+import { useSelectedProjectQuery } from 'hooks/misc/useSelectedProject'
+
+import {
+ APP_ACCESS_ROLES,
+ isKnownRole,
+ ROLE_INFO,
+ RoleGroup,
+ SUPABASE_SYSTEM_ROLES,
+ type KnownRole,
+} from '../constants/roles'
+
+export type RoleWithDescription = {
+ name: string
+ displayName: string
+ description?: string
+}
+
+export const useRolesFilter = () => {
+ const { data: project } = useSelectedProjectQuery()
+ const { data, isPending: isLoadingRoles } = useDatabaseRolesQuery({
+ projectRef: project?.ref,
+ connectionString: project?.connectionString,
+ })
+
+ const appAccessRolesSet = useMemo(() => new Set(APP_ACCESS_ROLES) as Set<string>, [])
+ const supabaseSystemRolesSet = useMemo(() => new Set(SUPABASE_SYSTEM_ROLES) as Set<string>, [])
+
+ const roles = useMemo((): RoleWithDescription[] => {
+ return (data ?? [])
+ .sort((a, b) => a.name.localeCompare(b.name))
+ .map((role) => ({
+ ...role,
+ displayName: isKnownRole(role.name) ? ROLE_INFO[role.name].displayName : role.name,
+ }))
+ }, [data])
+
+ const roleGroups = useMemo((): RoleGroup[] => {
+ return [
+ {
+ name: 'User Access',
+ options: roles.filter((r) => appAccessRolesSet.has(r.name)).map((r) => r.name),
+ },
+ {
+ name: 'System and Services',
+ options: roles.filter((r) => supabaseSystemRolesSet.has(r.name)).map((r) => r.name),
+ },
+ {
+ name: 'Custom',
+ options: roles
+ .filter((r) => !appAccessRolesSet.has(r.name) && !supabaseSystemRolesSet.has(r.name))
+ .map((r) => r.name),
+ },
+ ]
+ }, [appAccessRolesSet, roles, supabaseSystemRolesSet])
+
+ return {
+ roles,
+ roleGroups,
+ isLoadingRoles,
+ }
+}
diff --git a/apps/studio/components/ui/FilterPopover.tsx b/apps/studio/components/ui/FilterPopover.tsx
index c2804fa1a70..317b3d1b607 100644
--- a/apps/studio/components/ui/FilterPopover.tsx
+++ b/apps/studio/components/ui/FilterPopover.tsx
@@ -12,6 +12,9 @@ import {
PopoverContent_Shadcn_,
PopoverTrigger_Shadcn_,
ScrollArea,
+ Tooltip,
+ TooltipContent,
+ TooltipTrigger,
} from 'ui'
import { Input } from 'ui-patterns/DataInputs/Input'
import { ShimmeringLoader } from 'ui-patterns/ShimmeringLoader'
@@ -42,6 +45,13 @@ interface FilterPopoverProps<T> {
isFetching?: boolean
isFetchingNextPage?: boolean
fetchNextPage?: () => void
+
+ // Support for grouped options with separators
+ groupKey?: keyof T
+ groups?: Array<{ name: string; options: string[] }>
+
+ // Support for custom label rendering (e.g., for tooltips)
+ renderLabel?: (option: T, value: string) => React.ReactNode
}
// [Joshen] Known issue currently that FilterPopover trigger label will not show selected options properly
@@ -72,10 +82,58 @@ export const FilterPopover = <T extends Record<string, any>>({
isFetching = false,
isFetchingNextPage = false,
fetchNextPage = noop,
+ groups,
+ renderLabel,
}: FilterPopoverProps<T>) => {
const [open, setOpen] = useState(false)
const [selectedOptions, setSelectedOptions] = useState<string[]>([])
+ // Helper function to render an option
+ const renderOption = (option: T) => {
+ const value = option[valueKey]
+ const icon = iconKey ? option[iconKey] : undefined
+
+ const defaultLabel = (
+ <Label_Shadcn_
+ htmlFor={option[valueKey]}
+ className={cn('flex items-center gap-x-2 text-xs cursor-pointer', labelClass)}
+ >
+ {icon && (
+ <img src={icon} alt={option[labelKey]} className={cn('w-4 h-4', option.iconClass)} />
+ )}
+ <span>{option[labelKey]}</span>
+ </Label_Shadcn_>
+ )
+
+ const label = renderLabel ? renderLabel(option, value) : defaultLabel
+
+ return (
+ <div key={value} className="group flex items-center gap-x-2">
+ <Checkbox_Shadcn_
+ id={value}
+ checked={selectedOptions.includes(value)}
+ onCheckedChange={() => {
+ if (selectedOptions.includes(value)) {
+ setSelectedOptions(selectedOptions.filter((x) => x !== value))
+ } else {
+ setSelectedOptions(selectedOptions.concat(value))
+ }
+ }}
+ />
+ <div className="flex-1">{label}</div>
+ <button
+ className="text-xs text-foreground-lighter hover:text-foreground-muted opacity-0 group-hover:opacity-100 transition-opacity"
+ onClick={(e) => {
+ e.preventDefault()
+ setSelectedOptions([value])
+ }}
+ >
+ Only
+ </button>
+ </div>
+ )
+ }
+
const scrollRootRef = useRef<HTMLDivElement | null>(null)
const [sentinelRef, entry] = useIntersectionObserver({
root: scrollRootRef.current,
@@ -178,42 +236,28 @@ export const FilterPopover = <T extends Record<string, any>>({
)}
<ScrollArea className={options.length > 7 ? maxHeightClass : ''}>
<div className="px-3 pt-3 flex flex-col gap-y-2">
- {options.map((option) => {
- const value = option[valueKey]
- const icon = iconKey ? option[iconKey] : undefined
-
- return (
- <div
- key={value}
- className={cn('flex items-center gap-x-2', !hasNextPage && 'last:pb-3')}
- >
- <Checkbox_Shadcn_
- id={value}
- checked={selectedOptions.includes(value)}
- onCheckedChange={() => {
- if (selectedOptions.includes(value)) {
- setSelectedOptions(selectedOptions.filter((x) => x !== value))
- } else {
- setSelectedOptions(selectedOptions.concat(value))
- }
- }}
- />
- <Label_Shadcn_
- htmlFor={option[valueKey]}
- className={cn('flex items-center gap-x-2 text-xs', labelClass)}
- >
- {icon && (
- <img
- src={icon}
- alt={option[labelKey]}
- className={cn('w-4 h-4', option.iconClass)}
- />
- )}
- <span>{option[labelKey]}</span>
- </Label_Shadcn_>
- </div>
- )
- })}
+ {groups ? (
+ <>
+ {groups
+ .filter((group) => group.options.length > 0)
+ .map((group: { name: string; options: string[] }, groupIndex: number) => (
+ <div key={group.name} className={groupIndex > 0 ? 'py-2' : ''}>
+ {groupIndex > 0 && <div className="mb-2 border-t border-overlay -mx-3" />}
+ <span className="text-xs text-foreground-lighter font-medium mb-2 block">
+ {group.name}
+ </span>
+ <div className="flex flex-col gap-y-2">
+ {group.options.map((optionValue) => {
+ const option = options.find((x) => x[valueKey] === optionValue)
+ return option ? renderOption(option) : null
+ })}
+ </div>
+ </div>
+ ))}
+ </>
+ ) : (
+ options.map((option) => renderOption(option))
+ )}
</div>
<div ref={sentinelRef} className="h-1 -mt-1" />
{hasNextPage && (