adutra commented on code in PR #922: URL: https://github.com/apache/polaris/pull/922#discussion_r1983829480
########## service/common/src/main/java/org/apache/polaris/service/events/PolarisEvent.java: ########## @@ -0,0 +1,24 @@ +/* + * 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 org.apache.polaris.service.events; + +/** Represents an event emitted by Polaris. Currently there's no common data across events, hence the interface being empty, but all events still implement this interface. **/ Review Comment: I would just state that this is a marker interface, which is a quite common usage of interfaces as well. ########## service/common/src/main/java/org/apache/polaris/service/events/PolarisEventListener.java: ########## @@ -0,0 +1,49 @@ +/* + * 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 org.apache.polaris.service.events; + +/** + * Represents an event listener that can respond to notable moments during Polaris's execution. + * Users can either extend this interface and implement handlers for all events or, for ease, extend + * DefaultPolarisEventListener and only have to handle a subset of events. Event details are + * documented under the event objects themselves. + */ +public interface PolarisEventListener { + void onBeforeRequestRateLimited(BeforeRequestRateLimitedEvent event); + + void onBeforeTableCommit(BeforeTableCommitEvent event); + + void onAfterTableCommit(AfterTableCommitEvent event); Review Comment: Generally speaking, what are the guarantees about "after" commits? Are they triggered if the operation failed, or just when they succeeded? But then, do we need events for failed operations as well? I see that `AfterAttemptTaskEvent` has a `boolean success` flag, but other "after" events do not. Also, maybe the full throwable is preferable than just a boolean flag. ########## service/common/src/main/java/org/apache/polaris/service/events/PolarisEventListener.java: ########## @@ -0,0 +1,49 @@ +/* + * 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 org.apache.polaris.service.events; + +/** + * Represents an event listener that can respond to notable moments during Polaris's execution. + * Users can either extend this interface and implement handlers for all events or, for ease, extend + * DefaultPolarisEventListener and only have to handle a subset of events. Event details are + * documented under the event objects themselves. + */ +public interface PolarisEventListener { Review Comment: The "Polaris" prefix would deserve a discuss thread imho. Many components have this prefix, but not all. ########## quarkus/defaults/src/main/resources/application.properties: ########## @@ -94,6 +94,8 @@ polaris.persistence.type=in-memory polaris.file-io.type=default +polaris.events.type=default Review Comment: It seems the property name has been updated in `QuarkusPolarisEventListenerConfiguration` but hasn't been updated here. ########## service/common/src/main/java/org/apache/polaris/service/catalog/BasePolarisCatalog.java: ########## @@ -1254,6 +1267,7 @@ public void doRefresh() { if (latestLocation == null) { disableRefresh(); } else { + polarisEventListener.onBeforeRefreshTable(new BeforeTableRefreshEvent(tableIdentifier)); Review Comment: This approach of manually triggering events is fine as a starting point, but I think a more elegant approach would be to create a decorator catalog that would decorate calls to each method with before/after events. -- 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]
