Improving types, extracting another function

Author: kertal

src/legacy/ui/public/saved_objects/helpers/build_saved_object.ts

@@ -23,7 +23,13 @@ import { hydrateIndexPattern } from 'ui/saved_objects/helpers/hydrate_index_patt
 import { intializeSavedObject } from 'ui/saved_objects/helpers/initialize_saved_object';
 import { serializeSavedObject } from 'ui/saved_objects/helpers/serialize_saved_object';
 import { SavedObjectsClient } from 'kibana/public';
-import { EsResponse, SavedObject, SavedObjectConfig } from 'ui/saved_objects/types';
+import {
+  ConfirmModalPromise,
+  EsResponse,
+  SavedObject,
+  SavedObjectConfig,
+  SaveOptions,
+} from 'ui/saved_objects/types';
 import { applyEsResp } from 'ui/saved_objects/helpers/apply_es_resp';
 import { saveSavedObject } from 'ui/saved_objects/helpers/save_saved_object';
 import { IndexPatterns } from '../../../../core_plugins/data/public';
@@ -33,7 +39,7 @@ export function buildSavedObject(
   config: SavedObjectConfig = {},
   indexPatterns: IndexPatterns,
   savedObjectsClient: SavedObjectsClient,
-  confirmModalPromise: Promise<unknown>,
+  confirmModalPromise: ConfirmModalPromise,
   AngularPromise: PromiseService
 ) {
   // type name for this object, used as the ES-type
@@ -69,7 +75,7 @@ export function buildSavedObject(
    * @return {Promise<IndexPattern | null>}
    */
   savedObject.hydrateIndexPattern = (id?: string) =>
-    hydrateIndexPattern(id || '', savedObject, indexPatterns, config, Promise);
+    hydrateIndexPattern(id || '', savedObject, indexPatterns, config);
   /**
    * Asynchronously initialize this object - will only run
    * once even if called multiple times.
@@ -78,7 +84,7 @@ export function buildSavedObject(
    * @resolved {SavedObject}
    */
   savedObject.init = _.once(() =>
-    intializeSavedObject(savedObject, savedObjectsClient, config, Promise)
+    AngularPromise.resolve(intializeSavedObject(savedObject, savedObjectsClient, config))
   );
 
   savedObject.applyESResp = (resp: EsResponse) =>
@@ -94,31 +100,41 @@ export function buildSavedObject(
    * Returns true if the object's original title has been changed. New objects return false.
    * @return {boolean}
    */
-  savedObject.isTitleChanged = () => {
-    return savedObject._source && savedObject._source.title !== savedObject.title;
-  };
+  savedObject.isTitleChanged = () =>
+    savedObject._source && savedObject._source.title !== savedObject.title;
 
   savedObject.creationOpts = (opts: Record<string, any> = {}) => ({
     id: savedObject.id,
     migrationVersion: savedObject.migrationVersion,
     ...opts,
   });
 
-  savedObject.save = (opts: any) => {
-    return saveSavedObject(savedObject, savedObjectsClient, config, confirmModalPromise, Promise, {
-      ...opts,
-    });
+  savedObject.save = async (opts: SaveOptions) => {
+    try {
+      const result = await saveSavedObject(
+        savedObject,
+        savedObjectsClient,
+        config,
+        opts,
+        confirmModalPromise
+      );
+      return AngularPromise.resolve(result);
+    } catch (e) {
+      return AngularPromise.reject(e);
+    }
   };
 
   savedObject.destroy = () => {};
 
+  savedObject.getFullPath = () => config.path + '/' + config.id;
+
   /**
    * Delete this object from Elasticsearch
    * @return {promise}
    */
   savedObject.delete = () => {
     if (!savedObject.id) {
-      return Promise.reject(new Error('Deleting a saved Object requires type and id'));
+      return AngularPromise.reject(new Error('Deleting a saved Object requires type and id'));
     }
     return savedObjectsClient.delete(esType, savedObject.id);
   };

src/legacy/ui/public/saved_objects/helpers/check_for_duplicate_title.ts

@@ -0,0 +1,58 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { ConfirmModalPromise, SavedObject } from 'ui/saved_objects/types';
+import { SavedObjectsClient, SimpleSavedObject } from 'kibana/public';
+import { findObjectByTitle } from 'ui/saved_objects';
+import { SAVE_DUPLICATE_REJECTED } from 'ui/saved_objects/constants';
+import { displayDuplicateTitleConfirmModal } from 'ui/saved_objects/helpers/display_duplicate_title_confirm_modal';
+
+export const checkForDuplicateTitle = (
+  savedObject: SavedObject,
+  savedObjectsClient: SavedObjectsClient,
+  isTitleDuplicateConfirmed: boolean,
+  onTitleDuplicate: (() => void) | undefined,
+  confirmModalPromise: ConfirmModalPromise
+) => {
+  // Don't check for duplicates if user has already confirmed save with duplicate title
+  if (isTitleDuplicateConfirmed) {
+    return Promise.resolve(true);
+  }
+
+  // Don't check if the user isn't updating the title, otherwise that would become very annoying to have
+  // to confirm the save every time, except when copyOnSave is true, then we do want to check.
+  if (savedObject.title === savedObject.lastSavedTitle && !savedObject.copyOnSave) {
+    return Promise.resolve(true);
+  }
+
+  return findObjectByTitle(savedObjectsClient, savedObject.getEsType(), savedObject.title).then(
+    (duplicate: SimpleSavedObject<any> | void) => {
+      if (!duplicate) return true;
+      if (duplicate.id === savedObject.id) return true;
+
+      if (onTitleDuplicate) {
+        onTitleDuplicate();
+        return Promise.reject(new Error(SAVE_DUPLICATE_REJECTED));
+      }
+
+      // TODO: make onTitleDuplicate a required prop and remove UI components from this class
+      // Need to leave here until all users pass onTitleDuplicate.
+      return displayDuplicateTitleConfirmModal(savedObject, confirmModalPromise);
+    }
+  );
+};

src/legacy/ui/public/saved_objects/helpers/create_source.ts

@@ -18,7 +18,7 @@
  */
 import _ from 'lodash';
 import { i18n } from '@kbn/i18n';
-import { SavedObject } from 'ui/saved_objects/types';
+import { ConfirmModalPromise, SavedObject } from 'ui/saved_objects/types';
 import { SavedObjectAttributes, SavedObjectsClient } from 'kibana/public';
 import { OVERWRITE_REJECTED } from 'ui/saved_objects/constants';
 
@@ -39,8 +39,7 @@ export function createSource(
   savedObject: SavedObject,
   savedObjectsClient: SavedObjectsClient,
   esType: string,
-  AngularPromise: any,
-  confirmModalPromise: any,
+  confirmModalPromise: ConfirmModalPromise,
   options = {}
 ) {
   return savedObjectsClient.create(esType, source, options).catch(err => {

src/legacy/ui/public/saved_objects/helpers/display_duplicate_title_confirm_modal.ts

@@ -18,14 +18,11 @@
  */
 import { i18n } from '@kbn/i18n';
 import { SAVE_DUPLICATE_REJECTED } from 'ui/saved_objects/constants';
-import { SavedObject } from '../types';
+import { ConfirmModalPromise, SavedObject } from '../types';
 
 export function displayDuplicateTitleConfirmModal(
   savedObject: SavedObject,
-  confirmModalPromise: (
-    message: string,
-    options: { confirmButtonText: string }
-  ) => Promise<React.Component>
+  confirmModalPromise: ConfirmModalPromise
 ) {
   const confirmMessage = i18n.translate(
     'common.ui.savedObjects.confirmModal.saveDuplicateConfirmationMessage',

src/legacy/ui/public/saved_objects/helpers/hydrate_index_pattern.ts

@@ -16,7 +16,6 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { PromiseService } from 'ui/promises';
 import { SavedObject, SavedObjectConfig } from 'ui/saved_objects/types';
 import { IIndexPattern } from '../../../../../plugins/data/common/index_patterns';
 import { IndexPatterns } from '../../../../core_plugins/data/public/index_patterns/index_patterns';
@@ -31,25 +30,24 @@ export function hydrateIndexPattern(
   id: string,
   savedObject: SavedObject,
   indexPatterns: IndexPatterns,
-  config: SavedObjectConfig,
-  AngularPromise: PromiseService
+  config: SavedObjectConfig
 ) {
   const clearSavedIndexPattern = !!config.clearSavedIndexPattern;
   const indexPattern = config.indexPattern;
 
   if (!savedObject.searchSource) {
-    return AngularPromise.resolve(null);
+    return Promise.resolve(null);
   }
 
   if (clearSavedIndexPattern) {
     savedObject.searchSource!.setField('index', null);
-    return AngularPromise.resolve(null);
+    return Promise.resolve(null);
   }
 
   let index = id || indexPattern || savedObject.searchSource!.getOwnField('index');
 
   if (!index) {
-    return AngularPromise.resolve(null);
+    return Promise.resolve(null);
   }
 
   // If index is not an IndexPattern object at savedObject point, then it's a string id of an index.
@@ -59,7 +57,7 @@ export function hydrateIndexPattern(
 
   // At savedObject point index will either be an IndexPattern, if cached, or a promise that
   // will return an IndexPattern, if not cached.
-  return AngularPromise.resolve(index).then((ip: IIndexPattern) => {
+  return Promise.resolve(index).then((ip: IIndexPattern) => {
     savedObject.searchSource!.setField('index', ip);
   });
 }

src/legacy/ui/public/saved_objects/helpers/initialize_saved_object.ts

@@ -20,21 +20,22 @@
 import _ from 'lodash';
 import { SavedObject, SavedObjectConfig } from 'ui/saved_objects/types';
 import { SavedObjectsClient } from 'kibana/public';
-import { PromiseService } from 'ui/promises';
 
+/**
+ * Initialize saved object
+ */
 export function intializeSavedObject(
   savedObject: SavedObject,
   savedObjectsClient: SavedObjectsClient,
-  config: SavedObjectConfig,
-  AngularPromise: PromiseService
+  config: SavedObjectConfig
 ) {
   const esType = config.type;
   // ensure that the esType is defined
   if (!esType) throw new Error('You must define a type name to use SavedObject objects.');
   const customInit = config.init || _.noop;
   const afterESResp = config.afterESResp || _.noop;
 
-  return AngularPromise.resolve(true)
+  return Promise.resolve()
     .then(() => {
       // If there is not id, then there is no document to fetch from elasticsearch
       if (!savedObject.id) {

src/legacy/ui/public/saved_objects/helpers/save_saved_object.ts

@@ -16,15 +16,18 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { SavedObject, SavedObjectConfig } from 'ui/saved_objects/types';
+import {
+  ConfirmModalPromise,
+  SavedObject,
+  SavedObjectConfig,
+  SaveOptions,
+} from 'ui/saved_objects/types';
 import { npStart } from 'ui/new_platform';
-import { findObjectByTitle } from 'ui/saved_objects';
-import { displayDuplicateTitleConfirmModal } from 'ui/saved_objects/helpers/display_duplicate_title_confirm_modal';
-import { SavedObjectsClient, SimpleSavedObject } from 'kibana/public';
+import { SavedObjectsClient } from 'kibana/public';
 import { OVERWRITE_REJECTED, SAVE_DUPLICATE_REJECTED } from 'ui/saved_objects/constants';
 
 import { createSource } from 'ui/saved_objects/helpers/create_source';
-import { PromiseService } from 'ui/promises';
+import { checkForDuplicateTitle } from 'ui/saved_objects/helpers/check_for_duplicate_title';
 
 /**
  * @param error {Error} the error
@@ -35,72 +38,33 @@ function isErrorNonFatal(error: { message: string }) {
   return error.message === OVERWRITE_REJECTED || error.message === SAVE_DUPLICATE_REJECTED;
 }
 
-const checkForDuplicateTitle = (
-  savedObject: SavedObject,
-  savedObjectsClient: SavedObjectsClient,
-  isTitleDuplicateConfirmed: boolean,
-  onTitleDuplicate: (() => void) | undefined,
-  Promise: any,
-  confirmModalPromise: any
-) => {
-  // Don't check for duplicates if user has already confirmed save with duplicate title
-  if (isTitleDuplicateConfirmed) {
-    return Promise.resolve();
-  }
-
-  // Don't check if the user isn't updating the title, otherwise that would become very annoying to have
-  // to confirm the save every time, except when copyOnSave is true, then we do want to check.
-  if (savedObject.title === savedObject.lastSavedTitle && !savedObject.copyOnSave) {
-    return Promise.resolve();
-  }
-
-  return findObjectByTitle(savedObjectsClient, savedObject.getEsType(), savedObject.title).then(
-    (duplicate: SimpleSavedObject<any> | void) => {
-      if (!duplicate) return true;
-      if (duplicate.id === savedObject.id) return true;
-
-      if (onTitleDuplicate) {
-        onTitleDuplicate();
-        return Promise.reject(new Error(SAVE_DUPLICATE_REJECTED));
-      }
-
-      // TODO: make onTitleDuplicate a required prop and remove UI components from this class
-      // Need to leave here until all users pass onTitleDuplicate.
-      return displayDuplicateTitleConfirmModal(savedObject, confirmModalPromise);
-    }
-  );
-};
-
-interface SaveOptions {
-  confirmOverwrite?: boolean;
-  isTitleDuplicateConfirmed?: boolean;
-  onTitleDuplicate?: () => void | undefined;
-}
 /**
  * Saves this object.
  *
  * @param {string} [esType]
- * @param {savedObject} [savedObject]
+ * @param {SavedObject} [savedObject]
+ * @param {SavedObjectsClient} [savedObjectsClient]
+ * @param {SavedObjectConfig} [config]
  * @param {object} [options={}]
  * @property {boolean} [options.confirmOverwrite=false] - If true, attempts to create the source so it
  * can confirm an overwrite if a document with the id already exists.
  * @property {boolean} [options.isTitleDuplicateConfirmed=false] - If true, save allowed with duplicate title
  * @property {func} [options.onTitleDuplicate] - function called if duplicate title exists.
  * When not provided, confirm modal will be displayed asking user to confirm or cancel save.
+ * @param {ConfirmModalPromise} [confirmModalPromise]
  * @return {Promise}
  * @resolved {String} - The id of the doc
  */
-export function saveSavedObject(
+export async function saveSavedObject(
   savedObject: SavedObject,
   savedObjectsClient: SavedObjectsClient,
   config: SavedObjectConfig,
-  confirmModalPromise: Promise<any>,
-  AngularPromise: PromiseService,
   {
     confirmOverwrite = false,
     isTitleDuplicateConfirmed = false,
     onTitleDuplicate,
-  }: SaveOptions = {}
+  }: SaveOptions = {},
+  confirmModalPromise: ConfirmModalPromise
 ) {
   const esType = config.type || '';
   const extractReferences = config.extractReferences;
@@ -130,7 +94,6 @@ export function saveSavedObject(
     savedObjectsClient,
     isTitleDuplicateConfirmed,
     onTitleDuplicate,
-    AngularPromise,
     confirmModalPromise
   )
     .then(() => {
@@ -140,7 +103,6 @@ export function saveSavedObject(
           savedObject,
           savedObjectsClient,
           esType,
-          Promise,
           confirmModalPromise,
           savedObject.creationOpts({ references })
         );