Change save object type, wizard ID and Name to visBuilder

abbyhu2000 · abbyhu2000 · commit a270a940550e · 2022-10-26T01:49:35.000Z
Signed-off-by: abbyhu2000 &lt;abigailhu2000@gmail.com&gt;
diff --git a/config/opensearch_dashboards.yml b/config/opensearch_dashboards.yml
@@ -222,7 +222,7 @@
 
 # Set the value of this setting to true to start exploring wizard
 # functionality in Visualization.
-# wizard.enabled: false
+# visBuilder.enabled: false
 
 # Set the value of this setting to true to enable the experimental multiple data source
 # support feature. Use with caution.
diff --git a/src/plugins/saved_objects/README.md b/src/plugins/saved_objects/README.md
@@ -1,6 +1,6 @@
 # Saved object
 
-The saved object plugin provides all the core services and functionalities of saved objects. It is utilized by many core plugins such as [`visualization`](../visualizations/), [`dashboard`](../dashboard/) and [`wizard`](../wizard/), as well as external plugins. Saved object is the primary way to store app and plugin data in a standardized form in OpenSearch Dashboards. They allow plugin developers to manage creating, saving, editing and retrieving data for the application. They can also make reference to other saved objects and have useful features out of the box, such as migrations and strict typings. The saved objects can be managed by the Saved Object Management UI.
+The saved object plugin provides all the core services and functionalities of saved objects. It is utilized by many core plugins such as [`visualization`](../visualizations/), [`dashboard`](../dashboard/) and [`visBuilder`](../visBuilder/), as well as external plugins. Saved object is the primary way to store app and plugin data in a standardized form in OpenSearch Dashboards. They allow plugin developers to manage creating, saving, editing and retrieving data for the application. They can also make reference to other saved objects and have useful features out of the box, such as migrations and strict typings. The saved objects can be managed by the Saved Object Management UI.
 
 ## Save relationships to index pattern
 
diff --git a/src/plugins/saved_objects_management/opensearch_dashboards.json b/src/plugins/saved_objects_management/opensearch_dashboards.json
@@ -4,7 +4,7 @@
   "server": true,
   "ui": true,
   "requiredPlugins": ["management", "data"],
-  "optionalPlugins": ["dashboard", "visualizations", "discover", "home", "wizard"],
+  "optionalPlugins": ["dashboard", "visualizations", "discover", "home", "visBuilder"],
   "extraPublicDirs": ["public/lib"],
   "requiredBundles": ["opensearchDashboardsReact", "home"]
 }
diff --git a/src/plugins/saved_objects_management/public/plugin.ts b/src/plugins/saved_objects_management/public/plugin.ts
@@ -31,7 +31,7 @@
 import { i18n } from '@osd/i18n';
 import { CoreSetup, CoreStart, Plugin } from 'src/core/public';
 
-import { WizardStart } from '../../vis_builder/public';
+import { VisBuilderStart } from '../../vis_builder/public';
 import { ManagementSetup } from '../../management/public';
 import { DataPublicPluginStart } from '../../data/public';
 import { DashboardStart } from '../../dashboard/public';
@@ -71,7 +71,7 @@ export interface StartDependencies {
   dashboard?: DashboardStart;
   visualizations?: VisualizationsStart;
   discover?: DiscoverStart;
-  wizard?: WizardStart;
+  visBuilder?: VisBuilderStart;
 }
 
 export class SavedObjectsManagementPlugin
diff --git a/src/plugins/saved_objects_management/public/register_services.ts b/src/plugins/saved_objects_management/public/register_services.ts
@@ -36,7 +36,7 @@ export const registerServices = async (
   registry: ISavedObjectsManagementServiceRegistry,
   getStartServices: StartServicesAccessor<StartDependencies, SavedObjectsManagementPluginStart>
 ) => {
-  const [, { dashboard, visualizations, discover, wizard }] = await getStartServices();
+  const [, { dashboard, visualizations, discover, visBuilder }] = await getStartServices();
 
   if (dashboard) {
     registry.register({
@@ -62,11 +62,11 @@ export const registerServices = async (
     });
   }
 
-  if (wizard) {
+  if (visBuilder) {
     registry.register({
-      id: 'savedWizard',
-      title: 'wizard',
-      service: wizard.savedWizardLoader,
+      id: 'savedVisBuilder',
+      title: 'visBuilder',
+      service: visBuilder.savedVisBuilderLoader,
     });
   }
 };
diff --git a/src/plugins/vis_builder/README.md b/src/plugins/vis_builder/README.md
@@ -1,12 +1,12 @@
-# Wizard
+# Visualization Builder
 
 An OpenSearch Dashboards plugin for a visualization experience that makes exploring data and creating visualizations much easier. It will act as an additional way to create visualizations alongside the exiting tools within the current visualizations plugin. The tool will be incremental to the visualization tools available to users in OpenSearch Dashboards today.
 
 ## Usage
 
 To use this plugin, navigate to:
 
-Visualize -> Create Visualization -> Wizard
+Visualize -> Create Visualization -> Visualization Builder
 
 ## Add a visualization
 
diff --git a/src/plugins/vis_builder/common/index.ts b/src/plugins/vis_builder/common/index.ts
@@ -3,8 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-export const PLUGIN_ID = 'wizard';
-export const PLUGIN_NAME = 'Wizard';
+export const PLUGIN_ID = 'visBuilder';
+export const PLUGIN_NAME = 'Visualization Builder';
 export const VISUALIZE_ID = 'visualize';
 export const EDIT_PATH = '/edit';
 
diff --git a/src/plugins/vis_builder/common/vis_builder_saved_object_attributes.ts b/src/plugins/vis_builder/common/vis_builder_saved_object_attributes.ts
@@ -5,7 +5,7 @@
 
 import { SavedObjectAttributes } from '../../../core/types';
 
-export const VISBUILDER_SAVED_OBJECT = 'wizard';
+export const VISBUILDER_SAVED_OBJECT = 'visBuilder';
 
 export interface VisBuilderSavedObjectAttributes extends SavedObjectAttributes {
   title: string;
diff --git a/src/plugins/vis_builder/opensearch_dashboards.json b/src/plugins/vis_builder/opensearch_dashboards.json
@@ -1,5 +1,6 @@
 {
-  "id": "wizard",
+  "id": "visBuilder",
+  "configPath": "visBuilder",
   "version": "1.0.0",
   "opensearchDashboardsVersion": "opensearchDashboards",
   "server": true,
diff --git a/src/plugins/vis_builder/public/application/utils/get_top_nav_config.tsx b/src/plugins/vis_builder/public/application/utils/get_top_nav_config.tsx
@@ -81,7 +81,7 @@ export const getTopNavConfig = (
           : i18n.translate('visBuilder.topNavMenu.saveVisualizationButtonLabel', {
               defaultMessage: 'save',
             }),
-      testId: 'wizardSaveButton',
+      testId: 'visBuilderSaveButton',
       disableButton: !!saveDisabledReason,
       tooltip: saveDisabledReason,
       run: (_anchorElement) => {
@@ -95,7 +95,7 @@ export const getTopNavConfig = (
               dispatch,
               services
             )}
-            objectType={'wizard'}
+            objectType={'visualization'}
             onClose={() => {}}
             originatingApp={originatingApp}
             getAppNameFromId={stateTransfer.getAppNameFromId}
@@ -120,7 +120,7 @@ export const getTopNavConfig = (
                 defaultMessage: 'Finish editing visBuilder and return to the last app',
               }
             ),
-            testId: 'wizardsaveAndReturnButton',
+            testId: 'visBuilderSaveAndReturnButton',
             disableButton: !!saveDisabledReason,
             tooltip: saveDisabledReason,
             run: async () => {
@@ -207,7 +207,7 @@ export const getOnSave = (
           if (newlyCreated && stateTransfer) {
             // create new embeddable to transfer to originatingApp
             stateTransfer.navigateToWithEmbeddablePackage(originatingApp, {
-              state: { type: 'wizard', input: { savedObjectId: id } },
+              state: { type: 'visBuilder', input: { savedObjectId: id } },
             });
             return { id };
           } else {
diff --git a/src/plugins/vis_builder/public/application/utils/use/use_saved_vis_builder_vis.ts b/src/plugins/vis_builder/public/application/utils/use/use_saved_vis_builder_vis.ts
@@ -91,7 +91,7 @@ export const useSavedVisBuilderVis = (visualizationIdFromUrl: string | undefined
         const managementRedirectTarget = {
           [PLUGIN_ID]: {
             app: 'management',
-            path: `opensearch-dashboards/objects/savedWizard/${visualizationIdFromUrl}`,
+            path: `opensearch-dashboards/objects/savedVisBuilder/${visualizationIdFromUrl}`,
           },
         };
 
diff --git a/src/plugins/vis_builder/public/assets/vis_builder_icon.svg b/src/plugins/vis_builder/public/assets/vis_builder_icon.svg
diff --git a/src/plugins/vis_builder/public/assets/vis_builder_icon_secondary_fill.svg b/src/plugins/vis_builder/public/assets/vis_builder_icon_secondary_fill.svg
diff --git a/src/plugins/vis_builder/public/embeddable/vis_builder_embeddable.tsx b/src/plugins/vis_builder/public/embeddable/vis_builder_embeddable.tsx
@@ -178,7 +178,7 @@ export class VisBuilderEmbeddable extends Embeddable<SavedObjectEmbeddableInput,
     this.timeRange = cloneDeep(this.input.timeRange);
 
     const div = document.createElement('div');
-    div.className = `wizard visualize panel-content panel-content--fullWidth`;
+    div.className = `visBuilder visualize panel-content panel-content--fullWidth`;
     node.appendChild(div);
 
     this.node = div;
@@ -196,7 +196,7 @@ export class VisBuilderEmbeddable extends Embeddable<SavedObjectEmbeddableInput,
       div.setAttribute('data-description', this.savedVisBuilder.description);
     }
 
-    div.setAttribute('data-test-subj', 'wizardLoader');
+    div.setAttribute('data-test-subj', 'visBuilderLoader');
 
     this.subscriptions.push(this.handler.loading$.subscribe(this.onContainerLoading));
     this.subscriptions.push(this.handler.render$.subscribe(this.onContainerRender));
diff --git a/src/plugins/vis_builder/public/embeddable/vis_builder_embeddable_factory.tsx b/src/plugins/vis_builder/public/embeddable/vis_builder_embeddable_factory.tsx
@@ -26,7 +26,7 @@ import {
   VisBuilderOutput,
   VISBUILDER_EMBEDDABLE,
 } from './vis_builder_embeddable';
-import visBuilderIcon from '../assets/wizard_icon.svg';
+import visBuilderIcon from '../assets/vis_builder_icon.svg';
 import {
   getHttp,
   getSavedVisBuilderLoader,
diff --git a/src/plugins/vis_builder/public/plugin.ts b/src/plugins/vis_builder/public/plugin.ts
@@ -20,8 +20,8 @@ import {
   VisBuilderStart,
 } from './types';
 import { VisBuilderEmbeddableFactoryDefinition, VISBUILDER_EMBEDDABLE } from './embeddable';
-import visBuilderIconSecondaryFill from './assets/wizard_icon_secondary_fill.svg';
-import visBuilderIcon from './assets/wizard_icon.svg';
+import visBuilderIconSecondaryFill from './assets/vis_builder_icon_secondary_fill.svg';
+import visBuilderIcon from './assets/vis_builder_icon.svg';
 import { EDIT_PATH, PLUGIN_ID, PLUGIN_NAME, VISBUILDER_SAVED_OBJECT } from '../common';
 import { TypeService } from './services/type_service';
 import { getPreloadedStore } from './application/utils/state_management';
diff --git a/src/plugins/vis_builder/server/capabilities_provider.ts b/src/plugins/vis_builder/server/capabilities_provider.ts
@@ -4,7 +4,7 @@
  */
 
 export const capabilitiesProvider = () => ({
-  wizard: {
+  visBuilder: {
     // TODO: investigate which capabilities we need to provide
     // createNew: true,
     // createShortUrl: true,
diff --git a/src/plugins/vis_builder/server/plugin.ts b/src/plugins/vis_builder/server/plugin.ts
@@ -23,7 +23,7 @@ export class VisBuilderPlugin implements Plugin<VisBuilderPluginSetup, VisBuilde
   }
 
   public setup({ capabilities, http, savedObjects }: CoreSetup) {
-    this.logger.debug('wizard: Setup');
+    this.logger.debug('visBuilder: Setup');
 
     // Register saved object types
     savedObjects.registerType(visBuilderSavedObjectType);
@@ -35,9 +35,9 @@ export class VisBuilderPlugin implements Plugin<VisBuilderPluginSetup, VisBuilde
   }
 
   public start(_core: CoreStart) {
-    this.logger.debug('wizard: Started');
+    this.logger.debug('visBuilder: Started');
     return {};
   }
 
-  public stop() {}
+  public stop() { }
 }
diff --git a/src/plugins/vis_builder/server/saved_objects/vis_builder_app.ts b/src/plugins/vis_builder/server/saved_objects/vis_builder_app.ts
@@ -22,11 +22,11 @@ export const visBuilderSavedObjectType: SavedObjectsType = {
     importableAndExportable: true,
     getTitle: ({ attributes: { title } }: SavedObject<VisBuilderSavedObjectAttributes>) => title,
     getEditUrl: ({ id }: SavedObject) =>
-      `/management/opensearch-dashboards/objects/savedWizard/${encodeURIComponent(id)}`,
+      `/management/opensearch-dashboards/objects/savedVisBuilder/${encodeURIComponent(id)}`,
     getInAppUrl({ id }: SavedObject) {
       return {
         path: `/app/${PLUGIN_ID}${EDIT_PATH}/${encodeURIComponent(id)}`,
-        uiCapabilitiesPath: 'wizard.show',
+        uiCapabilitiesPath: 'visBuilder.show',
       };
     },
   },
diff --git a/src/plugins/vis_builder/server/saved_objects/vis_builder_migration.test.ts b/src/plugins/vis_builder/server/saved_objects/vis_builder_migration.test.ts
@@ -17,19 +17,19 @@ describe('2.3.0', () => {
 
   it('should return original doc if visualizationState is not found', () => {
     const migratedDoc = migrate({
-      type: 'wizard',
+      type: 'visBuilder',
       attributes: {},
     });
 
     expect(migratedDoc).toEqual({
-      type: 'wizard',
+      type: 'visBuilder',
       attributes: {},
     });
   });
 
   it('should return original doc if indexPattern is not found within visualizationState', () => {
     const migratedDoc = migrate({
-      type: 'wizard',
+      type: 'visBuilder',
       attributes: {
         visualizationState: {
           searchSource: '',
@@ -39,7 +39,7 @@ describe('2.3.0', () => {
     });
 
     expect(migratedDoc).toEqual({
-      type: 'wizard',
+      type: 'visBuilder',
       attributes: {
         visualizationState: {
           searchSource: '',
@@ -51,15 +51,15 @@ describe('2.3.0', () => {
 
   it('should return original doc if references is not an array', () => {
     const migratedDoc = migrate({
-      type: 'wizard',
+      type: 'visBuilder',
       attributes: {
         visualizationState: {},
       },
       references: {},
     });
 
     expect(migratedDoc).toEqual({
-      type: 'wizard',
+      type: 'visBuilder',
       attributes: {
         visualizationState: {},
       },
@@ -69,7 +69,7 @@ describe('2.3.0', () => {
 
   it('should migrate the old version visBuilder saved object to new version VisBuilder saved object', () => {
     const migratedDoc = migrate({
-      type: 'wizard',
+      type: 'visBuilder',
       attributes: {
         visualizationState: JSON.stringify({
           searchFields: {},
@@ -82,7 +82,7 @@ describe('2.3.0', () => {
     });
 
     expect(migratedDoc).toEqual({
-      type: 'wizard',
+      type: 'visBuilder',
       attributes: {
         visualizationState: JSON.stringify({
           searchFields: {},
diff --git a/src/plugins/vis_builder/server/saved_objects/vis_builder_migration.ts b/src/plugins/vis_builder/server/saved_objects/vis_builder_migration.ts
@@ -46,6 +46,8 @@ const migrateIndexPattern: SavedObjectMigrationFn<any, any> = (doc) => {
   }
 };
 
+// TODO: add migration to change the saved object type from wizard to visBuilder
+
 export const visBuilderSavedObjectTypeMigrations = {
   '2.3.0': flow(migrateIndexPattern),
 };
diff --git a/test/common/config.js b/test/common/config.js
@@ -78,7 +78,7 @@ export default function () {
         `--opensearchDashboards.branding.mark.defaultUrl=https://opensearch.org/assets/brand/SVG/Mark/opensearch_mark_default.svg`,
         `--opensearchDashboards.branding.mark.darkModeUrl=https://opensearch.org/assets/brand/SVG/Mark/opensearch_mark_darkmode.svg`,
         `--opensearchDashboards.branding.applicationTitle=OpenSearch`,
-        `--wizard.enabled=true`,
+        `--visBuilder.enabled=true`,
       ],
     },
     services,

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`"server": true,`
`5`	`5`	`"ui": true,`
`6`	`6`	`"requiredPlugins": ["management", "data"],`
`7`		`- "optionalPlugins": ["dashboard", "visualizations", "discover", "home", "wizard"],`
	`7`	`+ "optionalPlugins": ["dashboard", "visualizations", "discover", "home", "visBuilder"],`
`8`	`8`	`"extraPublicDirs": ["public/lib"],`
`9`	`9`	`"requiredBundles": ["opensearchDashboardsReact", "home"]`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`		`- "id": "wizard",`
	`2`	`+ "id": "visBuilder",`
	`3`	`+ "configPath": "visBuilder",`
`3`	`4`	`"version": "1.0.0",`
`4`	`5`	`"opensearchDashboardsVersion": "opensearchDashboards",`
`5`	`6`	`"server": true,`