Rename kibana_legacy to opensearch_dashboards_legacy (#37) (#154)

* Rename kibana_legacy to opensearch_dashboards_legacy (#37)

Signed-off-by: Bishoy Boktor <boktorbb@amazon.com>

src/plugins/opensearch_dashboards_legacy/README.md

@@ -0,0 +1,7 @@
+# OpenSearch-Dashboards-legacy
+
+This plugin contains several helpers and services to integrate pieces of the legacy OpenSearch Dashboards app with the new OpenSearch Dashboards platform.
+
+This plugin will be removed once all parts of legacy OpenSearch Dashboards are removed from other plugins.
+
+All of this plugin should be considered deprecated. New code should never integrate with the services provided from this plugin.

src/plugins/kibana_legacy/config.ts → src/plugins/opensearch_dashboards_legacy/config.ts

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { schema, TypeOf } from '@kbn/config-schema';
+import { schema, TypeOf } from '@osd/config-schema';
 
 export const configSchema = schema.object({
   defaultAppId: schema.string({ defaultValue: 'home' }),

src/plugins/opensearch_dashboards_legacy/opensearch_dashboards.json

@@ -0,0 +1,6 @@
+{
+  "id": "opensearchDashboardsLegacy",
+  "version": "opensearchDashboards",
+  "server": true,
+  "ui": true
+}

src/plugins/kibana_legacy/public/angular/angular_config.tsx → src/plugins/opensearch_dashboards_legacy/public/angular/angular_config.tsx

@@ -29,10 +29,10 @@ import $ from 'jquery';
 import { set } from '@elastic/safer-lodash-set';
 import { get } from 'lodash';
 import * as Rx from 'rxjs';
-import { ChromeBreadcrumb, EnvironmentMode, PackageInfo } from 'kibana/public';
+import { ChromeBreadcrumb, EnvironmentMode, PackageInfo } from 'opensearch-dashboards/public';
 import { History } from 'history';
 
-import { CoreStart } from 'kibana/public';
+import { CoreStart } from 'opensearch-dashboards/public';
 import { isSystemApiRequest } from '../utils';
 import { formatAngularHttpError, isAngularHttpError } from '../notify/lib';
 
@@ -86,10 +86,10 @@ export const configureAppAngularModule = (
   const packageInfo = newPlatform.env.packageInfo;
 
   angularModule
-    .value('kbnVersion', packageInfo.version)
+    .value('osdVersion', packageInfo.version)
     .value('buildNum', packageInfo.buildNum)
     .value('buildSha', packageInfo.buildSha)
-    .value('esUrl', getEsUrl(core))
+    .value('opensearchUrl', getOpenSearchUrl(core))
     .value('uiCapabilities', core.application.capabilities)
     .config(setupCompileProvider(newPlatform.env.mode.dev))
     .config(setupLocationProvider())
@@ -102,9 +102,9 @@ export const configureAppAngularModule = (
     .run($setupUICapabilityRedirect(core));
 };
 
-const getEsUrl = (newPlatform: CoreStart) => {
+const getOpenSearchUrl = (newPlatform: CoreStart) => {
   const a = document.createElement('a');
-  a.href = newPlatform.http.basePath.prepend('/elasticsearch');
+  a.href = newPlatform.http.basePath.prepend('/opensearch');
   const protocolPort = /https/.test(a.protocol) ? 443 : 80;
   const port = a.port || protocolPort;
   return {
@@ -146,9 +146,9 @@ const setupLocationProvider = () => ($locationProvider: ILocationProvider) => {
 
 export const $setupXsrfRequestInterceptor = (version: string) => {
   // Configure jQuery prefilter
-  $.ajaxPrefilter(({ kbnXsrfToken = true }: any, originalOptions, jqXHR) => {
-    if (kbnXsrfToken) {
-      jqXHR.setRequestHeader('kbn-version', version);
+  $.ajaxPrefilter(({ osdXsrfToken = true }: any, originalOptions, jqXHR) => {
+    if (osdXsrfToken) {
+      jqXHR.setRequestHeader('osd-version', version);
     }
   });
 
@@ -157,9 +157,9 @@ export const $setupXsrfRequestInterceptor = (version: string) => {
     $httpProvider.interceptors.push(() => {
       return {
         request(opts) {
-          const { kbnXsrfToken = true } = opts as any;
-          if (kbnXsrfToken) {
-            set(opts, ['headers', 'kbn-version'], version);
+          const { osdXsrfToken = true } = opts as any;
+          if (osdXsrfToken) {
+            set(opts, ['headers', 'osd-version'], version);
           }
           return opts;
         },
@@ -198,11 +198,11 @@ const $setupUICapabilityRedirect = (newPlatform: CoreStart) => (
   $rootScope: IRootScopeService,
   $injector: any
 ) => {
-  const isKibanaAppRoute = window.location.pathname.endsWith('/app/kibana');
-  // this feature only works within kibana app for now after everything is
+  const isOpenSearchDashboardsAppRoute = window.location.pathname.endsWith('/app/opensearch-dashboards');
+  // this feature only works within opensearch dashboards app for now after everything is
   // switched to the application service, this can be changed to handle all
   // apps.
-  if (!isKibanaAppRoute) {
+  if (!isOpenSearchDashboardsAppRoute) {
     return;
   }
   $rootScope.$on(
@@ -223,7 +223,7 @@ const $setupUICapabilityRedirect = (newPlatform: CoreStart) => (
 /**
  * internal angular run function that will be called when angular bootstraps and
  * lets us integrate with the angular router so that we can automatically clear
- * the breadcrumbs if we switch to a Kibana app that does not use breadcrumbs correctly
+ * the breadcrumbs if we switch to a OpenSearch Dashboards app that does not use breadcrumbs correctly
  */
 const $setupBreadcrumbsAutoClear = (newPlatform: CoreStart, isLocalAngular: boolean) => (
   $rootScope: IRootScopeService,
@@ -276,7 +276,7 @@ const $setupBreadcrumbsAutoClear = (newPlatform: CoreStart, isLocalAngular: bool
 /**
  * internal angular run function that will be called when angular bootstraps and
  * lets us integrate with the angular router so that we can automatically clear
- * the badge if we switch to a Kibana app that does not use the badge correctly
+ * the badge if we switch to a OpenSearch Dashboards app that does not use the badge correctly
  */
 const $setupBadgeAutoClear = (newPlatform: CoreStart, isLocalAngular: boolean) => (
   $rootScope: IRootScopeService,
@@ -321,7 +321,7 @@ const $setupBadgeAutoClear = (newPlatform: CoreStart, isLocalAngular: boolean) =
 /**
  * internal angular run function that will be called when angular bootstraps and
  * lets us integrate with the angular router so that we can automatically clear
- * the helpExtension if we switch to a Kibana app that does not set its own
+ * the helpExtension if we switch to a OpenSearch Dashboards app that does not set its own
  * helpExtension
  */
 const $setupHelpExtensionAutoClear = (newPlatform: CoreStart, isLocalAngular: boolean) => (

src/plugins/kibana_legacy/public/angular/index.ts → src/plugins/opensearch_dashboards_legacy/public/angular/index.ts

@@ -22,5 +22,5 @@ export { PromiseServiceCreator } from './promises';
 export { watchMultiDecorator } from './watch_multi';
 export * from './angular_config';
 // @ts-ignore
-export { createTopNavDirective, createTopNavHelper, loadKbnTopNavDirectives } from './kbn_top_nav';
+export { createTopNavDirective, createTopNavHelper, loadOsdTopNavDirectives } from './osd_top_nav';
 export { subscribeWithScope } from './subscribe_with_scope';

src/plugins/kibana_legacy/public/angular/kbn_top_nav.js → src/plugins/opensearch_dashboards_legacy/public/angular/osd_top_nav.js

@@ -25,7 +25,7 @@ export function createTopNavDirective() {
     restrict: 'E',
     template: '',
     compile: (elem) => {
-      const child = document.createElement('kbn-top-nav-helper');
+      const child = document.createElement('osd-top-nav-helper');
 
       // Copy attributes to the child directive
       for (const attr of elem[0].attributes) {
@@ -118,12 +118,12 @@ export const createTopNavHelper = ({ TopNavMenu }) => (reactDirective) => {
 
 let isLoaded = false;
 
-export function loadKbnTopNavDirectives(navUi) {
+export function loadOsdTopNavDirectives(navUi) {
   if (!isLoaded) {
     isLoaded = true;
     angular
-      .module('kibana')
-      .directive('kbnTopNav', createTopNavDirective)
-      .directive('kbnTopNavHelper', createTopNavHelper(navUi));
+      .module('opensearchDashboards')
+      .directive('osdTopNav', createTopNavDirective)
+      .directive('osdTopNavHelper', createTopNavHelper(navUi));
   }
 }

src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts → src/plugins/opensearch_dashboards_legacy/public/angular/subscribe_with_scope.ts

@@ -28,7 +28,7 @@ function callInDigest($scope: IScope, fn: () => void, fatalError?: FatalErrorFn)
     // this is terrible, but necessary to synchronously deliver subscription values
     // to angular scopes. This is required by some APIs, like the `config` service,
     // and beneficial for root level directives where additional digest cycles make
-    // kibana sluggish to load.
+    // opensearch dashboards sluggish to load.
     //
     // If you copy this code elsewhere you better have a good reason :)
     if ($scope.$root.$$phase) {
@@ -67,8 +67,7 @@ export function subscribeWithScope<T>(
             observer.error(error);
           } else {
             throw new Error(
-              `Uncaught error in subscribeWithScope(): ${
-                error ? error.stack || error.message : error
+              `Uncaught error in subscribeWithScope(): ${error ? error.stack || error.message : error
               }`
             );
           }

src/plugins/kibana_legacy/public/index.ts → src/plugins/opensearch_dashboards_legacy/public/index.ts

@@ -17,11 +17,11 @@
  * under the License.
  */
 
-import { PluginInitializerContext } from 'kibana/public';
-import { KibanaLegacyPlugin } from './plugin';
+import { PluginInitializerContext } from 'opensearch-dashboards/public';
+import { OpenSearchDashboardsLegacyPlugin } from './plugin';
 
 export const plugin = (initializerContext: PluginInitializerContext) =>
-  new KibanaLegacyPlugin(initializerContext);
+  new OpenSearchDashboardsLegacyPlugin(initializerContext);
 
 export * from './plugin';
 

src/plugins/kibana_legacy/public/mocks.ts → src/plugins/opensearch_dashboards_legacy/public/mocks.ts

@@ -17,10 +17,10 @@
  * under the License.
  */
 
-import { KibanaLegacyPlugin } from './plugin';
+import { OpenSearchDashboardsLegacyPlugin } from './plugin';
 
-export type Setup = jest.Mocked<ReturnType<KibanaLegacyPlugin['setup']>>;
-export type Start = jest.Mocked<ReturnType<KibanaLegacyPlugin['start']>>;
+export type Setup = jest.Mocked<ReturnType<OpenSearchDashboardsLegacyPlugin['setup']>>;
+export type Start = jest.Mocked<ReturnType<OpenSearchDashboardsLegacyPlugin['start']>>;
 
 const createSetupContract = (): Setup => ({});
 
@@ -35,7 +35,7 @@ const createStartContract = (): Start => ({
   loadFontAwesome: jest.fn(),
 });
 
-export const kibanaLegacyPluginMock = {
+export const opensearchDashboardsLegacyPluginMock = {
   createSetupContract,
   createStartContract,
 };

src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts → src/plugins/opensearch_dashboards_legacy/public/notify/lib/format_angular_http_error.ts

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { i18n } from '@kbn/i18n';
+import { i18n } from '@osd/i18n';
 import { IHttpResponse } from 'angular';
 
 export type AngularHttpError = IHttpResponse<{ message: string }>;
@@ -36,15 +36,15 @@ export function formatAngularHttpError(error: AngularHttpError) {
   // is an Angular $http "error object"
   if (error.status === -1) {
     // status = -1 indicates that the request was failed to reach the server
-    return i18n.translate('kibana_legacy.notify.fatalError.unavailableServerErrorMessage', {
+    return i18n.translate('opensearch_dashboards_legacy.notify.fatalError.unavailableServerErrorMessage', {
       defaultMessage:
         'An HTTP request has failed to connect. ' +
-        'Please check if the Kibana server is running and that your browser has a working connection, ' +
+        'Please check if the OpenSearch Dashboards server is running and that your browser has a working connection, ' +
         'or contact your system administrator.',
     });
   }
 
-  return i18n.translate('kibana_legacy.notify.fatalError.errorStatusMessage', {
+  return i18n.translate('opensearch_dashboards_legacy.notify.fatalError.errorStatusMessage', {
     defaultMessage: 'Error {errStatus} {errStatusText}: {errMessage}',
     values: {
       errStatus: error.status,

src/plugins/kibana_legacy/public/notify/lib/format_msg.test.js → src/plugins/opensearch_dashboards_legacy/public/notify/lib/format_msg.test.js

@@ -18,7 +18,7 @@
  */
 
 import { formatMsg } from './format_msg';
-import expect from '@kbn/expect';
+import expect from '@osd/expect';
 
 describe('formatMsg', () => {
   test('should prepend the second argument to result', () => {
@@ -59,7 +59,7 @@ describe('formatMsg', () => {
     );
   });
 
-  test('should handle an extended elasticsearch error', () => {
+  test('should handle an extended opensearch error', () => {
     const err = {
       resp: {
         error: {

src/plugins/kibana_legacy/public/notify/lib/format_msg.ts → src/plugins/opensearch_dashboards_legacy/public/notify/lib/format_msg.ts

@@ -18,12 +18,12 @@
  */
 
 import _ from 'lodash';
-import { i18n } from '@kbn/i18n';
-import { formatESMsg } from './format_es_msg';
+import { i18n } from '@osd/i18n';
+import { formatOpenSearchMsg } from './format_opensearch_msg';
 const has = _.has;
 
 /**
- * Formats the error message from an error object, extended elasticsearch
+ * Formats the error message from an error object, extended opensearch
  * object or simple string; prepends optional second parameter to the message
  * @param  {Error|String} err
  * @param  {String} source - Prefix for message indicating source (optional)
@@ -35,26 +35,26 @@ export function formatMsg(err: Record<string, any> | string, source: string = ''
     message += source + ': ';
   }
 
-  const esMsg = formatESMsg(err);
+  const opensearchMsg = formatOpenSearchMsg(err);
 
   if (typeof err === 'string') {
     message += err;
-  } else if (esMsg) {
-    message += esMsg;
+  } else if (opensearchMsg) {
+    message += opensearchMsg;
   } else if (err instanceof Error) {
     message += formatMsg.describeError(err);
   } else if (has(err, 'status') && has(err, 'data')) {
     // is an Angular $http "error object"
     if (err.status === -1) {
       // status = -1 indicates that the request was failed to reach the server
-      message += i18n.translate('kibana_legacy.notify.toaster.unavailableServerErrorMessage', {
+      message += i18n.translate('opensearch_dashboards_legacy.notify.toaster.unavailableServerErrorMessage', {
         defaultMessage:
           'An HTTP request has failed to connect. ' +
-          'Please check if the Kibana server is running and that your browser has a working connection, ' +
+          'Please check if the OpenSearch Dashboards server is running and that your browser has a working connection, ' +
           'or contact your system administrator.',
       });
     } else {
-      message += i18n.translate('kibana_legacy.notify.toaster.errorStatusMessage', {
+      message += i18n.translate('opensearch_dashboards_legacy.notify.toaster.errorStatusMessage', {
         defaultMessage: 'Error {errStatus} {errStatusText}: {errMessage}',
         values: {
           errStatus: err.status,

src/plugins/kibana_legacy/public/notify/lib/format_es_msg.test.js → src/plugins/opensearch_dashboards_legacy/public/notify/lib/format_opensearch_msg.test.js

@@ -17,28 +17,28 @@
  * under the License.
  */
 
-import { formatESMsg } from './format_es_msg';
-import expect from '@kbn/expect';
+import { formatOpenSearchMsg } from './format_opensearch_msg';
+import expect from '@osd/expect';
 
-describe('formatESMsg', () => {
+describe('formatOpenSearchMsg', () => {
   test('should return undefined if passed a basic error', () => {
     const err = new Error('This is a normal error');
 
-    const actual = formatESMsg(err);
+    const actual = formatOpenSearchMsg(err);
 
     expect(actual).to.be(undefined);
   });
 
   test('should return undefined if passed a string', () => {
     const err = 'This is a error string';
 
-    const actual = formatESMsg(err);
+    const actual = formatOpenSearchMsg(err);
 
     expect(actual).to.be(undefined);
   });
 
-  test('should return the root_cause if passed an extended elasticsearch', () => {
-    const err = new Error('This is an elasticsearch error');
+  test('should return the root_cause if passed an extended opensearch', () => {
+    const err = new Error('This is an opensearch error');
     err.resp = {
       error: {
         root_cause: [
@@ -49,13 +49,13 @@ describe('formatESMsg', () => {
       },
     };
 
-    const actual = formatESMsg(err);
+    const actual = formatOpenSearchMsg(err);
 
     expect(actual).to.equal('I am the detailed message');
   });
 
   test('should combine the reason messages if more than one is returned.', () => {
-    const err = new Error('This is an elasticsearch error');
+    const err = new Error('This is an opensearch error');
     err.resp = {
       error: {
         root_cause: [
@@ -69,7 +69,7 @@ describe('formatESMsg', () => {
       },
     };
 
-    const actual = formatESMsg(err);
+    const actual = formatOpenSearchMsg(err);
 
     expect(actual).to.equal('I am the detailed message 1\nI am the detailed message 2');
   });