FrankYang0529 commented on code in PR #73426: URL: https://github.com/apache/airflow/pull/73426#discussion_r4069159104
########## go-sdk/internal/contexttest/contexttest.go: ########## @@ -0,0 +1,60 @@ +// 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 contexttest provides a stand-in for airflow.Context. +// It is for the tests of the packages that airflow imports. +// +// Those tests cannot import airflow back, because that would be an import cycle, so they cannot +// declare a task function that takes an airflow.Context. +// They pass [New] to binding.RegisterTaskContext and declare [Context] parameters instead. +package contexttest + +import ( + "context" + "log/slog" + + "github.com/apache/airflow/go-sdk/sdk" +) + +// Context has the same methods as airflow.Context. +type Context struct { + context.Context + + logger *slog.Logger + client sdk.Client + ti sdk.TaskInstance + dagRun sdk.DagRun +} + +// New has the same signature as airflow.NewContext. +func New( + ctx context.Context, + logger *slog.Logger, + client sdk.Client, + ti sdk.TaskInstance, + dagRun sdk.DagRun, +) Context { + return Context{Context: ctx, logger: logger, client: client, ti: ti, dagRun: dagRun} +} + Review Comment: > Not necessary in this PR, if we really need the the `context` definition here for the `internal/bundle` test, but we can have a prek hook to make sure the signature and the implementation of `context` here is same as the `airflow.Context` as follow-up. Added it to this PR as a Go test instead of a prek hook. `TestContexttestMatchesContext` in package `airflow` uses reflect to compare the method sets of `airflow.Context` and `contexttest.Context`, and the parameters of `NewContext` and `contexttest.New`. > Another direction (but I'm not sure if it's feasible), could we define the `airflow.Context` at `internal/context:Context` then export it as `airflow.Context` so users can't tell the difference but it's better for codebase level testing, etc. The alias layout is feasible. I built it to check. `Context` moves to `internal/taskcontext`, `airflow/context.go` becomes `type Context = taskcontext.Context`, and `pkg/binding` imports the internal package directly. However, an alias does not exist at run time, so a message that prints the type with `%T` shows the internal package: ```text panic: airflow.TaskHandler("py_etl", "transform"): task function main.transform: parameter 0 is *taskcontext.Context, but airflow.Context is taken by value ``` Compiler errors still say `airflow.Context`. The second difference is in `go doc`, which prints the alias line and does not list the methods: ```console $ go doc ./airflow Context type Context = taskcontext.Context $ go doc ./airflow Context.Logger doc: no method or field Context.Logger in package ./airflow ``` I kept the current layout in this PR because the docs and the messages are what authors see. If you would rather have the simpler internals, I can switch it. WDYT? -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
