Files
libredesk/internal/ai/knowledgebase.go
T
Abhinav Raut d02b65f2bd address CodeRabbit findings in AI embedding and assistant flows
Fix a reindex race: snippet embedding runs outside the lock, so a slower
job from an older edit could commit stale vectors after a newer edit.
Split Reindex into embed (lock-free) and commit (locked), and gate the
commit with a per-snippet generation counter so only the latest edit
wins. Delete drops the counter so an in-flight job can't re-insert
vectors for a deleted snippet.

Clear the DB avatar reference before deleting the avatar media file. The
old order deleted the file first, so a failed DB update left the DB
pointing at a missing file and a broken image.

Also handle unchecked errors flagged by errcheck (tx.Rollback,
html.Render, fmt.Fprintf), guard capToTokens against a negative limit
that would panic, and stop logging the full import URL since it can
carry credentials.
2026-07-16 12:50:02 +05:30

185 lines
7.0 KiB
Go

package ai
import (
"context"
"crypto/sha256"
"database/sql"
"encoding/hex"
"fmt"
"github.com/abhinavxd/libredesk/internal/ai/models"
"github.com/abhinavxd/libredesk/internal/envelope"
)
// GetKnowledgeBaseItems returns all snippet knowledge base items.
func (m *Manager) GetKnowledgeBaseItems() ([]models.KnowledgeBaseItem, error) {
items := make([]models.KnowledgeBaseItem, 0)
if err := m.q.GetKnowledgeBaseItems.Select(&items); err != nil {
m.lo.Error("error fetching knowledge base items", "error", err)
return nil, envelope.NewError(envelope.GeneralError, m.i18n.T("globals.messages.somethingWentWrong"), nil)
}
return items, nil
}
func (m *Manager) GetKnowledgeBaseItem(id int) (models.KnowledgeBaseItem, error) {
var item models.KnowledgeBaseItem
if err := m.q.GetKnowledgeBaseItem.Get(&item, id); err != nil {
if err == sql.ErrNoRows {
return item, envelope.NewError(envelope.NotFoundError, m.i18n.T("globals.messages.notFound"), nil)
}
m.lo.Error("error fetching knowledge base item", "error", err)
return item, envelope.NewError(envelope.GeneralError, m.i18n.T("globals.messages.somethingWentWrong"), nil)
}
return item, nil
}
func (m *Manager) CreateKnowledgeBaseItem(title, content, source, sourceURL string, enabled bool) (models.KnowledgeBaseItem, error) {
if source == "" {
source = models.KnowledgeSourceManual
}
var item models.KnowledgeBaseItem
if err := m.q.InsertKnowledgeBaseItem.Get(&item, models.KnowledgeTypeSnippet, title, content, enabled, source, sourceURL); err != nil {
m.lo.Error("error creating knowledge base item", "error", err)
return item, envelope.NewError(envelope.GeneralError, m.i18n.T("globals.messages.somethingWentWrong"), nil)
}
m.reindexSnippet(item)
return item, nil
}
func (m *Manager) UpdateKnowledgeBaseItem(id int, title, content string, enabled bool) (models.KnowledgeBaseItem, error) {
var item models.KnowledgeBaseItem
if err := m.q.UpdateKnowledgeBaseItem.Get(&item, id, title, content, enabled); err != nil {
if err == sql.ErrNoRows {
return item, envelope.NewError(envelope.NotFoundError, m.i18n.T("globals.messages.notFound"), nil)
}
m.lo.Error("error updating knowledge base item", "error", err)
return item, envelope.NewError(envelope.GeneralError, m.i18n.T("globals.messages.somethingWentWrong"), nil)
}
m.reindexSnippet(item)
return item, nil
}
// DeleteKnowledgeBaseItem removes the snippet and its embeddings in one transaction so a failure
// can't leave deleted content searchable.
func (m *Manager) DeleteKnowledgeBaseItem(id int) error {
m.reindexMu.Lock()
defer m.reindexMu.Unlock()
// Supersede any in-flight reindex for this snippet so a slower embed can't re-insert its vectors
// after the delete commits.
m.dropSnippetGen(id)
tx, err := m.db.BeginTxx(context.Background(), &sql.TxOptions{})
if err != nil {
m.lo.Error("error beginning knowledge base delete transaction", "error", err)
return envelope.NewError(envelope.GeneralError, m.i18n.T("globals.messages.somethingWentWrong"), nil)
}
defer func() {
_ = tx.Rollback()
}()
if _, err := tx.Stmtx(m.q.DeleteKnowledgeBaseItem).Exec(id); err != nil {
m.lo.Error("error deleting knowledge base item", "error", err)
return envelope.NewError(envelope.GeneralError, m.i18n.T("globals.messages.somethingWentWrong"), nil)
}
if _, err := tx.Stmtx(m.q.DeleteEmbeddingsBySource).Exec(models.SourceSnippet, id); err != nil {
m.lo.Error("error deleting snippet embeddings", "error", err)
return envelope.NewError(envelope.GeneralError, m.i18n.T("globals.messages.somethingWentWrong"), nil)
}
if err := tx.Commit(); err != nil {
m.lo.Error("error committing knowledge base delete transaction", "error", err)
return envelope.NewError(envelope.GeneralError, m.i18n.T("globals.messages.somethingWentWrong"), nil)
}
m.index.removeSource(models.SourceSnippet, id)
return nil
}
// reindexSnippet embeds an enabled snippet (or drops its vectors when disabled) in the background.
func (m *Manager) reindexSnippet(item models.KnowledgeBaseItem) {
gen := m.nextSnippetGen(item.ID)
go m.reindexSnippetSync(item, gen)
}
func (m *Manager) reindexSnippetSync(item models.KnowledgeBaseItem, gen uint64) {
cfg, err := m.getRawProviderConfig(models.ProviderTypeEmbedding)
if err != nil {
return
}
m.reindexSnippetWith(item, cfg.Model, cfg.Dimensions, gen)
}
// reindexSnippetWith embeds an enabled snippet (or drops its vectors when disabled) and records the
// fingerprint on success. The commit is gated by gen so a slower job from an older edit can't overwrite
// a newer one. On failure the stored fingerprint stays stale, so reconcile retries later.
func (m *Manager) reindexSnippetWith(item models.KnowledgeBaseItem, model string, dimensions int, gen uint64) {
if !item.Enabled {
m.reindexMu.Lock()
defer m.reindexMu.Unlock()
if !m.isLatestSnippetGen(item.ID, gen) {
return
}
if err := m.removeEmbeddings(models.SourceSnippet, item.ID); err != nil {
m.lo.Error("error removing snippet embeddings", "error", err)
return
}
m.setSnippetFingerprint(item.ID, "")
return
}
indexed, err := m.embedSource(models.SourceSnippet, item.ID, item.Title, item.Content)
if err != nil {
m.lo.Error("error indexing snippet", "error", err, "id", item.ID)
return
}
m.reindexMu.Lock()
defer m.reindexMu.Unlock()
if !m.isLatestSnippetGen(item.ID, gen) {
return
}
if err := m.commitEmbeddings(models.SourceSnippet, item.ID, indexed); err != nil {
m.lo.Error("error indexing snippet", "error", err, "id", item.ID)
return
}
m.setSnippetFingerprint(item.ID, snippetFingerprint(item, model, dimensions))
}
// nextSnippetGen bumps and returns the reindex generation for a snippet. Each edit gets a higher gen;
// a reindex job only commits if its gen is still the latest when it reaches the commit.
func (m *Manager) nextSnippetGen(id int) uint64 {
m.snippetGenMu.Lock()
defer m.snippetGenMu.Unlock()
m.snippetGen[id]++
return m.snippetGen[id]
}
func (m *Manager) isLatestSnippetGen(id int, gen uint64) bool {
m.snippetGenMu.Lock()
defer m.snippetGenMu.Unlock()
return m.snippetGen[id] == gen
}
func (m *Manager) dropSnippetGen(id int) {
m.snippetGenMu.Lock()
defer m.snippetGenMu.Unlock()
delete(m.snippetGen, id)
}
func (m *Manager) setSnippetFingerprint(id int, fingerprint string) {
if _, err := m.q.SetKnowledgeBaseFingerprint.Exec(id, fingerprint); err != nil {
m.lo.Error("error setting snippet embedded fingerprint", "error", err, "id", id)
}
}
// ReindexAll triggers a reconcile so snippets are re-embedded against the current model, e.g. after the embedding model changed.
func (m *Manager) ReindexAll() {
go m.reconcile()
}
// snippetFingerprint signs the content and embedding model a snippet was last embedded against; any
// change (edited content, switched model, changed dimensions) yields a new value and triggers reindex.
func snippetFingerprint(item models.KnowledgeBaseItem, model string, dimensions int) string {
sum := sha256.Sum256(fmt.Appendf(nil, "%s\x00%s\x00%s\x00%d", item.Title, item.Content, model, dimensions))
return hex.EncodeToString(sum[:])
}