feat(shared): add internal directory sync react-query hooks

packages/shared/src/react/hooks/__tests__/useOrganizationDirectorySync.spec.tsx

@@ -0,0 +1,196 @@
+import { act, renderHook, waitFor } from '@testing-library/react';
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+
+import { ClerkAPIResponseError } from '@/error';
+
+import { INTERNAL_STABLE_KEYS } from '../../stable-keys';
+import { createCacheKeys } from '../createCacheKeys';
+import { __internal_useOrganizationDirectorySync } from '../useOrganizationDirectorySync';
+import { createMockClerk, createMockQueryClient } from './mocks/clerk';
+import { wrapper } from './wrapper';
+
+const updateSpy = vi.fn(() => Promise.resolve({ ...directory, enabled: false }));
+const rotateTokenSpy = vi.fn(() => Promise.resolve({ ...directory, token: 'tok_new' }));
+const deleteSpy = vi.fn(() => Promise.resolve({ object: 'directory', id: 'dir_1', deleted: true }));
+const directory = {
+  id: 'dir_1',
+  enterpriseConnectionId: 'ent_1',
+  update: updateSpy,
+  rotateToken: rotateTokenSpy,
+  delete: deleteSpy,
+};
+const getDirectorySyncSpy = vi.fn((_enterpriseConnectionId: string) => Promise.resolve(directory));
+const createDirectorySyncSpy = vi.fn((_enterpriseConnectionId: string, _params?: unknown) =>
+  Promise.resolve({ ...directory, token: 'tok_1' }),
+);
+
+const defaultQueryClient = createMockQueryClient();
+
+const mockClerk = createMockClerk({
+  queryClient: defaultQueryClient,
+  __internal_lastEmittedResources: {
+    user: null,
+    session: null,
+    organization: { id: 'org_1', getDirectorySync: getDirectorySyncSpy, createDirectorySync: createDirectorySyncSpy },
+    client: null,
+  },
+});
+
+vi.mock('../../contexts', () => ({
+  useAssertWrappedByClerkProvider: () => {},
+  useClerkInstanceContext: () => mockClerk,
+  useInitialStateContext: () => undefined,
+}));
+
+const keysFor = (enterpriseConnectionId: string) =>
+  createCacheKeys({
+    stablePrefix: INTERNAL_STABLE_KEYS.ORGANIZATION_DIRECTORY_SYNC_KEY,
+    authenticated: true,
+    tracked: { organizationId: 'org_1', enterpriseConnectionId },
+    untracked: { args: {} },
+  });
+
+const renderDirectorySync = (enterpriseConnectionId: string | null = 'ent_1') =>
+  renderHook(() => __internal_useOrganizationDirectorySync({ enterpriseConnectionId }), { wrapper });
+
+describe('useOrganizationDirectorySync', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+    defaultQueryClient.client.clear();
+    mockClerk.loaded = true;
+  });
+
+  it('resolves the directory for the connection', async () => {
+    const { result } = renderDirectorySync();
+    await waitFor(() => expect(result.current.isLoading).toBe(false));
+
+    expect(getDirectorySyncSpy).toHaveBeenCalledWith('ent_1');
+    expect(result.current.data).toBe(directory);
+    expect(result.current.error).toBeNull();
+  });
+
+  it('treats a 404 as "no directory yet" and resolves null instead of an error', async () => {
+    getDirectorySyncSpy.mockRejectedValueOnce(new ClerkAPIResponseError('Not found', { status: 404, data: [] }));
+
+    const { result } = renderDirectorySync();
+    await waitFor(() => expect(result.current.isLoading).toBe(false));
+
+    expect(result.current.data).toBeNull();
+    expect(result.current.error).toBeNull();
+  });
+
+  it('stays dormant without an enterprise connection id', () => {
+    const { result } = renderDirectorySync(null);
+
+    expect(getDirectorySyncSpy).not.toHaveBeenCalled();
+    expect(result.current.data).toBeUndefined();
+  });
+
+  it('revalidate refetches only this org+connection, leaving other connections cached', async () => {
+    const { queryKey: otherKey } = keysFor('ent_other');
+    defaultQueryClient.client.setQueryData(otherKey, { id: 'dir_other', enterpriseConnectionId: 'ent_other' });
+
+    const { result } = renderDirectorySync();
+    await waitFor(() => expect(result.current.isLoading).toBe(false));
+    expect(getDirectorySyncSpy).toHaveBeenCalledTimes(1);
+
+    await act(async () => {
+      await result.current.revalidate();
+    });
+
+    expect(getDirectorySyncSpy).toHaveBeenCalledTimes(2);
+    expect(defaultQueryClient.client.getQueryState(otherKey)?.isInvalidated).toBe(false);
+  });
+
+  describe('mutations', () => {
+    it('createDirectorySync creates for the connection, resolves the token-bearing resource, and refetches', async () => {
+      const { result } = renderDirectorySync();
+      await waitFor(() => expect(result.current.isLoading).toBe(false));
+      expect(getDirectorySyncSpy).toHaveBeenCalledTimes(1);
+
+      let created: Awaited<ReturnType<typeof result.current.createDirectorySync>>;
+      await act(async () => {
+        created = await result.current.createDirectorySync({ name: 'Okta' });
+      });
+
+      expect(createDirectorySyncSpy).toHaveBeenCalledWith('ent_1', { name: 'Okta' });
+      expect(created).toMatchObject({ id: 'dir_1', token: 'tok_1' });
+      expect(getDirectorySyncSpy).toHaveBeenCalledTimes(2);
+    });
+
+    it('createDirectorySync is a no-op without an enterprise connection id', async () => {
+      const { result } = renderDirectorySync(null);
+
+      await expect(result.current.createDirectorySync()).resolves.toBeUndefined();
+      expect(createDirectorySyncSpy).not.toHaveBeenCalled();
+    });
+
+    it.each([
+      [
+        'updateDirectorySync',
+        updateSpy,
+        (r: ReturnType<typeof renderDirectorySync>['result']) => r.current.updateDirectorySync({ enabled: false }),
+      ],
+      [
+        'rotateDirectorySyncToken',
+        rotateTokenSpy,
+        (r: ReturnType<typeof renderDirectorySync>['result']) => r.current.rotateDirectorySyncToken(),
+      ],
+      [
+        'deleteDirectorySync',
+        deleteSpy,
+        (r: ReturnType<typeof renderDirectorySync>['result']) => r.current.deleteDirectorySync(),
+      ],
+    ] as const)('%s acts on the loaded directory and refetches it', async (_name, resourceSpy, run) => {
+      const { result } = renderDirectorySync();
+      await waitFor(() => expect(result.current.isLoading).toBe(false));
+      expect(getDirectorySyncSpy).toHaveBeenCalledTimes(1);
+
+      let resolved: unknown;
+      await act(async () => {
+        resolved = await run(result);
+      });
+
+      expect(resourceSpy).toHaveBeenCalledTimes(1);
+      expect(resolved).toBe(await resourceSpy.mock.results[0].value);
+      expect(getDirectorySyncSpy).toHaveBeenCalledTimes(2);
+    });
+
+    it('updateDirectorySync forwards its params to the resource', async () => {
+      const { result } = renderDirectorySync();
+      await waitFor(() => expect(result.current.isLoading).toBe(false));
+
+      await act(async () => {
+        await result.current.updateDirectorySync({ enabled: false });
+      });
+
+      expect(updateSpy).toHaveBeenCalledWith({ enabled: false });
+    });
+
+    it('directory-scoped mutations resolve undefined before the directory has loaded', async () => {
+      getDirectorySyncSpy.mockRejectedValueOnce(new ClerkAPIResponseError('Not found', { status: 404, data: [] }));
+      const { result } = renderDirectorySync();
+      await waitFor(() => expect(result.current.isLoading).toBe(false));
+      expect(result.current.data).toBeNull();
+
+      await expect(result.current.updateDirectorySync({ enabled: false })).resolves.toBeUndefined();
+      await expect(result.current.rotateDirectorySyncToken()).resolves.toBeUndefined();
+      await expect(result.current.deleteDirectorySync()).resolves.toBeUndefined();
+      expect(updateSpy).not.toHaveBeenCalled();
+      expect(rotateTokenSpy).not.toHaveBeenCalled();
+      expect(deleteSpy).not.toHaveBeenCalled();
+    });
+
+    it('propagates a failed mutation and skips the refetch', async () => {
+      const { result } = renderDirectorySync();
+      await waitFor(() => expect(result.current.isLoading).toBe(false));
+      expect(getDirectorySyncSpy).toHaveBeenCalledTimes(1);
+
+      const failure = new Error('rotate failed');
+      rotateTokenSpy.mockRejectedValueOnce(failure);
+
+      await expect(result.current.rotateDirectorySyncToken()).rejects.toBe(failure);
+      expect(getDirectorySyncSpy).toHaveBeenCalledTimes(1);
+    });
+  });
+});

packages/shared/src/react/hooks/__tests__/useOrganizationDirectorySyncUsers.spec.tsx

@@ -0,0 +1,94 @@
+import { renderHook, waitFor } from '@testing-library/react';
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+
+import type { DirectorySyncResource } from '@/types/directorySync';
+
+import { __internal_useOrganizationDirectorySyncUsers } from '../useOrganizationDirectorySyncUsers';
+import { createMockClerk, createMockQueryClient } from './mocks/clerk';
+import { wrapper } from './wrapper';
+
+const POLL_INTERVAL_MS = 20;
+
+const getUsersSpy = vi.fn(() => Promise.resolve({ data: [{ id: 'du_1' }], total_count: 1 }));
+
+const createDirectory = (id: string) =>
+  ({ id, enterpriseConnectionId: 'ent_1', getUsers: getUsersSpy }) as unknown as DirectorySyncResource;
+
+const defaultQueryClient = createMockQueryClient();
+
+const mockClerk = createMockClerk({
+  queryClient: defaultQueryClient,
+  __internal_lastEmittedResources: {
+    user: null,
+    session: null,
+    organization: { id: 'org_1' },
+    client: null,
+  },
+});
+
+vi.mock('../../contexts', () => ({
+  useAssertWrappedByClerkProvider: () => {},
+  useClerkInstanceContext: () => mockClerk,
+  useInitialStateContext: () => undefined,
+}));
+
+type RenderProps = { directory: DirectorySyncResource | null; poll?: boolean };
+
+const renderUsers = (initialProps: RenderProps) =>
+  renderHook(
+    ({ directory, poll }: RenderProps) =>
+      __internal_useOrganizationDirectorySyncUsers({ directory, poll, pollIntervalMs: POLL_INTERVAL_MS }),
+    { wrapper, initialProps },
+  );
+
+describe('useOrganizationDirectorySyncUsers', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+    defaultQueryClient.client.clear();
+    mockClerk.loaded = true;
+  });
+
+  it('stays dormant without a directory', () => {
+    const { result } = renderUsers({ directory: null, poll: true });
+
+    expect(getUsersSpy).not.toHaveBeenCalled();
+    expect(result.current.data).toBeUndefined();
+    expect(result.current.isPolling).toBe(false);
+  });
+
+  it('does not poll by default', async () => {
+    const { result } = renderUsers({ directory: createDirectory('dir_1') });
+    await waitFor(() => expect(result.current.isLoading).toBe(false));
+    expect(result.current.isPolling).toBe(false);
+
+    const callsAfterLoad = getUsersSpy.mock.calls.length;
+    await new Promise(resolve => setTimeout(resolve, POLL_INTERVAL_MS * 3));
+    expect(getUsersSpy.mock.calls.length).toBe(callsAfterLoad);
+  });
+
+  it('polls while `poll` is true and stops when it turns false', async () => {
+    const directory = createDirectory('dir_1');
+    const { result, rerender } = renderUsers({ directory, poll: true });
+    expect(result.current.isPolling).toBe(true);
+    await waitFor(() => expect(getUsersSpy.mock.calls.length).toBeGreaterThanOrEqual(3));
+
+    rerender({ directory, poll: false });
+    expect(result.current.isPolling).toBe(false);
+
+    const callsAfterStop = getUsersSpy.mock.calls.length;
+    await new Promise(resolve => setTimeout(resolve, POLL_INTERVAL_MS * 3));
+    expect(getUsersSpy.mock.calls.length).toBe(callsAfterStop);
+  });
+
+  it('stops polling on unmount', async () => {
+    const { result, unmount } = renderUsers({ directory: createDirectory('dir_1'), poll: true });
+    await waitFor(() => expect(getUsersSpy.mock.calls.length).toBeGreaterThanOrEqual(3));
+    expect(result.current.isPolling).toBe(true);
+
+    unmount();
+
+    const callsAfterUnmount = getUsersSpy.mock.calls.length;
+    await new Promise(resolve => setTimeout(resolve, POLL_INTERVAL_MS * 3));
+    expect(getUsersSpy.mock.calls.length).toBe(callsAfterUnmount);
+  });
+});

packages/shared/src/react/hooks/__tests__/useOrganizationEnterpriseConnectionTestRuns.spec.tsx

@@ -1,10 +1,12 @@
-import { act, renderHook, waitFor } from '@testing-library/react';
+import { act, render, renderHook, waitFor } from '@testing-library/react';
+import React, { useEffect } from 'react';
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 
 import type { GetEnterpriseConnectionTestRunsParams } from '@/types/enterpriseConnectionTestRun';
 
 import { INTERNAL_STABLE_KEYS } from '../../stable-keys';
 import { createCacheKeys } from '../createCacheKeys';
+import type { UseOrganizationEnterpriseConnectionTestRunsReturn } from '../useOrganizationEnterpriseConnectionTestRuns';
 import { __internal_useOrganizationEnterpriseConnectionTestRuns } from '../useOrganizationEnterpriseConnectionTestRuns';
 import { createMockClerk, createMockQueryClient } from './mocks/clerk';
 import { wrapper } from './wrapper';
@@ -99,3 +101,93 @@ describe('useOrganizationEnterpriseConnectionTestRuns — revalidate invalidatio
     invalidateSpy.mockRestore();
   });
 });
+
+describe('useOrganizationEnterpriseConnectionTestRuns — polling arm scope', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+    defaultQueryClient.client.clear();
+    mockClerk.loaded = true;
+  });
+
+  it('keeps polling armed by a child effect in the same commit the connection arrives', async () => {
+    getTestRunsSpy.mockImplementation(() => Promise.resolve({ data: [], total_count: 0 }));
+    let latest: UseOrganizationEnterpriseConnectionTestRunsReturn | undefined;
+
+    // Child effects run before parent effects, so this is the ordering a
+    // reset-in-effect implementation would silently cancel.
+    const Child = ({
+      enterpriseConnectionId,
+      revalidate,
+    }: {
+      enterpriseConnectionId: string | null;
+      revalidate: UseOrganizationEnterpriseConnectionTestRunsReturn['revalidate'];
+    }) => {
+      useEffect(() => {
+        if (enterpriseConnectionId) {
+          void revalidate();
+        }
+      }, [enterpriseConnectionId, revalidate]);
+      return null;
+    };
+
+    const Parent = ({ enterpriseConnectionId }: { enterpriseConnectionId: string | null }) => {
+      latest = __internal_useOrganizationEnterpriseConnectionTestRuns({ enterpriseConnectionId, pollIntervalMs: 20 });
+      return (
+        <Child
+          enterpriseConnectionId={enterpriseConnectionId}
+          revalidate={latest.revalidate}
+        />
+      );
+    };
+
+    const { rerender } = render(<Parent enterpriseConnectionId={null} />);
+    expect(latest?.isPolling).toBe(false);
+
+    rerender(<Parent enterpriseConnectionId='ent_1' />);
+
+    await waitFor(() => expect(latest?.isPolling).toBe(true));
+    await waitFor(() => expect(getTestRunsSpy.mock.calls.length).toBeGreaterThanOrEqual(3));
+  });
+
+  it('disarms polling when the connection changes', async () => {
+    getTestRunsSpy.mockImplementation(() => Promise.resolve({ data: [], total_count: 0 }));
+    const { result, rerender } = renderHook(
+      ({ enterpriseConnectionId }: { enterpriseConnectionId: string }) =>
+        __internal_useOrganizationEnterpriseConnectionTestRuns({ enterpriseConnectionId, pollIntervalMs: 20 }),
+      { wrapper, initialProps: { enterpriseConnectionId: 'ent_1' } },
+    );
+    await waitFor(() => expect(result.current.isLoading).toBe(false));
+
+    await act(async () => {
+      await result.current.revalidate();
+    });
+    expect(result.current.isPolling).toBe(true);
+
+    rerender({ enterpriseConnectionId: 'ent_2' });
+    expect(result.current.isPolling).toBe(false);
+  });
+
+  it('does not resume polling when the original connection returns without a new revalidate', async () => {
+    getTestRunsSpy.mockImplementation(() => Promise.resolve({ data: [], total_count: 0 }));
+    const { result, rerender } = renderHook(
+      ({ enterpriseConnectionId }: { enterpriseConnectionId: string }) =>
+        __internal_useOrganizationEnterpriseConnectionTestRuns({ enterpriseConnectionId, pollIntervalMs: 20 }),
+      { wrapper, initialProps: { enterpriseConnectionId: 'ent_1' } },
+    );
+    await waitFor(() => expect(result.current.isLoading).toBe(false));
+
+    await act(async () => {
+      await result.current.revalidate();
+    });
+    expect(result.current.isPolling).toBe(true);
+
+    rerender({ enterpriseConnectionId: 'ent_2' });
+    rerender({ enterpriseConnectionId: 'ent_1' });
+    await waitFor(() => expect(result.current.isLoading).toBe(false));
+    expect(result.current.isPolling).toBe(false);
+
+    const callsAfterReturn = getTestRunsSpy.mock.calls.length;
+    await new Promise(resolve => setTimeout(resolve, 60));
+    expect(getTestRunsSpy.mock.calls.length).toBe(callsAfterReturn);
+  });
+});