fix(ui): handle base model compat when recalling parameters

We had a one-behind issue with recalling metadata items that had a model.

For example, when recalling LoRAs, we check against the current main model to decide whether or not the requested LoRA is compatible and may be recalled.

When recalling all params, we are often also recalling the main model, but the compat logic didn't compare against this new main model.

The logic is updated to check against the new main model, if one is being set.

Closes #5512

Author: psychedelicious

invokeai/frontend/web/src/features/parameters/hooks/useRecallParameters.ts

@@ -47,6 +47,7 @@ import {
   vaeSelected,
   widthChanged,
 } from 'features/parameters/store/generationSlice';
+import type { ParameterModel } from 'features/parameters/types/parameterSchemas';
 import {
   isParameterCFGRescaleMultiplier,
   isParameterCFGScale,
@@ -480,7 +481,7 @@ export const useRecallParameters = () => {
   const { data: loraModels } = useGetLoRAModelsQuery(undefined);
 
   const prepareLoRAMetadataItem = useCallback(
-    (loraMetadataItem: LoRAMetadataItem) => {
+    (loraMetadataItem: LoRAMetadataItem, newModel?: ParameterModel) => {
       if (!isParameterLoRAModel(loraMetadataItem.lora)) {
         return { lora: null, error: 'Invalid LoRA model' };
       }
@@ -499,7 +500,7 @@ export const useRecallParameters = () => {
       }
 
       const isCompatibleBaseModel =
-        matchingLoRA?.base_model === model?.base_model;
+        matchingLoRA?.base_model === (newModel ?? model)?.base_model;
 
       if (!isCompatibleBaseModel) {
         return {
@@ -510,7 +511,7 @@ export const useRecallParameters = () => {
 
       return { lora: matchingLoRA, error: null };
     },
-    [loraModels, model?.base_model]
+    [loraModels, model]
   );
 
   const recallLoRA = useCallback(
@@ -538,7 +539,10 @@ export const useRecallParameters = () => {
   const { data: controlNetModels } = useGetControlNetModelsQuery(undefined);
 
   const prepareControlNetMetadataItem = useCallback(
-    (controlnetMetadataItem: ControlNetMetadataItem) => {
+    (
+      controlnetMetadataItem: ControlNetMetadataItem,
+      newModel?: ParameterModel
+    ) => {
       if (!isParameterControlNetModel(controlnetMetadataItem.control_model)) {
         return { controlnet: null, error: 'Invalid ControlNet model' };
       }
@@ -565,7 +569,7 @@ export const useRecallParameters = () => {
       }
 
       const isCompatibleBaseModel =
-        matchingControlNetModel?.base_model === model?.base_model;
+        matchingControlNetModel?.base_model === (newModel ?? model)?.base_model;
 
       if (!isCompatibleBaseModel) {
         return {
@@ -600,7 +604,7 @@ export const useRecallParameters = () => {
 
       return { controlnet, error: null };
     },
-    [controlNetModels, model?.base_model]
+    [controlNetModels, model]
   );
 
   const recallControlNet = useCallback(
@@ -631,7 +635,10 @@ export const useRecallParameters = () => {
   const { data: t2iAdapterModels } = useGetT2IAdapterModelsQuery(undefined);
 
   const prepareT2IAdapterMetadataItem = useCallback(
-    (t2iAdapterMetadataItem: T2IAdapterMetadataItem) => {
+    (
+      t2iAdapterMetadataItem: T2IAdapterMetadataItem,
+      newModel?: ParameterModel
+    ) => {
       if (
         !isParameterControlNetModel(t2iAdapterMetadataItem.t2i_adapter_model)
       ) {
@@ -659,7 +666,7 @@ export const useRecallParameters = () => {
       }
 
       const isCompatibleBaseModel =
-        matchingT2IAdapterModel?.base_model === model?.base_model;
+        matchingT2IAdapterModel?.base_model === (newModel ?? model)?.base_model;
 
       if (!isCompatibleBaseModel) {
         return {
@@ -690,7 +697,7 @@ export const useRecallParameters = () => {
 
       return { t2iAdapter, error: null };
     },
-    [model?.base_model, t2iAdapterModels]
+    [model, t2iAdapterModels]
   );
 
   const recallT2IAdapter = useCallback(
@@ -721,7 +728,10 @@ export const useRecallParameters = () => {
   const { data: ipAdapterModels } = useGetIPAdapterModelsQuery(undefined);
 
   const prepareIPAdapterMetadataItem = useCallback(
-    (ipAdapterMetadataItem: IPAdapterMetadataItem) => {
+    (
+      ipAdapterMetadataItem: IPAdapterMetadataItem,
+      newModel?: ParameterModel
+    ) => {
       if (!isParameterIPAdapterModel(ipAdapterMetadataItem?.ip_adapter_model)) {
         return { ipAdapter: null, error: 'Invalid IP Adapter model' };
       }
@@ -746,7 +756,7 @@ export const useRecallParameters = () => {
       }
 
       const isCompatibleBaseModel =
-        matchingIPAdapterModel?.base_model === model?.base_model;
+        matchingIPAdapterModel?.base_model === (newModel ?? model)?.base_model;
 
       if (!isCompatibleBaseModel) {
         return {
@@ -768,7 +778,7 @@ export const useRecallParameters = () => {
 
       return { ipAdapter, error: null };
     },
-    [ipAdapterModels, model?.base_model]
+    [ipAdapterModels, model]
   );
 
   const recallIPAdapter = useCallback(
@@ -840,6 +850,13 @@ export const useRecallParameters = () => {
         t2iAdapters,
       } = metadata;
 
+      let newModel: ParameterModel | undefined = undefined;
+
+      if (isParameterModel(model)) {
+        newModel = model;
+        dispatch(modelSelected(model));
+      }
+
       if (isParameterCFGScale(cfg_scale)) {
         dispatch(setCfgScale(cfg_scale));
       }
@@ -848,10 +865,6 @@ export const useRecallParameters = () => {
         dispatch(setCfgRescaleMultiplier(cfg_rescale_multiplier));
       }
 
-      if (isParameterModel(model)) {
-        dispatch(modelSelected(model));
-      }
-
       if (isParameterPositivePrompt(positive_prompt)) {
         dispatch(setPositivePrompt(positive_prompt));
       }
@@ -953,29 +966,29 @@ export const useRecallParameters = () => {
 
       dispatch(lorasCleared());
       loras?.forEach((lora) => {
-        const result = prepareLoRAMetadataItem(lora);
+        const result = prepareLoRAMetadataItem(lora, newModel);
         if (result.lora) {
           dispatch(loraRecalled({ ...result.lora, weight: lora.weight }));
         }
       });
 
       dispatch(controlAdaptersReset());
       controlnets?.forEach((controlnet) => {
-        const result = prepareControlNetMetadataItem(controlnet);
+        const result = prepareControlNetMetadataItem(controlnet, newModel);
         if (result.controlnet) {
           dispatch(controlAdapterRecalled(result.controlnet));
         }
       });
 
       ipAdapters?.forEach((ipAdapter) => {
-        const result = prepareIPAdapterMetadataItem(ipAdapter);
+        const result = prepareIPAdapterMetadataItem(ipAdapter, newModel);
         if (result.ipAdapter) {
           dispatch(controlAdapterRecalled(result.ipAdapter));
         }
       });
 
       t2iAdapters?.forEach((t2iAdapter) => {
-        const result = prepareT2IAdapterMetadataItem(t2iAdapter);
+        const result = prepareT2IAdapterMetadataItem(t2iAdapter, newModel);
         if (result.t2iAdapter) {
           dispatch(controlAdapterRecalled(result.t2iAdapter));
         }