Merge pull request #1801 from hashicorp/feat/app-poll-handler

feature: Queue status reports on continuous interval for applications

.changelog/1801.txt

@@ -0,0 +1,4 @@
+```release-note:improvement
+server: Continuously generate a status report for an application after the initial
+deployment or release for projects backed by a git data source
+```

internal/cli/project_apply.go

@@ -23,18 +23,20 @@ import (
 type ProjectApplyCommand struct {
  *baseCommand
 
- flagDataSource string
- flagGitURL string
- flagGitRef string
- flagGitAuthType string
- flagGitUsername string
- flagGitPassword string
- flagGitKeyPath string
- flagGitKeyPassword string
- flagFromWaypointHcl string
- flagWaypointHcl string
- flagPoll bool
- flagPollInterval string
+ flagDataSource string
+ flagGitURL string
+ flagGitRef string
+ flagGitAuthType string
+ flagGitUsername string
+ flagGitPassword string
+ flagGitKeyPath string
+ flagGitKeyPassword string
+ flagFromWaypointHcl string
+ flagWaypointHcl string
+ flagPoll bool
+ flagPollInterval string
+ flagAppStatusPoll bool
+ flagAppStatusPollInterval string
 }
 
 func (c *ProjectApplyCommand) Run(args []string) int {
@@ -171,6 +173,15 @@ func (c *ProjectApplyCommand) Run(args []string) int {
  proj.DataSourcePoll.Interval = c.flagPollInterval
  }
 
+ if c.flagAppStatusPoll {
+ if proj.StatusReportPoll == nil {
+ proj.StatusReportPoll = &pb.Project_AppStatusPoll{}
+ }
+
+ proj.StatusReportPoll.Enabled = c.flagAppStatusPoll
+ proj.StatusReportPoll.Interval = c.flagAppStatusPollInterval
+ }
+
  // If the project existing datasource is Git, then we're overriding.
  // If the existing datasource is not Git or not set, then we set it
  // to Git and create new.
@@ -454,6 +465,21 @@ func (c *ProjectApplyCommand) Flags() *flag.Sets {
  Default: "30s",
  Usage: "Interval between polling if polling is enabled.",
  })
+
+ f.BoolVar(&flag.BoolVar{
+ Name: "app-status-poll",
+ Target: &c.flagAppStatusPoll,
+ Default: false,
+ Usage: "Enable polling to continuously generate status reports for apps. " +
+ "This is only valid if a Git data source is supplied.",
+ })
+
+ f.StringVar(&flag.StringVar{
+ Name: "app-status-poll-interval",
+ Target: &c.flagAppStatusPollInterval,
+ Default: "5m",
+ Usage: "Interval between polling to generate status reports if polling is enabled.",
+ })
  })
 }
 

internal/core/app_release.go

@@ -58,12 +58,12 @@ func (a *App) Release(ctx context.Context, target *pb.Deployment) (
  "err", err)
  }
 
- unimplemeneted := false
+ unimplemented := false
  c, err := a.createReleaser(ctx, &evalCtx)
  if status.Code(err) == codes.Unimplemented {
  c = nil
  err = nil
- unimplemeneted = true
+ unimplemented = true
  }
  if err != nil {
  return nil, nil, err
@@ -80,7 +80,7 @@ func (a *App) Release(ctx context.Context, target *pb.Deployment) (
 
  if releasepb != nil {
  rpb := releasepb.(*pb.Release)
- rpb.Unimplemented = unimplemeneted
+ rpb.Unimplemented = unimplemented
  releasepb = rpb
  }
 
@@ -166,11 +166,12 @@ type releaseOperation struct {
 
 func (op *releaseOperation) Init(app *App) (proto.Message, error) {
  release := &pb.Release{
- Application: app.ref,
- Workspace: app.workspace,
- DeploymentId: op.Target.Id,
- State: pb.Operation_CREATED,
- Component: op.Target.Component,
+ Application: app.ref,
+ Workspace: app.workspace,
+ DeploymentId: op.Target.Id,
+ State: pb.Operation_CREATED,
+ Component: op.Target.Component,
+ Unimplemented: true,
  }
 
  if v := op.Component; v != nil {

internal/runner/accept.go

@@ -350,6 +350,8 @@ func (r *Runner) prepareAndExecuteJob(
  client pb.Waypoint_RunnerJobStreamClient,
  job *pb.Job,
 ) (*pb.Job_Result, error) {
+ log.Trace("preparing to execute job operation", "type", hclog.Fmt("%T", job.Operation))
+
  // Some operation types don't need to download data, execute those here.
  switch job.Operation.(type) {
  case *pb.Job_Poll:

internal/runner/operation.go

@@ -226,7 +226,7 @@ func (r *Runner) executeJob(
  return r.executeQueueProjectOp(ctx, log, job, project)
 
  case *pb.Job_StatusReport:
- return r.executeStatusReportOp(ctx, job, project)
+ return r.executeStatusReportOp(ctx, log, job, project)
 
  default:
  return nil, status.Errorf(codes.Aborted, "unknown operation %T", job.Operation)

internal/runner/operation_status_report.go

@@ -4,12 +4,14 @@ import (
  "context"
  "fmt"
 
+ "github.com/hashicorp/go-hclog"
  "github.com/hashicorp/waypoint/internal/core"
  pb "github.com/hashicorp/waypoint/internal/server/gen"
 )
 
 func (r *Runner) executeStatusReportOp(
  ctx context.Context,
+ log hclog.Logger,
  job *pb.Job,
  project *core.Project,
 ) (*pb.Job_Result, error) {
@@ -25,12 +27,17 @@ func (r *Runner) executeStatusReportOp(
  panic("operation not expected type")
  }
 
+ log = log.With("app", job.Application.Application)
+
+ log.Trace("generating status report")
  var statusReportResult *pb.StatusReport
 
  switch t := op.StatusReport.Target.(type) {
  case *pb.Job_StatusReportOp_Deployment:
+ log.Trace("starting a status report against a deployment")
  statusReportResult, err = app.DeploymentStatusReport(ctx, t.Deployment)
  case *pb.Job_StatusReportOp_Release:
+ log.Trace("starting a status report against a release")
  statusReportResult, err = app.ReleaseStatusReport(ctx, t.Release)
  default:
  err = fmt.Errorf("unknown status report target: %T", op.StatusReport.Target)

internal/runner/operation_up.go

@@ -64,7 +64,7 @@ func (r *Runner) executeUpOp(
 
  // Status Report for Deployments
  app.UI.Output("")
- result, err = r.executeStatusReportOp(ctx, &pb.Job{
+ result, err = r.executeStatusReportOp(ctx, log, &pb.Job{
  Application: job.Application,
  Operation: &pb.Job_StatusReport{
  StatusReport: &pb.Job_StatusReportOp{
@@ -105,7 +105,7 @@ func (r *Runner) executeUpOp(
  releaseResult.Release.Release != nil {
  // Status Report for Releases
  app.UI.Output("")
- result, err = r.executeStatusReportOp(ctx, &pb.Job{
+ result, err = r.executeStatusReportOp(ctx, log, &pb.Job{
  Application: job.Application,
  Operation: &pb.Job_StatusReport{
  StatusReport: &pb.Job_StatusReportOp{