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.

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

[App Search] Schema: Set up server routes, grand foray into shared/connected Kea logic #99548

Merged
merged 11 commits into from
May 11, 2021
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/*
* 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 {
Schema,
IndexJob,
SchemaConflicts,
FieldCoercionErrors,
} from '../../../shared/schema/types';

export interface SchemaApiResponse {
schema: Schema;
mostRecentIndexJob: IndexJob;
unconfirmedFields: string[];
unsearchedUnconfirmedFields: boolean;
}

export interface MetaEngineSchemaApiResponse {
schema: Schema;
fields: SchemaConflicts;
conflictingFields: SchemaConflicts;
}

export interface ReindexJobApiResponse {
fieldCoercionErrors: FieldCoercionErrors;
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import { registerEnginesRoutes } from './engines';
import { registerOnboardingRoutes } from './onboarding';
import { registerResultSettingsRoutes } from './result_settings';
import { registerRoleMappingsRoutes } from './role_mappings';
import { registerSchemaRoutes } from './schema';
import { registerSearchSettingsRoutes } from './search_settings';
import { registerSearchUIRoutes } from './search_ui';
import { registerSettingsRoutes } from './settings';
Expand All @@ -28,6 +29,7 @@ export const registerAppSearchRoutes = (dependencies: RouteDependencies) => {
registerAnalyticsRoutes(dependencies);
registerDocumentsRoutes(dependencies);
registerDocumentRoutes(dependencies);
registerSchemaRoutes(dependencies);
registerCurationsRoutes(dependencies);
registerSynonymsRoutes(dependencies);
registerSearchSettingsRoutes(dependencies);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
/*
* 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 { MockRouter, mockRequestHandler, mockDependencies } from '../../__mocks__';

import { registerSchemaRoutes } from './schema';

describe('schema routes', () => {
describe('GET /api/app_search/engines/{engineName}/schema', () => {
let mockRouter: MockRouter;

beforeEach(() => {
jest.clearAllMocks();
mockRouter = new MockRouter({
method: 'get',
path: '/api/app_search/engines/{engineName}/schema',
});

registerSchemaRoutes({
...mockDependencies,
router: mockRouter.router,
});
});

it('creates a request handler', () => {
expect(mockRequestHandler.createRequest).toHaveBeenCalledWith({
path: '/as/engines/:engineName/schema',
});
});
});

describe('POST /api/app_search/engines/{engineName}/schema', () => {
let mockRouter: MockRouter;

beforeEach(() => {
jest.clearAllMocks();
mockRouter = new MockRouter({
method: 'post',
path: '/api/app_search/engines/{engineName}/schema',
});

registerSchemaRoutes({
...mockDependencies,
router: mockRouter.router,
});
});

it('creates a request handler', () => {
expect(mockRequestHandler.createRequest).toHaveBeenCalledWith({
path: '/as/engines/:engineName/schema',
});
});
});

describe('GET /api/app_search/engines/{engineName}/reindex_job/{reindexJobId}', () => {
let mockRouter: MockRouter;

beforeEach(() => {
jest.clearAllMocks();
mockRouter = new MockRouter({
method: 'get',
path: '/api/app_search/engines/{engineName}/reindex_job/{reindexJobId}',
});

registerSchemaRoutes({
...mockDependencies,
router: mockRouter.router,
});
});

it('creates a request handler', () => {
expect(mockRequestHandler.createRequest).toHaveBeenCalledWith({
path: '/as/engines/:engineName/reindex_job/:reindexJobId',
});
});
});
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
/*
* 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 { schema } from '@kbn/config-schema';

import { skipBodyValidation } from '../../lib/route_config_helpers';
import { RouteDependencies } from '../../plugin';

export function registerSchemaRoutes({
router,
enterpriseSearchRequestHandler,
}: RouteDependencies) {
router.get(
{
path: '/api/app_search/engines/{engineName}/schema',
validate: {
params: schema.object({
engineName: schema.string(),
}),
},
},
enterpriseSearchRequestHandler.createRequest({
path: '/as/engines/:engineName/schema',
})
);

router.post(
skipBodyValidation({
path: '/api/app_search/engines/{engineName}/schema',
validate: {
params: schema.object({
engineName: schema.string(),
}),
},
}),
enterpriseSearchRequestHandler.createRequest({
path: '/as/engines/:engineName/schema',
})
);

router.get(
{
path: '/api/app_search/engines/{engineName}/reindex_job/{reindexJobId}',
validate: {
params: schema.object({
engineName: schema.string(),
reindexJobId: schema.string(),
}),
},
},
enterpriseSearchRequestHandler.createRequest({
path: '/as/engines/:engineName/reindex_job/:reindexJobId',
})
);
}