[Reporting/Migration] ReportingSetup, LegacySetup #54198
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License; | ||
| * you may not use this file except in compliance with the Elastic License. | ||
| */ | ||
|
|
||
| import { Legacy } from 'kibana'; | ||
| import { CoreSetup, CoreStart, Plugin } from 'src/core/server'; | ||
| import { IUiSettingsClient } from 'src/core/server'; | ||
| import { UsageCollectionSetup } from 'src/plugins/usage_collection/server'; | ||
| import { XPackMainPlugin } from '../../xpack_main/server/xpack_main'; | ||
| // @ts-ignore | ||
| import { mirrorPluginStatus } from '../../../server/lib/mirror_plugin_status'; | ||
| import { PLUGIN_ID } from '../common/constants'; | ||
| import { ReportingPluginSpecOptions } from '../types.d'; | ||
| import { registerRoutes } from './routes'; | ||
| import { LevelLogger, checkLicenseFactory, getExportTypesRegistry, runValidations } from './lib'; | ||
| import { createBrowserDriverFactory } from './browsers'; | ||
| import { registerReportingUsageCollector } from './usage'; | ||
| import { logConfiguration } from '../log_configuration'; | ||
|
|
||
| // For now there is no exposed functionality to other plugins | ||
| export type ReportingSetup = object; | ||
| export type ReportingStart = object; | ||
|
|
||
| export interface ReportingSetupDeps { | ||
| usageCollection: UsageCollectionSetup; | ||
| } | ||
| export type ReportingStartDeps = object; | ||
|
|
||
| type LegacyPlugins = Legacy.Server['plugins']; | ||
|
|
||
| export interface LegacySetup { | ||
| config: Legacy.Server['config']; | ||
| info: Legacy.Server['info']; | ||
| log: Legacy.Server['log']; | ||
| plugins: { | ||
| elasticsearch: LegacyPlugins['elasticsearch']; | ||
| security: LegacyPlugins['security']; | ||
| xpack_main: XPackMainPlugin & { | ||
| status?: any; | ||
| }; | ||
| }; | ||
| route: Legacy.Server['route']; | ||
| savedObjects: Legacy.Server['savedObjects']; | ||
| uiSettingsServiceFactory: Legacy.Server['uiSettingsServiceFactory']; | ||
| fieldFormatServiceFactory: (uiConfig: IUiSettingsClient) => unknown; | ||
| } | ||
|
|
||
| export type ReportingPlugin = Plugin< | ||
| ReportingSetup, | ||
| ReportingStart, | ||
| ReportingSetupDeps, | ||
| ReportingStartDeps | ||
| >; | ||
|
|
||
| /* We need a factory that returns an instance of the class because the class | ||
| * implementation itself restricts against having Legacy dependencies passed | ||
| * into `setup`. The factory parameters take the legacy dependencies, and the | ||
| * `setup` method gets it from enclosure */ | ||
| export function reportingPluginFactory( | ||
|
There was a problem hiding this comment. I made this factory function to accept parameters that can not directly be passed into the I had to come up with this solution, because the guidance from the Migration guide had outdated info: /* this is not possible if the Plugin class extends the core plugin class:
* the setup method doesn't accept a 3rd parameter */
const demoSetup = new Plugin().setup(coreSetup, pluginsSetup, __LEGACY); There was a problem hiding this comment. We could make this type more permissive: interface Plugin<...> {
setup(core: CoreSetup, plugins: TPluginsSetup, ...args: any[]): MaybePromise<TSetup>;
/* ... */
}There was a problem hiding this comment. (sorry, I'm a little late) I'm not a big fan of 'poluting' the Maybe we could instead introduce a sub-interface for the migration period, interface ShimedPlugin<
TSetup = void,
TStart = void,
TPluginsSetup extends object = object,
TPluginsStart extends object = object,
TLegacySetupDeps extends object = object
> extends Plugin<TSetup, TStart, TPluginsSetup, TPluginsStart> {
setup(
core: CoreSetup,
plugins: TPluginsSetup,
legacy: TLegacySetupDeps
): TSetup | Promise<TSetup>;
}@tsullivan The factory is a workaround that will do just fine however. Sorry for the outdated documentation |
||
| __LEGACY: LegacySetup, | ||
| legacyPlugin: ReportingPluginSpecOptions | ||
| ) { | ||
| return new (class ReportingPlugin implements ReportingPlugin { | ||
| public async setup(core: CoreSetup, plugins: ReportingSetupDeps): Promise<ReportingSetup> { | ||
| const exportTypesRegistry = getExportTypesRegistry(); | ||
|
|
||
| let isCollectorReady = false; | ||
| // Register a function with server to manage the collection of usage stats | ||
| const { usageCollection } = plugins; | ||
| registerReportingUsageCollector( | ||
| usageCollection, | ||
| __LEGACY, | ||
| () => isCollectorReady, | ||
| exportTypesRegistry | ||
| ); | ||
|
|
||
| const logger = LevelLogger.createForServer(__LEGACY, [PLUGIN_ID]); | ||
| const browserDriverFactory = await createBrowserDriverFactory(__LEGACY); | ||
|
|
||
| logConfiguration(__LEGACY, logger); | ||
| runValidations(__LEGACY, logger, browserDriverFactory); | ||
|
|
||
| const { xpack_main: xpackMainPlugin } = __LEGACY.plugins; | ||
| mirrorPluginStatus(xpackMainPlugin, legacyPlugin); | ||
| const checkLicense = checkLicenseFactory(exportTypesRegistry); | ||
| (xpackMainPlugin as any).status.once('green', () => { | ||
| // Register a function that is called whenever the xpack info changes, | ||
| // to re-compute the license check results for this plugin | ||
| xpackMainPlugin.info.feature(PLUGIN_ID).registerLicenseCheckResultsGenerator(checkLicense); | ||
| }); | ||
|
|
||
| // Post initialization of the above code, the collector is now ready to fetch its data | ||
| isCollectorReady = true; | ||
|
|
||
| // Reporting routes | ||
| registerRoutes(__LEGACY, exportTypesRegistry, browserDriverFactory, logger); | ||
|
|
||
| return {}; | ||
| } | ||
|
|
||
| public start(core: CoreStart, plugins: ReportingStartDeps): ReportingStart { | ||
| return {}; | ||
| } | ||
| })(); | ||
| } | ||
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
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.
In the near future, we will expose functionality to other plugins so they have an API to schedule reports of their data visualizations / CSV exports