Merge pull request #35 from linuxfoundation/andrest50/project-settings-event

[LFXV2-787] Add NATS event for project settings updates

Author: andrest50

README.md

@@ -30,6 +30,20 @@ This service handles the following NATS subjects for inter-service communication
 - `lfx.projects-api.get_logo`: Get a project logo URL from a given project UID
 - `lfx.projects-api.slug_to_uid`: Get a project UID from a given project slug
 
+### NATS Events Published
+
+This service publishes the following NATS events:
+
+- `lfx.projects-api.project_settings.updated`: Published when project settings are updated. Contains both the old and new settings to allow downstream services to react to changes. Message format:
+
+  ```json
+  {
+    "project_uid": "string",
+    "old_settings": { /* ProjectSettings object */ },
+    "new_settings": { /* ProjectSettings object */ }
+  }
+  ```
+
 ### 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.

internal/domain/message.go

@@ -23,4 +23,5 @@ type MessageHandler interface {
 type MessageBuilder interface {
 	SendIndexerMessage(ctx context.Context, subject string, message any, sync bool) error
 	SendAccessMessage(ctx context.Context, subject string, message any, sync bool) error
+	SendProjectEventMessage(ctx context.Context, subject string, message any) error
 }

internal/domain/mock.go

@@ -122,6 +122,11 @@ func (m *MockMessageBuilder) SendAccessMessage(ctx context.Context, subject stri
 	return args.Error(0)
 }
 
+func (m *MockMessageBuilder) SendProjectEventMessage(ctx context.Context, subject string, message any) error {
+	args := m.Called(ctx, subject, message)
+	return args.Error(0)
+}
+
 // MockMessage implements Message for testing
 type MockMessage struct {
 	mock.Mock

internal/domain/models/message.go

@@ -53,3 +53,11 @@ type ProjectAccessData struct {
 type ProjectAccessMessage struct {
 	Data ProjectAccessData `json:"data"`
 }
+
+// ProjectSettingsUpdatedMessage is a NATS message published when project settings are updated.
+// It contains both the before and after states to allow downstream services to react to changes.
+type ProjectSettingsUpdatedMessage struct {
+	ProjectUID  string          `json:"project_uid"`
+	OldSettings ProjectSettings `json:"old_settings"`
+	NewSettings ProjectSettings `json:"new_settings"`
+}

internal/infrastructure/nats/message.go

@@ -171,3 +171,22 @@ func (m *MessageBuilder) SendAccessMessage(ctx context.Context, subject string,
 		return fmt.Errorf("unsupported access message type: %T", message)
 	}
 }
+
+// SendProjectEventMessage sends project event messages to NATS asynchronously.
+// This is used for publishing events like project settings updates, project creation, etc.
+func (m *MessageBuilder) SendProjectEventMessage(ctx context.Context, subject string, message any) error {
+	messageBytes, err := json.Marshal(message)
+	if err != nil {
+		slog.ErrorContext(ctx, "error marshalling project event message into JSON", constants.ErrKey, err, "subject", subject)
+		return err
+	}
+
+	err = m.publishMessage(subject, messageBytes)
+	if err != nil {
+		slog.ErrorContext(ctx, "error publishing project event message to NATS", constants.ErrKey, err, "subject", subject)
+		return err
+	}
+
+	slog.DebugContext(ctx, "published project event message to NATS", "subject", subject)
+	return nil
+}

internal/infrastructure/nats/message_test.go

@@ -385,3 +385,77 @@ func TestMessageBuilder_PublishAccessMessage_Sync(t *testing.T) {
 		})
 	}
 }
+
+func TestMessageBuilder_SendProjectEventMessage(t *testing.T) {
+	tests := []struct {
+		name       string
+		subject    string
+		message    interface{}
+		setupMocks func(*MockNATSConn)
+		wantErr    bool
+	}{
+		{
+			name:    "successful send project settings updated message",
+			subject: constants.ProjectSettingsUpdatedSubject,
+			message: models.ProjectSettingsUpdatedMessage{
+				ProjectUID: "test-project-uid",
+				OldSettings: models.ProjectSettings{
+					UID:              "test-project-uid",
+					MissionStatement: "old mission",
+				},
+				NewSettings: models.ProjectSettings{
+					UID:              "test-project-uid",
+					MissionStatement: "new mission",
+				},
+			},
+			setupMocks: func(mockConn *MockNATSConn) {
+				mockConn.On("Publish", constants.ProjectSettingsUpdatedSubject, mock.MatchedBy(func(data []byte) bool {
+					var msg models.ProjectSettingsUpdatedMessage
+					err := json.Unmarshal(data, &msg)
+					if err != nil {
+						return false
+					}
+					return msg.ProjectUID == "test-project-uid" &&
+						msg.OldSettings.MissionStatement == "old mission" &&
+						msg.NewSettings.MissionStatement == "new mission"
+				})).Return(nil)
+			},
+			wantErr: false,
+		},
+		{
+			name:    "nats publish error",
+			subject: constants.ProjectSettingsUpdatedSubject,
+			message: models.ProjectSettingsUpdatedMessage{
+				ProjectUID:  "test-project-uid",
+				OldSettings: models.ProjectSettings{UID: "test"},
+				NewSettings: models.ProjectSettings{UID: "test"},
+			},
+			setupMocks: func(mockConn *MockNATSConn) {
+				mockConn.On("Publish", constants.ProjectSettingsUpdatedSubject, mock.AnythingOfType("[]uint8")).Return(errors.New("nats error"))
+			},
+			wantErr: true,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			mockConn := &MockNATSConn{}
+			tt.setupMocks(mockConn)
+
+			mb := &MessageBuilder{
+				NatsConn: mockConn,
+			}
+
+			ctx := context.Background()
+			err := mb.SendProjectEventMessage(ctx, tt.subject, tt.message)
+
+			if tt.wantErr {
+				assert.Error(t, err)
+			} else {
+				assert.NoError(t, err)
+			}
+
+			mockConn.AssertExpectations(t)
+		})
+	}
+}

internal/service/project_operations.go

@@ -593,6 +593,15 @@ func (s *ProjectsService) UpdateProjectSettings(ctx context.Context, payload *pr
 		return s.MessageBuilder.SendAccessMessage(ctx, constants.UpdateAccessProjectSubject, msg, runSync)
 	})
 
+	g.Go(func() error {
+		msg := models.ProjectSettingsUpdatedMessage{
+			ProjectUID:  *payload.UID,
+			OldSettings: *existingProjectSettingsDB,
+			NewSettings: *projectSettingsDB,
+		}
+		return s.MessageBuilder.SendProjectEventMessage(ctx, constants.ProjectSettingsUpdatedSubject, msg)
+	})
+
 	if err := g.Wait(); err != nil {
 		// Return the first error from the goroutines.
 		return nil, domain.ErrInternal

pkg/constants/nats.go

@@ -37,6 +37,11 @@ const (
 	// DeleteAllAccessProjectSettingsSubject is the subject for the project settings access control deletion.
 	// The subject is of the form: lfx.delete_all_access.project_settings
 	DeleteAllAccessProjectSettingsSubject = "lfx.delete_all_access.project_settings"
+
+	// ProjectSettingsUpdatedSubject is the subject for project settings change events.
+	// This event is published when project settings are updated, containing both before and after states.
+	// The subject is of the form: lfx.projects-api.project_settings.updated
+	ProjectSettingsUpdatedSubject = "lfx.projects-api.project_settings.updated"
 )
 
 // NATS wildcard subjects that the project service handles messages about.