-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Search] Fix connector recheck and polling related issues (#178148)
## Summary Updates data fetching to rely on purely connector polling rather than index polling. This fixes a bunch of bugs related to data not being up to date. It also fixes two small UI issues. ### Checklist Delete any items that are not applicable to this PR. - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed
- Loading branch information
Showing
6 changed files
with
200 additions
and
55 deletions.
There are no files selected for viewing
152 changes: 152 additions & 0 deletions
152
...cations/enterprise_search_content/api/connector/cached_fetch_connector_by_id_api_logic.ts
This file contains 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,152 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import { kea, MakeLogicType } from 'kea'; | ||
|
|
||
| import { isEqual } from 'lodash'; | ||
|
|
||
| import { Connector } from '@kbn/search-connectors'; | ||
|
|
||
| import { Status } from '../../../../../common/types/api'; | ||
|
|
||
| import { Actions } from '../../../shared/api_logic/create_api_logic'; | ||
|
|
||
| import { | ||
| FetchConnectorByIdApiLogic, | ||
| FetchConnectorByIdApiLogicArgs, | ||
| FetchConnectorByIdApiLogicResponse, | ||
| } from './fetch_connector_by_id_logic'; | ||
|
|
||
| const FETCH_CONNECTOR_POLLING_DURATION = 5000; // 5 seconds | ||
| const FETCH_CONNECTOR_POLLING_DURATION_ON_FAILURE = 30000; // 30 seconds | ||
|
|
||
| export interface CachedFetchConnectorByIdApiLogicActions { | ||
| apiError: Actions<FetchConnectorByIdApiLogicArgs, FetchConnectorByIdApiLogicResponse>['apiError']; | ||
| apiReset: Actions<FetchConnectorByIdApiLogicArgs, FetchConnectorByIdApiLogicResponse>['apiReset']; | ||
| apiSuccess: Actions< | ||
| FetchConnectorByIdApiLogicArgs, | ||
| FetchConnectorByIdApiLogicResponse | ||
| >['apiSuccess']; | ||
| clearPollTimeout(): void; | ||
| createPollTimeout(duration: number): { duration: number }; | ||
| makeRequest: Actions< | ||
| FetchConnectorByIdApiLogicArgs, | ||
| FetchConnectorByIdApiLogicResponse | ||
| >['makeRequest']; | ||
| setTimeoutId(id: NodeJS.Timeout): { id: NodeJS.Timeout }; | ||
| startPolling(connectorId: string): { connectorId: string }; | ||
| stopPolling(): void; | ||
| } | ||
| export interface CachedFetchConnectorByIdApiLogicValues { | ||
| connectorData: Connector | null; | ||
| connectorId: string; | ||
| fetchConnectorByIdApiData: FetchConnectorByIdApiLogicResponse; | ||
| isInitialLoading: boolean; | ||
| isLoading: boolean; | ||
| pollTimeoutId: NodeJS.Timeout | null; | ||
| status: Status; | ||
| } | ||
|
|
||
| export const CachedFetchConnectorByIdApiLogic = kea< | ||
| MakeLogicType<CachedFetchConnectorByIdApiLogicValues, CachedFetchConnectorByIdApiLogicActions> | ||
| >({ | ||
| actions: { | ||
| clearPollTimeout: true, | ||
| createPollTimeout: (duration) => ({ duration }), | ||
| setTimeoutId: (id) => ({ id }), | ||
| startPolling: (connectorId) => ({ connectorId }), | ||
| stopPolling: true, | ||
| }, | ||
| connect: { | ||
| actions: [FetchConnectorByIdApiLogic, ['apiSuccess', 'apiError', 'apiReset', 'makeRequest']], | ||
| values: [FetchConnectorByIdApiLogic, ['data as fetchConnectorByIdApiData', 'status']], | ||
| }, | ||
| events: ({ values }) => ({ | ||
| beforeUnmount: () => { | ||
| if (values.pollTimeoutId) { | ||
| clearTimeout(values.pollTimeoutId); | ||
| } | ||
| }, | ||
| }), | ||
| listeners: ({ actions, values }) => ({ | ||
| apiError: () => { | ||
| if (values.pollTimeoutId) { | ||
| actions.createPollTimeout(FETCH_CONNECTOR_POLLING_DURATION_ON_FAILURE); | ||
| } | ||
| }, | ||
| apiSuccess: () => { | ||
| if (values.pollTimeoutId) { | ||
| actions.createPollTimeout(FETCH_CONNECTOR_POLLING_DURATION); | ||
| } | ||
| }, | ||
| createPollTimeout: ({ duration }) => { | ||
| if (values.pollTimeoutId) { | ||
| clearTimeout(values.pollTimeoutId); | ||
| } | ||
|
|
||
| const timeoutId = setTimeout(() => { | ||
| actions.makeRequest({ connectorId: values.connectorId }); | ||
| }, duration); | ||
| actions.setTimeoutId(timeoutId); | ||
| }, | ||
| startPolling: ({ connectorId }) => { | ||
| // Recurring polls are created by apiSuccess and apiError, depending on pollTimeoutId | ||
| if (values.pollTimeoutId) { | ||
| if (connectorId === values.connectorId) return; | ||
| clearTimeout(values.pollTimeoutId); | ||
| } | ||
| actions.makeRequest({ connectorId }); | ||
|
|
||
| actions.createPollTimeout(FETCH_CONNECTOR_POLLING_DURATION); | ||
| }, | ||
| stopPolling: () => { | ||
| if (values.pollTimeoutId) { | ||
| clearTimeout(values.pollTimeoutId); | ||
| } | ||
| actions.clearPollTimeout(); | ||
| }, | ||
| }), | ||
| path: ['enterprise_search', 'content', 'api', 'fetch_connector_by_id_api_wrapper'], | ||
| reducers: { | ||
| connectorData: [ | ||
| null, | ||
| { | ||
| apiReset: () => null, | ||
| apiSuccess: (currentState, newConnectorData) => { | ||
| return isEqual(currentState, newConnectorData.connector) | ||
| ? currentState | ||
| : newConnectorData.connector ?? null; | ||
| }, | ||
| }, | ||
| ], | ||
| connectorId: [ | ||
| '', | ||
| { | ||
| apiReset: () => '', | ||
| startPolling: (_, { connectorId }) => connectorId, | ||
| }, | ||
| ], | ||
| pollTimeoutId: [ | ||
| null, | ||
| { | ||
| clearPollTimeout: () => null, | ||
| setTimeoutId: (_, { id }) => id, | ||
| }, | ||
| ], | ||
| }, | ||
| selectors: ({ selectors }) => ({ | ||
| isInitialLoading: [ | ||
| () => [selectors.status, selectors.connectorData], | ||
| ( | ||
| status: CachedFetchConnectorByIdApiLogicValues['status'], | ||
| connectorData: CachedFetchConnectorByIdApiLogicValues['connectorData'] | ||
| ) => { | ||
| return status === Status.IDLE || (connectorData === null && status === Status.LOADING); | ||
| }, | ||
| ], | ||
| }), | ||
| }); |
This file contains 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 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 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 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
Oops, something went wrong.