fix(quickbooks): address final integration review

Author: waleedlatif1

apps/docs/content/docs/integrations/quickbooks.mdx

@@ -1198,7 +1198,7 @@ Read, merge, and full-update a customer payment using its current sync token
 | `paymentMethodId` | string | No | Replacement payment method ID |
 | `depositAccountId` | string | No | Replacement deposit account ID |
 | `invoiceAllocations` | json | No | Bounded invoice allocations to apply. Each entry sets the amount applied to that invoice; invoices already applied on the payment and not listed here keep their current amounts |
-| `unapplyOmittedInvoices` | boolean | No | Replace the payment allocations outright. Every invoice not listed in invoiceAllocations is UNAPPLIED and returns to open |
+| `unapplyOmittedInvoices` | boolean | No | Replace the payment allocations outright. Requires a non-empty invoiceAllocations list; every invoice not listed is UNAPPLIED and returns to open |
 
 #### Output
 
@@ -1472,7 +1472,7 @@ Create a customer refund receipt against a required deposit account
 
 ### QuickBooks Update Refund Receipt
 
-Sparse-update a refund receipt using its current sync token
+Read, merge, and full-update a refund receipt using its current sync token
 
 #### Input
 

apps/sim/app/desktop/connect/page.test.tsx

@@ -60,7 +60,9 @@ describe('DesktopConnectPage', () => {
   beforeEach(() => {
     vi.clearAllMocks()
     baseUrl.value = 'https://sim.test'
-    mockGetSession.mockResolvedValue({ user: { id: 'user-1', email: 'user@example.com' } })
+    mockGetSession.mockResolvedValue({
+      user: { id: 'user-1', email: 'user@example.com' },
+    })
   })
 
   it('hands the launcher an absolute complete URL so the callback can read the draft back', async () => {
@@ -143,6 +145,27 @@ describe('DesktopConnectPage', () => {
     )
   })
 
+  it('starts a draft-scoped QuickBooks connect through the server authorize route', async () => {
+    await expect(
+      DesktopConnectPage(
+        pageProps({
+          provider: 'quickbooks',
+          state: VALID_STATE,
+          port: PORT,
+          draftId: 'draft-1',
+        })
+      )
+    ).rejects.toThrow('NEXT_REDIRECT:')
+
+    const authorize = new URL(mockRedirect.mock.calls[0][0])
+    expect(authorize.pathname).toBe('/api/auth/oauth2/authorize')
+    expect(authorize.searchParams.get('draftId')).toBe('draft-1')
+    expect(authorize.searchParams.get('providerId')).toBeNull()
+    expect(authorize.searchParams.get('callbackURL')).toBe(
+      `https://sim.test/desktop/connect/complete?state=${VALID_STATE}&port=${PORT}`
+    )
+  })
+
   it.each(['trello', 'instagram', 'shopify'])(
     'starts %s through its dedicated authorize route in the system browser',
     async (provider) => {
@@ -171,7 +194,12 @@ describe('DesktopConnectPage', () => {
       { provider: 'Google', state: VALID_STATE, port: PORT },
       { provider: 'google-email', state: 'short', port: PORT },
       { provider: 'google-email', state: VALID_STATE },
-      { provider: 'google-email', state: VALID_STATE, port: PORT, draftId: 'bad draft' },
+      {
+        provider: 'google-email',
+        state: VALID_STATE,
+        port: PORT,
+        draftId: 'bad draft',
+      },
     ]
 
     for (const params of invalid) {

apps/sim/app/desktop/connect/page.tsx

@@ -77,7 +77,10 @@ export default async function DesktopConnectPage({ searchParams }: DesktopConnec
   // Force a DB-backed session read (bypass the cookie cache) so a revoked
   // browser session goes to login instead of starting a doomed link flow.
   const hdrs = await headers()
-  const session = await auth.api.getSession({ headers: hdrs, query: { disableCookieCache: true } })
+  const session = await auth.api.getSession({
+    headers: hdrs,
+    query: { disableCookieCache: true },
+  })
   if (!session?.user) {
     redirect(
       `/login?callbackUrl=${encodeURIComponent(
@@ -130,6 +133,13 @@ export default async function DesktopConnectPage({ searchParams }: DesktopConnec
     redirect(authorize.toString())
   }
 
+  if (providerId === 'quickbooks' && draftId) {
+    const authorize = new URL('/api/auth/oauth2/authorize', getBaseUrl())
+    authorize.searchParams.set('draftId', draftId)
+    authorize.searchParams.set('callbackURL', buildConnectCompleteUrl(state, port))
+    redirect(authorize.toString())
+  }
+
   if (providerId === 'trello' || providerId === 'instagram' || providerId === 'shopify') {
     const authorize = new URL(`/api/auth/${providerId}/authorize`, getBaseUrl())
     authorize.searchParams.set('returnUrl', buildConnectCompleteUrl(state, port))

apps/sim/app/workspace/[workspaceId]/components/connect-oauth-modal/connect-oauth-modal.test.tsx

@@ -10,6 +10,9 @@ const mocks = vi.hoisted(() => ({
   connectOAuthService: vi.fn(),
   getServiceConfigByProviderId: vi.fn(),
   onConnect: vi.fn(),
+  clearOAuthReturnContext: vi.fn(),
+  workspaceCredentials: vi.fn(),
+  writeOAuthReturnContext: vi.fn(),
 }))
 
 interface MockChipModalFieldProps {
@@ -90,7 +93,8 @@ vi.mock('@/lib/auth/auth-client', () => ({
 
 vi.mock('@/lib/credentials/client-state', () => ({
   ADD_CONNECTOR_SEARCH_PARAM: 'addConnector',
-  writeOAuthReturnContext: vi.fn(),
+  clearOAuthReturnContext: mocks.clearOAuthReturnContext,
+  writeOAuthReturnContext: mocks.writeOAuthReturnContext,
 }))
 
 vi.mock('@/lib/credentials/display-name', () => ({
@@ -123,10 +127,7 @@ vi.mock('@/hooks/queries/credentials', () => ({
     mutateAsync: mocks.createDraft,
     isPending: false,
   }),
-  useWorkspaceCredentials: () => ({
-    data: [],
-    isPending: false,
-  }),
+  useWorkspaceCredentials: mocks.workspaceCredentials,
 }))
 
 vi.mock('@/hooks/queries/oauth/oauth-connections', () => ({
@@ -188,17 +189,23 @@ function setFormControlValue(control: HTMLInputElement | HTMLSelectElement, valu
   const valueSetter = Object.getOwnPropertyDescriptor(prototype, 'value')?.set
   valueSetter?.call(control, value)
   control.dispatchEvent(
-    new Event(control instanceof HTMLSelectElement ? 'change' : 'input', { bubbles: true })
+    new Event(control instanceof HTMLSelectElement ? 'change' : 'input', {
+      bubbles: true,
+    })
   )
 }
 
 describe('ConnectOAuthModal reauthorization', () => {
   beforeEach(() => {
     vi.clearAllMocks()
-    mocks.createDraft.mockResolvedValue({ success: true, draftId: 'draft-exact' })
+    mocks.createDraft.mockResolvedValue({
+      success: true,
+      draftId: 'draft-exact',
+    })
     mocks.connectOAuthService.mockResolvedValue({ success: true })
     mocks.onConnect.mockResolvedValue(undefined)
     mocks.getServiceConfigByProviderId.mockReturnValue(null)
+    mocks.workspaceCredentials.mockReturnValue({ data: [], isPending: false })
     ;(globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }).IS_REACT_ACT_ENVIRONMENT = true
     container = document.createElement('div')
     document.body.appendChild(container)
@@ -235,6 +242,15 @@ describe('ConnectOAuthModal reauthorization', () => {
     expect(mocks.createDraft.mock.invocationCallOrder[0]).toBeLessThan(
       mocks.connectOAuthService.mock.invocationCallOrder[0]
     )
+    expect(mocks.writeOAuthReturnContext).toHaveBeenCalledWith(
+      expect.objectContaining({
+        origin: 'integrations',
+        displayName: 'Team Slack',
+        providerId: 'slack',
+        workspaceId: 'workspace-1',
+        reconnect: true,
+      })
+    )
   })
 
   it('does not launch OAuth when the reconnect draft cannot be created', async () => {
@@ -251,6 +267,24 @@ describe('ConnectOAuthModal reauthorization', () => {
 
     expect(mocks.connectOAuthService).not.toHaveBeenCalled()
     expect(container).toHaveTextContent('Draft creation failed')
+    expect(mocks.clearOAuthReturnContext).not.toHaveBeenCalled()
+  })
+
+  it('clears reconnect context when the provider handoff cannot start', async () => {
+    mocks.connectOAuthService.mockRejectedValue(new Error('Provider launch failed'))
+    renderReauthorizeModal({
+      reconnectTarget: {
+        workspaceId: 'workspace-1',
+        credentialId: 'credential-slack',
+        displayName: 'Team Slack',
+      },
+    })
+
+    await clickConnect()
+
+    expect(mocks.writeOAuthReturnContext).toHaveBeenCalledOnce()
+    expect(mocks.clearOAuthReturnContext).toHaveBeenCalledOnce()
+    expect(container).toHaveTextContent('Provider launch failed')
   })
 
   it('preserves provider-only reauthorization without creating a draft', async () => {
@@ -289,7 +323,12 @@ describe('ConnectOAuthModal reauthorization', () => {
         redirectPath: '/api/auth/oauth2/callback/quickbooks',
         fields: [
           { id: 'clientId', label: 'Client ID', type: 'text' },
-          { id: 'clientSecret', label: 'Client secret', type: 'secret', secret: true },
+          {
+            id: 'clientSecret',
+            label: 'Client secret',
+            type: 'secret',
+            secret: true,
+          },
           {
             id: 'webhookVerifierToken',
             label: 'Webhook verifier token',

apps/sim/app/workspace/[workspaceId]/components/connect-oauth-modal/connect-oauth-modal.tsx

@@ -17,7 +17,11 @@ import { createLogger } from '@sim/logger'
 import { getErrorMessage } from '@sim/utils/errors'
 import { useSession } from '@/lib/auth/auth-client'
 import type { OAuthReturnContext } from '@/lib/credentials/client-state'
-import { ADD_CONNECTOR_SEARCH_PARAM, writeOAuthReturnContext } from '@/lib/credentials/client-state'
+import {
+  ADD_CONNECTOR_SEARCH_PARAM,
+  clearOAuthReturnContext,
+  writeOAuthReturnContext,
+} from '@/lib/credentials/client-state'
 import { defaultCredentialDisplayName } from '@/lib/credentials/display-name'
 import {
   getProviderIdFromServiceId,
@@ -121,7 +125,11 @@ type ConnectOAuthModalConnectProps = ConnectOAuthModalBaseProps & {
   requiredScopes: readonly string[]
 } & (
     | { origin: 'workflow'; workflowId: string }
-    | { origin: 'kb-connectors'; knowledgeBaseId: string; connectorType?: string }
+    | {
+        origin: 'kb-connectors'
+        knowledgeBaseId: string
+        connectorType?: string
+      }
     | { origin: 'integrations' }
   )
 
@@ -199,21 +207,24 @@ export function ConnectOAuthModal(props: ConnectOAuthModalProps) {
 
   const { providerName, ProviderIcon } = useMemo(() => {
     if (props.serviceName && props.serviceIcon) {
-      return { providerName: props.serviceName, ProviderIcon: props.serviceIcon }
+      return {
+        providerName: props.serviceName,
+        ProviderIcon: props.serviceIcon,
+      }
     }
     const provider = (props.provider ?? providerId) as OAuthProvider
     return resolveService(provider, props.serviceId ?? providerId)
   }, [props.serviceName, props.serviceIcon, props.provider, props.serviceId, providerId])
 
-  const workspaceId = isConnect ? props.workspaceId : ''
+  const workspaceId = isConnect ? props.workspaceId : (props.reconnectTarget?.workspaceId ?? '')
   const clientConfiguration = getServiceConfigByProviderId(providerId)?.clientConfiguration
   const oauthClientRedirectUri =
     clientConfiguration?.redirectPath && typeof window !== 'undefined'
       ? new URL(clientConfiguration.redirectPath, window.location.origin).toString()
       : null
   const { data: credentials = [], isPending: credentialsLoading } = useWorkspaceCredentials({
     workspaceId,
-    enabled: isConnect && Boolean(workspaceId) && open,
+    enabled: Boolean(workspaceId) && open,
   })
   const createDraft = useCreateCredentialDraft()
   const connectOAuthService = useConnectOAuthService()
@@ -301,6 +312,7 @@ export function ConnectOAuthModal(props: ConnectOAuthModalProps) {
   const handleConnect = async () => {
     setValidationError(null)
     setSubmitError(null)
+    let returnContextWritten = false
     try {
       const environmentUrl = dataverseEnvironmentForm.validate()
       if (dataverseEnvironmentForm.enabled && !environmentUrl) return
@@ -373,12 +385,17 @@ export function ConnectOAuthModal(props: ConnectOAuthModalProps) {
             connectorType: props.connectorType,
           }
         } else if (props.origin === 'workflow') {
-          returnContext = { ...baseContext, origin: 'workflow', workflowId: props.workflowId }
+          returnContext = {
+            ...baseContext,
+            origin: 'workflow',
+            workflowId: props.workflowId,
+          }
         } else {
           returnContext = { ...baseContext, origin: 'integrations' }
         }
 
         writeOAuthReturnContext(returnContext)
+        returnContextWritten = true
       } else if (props.onConnect) {
         await props.onConnect()
         handleClose()
@@ -393,6 +410,25 @@ export function ConnectOAuthModal(props: ConnectOAuthModalProps) {
             oauthClientConfig: quickBooksOAuthClientConfig,
           })
           draftId = draft.draftId
+
+          const providerCredentials = credentials.filter(
+            (credential) => credential.type === 'oauth' && credential.providerId === providerId
+          )
+          writeOAuthReturnContext({
+            origin: 'integrations',
+            displayName: props.reconnectTarget.displayName,
+            providerId,
+            preCount: providerCredentials.length,
+            baselineCredentials: providerCredentials.map((credential) => ({
+              id: credential.id,
+              accountId: credential.accountId,
+              updatedAt: credential.updatedAt,
+            })),
+            workspaceId: props.reconnectTarget.workspaceId,
+            reconnect: true,
+            requestedAt: Date.now(),
+          })
+          returnContextWritten = true
         }
 
         logger.info('Reauthorizing OAuth2', {
@@ -422,6 +458,7 @@ export function ConnectOAuthModal(props: ConnectOAuthModalProps) {
       }
       handleClose()
     } catch (err: unknown) {
+      if (returnContextWritten) clearOAuthReturnContext()
       const message = getErrorMessage(err, 'Failed to start OAuth connection')
       setSubmitError(message)
       logger.error('Failed to connect OAuth service', err)
@@ -514,7 +551,10 @@ export function ConnectOAuthModal(props: ConnectOAuthModalProps) {
               title={field.label}
               value={oauthClientFields[field.id] ?? ''}
               onChange={(value) =>
-                setOAuthClientFields((current) => ({ ...current, [field.id]: value }))
+                setOAuthClientFields((current) => ({
+                  ...current,
+                  [field.id]: value,
+                }))
               }
               options={[...field.options]}
               placeholder={field.placeholder}
@@ -529,7 +569,10 @@ export function ConnectOAuthModal(props: ConnectOAuthModalProps) {
               title={field.label}
               value={oauthClientFields[field.id] ?? ''}
               onChange={(value) =>
-                setOAuthClientFields((current) => ({ ...current, [field.id]: value }))
+                setOAuthClientFields((current) => ({
+                  ...current,
+                  [field.id]: value,
+                }))
               }
               placeholder={field.placeholder}
               inputType={field.secret ? 'password' : 'text'}