Targeted renaming of SearchSettings

elastic · Feb 3, 2021 · 074190a · 074190a
1 parent 716ab23
commit 074190a
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 24 deletions.
diff --git a/...public/applications/app_search/components/relevance_tuning/relevance_tuning_logic.test.ts b/...public/applications/app_search/components/relevance_tuning/relevance_tuning_logic.test.ts
@@ -6,7 +6,7 @@
 
 import { LogicMounter } from '../../../__mocks__';
 
-import { IBoostType } from './types';
+import { BoostType } from './types';
 
 import { RelevanceTuningLogic } from './relevance_tuning_logic';
 
@@ -15,7 +15,7 @@ describe('RelevanceTuningLogic', () => {
     boosts: {
       foo: [
         {
-          type: 'value' as IBoostType,
+          type: 'value' as BoostType,
           factor: 5,
         },
       ],
@@ -24,7 +24,7 @@ describe('RelevanceTuningLogic', () => {
   };
   const schema = {};
   const schemaConflicts = {};
-  const searchSettingProps = {
+  const relevanceTuningProps = {
     searchSettings,
     schema,
     schemaConflicts,
@@ -61,12 +61,12 @@ describe('RelevanceTuningLogic', () => {
   });
 
   describe('actions', () => {
-    describe('onInitializeSearchSettings', () => {
+    describe('onInitializeRelevanceTuning', () => {
       it('should set state', () => {
         mount({
           dataLoading: true,
         });
-        RelevanceTuningLogic.actions.onInitializeSearchSettings(searchSettingProps);
+        RelevanceTuningLogic.actions.onInitializeRelevanceTuning(relevanceTuningProps);
 
         expect(RelevanceTuningLogic.values).toEqual({
           ...DEFAULT_VALUES,

diff --git a/...arch/public/applications/app_search/components/relevance_tuning/relevance_tuning_logic.ts b/...arch/public/applications/app_search/components/relevance_tuning/relevance_tuning_logic.ts
@@ -7,17 +7,18 @@
 import { kea, MakeLogicType } from 'kea';
 
 import { Schema, SchemaConflicts } from '../../../shared/types';
-import { ISearchSettings } from './types';
 
-interface ISearchSettingsProps {
-  searchSettings: ISearchSettings;
+import { SearchSettings } from './types';
+
+interface RelevanceTuningProps {
+  searchSettings: SearchSettings;
   schema: Schema;
   schemaConflicts: SchemaConflicts;
 }
 
-interface ISearchSettingsActions {
-  onInitializeSearchSettings(props: ISearchSettingsProps): ISearchSettingsProps;
-  setSearchSettings(searchSettings: ISearchSettings): { searchSettings: ISearchSettings };
+interface RelevanceTuningActions {
+  onInitializeRelevanceTuning(props: RelevanceTuningProps): RelevanceTuningProps;
+  setSearchSettings(searchSettings: SearchSettings): { searchSettings: SearchSettings };
   setFilterValue(value: string): string;
   setSearchQuery(value: string): string;
   setSearchResults(searchResults: object[]): object[];
@@ -27,8 +28,8 @@ interface ISearchSettingsActions {
   dismissSchemaConflictCallout(): void;
 }
 
-interface ISearchSettingsValues {
-  searchSettings: Partial<ISearchSettings>;
+interface RelevanceTuningValues {
+  searchSettings: Partial<SearchSettings>;
   schema: Schema;
   dataLoading: boolean;
   schemaConflicts: SchemaConflicts;
@@ -51,11 +52,11 @@ const filterIfTerm = (array: string[], filterTerm: string): string[] => {
 };
 
 export const RelevanceTuningLogic = kea<
-  MakeLogicType<ISearchSettingsValues, ISearchSettingsActions>
+  MakeLogicType<RelevanceTuningValues, RelevanceTuningActions>
 >({
   path: ['enterprise_search', 'app_search', 'relevance_tuning_logic'],
   actions: () => ({
-    onInitializeSearchSettings: (props) => props,
+    onInitializeRelevanceTuning: (props) => props,
     setSearchSettings: (searchSettings) => ({ searchSettings }),
     setFilterValue: (value) => value,
     setSearchQuery: (query) => query,
@@ -69,27 +70,27 @@ export const RelevanceTuningLogic = kea<
     searchSettings: [
       {},
       {
-        onInitializeSearchSettings: (_, { searchSettings }) => searchSettings,
+        onInitializeRelevanceTuning: (_, { searchSettings }) => searchSettings,
         setSearchSettings: (_, { searchSettings }) => searchSettings,
       },
     ],
     schema: [
       {},
       {
-        onInitializeSearchSettings: (_, { schema }) => schema,
+        onInitializeRelevanceTuning: (_, { schema }) => schema,
       },
     ],
     dataLoading: [
       true,
       {
-        onInitializeSearchSettings: () => false,
+        onInitializeRelevanceTuning: () => false,
         resetSearchSettingsState: () => true,
       },
     ],
     schemaConflicts: [
       {},
       {
-        onInitializeSearchSettings: (_, { schemaConflicts }) => schemaConflicts,
+        onInitializeRelevanceTuning: (_, { schemaConflicts }) => schemaConflicts,
       },
     ],
     unsavedChanges: [

diff --git a/...ins/enterprise_search/public/applications/app_search/components/relevance_tuning/types.ts b/...ins/enterprise_search/public/applications/app_search/components/relevance_tuning/types.ts
@@ -4,10 +4,10 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-export type IBoostType = 'value' | 'functional' | 'proximity';
+export type BoostType = 'value' | 'functional' | 'proximity';
 
 export interface IBoost {
-  type: IBoostType;
+  type: BoostType;
   operation?: string;
   function?: string;
   newBoost?: boolean;
@@ -16,11 +16,11 @@ export interface IBoost {
   factor: number;
 }
 
-export interface IBoostObject {
+export interface BoostObject {
   [key: string]: IBoost[];
 }
 
-export interface ISearchSettings {
-  boosts: IBoostObject;
+export interface SearchSettings {
+  boosts: BoostObject;
   search_fields: object;
 }