Skip to content

Commit

Permalink
Attempt to get rid of SavedObjectClass (elastic#192265)
Browse files Browse the repository at this point in the history
## Summary

Another step towards getting rid of the savedobjects plugin which was
scheduled for removal since 2019 😓
elastic#46435


### 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
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] 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)

---------

Co-authored-by: kibanamachine <[email protected]>
  • Loading branch information
rudolf and kibanamachine authored Sep 20, 2024
1 parent d30b9c8 commit ac29d0f
Show file tree
Hide file tree
Showing 44 changed files with 10 additions and 2,026 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ export const savedObjectsTaggingServiceFactory: SavedObjectsTaggingServiceFactor

// I'm not defining components so that I don't have to update the snapshot of `save_modal.test`
// However, if it's ever necessary, it can be done via: `components: pluginMock.components`,
hasTagDecoration: pluginMock.hasTagDecoration,
parseSearchQuery: pluginMock.parseSearchQuery,
getSearchBarFilter: pluginMock.getSearchBarFilter,
getTagIdsFromReferences: pluginMock.getTagIdsFromReferences,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ export const savedObjectsTaggingServiceFactory: SavedObjectsTaggingServiceFactor
ui: {
components,
parseSearchQuery,
hasTagDecoration,
getSearchBarFilter,
updateTagsReferences,
getTagIdsFromReferences,
Expand All @@ -42,7 +41,6 @@ export const savedObjectsTaggingServiceFactory: SavedObjectsTaggingServiceFactor
hasApi: true,
api: taggingApi,
components,
hasTagDecoration,
parseSearchQuery,
getSearchBarFilter,
updateTagsReferences,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ export interface DashboardSavedObjectsTaggingService {
hasApi: boolean; // remove this once the entire service is optional
api?: SavedObjectsTaggingApi;
components?: SavedObjectsTaggingApi['ui']['components'];
hasTagDecoration?: SavedObjectsTaggingApi['ui']['hasTagDecoration'];
parseSearchQuery?: SavedObjectsTaggingApi['ui']['parseSearchQuery'];
getSearchBarFilter?: SavedObjectsTaggingApi['ui']['getSearchBarFilter'];
updateTagsReferences?: SavedObjectsTaggingApi['ui']['updateTagsReferences'];
Expand Down
3 changes: 0 additions & 3 deletions src/plugins/saved_objects/kibana.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,6 @@
"requiredPlugins": [
"data",
"dataViews"
],
"requiredBundles": [
"kibanaUtils"
]
}
}
6 changes: 0 additions & 6 deletions src/plugins/saved_objects/public/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,7 @@ import { SavedObjectsPublicPlugin } from './plugin';

export type { OnSaveProps, OriginSaveModalProps, SaveModalState, SaveResult } from './save_modal';
export { SavedObjectSaveModal, SavedObjectSaveModalOrigin, showSaveModal } from './save_modal';
export type {
SavedObjectDecorator,
SavedObjectDecoratorFactory,
SavedObjectDecoratorConfig,
} from './saved_object';
export { checkForDuplicateTitle, saveWithConfirmation, isErrorNonFatal } from './saved_object';
export type { SavedObjectSaveOpts, SavedObject, SavedObjectConfig } from './types';
export type { SavedObjectsStart, SavedObjectSetup } from './plugin';

export const plugin = () => new SavedObjectsPublicPlugin();
19 changes: 1 addition & 18 deletions src/plugins/saved_objects/public/mocks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,4 @@
* License v3.0 only", or the "Server Side Public License, v 1".
*/

import { SavedObjectsStart, SavedObjectSetup } from './plugin';

const createStartContract = (): SavedObjectsStart => {
return {
SavedObjectClass: jest.fn(),
};
};

const createSetupContract = (): jest.Mocked<SavedObjectSetup> => {
return {
registerDecorator: jest.fn(),
};
};

export const savedObjectsPluginMock = {
createStartContract,
createSetupContract,
};
export const savedObjectsPluginMock = {};
44 changes: 4 additions & 40 deletions src/plugins/saved_objects/public/plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,55 +12,19 @@ import { CoreStart, Plugin } from '@kbn/core/public';
import './index.scss';
import { DataPublicPluginStart } from '@kbn/data-plugin/public';
import { DataViewsPublicPluginStart } from '@kbn/data-views-plugin/public';
import {
createSavedObjectClass,
SavedObjectDecoratorRegistry,
SavedObjectDecoratorConfig,
} from './saved_object';
import { SavedObject } from './types';
import { setStartServices } from './kibana_services';

export interface SavedObjectSetup {
registerDecorator: (config: SavedObjectDecoratorConfig<any>) => void;
}

export interface SavedObjectsStart {
/**
* @deprecated
* @removeBy 8.8.0
*/
SavedObjectClass: new (raw: Record<string, any>) => SavedObject;
}

export interface SavedObjectsStartDeps {
data: DataPublicPluginStart;
dataViews: DataViewsPublicPluginStart;
}

export class SavedObjectsPublicPlugin
implements Plugin<SavedObjectSetup, SavedObjectsStart, object, SavedObjectsStartDeps>
{
private decoratorRegistry = new SavedObjectDecoratorRegistry();

public setup(): SavedObjectSetup {
return {
registerDecorator: (config) => this.decoratorRegistry.register(config),
};
export class SavedObjectsPublicPlugin implements Plugin<{}, {}, object, SavedObjectsStartDeps> {
public setup() {
return {};
}
public start(core: CoreStart, { data, dataViews }: SavedObjectsStartDeps) {
setStartServices(core);
return {
SavedObjectClass: createSavedObjectClass(
{
dataViews,
savedObjectsClient: core.savedObjects.client,
search: data.search,
chrome: core.chrome,
overlays: core.overlays,
},
core,
this.decoratorRegistry
),
};
return {};
}
}
12 changes: 0 additions & 12 deletions src/plugins/saved_objects/public/saved_object/decorators/index.ts

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

34 changes: 0 additions & 34 deletions src/plugins/saved_objects/public/saved_object/decorators/types.ts

This file was deleted.

Loading

0 comments on commit ac29d0f

Please sign in to comment.