-
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.
Browse files
Browse the repository at this point in the history
* ReportingSetup, LegacySetup * fix ts
- Loading branch information
Showing
3 changed files
with
123 additions
and
68 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
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( | ||
__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