fix(search): reconcile sync progress and finish source guides

Author: waleedlatif1

apps/docs/content/docs/search/confluence.mdx

@@ -196,6 +196,6 @@ Configure one shared Confluence OAuth integration for your deployment. This powe
 2. Under **Authorization → OAuth 2.0 (3LO)**, add `https://<your-sim-domain>/api/auth/oauth2/callback/confluence` to **Callback URLs**, keep existing callbacks used by the deployment, and save.
 3. Under **Permissions**, add the Confluence API and configure the full `confluence` scope list for your release in [Sim's OAuth configuration](https://github.com/simstudioai/sim/blob/staging/apps/sim/lib/oauth/oauth.ts), including `read:group:confluence`. Also add **User Identity API** with `read:me`. Sim requests `offline_access` for refresh tokens. The service-account read scopes above do not replace the broader shared OAuth scope set.
 4. Enable sharing under **Distribution**. Set `CONFLUENCE_CLIENT_ID` and `CONFLUENCE_CLIENT_SECRET` from the app's **Settings**, verify `NEXT_PUBLIC_APP_URL`, and restart Sim.
-5. Start authorization from Search and select the configured site. Reconnect old accounts after adding scopes so the new permission grant takes effect.
+5. Start authorization from **Integrations** and select the configured site. Reconnect old accounts after adding scopes so the new permission grant takes effect.
 
 A callback mismatch needs a corrected callback URL; a connection that works only for the app owner needs sharing enabled. See Atlassian's [OAuth configuration guide](https://developer.atlassian.com/cloud/confluence/oauth-2-3lo-apps/) and Sim's [deployment reference](/platform/self-hosting/integrations-oauth).

apps/docs/content/docs/search/connect-your-account.mdx

@@ -35,7 +35,9 @@ Use **Add source** beside **Add another [provider] source** when you need anothe
 
 In the new tab, select **Connect** and complete the provider's authorization. Choose the account associated with your verified Sim email. The provider may require your organization's SSO or app approval.
 
-Return to Integrations when the connection completes, or use **Return to Search** on the connection page. If the popup was blocked or closed, allow popups and select **Connect account** again. While authorization is pending, use **Open again**.
+Return to Integrations when the connection completes, or select **Return to Search** to open your organization’s Search page. Your account is saved when authorization completes; there is no separate submit step. If the popup was blocked or closed, allow popups and select **Connect account** again. While authorization is pending, use **Open again**.
+
+<Image src="/static/search/member-enrollment.jpg" alt="Gmail account connection with Connect and Return to Search actions" width={680} height={305} />
 
 </Step>
 <Step>

apps/docs/content/docs/search/index.mdx

@@ -95,7 +95,7 @@ Open **Settings → Sources → [integration]**, then select a source. Providers
 | Source tab | What you can do |
 | --- | --- |
 | **Documents** | Find indexed documents, inspect processing status, retry failed indexing, or exclude and restore documents. |
-| **Settings** | Edit the source's scope, filters, metadata, and supported connection settings. Save your changes before leaving. |
+| **Settings** | Edit the source's scope, filters, and supported connection settings. Save your changes before leaving. |
 | **Sync history** | Review recent sync runs and errors. |
 
 Use the source header to sync, pause, resume, or remove that source. The back link returns to its integration. **Deactivate** on the integration page makes its content unavailable in Search, Assistant, and MCP while preserving its sources and connected accounts; **Activate** enables it again.

apps/docs/content/docs/search/jira.mdx

@@ -138,6 +138,6 @@ The deployment operator configures one shared Jira OAuth integration. Teammates
 
 3. Under **Permissions**, add **Jira API**, then **Configure** its classic and granular scopes for Jira, Jira Service Management, and Assets. Separately add **User Identity API** with `read:me`. Sim requests `offline_access` in the authorization URL for refresh tokens. Configure the full `jira` scope list for your release in [Sim's OAuth configuration](https://github.com/simstudioai/sim/blob/staging/apps/sim/lib/oauth/oauth.ts); the Search read scopes above are only a subset of this shared integration's permissions.
 4. Under **Distribution**, enable sharing so teammates can authorize the app. Copy the client ID and secret from **Settings** into `JIRA_CLIENT_ID` and `JIRA_CLIENT_SECRET`, set the correct `NEXT_PUBLIC_APP_URL`, and restart Sim.
-5. Start a connection from Search. Confirm that Atlassian lists the intended site, then return to Sim. After changing requested scopes, reconnect previously authorized accounts.
+5. Start a connection from **Integrations**. Confirm that Atlassian lists the intended site, then return to Sim. After changing requested scopes, reconnect previously authorized accounts.
 
-For a local instance using `NEXT_PUBLIC_APP_URL=http://localhost:3000`, register `http://localhost:3000/api/auth/oauth2/callback/jira`. Use a separate development OAuth app when production callbacks must remain unchanged. After updating local client credentials or the app URL, restart Sim and begin a new connection from Search. If only the app owner can connect, check **Distribution**. See Atlassian's [OAuth configuration and sharing guide](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/) and Sim's [deployment reference](/platform/self-hosting/integrations-oauth).
+For a local instance using `NEXT_PUBLIC_APP_URL=http://localhost:3000`, register `http://localhost:3000/api/auth/oauth2/callback/jira`. Use a separate development OAuth app when production callbacks must remain unchanged. After updating local client credentials or the app URL, restart Sim and begin a new connection from **Integrations**. If only the app owner can connect, check **Distribution**. See Atlassian's [OAuth configuration and sharing guide](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/) and Sim's [deployment reference](/platform/self-hosting/integrations-oauth).

apps/docs/public/static/search/member-enrollment.jpg

@@ -266,6 +266,7 @@ describe('organization administration overview boundary', () => {
       sourceCount: 1,
       approved: true,
       status: 'waiting_for_connections',
+      isSyncing: false,
     }
     mocks.adminOverview.mockResolvedValue({
       providers: [{ ...provider, privateAccount: 'private' }],

apps/sim/app/api/knowledge/sim-search/sources/route.test.ts

@@ -48,7 +48,13 @@ import { SettingsHeaderProvider, SettingsHeaderShell } from '@/components/settin
 import { OrganizationIntegrationsSetup } from '@/app/o/[organizationId]/settings/components/integrations/organization-integrations-setup'
 
 const providers: OrganizationSearchProviderSummary[] = [
-  { connectorType: 'gmail', approved: true, sourceCount: 0, status: 'waiting_for_connections' },
+  {
+    connectorType: 'gmail',
+    approved: true,
+    sourceCount: 0,
+    status: 'waiting_for_connections',
+    isSyncing: false,
+  },
   { connectorType: 'google_drive', approved: false, sourceCount: 2, status: 'paused' },
 ]
 let root: Root

apps/sim/app/o/[organizationId]/settings/components/integrations/organization-integrations-setup.test.tsx

@@ -294,24 +294,13 @@ export function useConnectorSettingsForm({
     [connector.sourceConfig]
   )
 
-  const hasChanges = useMemo(() => {
-    if (syncInterval !== connector.syncIntervalMinutes) return true
-    if (didCanonicalModesChange(canonicalModes, persistedCanonicalModes)) return true
-    const resolved = resolveSourceConfig()
-    for (const [key, value] of Object.entries(resolved)) {
-      if (hiddenCapFieldIds.has(key)) continue
-      if (!valuesEqual(connector.sourceConfig[key], value)) return true
-    }
-    return false
-  }, [
-    resolveSourceConfig,
-    syncInterval,
-    connector.syncIntervalMinutes,
-    connector.sourceConfig,
-    canonicalModes,
-    persistedCanonicalModes,
-    hiddenCapFieldIds,
-  ])
+  const hasChanges =
+    syncInterval !== connector.syncIntervalMinutes ||
+    didCanonicalModesChange(canonicalModes, persistedCanonicalModes) ||
+    Object.entries(resolveSourceConfig()).some(
+      ([key, value]) =>
+        !hiddenCapFieldIds.has(key) && !valuesEqual(connector.sourceConfig[key], value)
+    )
 
   const handleSave = useCallback(() => {
     if (!searchSettingsAllowed || !settingsComplete || accessDirty) return

apps/sim/app/workspace/[workspaceId]/knowledge/[id]/components/edit-connector-modal/use-connector-settings-form.ts

@@ -211,6 +211,7 @@ describe('useTriggerSync optimistic state', () => {
   function capturedMutationOptions() {
     return mocks.useMutation.mock.calls.at(-1)?.[0] as {
       onMutate: (vars: { knowledgeBaseId: string; connectorId: string }) => Promise<unknown>
+      onSettled: () => Promise<unknown>
       onSuccess: (data: undefined, vars: { knowledgeBaseId: string; connectorId: string }) => void
       onError: (
         error: unknown,
@@ -294,37 +295,10 @@ describe('useTriggerSync optimistic state', () => {
     expect(rolledBack?.find((c) => c.id === 'connector-2')?.status).toBe('pending')
   })
 
-  /**
-   * The Search surface reads the member sync status from the workspace
-   * member-connector list, which has no poll of its own, so a members-mode
-   * trigger patches that cache too and a refused trigger refetches it.
-   */
-  it('patches all loaded source pages without changing cursors or overview cache data', async () => {
-    mocks.getQueryData.mockReturnValue([makeConnector({ status: 'active' })])
+  it('reconciles server source summaries after either sync outcome', async () => {
     useTriggerSync()
-    await capturedMutationOptions().onMutate({ knowledgeBaseId: KB_ID, connectorId: 'connector-1' })
-    const [filter, patch] = mocks.setQueriesData.mock.calls.find(
-      ([filter]) => filter.queryKey[0] === 'search-sources'
-    )!
-    const overviewKey = searchSourceKeys.overview('workspace-a')
-    const pagesKey = searchSourceKeys.pages('workspace-a', { search: '', mine: false })
-    expect(filter.predicate({ queryKey: overviewKey })).toBe(false)
-    expect(filter.predicate({ queryKey: pagesKey })).toBe(true)
-    const cached = {
-      pageParams: [null, 'cursor'],
-      pages: [
-        { sources: [{ connectorId: 'other', isSyncing: false }], nextCursor: 'cursor' },
-        { sources: [{ connectorId: 'connector-1', isSyncing: false }], nextCursor: null },
-      ],
-    }
-    expect(patch(cached)).toEqual({
-      ...cached,
-      pages: [
-        cached.pages[0],
-        { ...cached.pages[1], sources: [{ connectorId: 'connector-1', isSyncing: true }] },
-      ],
-    })
-    expect(patch(undefined)).toBeUndefined()
+    await capturedMutationOptions().onSettled()
+    expect(mocks.invalidateQueries).toHaveBeenCalledWith({ queryKey: searchSourceKeys.lists() })
   })
 
   it('queues a members connector in the workspace member-connector list as well', async () => {

apps/sim/hooks/queries/kb/connectors.test.ts

@@ -1,6 +1,5 @@
 import { useEffect } from 'react'
 import {
-  type InfiniteData,
   keepPreviousData,
   type QueryClient,
   useInfiniteQuery,
@@ -521,7 +520,7 @@ export function useOrganizationSearchOverview(
     enabled: Boolean(organizationId) && (options?.enabled ?? true),
     staleTime: CONNECTOR_LIST_STALE_TIME,
     refetchInterval: (query) =>
-      query.state.data?.providers.some((provider) => provider.status === 'indexing')
+      query.state.data?.providers.some((provider) => provider.isSyncing)
         ? SEARCH_SOURCE_SUMMARY_POLL_MS
         : false,
   })
@@ -807,31 +806,14 @@ export function useTriggerSync() {
       await Promise.all([
         queryClient.cancelQueries({ queryKey: connectorKeys.all(knowledgeBaseId) }),
         queryClient.cancelQueries({ queryKey: memberConnectorKeys.lists() }),
-        queryClient.cancelQueries({ queryKey: searchSourceKeys.lists() }),
       ])
-      queryClient.setQueriesData<InfiniteData<SearchSourcePage>>(
-        { queryKey: searchSourceKeys.lists(), predicate: (query) => query.queryKey[3] === 'pages' },
-        (data) =>
-          data
-            ? {
-                ...data,
-                pages: data.pages.map((page) => ({
-                  ...page,
-                  sources: page.sources.map((source) =>
-                    source.connectorId === connectorId ? { ...source, isSyncing: true } : source
-                  ),
-                })),
-              }
-            : data
-      )
       return optimisticallyQueueSync(queryClient, knowledgeBaseId, connectorId)
     },
     /**
      * Rolling back also stops the poll the optimistic `pending` started, so a
      * refused sync does not leave the row spinning.
      */
     onError: (_error, { knowledgeBaseId, connectorId }, previous) => {
-      queryClient.invalidateQueries({ queryKey: searchSourceKeys.lists() })
       queryClient.invalidateQueries({ queryKey: searchIntegrationKeys.lists() })
       if (previous) {
         setCachedConnectorStatus(queryClient, knowledgeBaseId, connectorId, previous)
@@ -852,6 +834,7 @@ export function useTriggerSync() {
         queryKey: connectorKeys.progresses(knowledgeBaseId, connectorId),
       })
     },
+    onSettled: () => queryClient.invalidateQueries({ queryKey: searchSourceKeys.lists() }),
   })
 }