[#9536] feat(core): Add event listener for function operations by laserninja · Pull Request #10499 · apache/gravitino

laserninja · 2026-03-22T18:56:22Z

What changes were proposed in this pull request?

Add event/listener hooks for function CRUD operations (register, get, alter, drop, list). This follows the same pattern as existing entity event dispatchers (Table, Model, etc.).

Why are the changes needed?

New files:

FunctionInfo: read-only function info for event listeners
FunctionEvent/FunctionFailureEvent/FunctionPreEvent: base event classes
Register/Get/Alter/Drop/ListFunction Event/PreEvent/FailureEvent classes
FunctionEventDispatcher: decorates FunctionDispatcher with event dispatching
TestFunctionEvent: unit tests for all function events

Modified files:

OperationType: added REGISTER/GET/ALTER/DROP/LIST_FUNCTION
GravitinoEnv: wired FunctionEventDispatcher into dispatcher chain

Closes #9536

Does this PR introduce any user-facing change?

No

How was this patch tested?

All tests passed

github-actions · 2026-03-23T04:19:02Z

Code Coverage Report

Overall Project	64.96% `+0.14%`	🟢
Files changed	78.31%	🟢

Module	Coverage
aliyun	1.73%	🔴
api	47.14%	🟢
authorization-common	85.96%	🟢
aws	1.1%	🔴
azure	2.6%	🔴
catalog-common	10.0%	🔴
catalog-fileset	80.02%	🟢
catalog-hive	80.98%	🟢
catalog-jdbc-clickhouse	79.06%	🟢
catalog-jdbc-common	42.89%	🟢
catalog-jdbc-doris	80.28%	🟢
catalog-jdbc-hologres	54.03%	🟢
catalog-jdbc-mysql	79.23%	🟢
catalog-jdbc-oceanbase	78.38%	🟢
catalog-jdbc-postgresql	82.05%	🟢
catalog-jdbc-starrocks	78.27%	🟢
catalog-kafka	77.01%	🟢
catalog-lakehouse-generic	45.07%	🟢
catalog-lakehouse-hudi	79.1%	🟢
catalog-lakehouse-iceberg	87.15%	🟢
catalog-lakehouse-paimon	77.71%	🟢
catalog-model	77.72%	🟢
cli	44.51%	🟢
client-java	77.83%	🟢
common	49.42%	🟢
core	81.03% `-0.09%`	🟢
filesystem-hadoop3	76.97%	🟢
flink	38.86%	🔴
flink-runtime	0.0%	🔴
gcp	14.2%	🔴
hadoop-common	10.39%	🔴
hive-metastore-common	45.82%	🟢
iceberg-common	50.21%	🟢
iceberg-rest-server	66.51%	🟢
integration-test-common	0.0%	🔴
jobs	66.17%	🟢
lance-common	23.88%	🔴
lance-rest-server	57.84%	🟢
lineage	53.02%	🟢
optimizer	82.87%	🟢
optimizer-api	21.95%	🔴
server	85.62%	🟢
server-common	70.14%	🟢
spark	32.79%	🔴
spark-common	39.09%	🔴
trino-connector	31.62%	🔴

Files

Module	File	Coverage
core	OperationType.java	100.0%	🟢
	AlterFunctionEvent.java	100.0%	🟢
	AlterFunctionFailureEvent.java	100.0%	🟢
	AlterFunctionPreEvent.java	100.0%	🟢
	DropFunctionEvent.java	100.0%	🟢
	DropFunctionFailureEvent.java	100.0%	🟢
	DropFunctionPreEvent.java	100.0%	🟢
	FunctionEvent.java	100.0%	🟢
	FunctionFailureEvent.java	100.0%	🟢
	FunctionPreEvent.java	100.0%	🟢
	GetFunctionEvent.java	100.0%	🟢
	GetFunctionFailureEvent.java	100.0%	🟢
	GetFunctionPreEvent.java	100.0%	🟢
	ListFunctionEvent.java	100.0%	🟢
	ListFunctionFailureEvent.java	100.0%	🟢
	ListFunctionInfosEvent.java	100.0%	🟢
	ListFunctionPreEvent.java	100.0%	🟢
	RegisterFunctionEvent.java	100.0%	🟢
	RegisterFunctionFailureEvent.java	100.0%	🟢
	RegisterFunctionPreEvent.java	100.0%	🟢
	CompatibilityUtils.java	98.33%	🟢
	FunctionEventDispatcher.java	98.28%	🟢
	FunctionInfo.java	96.0%	🟢
	AuditLog.java	95.0%	🟢
	CatalogEventDispatcher.java	91.18%	🟢
	MetalakeEventDispatcher.java	91.07%	🟢
	GravitinoEnv.java	10.91%	🔴

mchades · 2026-03-24T01:56:20Z

Hi @laserninja, thanks for your contributions—is this PR ready for review?

laserninja · 2026-03-24T02:20:24Z

I had a question but I'll save it for after the review since it might be redundant

Add event/listener hooks for function CRUD operations (register, get, alter, drop, list). This follows the same pattern as existing entity event dispatchers (Table, Model, etc.). New files: - FunctionInfo: read-only function info for event listeners - FunctionEvent/FunctionFailureEvent/FunctionPreEvent: base event classes - Register/Get/Alter/Drop/ListFunction Event/PreEvent/FailureEvent classes - FunctionEventDispatcher: decorates FunctionDispatcher with event dispatching - TestFunctionEvent: unit tests for all function events Modified files: - OperationType: added REGISTER/GET/ALTER/DROP/LIST_FUNCTION - GravitinoEnv: wired FunctionEventDispatcher into dispatcher chain Closes apache#9536

Copilot

Pull request overview

Adds event/listener hooks around function catalog operations by introducing function-specific event types and wiring a FunctionEventDispatcher into the core dispatcher chain, aligning function CRUD/list operations with the existing event-dispatching patterns used for other entities (e.g., tables/models).

Changes:

Introduced FunctionEventDispatcher to emit pre/success/failure events for function operations and delegate to the underlying FunctionDispatcher.
Added function event/info types (FunctionInfo, FunctionEvent/FunctionPreEvent/FunctionFailureEvent, and operation-specific event classes) plus new OperationType entries.
Added unit tests validating function event dispatch for success/failure paths.

Reviewed changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
core/src/test/java/org/apache/gravitino/listener/api/event/TestFunctionEvent.java	Adds unit tests for function operation events (success/failure).
core/src/main/java/org/apache/gravitino/listener/FunctionEventDispatcher.java	Decorator that dispatches function pre/post/failure events around function operations.
core/src/main/java/org/apache/gravitino/listener/api/info/FunctionInfo.java	Read-only function info DTO used in events.
core/src/main/java/org/apache/gravitino/listener/api/event/RegisterFunctionPreEvent.java	Pre-event for register function.
core/src/main/java/org/apache/gravitino/listener/api/event/RegisterFunctionFailureEvent.java	Failure-event for register function.
core/src/main/java/org/apache/gravitino/listener/api/event/RegisterFunctionEvent.java	Success-event for register function.
core/src/main/java/org/apache/gravitino/listener/api/event/OperationType.java	Adds function operation types.
core/src/main/java/org/apache/gravitino/listener/api/event/ListFunctionPreEvent.java	Pre-event for listing functions.
core/src/main/java/org/apache/gravitino/listener/api/event/ListFunctionFailureEvent.java	Failure-event for listing functions.
core/src/main/java/org/apache/gravitino/listener/api/event/ListFunctionEvent.java	Success-event for listing functions.
core/src/main/java/org/apache/gravitino/listener/api/event/GetFunctionPreEvent.java	Pre-event for get function.
core/src/main/java/org/apache/gravitino/listener/api/event/GetFunctionFailureEvent.java	Failure-event for get function.
core/src/main/java/org/apache/gravitino/listener/api/event/GetFunctionEvent.java	Success-event for get function.
core/src/main/java/org/apache/gravitino/listener/api/event/FunctionPreEvent.java	Base pre-event type for function operations.
core/src/main/java/org/apache/gravitino/listener/api/event/FunctionFailureEvent.java	Base failure-event type for function operations.
core/src/main/java/org/apache/gravitino/listener/api/event/FunctionEvent.java	Base success-event type for function operations.
core/src/main/java/org/apache/gravitino/listener/api/event/DropFunctionPreEvent.java	Pre-event for drop function.
core/src/main/java/org/apache/gravitino/listener/api/event/DropFunctionFailureEvent.java	Failure-event for drop function.
core/src/main/java/org/apache/gravitino/listener/api/event/DropFunctionEvent.java	Success-event for drop function.
core/src/main/java/org/apache/gravitino/listener/api/event/AlterFunctionPreEvent.java	Pre-event for alter function.
core/src/main/java/org/apache/gravitino/listener/api/event/AlterFunctionFailureEvent.java	Failure-event for alter function.
core/src/main/java/org/apache/gravitino/listener/api/event/AlterFunctionEvent.java	Success-event for alter function.
core/src/main/java/org/apache/gravitino/GravitinoEnv.java	Wires `FunctionEventDispatcher` into the function dispatcher chain.

core/src/main/java/org/apache/gravitino/listener/FunctionEventDispatcher.java

core/src/test/java/org/apache/gravitino/listener/api/event/TestFunctionEvent.java

core/src/main/java/org/apache/gravitino/listener/api/event/function/AlterFunctionEvent.java

… and add LIST_FUNCTION_INFOS

core/src/main/java/org/apache/gravitino/listener/FunctionEventDispatcher.java

core/src/main/java/org/apache/gravitino/listener/api/event/function/AlterFunctionPreEvent.java

core/src/main/java/org/apache/gravitino/listener/api/info/FunctionInfo.java

core/src/main/java/org/apache/gravitino/listener/api/event/function/AlterFunctionEvent.java

mchades

you should also update the doc

gravitino/docs/gravitino-server-config.md

Line 169 in bbb14ad

#### Event

…ate docs - Extract PrincipalUtils.getCurrentUserName() to local variable 'user' in all FunctionEventDispatcher methods for consistency with ModelEventDispatcher - Use Arrays.copyOf() instead of .clone() in AlterFunctionEvent and AlterFunctionFailureEvent constructors - Add defensive copy in AlterFunctionPreEvent constructor - Return defensive copies from functionChanges() getters in AlterFunctionEvent, AlterFunctionFailureEvent, AlterFunctionPreEvent - Return defensive copy from definitions() getter in FunctionInfo - Add function event entries to gravitino-server-config.md docs

laserninja · 2026-03-24T18:33:40Z

Updated the doc. Thanks for the review!

docs/gravitino-server-config.md

mchades

LGTM. Thanks for your contributions!

I'll merge it into the main branch after the CI passes

mchades · 2026-03-26T12:48:47Z

BTW, please update the PR description to match the format.

laserninja · 2026-03-26T17:05:13Z

Done, thanks

…pache#10499) ### What changes were proposed in this pull request? Add event/listener hooks for function CRUD operations (register, get, alter, drop, list). This follows the same pattern as existing entity event dispatchers (Table, Model, etc.). ### Why are the changes needed? New files: - FunctionInfo: read-only function info for event listeners - FunctionEvent/FunctionFailureEvent/FunctionPreEvent: base event classes - Register/Get/Alter/Drop/ListFunction Event/PreEvent/FailureEvent classes - FunctionEventDispatcher: decorates FunctionDispatcher with event dispatching - TestFunctionEvent: unit tests for all function events Modified files: - OperationType: added REGISTER/GET/ALTER/DROP/LIST_FUNCTION - GravitinoEnv: wired FunctionEventDispatcher into dispatcher chain Closes apache#9536 ### Does this PR introduce _any_ user-facing change? No ### How was this patch tested? All tests passed

laserninja marked this pull request as ready for review March 24, 2026 02:19

mchades requested a review from Copilot March 24, 2026 02:36

Copilot started reviewing on behalf of mchades March 24, 2026 02:37 View session

mchades force-pushed the event-listener-udf-adaptation branch from a07f67b to 180c0b0 Compare March 24, 2026 02:37

Copilot AI reviewed Mar 24, 2026

View reviewed changes

core/src/main/java/org/apache/gravitino/listener/FunctionEventDispatcher.java Show resolved Hide resolved

core/src/test/java/org/apache/gravitino/listener/api/event/TestFunctionEvent.java Show resolved Hide resolved

mchades reviewed Mar 24, 2026

View reviewed changes

core/src/main/java/org/apache/gravitino/listener/api/event/function/AlterFunctionEvent.java Show resolved Hide resolved

[apache#9536] refactor: Move function events to dedicated sub-package…

27961a7

… and add LIST_FUNCTION_INFOS

mchades reviewed Mar 24, 2026

View reviewed changes

mchades reviewed Mar 25, 2026

View reviewed changes

docs/gravitino-server-config.md Outdated Show resolved Hide resolved

Fix Since Version to 1.3.0 for function event docs

394ddaa

laserninja requested a review from mchades March 25, 2026 16:30

mchades approved these changes Mar 26, 2026

View reviewed changes

mchades assigned laserninja Mar 26, 2026

mchades merged commit 6c0e75a into apache:main Mar 27, 2026
24 checks passed

Conversation

laserninja commented Mar 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changes were proposed in this pull request?

Why are the changes needed?

Does this PR introduce any user-facing change?

How was this patch tested?

Uh oh!

github-actions bot commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Coverage Report

Uh oh!

mchades commented Mar 24, 2026

Uh oh!

laserninja commented Mar 24, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mchades left a comment

Choose a reason for hiding this comment

Uh oh!

laserninja commented Mar 24, 2026

Uh oh!

Uh oh!

mchades left a comment

Choose a reason for hiding this comment

Uh oh!

mchades commented Mar 26, 2026

Uh oh!

laserninja commented Mar 26, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

laserninja commented Mar 22, 2026 •

edited

Loading

github-actions bot commented Mar 23, 2026 •

edited

Loading