apunkt/SurfSense
1
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2026-07-14 22:52:15 +02:00
Code Issues Projects Releases Packages Wiki Activity

Fix: Ensure full Slack connector configuration is saved

Browse source 
I've modified `useConnectorEditPage.ts` to correctly save all Slack connector settings.

- I updated `editConnectorSchema` in `types.ts` to include a `config` field in `EditConnectorFormValues`.
- I replaced the `handleSaveChanges` function in `useConnectorEditPage.ts` with a version that reads the complete Slack configuration from `formData.config` (populated by `EditSlackConnectorConfigForm` and channel selection).
- This ensures that settings like `slack_selected_channel_ids`, `slack_membership_filter_type`, and other Slack-specific options are included in the payload to the backend and persisted correctly.
- I updated post-save logic to correctly reset the form's `config` field for Slack connectors.

This addresses the issue where changes to Slack connector configurations, other than just the bot token, were not being saved.
This commit is contained in:
google-labs-jules[bot] 2025-05-29 06:37:35 +00:00
parent 9fc5f6589b
commit 95b3d97800
2 changed files with 153 additions and 73 deletions
Download patch file Download diff file Expand all files Collapse all files

1
surfsense_web/components/editConnector/types.ts
View file

@ -31,5 +31,6 @@ export const editConnectorSchema = z.object({
TAVILY_API_KEY: z.string().optional(), TAVILY_API_KEY: z.string().optional(),
LINEAR_API_KEY: z.string().optional(), LINEAR_API_KEY: z.string().optional(),
LINKUP_API_KEY: z.string().optional(), LINKUP_API_KEY: z.string().optional(),
config: z.record(z.string(), z.any()).optional(), // Added for generic config object
}); });
export type EditConnectorFormValues = z.infer<typeof editConnectorSchema>; export type EditConnectorFormValues = z.infer<typeof editConnectorSchema>;

225
surfsense_web/hooks/useConnectorEditPage.ts
View file

@ -113,11 +113,24 @@ export function useConnectorEditPage(connectorId: number, searchSpaceId: string)
}, []); }, []);
const handleSaveChanges = useCallback(async (formData: EditConnectorFormValues) => { const handleSaveChanges = useCallback(async (formData: EditConnectorFormValues) => {
if (!connector || !originalConfig) return; if (!connector) {
toast.error("Connector data not loaded.");
setIsSaving(false);
return;
}
// Ensure originalConfig is loaded, if not, it's an issue.
if (!originalConfig && connector.connector_type !== 'GITHUB_CONNECTOR') {
// For GitHub, originalConfig might be less critical if PAT is the only config and handled by originalPat
// but for others like Slack, it's needed for comparison.
toast.error("Original configuration not available. Cannot determine changes.");
setIsSaving(false);
return;
}
setIsSaving(true); setIsSaving(true);
const updatePayload: Partial<SearchSourceConnector> = {}; const updatePayload: Partial<SearchSourceConnector> = {};
let configChanged = false; let configChanged = false;
let newConfig: Record<string, any> | null = null; let newConfigForPayload: Record<string, any> | null = null;
if (formData.name !== connector.name) { if (formData.name !== connector.name) {
updatePayload.name = formData.name; updatePayload.name = formData.name;
@ -130,108 +143,174 @@ export function useConnectorEditPage(connectorId: number, searchSpaceId: string)
const initialRepoSet = new Set(currentSelectedRepos); const initialRepoSet = new Set(currentSelectedRepos);
const newRepoSet = new Set(newSelectedRepos); const newRepoSet = new Set(newSelectedRepos);
const reposChanged = initialRepoSet.size !== newRepoSet.size || ![...initialRepoSet].every(repo => newRepoSet.has(repo)); const reposChanged = initialRepoSet.size !== newRepoSet.size || ![...initialRepoSet].every(repo => newRepoSet.has(repo));
if (patChanged || (editMode === 'editing_repos' && reposChanged && fetchedRepos !== null)) { if (patChanged || (editMode === 'editing_repos' && reposChanged && fetchedRepos !== null)) {
if (!currentPatInForm || !(currentPatInForm.startsWith('ghp_') || currentPatInForm.startsWith('github_pat_'))) { if (!currentPatInForm || !(currentPatInForm.startsWith('ghp_') || currentPatInForm.startsWith('github_pat_'))) {
toast.error("Invalid GitHub PAT format. Cannot save."); setIsSaving(false); return; toast.error("Invalid GitHub PAT format. Cannot save.");
setIsSaving(false);
return;
}
newConfigForPayload = { GITHUB_PAT: currentPatInForm, repo_full_names: newSelectedRepos };
if (reposChanged && newSelectedRepos.length === 0) {
toast.warning("Warning: No repositories selected.");
} }
newConfig = { GITHUB_PAT: currentPatInForm, repo_full_names: newSelectedRepos };
if (reposChanged && newSelectedRepos.length === 0) { toast.warning("Warning: No repositories selected."); }
} }
break; break;
case 'SLACK_CONNECTOR': case 'SLACK_CONNECTOR':
if (formData.SLACK_BOT_TOKEN !== originalConfig.SLACK_BOT_TOKEN) { const formDefinedSlackConfig = formData.config; // This now comes from editConnectorSchema
if (!formData.SLACK_BOT_TOKEN) { toast.error("Slack Token empty."); setIsSaving(false); return; } // originalConfig should represent the whole config object for the connector
newConfig = { SLACK_BOT_TOKEN: formData.SLACK_BOT_TOKEN }; if (formDefinedSlackConfig && JSON.stringify(formDefinedSlackConfig) !== JSON.stringify(originalConfig)) {
} if (!formDefinedSlackConfig.SLACK_BOT_TOKEN || typeof formDefinedSlackConfig.SLACK_BOT_TOKEN !== 'string' || formDefinedSlackConfig.SLACK_BOT_TOKEN.trim() === '') {
break; toast.error("Slack Bot Token cannot be empty in config.");
case 'NOTION_CONNECTOR': setIsSaving(false);
if (formData.NOTION_INTEGRATION_TOKEN !== originalConfig.NOTION_INTEGRATION_TOKEN) { return;
if (!formData.NOTION_INTEGRATION_TOKEN) { toast.error("Notion Token empty."); setIsSaving(false); return; }
newConfig = { NOTION_INTEGRATION_TOKEN: formData.NOTION_INTEGRATION_TOKEN };
}
break;
case 'SERPER_API':
if (formData.SERPER_API_KEY !== originalConfig.SERPER_API_KEY) {
if (!formData.SERPER_API_KEY) { toast.error("Serper Key empty."); setIsSaving(false); return; }
newConfig = { SERPER_API_KEY: formData.SERPER_API_KEY };
}
break;
case 'TAVILY_API':
if (formData.TAVILY_API_KEY !== originalConfig.TAVILY_API_KEY) {
if (!formData.TAVILY_API_KEY) { toast.error("Tavily Key empty."); setIsSaving(false); return; }
newConfig = { TAVILY_API_KEY: formData.TAVILY_API_KEY };
}
break;
case 'LINEAR_CONNECTOR':
if (formData.LINEAR_API_KEY !== originalConfig.LINEAR_API_KEY) {
if (!formData.LINEAR_API_KEY) {
toast.error("Linear API Key cannot be empty.");
setIsSaving(false);
return;
} }
newConfig = { LINEAR_API_KEY: formData.LINEAR_API_KEY }; newConfigForPayload = { ...formDefinedSlackConfig };
}
break;
case 'NOTION_CONNECTOR':
// Assuming NOTION_INTEGRATION_TOKEN is directly on formData, not in formData.config
// If it were moved to formData.config, this logic would need to mirror Slack's.
if (formData.NOTION_INTEGRATION_TOKEN !== (originalConfig?.NOTION_INTEGRATION_TOKEN || "")) {
if (!formData.NOTION_INTEGRATION_TOKEN || formData.NOTION_INTEGRATION_TOKEN.trim() === '') {
toast.error("Notion Integration Token cannot be empty.");
setIsSaving(false);
return;
}
newConfigForPayload = { NOTION_INTEGRATION_TOKEN: formData.NOTION_INTEGRATION_TOKEN };
}
break;
case 'SERPER_API':
if (formData.SERPER_API_KEY !== (originalConfig?.SERPER_API_KEY || "")) {
if (!formData.SERPER_API_KEY || formData.SERPER_API_KEY.trim() === '') {
toast.error("Serper API Key cannot be empty.");
setIsSaving(false);
return;
}
newConfigForPayload = { SERPER_API_KEY: formData.SERPER_API_KEY };
}
break;
case 'TAVILY_API':
if (formData.TAVILY_API_KEY !== (originalConfig?.TAVILY_API_KEY || "")) {
if (!formData.TAVILY_API_KEY || formData.TAVILY_API_KEY.trim() === '') {
toast.error("Tavily API Key cannot be empty.");
setIsSaving(false);
return;
}
newConfigForPayload = { TAVILY_API_KEY: formData.TAVILY_API_KEY };
}
break;
case 'LINEAR_CONNECTOR':
if (formData.LINEAR_API_KEY !== (originalConfig?.LINEAR_API_KEY || "")) {
if (!formData.LINEAR_API_KEY || formData.LINEAR_API_KEY.trim() === '') {
toast.error("Linear API Key cannot be empty.");
setIsSaving(false);
return;
}
newConfigForPayload = { LINEAR_API_KEY: formData.LINEAR_API_KEY };
} }
break; break;
case 'LINKUP_API': case 'LINKUP_API':
if (formData.LINKUP_API_KEY !== originalConfig.LINKUP_API_KEY) { if (formData.LINKUP_API_KEY !== (originalConfig?.LINKUP_API_KEY || "")) {
if (!formData.LINKUP_API_KEY) { toast.error("Linkup API Key cannot be empty."); setIsSaving(false); return; } if (!formData.LINKUP_API_KEY || formData.LINKUP_API_KEY.trim() === '') {
newConfig = { LINKUP_API_KEY: formData.LINKUP_API_KEY }; toast.error("Linkup API Key cannot be empty.");
setIsSaving(false);
return;
}
newConfigForPayload = { LINKUP_API_KEY: formData.LINKUP_API_KEY };
} }
break; break;
// Add other connector types if their config isn't simply a single token on formData
// and needs to come from formData.config
} }
if (newConfig !== null) { if (newConfigForPayload !== null) {
updatePayload.config = newConfig; updatePayload.config = newConfigForPayload;
configChanged = true; configChanged = true; // Mark that config was changed
} }
if (Object.keys(updatePayload).length === 0) { if (Object.keys(updatePayload).length === 0) {
toast.info("No changes detected."); toast.info("No changes detected.");
setIsSaving(false); setIsSaving(false);
if (connector.connector_type === 'GITHUB_CONNECTOR') { setEditMode('viewing'); patForm.reset({ github_pat: originalPat }); } if (connector.connector_type === 'GITHUB_CONNECTOR') {
setEditMode('viewing');
patForm.reset({ github_pat: originalPat });
}
return; return;
} }
try { try {
await updateConnector(connectorId, updatePayload); await updateConnector(connectorId, updatePayload);
toast.success("Connector updated!"); toast.success("Connector updated successfully!");
const newlySavedConfig = updatePayload.config || originalConfig;
setOriginalConfig(newlySavedConfig); const newActualSavedConfig = updatePayload.config || originalConfig || {};
setOriginalConfig(newActualSavedConfig); // Update originalConfig to the new state
// Update the connector state to reflect changes immediately in UI
setConnector(prev => {
if (!prev) return null;
return {
...prev,
name: updatePayload.name || prev.name,
config: newActualSavedConfig,
};
});
// Reset form values to reflect saved state
// For name
if (updatePayload.name) { if (updatePayload.name) {
setConnector(prev => prev ? { ...prev, name: updatePayload.name!, config: newlySavedConfig } : null); editForm.reset({ ...editForm.getValues(), name: updatePayload.name });
} }
// For config fields, depending on connector type
if (configChanged) { if (configChanged) {
if (connector.connector_type === 'GITHUB_CONNECTOR') { if (connector.connector_type === 'GITHUB_CONNECTOR') {
const savedGitHubConfig = newlySavedConfig as { GITHUB_PAT?: string; repo_full_names?: string[] }; const savedGitHubConfig = newActualSavedConfig as { GITHUB_PAT?: string; repo_full_names?: string[] };
setCurrentSelectedRepos(savedGitHubConfig.repo_full_names || []); setCurrentSelectedRepos(savedGitHubConfig.repo_full_names || []);
setOriginalPat(savedGitHubConfig.GITHUB_PAT || ""); setOriginalPat(savedGitHubConfig.GITHUB_PAT || "");
setNewSelectedRepos(savedGitHubConfig.repo_full_names || []); setNewSelectedRepos(savedGitHubConfig.repo_full_names || []); // Reset selection buffer
patForm.reset({ github_pat: savedGitHubConfig.GITHUB_PAT || "" }); patForm.reset({ github_pat: savedGitHubConfig.GITHUB_PAT || "" });
} else if(connector.connector_type === 'SLACK_CONNECTOR') { setEditMode('viewing');
editForm.setValue('SLACK_BOT_TOKEN', newlySavedConfig.SLACK_BOT_TOKEN || ""); setFetchedRepos(null); // Clear fetched repos list
} else if(connector.connector_type === 'NOTION_CONNECTOR') { } else if (connector.connector_type === 'SLACK_CONNECTOR') {
editForm.setValue('NOTION_INTEGRATION_TOKEN', newlySavedConfig.NOTION_INTEGRATION_TOKEN || ""); // EditSlackConnectorConfigForm relies on `connector.config` prop which is updated by setConnector
} else if(connector.connector_type === 'SERPER_API') { // and also on `editForm.setValue('config', ...)` if direct form manipulation is preferred.
editForm.setValue('SERPER_API_KEY', newlySavedConfig.SERPER_API_KEY || ""); // Let's ensure the form's 'config' field is also explicitly reset.
} else if(connector.connector_type === 'TAVILY_API') { editForm.setValue('config', newActualSavedConfig);
editForm.setValue('TAVILY_API_KEY', newlySavedConfig.TAVILY_API_KEY || ""); } else if (newActualSavedConfig.NOTION_INTEGRATION_TOKEN !== undefined) {
} else if(connector.connector_type === 'LINEAR_CONNECTOR') { editForm.setValue('NOTION_INTEGRATION_TOKEN', newActualSavedConfig.NOTION_INTEGRATION_TOKEN || "");
editForm.setValue('LINEAR_API_KEY', newlySavedConfig.LINEAR_API_KEY || ""); } else if (newActualSavedConfig.SERPER_API_KEY !== undefined) {
} else if(connector.connector_type === 'LINKUP_API') { editForm.setValue('SERPER_API_KEY', newActualSavedConfig.SERPER_API_KEY || "");
editForm.setValue('LINKUP_API_KEY', newlySavedConfig.LINKUP_API_KEY || ""); } else if (newActualSavedConfig.TAVILY_API_KEY !== undefined) {
} editForm.setValue('TAVILY_API_KEY', newActualSavedConfig.TAVILY_API_KEY || "");
} } else if (newActualSavedConfig.LINEAR_API_KEY !== undefined) {
if (connector.connector_type === 'GITHUB_CONNECTOR') { editForm.setValue('LINEAR_API_KEY', newActualSavedConfig.LINEAR_API_KEY || "");
setEditMode('viewing'); } else if (newActualSavedConfig.LINKUP_API_KEY !== undefined) {
setFetchedRepos(null); editForm.setValue('LINKUP_API_KEY', newActualSavedConfig.LINKUP_API_KEY || "");
} }
// Resetting simple form values is handled by useEffect if connector state updates }
} catch (error) { } catch (error) {
console.error("Error updating connector:", error); console.error("Error updating connector:", error);
toast.error(error instanceof Error ? error.message : "Failed to update connector."); toast.error(error instanceof Error ? error.message : "Failed to update connector.");
} finally { setIsSaving(false); } } finally {
}, [connector, originalConfig, updateConnector, connectorId, patForm, originalPat, currentSelectedRepos, newSelectedRepos, editMode, fetchedRepos, editForm]); // Added editForm to dependencies setIsSaving(false);
}
}, [
connector,
originalConfig, // Ensure originalConfig is correctly representing the full config object for comparison
updateConnector,
connectorId,
patForm,
originalPat,
currentSelectedRepos,
newSelectedRepos,
editMode,
fetchedRepos,
editForm, // Added editForm as it's used for setValue now
// router, // router is not used directly in this function
// searchSpaceId // not used directly
]);
// Return values needed by the component // Return values needed by the component
return { return {