sentry/static/app/stores/savedSearchesStore.spec.jsx

import {
  deleteSavedSearch,
  fetchSavedSearches,
  pinSearch,
  unpinSearch,
} from 'sentry/actionCreators/savedSearches';
import {Client} from 'sentry/api';
import SavedSearchesStore from 'sentry/stores/savedSearchesStore';

describe('SavedSearchesStore', function () {
  let api;

  beforeAll(async function () {
    api = new Client();
    await SavedSearchesStore.reset();
  });

  beforeEach(function () {
    Client.addMockResponse({
      url: '/organizations/org-1/searches/',
      body: TestStubs.Searches(),
    });
    Client.addMockResponse({
      url: '/organizations/org-1/pinned-searches/',
      method: 'PUT',
      body: {},
    });
    Client.addMockResponse({
      url: '/organizations/org-1/pinned-searches/',
      method: 'DELETE',
    });
  });

  afterEach(async function () {
    Client.clearMockResponses();
    SavedSearchesStore.reset();
    await tick();
  });

  it('get', function () {
    expect(SavedSearchesStore.get()).toEqual({
      hasError: false,
      isLoading: true,
      savedSearches: [],
    });
  });

  it('fetching saved searches updates store', async function () {
    await fetchSavedSearches(api, 'org-1', {});
    await tick();

    expect(SavedSearchesStore.get().savedSearches).toHaveLength(2);
    expect(SavedSearchesStore.get().isLoading).toBe(false);
  });

  it('failed fetches do not corrupt store', async function () {
    Client.addMockResponse({
      url: '/organizations/org-1/searches/',
      body: '',
    });
    await fetchSavedSearches(api, 'org-1', {});
    await tick();

    expect(SavedSearchesStore.get().savedSearches).toHaveLength(0);
    expect(SavedSearchesStore.get().isLoading).toBe(false);
  });

  it('creates a new pin search', async function () {
    await fetchSavedSearches(api, 'org-1', {});
    await tick();

    Client.addMockResponse({
      url: '/organizations/org-1/pinned-searches/',
      method: 'PUT',
      body: {
        id: '123',
        query: 'level:info',
        sort: 'freq',
        isPinned: true,
      },
    });

    pinSearch(api, 'org-1', 0, 'level:info', 'freq');
    await tick();
    await tick();

    expect(SavedSearchesStore.get().savedSearches).toHaveLength(3);
    expect(SavedSearchesStore.get().savedSearches[0]).toEqual(
      expect.objectContaining({
        id: '123',
        isPinned: true,
        type: 0,
        query: 'level:info',
        name: 'My Pinned Search',
        sort: 'freq',
      })
    );
  });

  it('changes pinned search from a custom search to an existing search', async function () {
    const searches = TestStubs.Searches();

    Client.addMockResponse({
      url: '/organizations/org-1/searches/',
      body: [
        {
          id: null,
          isPinned: true,
          type: 0,
          query: 'assigned:me',
          sort: 'date',
        },
        ...searches,
      ],
    });

    Client.addMockResponse({
      url: '/organizations/org-1/pinned-searches/',
      method: 'PUT',
      body: {
        id: '1',
        isDefault: false,
        isGlobal: true,
        isOrgCustom: false,
        isPinned: true,
        query: 'is:unresolved',
        sort: 'date',
        name: 'Unresolved Issues',
        type: 0,
      },
    });

    await fetchSavedSearches(api, 'org-1', {});
    await tick();

    pinSearch(api, 'org-1', 0, searches[1].query, 'date');
    await tick();
    await tick();

    // Order should remain the same
    expect(SavedSearchesStore.get().savedSearches[1]).toEqual(
      expect.objectContaining({
        id: '1',
        isDefault: false,
        isGlobal: true,
        isOrgCustom: false,
        isPinned: true,
        type: 0,
        name: 'Unresolved Issues',
        query: 'is:unresolved',
        sort: 'date',
      })
    );

    // Saved custom search should be removed
    expect(SavedSearchesStore.get().savedSearches).toHaveLength(2);
  });

  it('changes pinned search from an existing search to another existing search', async function () {
    const searches = TestStubs.Searches();

    Client.addMockResponse({
      url: '/organizations/org-1/searches/',
      body: [{...searches[0], isPinned: true}, searches[1]],
    });

    Client.addMockResponse({
      url: '/organizations/org-1/pinned-searches/',
      method: 'PUT',
      body: {
        id: '1',
        isDefault: false,
        isGlobal: true,
        isOrgCustom: false,
        isPinned: true,
        query: 'is:unresolved',
        sort: 'date',
        name: 'Unresolved Issues',
        type: 0,
      },
    });
    await fetchSavedSearches(api, 'org-1', {});
    await tick();

    pinSearch(api, 'org-1', 0, searches[1].query, 'date');
    await tick();
    await tick();

    expect(SavedSearchesStore.get().savedSearches).toHaveLength(2);

    expect(SavedSearchesStore.get().savedSearches[0]).toEqual(
      expect.objectContaining({
        id: '2',
        isPinned: false,
        type: 0,
        name: 'Needs Triage',
        query: 'is:unresolved is:unassigned',
        sort: 'date',
      })
    );

    expect(SavedSearchesStore.get().savedSearches[1]).toEqual(
      expect.objectContaining({
        id: '1',
        isDefault: false,
        isGlobal: true,
        isOrgCustom: false,
        isPinned: true,
        type: 0,
        name: 'Unresolved Issues',
        query: 'is:unresolved',
        sort: 'date',
      })
    );
  });

  it('unpins a user custom search (not global, and not org custom)', async function () {
    const searches = TestStubs.Searches();

    Client.addMockResponse({
      url: '/organizations/org-1/searches/',
      body: [
        {
          id: null,
          isPinned: true,
          type: 0,
          query: 'assigned:me',
          sort: 'date',
        },
        ...searches,
      ],
    });
    await fetchSavedSearches(api, 'org-1', {});
    await tick();

    unpinSearch(api, 'org-1', 0, searches[0]);
    await tick();
    await tick();

    // Saved custom search should be removed
    expect(SavedSearchesStore.get().savedSearches).toHaveLength(2);

    expect(SavedSearchesStore.get().savedSearches[0]).toEqual(
      expect.objectContaining({
        id: '2',
        isPinned: false,
        type: 0,
        name: 'Needs Triage',
        query: 'is:unresolved is:unassigned',
        sort: 'date',
      })
    );

    expect(SavedSearchesStore.get().savedSearches[1]).toEqual(
      expect.objectContaining({
        id: '1',
        isPinned: false,
        type: 0,
        name: 'Unresolved Issues',
        query: 'is:unresolved',
        sort: 'date',
      })
    );
  });

  it('unpins an existing global saved search', async function () {
    const searches = TestStubs.Searches();

    Client.addMockResponse({
      url: '/organizations/org-1/searches/',
      body: [{...searches[0], isPinned: true}, searches[1]],
    });
    await fetchSavedSearches(api, 'org-1', {});
    await tick();

    unpinSearch(api, 'org-1', 0, searches[0]);
    await tick();
    await tick();

    expect(SavedSearchesStore.get().savedSearches).toHaveLength(2);

    expect(SavedSearchesStore.get().savedSearches[0]).toEqual(
      expect.objectContaining({
        id: '2',
        isPinned: false,
        type: 0,
        name: 'Needs Triage',
        query: 'is:unresolved is:unassigned',
        sort: 'date',
      })
    );

    expect(SavedSearchesStore.get().savedSearches[1]).toEqual(
      expect.objectContaining({
        id: '1',
        isPinned: false,
        type: 0,
        name: 'Unresolved Issues',
        query: 'is:unresolved',
        sort: 'date',
      })
    );
  });

  it('unpins an existing org saved search', async function () {
    const searches = TestStubs.Searches();

    Client.addMockResponse({
      url: '/organizations/org-1/searches/',
      body: [
        {...searches[0], isOrgCustom: true, isGlobal: false, isPinned: true},
        searches[1],
      ],
    });
    await fetchSavedSearches(api, 'org-1', {});
    await tick();

    unpinSearch(api, 'org-1', 0, searches[0]);
    await tick();
    await tick();

    expect(SavedSearchesStore.get().savedSearches).toHaveLength(2);

    expect(SavedSearchesStore.get().savedSearches[0]).toEqual(
      expect.objectContaining({
        id: '2',
        isPinned: false,
        type: 0,
        name: 'Needs Triage',
        query: 'is:unresolved is:unassigned',
        sort: 'date',
      })
    );

    expect(SavedSearchesStore.get().savedSearches[1]).toEqual(
      expect.objectContaining({
        id: '1',
        isPinned: false,
        type: 0,
        name: 'Unresolved Issues',
        query: 'is:unresolved',
        sort: 'date',
      })
    );
  });

  it('removes deleted saved searches', async function () {
    await fetchSavedSearches(api, 'org-1', {});
    await tick();

    const searches = SavedSearchesStore.get().savedSearches;
    Client.addMockResponse({
      url: `/organizations/org-1/searches/${searches[0].id}/`,
      method: 'DELETE',
      body: {},
    });
    await deleteSavedSearch(api, 'org-1', searches[0]);
    await tick();

    const newSearches = SavedSearchesStore.get().savedSearches;
    expect(newSearches.length).toBeLessThan(searches.length);
    expect(newSearches[0].id).not.toBe(searches[0].id);
  });
});