github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 09:19:04 -04:00
Code Issues Projects Releases Packages Wiki Activity

[Controls] Move controls routes to internal (#158762)

Browse source 
Fixes #157084

## Summary

Moves Controls plugin routes to internal.

[More info on versioning HTTP
APIs](https://docs.elastic.dev/kibana-dev-docs/versioning-http-apis)
This commit is contained in:
Nick Peihl 2023-05-31 17:16:09 -04:00 • committed by GitHub
parent 1c75903f92
commit 0fb3099620
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 95 additions and 83 deletions
Download patch file Download diff file Expand all files Collapse all files

18
src/plugins/controls/public/services/options_list/options_list_service.ts
View file

@ -72,14 +72,12 @@ class OptionsListService implements ControlsOptionsListService {
async (request: OptionsListRequest, abortSignal: AbortSignal) => {
const index = request.dataView.title;
const requestBody = this.getRequestBody(request);
return await this.http.fetch<OptionsListResponse>(
`/api/kibana/controls/optionsList/${index}`,
{
body: JSON.stringify(requestBody),
signal: abortSignal,
method: 'POST',
}
);
return await this.http.fetch<OptionsListResponse>(`/internal/controls/optionsList/${index}`, {
version: '1',
body: JSON.stringify(requestBody),
signal: abortSignal,
method: 'POST',
});
},
this.optionsListCacheResolver
);
@ -104,7 +102,9 @@ class OptionsListService implements ControlsOptionsListService {
private cachedAllowExpensiveQueries = memoize(async () => {
const { allowExpensiveQueries } = await this.http.get<{
allowExpensiveQueries: boolean;
}>('/api/kibana/controls/optionsList/getExpensiveQueriesSetting');
}>('/internal/controls/optionsList/getExpensiveQueriesSetting', {
version: '1',
});
return allowExpensiveQueries;
});

73
src/plugins/controls/server/options_list/options_list_cluster_settings_route.ts
View file

@ -11,41 +11,46 @@ import { CoreSetup } from '@kbn/core/server';
export const setupOptionsListClusterSettingsRoute = ({ http }: CoreSetup) => {
const router = http.createRouter();
router.get(
{
path: '/api/kibana/controls/optionsList/getExpensiveQueriesSetting',
validate: false,
},
async (context, _, response) => {
try {
/**
* using internal user here because in many cases the logged in user will not have the monitor permission required
* to check cluster settings. This endpoint does not take a query, params, or a body, so there is no chance of leaking info.
*/
const esClient = (await context.core).elasticsearch.client.asInternalUser;
const settings = await esClient.cluster.getSettings({
include_defaults: true,
filter_path: '**.allow_expensive_queries',
});
router.versioned
.get({
access: 'internal',
path: '/internal/controls/optionsList/getExpensiveQueriesSetting',
})
.addVersion(
{
version: '1',
validate: false,
},
async (context, _, response) => {
try {
/**
* using internal user here because in many cases the logged in user will not have the monitor permission required
* to check cluster settings. This endpoint does not take a query, params, or a body, so there is no chance of leaking info.
*/
const esClient = (await context.core).elasticsearch.client.asInternalUser;
const settings = await esClient.cluster.getSettings({
include_defaults: true,
filter_path: '**.allow_expensive_queries',
});
// priority: transient -> persistent -> default
const allowExpensiveQueries: string =
settings.transient?.search?.allow_expensive_queries ??
settings.persistent?.search?.allow_expensive_queries ??
settings.defaults?.search?.allow_expensive_queries ??
// by default, the allowExpensiveQueries cluster setting is undefined; so, we need to treat this the same
// as `true` since that's the way other applications (such as the dashboard listing page) handle this.
'true';
// priority: transient -> persistent -> default
const allowExpensiveQueries: string =
settings.transient?.search?.allow_expensive_queries ??
settings.persistent?.search?.allow_expensive_queries ??
settings.defaults?.search?.allow_expensive_queries ??
// by default, the allowExpensiveQueries cluster setting is undefined; so, we need to treat this the same
// as `true` since that's the way other applications (such as the dashboard listing page) handle this.
'true';
return response.ok({
body: {
allowExpensiveQueries: allowExpensiveQueries === 'true',
},
});
} catch (e) {
const kbnErr = getKbnServerError(e);
return reportServerError(response, kbnErr);
return response.ok({
body: {
allowExpensiveQueries: allowExpensiveQueries === 'true',
},
});
} catch (e) {
const kbnErr = getKbnServerError(e);
return reportServerError(response, kbnErr);
}
}
}
);
);
};

87
src/plugins/controls/server/options_list/options_list_suggestions_route.ts
View file

@ -26,50 +26,57 @@ export const setupOptionsListSuggestionsRoute = (
) => {
const router = http.createRouter();
router.post(
{
path: '/api/kibana/controls/optionsList/{index}',
validate: {
params: schema.object(
{
index: schema.string(),
router.versioned
.post({
access: 'internal',
path: '/internal/controls/optionsList/{index}',
})
.addVersion(
{
version: '1',
validate: {
request: {
params: schema.object(
{
index: schema.string(),
},
{ unknowns: 'allow' }
),
body: schema.object(
{
size: schema.number(),
fieldName: schema.string(),
sort: schema.maybe(schema.any()),
filters: schema.maybe(schema.any()),
fieldSpec: schema.maybe(schema.any()),
allowExpensiveQueries: schema.boolean(),
searchString: schema.maybe(schema.string()),
selectedOptions: schema.maybe(schema.arrayOf(schema.string())),
},
{ unknowns: 'allow' }
),
},
{ unknowns: 'allow' }
),
body: schema.object(
{
size: schema.number(),
fieldName: schema.string(),
sort: schema.maybe(schema.any()),
filters: schema.maybe(schema.any()),
fieldSpec: schema.maybe(schema.any()),
allowExpensiveQueries: schema.boolean(),
searchString: schema.maybe(schema.string()),
selectedOptions: schema.maybe(schema.arrayOf(schema.string())),
},
{ unknowns: 'allow' }
),
},
},
},
async (context, request, response) => {
try {
const suggestionRequest: OptionsListRequestBody = request.body;
const { index } = request.params;
const esClient = (await context.core).elasticsearch.client.asCurrentUser;
async (context, request, response) => {
try {
const suggestionRequest: OptionsListRequestBody = request.body;
const { index } = request.params;
const esClient = (await context.core).elasticsearch.client.asCurrentUser;
const suggestionsResponse = await getOptionsListSuggestions({
abortedEvent$: request.events.aborted$,
request: suggestionRequest,
esClient,
index,
});
return response.ok({ body: suggestionsResponse });
} catch (e) {
const kbnErr = getKbnServerError(e);
return reportServerError(response, kbnErr);
const suggestionsResponse = await getOptionsListSuggestions({
abortedEvent$: request.events.aborted$,
request: suggestionRequest,
esClient,
index,
});
return response.ok({ body: suggestionsResponse });
} catch (e) {
const kbnErr = getKbnServerError(e);
return reportServerError(response, kbnErr);
}
}
}
);
);
const getOptionsListSuggestions = async ({
abortedEvent$,