-
-
Notifications
You must be signed in to change notification settings - Fork 508
Improve tag autocomplete with bounded cached search #2584
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
niemyjski
wants to merge
1
commit into
main
Choose a base branch
from
issue/customer-tag-search
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
144 changes: 144 additions & 0 deletions
144
src/Exceptionless.Web/ClientApp/e2e/tests/tag-suggestions.e2e.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| import { expect, type Page, type Route, test } from '@playwright/test'; | ||
|
|
||
| const ORGANIZATION_ID = '000000000000000000000001'; | ||
|
|
||
| test('complete tag suggestions filter locally without changing selected tags', async ({ page }) => { | ||
| const requests: string[] = []; | ||
| await page.clock.install(); | ||
| await setup(page, async (route, aggregation) => { | ||
| requests.push(aggregation); | ||
| await route.fulfill({ json: tags(['Alpha', 'Beta']) }); | ||
| }); | ||
| await page.goto('/next/event?tag=Selected&time=%5Bnow-24h%20TO%20now%5D&project=000000000000000000000003'); | ||
| await page.getByRole('button', { name: /^Tag\s+Selected/ }).click(); | ||
| const input = page.getByPlaceholder('Tag', { exact: true }); | ||
| await expect(page.getByRole('option', { exact: true, name: 'Alpha' })).toBeVisible(); | ||
| await input.fill('Be'); | ||
| await expect(page.getByRole('option', { exact: true, name: 'Beta' })).toBeVisible(); | ||
| await expect(page.getByRole('option', { exact: true, name: 'Alpha' })).toHaveCount(0); | ||
| await page.clock.fastForward(450); | ||
| expect(requests).toEqual(['terms:(tags~251)']); | ||
| await expect(page).toHaveURL(/[?&]tag=Selected/); | ||
| await input.press('Escape'); | ||
| await page.getByRole('button', { name: /^Tag\s+Selected/ }).click(); | ||
| expect(requests).toHaveLength(1); | ||
| await input.press('Escape'); | ||
| await page.getByRole('button', { exact: true, name: 'Date Last 24 hours' }).click(); | ||
| await page.getByRole('button', { exact: true, name: 'Last 7 days' }).click(); | ||
| await expect(page).toHaveURL(/[?&]time=/); | ||
| await page | ||
| .getByRole('button', { name: /^Project/ }) | ||
| .first() | ||
| .click(); | ||
| await page.getByRole('option', { exact: true, name: 'Project One' }).click(); | ||
| await expect(page).not.toHaveURL(/[?&]project=/); | ||
| await page.keyboard.press('Escape'); | ||
| await page.getByRole('button', { name: /^Tag\s+Selected/ }).click(); | ||
| await page.clock.fastForward(450); | ||
| expect(requests).toHaveLength(1); | ||
| }); | ||
|
|
||
| test('incomplete suggestions debounce remote search, reuse cache and preserve selections through failure', async ({ page }) => { | ||
| const requests: string[] = []; | ||
| let searchFailed = false; | ||
| await page.clock.install(); | ||
| await setup(page, async (route, aggregation) => { | ||
| requests.push(aggregation); | ||
| if (aggregation === 'terms:(tags~251)') { | ||
| await route.fulfill({ json: tags(['Common'], 1) }); | ||
| } else if (aggregation.includes('[fF][aA][iI][lL]')) { | ||
| if (!searchFailed) { | ||
| searchFailed = true; | ||
| await route.fulfill({ json: { status: 503, title: 'Unavailable' }, status: 503 }); | ||
| } else { | ||
| await route.fulfill({ json: tags(['Failover']) }); | ||
| } | ||
| } else { | ||
| await route.fulfill({ json: tags(['RareTag']) }); | ||
| } | ||
| }); | ||
| await page.goto('/next/event?tag=Selected'); | ||
| await page.getByRole('button', { name: /^Tag\s+Selected/ }).click(); | ||
| const input = page.getByPlaceholder('Tag', { exact: true }); | ||
| await expect(page.getByRole('option', { exact: true, name: 'Common' })).toBeVisible(); | ||
| await input.fill('R'); | ||
| await page.clock.fastForward(350); | ||
| expect(requests).toHaveLength(1); | ||
| await input.fill('Ra'); | ||
| await input.fill('Rar'); | ||
| await input.fill('Rare'); | ||
| await page.clock.fastForward(350); | ||
| await expect(page.getByRole('option', { exact: true, name: 'RareTag' })).toBeVisible(); | ||
| expect(requests).toHaveLength(2); | ||
| await page.getByRole('option', { exact: true, name: 'RareTag' }).click(); | ||
| await expect(page).toHaveURL(/RareTag/); | ||
| expect(requests).toHaveLength(2); | ||
| await input.fill('fail'); | ||
| await page.clock.fastForward(350); | ||
| await expect(page.getByText('Could not load tags.')).toBeVisible(); | ||
| await expect(page.getByRole('button', { exact: true, name: 'Retry' })).toBeVisible(); | ||
| await expect(page).toHaveURL(/Selected/); | ||
| await expect(page).toHaveURL(/RareTag/); | ||
| await page.getByRole('button', { exact: true, name: 'Retry' }).click(); | ||
| await expect(page.getByRole('option', { exact: true, name: 'Failover' })).toBeVisible(); | ||
| await input.fill('Rare'); | ||
| await page.clock.fastForward(350); | ||
| await expect(page.getByRole('option', { exact: true, name: 'RareTag' })).toBeVisible(); | ||
| await page.clock.fastForward(350); | ||
| expect(requests).toHaveLength(4); | ||
| }); | ||
|
|
||
| async function setup(page: Page, handleTags: (route: Route, aggregation: string) => Promise<void>) { | ||
| page.setDefaultTimeout(10000); | ||
| await page.addInitScript((organizationId) => { | ||
| localStorage.setItem('satellizer_token', 'synthetic-tag-test-token'); | ||
| localStorage.setItem('organization', JSON.stringify(organizationId)); | ||
| }, ORGANIZATION_ID); | ||
| await page.route('**/health', (route) => route.fulfill({ body: 'OK' })); | ||
| await page.route('**/api/v2/**', async (route) => { | ||
| const url = new URL(route.request().url()); | ||
| const aggregation = url.searchParams.get('aggregations'); | ||
| if (aggregation?.startsWith('terms:(tags~')) { | ||
| expect(url.pathname).toBe(`/api/v2/organizations/${ORGANIZATION_ID}/events/count`); | ||
| expect(url.searchParams.get('filter')).toBeNull(); | ||
| expect(url.searchParams.get('time')).toBe('all'); | ||
| await handleTags(route, aggregation); | ||
| } else if (url.pathname === '/api/v2/users/me') { | ||
| await route.fulfill({ | ||
| json: { | ||
| email_address: 'tags@example.test', | ||
| full_name: 'Test User', | ||
| id: '000000000000000000000002', | ||
| is_active: true, | ||
| is_email_address_verified: true, | ||
| organization_ids: [ORGANIZATION_ID], | ||
| organization_preferences: [], | ||
| roles: [] | ||
| } | ||
| }); | ||
| } else if (url.pathname === '/api/v2/organizations' || url.pathname === `/api/v2/organizations/${ORGANIZATION_ID}`) { | ||
| const organization = { features: [], id: ORGANIZATION_ID, name: 'Test Organization', plan_id: 'EX_UNLIMITED', plan_name: 'Unlimited' }; | ||
| await route.fulfill({ json: url.pathname === '/api/v2/organizations' ? [organization] : organization }); | ||
| } else if (url.pathname.endsWith('/projects')) { | ||
| await route.fulfill({ json: [{ id: '000000000000000000000003', name: 'Project One', organization_id: ORGANIZATION_ID }] }); | ||
| } else if (url.pathname === '/api/v2/assistant/access') { | ||
| await route.fulfill({ json: { enabled: false, has_access: false } }); | ||
| } else if (url.pathname.endsWith('/count')) { | ||
| await route.fulfill({ json: { aggregations: {}, total: 0 } }); | ||
| } else { | ||
| await route.fulfill({ json: [] }); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| function tags(values: string[], omitted = 0) { | ||
| return { | ||
| aggregations: { | ||
| terms_tags: { | ||
| data: { '@type': 'bucket', ...(omitted ? { SumOtherDocCount: omitted } : {}) }, | ||
| items: values.map((key) => ({ key, total: 1 })) | ||
| } | ||
| }, | ||
| total: values.length | ||
| }; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
27 changes: 27 additions & 0 deletions
27
...eb/ClientApp/src/lib/features/events/components/filters/tag-faceted-filter.svelte.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| import { render } from '@testing-library/svelte'; | ||
| import { tick } from 'svelte'; | ||
| import { describe, expect, it, vi } from 'vitest'; | ||
|
|
||
| import { TagFilter } from './models.svelte'; | ||
| import TagFacetedFilter from './tag-faceted-filter.svelte'; | ||
|
|
||
| vi.mock('$features/organizations/context.svelte', () => ({ organization: { current: 'organization-id' } })); | ||
| vi.mock('$features/events/api.svelte', () => ({ | ||
| getTagSuggestionsQuery: () => ({ | ||
| data: { aggregations: { terms_tags: { data: { '@type': 'bucket', SumOtherDocCount: 1 }, items: [{ key: 'common', total: 2 }] } } }, | ||
| isError: false, | ||
| isFetching: false, | ||
| isSuccess: true | ||
| }) | ||
| })); | ||
|
|
||
| describe('tag suggestions', () => { | ||
| it('preserves a selected tag absent from the returned aggregation', async () => { | ||
| const filter = new TagFilter(['rare']); | ||
| const filterChanged = vi.fn(); | ||
| render(TagFacetedFilter, { filter, filterChanged, filterRemoved: vi.fn(), open: false, title: 'Tag' }); | ||
| await tick(); | ||
| expect(filter.value).toEqual(['rare']); | ||
| expect(filterChanged).not.toHaveBeenCalled(); | ||
| }); | ||
| }); |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When a user types a query and closes the picker, this branch clears only
debouncedSearch; the boundsearchstate retains the query. Reopening the picker therefore immediately filters the suggestions by the previous text and may launch another remote lookup instead of showing the full tag list as it did previously. Resetsearchwhenopenbecomes false.Useful? React with 👍 / 👎.