Move maxSuggestionCount to UI prop

BoostV · Nov 8, 2023 · 98a0d4c · 98a0d4c
1 parent d578824
commit 98a0d4c
Show file tree

Hide file tree

Showing 7 changed files with 60 additions and 11 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/core/src/context/experiment/experiment-reducers.ts b/packages/core/src/context/experiment/experiment-reducers.ts
@@ -140,7 +140,10 @@ export type ExperimentAction =
     }
   | {
       type: 'updateSuggestionCount'
-      payload: string
+      payload: {
+        suggestionCount: string
+        maxSuggestionCount?: number
+      }
     }
   | {
       type: 'copySuggestedToDataPoints'
@@ -183,8 +186,13 @@ export const experimentReducer = produce(
           experimentSchema.shape.info.shape.description.parse(action.payload)
         break
       case 'updateSuggestionCount': {
-        const payloadVal = Number(action.payload)
-        const actualVal = payloadVal <= 10 ? payloadVal : 10
+        const payloadVal = Number(action.payload.suggestionCount)
+        const maxSuggestionCount = action.payload.maxSuggestionCount
+        let actualVal = payloadVal
+        if (maxSuggestionCount !== undefined) {
+          actualVal =
+            payloadVal <= maxSuggestionCount ? payloadVal : maxSuggestionCount
+        }
         state.extras.experimentSuggestionCount = actualVal >= 1 ? actualVal : 1
         break
       }

diff --git a/packages/core/src/context/experiment/reducers.test.ts b/packages/core/src/context/experiment/reducers.test.ts
@@ -197,16 +197,36 @@ describe('experiment reducer', () => {
   })
 
   describe('updateSuggestionCount', () => {
-    it('should change suggestion count (min 1, max 10)', () => {
+    it('should cap suggestion count to max', () => {
       const actual = rootReducer(initState, {
         type: 'updateSuggestionCount',
-        payload: '42',
+        payload: { suggestionCount: '42', maxSuggestionCount: 10 },
       })
       expect(actual.experiment.extras).toMatchObject({
         experimentSuggestionCount: 10,
       })
       expect(actual.experiment.changedSinceLastEvaluation).toBeTruthy()
     })
+    it('should not cap suggestion count to max when unset', () => {
+      const actual = rootReducer(initState, {
+        type: 'updateSuggestionCount',
+        payload: { suggestionCount: '42' },
+      })
+      expect(actual.experiment.extras).toMatchObject({
+        experimentSuggestionCount: 42,
+      })
+      expect(actual.experiment.changedSinceLastEvaluation).toBeTruthy()
+    })
+    it('should set suggestion count to min 1', () => {
+      const actual = rootReducer(initState, {
+        type: 'updateSuggestionCount',
+        payload: { suggestionCount: '0' },
+      })
+      expect(actual.experiment.extras).toMatchObject({
+        experimentSuggestionCount: 1,
+      })
+      expect(actual.experiment.changedSinceLastEvaluation).toBeTruthy()
+    })
   })
 
   describe('Constraints', () => {

diff --git a/packages/core/src/context/experiment/test-utils.ts b/packages/core/src/context/experiment/test-utils.ts
@@ -124,7 +124,9 @@ export const dummyPayloads: Payloads = {
   updateExperimentDescription: '',
   updateConfiguration: initialState.experiment.optimizerConfig,
   updateDataPoints: initialState.experiment.dataPoints,
-  updateSuggestionCount: '',
+  updateSuggestionCount: {
+    suggestionCount: '',
+  },
   copySuggestedToDataPoints: [],
   'experiment/toggleMultiObjective': undefined,
   'experiment/setConstraintSum': 0,

diff --git a/packages/ui/package.json b/packages/ui/package.json
@@ -37,7 +37,7 @@
   "dependencies": {
     "@boostv/process-optimizer-frontend-core": "*",
     "@boostv/process-optimizer-frontend-plots": "*",
-    "lodash": "^4.17.21",
+    "lodash.debounce": "^4.0.8",
     "react-hook-form": "^7.33.0",
     "remeda": "^1.12.0",
     "tss-react": "^4.8.2"

diff --git a/packages/ui/src/containers/result-data/experimentation-guide.tsx b/packages/ui/src/containers/result-data/experimentation-guide.tsx
@@ -39,6 +39,7 @@ interface ResultDataProps {
   warning?: string
   padding?: number
   allowIndividualSuggestionCopy?: boolean
+  maxSuggestionCount?: number
   toggleUISize?: () => void
   onMouseEnterExpand?: () => void
   onMouseLeaveExpand?: () => void
@@ -54,6 +55,7 @@ export const ExperimentationGuide = (props: ResultDataProps) => {
     padding,
     loadingMode,
     allowIndividualSuggestionCopy = true,
+    maxSuggestionCount,
     toggleUISize,
     onMouseEnterExpand,
     onMouseLeaveExpand,
@@ -181,6 +183,7 @@ export const ExperimentationGuide = (props: ResultDataProps) => {
         {!isInitializing && (
           <Box width={160}>
             <NextExperiments
+              maxSuggestionCount={maxSuggestionCount}
               onSuggestionChange={suggestionCount =>
                 debouncedUpdate(suggestionCount)
               }

diff --git a/packages/ui/src/features/result-data/next-experiments.tsx b/packages/ui/src/features/result-data/next-experiments.tsx
@@ -7,10 +7,14 @@ import {
 } from '@boostv/process-optimizer-frontend-core'
 
 type Props = {
+  maxSuggestionCount?: number
   onSuggestionChange: (suggestionCount: string) => void
 }
 
-export const NextExperiments: FC<Props> = ({ onSuggestionChange }) => {
+export const NextExperiments: FC<Props> = ({
+  onSuggestionChange,
+  maxSuggestionCount,
+}) => {
   const isSuggestionCountEditable = useSelector(selectIsSuggestionCountEditable)
   const suggestionCount = useSelector(selectCalculatedSuggestionCount)
   const [suggestionCountUI, setSuggestionCountUI] = useState(suggestionCount)
@@ -32,7 +36,9 @@ export const NextExperiments: FC<Props> = ({ onSuggestionChange }) => {
         type="number"
         value={suggestionCountUI + ''}
         name="numberOfSuggestions"
-        label="Suggestions (1-10)"
+        label={`Suggestions${
+          maxSuggestionCount !== undefined ? ` (1-${maxSuggestionCount})` : ''
+        }`}
         size="small"
         onChange={val => {
           setSuggestionCountUI(Number(val.target.value))