Kibana Sustainable Architecture: Expose StatusResponse in core-stat…

…us-common (elastic#200524) ## Summary - Exposes the interfaces that define the format of the response of the `/api/status` endpoint. - Moves them from `@kbn/core-status-common-internal` to `@kbn/core-status-common`. - Removes the former package, as it no longer contains anything. - Fixes some of the illegal dependencies uncovered by elastic#199630. --------- Co-authored-by: kibanamachine <[email protected]>
CAWilson94 · Dec 12, 2024 · 8dac33d · 8dac33d
1 parent 6c8a64b
commit 8dac33d
Show file tree

Hide file tree

Showing 31 changed files with 35 additions and 130 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -225,7 +225,6 @@ packages/core/security/core-security-server @elastic/kibana-core
 packages/core/security/core-security-server-internal @elastic/kibana-core
 packages/core/security/core-security-server-mocks @elastic/kibana-core
 packages/core/status/core-status-common @elastic/kibana-core
-packages/core/status/core-status-common-internal @elastic/kibana-core
 packages/core/status/core-status-server @elastic/kibana-core
 packages/core/status/core-status-server-internal @elastic/kibana-core
 packages/core/status/core-status-server-mocks @elastic/kibana-core

diff --git a/package.json b/package.json
@@ -384,7 +384,6 @@
     "@kbn/core-security-server-internal": "link:packages/core/security/core-security-server-internal",
     "@kbn/core-security-server-mocks": "link:packages/core/security/core-security-server-mocks",
     "@kbn/core-status-common": "link:packages/core/status/core-status-common",
-    "@kbn/core-status-common-internal": "link:packages/core/status/core-status-common-internal",
     "@kbn/core-status-server": "link:packages/core/status/core-status-server",
     "@kbn/core-status-server-internal": "link:packages/core/status/core-status-server-internal",
     "@kbn/core-test-helpers-deprecations-getters": "link:packages/core/test-helpers/core-test-helpers-deprecations-getters",

diff --git a/packages/core/apps/core-apps-browser-internal/src/status/components/status_table.test.tsx b/packages/core/apps/core-apps-browser-internal/src/status/components/status_table.test.tsx
@@ -9,7 +9,7 @@
 
 import React from 'react';
 import { shallow } from 'enzyme';
-import type { StatusInfoServiceStatus as ServiceStatus } from '@kbn/core-status-common-internal';
+import type { StatusInfoServiceStatus as ServiceStatus } from '@kbn/core-status-common';
 import { StatusTable } from './status_table';
 
 const state = {

diff --git a/packages/core/apps/core-apps-browser-internal/src/status/components/version_header.test.tsx b/packages/core/apps/core-apps-browser-internal/src/status/components/version_header.test.tsx
@@ -9,7 +9,7 @@
 
 import React from 'react';
 import { mountWithIntl, findTestSubject } from '@kbn/test-jest-helpers';
-import type { ServerVersion } from '@kbn/core-status-common-internal';
+import type { ServerVersion } from '@kbn/core-status-common';
 import { VersionHeader } from './version_header';
 
 const buildServerVersion = (parts: Partial<ServerVersion> = {}): ServerVersion => ({

diff --git a/packages/core/apps/core-apps-browser-internal/src/status/components/version_header.tsx b/packages/core/apps/core-apps-browser-internal/src/status/components/version_header.tsx
@@ -10,7 +10,7 @@
 import React, { FC } from 'react';
 import { EuiFlexGroup, EuiFlexItem, EuiPanel, EuiText } from '@elastic/eui';
 import { FormattedMessage } from '@kbn/i18n-react';
-import type { ServerVersion } from '@kbn/core-status-common-internal';
+import type { ServerVersion } from '@kbn/core-status-common';
 
 interface VersionHeaderProps {
   version: ServerVersion;

diff --git a/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.test.ts b/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.test.ts
@@ -8,7 +8,7 @@
  */
 
 import { httpServiceMock } from '@kbn/core-http-browser-mocks';
-import type { StatusResponse } from '@kbn/core-status-common-internal';
+import type { StatusResponse } from '@kbn/core-status-common';
 import { notificationServiceMock } from '@kbn/core-notifications-browser-mocks';
 import { mocked } from '@kbn/core-metrics-collectors-server-mocks';
 import { loadStatus } from './load_status';

diff --git a/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts b/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts
@@ -11,11 +11,11 @@ import numeral from '@elastic/numeral';
 import { i18n } from '@kbn/i18n';
 import type { HttpSetup } from '@kbn/core-http-browser';
 import type { NotificationsSetup } from '@kbn/core-notifications-browser';
-import type { ServiceStatusLevelId } from '@kbn/core-status-common';
 import type {
+  ServiceStatusLevelId,
   StatusResponse,
   StatusInfoServiceStatus as ServiceStatus,
-} from '@kbn/core-status-common-internal';
+} from '@kbn/core-status-common';
 import type { DataType } from './format_number';
 
 interface MetricMeta {

diff --git a/packages/core/apps/core-apps-browser-internal/src/status/lib/status_level.test.ts b/packages/core/apps/core-apps-browser-internal/src/status/lib/status_level.test.ts
@@ -7,7 +7,7 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-import type { StatusInfoServiceStatus as ServiceStatus } from '@kbn/core-status-common-internal';
+import type { StatusInfoServiceStatus as ServiceStatus } from '@kbn/core-status-common';
 import { getLevelSortValue, groupByLevel, getHighestStatus } from './status_level';
 import { FormattedStatus, StatusState } from './load_status';
 

diff --git a/packages/core/apps/core-apps-browser-internal/tsconfig.json b/packages/core/apps/core-apps-browser-internal/tsconfig.json
@@ -24,7 +24,6 @@
     "@kbn/core-application-browser",
     "@kbn/core-application-browser-internal",
     "@kbn/core-mount-utils-browser-internal",
-    "@kbn/core-status-common-internal",
     "@kbn/core-http-browser-internal",
     "@kbn/core-application-browser-mocks",
     "@kbn/core-notifications-browser-mocks",

diff --git a/packages/core/status/core-status-common-internal/README.md b/packages/core/status/core-status-common-internal/README.md
diff --git a/packages/core/status/core-status-common-internal/index.ts b/packages/core/status/core-status-common-internal/index.ts
diff --git a/packages/core/status/core-status-common-internal/jest.config.js b/packages/core/status/core-status-common-internal/jest.config.js
diff --git a/packages/core/status/core-status-common-internal/kibana.jsonc b/packages/core/status/core-status-common-internal/kibana.jsonc
diff --git a/packages/core/status/core-status-common-internal/package.json b/packages/core/status/core-status-common-internal/package.json
diff --git a/packages/core/status/core-status-common-internal/src/index.ts b/packages/core/status/core-status-common-internal/src/index.ts
diff --git a/packages/core/status/core-status-common-internal/tsconfig.json b/packages/core/status/core-status-common-internal/tsconfig.json
diff --git a/packages/core/status/core-status-common/index.ts b/packages/core/status/core-status-common/index.ts
@@ -7,5 +7,14 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-export { ServiceStatusLevels } from './src';
-export type { ServiceStatus, ServiceStatusLevel, ServiceStatusLevelId, CoreStatus } from './src';
+export { ServiceStatusLevels } from './src/service_status';
+export type { CoreStatus } from './src/core_status';
+export type { ServiceStatus, ServiceStatusLevel, ServiceStatusLevelId } from './src/service_status';
+export type {
+  StatusInfo,
+  StatusInfoCoreStatus,
+  StatusInfoServiceStatus,
+  StatusResponse,
+  ServerVersion,
+  ServerMetrics,
+} from './src/status';
diff --git a/packages/core/status/core-status-common/jest.config.js b/packages/core/status/core-status-common/jest.config.js
@@ -10,5 +10,5 @@
 module.exports = {
   preset: '@kbn/test',
   rootDir: '../../../..',
-  roots: ['<rootDir>/packages/core/status/core-status-common-internal'],
+  roots: ['<rootDir>/packages/core/status/core-status-common'],
 };
diff --git a/packages/core/status/core-status-common/src/index.ts b/packages/core/status/core-status-common/src/index.ts
diff --git a/...core-status-common-internal/src/status.ts → ...e/status/core-status-common/src/status.ts b/...core-status-common-internal/src/status.ts → ...e/status/core-status-common/src/status.ts
@@ -8,8 +8,9 @@
  */
 
 import type { BuildFlavor } from '@kbn/config';
-import type { ServiceStatusLevelId, ServiceStatus, CoreStatus } from '@kbn/core-status-common';
 import type { OpsMetrics } from '@kbn/core-metrics-server';
+import type { ServiceStatusLevelId, ServiceStatus } from './service_status';
+import type { CoreStatus } from './core_status';
 
 export interface StatusInfoServiceStatus extends Omit<ServiceStatus, 'level'> {
   level: ServiceStatusLevelId;

diff --git a/packages/core/status/core-status-common/tsconfig.json b/packages/core/status/core-status-common/tsconfig.json
@@ -12,7 +12,9 @@
     "**/*.tsx",
   ],
   "kbn_references": [
-    "@kbn/std"
+    "@kbn/std",
+    "@kbn/config",
+    "@kbn/core-metrics-server"
   ],
   "exclude": [
     "target/**/*",

diff --git a/packages/core/status/core-status-server-internal/src/routes/status.ts b/packages/core/status/core-status-server-internal/src/routes/status.ts
@@ -15,7 +15,7 @@ import type { IRouter } from '@kbn/core-http-server';
 import type { MetricsServiceSetup } from '@kbn/core-metrics-server';
 import type { CoreIncrementUsageCounter } from '@kbn/core-usage-data-server';
 import { type ServiceStatus, type CoreStatus, ServiceStatusLevels } from '@kbn/core-status-common';
-import { StatusResponse } from '@kbn/core-status-common-internal';
+import type { StatusResponse } from '@kbn/core-status-common';
 import { calculateLegacyStatus, type LegacyStatusInfo } from '../legacy_status';
 import { statusResponse, type RedactedStatusHttpBody } from './status_response_schemas';
 

diff --git a/packages/core/status/core-status-server-internal/src/routes/status_response_schemas.ts b/packages/core/status/core-status-server-internal/src/routes/status_response_schemas.ts
@@ -9,15 +9,15 @@
 
 import { schema, type Type, type TypeOf } from '@kbn/config-schema';
 import type { BuildFlavor } from '@kbn/config';
-import type { ServiceStatusLevelId, ServiceStatus } from '@kbn/core-status-common';
-
 import type {
+  ServiceStatusLevelId,
+  ServiceStatus,
   StatusResponse,
   StatusInfoCoreStatus,
   ServerMetrics,
   StatusInfo,
   ServerVersion,
-} from '@kbn/core-status-common-internal';
+} from '@kbn/core-status-common';
 
 const serviceStatusLevelId: () => Type<ServiceStatusLevelId> = () =>
   schema.oneOf(

diff --git a/packages/core/status/core-status-server-internal/tsconfig.json b/packages/core/status/core-status-server-internal/tsconfig.json
@@ -29,7 +29,6 @@
     "@kbn/core-saved-objects-server-internal",
     "@kbn/core-status-server",
     "@kbn/core-status-common",
-    "@kbn/core-status-common-internal",
     "@kbn/core-usage-data-base-server-internal",
     "@kbn/core-base-server-mocks",
     "@kbn/core-environment-server-mocks",

diff --git a/packages/kbn-manifest/index.ts b/packages/kbn-manifest/index.ts
@@ -37,7 +37,7 @@ export const runKbnManifestCli = () => {
           --list all List all the manifests
           --package [packageId] Select a package to update.
           --plugin [pluginId] Select a plugin to update.
-          --set [property] [value] Set the desired "[property]": "[value]"
+          --set [property]=[value] Set the desired "[property]": "[value]"
           --unset [property] Removes the desired "[property]: value" from the manifest
         `,
       },

diff --git a/src/plugins/interactive_setup/public/progress_indicator.tsx b/src/plugins/interactive_setup/public/progress_indicator.tsx
@@ -15,7 +15,7 @@ import useAsyncFn from 'react-use/lib/useAsyncFn';
 import useTimeoutFn from 'react-use/lib/useTimeoutFn';
 
 import type { IHttpFetchError } from '@kbn/core-http-browser';
-import type { StatusResponse } from '@kbn/core-status-common-internal';
+import type { StatusResponse } from '@kbn/core-status-common';
 import { i18n } from '@kbn/i18n';
 
 import { useKibana } from './use_kibana';

diff --git a/src/plugins/interactive_setup/tsconfig.json b/src/plugins/interactive_setup/tsconfig.json
@@ -14,7 +14,7 @@
     "@kbn/i18n",
     "@kbn/ui-theme",
     "@kbn/core-http-browser",
-    "@kbn/core-status-common-internal",
+    "@kbn/core-status-common",
     "@kbn/safer-lodash-set",
     "@kbn/test-jest-helpers",
     "@kbn/config-schema",

diff --git a/tsconfig.base.json b/tsconfig.base.json
@@ -606,8 +606,6 @@
       "@kbn/core-security-server-mocks/*": ["packages/core/security/core-security-server-mocks/*"],
       "@kbn/core-status-common": ["packages/core/status/core-status-common"],
       "@kbn/core-status-common/*": ["packages/core/status/core-status-common/*"],
-      "@kbn/core-status-common-internal": ["packages/core/status/core-status-common-internal"],
-      "@kbn/core-status-common-internal/*": ["packages/core/status/core-status-common-internal/*"],
       "@kbn/core-status-server": ["packages/core/status/core-status-server"],
       "@kbn/core-status-server/*": ["packages/core/status/core-status-server/*"],
       "@kbn/core-status-server-internal": ["packages/core/status/core-status-server-internal"],

diff --git a/x-pack/plugins/security_solution/common/endpoint/utils/kibana_status.ts b/x-pack/plugins/security_solution/common/endpoint/utils/kibana_status.ts
@@ -7,19 +7,19 @@
 
 import { KbnClient } from '@kbn/test';
 import type { Client } from '@elastic/elasticsearch';
-import type { StatusResponse } from '@kbn/core-status-common-internal';
+import type { StatusResponse } from '@kbn/core-status-common';
 import { catchAxiosErrorFormatAndThrow } from '../format_axios_error';
 
 export const fetchKibanaStatus = async (kbnClient: KbnClient): Promise<StatusResponse> => {
   // We DO NOT use `kbnClient.status.get()` here because the `kbnClient` passed on input could be our enhanced
   // client (created by `x-pack/plugins/security_solution/scripts/endpoint/common/stack_services.ts:267`)
   // which could be using an API key (which the core KbnClient does not support)
   return kbnClient
-    .request({
+    .request<StatusResponse>({
       method: 'GET',
       path: '/api/status',
     })
-    .then((response) => response.data as StatusResponse)
+    .then(({ data }) => data)
     .catch(catchAxiosErrorFormatAndThrow);
 };
 /**

diff --git a/x-pack/plugins/security_solution/tsconfig.json b/x-pack/plugins/security_solution/tsconfig.json
@@ -126,7 +126,7 @@
     "@kbn/dev-cli-errors",
     "@kbn/dev-utils",
     "@kbn/tooling-log",
-    "@kbn/core-status-common-internal",
+    "@kbn/core-status-common",
     "@kbn/repo-info",
     "@kbn/storybook",
     "@kbn/controls-plugin",

diff --git a/yarn.lock b/yarn.lock
@@ -4458,10 +4458,6 @@
   version "0.0.0"
   uid ""
 
-"@kbn/core-status-common-internal@link:packages/core/status/core-status-common-internal":
-  version "0.0.0"
-  uid ""
-
 "@kbn/core-status-common@link:packages/core/status/core-status-common":
   version "0.0.0"
   uid ""