feat(search): align article result payloads
This commit is contained in:
@@ -282,7 +282,7 @@ func (h *SearchHandler) SearchArticles(c *gin.Context) {
|
||||
}
|
||||
|
||||
_ = total
|
||||
c.JSON(http.StatusOK, gin.H{"payload": gin.H{"articles": serializeSearchArticles(results)}})
|
||||
c.JSON(http.StatusOK, gin.H{"payload": gin.H{"articles": serializeSearchArticles(c.Request.Context(), h.db, results)}})
|
||||
}
|
||||
|
||||
func serializeSearchPayload(ctx context.Context, db *gorm.DB, results []search.SearchResult) gin.H {
|
||||
@@ -290,7 +290,7 @@ func serializeSearchPayload(ctx context.Context, db *gorm.DB, results []search.S
|
||||
"conversations": serializeSearchConversations(ctx, db, filterSearchResults(results, search.ResultTypeConversation)),
|
||||
"contacts": serializeSearchContacts(filterSearchResults(results, search.ResultTypeContact)),
|
||||
"messages": serializeSearchMessages(ctx, db, filterSearchResults(results, search.ResultTypeMessage)),
|
||||
"articles": serializeSearchArticles(filterSearchResults(results, search.ResultTypeArticle)),
|
||||
"articles": serializeSearchArticles(ctx, db, filterSearchResults(results, search.ResultTypeArticle)),
|
||||
}
|
||||
}
|
||||
|
||||
@@ -618,22 +618,27 @@ func omitNilSearchMessageFields(data map[string]any) map[string]any {
|
||||
return data
|
||||
}
|
||||
|
||||
func serializeSearchArticles(results []search.SearchResult) []map[string]any {
|
||||
func serializeSearchArticles(ctx context.Context, db *gorm.DB, results []search.SearchResult) []map[string]any {
|
||||
payload := make([]map[string]any, 0, len(results))
|
||||
for _, result := range results {
|
||||
payload = append(payload, serializeSearchArticle(result))
|
||||
payload = append(payload, serializeSearchArticle(ctx, db, result))
|
||||
}
|
||||
return payload
|
||||
}
|
||||
|
||||
func serializeSearchArticle(result search.SearchResult) map[string]any {
|
||||
func serializeSearchArticle(ctx context.Context, db *gorm.DB, result search.SearchResult) map[string]any {
|
||||
if article, ok := result.Data.(model.Article); ok {
|
||||
return serializeSearchArticleModel(&article)
|
||||
return serializeSearchArticleModel(ctx, db, &article)
|
||||
}
|
||||
if article, ok := result.Data.(*model.Article); ok && article != nil {
|
||||
return serializeSearchArticleModel(article)
|
||||
return serializeSearchArticleModel(ctx, db, article)
|
||||
}
|
||||
data := nestedSearchData(result, "article")
|
||||
if db != nil {
|
||||
if payload, ok := loadSearchArticlePayload(ctx, db, uintFromAny(firstMapValue(data, "id")), result.AccountID); ok {
|
||||
return payload
|
||||
}
|
||||
}
|
||||
return map[string]any{
|
||||
"id": firstMapValue(data, "id"),
|
||||
"title": firstMapValue(data, "title"),
|
||||
@@ -648,7 +653,12 @@ func serializeSearchArticle(result search.SearchResult) map[string]any {
|
||||
}
|
||||
}
|
||||
|
||||
func serializeSearchArticleModel(article *model.Article) map[string]any {
|
||||
func serializeSearchArticleModel(ctx context.Context, db *gorm.DB, article *model.Article) map[string]any {
|
||||
if db != nil {
|
||||
if payload, ok := loadSearchArticlePayload(ctx, db, article.ID, article.AccountID); ok {
|
||||
return payload
|
||||
}
|
||||
}
|
||||
portalSlug := ""
|
||||
if article.Portal.Slug != "" {
|
||||
portalSlug = article.Portal.Slug
|
||||
@@ -671,6 +681,21 @@ func serializeSearchArticleModel(article *model.Article) map[string]any {
|
||||
}
|
||||
}
|
||||
|
||||
func loadSearchArticlePayload(ctx context.Context, db *gorm.DB, articleID uint, accountID uint) (map[string]any, bool) {
|
||||
if db == nil || articleID == 0 {
|
||||
return nil, false
|
||||
}
|
||||
var article model.Article
|
||||
q := db.WithContext(ctx).Preload("Portal").Preload("Category").Where("id = ?", articleID)
|
||||
if accountID != 0 {
|
||||
q = q.Where("account_id = ?", accountID)
|
||||
}
|
||||
if err := q.First(&article).Error; err != nil {
|
||||
return nil, false
|
||||
}
|
||||
return serializeSearchArticleModel(ctx, nil, &article), true
|
||||
}
|
||||
|
||||
func nestedSearchData(result search.SearchResult, key string) map[string]any {
|
||||
return nestedSearchDataFromRoot(searchDataRoot(result), key)
|
||||
}
|
||||
|
||||
@@ -545,6 +545,40 @@ func TestSearchHandler_SearchArticles_Success(t *testing.T) {
|
||||
require.Len(t, results, 1)
|
||||
}
|
||||
|
||||
func TestSearchHandler_SearchArticles_HydratesPortalAndCategoryPayload(t *testing.T) {
|
||||
db, err := gorm.Open(sqlite.Open("file:search-article-payload?mode=memory&cache=private"), &gorm.Config{Logger: logger.Default.LogMode(logger.Silent)})
|
||||
require.NoError(t, err)
|
||||
require.NoError(t, db.AutoMigrate(&model.Account{}, &model.Portal{}, &model.Category{}, &model.Article{}))
|
||||
|
||||
account := model.Account{Name: "Acme"}
|
||||
require.NoError(t, db.Create(&account).Error)
|
||||
portal := model.Portal{AccountID: account.ID, Name: "Help Center", Slug: "help-center", Locale: "en"}
|
||||
require.NoError(t, db.Create(&portal).Error)
|
||||
category := model.Category{AccountID: account.ID, PortalID: portal.ID, Name: "Billing", Slug: "billing", Locale: "en"}
|
||||
require.NoError(t, db.Create(&category).Error)
|
||||
article := model.Article{AccountID: account.ID, PortalID: portal.ID, CategoryID: &category.ID, Title: "Billing FAQ", Slug: "billing-faq", Content: "billing help", Status: "published", Locale: "en"}
|
||||
require.NoError(t, db.Create(&article).Error)
|
||||
|
||||
repo := &mockSearchRepo{articles: []model.Article{{Base: model.Base{ID: article.ID}, AccountID: account.ID}}, articleTotal: 1}
|
||||
svc := search.NewSearchService(repo)
|
||||
handler := NewSearchHandler(svc, db)
|
||||
router := setupSearchHandlerRouter(handler)
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
req := httptest.NewRequest("GET", "/api/v1/accounts/1/search/articles?q=billing", nil)
|
||||
router.ServeHTTP(w, req)
|
||||
|
||||
require.Equal(t, http.StatusOK, w.Code)
|
||||
var body map[string]any
|
||||
require.NoError(t, json.Unmarshal(w.Body.Bytes(), &body))
|
||||
payload := body["payload"].(map[string]any)
|
||||
articles := payload["articles"].([]any)
|
||||
require.Len(t, articles, 1)
|
||||
got := articles[0].(map[string]any)
|
||||
assert.Equal(t, "help-center", got["portal_slug"])
|
||||
assert.Equal(t, "Billing", got["category_name"])
|
||||
}
|
||||
|
||||
func TestSearchHandler_SearchArticles_InvalidAccountID(t *testing.T) {
|
||||
repo := &mockSearchRepo{}
|
||||
svc := search.NewSearchService(repo)
|
||||
|
||||
Reference in New Issue
Block a user