Abstracting search

GenerateNU · May 22, 2024 · 23a293f · 23a293f
1 parent a99c4f1
commit 23a293f
Show file tree

Hide file tree

Showing 15 changed files with 316 additions and 359 deletions.
diff --git a/backend/entities/clubs/base/transactions.go b/backend/entities/clubs/base/transactions.go
@@ -70,7 +70,7 @@ func CreateClub(db *gorm.DB, userId uuid.UUID, club models.Club) (*models.Club,
 		return nil, err
 	}
 
-	err = search.UpsertClubToIndex(db, club.ID.String())
+	err = search.Upsert[models.Club](db, "clubs", club.ID.String(), &club)
 	if err != nil {
 		return nil, err
 	}
@@ -106,7 +106,7 @@ func UpdateClub(db *gorm.DB, id uuid.UUID, club models.Club) (*models.Club, erro
 		return nil, err
 	}
 
-	err = search.UpsertClubToIndex(db, club.ID.String())
+	err = search.Upsert[models.Club](db, "clubs", club.ID.String(), &club)
 	if err != nil {
 		return nil, err
 	}
@@ -140,7 +140,7 @@ func DeleteClub(db *gorm.DB, id uuid.UUID) error {
 		return result.Error
 	}
 
-	err = search.DeleteClubFromIndex(db, id.String())
+	err = search.Delete(db, "clubs", id.String())
 	if err != nil {
 		return err
 	}

diff --git a/backend/entities/events/base/transactions.go b/backend/entities/events/base/transactions.go
@@ -30,7 +30,7 @@ func CreateEvent(db *gorm.DB, event models.Event) (*models.Event, error) {
 		return nil, err
 	}
 
-	err := search.UpsertEventToIndex(db, event.ID.String())
+	err := search.Upsert[models.Event](db, "events", event.ID.String(), &event)
 	if err != nil {
 		return nil, err
 	}
@@ -55,9 +55,9 @@ func updateEvent(db *gorm.DB, id uuid.UUID, event models.Event) ([]models.Event,
 		return nil, result.Error
 	}
 
-	err := search.UpsertEventToIndex(db, id.String())
+	err := search.Upsert[models.Event](db, "events", id.String(), &event)
 	if err != nil {
-		return []models.Event{resultingEvent}, err
+		return nil, err
 	}
 
 	return []models.Event{resultingEvent}, nil
@@ -93,7 +93,7 @@ func DeleteEvent(db *gorm.DB, id uuid.UUID) error {
 		return result.Error
 	}
 
-	err := search.DeleteEventFromIndex(db, id.String())
+	err := search.Delete(db, "events", id.String())
 	if err != nil {
 		return err
 	}

diff --git a/backend/entities/models/club.go b/backend/entities/models/club.go
@@ -36,3 +36,26 @@ type Club struct {
 	Event       []Event        `gorm:"many2many:club_events;" json:"-"`
 	Notifcation []Notification `gorm:"polymorphic:Reference;" json:"-"`
 }
+
+type ClubSearchDocument struct {
+	Name        string   `json:"name"`
+	Preview     string   `json:"preview"`
+	Description string   `json:"description"`
+	NumMembers  int      `json:"num_members"`
+	Tags        []string `json:"tags"`
+}
+
+func (c *Club) ToSearchDocument() interface{} {
+	tagIds := make([]string, len(c.Tag))
+	for i, tag := range c.Tag {
+		tagIds[i] = tag.ID.String()
+	}
+
+	return ClubSearchDocument{
+		Name:        c.Name,
+		Preview:     c.Preview,
+		Description: c.Description,
+		NumMembers:  c.NumMembers,
+		Tags:        tagIds,
+	}
+}
diff --git a/backend/entities/models/event.go b/backend/entities/models/event.go
@@ -47,3 +47,38 @@ type Event struct {
 	Tag          []Tag          `gorm:"many2many:event_tags;" json:"-"`
 	Notification []Notification `gorm:"polymorphic:Reference;" json:"-"`
 }
+
+// How Events are represented in the OpenSearch index.
+type EventSearchDocument struct {
+	Name        string    `json:"name"`
+	Preview     string    `json:"preview"`
+	Description string    `json:"description"`
+	EventType   EventType `json:"event_type"`
+	StartTime   time.Time `json:"start_time"`
+	EndTime     time.Time `json:"end_time"`
+	Clubs       []string  `json:"clubs"`
+	Tags        []string  `json:"tags"`
+}
+
+func (c *Event) ToSearchDocument() interface{} {
+	tagIds := make([]string, len(c.Tag))
+	for i, tag := range c.Tag {
+		tagIds[i] = tag.ID.String()
+	}
+
+	clubIds := make([]string, len(c.Clubs))
+	for i, club := range c.Clubs {
+		clubIds[i] = club.ID.String()
+	}
+
+	return EventSearchDocument{
+		Name:        c.Name,
+		Preview:     c.Preview,
+		Description: c.Description,
+		EventType:   c.EventType,
+		StartTime:   c.StartTime,
+		EndTime:     c.EndTime,
+		Tags:        tagIds,
+		Clubs:       clubIds,
+	}
+}
diff --git a/backend/search/base/controller.go b/backend/search/base/controller.go
@@ -3,7 +3,7 @@ package base
 import (
 	"net/http"
 
-	"github.com/GenerateNU/sac/backend/search"
+	search_types "github.com/GenerateNU/sac/backend/search/types"
 	"github.com/GenerateNU/sac/backend/utilities"
 	"github.com/gofiber/fiber/v2"
 )
@@ -30,7 +30,7 @@ func NewSearchController(searchService SearchServiceInterface) *SearchController
 // @Failure     500   {object}      error
 // @Router		/search/clubs  [get]
 func (s *SearchController) SearchClubs(c *fiber.Ctx) error {
-	var searchQuery search.ClubSearchRequest
+	var searchQuery search_types.ClubSearchRequest
 
 	if err := c.BodyParser(&searchQuery); err != nil {
 		return utilities.InvalidJSON()
@@ -59,7 +59,7 @@ func (s *SearchController) SearchClubs(c *fiber.Ctx) error {
 // @Failure     500   {object}      error
 // @Router		/search/events  [get]
 func (s *SearchController) SearchEvents(c *fiber.Ctx) error {
-	var searchQuery search.EventSearchRequest
+	var searchQuery search_types.EventSearchRequest
 
 	if err := c.BodyParser(&searchQuery); err != nil {
 		return utilities.InvalidJSON()

diff --git a/backend/search/base/routes.go b/backend/search/base/routes.go
@@ -4,7 +4,7 @@ import (
 	"github.com/GenerateNU/sac/backend/types"
 )
 
-func Search(params types.RouteParams) {
+func SearchRoutes(params types.RouteParams) {
 	searchService := NewSearchService(params.ServiceParams)
 	searchController := NewSearchController(searchService)
 

diff --git a/backend/search/base/service.go b/backend/search/base/service.go
@@ -1,14 +1,15 @@
 package base
 
 import (
-	"github.com/GenerateNU/sac/backend/search"
+	"github.com/GenerateNU/sac/backend/entities/models"
+	search_types "github.com/GenerateNU/sac/backend/search/types"
 
 	"github.com/GenerateNU/sac/backend/types"
 )
 
 type SearchServiceInterface interface {
-	SearchClubs(query search.ClubSearchRequest) (*search.ClubSearchResult, error)
-	SearchEvents(query search.EventSearchRequest) (*search.EventSearchResult, error)
+	SearchClubs(query search_types.ClubSearchRequest) (*search_types.SearchResult[models.Club], error)
+	SearchEvents(query search_types.EventSearchRequest) (*search_types.SearchResult[models.Event], error)
 }
 
 type SearchService struct {
@@ -19,10 +20,10 @@ func NewSearchService(serviceParams types.ServiceParams) SearchServiceInterface
 	return &SearchService{serviceParams}
 }
 
-func (s *SearchService) SearchClubs(query search.ClubSearchRequest) (*search.ClubSearchResult, error) {
-	return SearchClubs(s.DB, query)
+func (s *SearchService) SearchClubs(query search_types.ClubSearchRequest) (*search_types.SearchResult[models.Club], error) {
+	return Search[models.Club](s.DB, &query)
 }
 
-func (s *SearchService) SearchEvents(query search.EventSearchRequest) (*search.EventSearchResult, error) {
-	return SearchEvents(s.DB, query)
+func (s *SearchService) SearchEvents(query search_types.EventSearchRequest) (*search_types.SearchResult[models.Event], error) {
+	return Search[models.Event](s.DB, &query)
 }
diff --git a/backend/search/base/transactions.go b/backend/search/base/transactions.go
@@ -8,8 +8,7 @@ import (
 	"net/http"
 
 	"github.com/GenerateNU/sac/backend/constants"
-	"github.com/GenerateNU/sac/backend/entities/models"
-	"github.com/GenerateNU/sac/backend/search"
+	"github.com/GenerateNU/sac/backend/search/types"
 	"gorm.io/gorm"
 )
 
@@ -47,8 +46,8 @@ func doSearchGetRequest[T, V any](url string, requestBody T) (*V, error) {
 	return &responseData, nil
 }
 
-func SearchClubs(db *gorm.DB, query search.ClubSearchRequest) (*search.ClubSearchResult, error) {
-	result, err := doSearchGetRequest[search.SearchEndpointRequest, search.SearchEndpointResponse]("/clubs/_search", query.ToSearchEndpointRequest())
+func Search[T types.Searchable](db *gorm.DB, query types.SearchRequest) (*types.SearchResult[T], error) {
+	result, err := doSearchGetRequest[types.SearchEndpointRequest, types.SearchEndpointResponse](fmt.Sprintf("%s/_search", query.Index()), query.ToSearchEndpointRequest())
 	if err != nil {
 		return nil, nil
 	}
@@ -58,110 +57,26 @@ func SearchClubs(db *gorm.DB, query search.ClubSearchRequest) (*search.ClubSearc
 		ids[i] = result.Id
 	}
 
-	var clubs []models.Club
+	var results []T
 
-	if err = db.Model(&models.Club{}).Preload("Tag").Where("id IN ?", ids).Find(&clubs).Error; err != nil {
+	if err = db.Model(query.Model()).Preload("Tag").Preload("Clubs").Where("id IN ?", ids).Find(&results).Error; err != nil {
 		return nil, nil
 	}
 
-	return &search.ClubSearchResult{
-		Results: clubs,
+	return &types.SearchResult[T]{
+		Results: results,
 	}, nil
 }
 
-func SearchEvents(db *gorm.DB, query search.EventSearchRequest) (*search.EventSearchResult, error) {
-	result, err := doSearchGetRequest[search.SearchEndpointRequest, search.SearchEndpointResponse]("/events/_search", query.ToSearchEndpointRequest())
-	if err != nil {
-		return nil, nil
-	}
-
-	ids := make([]string, len(result.Hits.Hits))
-	for i, result := range result.Hits.Hits {
-		ids[i] = result.Id
-	}
-
-	var events []models.Event
-
-	if err = db.Model(&models.Event{}).Preload("Tag").Where("id IN ?", ids).Find(&events).Error; err != nil {
-		return nil, nil
-	}
-
-	return &search.EventSearchResult{
-		Results: events,
-	}, nil
-}
-
-func UpsertClubToIndex(db *gorm.DB, clubUuid string) error {
-	var club models.Club
-
-	if err := db.Preload("Tag").Where("id = ?", clubUuid).Find(&club).Error; err != nil {
-		return err
-	}
-
-	doc := search.ClubSearchDocumentFromClub(&club)
-	requestBody := search.Json{
-		"doc":           doc,
-		"doc_as_upsert": true,
-	}
-	payload, err := json.Marshal(requestBody)
-
-	print(string(payload))
-	if err != nil {
-		return err
-	}
-
-	req, err := http.NewRequest("POST", fmt.Sprintf("%s/%s/_update/%s", constants.SEARCH_URL, "clubs", club.ID), bytes.NewBuffer(payload))
-	if err != nil {
-		return err
-	}
-	req.Header.Set("Content-Type", "application/json")
-
-	resp, err := http.DefaultClient.Do(req)
-	if err != nil {
-		return err
-	}
-	defer resp.Body.Close()
-
-	responseBody, err := io.ReadAll(resp.Body)
-	if err != nil {
-		return err
-	}
-	print(string(responseBody))
-
-	return nil
-}
-
-func DeleteClubFromIndex(db *gorm.DB, clubUuid string) error {
-	req, err := http.NewRequest("DELETE", fmt.Sprintf("%s/%s/_doc/%s", constants.SEARCH_URL, "clubs", clubUuid), nil)
-	if err != nil {
-		return err
-	}
-	req.Header.Set("Content-Type", "application/json")
-
-	resp, err := http.DefaultClient.Do(req)
-	if err != nil {
-		return err
-	}
-	defer resp.Body.Close()
-
-	responseBody, err := io.ReadAll(resp.Body)
-	if err != nil {
-		return err
-	}
-	print(string(responseBody))
-
-	return nil
-}
-
-func UpsertEventToIndex(db *gorm.DB, eventUuid string) error {
-	var event models.Event
+func Upsert[T types.Searchable](db *gorm.DB, index string, uuid string, model types.ToSearchDocument) error {
+	var elem T
 
-	if err := db.Preload("Clubs").Preload("Tag").Where("id = ?", eventUuid).Find(&event).Error; err != nil {
+	if err := db.Model(&model).Preload("Tag").Where("Clubs").Where("id = ?", uuid).Find(&elem).Error; err != nil {
 		return err
 	}
 
-	doc := search.EventSearchDocumentFromEvent(&event)
-	requestBody := search.Json{
+	doc := model.ToSearchDocument()
+	requestBody := types.Json{
 		"doc":           doc,
 		"doc_as_upsert": true,
 	}
@@ -172,7 +87,7 @@ func UpsertEventToIndex(db *gorm.DB, eventUuid string) error {
 		return err
 	}
 
-	req, err := http.NewRequest("POST", fmt.Sprintf("%s/%s/_update/%s", constants.SEARCH_URL, "events", event.ID), bytes.NewBuffer(payload))
+	req, err := http.NewRequest("POST", fmt.Sprintf("%s/%s/_update/%s", constants.SEARCH_URL, index, uuid), bytes.NewBuffer(payload))
 	if err != nil {
 		return err
 	}
@@ -193,8 +108,8 @@ func UpsertEventToIndex(db *gorm.DB, eventUuid string) error {
 	return nil
 }
 
-func DeleteEventFromIndex(db *gorm.DB, eventUuid string) error {
-	req, err := http.NewRequest("DELETE", fmt.Sprintf("%s/%s/_doc/%s", constants.SEARCH_URL, "events", eventUuid), nil)
+func Delete(db *gorm.DB, index string, uuid string) error {
+	req, err := http.NewRequest("DELETE", fmt.Sprintf("%s/%s/_doc/%s", constants.SEARCH_URL, index, uuid), nil)
 	if err != nil {
 		return err
 	}

diff --git a/backend/search/seed.go b/backend/search/seed.go
@@ -10,6 +10,7 @@ import (
 
 	"github.com/GenerateNU/sac/backend/constants"
 	"github.com/GenerateNU/sac/backend/entities/models"
+	search_types "github.com/GenerateNU/sac/backend/search/types"
 	"github.com/GenerateNU/sac/backend/transactions"
 	"gorm.io/gorm"
 )
@@ -35,15 +36,15 @@ func SeedClubs(db *gorm.DB) error {
 	var requestBodyBuilder strings.Builder
 
 	for _, club := range clubs {
-		indexData := BulkRequestCreate{}
+		indexData := search_types.BulkRequestCreate{}
 		indexData.Create.Index = "clubs"
 		indexData.Create.Id = club.ID.String()
 		indexJson, err := json.Marshal(indexData)
 		if err != nil {
 			return err
 		}
 
-		clubData := ClubSearchDocumentFromClub(&club)
+		clubData := club.ToSearchDocument()
 		clubJson, err := json.Marshal(clubData)
 		if err != nil {
 			return err
@@ -92,15 +93,15 @@ func SeedEvents(db *gorm.DB) error {
 	var requestBodyBuilder strings.Builder
 
 	for _, event := range events {
-		indexData := BulkRequestCreate{}
+		indexData := search_types.BulkRequestCreate{}
 		indexData.Create.Index = "events"
 		indexData.Create.Id = event.ID.String()
 		indexJson, err := json.Marshal(indexData)
 		if err != nil {
 			return err
 		}
 
-		eventData := EventSearchDocumentFromEvent(&event)
+		eventData := event.ToSearchDocument()
 		eventJson, err := json.Marshal(eventData)
 		if err != nil {
 			return err