ashb commented on code in PR #50964: URL: https://github.com/apache/airflow/pull/50964#discussion_r2104662468
########## go-sdk/worker/runner.go: ########## @@ -0,0 +1,402 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you 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. + +package worker + +import ( + "context" + "errors" + "fmt" + "log/slog" + "os" + "path" + "runtime/debug" + "time" + + "github.com/spf13/viper" + + "github.com/apache/airflow/go-sdk/pkg/api" + "github.com/apache/airflow/go-sdk/pkg/logging" + "github.com/apache/airflow/go-sdk/pkg/sdkcontext" +) + +type ( + Registry interface { + // RegisterTask registers a new task with this task registry + // A task takes a [context.Context] and input and returns a (result, error) or just error. + // + // This method panics if taskFunc doesn't comply with the expected format or tries to register a duplicate task + RegisterTask(dagid string, fn any) + + RegisterTaskWithName(dagId, taskId string, fn any) + + LookupTask(dagId, taskId string) (task Task, exists bool) + } + + Worker interface { + Registry + + ExecuteTaskWorkload(ctx context.Context, workload api.ExecuteTaskWorkload) error + + WithServer(server string) (Worker, error) + } + + worker struct { + Registry + client api.ClientInterface + logger *slog.Logger + heartbeatInterval time.Duration + reportTimeout time.Duration + } +) + +var ErrTaskCancelledAfterFailedHeartbeat = errors.New("task cancelled after failed heartbeat") + +func New(logger *slog.Logger) Worker { + return &worker{ + logger: logger, + heartbeatInterval: HeartbeatInterval, + reportTimeout: ReportTimeout, + Registry: newRegistry(), + } +} + +const ( + HeartbeatInterval = 5 * time.Second + ReportTimeout = 10 * time.Second +) + +func (w *worker) WithServer(server string) (Worker, error) { + client, err := api.NewDefaultClient(server) + if err != nil { + return nil, err + } + return &worker{ + Registry: w.Registry, + client: client, + logger: w.logger, + heartbeatInterval: w.heartbeatInterval, + reportTimeout: w.reportTimeout, + }, nil +} + +type heartbeater struct { + heartbeatInterval time.Duration + logger *slog.Logger + taskCanceller context.CancelCauseFunc + taskLogger *slog.Logger +} + +// Run a heartbeat loop until our ctx is Done +// +// If there is an error reporting too many heartbeats then the task context will be cancelled to stop the task. +func (h *heartbeater) Run( + ctx context.Context, +) { + h.logger.DebugContext(ctx, "Starting heartbeater", "heartbeat", h.heartbeatInterval) + + workload := ctx.Value(sdkcontext.WorkloadContextKey).(api.ExecuteTaskWorkload) + client := ctx.Value(sdkcontext.ApiClientContextKey).(api.ClientInterface) + + ticker := time.NewTicker(h.heartbeatInterval) + defer ticker.Stop() + for { + select { + case <-ticker.C: + // TODO: Record when last successful heartbeat was, and fail+abort if we haven't managed to record + // one recently enough + + err := client.TaskInstances(). + Heartbeat(ctx, workload.TI.Id, &api.TIHeartbeatInfo{ + Hostname: Hostname, + Pid: os.Getpid(), + }) + if err != nil { + h.logger.InfoContext(ctx, "heartbeating", slog.Any("error", err)) + } + + var httpError *api.GeneralHTTPError + if errors.As(err, &httpError) { + resp := httpError.Response + if resp != nil && resp.StatusCode() == 404 || resp.StatusCode() == 409 { + h.logger.ErrorContext( + ctx, + "Server indicated the task shouldn't be running anymore", + "status_code", resp.StatusCode(), + "details", httpError.JSON, + ) + // Log something in the task log file too + h.taskLogger.ErrorContext( + ctx, + "Server indicated the task shouldn't be running anymore. Terminating workload", + "status_code", + resp.StatusCode(), + "details", + httpError.JSON, + ) + + h.taskCanceller(ErrTaskCancelledAfterFailedHeartbeat) + return + } + + } + case <-ctx.Done(): + // Something signaled us to stop. + return + } + } +} + +func (w *worker) ExecuteTaskWorkload(ctx context.Context, workload api.ExecuteTaskWorkload) error { + // Store the workload in the context so we can get at task id, etc, variables + taskContext, cancelTaskCtx := context.WithCancelCause( + context.WithValue(ctx, sdkcontext.WorkloadContextKey, workload), + ) + defer cancelTaskCtx(context.Canceled) + + // Task Logger is for the task's _own_ logs. We want a logger for our heartbeat etc. + logger := w.logger.With( + slog.String("dag_id", workload.TI.DagId), + slog.String("task_id", workload.TI.TaskId), + slog.String("ti_id", workload.TI.Id.String()), + ) + + workloadClient := w.client + if c, ok := workloadClient.(*api.Client); ok { + var err error + workloadClient, err = c.WithBearerToken(workload.Token) + if err != nil { + logger.ErrorContext(ctx, "Could not create client", slog.Any("error", err)) + return err + } + + c = workloadClient.(*api.Client) + c.Client.SetLogger(&logging.RestyLoggerBridge{Handler: logger.Handler(), Context: ctx}) + c.Client.SetDebug(viper.GetBool("api_client.debug")) + } + + reportStateFailed := func() error { + body := &api.TIUpdateStatePayload{} + body.FromTITerminalStatePayload(api.TITerminalStatePayload{ + State: api.TerminalStateNonSuccess(api.TerminalTIStateFailed), + EndDate: time.Now().UTC(), + }) + return workloadClient.TaskInstances().UpdateState( + ctx, + workload.TI.Id, + body, + ) + } Review Comment: This uses local variables and is called in two or three places. We can't easily place it outside this fn without creating a new type, and that didn't really seem worth it) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@airflow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
