Skip to content
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.

Sign up for GitHub

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

[9.0] [Search] Don't error out on missing connectors permissions (#212622) #212763

Merged
merged 1 commit into from
Feb 28, 2025
Merged

[9.0] [Search] Don't error out on missing connectors permissions (#212622) #212763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions x-pack/solutions/search/plugins/enterprise_search/server/lib/indices/fetch_index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*/

import { ByteSizeValue } from '@kbn/config-schema';
import { IScopedClusterClient } from '@kbn/core/server';
import { IScopedClusterClient, Logger } from '@kbn/core/server';

import { fetchConnectorByIndexName } from '@kbn/search-connectors';

Expand Down Expand Up @@ -47,6 +47,10 @@ describe('fetchIndex lib function', () => {
jest.clearAllMocks();
});

const logger = {
error: jest.fn(),
} as any as Logger;

const statsResponse = {
indices: {
index_name: {
Expand Down Expand Up @@ -101,7 +105,7 @@ describe('fetchIndex lib function', () => {
mockClient.asCurrentUser.indices.stats.mockImplementation(() => Promise.resolve(statsResponse));

await expect(
fetchIndex(mockClient as unknown as IScopedClusterClient, 'index_name')
fetchIndex(mockClient as unknown as IScopedClusterClient, 'index_name', logger)
).resolves.toEqual(result);
});

Expand All @@ -125,7 +129,7 @@ describe('fetchIndex lib function', () => {
mockClient.asCurrentUser.indices.stats.mockImplementation(() => Promise.resolve(statsResponse));

await expect(
fetchIndex(mockClient as unknown as IScopedClusterClient, 'index_name')
fetchIndex(mockClient as unknown as IScopedClusterClient, 'index_name', logger)
).resolves.toEqual({
...result,
connector: { doc: 'doc', service_type: 'some-service-type' },
Expand All @@ -141,7 +145,7 @@ describe('fetchIndex lib function', () => {
mockClient.asCurrentUser.indices.stats.mockImplementation(() => Promise.resolve(statsResponse));

await expect(
fetchIndex(mockClient as unknown as IScopedClusterClient, 'index_name')
fetchIndex(mockClient as unknown as IScopedClusterClient, 'index_name', logger)
).rejects.toEqual(new Error('404'));
});
it('should throw a 404 error if the indexStats cannot be fonud', async () => {
Expand All @@ -158,7 +162,7 @@ describe('fetchIndex lib function', () => {
);

await expect(
fetchIndex(mockClient as unknown as IScopedClusterClient, 'index_name')
fetchIndex(mockClient as unknown as IScopedClusterClient, 'index_name', logger)
).rejects.toEqual(new Error('404'));
});
it('should throw a 404 error if the index stats indices cannot be fonud', async () => {
Expand All @@ -173,7 +177,7 @@ describe('fetchIndex lib function', () => {
mockClient.asCurrentUser.indices.stats.mockImplementation(() => Promise.resolve({}));

await expect(
fetchIndex(mockClient as unknown as IScopedClusterClient, 'index_name')
fetchIndex(mockClient as unknown as IScopedClusterClient, 'index_name', logger)
).rejects.toEqual(new Error('404'));
});
});
16 changes: 10 additions & 6 deletions x-pack/solutions/search/plugins/enterprise_search/server/lib/indices/fetch_index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,10 @@
* 2.0.
*/

import { IScopedClusterClient } from '@kbn/core/server';

import {} from '../..';
import { IScopedClusterClient, Logger } from '@kbn/core/server';

import {
Connector,
CONNECTORS_JOBS_INDEX,
ConnectorSyncJobDocument,
fetchConnectorByIndexName,
Expand Down Expand Up @@ -60,7 +59,8 @@ const hasInProgressSyncs = async (

export const fetchIndex = async (
client: IScopedClusterClient,
index: string
index: string,
logger: Logger
): Promise<ElasticsearchIndexWithIngestion> => {
const indexDataResult = await client.asCurrentUser.indices.get({ index });
const indexData = indexDataResult[index];
Expand All @@ -72,8 +72,12 @@ export const fetchIndex = async (
throw new Error('404');
}
const indexStats = indices[index];

const connector = await fetchConnectorByIndexName(client.asCurrentUser, index);
let connector: Connector | undefined;
try {
connector = await fetchConnectorByIndexName(client.asCurrentUser, index);
} catch (error) {
logger.error(`Error fetching connector for index ${index}: ${error}`);
}
const hasInProgressSyncsResult = connector
? await hasInProgressSyncs(client, connector.id)
: { inProgress: false, pending: false };
Expand Down
9 changes: 7 additions & 2 deletions ...solutions/search/plugins/enterprise_search/server/lib/indices/fetch_unattached_indices.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*/

import { IScopedClusterClient } from '@kbn/core/server';
import { fetchConnectors } from '@kbn/search-connectors';
import { Connector, fetchConnectors } from '@kbn/search-connectors';

import { isNotNullish } from '../../../common/utils/is_not_nullish';

Expand All @@ -22,7 +22,12 @@ export const fetchUnattachedIndices = async (
totalResults: number;
}> => {
const { indexNames } = await getUnattachedIndexData(client, searchQuery);
const connectors = await fetchConnectors(client.asCurrentUser, indexNames);
let connectors: Connector[] = [];
try {
connectors = await fetchConnectors(client.asCurrentUser, indexNames);
} catch (error) {
connectors = [];
}

const connectedIndexNames = [...connectors.map((con) => con.index_name).filter(isNotNullish)];

Expand Down
2 changes: 1 addition & 1 deletion x-pack/solutions/search/plugins/enterprise_search/server/lib/pipelines/get_index_pipeline.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export const getIndexPipelineParameters = async (
// we want to throw the error if getDefaultPipeline() fails so we're not catching it on purpose
const [defaultPipeline, connector, customPipelineResp] = await Promise.all([
getDefaultPipeline(client),
fetchConnectorByIndexName(client.asCurrentUser, indexName),
fetchConnectorByIndexName(client.asCurrentUser, indexName).catch(() => null),
client.asCurrentUser.ingest
.getPipeline({
id: `${indexName}`,
Expand Down
31 changes: 23 additions & 8 deletions x-pack/solutions/search/plugins/enterprise_search/server/routes/enterprise_search/indices.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import {
deleteConnectorSecret,
deleteConnectorById,
updateConnectorIndexName,
Connector,
} from '@kbn/search-connectors';
import {
fetchConnectorByIndexName,
Expand Down Expand Up @@ -119,7 +120,13 @@ export function registerIndexRoutes({ router, log, ml }: RouteDependencies) {
from,
size
);
const connectors = await fetchConnectors(client.asCurrentUser, indexNames);
let connectors: Connector[] = [];
// If the user doesn't have permissions, fetchConnectors will error out. We still want to return indices in that case.
try {
connectors = await fetchConnectors(client.asCurrentUser, indexNames);
} catch {
connectors = [];
}
const enrichedIndices = indices.map((index) => ({
...index,
connector: connectors.find((connector) => connector.index_name === index.name),
Expand Down Expand Up @@ -155,7 +162,7 @@ export function registerIndexRoutes({ router, log, ml }: RouteDependencies) {
const { client } = (await context.core).elasticsearch;

try {
const index = await fetchIndex(client, indexName);
const index = await fetchIndex(client, indexName, log);
return response.ok({
body: index,
headers: { 'content-type': 'application/json' },
Expand Down Expand Up @@ -189,7 +196,13 @@ export function registerIndexRoutes({ router, log, ml }: RouteDependencies) {
const { client } = (await context.core).elasticsearch;

try {
const connector = await fetchConnectorByIndexName(client.asCurrentUser, indexName);
let connector: Connector | undefined;
// users without permissions to fetch connectors should still see a result
try {
connector = await fetchConnectorByIndexName(client.asCurrentUser, indexName);
} catch (error) {
log.error(`Error fetching connector for index ${indexName}: ${error}`);
}

if (connector) {
if (connector.service_type === CRAWLER_SERVICE_TYPE) {
Expand Down Expand Up @@ -567,11 +580,13 @@ export function registerIndexRoutes({ router, log, ml }: RouteDependencies) {
statusCode: 409,
});
}

const connector = await fetchConnectorByIndexName(
client.asCurrentUser,
request.body.index_name
);
let connector: Connector | undefined;
// users without permissions to fetch connectors should still be able to create an index
try {
connector = await fetchConnectorByIndexName(client.asCurrentUser, indexName);
} catch (error) {
log.error(`Error fetching connector for index ${indexName}: ${error}`);
}

if (connector) {
return createError({
Expand Down