Fix the stream API to support DeploymentStatus

Author: noah

internal/pkg/store/event.go

@@ -28,6 +28,10 @@ func (s *Store) ListEventsGreaterThanTime(ctx context.Context, t time.Time) ([]*
 				WithRepo().
 				WithDeploymentStatuses()
 		}).
+		WithDeploymentStatus(func(dsq *ent.DeploymentStatusQuery) {
+			dsq.
+				WithDeployment()
+		}).
 		WithReview(func(rq *ent.ReviewQuery) {
 			rq.
 				WithUser().

internal/server/api/v1/stream/events.go

@@ -39,7 +39,7 @@ func (s *Stream) GetEvents(c *gin.Context) {
 			}
 
 			if _, err := s.i.FindPermOfRepo(ctx, d.Edges.Repo, u); err != nil {
-				s.log.Debug("Skip the event. The permission is denied.")
+				s.log.Debug("Skip the event. The permission is denied.", zap.Error(err))
 				return
 			}
 
@@ -48,6 +48,30 @@ func (s *Stream) GetEvents(c *gin.Context) {
 				Event: "deployment",
 				Data:  d,
 			}
+		case event.KindDeploymentStatus:
+			ds, err := s.i.FindDeploymentStatusByID(ctx, e.DeploymentStatusID)
+			if err != nil {
+				s.log.Error("Failed to find the deployment status.", zap.Error(err))
+				return
+			}
+
+			// Ensure that a user has access to the repository of the deployment.
+			d, err := s.i.FindDeploymentByID(ctx, ds.DeploymentID)
+			if err != nil {
+				s.log.Error("Failed to find the deployment.", zap.Error(err))
+				return
+			}
+
+			if _, err := s.i.FindPermOfRepo(ctx, d.Edges.Repo, u); err != nil {
+				s.log.Debug("Skip the event. The permission is denied.", zap.Error(err))
+				return
+			}
+
+			s.log.Debug("Dispatch a deployment_status event.", zap.Int("id", d.ID))
+			events <- &sse.Event{
+				Event: "deployment_status",
+				Data:  ds,
+			}
 
 		case event.KindReview:
 			r, err := s.i.FindReviewByID(ctx, e.ReviewID)

internal/server/api/v1/stream/interface.go

@@ -11,6 +11,7 @@ type (
 		SubscribeEvent(fn func(e *ent.Event)) error
 		UnsubscribeEvent(fn func(e *ent.Event)) error
 		FindDeploymentByID(ctx context.Context, id int) (*ent.Deployment, error)
+		FindDeploymentStatusByID(ctx context.Context, id int) (*ent.DeploymentStatus, error)
 		FindReviewByID(ctx context.Context, id int) (*ent.Review, error)
 		FindPermOfRepo(ctx context.Context, r *ent.Repo, u *ent.User) (*ent.Perm, error)
 	}

openapi/v1.yaml

@@ -1438,10 +1438,12 @@ paths:
                       type: string
                       enum:
                         - deployment
+                        - deployment_status
                         - review
                     data:
                       oneOf:
                         - $ref: '#/components/schemas/Deployment'
+                        - $ref: '#/components/schemas/DeploymentStatus'
                         - $ref: '#/components/schemas/Review'
   /sync:
     post: