The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
fix(studio): stop duplicating access_token_creation_sheet_dismissed on Done (#50077)
claude[bot]c086fe0d3fe3
diff --git a/apps/studio/components/interfaces/Account/AccessTokens/Scoped/Form/NewScopedTokenForm.tsx b/apps/studio/components/interfaces/Account/AccessTokens/Scoped/Form/NewScopedTokenForm.tsxindex 0d4cb0b02e4..1054062e337 100644--- a/apps/studio/components/interfaces/Account/AccessTokens/Scoped/Form/NewScopedTokenForm.tsx+++ b/apps/studio/components/interfaces/Account/AccessTokens/Scoped/Form/NewScopedTokenForm.tsx@@ -1,7 +1,7 @@import { zodResolver } from '@hookform/resolvers/zod'import { useReducedMotion } from 'common'import { ChevronRight, X } from 'lucide-react'-import { useEffect, useRef, useState } from 'react'+import { forwardRef, useEffect, useImperativeHandle, useRef, useState } from 'react'import { useForm, useWatch } from 'react-hook-form'import { toast } from 'sonner'import {@@ -43,21 +43,36 @@ const DEFAULT_VALUES: TokenFormValues = {permissions: {},}-export const NewScopedTokenForm = ({- isPending,- onCreateToken,- onCancel,-}: {- isPending: boolean- onCreateToken: (values: TokenFormValues) => void- onCancel: () => void-}) => {+export interface NewScopedTokenFormHandle {+ getAbandonmentContext: () => {+ resourceAccess: TokenFormValues['resourceAccess']+ formStep: 'form' | 'review'+ isFormTouched: boolean+ }+}++export const NewScopedTokenForm = forwardRef<+ NewScopedTokenFormHandle,+ {+ isPending: boolean+ onCreateToken: (values: TokenFormValues) => void+ onCancel: () => void+ }+>(({ isPending, onCreateToken, onCancel }, ref) => {const form = useForm<TokenFormValues>({resolver: zodResolver(TokenFormSchema),defaultValues: DEFAULT_VALUES,mode: 'onChange',})const [step, setStep] = useState<'form' | 'review'>('form')+ const { isDirty } = form.formState+ useImperativeHandle(ref, () => ({+ getAbandonmentContext: () => ({+ resourceAccess: form.getValues('resourceAccess'),+ formStep: step,+ isFormTouched: isDirty,+ }),+ }))const [formValues, setFormValues] = useState<TokenFormValues>(DEFAULT_VALUES)const [isCreateHintDismissed, setIsCreateHintDismissed] = useState(false)const [missingPermissionsAttempts, setMissingPermissionsAttempts] = useState(0)@@ -89,13 +104,15 @@ export const NewScopedTokenForm = ({const isReducedMotionPreferred = useReducedMotion()const isReducedMotionPreferredRef = useRef(isReducedMotionPreferred)isReducedMotionPreferredRef.current = isReducedMotionPreferred+ const onCancelRef = useRef(onCancel)+ onCancelRef.current = onCanceluseEffect(() => {if (isError) {toast.error('Something went wrong, try again')- onCancel()+ onCancelRef.current()}- }, [onCancel, isError])+ }, [isError])useEffect(() => {if (missingPermissionsAttempts === 0) return@@ -267,4 +284,6 @@ export const NewScopedTokenForm = ({</SheetFooter></>)-}+})++NewScopedTokenForm.displayName = 'NewScopedTokenForm'diff --git a/apps/studio/components/interfaces/Account/AccessTokens/Scoped/NewScopedTokenSheet.test.tsx b/apps/studio/components/interfaces/Account/AccessTokens/Scoped/NewScopedTokenSheet.test.tsxindex 4699369cdad..e76c2f11e55 100644--- a/apps/studio/components/interfaces/Account/AccessTokens/Scoped/NewScopedTokenSheet.test.tsx+++ b/apps/studio/components/interfaces/Account/AccessTokens/Scoped/NewScopedTokenSheet.test.tsx@@ -248,8 +248,90 @@ describe('NewScopedTokenSheet', () => {})// Dialog has been closedawait waitFor(() => expect(screen.queryByRole('dialog')).toBeNull())+ // Completing the flow via Done must not also emit a dismissed event+ expect(mockTrack).not.toHaveBeenCalledWith(+ 'access_token_creation_sheet_dismissed',+ expect.anything()+ )+ }, 10_000)++ test('tracks dismissal with the in-progress resourceAccess and touched state on Cancel', async () => {+ renderSheet()+ fireEvent.click(await screen.findByRole('button', { name: 'Generate new token' }))+ await screen.findByRole('dialog')+ await user.click(await screen.findByRole('radio', { name: /Organization/ }))+ fireEvent.click(await screen.findByRole('button', { name: 'Cancel' }))+ expect(mockTrack).toHaveBeenCalledWith('access_token_creation_sheet_dismissed', {+ resourceAccess: 'organization',+ formStep: 'form',+ isFormTouched: true,+ trigger: 'user',+ })+ await waitFor(() => expect(screen.queryByRole('dialog')).toBeNull())+ })++ test('tracks dismissal with the untouched default resourceAccess on Escape', async () => {+ renderSheet()+ fireEvent.click(await screen.findByRole('button', { name: 'Generate new token' }))+ const dialog = await screen.findByRole('dialog')+ fireEvent.keyDown(dialog, { key: 'Escape', code: 'Escape' })+ expect(mockTrack).toHaveBeenCalledWith('access_token_creation_sheet_dismissed', {+ resourceAccess: 'project',+ formStep: 'form',+ isFormTouched: false,+ trigger: 'user',+ })+ await waitFor(() => expect(screen.queryByRole('dialog')).toBeNull())+ })++ test('tracks the review step when the sheet is dismissed from the review screen', async () => {+ renderSheet()+ fireEvent.click(await screen.findByRole('button', { name: 'Generate new token' }))+ await screen.findByRole('dialog')+ await user.type(await screen.findByLabelText('Name'), 'test')+ fireEvent.click(await screen.findByRole('combobox', { name: 'Organization' }))+ fireEvent.click(await screen.findByRole('option', { name: 'Acme Production' }))+ fireEvent.click(await screen.findByRole('combobox', { name: 'Projects' }))+ fireEvent.click(await screen.findByRole('option', { name: 'Project 1' }))+ await expandPermissionCategory('Project')+ fireEvent.click(await screen.findByLabelText('Project Settings', { exact: false }))+ fireEvent.click(await screen.findByRole('option', { name: 'Read' }))+ fireEvent.click(await screen.findByRole('button', { name: 'Review access' }))+ await screen.findByText('Medium risk')+ fireEvent.click(await screen.findByRole('button', { name: 'Cancel' }))+ expect(mockTrack).toHaveBeenCalledWith('access_token_creation_sheet_dismissed', {+ resourceAccess: 'project',+ formStep: 'review',+ isFormTouched: true,+ trigger: 'user',+ })+ await waitFor(() => expect(screen.queryByRole('dialog')).toBeNull())}, 10_000)+ test('tracks a permissions load error as the dismissal trigger and closes the sheet', async () => {+ addAPIMock({+ method: 'get',+ // @ts-expect-error Studio API is missing from types+ path: '/scoped-access-token-permissions',+ response: () => HttpResponse.json({ message: 'unavailable' }, { status: 500 }),+ })+ renderSheet()+ fireEvent.click(await screen.findByRole('button', { name: 'Generate new token' }))+ await waitFor(() =>+ expect(mockTrack).toHaveBeenCalledWith('access_token_creation_sheet_dismissed', {+ resourceAccess: 'project',+ formStep: 'form',+ isFormTouched: false,+ trigger: 'permissions_load_error',+ })+ )+ await waitFor(() => expect(screen.queryByRole('dialog')).toBeNull())+ const dismissedCalls = mockTrack.mock.calls.filter(+ ([event]) => event === 'access_token_creation_sheet_dismissed'+ )+ expect(dismissedCalls).toHaveLength(1)+ })+// Organization scope teststest('requires an organization when scope is Organization', async () => {renderSheet()diff --git a/apps/studio/components/interfaces/Account/AccessTokens/Scoped/NewScopedTokenSheet.tsx b/apps/studio/components/interfaces/Account/AccessTokens/Scoped/NewScopedTokenSheet.tsxindex 77eca42f91f..81053bcd510 100644--- a/apps/studio/components/interfaces/Account/AccessTokens/Scoped/NewScopedTokenSheet.tsx+++ b/apps/studio/components/interfaces/Account/AccessTokens/Scoped/NewScopedTokenSheet.tsx@@ -1,4 +1,4 @@-import { useState } from 'react'+import { useRef, useState } from 'react'import { toast } from 'sonner'import {Button,@@ -12,7 +12,7 @@ import {import { selectionToScopes } from '../AccessToken.permissions'import { ExperimentalTokenDropdown } from '../Classic/ExperimentalTokenDropdown'-import { NewScopedTokenForm } from './Form/NewScopedTokenForm'+import { NewScopedTokenForm, type NewScopedTokenFormHandle } from './Form/NewScopedTokenForm'import { getExpiryDate, type TokenFormValues } from './Form/NewScopedTokenForm.utils'import { NewScopedTokenSuccess } from './Form/NewScopedTokenSuccess'import { TokenDocsButtons } from './TokenDocsButtons'@@ -35,6 +35,7 @@ interface NewScopedTokenSheetProps {export const NewScopedTokenSheet = ({ onCreateExperimentalToken }: NewScopedTokenSheetProps) => {const [isOpen, setIsOpen] = useState(false)const track = useTrack()+ const formRef = useRef<NewScopedTokenFormHandle>(null)const { mutate: createToken, isPending: isCreatingScopedToken } =useScopedAccessTokenCreateMutation()const { mutate: createClassicToken, isPending: isCreatingClassicToken } =@@ -102,21 +103,30 @@ export const NewScopedTokenSheet = ({ onCreateExperimentalToken }: NewScopedToke})}+ const trackDismissed = (trigger: 'user' | 'permissions_load_error') => {+ const abandonmentContext = formRef.current?.getAbandonmentContext()+ track('access_token_creation_sheet_dismissed', {+ resourceAccess: abandonmentContext?.resourceAccess ?? 'project',+ formStep: abandonmentContext?.formStep ?? 'form',+ isFormTouched: abandonmentContext?.isFormTouched ?? false,+ trigger,+ })+ }+// By default, if users created a token successfully, they can't click outside the sheet to close it// as we need to make sure they copied the new token firstconst handleOpenChange = (open: boolean, isSafe = false) => {if (open === false && step === 'success' && !isSafe) return- if (open === false) {- track('access_token_creation_sheet_dismissed', {- // Can be non when users closes the sheet without completing the token creation- tokenType: createdToken?.tokenType ?? 'none',- step,- })- }+ if (open === false && !isSafe) trackDismissed('user')setStep('form')setIsOpen(open)}+ const handlePermissionsLoadError = () => {+ trackDismissed('permissions_load_error')+ handleOpenChange(false, true)+ }+return (<Sheet open={isOpen} onOpenChange={handleOpenChange}><div className="flex items-center">@@ -151,9 +161,10 @@ export const NewScopedTokenSheet = ({ onCreateExperimentalToken }: NewScopedToke/>) : (<NewScopedTokenForm+ ref={formRef}isPending={isCreatingScopedToken || isCreatingClassicToken}onCreateToken={handleCreate}- onCancel={() => handleOpenChange(false, true)}+ onCancel={handlePermissionsLoadError}/>)}</SheetContent>diff --git a/packages/common/telemetry-constants.ts b/packages/common/telemetry-constants.tsindex e01b9126af4..c8ccbd5b671 100644--- a/packages/common/telemetry-constants.ts+++ b/packages/common/telemetry-constants.ts@@ -3534,7 +3534,10 @@ export interface AccessTokenCreatedEvent {}/**- * Triggered when an access token creation sheet is closed.+ * Triggered when the access token creation sheet is closed before a token was created, either by+ * the user (Escape, outside click, or Cancel) or because the permissions map failed to load and+ * forced the sheet shut. The token created step blocks non-safe closes, so this event never fires+ * for a completed creation.** @group Events* @source studio@@ -3543,8 +3546,10 @@ export interface AccessTokenCreatedEvent {export interface AccessTokenCreationSheetDismissedEvent {action: 'access_token_creation_sheet_dismissed'properties: {- tokenType: 'classic' | 'scoped' | 'none'- step: 'form' | 'success'+ resourceAccess: 'project' | 'organization' | 'account'+ formStep: 'form' | 'review'+ isFormTouched: boolean+ trigger: 'user' | 'permissions_load_error'}groups: Omit<TelemetryGroups, 'project'>}