[Share] Convert Share registry to async registry #224139
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,34 @@ | ||
| /* | ||
| * 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", the "GNU Affero General Public License v3.0 only", 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", the "GNU Affero General Public | ||
| * License v3.0 only", or the "Server Side Public License, v 1". | ||
| */ | ||
|
|
||
| import { useEffect, useState } from 'react'; | ||
| import type { DiscoverServices } from '../../../build_services'; | ||
|
|
||
| export function useHasShareIntegration({ share }: DiscoverServices) { | ||
|
Contributor
Author
There was a problem hiding this comment. |
||
| const [hasShareIntegration, setHasShareIntegration] = useState<boolean>(false); | ||
|
|
||
| useEffect(() => { | ||
| let canceled = false; | ||
| if (!share) return; | ||
| const checkShareIntegration = async () => { | ||
| const integrations = await share.availableIntegrations('search', 'export'); | ||
| if (!canceled) { | ||
| setHasShareIntegration(integrations.length > 0); | ||
| } | ||
| }; | ||
|
|
||
| checkShareIntegration(); | ||
|
|
||
| return () => { | ||
| canceled = true; | ||
| }; | ||
| }, [share]); | ||
|
|
||
| return hasShareIntegration; | ||
| } | ||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -19,9 +19,12 @@ import type { | |
| ShareIntegration, | ||
| ShareRegistryApiStart, | ||
| ShareMenuProviderLegacy, | ||
| ShareIntegrationMapKey, | ||
| } from '../types'; | ||
| import type { AnonymousAccessServiceContract } from '../../common/anonymous_access'; | ||
|
|
||
| type ShareContextMapKey = InternalShareActionIntent | ShareIntegrationMapKey | 'legacy'; | ||
|
|
||
| export class ShareRegistry implements ShareRegistryPublicApi { | ||
| private urlService?: BrowserUrlService; | ||
| private anonymousAccessServiceProvider?: () => AnonymousAccessServiceContract; | ||
|
|
@@ -35,10 +38,9 @@ export class ShareRegistry implements ShareRegistryPublicApi { | |
| this.registerLinkShareAction(); | ||
| this.registerEmbedShareAction(); | ||
| } | ||
| private readonly shareOptionsStore: Record< | ||
| string, | ||
| Map<ShareContextMapKey, () => Promise<ShareActionIntents>> | ||
| > = { | ||
| [this.globalMarker]: new Map(), | ||
| }; | ||
|
|
@@ -70,94 +72,98 @@ export class ShareRegistry implements ShareRegistryPublicApi { | |
| }; | ||
| } | ||
|
|
||
| // Async registration for share actions | ||
| private async registerShareIntentAction( | ||
| shareObject: string, | ||
| key: ShareContextMapKey, | ||
| getShareActionIntent: () => Promise<ShareActionIntents> | ||
|
Contributor
Author
There was a problem hiding this comment. Since the
Contributor
There was a problem hiding this comment. I think it might be better for this API we were to actually accept the
Contributor
There was a problem hiding this comment. Another advantage to this approach would mean that we'll be able to check available integrations synchronously rather than async, and not have to modify functions returning nav config for other apps becoming async, with the resolution of the share implementation still async. |
||
| ): Promise<void> { | ||
| if (!this.shareOptionsStore[shareObject]) { | ||
| this.shareOptionsStore[shareObject] = new Map(); | ||
| } | ||
|
|
||
| const shareContextMap = this.shareOptionsStore[shareObject]; | ||
|
|
||
| if (shareContextMap.has(key)) { | ||
| throw new Error( | ||
| `Share action with key [${key}] for app [${shareObject}] has already been registered.` | ||
| ); | ||
| } | ||
|
|
||
| shareContextMap.set(key, getShareActionIntent); | ||
| } | ||
|
|
||
| private registerLinkShareAction(): void { | ||
| this.registerShareIntentAction(this.globalMarker, 'link', async () => ({ | ||
| shareType: 'link', | ||
| config: ({ urlService }) => ({ | ||
| shortUrlService: urlService?.shortUrls.get(null)!, | ||
| }), | ||
| })); | ||
| } | ||
|
|
||
| private registerEmbedShareAction(): void { | ||
| this.registerShareIntentAction(this.globalMarker, 'embed', async () => ({ | ||
| shareType: 'embed', | ||
| config: ({ urlService, anonymousAccessServiceProvider }) => ({ | ||
| anonymousAccess: anonymousAccessServiceProvider!(), | ||
| shortUrlService: urlService.shortUrls.get(null), | ||
| }), | ||
| })); | ||
| } | ||
|
|
||
| /** | ||
| * @description provides an escape hatch to support allowing legacy share menu items to be registered | ||
| */ | ||
| private register(value: ShareMenuProviderLegacy | Promise<ShareMenuProviderLegacy>) { | ||
| this.registerShareIntentAction(this.globalMarker, 'legacy', async () => { | ||
| const resolvedValue = await Promise.resolve(value); | ||
| return { | ||
| shareType: 'legacy', | ||
| id: resolvedValue.id, | ||
| config: resolvedValue.getShareMenuItemsLegacy, | ||
| }; | ||
| }); | ||
| } | ||
|
|
||
| private registerShareIntegration<I extends ShareIntegration>( | ||
| shareObject: string, | ||
| key: ShareIntegrationMapKey, | ||
| getShareActionIntent: () => Promise<Omit<I, 'shareType'>> | ||
|
Comment on lines
+130
to
+132
Contributor
There was a problem hiding this comment. This forces users to specify a share object, we should at the very least specify that |
||
| ): void { | ||
| this.registerShareIntentAction(shareObject, key, async () => ({ | ||
| shareType: 'integration', | ||
| ...(await getShareActionIntent()), | ||
| })); | ||
| } | ||
|
|
||
| private async getShareConfigOptionsForObject( | ||
| objectType: ShareContext['objectType'] | ||
| ): Promise<ShareActionIntents[]> { | ||
| const shareContextMap = this.shareOptionsStore[objectType]; | ||
| const globalOptions = Array.from(this.shareOptionsStore[this.globalMarker].values()); | ||
|
|
||
| const allFactories = shareContextMap | ||
| ? [...globalOptions, ...Array.from(shareContextMap.values())] | ||
| : globalOptions; | ||
|
|
||
| return Promise.all(allFactories.map((factory) => factory())); | ||
| } | ||
|
|
||
| /** | ||
| * Returns all share actions that are available for the given object type. | ||
| */ | ||
| private async availableIntegrations( | ||
| objectType: string, | ||
| groupId?: string | ||
| ): Promise<ShareActionIntents[]> { | ||
| if (!this.capabilities || !this.getLicense) { | ||
| throw new Error('ShareOptionsManager#start was not invoked'); | ||
| } | ||
|
|
||
| const shareActions = await this.getShareConfigOptionsForObject(objectType); | ||
|
|
||
| return shareActions.filter((share) => { | ||
| if ( | ||
| groupId && | ||
| (share.shareType !== 'integration' || | ||
|
|
@@ -179,16 +185,18 @@ export class ShareRegistry implements ShareRegistryPublicApi { | |
| }); | ||
| } | ||
|
|
||
| private async resolveShareItemsForShareContext({ | ||
|
Contributor
There was a problem hiding this comment. Since this signature changed we'll need to in turn change the signature of |
||
| objectType, | ||
| isServerless, | ||
| ...shareContext | ||
| }: ShareContext & { isServerless: boolean }): Promise<ShareConfigs[]> { | ||
| if (!this.urlService || !this.anonymousAccessServiceProvider) { | ||
| throw new Error('ShareOptionsManager#start was not invoked'); | ||
| } | ||
|
|
||
| const shareActions = await this.availableIntegrations(objectType); | ||
|
|
||
| return shareActions | ||
| .map((shareAction) => { | ||
| let config: ShareConfigs['config'] | null; | ||
|
|
||
|
|
||
This file contains hidden or 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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See also https://github.com/elastic/kibana/pull/224139/files#r2152953864