-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Embeddable Rebuild] [Image] Migrate image embeddable to new embeddab…
…le framework (#178544) Closes #174962 Closes #165848 Closes #179521 ## Summary This PR converts the Image embeddable to the new React embeddable framework. There should not be **any** changes in user-facing behaviour (unless they were made intentionally, such as the small change described [here](#178544 (comment))) - therefore, testing of this PR should be focused on ensuring that no behaviour is changed and/or broken with this refactor. Since I was already doing a major overhaul, I took the opportunity to clean up some of the image embeddable code, such as the small change described [here](#178544 (comment)). Some of my changes are heavily influenced by the Presentation team style (such as my changes to the file organization) so, if there are any disagreements, I am 100% open to make changes - after all, this code does not belong to us and we are not responsible for maintenance. Since this is the first embeddable to be officially refactored (🎉), I expect there to be lots of questions + feedback and that is okay! ### Small Style Changes In order to close #165848, I did two things: 1. I fixed the contrast of the `optionsMenuButton` as described in #178544 (comment) 2. I ensured that the `PresentationPanel` enforces rounded corners in view mode while keeping appearances consistent in edit mode (i.e. the upper corners remain square so that it looks consistent with the title bar): | | Before | After | |-----|--------|--------| | **View mode** |  |  | | **Edit mode** |  |  | ### Checklist - [x] 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) - [x] [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 - [x] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed ([FTR](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/5559))  - [x] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### 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
1 parent
d1e792a
commit 826f7cb
Showing
39 changed files
with
613 additions
and
470 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
59 changes: 59 additions & 0 deletions
59
src/plugins/image_embeddable/public/actions/create_image_action.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| import { i18n } from '@kbn/i18n'; | ||
| import { CanAddNewPanel } from '@kbn/presentation-containers'; | ||
| import { EmbeddableApiContext } from '@kbn/presentation-publishing'; | ||
| import { IncompatibleActionError } from '@kbn/ui-actions-plugin/public'; | ||
| import { | ||
| ADD_IMAGE_EMBEDDABLE_ACTION_ID, | ||
| IMAGE_EMBEDDABLE_TYPE, | ||
| } from '../image_embeddable/constants'; | ||
| import { uiActionsService } from '../services/kibana_services'; | ||
|
|
||
| const parentApiIsCompatible = async (parentApi: unknown): Promise<CanAddNewPanel | undefined> => { | ||
| const { apiCanAddNewPanel } = await import('@kbn/presentation-containers'); | ||
| // we cannot have an async type check, so return the casted parentApi rather than a boolean | ||
| return apiCanAddNewPanel(parentApi) ? (parentApi as CanAddNewPanel) : undefined; | ||
| }; | ||
|
|
||
| export const registerCreateImageAction = () => { | ||
| uiActionsService.registerAction<EmbeddableApiContext>({ | ||
| id: ADD_IMAGE_EMBEDDABLE_ACTION_ID, | ||
| getIconType: () => 'image', | ||
| isCompatible: async ({ embeddable: parentApi }) => { | ||
| return Boolean(await parentApiIsCompatible(parentApi)); | ||
| }, | ||
| execute: async ({ embeddable: parentApi }) => { | ||
| const canAddNewPanelParent = await parentApiIsCompatible(parentApi); | ||
| if (!canAddNewPanelParent) throw new IncompatibleActionError(); | ||
| const { openImageEditor } = await import('../components/image_editor/open_image_editor'); | ||
| try { | ||
| const imageConfig = await openImageEditor({ parentApi: canAddNewPanelParent }); | ||
|
|
||
| canAddNewPanelParent.addNewPanel({ | ||
| panelType: IMAGE_EMBEDDABLE_TYPE, | ||
| initialState: { imageConfig }, | ||
| }); | ||
| } catch { | ||
| // swallow the rejection, since this just means the user closed without saving | ||
| } | ||
| }, | ||
| getDisplayName: () => | ||
| i18n.translate('imageEmbeddable.imageEmbeddableFactory.displayName', { | ||
| defaultMessage: 'Image', | ||
| }), | ||
| }); | ||
|
|
||
| uiActionsService.attachAction('ADD_PANEL_TRIGGER', ADD_IMAGE_EMBEDDABLE_ACTION_ID); | ||
| if (uiActionsService.hasTrigger('ADD_CANVAS_ELEMENT_TRIGGER')) { | ||
| // Because Canvas is not enabled in Serverless, this trigger might not be registered - only attach | ||
| // the create action if the Canvas-specific trigger does indeed exist. | ||
| uiActionsService.attachAction('ADD_CANVAS_ELEMENT_TRIGGER', ADD_IMAGE_EMBEDDABLE_ACTION_ID); | ||
| } | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
88 changes: 88 additions & 0 deletions
88
src/plugins/image_embeddable/public/components/image_editor/open_image_editor.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| /* | ||
| * 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 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| import React from 'react'; | ||
|
|
||
| import { tracksOverlays, CanAddNewPanel } from '@kbn/presentation-containers'; | ||
| import { toMountPoint } from '@kbn/react-kibana-mount'; | ||
| import { FilesContext } from '@kbn/shared-ux-file-context'; | ||
|
|
||
| import { ImageConfig } from '../../image_embeddable/types'; | ||
| import { FileImageMetadata, imageEmbeddableFileKind } from '../../imports'; | ||
| import { coreServices, filesService, securityService } from '../../services/kibana_services'; | ||
| import { createValidateUrl } from '../../utils/validate_url'; | ||
| import { ImageViewerContext } from '../image_viewer/image_viewer_context'; | ||
|
|
||
| export const openImageEditor = async ({ | ||
| parentApi, | ||
| initialImageConfig, | ||
| }: { | ||
| parentApi: CanAddNewPanel; | ||
| initialImageConfig?: ImageConfig; | ||
| }): Promise<ImageConfig> => { | ||
| const { ImageEditorFlyout } = await import('./image_editor_flyout'); | ||
|
|
||
| const { overlays, theme, i18n, http } = coreServices; | ||
| const user = securityService ? await securityService.authc.getCurrentUser() : undefined; | ||
| const filesClient = filesService.filesClientFactory.asUnscoped<FileImageMetadata>(); | ||
|
|
||
| /** | ||
| * If available, the parent API will keep track of which flyout is open and close it | ||
| * if the app changes, disable certain actions when the flyout is open, etc. | ||
| */ | ||
| const overlayTracker = tracksOverlays(parentApi) ? parentApi : undefined; | ||
|
|
||
| return new Promise((resolve, reject) => { | ||
| const onSave = (imageConfig: ImageConfig) => { | ||
| resolve(imageConfig); | ||
| flyoutSession.close(); | ||
| overlayTracker?.clearOverlays(); | ||
| }; | ||
|
|
||
| const onCancel = () => { | ||
| reject(); | ||
| flyoutSession.close(); | ||
| overlayTracker?.clearOverlays(); | ||
| }; | ||
|
|
||
| const flyoutSession = overlays.openFlyout( | ||
| toMountPoint( | ||
| <FilesContext client={filesClient}> | ||
| <ImageViewerContext.Provider | ||
| value={{ | ||
| getImageDownloadHref: (fileId: string) => { | ||
| return filesClient.getDownloadHref({ | ||
| id: fileId, | ||
| fileKind: imageEmbeddableFileKind.id, | ||
| }); | ||
| }, | ||
| validateUrl: createValidateUrl(http.externalUrl), | ||
| }} | ||
| > | ||
| <ImageEditorFlyout | ||
| user={user} | ||
| onCancel={onCancel} | ||
| onSave={onSave} | ||
| initialImageConfig={initialImageConfig} | ||
| /> | ||
| </ImageViewerContext.Provider> | ||
| </FilesContext>, | ||
| { theme, i18n } | ||
| ), | ||
| { | ||
| onClose: () => { | ||
| onCancel(); | ||
| }, | ||
| ownFocus: true, | ||
| 'data-test-subj': 'createImageEmbeddableFlyout', | ||
| } | ||
| ); | ||
|
|
||
| overlayTracker?.openOverlay(flyoutSession); | ||
| }); | ||
| }; |
File renamed without changes.
88 changes: 88 additions & 0 deletions
88
src/plugins/image_embeddable/public/components/image_embeddable.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| /* | ||
| * 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 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| import React, { useEffect, useState } from 'react'; | ||
|
|
||
| import { PublishingSubject, useBatchedPublishingSubjects } from '@kbn/presentation-publishing'; | ||
|
|
||
| import { imageClickTrigger } from '../actions'; | ||
| import { ImageEmbeddableApi } from '../image_embeddable/types'; | ||
| import { FileImageMetadata, FilesClient, imageEmbeddableFileKind } from '../imports'; | ||
| import { coreServices, screenshotModeService, uiActionsService } from '../services/kibana_services'; | ||
| import { ImageConfig } from '../types'; | ||
| import { createValidateUrl } from '../utils/validate_url'; | ||
| import { ImageViewer } from './image_viewer'; | ||
| import { ImageViewerContext } from './image_viewer/image_viewer_context'; | ||
|
|
||
| import './image_embeddable.scss'; | ||
|
|
||
| interface ImageEmbeddableProps { | ||
| api: ImageEmbeddableApi & { | ||
| setDataLoading: (loading: boolean | undefined) => void; | ||
| imageConfig$: PublishingSubject<ImageConfig>; | ||
| }; | ||
| filesClient: FilesClient<FileImageMetadata>; | ||
| } | ||
|
|
||
| export const ImageEmbeddable = ({ api, filesClient }: ImageEmbeddableProps) => { | ||
| const [imageConfig, dynamicActionsState] = useBatchedPublishingSubjects( | ||
| api.imageConfig$, | ||
| api.dynamicActionsState$ | ||
| ); | ||
| const [hasTriggerActions, setHasTriggerActions] = useState(false); | ||
|
|
||
| useEffect(() => { | ||
| /** | ||
| * set the loading to `true` any time the image changes; the ImageViewer component | ||
| * is responsible for setting loading to `false` again once the image loads | ||
| */ | ||
| api.setDataLoading(true); | ||
| }, [api, imageConfig]); | ||
|
|
||
| useEffect(() => { | ||
| // set `hasTriggerActions` depending on whether or not the image has at least one drilldown | ||
| setHasTriggerActions((dynamicActionsState?.dynamicActions.events ?? []).length > 0); | ||
| }, [dynamicActionsState]); | ||
|
|
||
| return ( | ||
| <ImageViewerContext.Provider | ||
| value={{ | ||
| getImageDownloadHref: (fileId: string) => { | ||
| return filesClient.getDownloadHref({ | ||
| id: fileId, | ||
| fileKind: imageEmbeddableFileKind.id, | ||
| }); | ||
| }, | ||
| validateUrl: createValidateUrl(coreServices.http.externalUrl), | ||
| }} | ||
| > | ||
| <ImageViewer | ||
| data-rendering-count={1} // TODO: Remove this as part of https://github.com/elastic/kibana/issues/179376 | ||
| className="imageEmbeddableImage" | ||
| imageConfig={imageConfig} | ||
| isScreenshotMode={screenshotModeService?.isScreenshotMode()} | ||
| onLoad={() => { | ||
| api.setDataLoading(false); | ||
| }} | ||
| onError={() => { | ||
| api.setDataLoading(false); | ||
| }} | ||
| onClick={ | ||
| // note: passing onClick enables the cursor pointer style, so we only pass it if there are compatible actions | ||
| hasTriggerActions | ||
| ? () => { | ||
| uiActionsService.executeTriggerActions(imageClickTrigger.id, { | ||
| embeddable: api, | ||
| }); | ||
| } | ||
| : undefined | ||
| } | ||
| /> | ||
| </ImageViewerContext.Provider> | ||
| ); | ||
| }; |
File renamed without changes
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.