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

Specifying valid licenses for the Graph feature #55911

Merged
merged 7 commits into from
Feb 7, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions x-pack/legacy/plugins/graph/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ export const graph: LegacyPluginInitializer = kibana => {
navLinkId: 'graph',
app: ['graph', 'kibana'],
catalogue: ['graph'],
validLicenses: ['platinum', 'enterprise', 'trial'],
privileges: {
all: {
savedObject: {
Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugins/features/common/feature.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export interface Feature<
* This does not restrict access to your feature based on license.
* Its only purpose is to inform the space and roles UIs on which features to display.
*/
validLicenses?: Array<'basic' | 'standard' | 'gold' | 'platinum' | 'enterprise'>;
validLicenses?: Array<'basic' | 'standard' | 'gold' | 'platinum' | 'enterprise' | 'trial'>;

/**
* An optional EUI Icon to be used when displaying your feature.
Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugins/features/server/feature_schema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ const schema = Joi.object({
name: Joi.string().required(),
excludeFromBasePrivileges: Joi.boolean(),
validLicenses: Joi.array().items(
Joi.string().valid('basic', 'standard', 'gold', 'platinum', 'enterprise')
Joi.string().valid('basic', 'standard', 'gold', 'platinum', 'enterprise', 'trial')
),
icon: Joi.string(),
description: Joi.string(),
Expand Down
65 changes: 62 additions & 3 deletions x-pack/plugins/features/server/routes/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ describe('GET /api/features', () => {

it('returns a list of available features', async () => {
const mockResponse = httpServerMock.createResponseFactory();
routeHandler(undefined as any, undefined as any, mockResponse);
routeHandler(undefined as any, { query: {} } as any, mockResponse);

expect(mockResponse.ok.mock.calls).toMatchInlineSnapshot(`
Array [
Expand Down Expand Up @@ -84,11 +84,11 @@ describe('GET /api/features', () => {
`);
});

it(`does not return features that arent allowed by current license`, async () => {
it(`by default does not return features that arent allowed by current license`, async () => {
currentLicenseLevel = 'basic';

const mockResponse = httpServerMock.createResponseFactory();
routeHandler(undefined as any, undefined as any, mockResponse);
routeHandler(undefined as any, { query: {} } as any, mockResponse);

expect(mockResponse.ok.mock.calls).toMatchInlineSnapshot(`
Array [
Expand All @@ -107,4 +107,63 @@ describe('GET /api/features', () => {
]
`);
});

it(`ignoreValidLicenses=false does not return features that arent allowed by current license`, async () => {
currentLicenseLevel = 'basic';

const mockResponse = httpServerMock.createResponseFactory();
routeHandler(undefined as any, { query: { ignoreValidLicenses: false } } as any, mockResponse);

expect(mockResponse.ok.mock.calls).toMatchInlineSnapshot(`
Array [
Array [
Object {
"body": Array [
Object {
"app": Array [],
"id": "feature_1",
"name": "Feature 1",
"privileges": Object {},
},
],
},
],
]
`);
});

it(`ignoreValidLicenses=true returns features that arent allowed by current license`, async () => {
currentLicenseLevel = 'basic';

const mockResponse = httpServerMock.createResponseFactory();
routeHandler(undefined as any, { query: { ignoreValidLicenses: true } } as any, mockResponse);

expect(mockResponse.ok.mock.calls).toMatchInlineSnapshot(`
Array [
Array [
Object {
"body": Array [
Object {
"app": Array [],
"id": "feature_1",
"name": "Feature 1",
"privileges": Object {},
},
Object {
"app": Array [
"bar-app",
],
"id": "licensed_feature",
"name": "Licensed Feature",
"privileges": Object {},
"validLicenses": Array [
"gold",
],
},
],
},
],
]
`);
});
});
10 changes: 9 additions & 1 deletion x-pack/plugins/features/server/routes/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
* you may not use this file except in compliance with the Elastic License.
*/

import { schema } from '@kbn/config-schema';
import { IRouter } from '../../../../../src/core/server';
import { LegacyAPI } from '../plugin';
import { FeatureRegistry } from '../feature_registry';
Expand All @@ -19,13 +20,20 @@ export interface RouteDefinitionParams {

export function defineRoutes({ router, featureRegistry, getLegacyAPI }: RouteDefinitionParams) {
router.get(
{ path: '/api/features', options: { tags: ['access:features'] }, validate: false },
{
path: '/api/features',
options: { tags: ['access:features'] },
validate: {
query: schema.object({ ignoreValidLicenses: schema.boolean({ defaultValue: false }) }),
},
},
(context, request, response) => {
const allFeatures = featureRegistry.getAll();

return response.ok({
body: allFeatures.filter(
feature =>
request.query.ignoreValidLicenses ||
!feature.validLicenses ||
!feature.validLicenses.length ||
getLegacyAPI().xpackInfo.license.isOneOf(feature.validLicenses)
Expand Down
6 changes: 4 additions & 2 deletions x-pack/test/ui_capabilities/common/services/features.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,11 @@ export class FeaturesService {
});
}

public async get(): Promise<Features> {
public async get({ ignoreValidLicenses } = { ignoreValidLicenses: false }): Promise<Features> {
this.log.debug('requesting /api/features to get the features');
const response = await this.axios.get('/api/features');
const response = await this.axios.get(
`/api/features?ignoreValidLicenses=${ignoreValidLicenses}`
);

if (response.status !== 200) {
throw new Error(
Expand Down
3 changes: 2 additions & 1 deletion x-pack/test/ui_capabilities/spaces_only/tests/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ export default function uiCapabilitesTests({ loadTestFile, getService }: FtrProv
this.tags('ciGroup9');

before(async () => {
const features = await featuresService.get();
// we're using a basic license, so if we want to disable all features, we have to ignore the valid licenses
const features = await featuresService.get({ ignoreValidLicenses: true });
for (const space of SpaceScenarios) {
const disabledFeatures =
space.disabledFeatures === '*' ? Object.keys(features) : space.disabledFeatures;
Expand Down