From b730c9fb77ce3c97f1917ea4567d829e79f897a8 Mon Sep 17 00:00:00 2001 From: Timothy Sullivan Date: Wed, 13 Dec 2023 17:47:11 -0700 Subject: [PATCH] backing out of sprawling test updates --- examples/no_data/README.md | 6 -- examples/no_data/common/index.ts | 10 -- examples/no_data/kibana.jsonc | 15 --- examples/no_data/package.json | 12 --- examples/no_data/public/application.tsx | 23 ----- examples/no_data/public/components/app.tsx | 95 ------------------- examples/no_data/public/index.ts | 23 ----- examples/no_data/public/plugin.ts | 49 ---------- examples/no_data/public/types.ts | 12 --- examples/no_data/translations/ja-JP.json | 81 ---------------- examples/no_data/tsconfig.json | 13 --- package.json | 1 - src/plugins/no_data_page/common/index.ts | 13 --- src/plugins/no_data_page/common/types.ts | 11 --- src/plugins/no_data_page/kibana.jsonc | 5 +- .../public/lib/use_has_api_keys.ts | 37 -------- .../no_data_page/public/mocks/index.ts | 22 ----- src/plugins/no_data_page/public/plugin.ts | 27 ++---- src/plugins/no_data_page/public/types.ts | 21 +--- src/plugins/no_data_page/server/index.ts | 24 ++--- src/plugins/no_data_page/server/plugin.ts | 43 --------- .../no_data_page/server/routes/index.ts | 65 ------------- test/examples/config.js | 1 - test/examples/no_data/index.ts | 66 ------------- tsconfig.base.json | 2 - yarn.lock | 4 - 26 files changed, 20 insertions(+), 661 deletions(-) delete mode 100755 examples/no_data/README.md delete mode 100644 examples/no_data/common/index.ts delete mode 100644 examples/no_data/kibana.jsonc delete mode 100644 examples/no_data/package.json delete mode 100644 examples/no_data/public/application.tsx delete mode 100644 examples/no_data/public/components/app.tsx delete mode 100644 examples/no_data/public/index.ts delete mode 100644 examples/no_data/public/plugin.ts delete mode 100644 examples/no_data/public/types.ts delete mode 100644 examples/no_data/translations/ja-JP.json delete mode 100644 examples/no_data/tsconfig.json delete mode 100644 src/plugins/no_data_page/common/index.ts delete mode 100644 src/plugins/no_data_page/common/types.ts delete mode 100644 src/plugins/no_data_page/public/lib/use_has_api_keys.ts delete mode 100644 src/plugins/no_data_page/public/mocks/index.ts delete mode 100644 src/plugins/no_data_page/server/plugin.ts delete mode 100644 src/plugins/no_data_page/server/routes/index.ts delete mode 100644 test/examples/no_data/index.ts diff --git a/examples/no_data/README.md b/examples/no_data/README.md deleted file mode 100755 index a4274c85fb7f..000000000000 --- a/examples/no_data/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# NoDataExamples - -A Kibana plugin to demonstrate the stateful capabilities of integrated NoDataPage services: - - - getAnalyticsNoDataPageFlavor - - useHasApiKeys diff --git a/examples/no_data/common/index.ts b/examples/no_data/common/index.ts deleted file mode 100644 index 850e23586938..000000000000 --- a/examples/no_data/common/index.ts +++ /dev/null @@ -1,10 +0,0 @@ -/* - * 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. - */ - -export const PLUGIN_ID = 'noDataExamples'; -export const PLUGIN_NAME = 'NoDataExamples'; diff --git a/examples/no_data/kibana.jsonc b/examples/no_data/kibana.jsonc deleted file mode 100644 index b3a6dc4e069e..000000000000 --- a/examples/no_data/kibana.jsonc +++ /dev/null @@ -1,15 +0,0 @@ -{ - "type": "plugin", - "id": "@kbn/no-data-page-example-plugin", - "owner": "@elastic/appex-sharedux", - "description": "A Kibana plugin to demonstrate the stateful capabilities of integrated NoDataPage services", - "plugin": { - "id": "no_data_page_example", - "server": false, - "browser": true, - "requiredPlugins": [ - "developerExamples", - "noDataPage" - ] - } -} diff --git a/examples/no_data/package.json b/examples/no_data/package.json deleted file mode 100644 index 01a83d65c6bc..000000000000 --- a/examples/no_data/package.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "name": "noDataExamples", - "version": "0.0.0", - "private": true, - "scripts": { - "bootstrap": "yarn kbn bootstrap && yarn install", - "build": "yarn plugin-helpers build", - "dev": "yarn plugin-helpers dev", - "plugin-helpers": "node ../../scripts/plugin_helpers", - "kbn": "node ../../scripts/kbn" - } -} diff --git a/examples/no_data/public/application.tsx b/examples/no_data/public/application.tsx deleted file mode 100644 index c4aedc5c2c93..000000000000 --- a/examples/no_data/public/application.tsx +++ /dev/null @@ -1,23 +0,0 @@ -/* - * 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 ReactDOM from 'react-dom'; -import { AppMountParameters, CoreStart } from '@kbn/core/public'; -import { NoDataExamplesApp } from './components/app'; -import { NoDataExamplesPluginSetupDeps } from '.'; - -export const renderApp = ( - _: CoreStart, - { element }: AppMountParameters, - { noDataPage }: Pick -) => { - ReactDOM.render(, element); - - return () => ReactDOM.unmountComponentAtNode(element); -}; diff --git a/examples/no_data/public/components/app.tsx b/examples/no_data/public/components/app.tsx deleted file mode 100644 index c1fd58d236c8..000000000000 --- a/examples/no_data/public/components/app.tsx +++ /dev/null @@ -1,95 +0,0 @@ -/* - * 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, { useState } from 'react'; - -import { EuiButton, EuiCode, EuiHorizontalRule, EuiLoadingSpinner, EuiText } from '@elastic/eui'; -import { NoDataPagePluginSetup } from '@kbn/no-data-page-plugin/public'; -import { KibanaErrorBoundary, KibanaErrorBoundaryProvider } from '@kbn/shared-ux-error-boundary'; -import { KibanaPageTemplate } from '@kbn/shared-ux-page-kibana-template'; -import { PLUGIN_NAME } from '../../common'; - -interface NoDataExamplesAppDeps { - noDataPage: NoDataPagePluginSetup; -} - -export const NoDataExamplesApp: React.FC = ({ noDataPage }) => { - // Use React hooks to manage state. - const [showHasApiKeys, setShowHasApiKeys] = useState(null); - - const onClickHandler = () => { - setShowHasApiKeys(true); - }; - - const ShowHasApiKeys = () => { - const hasApiKeysResponse = noDataPage.useHasApiKeys(); - if (hasApiKeysResponse == null) { - return <>undetermined; - } - const { hasApiKeys, loading, error } = hasApiKeysResponse; - - if (error) { - throw error; - } - - if (loading) { - return ; - } - - return <>{hasApiKeys ? 'yes' : 'no'}; - }; - - // Render the application DOM. - // Note that `navigation.ui.TopNavMenu` is a stateful component exported on the `navigation` plugin's start contract. - return ( - - - - - - -

- Service: hasApiKeys -
- - Current user has API keys:{' '} - {showHasApiKeys ? : 'unknown'} - -

-

Click to determine whether the user has created active API keys.

- - Click - - - - - - -

- Service: getAnalyticsNoDataPageFlavor -
- Analytics NoDataPage Flavor:{' '} - - {noDataPage.getAnalyticsNoDataPageFlavor() ?? 'undefined'} - -

- - - - - - ); -}; diff --git a/examples/no_data/public/index.ts b/examples/no_data/public/index.ts deleted file mode 100644 index 4d08f6d2474c..000000000000 --- a/examples/no_data/public/index.ts +++ /dev/null @@ -1,23 +0,0 @@ -/* - * 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 { DeveloperExamplesSetup } from '@kbn/developer-examples-plugin/public'; -import { NoDataPagePluginSetup } from '@kbn/no-data-page-plugin/public'; -import { NoDataExamplesPlugin } from './plugin'; - -// This exports static code and TypeScript types, -// as well as, Kibana Platform `plugin()` initializer. -export function plugin() { - return new NoDataExamplesPlugin(); -} -export type { NoDataExamplesPluginSetup, NoDataExamplesPluginStart } from './types'; - -export interface NoDataExamplesPluginSetupDeps { - developerExamples: DeveloperExamplesSetup; - noDataPage: NoDataPagePluginSetup; -} diff --git a/examples/no_data/public/plugin.ts b/examples/no_data/public/plugin.ts deleted file mode 100644 index 1148865ad46f..000000000000 --- a/examples/no_data/public/plugin.ts +++ /dev/null @@ -1,49 +0,0 @@ -/* - * 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 { AppMountParameters, CoreSetup, CoreStart, Plugin } from '@kbn/core/public'; -import { NoDataExamplesPluginSetup, NoDataExamplesPluginStart } from './types'; -import { PLUGIN_ID, PLUGIN_NAME } from '../common'; -import { NoDataExamplesPluginSetupDeps } from '.'; - -export class NoDataExamplesPlugin - implements Plugin -{ - public setup(core: CoreSetup, deps: NoDataExamplesPluginSetupDeps) { - const { developerExamples, noDataPage } = deps; - - // Register an application into the side navigation menu - core.application.register({ - id: PLUGIN_ID, - title: PLUGIN_NAME, - async mount(params: AppMountParameters) { - // Load application bundle - const { renderApp } = await import('./application'); - // Get start services as specified in kibana.json - const [coreStart] = await core.getStartServices(); - // Render the application - return renderApp(coreStart, params, { noDataPage }); - }, - }); - - // This section is only needed to get this example plugin to show up in our Developer Examples. - developerExamples.register({ - appId: PLUGIN_ID, - title: PLUGIN_NAME, - description: `Demonstrates the stateful capabilities of integrated NoDataPage services`, - }); - - return {}; - } - - public start(_: CoreStart): NoDataExamplesPluginStart { - return {}; - } - - public stop() {} -} diff --git a/examples/no_data/public/types.ts b/examples/no_data/public/types.ts deleted file mode 100644 index f95799723b48..000000000000 --- a/examples/no_data/public/types.ts +++ /dev/null @@ -1,12 +0,0 @@ -/* - * 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. - */ - -// eslint-disable-next-line @typescript-eslint/no-empty-interface -export interface NoDataExamplesPluginSetup {} - -export type NoDataExamplesPluginStart = NoDataExamplesPluginSetup; diff --git a/examples/no_data/translations/ja-JP.json b/examples/no_data/translations/ja-JP.json deleted file mode 100644 index 9b0c46d52667..000000000000 --- a/examples/no_data/translations/ja-JP.json +++ /dev/null @@ -1,81 +0,0 @@ -{ - "formats": { - "number": { - "currency": { - "style": "currency" - }, - "percent": { - "style": "percent" - } - }, - "date": { - "short": { - "month": "numeric", - "day": "numeric", - "year": "2-digit" - }, - "medium": { - "month": "short", - "day": "numeric", - "year": "numeric" - }, - "long": { - "month": "long", - "day": "numeric", - "year": "numeric" - }, - "full": { - "weekday": "long", - "month": "long", - "day": "numeric", - "year": "numeric" - } - }, - "time": { - "short": { - "hour": "numeric", - "minute": "numeric" - }, - "medium": { - "hour": "numeric", - "minute": "numeric", - "second": "numeric" - }, - "long": { - "hour": "numeric", - "minute": "numeric", - "second": "numeric", - "timeZoneName": "short" - }, - "full": { - "hour": "numeric", - "minute": "numeric", - "second": "numeric", - "timeZoneName": "short" - } - }, - "relative": { - "years": { - "units": "year" - }, - "months": { - "units": "month" - }, - "days": { - "units": "day" - }, - "hours": { - "units": "hour" - }, - "minutes": { - "units": "minute" - }, - "seconds": { - "units": "second" - } - } - }, - "messages": { - "noDataExamples.buttonText": "Translate me to Japanese" - } -} diff --git a/examples/no_data/tsconfig.json b/examples/no_data/tsconfig.json deleted file mode 100644 index 41e1609c2bf7..000000000000 --- a/examples/no_data/tsconfig.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "extends": "../../tsconfig.json", - "compilerOptions": { - "outDir": "./target/types" - }, - "include": [ - "index.ts", - "public/**/*.ts", - "public/**/*.tsx", - "../../typings/**/*" - ], - "exclude": [] -} diff --git a/package.json b/package.json index 8ccbeb8bef1b..524e1e02cf6a 100644 --- a/package.json +++ b/package.json @@ -574,7 +574,6 @@ "@kbn/navigation-plugin": "link:src/plugins/navigation", "@kbn/newsfeed-plugin": "link:src/plugins/newsfeed", "@kbn/newsfeed-test-plugin": "link:test/common/plugins/newsfeed", - "@kbn/no-data-page-example-plugin": "link:examples/no_data", "@kbn/no-data-page-plugin": "link:src/plugins/no_data_page", "@kbn/notifications-plugin": "link:x-pack/plugins/notifications", "@kbn/object-versioning": "link:packages/kbn-object-versioning", diff --git a/src/plugins/no_data_page/common/index.ts b/src/plugins/no_data_page/common/index.ts deleted file mode 100644 index 9b5d0e3fcd43..000000000000 --- a/src/plugins/no_data_page/common/index.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* - * 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. - */ - -export const NO_DATA_API_PATHS: Record> = { - internal: { - hasApiKeys: '/internal/no_data/has_api_keys', - }, -}; diff --git a/src/plugins/no_data_page/common/types.ts b/src/plugins/no_data_page/common/types.ts deleted file mode 100644 index aba6db976872..000000000000 --- a/src/plugins/no_data_page/common/types.ts +++ /dev/null @@ -1,11 +0,0 @@ -/* - * 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. - */ - -export interface HasApiKeysApiResponse { - has_api_keys: boolean; -} diff --git a/src/plugins/no_data_page/kibana.jsonc b/src/plugins/no_data_page/kibana.jsonc index 808205ec8960..202917173b7a 100644 --- a/src/plugins/no_data_page/kibana.jsonc +++ b/src/plugins/no_data_page/kibana.jsonc @@ -5,9 +5,6 @@ "plugin": { "id": "noDataPage", "server": true, - "browser": true, - "optionalPlugins": [ - "security" - ] + "browser": true } } diff --git a/src/plugins/no_data_page/public/lib/use_has_api_keys.ts b/src/plugins/no_data_page/public/lib/use_has_api_keys.ts deleted file mode 100644 index 2fb13ad7a300..000000000000 --- a/src/plugins/no_data_page/public/lib/use_has_api_keys.ts +++ /dev/null @@ -1,37 +0,0 @@ -/* - * 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 type { HttpSetup } from '@kbn/core-http-browser'; -import { useEffect, useState } from 'react'; -import { NO_DATA_API_PATHS } from '../../common'; -import type { HasApiKeysApiResponse } from '../../common/types'; -import { HasApiKeysResponse } from '../types'; - -export const createUseHasApiKeys = ({ http }: { http: HttpSetup }) => { - return function useHasApiKeys(): HasApiKeysResponse { - const [hasApiKeys, setHasApiKeys] = useState(null); - const [loading, setLoading] = useState(false); - const [error, setError] = useState(null); - - useEffect(() => { - setLoading(true); - http - .get(NO_DATA_API_PATHS.internal.hasApiKeys) - .then((response) => { - setHasApiKeys(response.has_api_keys); - setLoading(false); - }) - .catch((caughtError) => { - setError(caughtError); - setLoading(false); - }); - }, []); - - return { hasApiKeys, loading, error }; - }; -}; diff --git a/src/plugins/no_data_page/public/mocks/index.ts b/src/plugins/no_data_page/public/mocks/index.ts deleted file mode 100644 index 7989ec54cbd8..000000000000 --- a/src/plugins/no_data_page/public/mocks/index.ts +++ /dev/null @@ -1,22 +0,0 @@ -/* - * 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 { NoDataPagePluginSetup, NoDataPagePluginStart } from '../types'; - -const initialize = () => { - return () => - ({ - getAnalyticsNoDataPageFlavor: () => 'kibana', - useHasApiKeys: () => null, - } as T); -}; - -export const noDataPagePluginMock = { - createSetup: initialize(), - createStart: initialize(), -}; diff --git a/src/plugins/no_data_page/public/plugin.ts b/src/plugins/no_data_page/public/plugin.ts index caa0259deb96..740f796f4f39 100644 --- a/src/plugins/no_data_page/public/plugin.ts +++ b/src/plugins/no_data_page/public/plugin.ts @@ -6,33 +6,26 @@ * Side Public License, v 1. */ -import type { - CoreSetup, - CoreStart, - HttpSetup, - Plugin, - PluginInitializerContext, -} from '@kbn/core/public'; -import type { NoDataPageConfig } from '../config'; +import type { CoreSetup, CoreStart, Plugin, PluginInitializerContext } from '@kbn/core/public'; import type { NoDataPagePluginSetup, NoDataPagePluginStart } from './types'; -import { createUseHasApiKeys } from './lib/use_has_api_keys'; +import type { NoDataPageConfig } from '../config'; export class NoDataPagePlugin implements Plugin { constructor(private initializerContext: PluginInitializerContext) {} public setup(core: CoreSetup): NoDataPagePluginSetup { - return this.initialize(core); + return { + getAnalyticsNoDataPageFlavor: () => { + return this.initializerContext.config.get().analyticsNoDataPageFlavor; + }, + }; } public start(core: CoreStart): NoDataPagePluginStart { - return this.initialize(core); - } - - private initialize({ http }: { http: HttpSetup }): NoDataPagePluginSetup { return { - getAnalyticsNoDataPageFlavor: () => - this.initializerContext.config.get().analyticsNoDataPageFlavor, - useHasApiKeys: createUseHasApiKeys({ http }), + getAnalyticsNoDataPageFlavor: () => { + return this.initializerContext.config.get().analyticsNoDataPageFlavor; + }, }; } } diff --git a/src/plugins/no_data_page/public/types.ts b/src/plugins/no_data_page/public/types.ts index bae191bbbfbf..2e33170ec06b 100644 --- a/src/plugins/no_data_page/public/types.ts +++ b/src/plugins/no_data_page/public/types.ts @@ -6,27 +6,8 @@ * Side Public License, v 1. */ -export type GetAnalyticsNoDataPageFlavor = () => - | 'kibana' - | 'serverless_search' - | 'serverless_observability'; - -export interface HasApiKeysResponseData { - hasApiKeys: boolean; -} - -export interface HasApiKeysResponse { - hasApiKeys: boolean | null; - loading: boolean; - error: Error | null; -} - export interface NoDataPagePluginSetup { - getAnalyticsNoDataPageFlavor: GetAnalyticsNoDataPageFlavor; - /** - * The response can be stubbed with null as a default, if the No Data Page is unavailable - */ - useHasApiKeys: () => HasApiKeysResponse | null; + getAnalyticsNoDataPageFlavor: () => 'kibana' | 'serverless_search' | 'serverless_observability'; } export type NoDataPagePluginStart = NoDataPagePluginSetup; diff --git a/src/plugins/no_data_page/server/index.ts b/src/plugins/no_data_page/server/index.ts index adc0025855f2..ba02a016a967 100644 --- a/src/plugins/no_data_page/server/index.ts +++ b/src/plugins/no_data_page/server/index.ts @@ -6,13 +6,9 @@ * Side Public License, v 1. */ -import type { - PluginConfigDescriptor, - PluginInitializer, - PluginInitializerContext, -} from '@kbn/core/server'; -import type { SecurityPluginStart } from '@kbn/security-plugin-types-server'; -import { configSchema, type NoDataPageConfig } from '../config'; +import { PluginConfigDescriptor } from '@kbn/core-plugins-server'; + +import { configSchema, NoDataPageConfig } from '../config'; export const config: PluginConfigDescriptor = { exposeToBrowser: { @@ -21,13 +17,9 @@ export const config: PluginConfigDescriptor = { schema: configSchema, }; -export const plugin: PluginInitializer<{}, {}, {}, NoDataPagePluginStartDeps> = async ( - initializerContext: PluginInitializerContext -) => { - const { NoDataPagePlugin } = await import('./plugin'); - return new NoDataPagePlugin(initializerContext); -}; - -export interface NoDataPagePluginStartDeps { - security?: SecurityPluginStart; +export function plugin() { + return new (class NoDataPagePlugin { + setup() {} + start() {} + })(); } diff --git a/src/plugins/no_data_page/server/plugin.ts b/src/plugins/no_data_page/server/plugin.ts deleted file mode 100644 index baf9d9658b42..000000000000 --- a/src/plugins/no_data_page/server/plugin.ts +++ /dev/null @@ -1,43 +0,0 @@ -/* - * 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 type { - CoreSetup, - CoreStart, - Logger, - Plugin, - PluginInitializerContext, -} from '@kbn/core/server'; -import { NoDataPagePluginStartDeps } from '.'; -import { getHasApiKeysRoute } from './routes'; - -export class NoDataPagePlugin implements Plugin { - private readonly logger: Logger; - - constructor(private readonly initializerContext: PluginInitializerContext) { - this.logger = this.initializerContext.logger.get(); - } - - setup(core: CoreSetup) { - core.getStartServices().then(([_, startDeps]) => { - const { security } = startDeps; - - // initialize internal route(s) - getHasApiKeysRoute(core.http.createRouter(), { - logger: this.logger, - security, - }); - }); - - return {}; - } - - start(_: CoreStart) { - return {}; - } -} diff --git a/src/plugins/no_data_page/server/routes/index.ts b/src/plugins/no_data_page/server/routes/index.ts deleted file mode 100644 index 8317a85e5aa3..000000000000 --- a/src/plugins/no_data_page/server/routes/index.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* - * 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 type { - IRouter, - Logger, - KibanaRequest, - KibanaResponseFactory, - RequestHandlerContext, -} from '@kbn/core/server'; -import type { SecurityPluginStart } from '@kbn/security-plugin-types-server'; -import { NO_DATA_API_PATHS } from '../../common'; -import type { HasApiKeysApiResponse } from '../../common/types'; - -interface GetHasApiKeysRoutePluginDeps { - logger: Logger; - security?: SecurityPluginStart; -} - -/** - * Register a internal route that informs the UI whether the currently logged-in user has created API keys in - * Elasticsearch Security. This is used to direct users effectively through their getting started experience. - * - * NOTE: The user may not have the necessary privilege to call the required Elasticsearch API. - * NOTE: The user may have created API keys that have been invalidated, which explicitly do not get counted the result. - * NOTE: The Elasticsearch cluster may not have API keys enabled. - */ -export const getHasApiKeysRoute = (router: IRouter, deps: GetHasApiKeysRoutePluginDeps) => { - const { logger, security } = deps; - - router.get( - { - path: NO_DATA_API_PATHS.internal.hasApiKeys, - validate: {}, - }, - async function handler( - _: RequestHandlerContext, - req: KibanaRequest, - res: KibanaResponseFactory - ) { - let hasApiKeys: boolean | null = null; - - try { - const result = await security?.authc.apiKeys.hasApiKeys(req, { - ownerOnly: true, - validOnly: true, - }); - hasApiKeys = result ?? null; - } catch (e) { - logger.error(e); - } - - return res.ok({ - body: { - has_api_keys: hasApiKeys ?? false, - }, - }); - } - ); -}; diff --git a/test/examples/config.js b/test/examples/config.js index 8310d3240d61..dbc9d32055cc 100644 --- a/test/examples/config.js +++ b/test/examples/config.js @@ -32,7 +32,6 @@ export default async function ({ readConfigFile }) { require.resolve('./unified_field_list_examples'), require.resolve('./discover_customization_examples'), require.resolve('./error_boundary'), - require.resolve('./no_data'), ], services: { ...functionalConfig.get('services'), diff --git a/test/examples/no_data/index.ts b/test/examples/no_data/index.ts deleted file mode 100644 index 578b2ce26f32..000000000000 --- a/test/examples/no_data/index.ts +++ /dev/null @@ -1,66 +0,0 @@ -/* - * 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 expect from '@kbn/expect'; -import { PLUGIN_ID as NO_DATA_PLUGIN_ID } from '@kbn/no-data-page-example-plugin/common'; -import { FtrProviderContext } from '../../functional/ftr_provider_context'; - -// eslint-disable-next-line import/no-default-export -export default function ({ getService, getPageObjects }: FtrProviderContext) { - const retry = getService('retry'); - const testSubjects = getService('testSubjects'); - const PageObjects = getPageObjects(['common']); - const log = getService('log'); - const es = getService('es'); - - describe('No Data Page Examples', () => { - before(async () => { - await PageObjects.common.navigateToApp(NO_DATA_PLUGIN_ID); - await testSubjects.existOrFail('noDataPageExampleHeader'); - }); - - it('determine when user has no API keys', async () => { - await retry.try(async () => { - const sectionText = await testSubjects.getVisibleText('noDataPageExampleHasApiKeysResult'); - expect(sectionText).to.be('Current user has API keys: unknown'); - }); - - log.debug('clicking button for checking API keys'); - await testSubjects.click('noDataPageExampleHasApiKeysClick'); - - await retry.try(async () => { - const sectionText = await testSubjects.getVisibleText('noDataPageExampleHasApiKeysResult'); - expect(sectionText).to.be('Current user has API keys: no'); - }); - }); - - // can not be tested with example plugins tests server - it.skip('determine when user has API key(s)', async () => { - const { id: keyId } = await es.security.createApiKey({ - name: 'key-for-test', - }); - - await retry.try(async () => { - const sectionText = await testSubjects.getVisibleText('noDataPageExampleHasApiKeysResult'); - expect(sectionText).to.be('Current user has API keys: unknown'); - }); - - log.debug('clicking button for checking API keys'); - await testSubjects.click('noDataPageExampleHasApiKeysClick'); - - await retry.try(async () => { - const sectionText = await testSubjects.getVisibleText('noDataPageExampleHasApiKeysResult'); - expect(sectionText).to.be('Current user has API keys: yes'); - }); - - await es.security.invalidateApiKey({ - id: keyId, - }); - }); - }); -} diff --git a/tsconfig.base.json b/tsconfig.base.json index 2a21f4fd5293..e634fe61248a 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -1106,8 +1106,6 @@ "@kbn/newsfeed-plugin/*": ["src/plugins/newsfeed/*"], "@kbn/newsfeed-test-plugin": ["test/common/plugins/newsfeed"], "@kbn/newsfeed-test-plugin/*": ["test/common/plugins/newsfeed/*"], - "@kbn/no-data-page-example-plugin": ["examples/no_data"], - "@kbn/no-data-page-example-plugin/*": ["examples/no_data/*"], "@kbn/no-data-page-plugin": ["src/plugins/no_data_page"], "@kbn/no-data-page-plugin/*": ["src/plugins/no_data_page/*"], "@kbn/notifications-plugin": ["x-pack/plugins/notifications"], diff --git a/yarn.lock b/yarn.lock index f61fa4cea502..1db13cef1334 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5147,10 +5147,6 @@ version "0.0.0" uid "" -"@kbn/no-data-page-example-plugin@link:examples/no_data": - version "0.0.0" - uid "" - "@kbn/no-data-page-plugin@link:src/plugins/no_data_page": version "0.0.0" uid ""