Skip to content

[SPARK-59435][UDF] Qualify UDF worker proto import paths #58738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
haiyangsun-db wants to merge 2 commits into
base: master
Choose a base branch
from
Open

[SPARK-59435][UDF] Qualify UDF worker proto import paths #58738

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5dadc56
[SPARK-59435][UDF] Qualify UDF worker proto import paths
haiyangsun-db Sep 11, 2026
328e06f
[SPARK-59435][UDF] Align UDF worker proto paths with package
haiyangsun-db Sep 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions udf/worker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,11 @@ provisioning service or daemon).
```
udf/worker/
├── proto/ -- protobuf message classes only (protobuf-java)
│ worker_spec.proto -- UDFWorkerSpecification protobuf
│ udf_message.proto -- UDF execution protocol messages (Init, UdfPayload, ...)
│ udf_service.proto -- UdfWorker gRPC service (Execute, Manage)
│ common.proto -- shared enums (UDFWorkerDataFormat, etc.)
│ └── src/main/protobuf/org/apache/spark/udf/worker/
│ worker_spec.proto -- UDFWorkerSpecification protobuf
│ udf_message.proto -- UDF execution protocol messages (Init, UdfPayload, ...)
│ udf_service.proto -- UdfWorker gRPC service (Execute, Manage)
│ common.proto -- shared enums (UDFWorkerDataFormat, etc.)
│
├── core/ -- abstract interfaces
│ WorkerDispatcher.scala -- creates sessions, manages worker lifecycle
Expand All @@ -56,7 +57,7 @@ udf/worker/
GrpcWorkerChannel.scala -- owns a Netty gRPC channel and event loop
GrpcWorkerSession.scala -- one UDF execution over an Execute stream
UnixDomainSocketTransport.scala -- selects native epoll/kqueue transport
(generated) -- UdfWorkerGrpc stubs from proto/udf_service.proto
(generated) -- UdfWorkerGrpc stubs from the UDF worker service proto
```

The `core/` package defines abstract interfaces that are independent of how
Expand All @@ -67,7 +68,7 @@ obtaining workers from a provisioning service or daemon.

The `grpc/` module owns the concrete direct dispatcher, channel and session
implementations, native Unix-domain-socket transport selection, gRPC service-stub
generation (from `proto/`'s `udf_service.proto`), and the gRPC runtime dependencies.
generation (from the UDF worker service proto above), and the gRPC runtime dependencies.
Keeping gRPC here means `proto/`, `core/`, and their consumers (`core`, `catalyst`,
`sql/core`) carry no gRPC dependency on their classpath.

Expand All @@ -81,9 +82,10 @@ Engine -> Worker: Init -> PayloadChunk* -> (DataRequest)* -> Finish (Cancel)?
Worker -> Engine: InitResponse -> (DataResponse)* -> (ErrorResponse)? -> (FinishResponse | CancelResponse)
```

See `udf/worker/proto/src/main/protobuf/udf_message.proto` for the complete
message definitions, ordering invariants, and error contract, and
`udf_service.proto` for the gRPC service.
See `udf/worker/proto/src/main/protobuf/org/apache/spark/udf/worker/udf_message.proto`
for the complete message definitions, ordering invariants, and error contract, and
`udf/worker/proto/src/main/protobuf/org/apache/spark/udf/worker/udf_service.proto`
for the gRPC service.

### Direct worker creation

Expand Down
0 ...rker/proto/src/main/protobuf/common.proto → .../org/apache/spark/udf/worker/common.proto
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...proto/src/main/protobuf/udf_message.proto → ...apache/spark/udf/worker/udf_message.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

syntax = "proto3";

import "common.proto";
import "org/apache/spark/udf/worker/common.proto";

package org.apache.spark.udf.worker;

Expand Down
2 changes: 1 addition & 1 deletion ...proto/src/main/protobuf/udf_service.proto → ...apache/spark/udf/worker/udf_service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

syntax = "proto3";

import "udf_message.proto";
import "org/apache/spark/udf/worker/udf_message.proto";

package org.apache.spark.udf.worker;

Expand Down
2 changes: 1 addition & 1 deletion ...proto/src/main/protobuf/worker_spec.proto → ...apache/spark/udf/worker/worker_spec.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

syntax = "proto3";

import "common.proto";
import "org/apache/spark/udf/worker/common.proto";

package org.apache.spark.udf.worker;

Expand Down