Add profile ID to latest_evaluation_statuses (#3993)

Adding this information to the `latest_evaluation_statuses` table
simplifies the process of changing the profile status queries to use the
evaluation history tables instead of the old tables I am trying to
replace.

database/migrations/000078_latest_status_profile_id.down.sql

@@ -0,0 +1,18 @@
+-- Copyright 2024 Stacklok, Inc
+--
+-- Licensed under the Apache License, Version 2.0 (the "License");
+-- you may not use this file except in compliance with the License.
+-- You may obtain a copy of the License at
+--
+--      http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+
+-- introduce some denormalization to simplify a common access pattern
+-- namely: retrieving the latest rule statuses for a specific profile
+-- A future PR will backfill this column and make it NOT NULL
+ALTER TABLE latest_evaluation_statuses DROP COLUMN profile_id;

database/migrations/000078_latest_status_profile_id.up.sql

@@ -0,0 +1,19 @@
+-- Copyright 2024 Stacklok, Inc
+--
+-- Licensed under the Apache License, Version 2.0 (the "License");
+-- you may not use this file except in compliance with the License.
+-- You may obtain a copy of the License at
+--
+--      http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+
+-- introduce some denormalization to simplify a common access pattern
+-- namely: retrieving the latest rule statuses for a specific profile
+-- A future PR will backfill this column and make it NOT NULL
+ALTER TABLE latest_evaluation_statuses ADD COLUMN profile_id UUID REFERENCES profiles(id);
+CREATE INDEX idx_profile_id ON latest_evaluation_statuses(profile_id);

database/query/eval_history.sql

@@ -55,10 +55,12 @@ RETURNING id;
 -- name: UpsertLatestEvaluationStatus :exec
 INSERT INTO latest_evaluation_statuses(
     rule_entity_id,
-    evaluation_history_id
+    evaluation_history_id,
+    profile_id
 ) VALUES (
     $1,
-    $2
+    $2,
+    $3
 )
 ON CONFLICT (rule_entity_id) DO UPDATE
 SET evaluation_history_id = $2;

internal/engine/eval_status.go

@@ -197,6 +197,7 @@ func (e *executor) createOrUpdateEvalStatus(
 			ctx,
 			qtx,
 			params.Rule.ID,
+			params.Profile.ID,
 			params.EntityType,
 			entityID,
 			params.GetEvalErr(),

internal/engine/executor_test.go

@@ -325,7 +325,7 @@ default allow = true`,
 
 	historyService := mockhistory.NewMockEvaluationHistoryService(ctrl)
 	historyService.EXPECT().
-		StoreEvaluationStatus(gomock.Any(), gomock.Any(), ruleInstanceID, db.EntitiesRepository, repositoryID, gomock.Any()).
+		StoreEvaluationStatus(gomock.Any(), gomock.Any(), ruleInstanceID, profileID, db.EntitiesRepository, repositoryID, gomock.Any()).
 		Return(uuid.New(), nil)
 
 	mockStore.EXPECT().

internal/history/service.go

@@ -38,6 +38,7 @@ type EvaluationHistoryService interface {
 		ctx context.Context,
 		qtx db.Querier,
 		ruleID uuid.UUID,
+		profileID uuid.UUID,
 		entityType db.Entities,
 		entityID uuid.UUID,
 		evalError error,
@@ -64,6 +65,7 @@ func (e *evaluationHistoryService) StoreEvaluationStatus(
 	ctx context.Context,
 	qtx db.Querier,
 	ruleID uuid.UUID,
+	profileID uuid.UUID,
 	entityType db.Entities,
 	entityID uuid.UUID,
 	evalError error,
@@ -111,7 +113,7 @@ func (e *evaluationHistoryService) StoreEvaluationStatus(
 		ruleEntityID = latestRecord.RuleEntityID
 	}
 
-	evaluationID, err := e.createNewStatus(ctx, qtx, ruleEntityID, status, details)
+	evaluationID, err := e.createNewStatus(ctx, qtx, ruleEntityID, profileID, status, details)
 	if err != nil {
 		return uuid.Nil, fmt.Errorf("error while creating new evaluation status for rule/entity %s: %w", ruleEntityID, err)
 	}
@@ -123,6 +125,7 @@ func (_ *evaluationHistoryService) createNewStatus(
 	ctx context.Context,
 	qtx db.Querier,
 	ruleEntityID uuid.UUID,
+	profileID uuid.UUID,
 	status db.EvalStatusTypes,
 	details string,
 ) (uuid.UUID, error) {
@@ -142,6 +145,10 @@ func (_ *evaluationHistoryService) createNewStatus(
 		db.UpsertLatestEvaluationStatusParams{
 			RuleEntityID:        ruleEntityID,
 			EvaluationHistoryID: newEvaluationID,
+			ProfileID: uuid.NullUUID{
+				UUID:  profileID,
+				Valid: true,
+			},
 		},
 	)
 	if err != nil {

internal/history/service_test.go

@@ -114,7 +114,7 @@ func TestStoreEvaluationStatus(t *testing.T) {
 			}
 
 			service := NewEvaluationHistoryService()
-			id, err := service.StoreEvaluationStatus(ctx, store, ruleID, scenario.EntityType, entityID, errTest)
+			id, err := service.StoreEvaluationStatus(ctx, store, ruleID, profileID, scenario.EntityType, entityID, errTest)
 			if scenario.ExpectedError == "" {
 				require.Equal(t, evaluationID, id)
 				require.NoError(t, err)
@@ -795,6 +795,7 @@ func makeHistoryRow(
 
 var (
 	ruleID       = uuid.New()
+	profileID    = uuid.New()
 	entityID     = uuid.New()
 	ruleEntityID = uuid.New()
 	evaluationID = uuid.New()