Skip to content

Commit

Permalink
[Canvas] Restore enabled config in dev (#154391)
Browse files Browse the repository at this point in the history
## Summary

Related to #152395.
Closes #154394.

This restores the `enabled` config setting for the Canvas plugin (in
development only for now until
#152395 is addressed).

Restoring the `xpack.canvas.enabled` setting will allow Canvas to be
disabled in future offerings.

### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [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
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces—unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes—Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
  • Loading branch information
cqliu1 authored Apr 6, 2023
1 parent 99f366a commit b222c0a
Show file tree
Hide file tree
Showing 4 changed files with 84 additions and 1 deletion.
53 changes: 53 additions & 0 deletions x-pack/plugins/canvas/server/config.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/*
* 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.
*/

jest.mock('crypto', () => ({
randomBytes: jest.fn(),
constants: jest.requireActual('crypto').constants,
}));

jest.mock('@kbn/utils', () => ({
getLogsPath: () => '/mock/kibana/logs/path',
}));

import { ConfigSchema } from './config';

describe('config schema', () => {
it('generates proper defaults', () => {
expect(ConfigSchema.validate({})).toMatchInlineSnapshot(`
Object {
"enabled": true,
}
`);

expect(ConfigSchema.validate({}, { dev: false })).toMatchInlineSnapshot(`
Object {
"enabled": true,
}
`);

expect(ConfigSchema.validate({}, { dev: true })).toMatchInlineSnapshot(`
Object {
"enabled": true,
}
`);
});

it('should throw error if spaces is disabled', () => {
expect(() => ConfigSchema.validate({ enabled: false })).toThrow(
'[enabled]: Canvas can only be disabled in development mode'
);

expect(() => ConfigSchema.validate({ enabled: false }, { dev: false })).toThrow(
'[enabled]: Canvas can only be disabled in development mode'
);
});

it('should not throw error if spaces is disabled in development mode', () => {
expect(() => ConfigSchema.validate({ enabled: false }, { dev: true })).not.toThrow();
});
});
24 changes: 24 additions & 0 deletions x-pack/plugins/canvas/server/config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/*
* 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';

export const ConfigSchema = schema.object({
enabled: schema.conditional(
schema.contextRef('dev'),
true,
schema.boolean({ defaultValue: true }),
schema.boolean({
validate: (rawValue) => {
if (rawValue === false) {
return 'Canvas can only be disabled in development mode';
}
},
defaultValue: true,
})
),
});
7 changes: 6 additions & 1 deletion x-pack/plugins/canvas/server/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,13 @@
* 2.0.
*/

import { PluginInitializerContext } from '@kbn/core/server';
import { PluginConfigDescriptor, PluginInitializerContext } from '@kbn/core/server';
import { CanvasPlugin } from './plugin';
import { ConfigSchema } from './config';

export const config: PluginConfigDescriptor = {
schema: ConfigSchema,
};

export const plugin = (initializerContext: PluginInitializerContext) =>
new CanvasPlugin(initializerContext);
1 change: 1 addition & 0 deletions x-pack/plugins/canvas/server/plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ interface PluginsStart {

export class CanvasPlugin implements Plugin {
private readonly logger: Logger;

constructor(public readonly initializerContext: PluginInitializerContext) {
this.logger = initializerContext.logger.get();
}
Expand Down

0 comments on commit b222c0a

Please sign in to comment.