Expose decoded cloudId components from the cloud plugin's contract

x-pack/plugins/fleet/common/services/decode_cloud_id.ts → x-pack/plugins/cloud/common/decode_cloud_id.ts

@@ -5,15 +5,15 @@
  * 2.0.
  */
 
+export interface DecodedCloudId {
+  host: string;
+  defaultPort: string;
+  elasticsearchUrl: string;
+  kibanaUrl: string;
+}
+
 // decodeCloudId decodes the c.id into c.esURL and c.kibURL
-export function decodeCloudId(cid: string):
-  | {
-      host: string;
-      defaultPort: string;
-      elasticsearchUrl: string;
-      kibanaUrl: string;
-    }
-  | undefined {
+export function decodeCloudId(cid: string): DecodedCloudId | undefined {
   // 1. Ignore anything before `:`.
   const id = cid.split(':').pop();
   if (!id) {
@@ -56,6 +56,7 @@ export function decodeCloudId(cid: string):
     kibanaUrl: kbUrl,
   };
 }
+
 // extractPortFromName takes a string in the form `id:port` and returns the
 // Id and the port. If there's no `:`, the default port is returned
 function extractPortFromName(word: string, defaultPort = '443') {

x-pack/plugins/cloud/public/index.ts

@@ -8,7 +8,8 @@
 import { PluginInitializerContext } from '@kbn/core/public';
 import { CloudPlugin } from './plugin';
 
-export type { CloudSetup, CloudConfigType, CloudStart } from './plugin';
+export type { CloudSetup, CloudStart } from './types';
+export type { CloudConfigType } from './plugin';
 
 export function plugin(initializerContext: PluginInitializerContext) {
   return new CloudPlugin(initializerContext);

x-pack/plugins/cloud/public/mocks.tsx

@@ -7,17 +7,22 @@
 
 import React from 'react';
 
-import { CloudStart } from '.';
+import type { CloudSetup, CloudStart } from './types';
 
-function createSetupMock() {
+function createSetupMock(): jest.Mocked<CloudSetup> {
   return {
     cloudId: 'mock-cloud-id',
+    deploymentId: 'mock-deployment-id',
     isCloudEnabled: true,
     cname: 'cname',
     baseUrl: 'base-url',
     deploymentUrl: 'deployment-url',
     profileUrl: 'profile-url',
     organizationUrl: 'organization-url',
+    elasticsearchUrl: 'elasticsearch-url',
+    kibanaUrl: 'kibana-url',
+    cloudHost: 'cloud-host',
+    cloudDefaultPort: '443',
     isElasticStaffOwned: true,
     trialEndDate: new Date('2020-10-01T14:13:12Z'),
     registerCloudService: jest.fn(),

x-pack/plugins/cloud/public/plugin.test.mocks.ts

@@ -0,0 +1,22 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export const parseDeploymentIdFromDeploymentUrlMock = jest.fn();
+
+jest.doMock('../common/parse_deployment_id_from_deployment_url', () => {
+  return {
+    parseDeploymentIdFromDeploymentUrl: parseDeploymentIdFromDeploymentUrlMock,
+  };
+});
+
+export const decodeCloudIdMock = jest.fn();
+
+jest.doMock('../common/decode_cloud_id', () => {
+  return {
+    decodeCloudId: decodeCloudIdMock,
+  };
+});

x-pack/plugins/cloud/public/plugin.test.ts

@@ -5,8 +5,10 @@
  * 2.0.
  */
 
+import { decodeCloudIdMock, parseDeploymentIdFromDeploymentUrlMock } from './plugin.test.mocks';
 import { coreMock } from '@kbn/core/public/mocks';
 import { CloudPlugin } from './plugin';
+import type { DecodedCloudId } from '../common/decode_cloud_id';
 
 const baseConfig = {
   base_url: 'https://cloud.elastic.co',
@@ -16,6 +18,11 @@ const baseConfig = {
 };
 
 describe('Cloud Plugin', () => {
+  beforeEach(() => {
+    parseDeploymentIdFromDeploymentUrlMock.mockReset().mockReturnValue('deployment-id');
+    decodeCloudIdMock.mockReset().mockReturnValue({});
+  });
+
   describe('#setup', () => {
     describe('interface', () => {
       const setupPlugin = () => {
@@ -76,6 +83,37 @@ describe('Cloud Plugin', () => {
         const { setup } = setupPlugin();
         expect(setup.registerCloudService).toBeDefined();
       });
+
+      it('exposes deploymentId', () => {
+        parseDeploymentIdFromDeploymentUrlMock.mockReturnValue('some-deployment-id');
+        const { setup } = setupPlugin();
+        expect(setup.deploymentId).toBe('some-deployment-id');
+        expect(parseDeploymentIdFromDeploymentUrlMock).toHaveBeenCalledTimes(2); // called when registering the analytic context too
+        expect(parseDeploymentIdFromDeploymentUrlMock).toHaveBeenCalledWith(
+          baseConfig.deployment_url
+        );
+      });
+
+      it('exposes components decoded from the cloudId', () => {
+        const decodedId: DecodedCloudId = {
+          defaultPort: '9000',
+          host: 'host',
+          elasticsearchUrl: 'elasticsearch-url',
+          kibanaUrl: 'kibana-url',
+        };
+        decodeCloudIdMock.mockReturnValue(decodedId);
+        const { setup } = setupPlugin();
+        expect(setup).toEqual(
+          expect.objectContaining({
+            cloudDefaultPort: '9000',
+            cloudHost: 'host',
+            elasticsearchUrl: 'elasticsearch-url',
+            kibanaUrl: 'kibana-url',
+          })
+        );
+        expect(decodeCloudIdMock).toHaveBeenCalledTimes(1);
+        expect(decodeCloudIdMock).toHaveBeenCalledWith('cloudId');
+      });
     });
   });
 

x-pack/plugins/cloud/public/plugin.tsx

@@ -7,10 +7,12 @@
 
 import React, { FC } from 'react';
 import type { CoreSetup, CoreStart, Plugin, PluginInitializerContext } from '@kbn/core/public';
-
 import { registerCloudDeploymentMetadataAnalyticsContext } from '../common/register_cloud_deployment_id_analytics_context';
 import { getIsCloudEnabled } from '../common/is_cloud_enabled';
+import { parseDeploymentIdFromDeploymentUrl } from '../common/parse_deployment_id_from_deployment_url';
 import { ELASTIC_SUPPORT_LINK, CLOUD_SNAPSHOTS_PATH } from '../common/constants';
+import { decodeCloudId, type DecodedCloudId } from '../common/decode_cloud_id';
+import type { CloudSetup, CloudStart } from './types';
 import { getFullCloudUrl } from './utils';
 
 export interface CloudConfigType {
@@ -24,81 +26,6 @@ export interface CloudConfigType {
   is_elastic_staff_owned?: boolean;
 }
 
-export interface CloudStart {
-  /**
-   * A React component that provides a pre-wired `React.Context` which connects components to Cloud services.
-   */
-  CloudContextProvider: FC<{}>;
-  /**
-   * `true` when Kibana is running on Elastic Cloud.
-   */
-  isCloudEnabled: boolean;
-  /**
-   * Cloud ID. Undefined if not running on Cloud.
-   */
-  cloudId?: string;
-  /**
-   * The full URL to the deployment management page on Elastic Cloud. Undefined if not running on Cloud.
-   */
-  deploymentUrl?: string;
-  /**
-   * The full URL to the user profile page on Elastic Cloud. Undefined if not running on Cloud.
-   */
-  profileUrl?: string;
-  /**
-   * The full URL to the organization management page on Elastic Cloud. Undefined if not running on Cloud.
-   */
-  organizationUrl?: string;
-}
-
-export interface CloudSetup {
-  /**
-   * Cloud ID. Undefined if not running on Cloud.
-   */
-  cloudId?: string;
-  /**
-   * This value is the same as `baseUrl` on ESS but can be customized on ECE.
-   */
-  cname?: string;
-  /**
-   * This is the URL of the Cloud interface.
-   */
-  baseUrl?: string;
-  /**
-   * The full URL to the deployment management page on Elastic Cloud. Undefined if not running on Cloud.
-   */
-  deploymentUrl?: string;
-  /**
-   * The full URL to the user profile page on Elastic Cloud. Undefined if not running on Cloud.
-   */
-  profileUrl?: string;
-  /**
-   * The full URL to the organization management page on Elastic Cloud. Undefined if not running on Cloud.
-   */
-  organizationUrl?: string;
-  /**
-   * This is the path to the Snapshots page for the deployment to which the Kibana instance belongs. The value is already prepended with `deploymentUrl`.
-   */
-  snapshotsUrl?: string;
-  /**
-   * `true` when Kibana is running on Elastic Cloud.
-   */
-  isCloudEnabled: boolean;
-  /**
-   * When the Cloud Trial ends/ended for the organization that owns this deployment. Only available when running on Elastic Cloud.
-   */
-  trialEndDate?: Date;
-  /**
-   * `true` if the Elastic Cloud organization that owns this deployment is owned by an Elastician. Only available when running on Elastic Cloud.
-   */
-  isElasticStaffOwned?: boolean;
-  /**
-   * Registers CloudServiceProviders so start's `CloudContextProvider` hooks them.
-   * @param contextProvider The React component from the Service Provider.
-   */
-  registerCloudService: (contextProvider: FC) => void;
-}
-
 interface CloudUrls {
   deploymentUrl?: string;
   profileUrl?: string;
@@ -127,11 +54,21 @@ export class CloudPlugin implements Plugin<CloudSetup> {
       is_elastic_staff_owned: isElasticStaffOwned,
     } = this.config;
 
+    let decodedId: DecodedCloudId | undefined;
+    if (id) {
+      decodedId = decodeCloudId(id);
+    }
+
     return {
       cloudId: id,
+      deploymentId: parseDeploymentIdFromDeploymentUrl(this.config.deployment_url),
       cname,
       baseUrl,
       ...this.getCloudUrls(),
+      elasticsearchUrl: decodedId?.elasticsearchUrl,
+      kibanaUrl: decodedId?.kibanaUrl,
+      cloudHost: decodedId?.host,
+      cloudDefaultPort: decodedId?.defaultPort,
       trialEndDate: trialEndDate ? new Date(trialEndDate) : undefined,
       isElasticStaffOwned,
       isCloudEnabled: this.isCloudEnabled,

x-pack/plugins/cloud/public/types.ts

@@ -0,0 +1,111 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import type { FC } from 'react';
+
+export interface CloudStart {
+  /**
+   * A React component that provides a pre-wired `React.Context` which connects components to Cloud services.
+   */
+  CloudContextProvider: FC<{}>;
+  /**
+   * `true` when Kibana is running on Elastic Cloud.
+   */
+  isCloudEnabled: boolean;
+  /**
+   * Cloud ID. Undefined if not running on Cloud.
+   */
+  cloudId?: string;
+  /**
+   * The full URL to the deployment management page on Elastic Cloud. Undefined if not running on Cloud.
+   */
+  deploymentUrl?: string;
+  /**
+   * The full URL to the user profile page on Elastic Cloud. Undefined if not running on Cloud.
+   */
+  profileUrl?: string;
+  /**
+   * The full URL to the organization management page on Elastic Cloud. Undefined if not running on Cloud.
+   */
+  organizationUrl?: string;
+  /**
+   * The full URL to the elasticsearch cluster.
+   */
+  elasticsearchUrl?: string;
+  /**
+   * The full URL to the Kibana deployment.
+   */
+  kibanaUrl?: string;
+}
+
+export interface CloudSetup {
+  /**
+   * Cloud ID. Undefined if not running on Cloud.
+   */
+  cloudId?: string;
+  /**
+   * The deployment's ID. Only available when running on Elastic Cloud.
+   */
+  deploymentId?: string;
+  /**
+   * This value is the same as `baseUrl` on ESS but can be customized on ECE.
+   */
+  cname?: string;
+  /**
+   * This is the URL of the Cloud interface.
+   */
+  baseUrl?: string;
+  /**
+   * The full URL to the deployment management page on Elastic Cloud. Undefined if not running on Cloud.
+   */
+  deploymentUrl?: string;
+  /**
+   * The full URL to the user profile page on Elastic Cloud. Undefined if not running on Cloud.
+   */
+  profileUrl?: string;
+  /**
+   * The full URL to the organization management page on Elastic Cloud. Undefined if not running on Cloud.
+   */
+  organizationUrl?: string;
+  /**
+   * This is the path to the Snapshots page for the deployment to which the Kibana instance belongs. The value is already prepended with `deploymentUrl`.
+   */
+  snapshotsUrl?: string;
+  /**
+   * The full URL to the elasticsearch cluster.
+   */
+  elasticsearchUrl?: string;
+  /**
+   * The full URL to the Kibana deployment.
+   */
+  kibanaUrl?: string;
+  /**
+   * {host} from the deployment url https://<deploymentId>.<application>.<host><?:port>
+   */
+  cloudHost?: string;
+  /**
+   * {port} from the deployment url https://<deploymentId>.<application>.<host><?:port>
+   */
+  cloudDefaultPort?: string;
+  /**
+   * `true` when Kibana is running on Elastic Cloud.
+   */
+  isCloudEnabled: boolean;
+  /**
+   * When the Cloud Trial ends/ended for the organization that owns this deployment. Only available when running on Elastic Cloud.
+   */
+  trialEndDate?: Date;
+  /**
+   * `true` if the Elastic Cloud organization that owns this deployment is owned by an Elastician. Only available when running on Elastic Cloud.
+   */
+  isElasticStaffOwned?: boolean;
+  /**
+   * Registers CloudServiceProviders so start's `CloudContextProvider` hooks them.
+   * @param contextProvider The React component from the Service Provider.
+   */
+  registerCloudService: (contextProvider: FC) => void;
+}