Exposes ServiceContext in events (#6002)

This change exposes the new ServiceContext in all service lifecycle events.
This will provide extension developers more information during lifecycle events that includes all the artifacts generated for the given command/workflow.

Author: wbreza

cli/azd/cmd/env.go

@@ -1127,8 +1127,9 @@ func (ef *envRefreshAction) Run(ctx context.Context) (*actions.ActionResult, err
 
 	for _, svc := range servicesStable {
 		eventArgs := project.ServiceLifecycleEventArgs{
-			Project: ef.projectConfig,
-			Service: svc,
+			Project:        ef.projectConfig,
+			Service:        svc,
+			ServiceContext: project.NewServiceContext(),
 			Args: map[string]any{
 				"bicepOutput": state.Outputs,
 			},

cli/azd/cmd/middleware/hooks_test.go

@@ -272,8 +272,9 @@ func Test_ServiceHooks_Registered(t *testing.T) {
 
 	nextFn := func(ctx context.Context) (*actions.ActionResult, error) {
 		err := serviceConfig.Invoke(ctx, project.ServiceEventDeploy, project.ServiceLifecycleEventArgs{
-			Project: &projectConfig,
-			Service: serviceConfig,
+			Project:        &projectConfig,
+			Service:        serviceConfig,
+			ServiceContext: project.NewServiceContext(),
 		}, func() error {
 			return nil
 		})

cli/azd/extensions/microsoft.azd.demo/internal/cmd/listen.go

@@ -61,26 +61,20 @@ func newListenCommand() *cobra.Command {
 				}).
 				WithServiceEventHandler("prepackage", func(ctx context.Context, args *azdext.ServiceEventArgs) error {
 					for i := 1; i <= 20; i++ {
-						fmt.Printf("%d. Doing important prepackage service work in extension...\n", i)
+						fmt.Printf("Service: %s, Artifacts: %d\n", args.Service.Name, len(args.ServiceContext.Package))
 						time.Sleep(250 * time.Millisecond)
 					}
 
 					return nil
-				}, &azdext.ServerEventOptions{
-					// Optionally filter your subscription by service host and/or language
-					Host: "containerapp",
-				}).
+				}, nil).
 				WithServiceEventHandler("postpackage", func(ctx context.Context, args *azdext.ServiceEventArgs) error {
 					for i := 1; i <= 20; i++ {
-						fmt.Printf("%d. Doing important postpackage service work in extension...\n", i)
+						fmt.Printf("Service: %s, Artifacts: %d\n", args.Service.Name, len(args.ServiceContext.Package))
 						time.Sleep(250 * time.Millisecond)
 					}
 
 					return nil
-				}, &azdext.ServerEventOptions{
-					// Optionally filter your subscription by service host and/or language
-					Host: "containerapp",
-				})
+				}, nil)
 
 			// Start listening for events
 			// This is a blocking call and will not return until the server connection is closed.

cli/azd/grpc/proto/event.proto

@@ -65,6 +65,8 @@ message InvokeServiceHandler {
   ProjectConfig project = 2;
   // Specific service configuration.
   ServiceConfig service = 3;
+  // Service context with artifacts from all lifecycle phases.
+  ServiceContext service_context = 4;
 }
 
 // Client sends status updates for project events

cli/azd/internal/cmd/provision.go

@@ -398,8 +398,9 @@ func (p *ProvisionAction) Run(ctx context.Context) (*actions.ActionResult, error
 
 		for _, svc := range servicesStable {
 			eventArgs := project.ServiceLifecycleEventArgs{
-				Project: p.projectConfig,
-				Service: svc,
+				Project:        p.projectConfig,
+				Service:        svc,
+				ServiceContext: project.NewServiceContext(),
 				Args: map[string]any{
 					"bicepOutput": deployResult.Deployment.Outputs,
 				},

cli/azd/internal/grpcserver/event_service.go

@@ -160,7 +160,7 @@ func (s *eventService) createProjectEventHandler(
 		defer s.syncExtensionOutput(ctx, extension, previewTitle)()
 
 		// Send the invoke message.
-		if err := s.sendProjectInvokeMessage(stream, eventName, args.Project); err != nil {
+		if err := s.sendProjectInvokeMessage(stream, eventName, args); err != nil {
 			return err
 		}
 
@@ -172,7 +172,7 @@ func (s *eventService) createProjectEventHandler(
 func (s *eventService) sendProjectInvokeMessage(
 	stream grpc.BidiStreamingServer[azdext.EventMessage, azdext.EventMessage],
 	eventName string,
-	proj *project.ProjectConfig,
+	args project.ProjectLifecycleEventArgs,
 ) error {
 	resolver := noEnvResolver
 	env, err := s.lazyEnv.GetValue()
@@ -181,7 +181,7 @@ func (s *eventService) sendProjectInvokeMessage(
 	}
 
 	var protoProjectConfig *azdext.ProjectConfig
-	if err := mapper.WithResolver(resolver).Convert(proj, &protoProjectConfig); err != nil {
+	if err := mapper.WithResolver(resolver).Convert(args.Project, &protoProjectConfig); err != nil {
 		return err
 	}
 
@@ -270,7 +270,7 @@ func (s *eventService) createServiceEventHandler(
 		defer s.syncExtensionOutput(ctx, extension, previewTitle)()
 
 		// Send the invoke message.
-		if err := s.sendServiceInvokeMessage(stream, eventName, args.Project, args.Service); err != nil {
+		if err := s.sendServiceInvokeMessage(stream, eventName, args); err != nil {
 			return err
 		}
 
@@ -282,31 +282,38 @@ func (s *eventService) createServiceEventHandler(
 func (s *eventService) sendServiceInvokeMessage(
 	stream grpc.BidiStreamingServer[azdext.EventMessage, azdext.EventMessage],
 	eventName string,
-	proj *project.ProjectConfig,
-	svc *project.ServiceConfig,
+	args project.ServiceLifecycleEventArgs,
 ) error {
 	resolver := noEnvResolver
 	env, err := s.lazyEnv.GetValue()
 	if err == nil && env != nil {
 		resolver = env.Getenv
 	}
 
+	objectMapper := mapper.WithResolver(resolver)
+
 	var protoProjectConfig *azdext.ProjectConfig
-	if err := mapper.WithResolver(resolver).Convert(proj, &protoProjectConfig); err != nil {
+	if err := objectMapper.Convert(args.Project, &protoProjectConfig); err != nil {
 		return err
 	}
 
 	var protoServiceConfig *azdext.ServiceConfig
-	if err := mapper.WithResolver(resolver).Convert(svc, &protoServiceConfig); err != nil {
+	if err := objectMapper.Convert(args.Service, &protoServiceConfig); err != nil {
+		return err
+	}
+
+	var protoServiceContext *azdext.ServiceContext
+	if err := objectMapper.Convert(args.ServiceContext, &protoServiceContext); err != nil {
 		return err
 	}
 
 	return stream.Send(&azdext.EventMessage{
 		MessageType: &azdext.EventMessage_InvokeServiceHandler{
 			InvokeServiceHandler: &azdext.InvokeServiceHandler{
-				EventName: eventName,
-				Project:   protoProjectConfig,
-				Service:   protoServiceConfig,
+				EventName:      eventName,
+				Project:        protoProjectConfig,
+				Service:        protoServiceConfig,
+				ServiceContext: protoServiceContext,
 			},
 		},
 	})