Merge pull request #39 from linuxfoundation/andrest50/indexer-message

[LFXV2-968] Integrate indexer-service types for NATS messaging

Author: andrest50

README.md

@@ -47,45 +47,21 @@ This service publishes the following NATS events:
 
 ### Project Tags
 
-The LFX v2 Project Service generates a set of tags for projects and project settings that are sent to the indexer-service. These tags enable searchability and discoverability of projects through OpenSearch.
+The LFX v2 Project Service generates tags for projects that are sent to the indexer-service.
 
 #### Tags Generated for Projects
 
-When projects are created or updated, the following tags are automatically generated:
+When projects are created or updated, the following tag is generated:
 
 | Project Field | Tag Format | Example | Purpose |
 |--------------|-----------|---------|---------|
-| UID | Plain value | `f1545930-b9b7-420d-942b-eb53c1a63428` | Direct lookup by ID |
-| UID | `project_uid:<value>` | `project_uid:f1545930-b9b7-420d-942b-eb53c1a63428` | Namespaced lookup by ID |
-| ParentUID | `parent_uid:<value>` | `parent_uid:efc80205-b0b3-4943-9395-2b634985a142` | Find child projects of a parent |
-| Slug | Plain value | `test-project-tags-indexed` | Direct lookup by slug |
-| Slug | `project_slug:<value>` | `project_slug:test-project-tags-indexed` | Namespaced lookup by slug |
-| Name | Plain value | `Updated Foo Foundation` | Text search by project name |
-| Description | Plain value | `Updated description for tag testing` | Full-text search in descriptions |
+| Slug | `project_slug:<value>` | `project_slug:test-project` | Namespaced lookup by slug |
 
-#### Tags Generated for Project Settings
-
-Project settings generate a separate set of tags:
-
-| Settings Field | Tag Format | Example | Purpose |
-|---------------|-----------|---------|---------|
-| UID | Plain value | `f1545930-b9b7-420d-942b-eb53c1a63428` | Direct lookup by ID |
-| UID | `project_uid:<value>` | `project_uid:f1545930-b9b7-420d-942b-eb53c1a63428` | Namespaced lookup by ID |
-| MissionStatement | Plain value | `Updated mission statement for testing tags` | Full-text search in mission statements |
-
-#### How Tags Are Used
+**Note**: Additional project metadata (UID, ParentUID, Name, Description, etc.) is sent via the `IndexingConfig` field.
 
-Tags serve multiple important purposes in the LFX system:
-
-1. **Indexed Search**: Tags are indexed in OpenSearch, enabling fast lookups and text searches across projects
-
-2. **Relationship Navigation**: Parent-child relationships can be traversed using the parent_uid tags
-
-3. **Multiple Access Patterns**: Both plain value and prefixed tags support different query patterns:
-   - Plain values support general text search (e.g., "find projects containing 'foo'")
-   - Prefixed values support field-specific search (e.g., "find projects with slug 'test-project'")
+#### Tags Generated for Project Settings
 
-4. **Data Synchronization**: When projects or settings are updated, their tags are automatically updated, ensuring search results remain current
+Project settings generate no tags. All metadata is sent via the `IndexingConfig` field.
 
 ## Quick Start
 

charts/lfx-v2-project-service/Chart.yaml

@@ -5,5 +5,5 @@ apiVersion: v2
 name: lfx-v2-project-service
 description: LFX Platform V2 Project Service chart
 type: application
-version: 0.5.4
+version: 0.5.5
 appVersion: "latest"

cmd/project-api/service_endpoint_project_test.go

@@ -153,9 +153,8 @@ func TestCreateProject(t *testing.T) {
 				// Mock successful project creation
 				mockRepo.On("CreateProject", mock.Anything, mock.AnythingOfType("*models.ProjectBase"), mock.AnythingOfType("*models.ProjectSettings")).Return(nil)
 				// Mock message sending
-				mockMsg.On("SendIndexerMessage", mock.Anything, mock.AnythingOfType("string"), mock.AnythingOfType("models.ProjectIndexerMessage"), mock.AnythingOfType("bool")).Return(nil)
+				mockMsg.On("SendIndexerMessage", mock.Anything, mock.AnythingOfType("string"), mock.AnythingOfType("types.IndexerMessageEnvelope"), mock.AnythingOfType("bool")).Return(nil).Times(2)
 				mockMsg.On("SendAccessMessage", mock.Anything, mock.AnythingOfType("string"), mock.AnythingOfType("models.ProjectAccessMessage"), mock.AnythingOfType("bool")).Return(nil)
-				mockMsg.On("SendIndexerMessage", mock.Anything, mock.AnythingOfType("string"), mock.AnythingOfType("models.ProjectSettingsIndexerMessage"), mock.AnythingOfType("bool")).Return(nil)
 			},
 			expectedError: false,
 		},

go.mod

@@ -11,6 +11,7 @@ require (
 	github.com/aws/aws-sdk-go-v2/service/s3 v1.92.0
 	github.com/go-viper/mapstructure/v2 v2.4.0
 	github.com/google/uuid v1.6.0
+	github.com/linuxfoundation/lfx-v2-indexer-service v0.4.14-0.20260109191409-7371e293d8b5
 	github.com/nats-io/nats.go v1.47.0
 	github.com/rustyoz/svg v0.0.0-20250705135709-8b1786137cb3
 	github.com/stretchr/testify v1.11.1

go.sum

@@ -62,6 +62,10 @@ github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aN
 github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
 github.com/klauspost/compress v1.18.1 h1:bcSGx7UbpBqMChDtsF28Lw6v/G94LPrrbMbdC3JH2co=
 github.com/klauspost/compress v1.18.1/go.mod h1:ZQFFVG+MdnR0P+l6wpXgIL4NTtwiKIdBnrBd8Nrxr+0=
+github.com/linuxfoundation/lfx-v2-indexer-service v0.4.13 h1:SANx5u+qJ+1DkMadpSDhPYJgPgnHDBPxw9Am6LC5pjk=
+github.com/linuxfoundation/lfx-v2-indexer-service v0.4.13/go.mod h1:j013GdKST/hMWFhciRuzJd0sy764sNtlmO3gqmsnaCA=
+github.com/linuxfoundation/lfx-v2-indexer-service v0.4.14-0.20260109191409-7371e293d8b5 h1:Ic06r/3OO4wP2Y2eL9InXEKRSVq2cqbNGBTsdr493YA=
+github.com/linuxfoundation/lfx-v2-indexer-service v0.4.14-0.20260109191409-7371e293d8b5/go.mod h1:j013GdKST/hMWFhciRuzJd0sy764sNtlmO3gqmsnaCA=
 github.com/manveru/faker v0.0.0-20171103152722-9fbc68a78c4d h1:Zj+PHjnhRYWBK6RqCDBcAhLXoi3TzC27Zad/Vn+gnVQ=
 github.com/manveru/faker v0.0.0-20171103152722-9fbc68a78c4d/go.mod h1:WZy8Q5coAB1zhY9AOBJP0O6J4BuDfbupUDavKY+I3+s=
 github.com/manveru/gobdd v0.0.0-20131210092515-f1a17fdd710b h1:3E44bLeN8uKYdfQqVQycPnaVviZdBLbizFhU49mtbe4=

internal/domain/models/message.go

@@ -3,41 +3,6 @@
 
 package models
 
-// MessageAction is a type for the action of a project message.
-type MessageAction string
-
-// MessageAction constants for the action of a project message.
-const (
-	// ActionCreated is the action for a resource creation message.
-	ActionCreated MessageAction = "created"
-	// ActionUpdated is the action for a resource update message.
-	ActionUpdated MessageAction = "updated"
-	// ActionDeleted is the action for a resource deletion message.
-	ActionDeleted MessageAction = "deleted"
-)
-
-// ProjectIndexerMessage is a type-safe NATS message for project indexing operations.
-type ProjectIndexerMessage struct {
-	Action MessageAction `json:"action"`
-	Data   ProjectBase   `json:"data"`
-	Tags   []string      `json:"tags"`
-}
-
-// ProjectSettingsIndexerMessage is a type-safe NATS message for project settings indexing operations.
-type ProjectSettingsIndexerMessage struct {
-	Action MessageAction   `json:"action"`
-	Data   ProjectSettings `json:"data"`
-	Tags   []string        `json:"tags"`
-}
-
-// IndexerMessageEnvelope is the actual message format sent to NATS for indexing operations.
-type IndexerMessageEnvelope struct {
-	Action  MessageAction     `json:"action"`
-	Headers map[string]string `json:"headers"`
-	Data    any               `json:"data"`
-	Tags    []string          `json:"tags"`
-}
-
 // ProjectAccessData is the schema for the data in the message sent to the fga-sync service.
 // These are the fields that the fga-sync service needs in order to update the OpenFGA permissions.
 type ProjectAccessData struct {

internal/domain/models/message_test.go

@@ -9,116 +9,6 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-func TestMessageActionConstants(t *testing.T) {
-	tests := []struct {
-		name     string
-		action   MessageAction
-		expected string
-	}{
-		{
-			name:     "action created",
-			action:   ActionCreated,
-			expected: "created",
-		},
-		{
-			name:     "action updated",
-			action:   ActionUpdated,
-			expected: "updated",
-		},
-		{
-			name:     "action deleted",
-			action:   ActionDeleted,
-			expected: "deleted",
-		},
-	}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			assert.Equal(t, tt.expected, string(tt.action))
-		})
-	}
-}
-
-func TestProjectIndexerMessage(t *testing.T) {
-	tests := []struct {
-		name    string
-		message ProjectIndexerMessage
-		verify  func(t *testing.T, msg ProjectIndexerMessage)
-	}{
-		{
-			name: "project indexer message with all fields",
-			message: ProjectIndexerMessage{
-				Action: ActionCreated,
-				Data: ProjectBase{
-					UID:  "project-123",
-					Slug: "test-project",
-					Name: "Test Project",
-				},
-				Tags: []string{"project-123", "test-project", "Test Project"},
-			},
-			verify: func(t *testing.T, msg ProjectIndexerMessage) {
-				assert.Equal(t, ActionCreated, msg.Action)
-				assert.Equal(t, "project-123", msg.Data.UID)
-				assert.Equal(t, "test-project", msg.Data.Slug)
-				assert.Equal(t, "Test Project", msg.Data.Name)
-				assert.Len(t, msg.Tags, 3)
-			},
-		},
-		{
-			name: "project indexer message with minimal fields",
-			message: ProjectIndexerMessage{
-				Action: ActionDeleted,
-				Data: ProjectBase{
-					UID: "project-456",
-				},
-			},
-			verify: func(t *testing.T, msg ProjectIndexerMessage) {
-				assert.Equal(t, ActionDeleted, msg.Action)
-				assert.Equal(t, "project-456", msg.Data.UID)
-				assert.Empty(t, msg.Tags)
-			},
-		},
-	}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			tt.verify(t, tt.message)
-		})
-	}
-}
-
-func TestProjectSettingsIndexerMessage(t *testing.T) {
-	tests := []struct {
-		name    string
-		message ProjectSettingsIndexerMessage
-		verify  func(t *testing.T, msg ProjectSettingsIndexerMessage)
-	}{
-		{
-			name: "project settings indexer message with all fields",
-			message: ProjectSettingsIndexerMessage{
-				Action: ActionUpdated,
-				Data: ProjectSettings{
-					UID:              "settings-123",
-					MissionStatement: "Our mission",
-				},
-				Tags: []string{"settings-123", "Our mission"},
-			},
-			verify: func(t *testing.T, msg ProjectSettingsIndexerMessage) {
-				assert.Equal(t, ActionUpdated, msg.Action)
-				assert.Equal(t, "settings-123", msg.Data.UID)
-				assert.Equal(t, "Our mission", msg.Data.MissionStatement)
-				assert.Len(t, msg.Tags, 2)
-			},
-		},
-	}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			tt.verify(t, tt.message)
-		})
-	}
-}
-
 func TestProjectAccessMessage(t *testing.T) {
 	tests := []struct {
 		name    string
@@ -154,48 +44,3 @@ func TestProjectAccessMessage(t *testing.T) {
 		})
 	}
 }
-
-func TestIndexerMessageEnvelope(t *testing.T) {
-	tests := []struct {
-		name    string
-		message IndexerMessageEnvelope
-		verify  func(t *testing.T, msg IndexerMessageEnvelope)
-	}{
-		{
-			name: "indexer message envelope with all fields",
-			message: IndexerMessageEnvelope{
-				Action: ActionCreated,
-				Headers: map[string]string{
-					"request-id": "test-request-123",
-					"user-id":    "user-456",
-				},
-				Data: map[string]interface{}{
-					"uid":  "project-123",
-					"slug": "test-project",
-					"name": "Test Project",
-				},
-				Tags: []string{"project-123", "test-project"},
-			},
-			verify: func(t *testing.T, msg IndexerMessageEnvelope) {
-				assert.Equal(t, ActionCreated, msg.Action)
-				assert.Equal(t, "test-request-123", msg.Headers["request-id"])
-				assert.Equal(t, "user-456", msg.Headers["user-id"])
-				assert.NotNil(t, msg.Data)
-				assert.Len(t, msg.Tags, 2)
-
-				// Verify data can be type asserted
-				data, ok := msg.Data.(map[string]interface{})
-				assert.True(t, ok)
-				assert.Equal(t, "project-123", data["uid"])
-				assert.Equal(t, "test-project", data["slug"])
-				assert.Equal(t, "Test Project", data["name"])
-			},
-		},
-	}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			tt.verify(t, tt.message)
-		})
-	}
-}