Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

fix(settings): fix AI setting display and adopt UpdateMask pattern (#19696)

h3n4l070692139c5b
diff --git a/backend/api/v1/setting_service.go b/backend/api/v1/setting_service.go
index 4b38f4d423..0c0b292a98 100644
--- a/backend/api/v1/setting_service.go
+++ b/backend/api/v1/setting_service.go
@@ -507,26 +507,44 @@ func (s *SettingService) UpdateSetting(ctx context.Context, request *connect.Req
}
storeSettingValue = storeSemanticTypeSetting
case storepb.SettingName_AI:
- aiSetting := convertAISetting(request.Msg.Setting.Value.GetAi())
- if aiSetting.Enabled {
- if aiSetting.Endpoint == "" || aiSetting.Model == "" {
- return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("API endpoint and model are required"))
+ if request.Msg.UpdateMask == nil {
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("update mask is required"))
+ }
+ payload := convertAISetting(request.Msg.Setting.Value.GetAi())
+ oldAISetting, err := s.store.GetAISetting(ctx, workspaceID)
+ if err != nil {
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to find AI setting: %v", err))
+ }
+ // Clone to avoid mutating the cached store object if validation fails later.
+ oldAISetting = proto.CloneOf(oldAISetting)
+
+ for _, path := range request.Msg.UpdateMask.Paths {
+ switch path {
+ case "value.ai.enabled":
+ oldAISetting.Enabled = payload.Enabled
+ case "value.ai.provider":
+ oldAISetting.Provider = storepb.AISetting_Provider(payload.Provider)
+ case "value.ai.endpoint":
+ oldAISetting.Endpoint = payload.Endpoint
+ case "value.ai.api_key":
+ oldAISetting.ApiKey = payload.ApiKey
+ case "value.ai.model":
+ oldAISetting.Model = payload.Model
+ default:
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("invalid update mask path %v", path))
}
- if existedSetting != nil {
- existedAISetting, err := convertToSettingMessage(existedSetting)
- if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to unmarshal existed ai setting with error: %v", err))
- }
- if aiSetting.ApiKey == "" {
- aiSetting.ApiKey = existedAISetting.Value.GetAi().GetApiKey()
- }
+ }
+
+ if oldAISetting.Enabled {
+ if oldAISetting.Endpoint == "" || oldAISetting.Model == "" {
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("API endpoint and model are required"))
}
- if aiSetting.ApiKey == "" {
+ if oldAISetting.ApiKey == "" {
return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("API key is required"))
}
}
- storeSettingValue = aiSetting
+ storeSettingValue = oldAISetting
case storepb.SettingName_ENVIRONMENT:
if serr := s.validateEnvironments(ctx, workspaceID, request.Msg.Setting.Value.GetEnvironment().GetEnvironments()); serr != nil {
return nil, serr
diff --git a/frontend/src/components/GeneralSetting/AIAugmentationSetting.vue b/frontend/src/components/GeneralSetting/AIAugmentationSetting.vue
index c9ccc692a9..0173244cc0 100644
--- a/frontend/src/components/GeneralSetting/AIAugmentationSetting.vue
+++ b/frontend/src/components/GeneralSetting/AIAugmentationSetting.vue
@@ -66,10 +66,11 @@
>
<NSelect
style="width: 12rem"
- v-model:value="state.provider"
+ :value="state.provider"
:options="providerOptions"
:disabled="slotProps.disabled"
:consistent-menu-width="true"
+ @update:value="onProviderChange"
/>
</PermissionGuardWrapper>
</div>
@@ -176,9 +177,10 @@
<script lang="ts" setup>
import { create } from "@bufbuild/protobuf";
+import { FieldMaskSchema } from "@bufbuild/protobuf/wkt";
import { NCollapseTransition, NSelect } from "naive-ui";
import scrollIntoView from "scroll-into-view-if-needed";
-import { computed, onMounted, reactive, ref, watch, watchEffect } from "vue";
+import { computed, onMounted, reactive, ref, watchEffect } from "vue";
import { useI18n } from "vue-i18n";
import { BBAttention, BBTextField } from "@/bbkit";
import LearnMoreLink from "@/components/LearnMoreLink.vue";
@@ -277,15 +279,12 @@ watchEffect(async () => {
const allowSave = computed((): boolean => {
const initValue = getInitialState();
- const enabledUpdated = state.enabled !== initValue.enabled;
- const openAIKeyUpdated = !!state.apiKey;
- const openAIEndpointUpdated = state.endpoint !== initValue.endpoint;
- const openAIModelUpdated = state.model !== initValue.model;
return (
- enabledUpdated ||
- openAIKeyUpdated ||
- openAIEndpointUpdated ||
- openAIModelUpdated
+ state.enabled !== initValue.enabled ||
+ state.provider !== initValue.provider ||
+ !!state.apiKey ||
+ state.endpoint !== initValue.endpoint ||
+ state.model !== initValue.model
);
});
@@ -330,12 +329,10 @@ const providerDefault = computed(() => {
}
});
-watch(
- () => state.provider,
- () => {
- Object.assign(state, providerDefault.value);
- }
-);
+const onProviderChange = (provider: AISetting_Provider) => {
+ state.provider = provider;
+ Object.assign(state, providerDefault.value);
+};
const toggleAIEnabled = (on: boolean) => {
if (!on) {
@@ -348,6 +345,17 @@ const toggleAIEnabled = (on: boolean) => {
};
const updateAISetting = async () => {
+ const initValue = getInitialState();
+ const paths: string[] = [];
+ if (state.enabled !== initValue.enabled) paths.push("value.ai.enabled");
+ if (state.provider !== initValue.provider) paths.push("value.ai.provider");
+ if (state.endpoint !== initValue.endpoint) paths.push("value.ai.endpoint");
+ if (state.model !== initValue.model) paths.push("value.ai.model");
+ // Include api_key when user entered a new key, or when provider changed
+ // (switching providers invalidates the old key, forcing user to provide a new one).
+ if (state.apiKey || state.provider !== initValue.provider)
+ paths.push("value.ai.api_key");
+
await settingV1Store.upsertSetting({
name: Setting_SettingName.AI,
value: create(SettingSettingValueSchema, {
@@ -363,6 +371,7 @@ const updateAISetting = async () => {
}),
},
}),
+ updateMask: create(FieldMaskSchema, { paths }),
});
Object.assign(state, getInitialState());