mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
Refactor attribute service (#78414)
* Making saveMethod mandatory in attribute service * Making unwrap method mandatory * Making book embeddable respect new attribute service * Remove savedObjectsClient from attribute service * Add checkForDuplicateTitle method to book embeddable * Make options mandatory on attribute service * Changing Lens attribute service * Somw more typescript fixes * Fixing attribute service typescript and tests * Fixing typescript errors * Unsetting feature flag Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
parent
ffc1caa2d2
commit
989e9c9702
14 changed files with 261 additions and 153 deletions
|
@ -4,7 +4,7 @@
|
|||
"kibanaVersion": "kibana",
|
||||
"server": true,
|
||||
"ui": true,
|
||||
"requiredPlugins": ["embeddable", "uiActions", "dashboard"],
|
||||
"requiredPlugins": ["embeddable", "uiActions", "dashboard", "savedObjects"],
|
||||
"optionalPlugins": [],
|
||||
"extraPublicDirs": ["public/todo", "public/hello_world", "public/todo/todo_ref_embeddable"],
|
||||
"requiredBundles": ["kibanaReact"]
|
||||
|
|
|
@ -33,12 +33,19 @@ import {
|
|||
BookEmbeddableOutput,
|
||||
} from './book_embeddable';
|
||||
import { CreateEditBookComponent } from './create_edit_book_component';
|
||||
import { OverlayStart } from '../../../../src/core/public';
|
||||
import {
|
||||
OverlayStart,
|
||||
SavedObjectsClientContract,
|
||||
SimpleSavedObject,
|
||||
} from '../../../../src/core/public';
|
||||
import { DashboardStart, AttributeService } from '../../../../src/plugins/dashboard/public';
|
||||
import { checkForDuplicateTitle, OnSaveProps } from '../../../../src/plugins/saved_objects/public';
|
||||
|
||||
interface StartServices {
|
||||
getAttributeService: DashboardStart['getAttributeService'];
|
||||
openModal: OverlayStart['openModal'];
|
||||
savedObjectsClient: SavedObjectsClientContract;
|
||||
overlays: OverlayStart;
|
||||
}
|
||||
|
||||
export type BookEmbeddableFactory = EmbeddableFactory<
|
||||
|
@ -117,11 +124,55 @@ export class BookEmbeddableFactoryDefinition
|
|||
});
|
||||
}
|
||||
|
||||
private async unwrapMethod(savedObjectId: string): Promise<BookSavedObjectAttributes> {
|
||||
const { savedObjectsClient } = await this.getStartServices();
|
||||
const savedObject: SimpleSavedObject<BookSavedObjectAttributes> = await savedObjectsClient.get<
|
||||
BookSavedObjectAttributes
|
||||
>(this.type, savedObjectId);
|
||||
return { ...savedObject.attributes };
|
||||
}
|
||||
|
||||
private async saveMethod(
|
||||
type: string,
|
||||
attributes: BookSavedObjectAttributes,
|
||||
savedObjectId?: string
|
||||
) {
|
||||
const { savedObjectsClient } = await this.getStartServices();
|
||||
if (savedObjectId) {
|
||||
return savedObjectsClient.update(type, savedObjectId, attributes);
|
||||
}
|
||||
return savedObjectsClient.create(type, attributes);
|
||||
}
|
||||
|
||||
private async checkForDuplicateTitleMethod(props: OnSaveProps): Promise<true> {
|
||||
const start = await this.getStartServices();
|
||||
const { savedObjectsClient, overlays } = start;
|
||||
return checkForDuplicateTitle(
|
||||
{
|
||||
title: props.newTitle,
|
||||
copyOnSave: false,
|
||||
lastSavedTitle: '',
|
||||
getEsType: () => this.type,
|
||||
getDisplayName: this.getDisplayName || (() => this.type),
|
||||
},
|
||||
props.isTitleDuplicateConfirmed,
|
||||
props.onTitleDuplicate,
|
||||
{
|
||||
savedObjectsClient,
|
||||
overlays,
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
private async getAttributeService() {
|
||||
if (!this.attributeService) {
|
||||
this.attributeService = await (await this.getStartServices()).getAttributeService<
|
||||
this.attributeService = (await this.getStartServices()).getAttributeService<
|
||||
BookSavedObjectAttributes
|
||||
>(this.type);
|
||||
>(this.type, {
|
||||
saveMethod: this.saveMethod.bind(this),
|
||||
unwrapMethod: this.unwrapMethod.bind(this),
|
||||
checkForDuplicateTitle: this.checkForDuplicateTitleMethod.bind(this),
|
||||
});
|
||||
}
|
||||
return this.attributeService!;
|
||||
}
|
||||
|
|
|
@ -31,10 +31,13 @@ import {
|
|||
} from './book_embeddable';
|
||||
import { CreateEditBookComponent } from './create_edit_book_component';
|
||||
import { DashboardStart } from '../../../../src/plugins/dashboard/public';
|
||||
import { OnSaveProps } from '../../../../src/plugins/saved_objects/public';
|
||||
import { SavedObjectsClientContract } from '../../../../src/core/target/types/public/saved_objects';
|
||||
|
||||
interface StartServices {
|
||||
openModal: OverlayStart['openModal'];
|
||||
getAttributeService: DashboardStart['getAttributeService'];
|
||||
savedObjectsClient: SavedObjectsClientContract;
|
||||
}
|
||||
|
||||
interface ActionContext {
|
||||
|
@ -56,8 +59,24 @@ export const createEditBookAction = (getStartServices: () => Promise<StartServic
|
|||
);
|
||||
},
|
||||
execute: async ({ embeddable }: ActionContext) => {
|
||||
const { openModal, getAttributeService } = await getStartServices();
|
||||
const attributeService = getAttributeService<BookSavedObjectAttributes>(BOOK_SAVED_OBJECT);
|
||||
const { openModal, getAttributeService, savedObjectsClient } = await getStartServices();
|
||||
const attributeService = getAttributeService<BookSavedObjectAttributes>(BOOK_SAVED_OBJECT, {
|
||||
saveMethod: async (
|
||||
type: string,
|
||||
attributes: BookSavedObjectAttributes,
|
||||
savedObjectId?: string
|
||||
) => {
|
||||
if (savedObjectId) {
|
||||
return savedObjectsClient.update(type, savedObjectId, attributes);
|
||||
}
|
||||
return savedObjectsClient.create(type, attributes);
|
||||
},
|
||||
checkForDuplicateTitle: (props: OnSaveProps) => {
|
||||
return new Promise(() => {
|
||||
return true;
|
||||
});
|
||||
},
|
||||
});
|
||||
const onSave = async (attributes: BookSavedObjectAttributes, useRefType: boolean) => {
|
||||
const newInput = await attributeService.wrapAttributes(
|
||||
attributes,
|
||||
|
|
|
@ -22,7 +22,7 @@ import {
|
|||
EmbeddableStart,
|
||||
CONTEXT_MENU_TRIGGER,
|
||||
} from '../../../src/plugins/embeddable/public';
|
||||
import { Plugin, CoreSetup, CoreStart } from '../../../src/core/public';
|
||||
import { Plugin, CoreSetup, CoreStart, SavedObjectsClient } from '../../../src/core/public';
|
||||
import {
|
||||
HelloWorldEmbeddableFactory,
|
||||
HELLO_WORLD_EMBEDDABLE,
|
||||
|
@ -76,6 +76,7 @@ export interface EmbeddableExamplesSetupDependencies {
|
|||
export interface EmbeddableExamplesStartDependencies {
|
||||
embeddable: EmbeddableStart;
|
||||
dashboard: DashboardStart;
|
||||
savedObjectsClient: SavedObjectsClient;
|
||||
}
|
||||
|
||||
interface ExampleEmbeddableFactories {
|
||||
|
@ -158,12 +159,15 @@ export class EmbeddableExamplesPlugin
|
|||
new BookEmbeddableFactoryDefinition(async () => ({
|
||||
getAttributeService: (await core.getStartServices())[1].dashboard.getAttributeService,
|
||||
openModal: (await core.getStartServices())[0].overlays.openModal,
|
||||
savedObjectsClient: (await core.getStartServices())[0].savedObjects.client,
|
||||
overlays: (await core.getStartServices())[0].overlays,
|
||||
}))
|
||||
);
|
||||
|
||||
const editBookAction = createEditBookAction(async () => ({
|
||||
getAttributeService: (await core.getStartServices())[1].dashboard.getAttributeService,
|
||||
openModal: (await core.getStartServices())[0].overlays.openModal,
|
||||
savedObjectsClient: (await core.getStartServices())[0].savedObjects.client,
|
||||
}));
|
||||
deps.uiActions.registerAction(editBookAction);
|
||||
deps.uiActions.attachAction(CONTEXT_MENU_TRIGGER, editBookAction.id);
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue