-
Notifications
You must be signed in to change notification settings - Fork 387
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.
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
[#5901] feat(core): support tag event to Gravitino server #5998
Draft
TungYuChiang
wants to merge
13
commits into
apache:main
Choose a base branch
from
TungYuChiang:feature/tagEvent
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
6be252c
Add TagEvent
TungYuChiang f73dcb8
Add Create & List TagEvent
TungYuChiang d091a25
Add all tag event
TungYuChiang 08b46af
spotlessApply
TungYuChiang 7886a7c
remove redundant line
TungYuChiang 5fddeed
add unit test init for tagEvent & add createTagEvent test
TungYuChiang 87c6195
fix createTagTest and add listTagTest
TungYuChiang 80dd095
add test
TungYuChiang 1137491
Add
TungYuChiang eb810f3
Add
TungYuChiang 77aff4e
fix bugs
TungYuChiang 22722e2
Remove incorrect test
TungYuChiang 7599f64
Fix bugs of AlterTagEvent
TungYuChiang File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -21,16 +21,27 @@ | |
import java.util.Map; | ||
import org.apache.gravitino.MetadataObject; | ||
import org.apache.gravitino.exceptions.NoSuchTagException; | ||
import org.apache.gravitino.listener.api.event.AlterTagEvent; | ||
import org.apache.gravitino.listener.api.event.AlterTagFailureEvent; | ||
import org.apache.gravitino.listener.api.event.AssociateTagsForMetadataObjectEvent; | ||
import org.apache.gravitino.listener.api.event.AssociateTagsForMetadataObjectFailureEvent; | ||
import org.apache.gravitino.listener.api.event.CreateTagEvent; | ||
import org.apache.gravitino.listener.api.event.CreateTagFailureEvent; | ||
import org.apache.gravitino.listener.api.event.DeleteTagEvent; | ||
import org.apache.gravitino.listener.api.event.DeleteTagFailureEvent; | ||
import org.apache.gravitino.listener.api.event.GetTagEvent; | ||
import org.apache.gravitino.listener.api.event.GetTagFailureEvent; | ||
import org.apache.gravitino.listener.api.event.GetTagForMetadataObjectEvent; | ||
import org.apache.gravitino.listener.api.event.GetTagForMetadataObjectFailureEvent; | ||
import org.apache.gravitino.listener.api.event.ListMetadataObjectsForTagEvent; | ||
import org.apache.gravitino.listener.api.event.ListMetadataObjectsForTagFailureEvent; | ||
import org.apache.gravitino.listener.api.event.ListTagEvent; | ||
import org.apache.gravitino.listener.api.event.ListTagInfoEvent; | ||
import org.apache.gravitino.listener.api.event.ListTagsFailureEvent; | ||
import org.apache.gravitino.listener.api.event.ListTagsForMetadataObjectEvent; | ||
import org.apache.gravitino.listener.api.event.ListTagsForMetadataObjectFailureEvent; | ||
import org.apache.gravitino.listener.api.event.ListTagsInfoFailureEvent; | ||
import org.apache.gravitino.listener.api.event.ListTagsInfoForMetadataObjectEvent; | ||
import org.apache.gravitino.listener.api.event.ListTagsInfoForMetadataObjectFailureEvent; | ||
import org.apache.gravitino.listener.api.info.TagInfo; | ||
import org.apache.gravitino.tag.Tag; | ||
|
@@ -57,8 +68,9 @@ public TagEventDispatcher(EventBus eventBus, TagDispatcher dispatcher) { | |
public String[] listTags(String metalake) { | ||
// TODO: listTagsPreEvent | ||
try { | ||
// TODO: listTagsEvent | ||
return dispatcher.listTags(metalake); | ||
String[] tagNames = dispatcher.listTags(metalake); | ||
eventBus.dispatchEvent(new ListTagEvent(PrincipalUtils.getCurrentUserName(), metalake)); | ||
return tagNames; | ||
} catch (Exception e) { | ||
eventBus.dispatchEvent( | ||
new ListTagsFailureEvent(PrincipalUtils.getCurrentUserName(), metalake, e)); | ||
|
@@ -70,8 +82,10 @@ public String[] listTags(String metalake) { | |
public Tag[] listTagsInfo(String metalake) { | ||
// TODO: listTagsInfoPreEvent | ||
try { | ||
// TODO: listTagsInfoEvent | ||
return dispatcher.listTagsInfo(metalake); | ||
Tag[] tags = dispatcher.listTagsInfo(metalake); | ||
eventBus.dispatchEvent( | ||
new ListTagInfoEvent(PrincipalUtils.getCurrentUserName(), metalake, tags)); | ||
return tags; | ||
} catch (Exception e) { | ||
eventBus.dispatchEvent( | ||
new ListTagsInfoFailureEvent(PrincipalUtils.getCurrentUserName(), metalake, e)); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. could you rename |
||
|
@@ -83,8 +97,10 @@ public Tag[] listTagsInfo(String metalake) { | |
public Tag getTag(String metalake, String name) throws NoSuchTagException { | ||
// TODO: getTagPreEvent | ||
try { | ||
// TODO: getTagEvent | ||
return dispatcher.getTag(metalake, name); | ||
Tag tag = dispatcher.getTag(metalake, name); | ||
eventBus.dispatchEvent( | ||
new GetTagEvent(PrincipalUtils.getCurrentUserName(), metalake, name, tag)); | ||
return tag; | ||
} catch (Exception e) { | ||
eventBus.dispatchEvent( | ||
new GetTagFailureEvent(PrincipalUtils.getCurrentUserName(), metalake, name, e)); | ||
|
@@ -98,8 +114,13 @@ public Tag createTag( | |
TagInfo tagInfo = new TagInfo(name, comment, properties); | ||
// TODO: createTagPreEvent | ||
try { | ||
// TODO: createTagEvent | ||
return dispatcher.createTag(metalake, name, comment, properties); | ||
Tag tag = dispatcher.createTag(metalake, name, comment, properties); | ||
eventBus.dispatchEvent( | ||
new CreateTagEvent( | ||
PrincipalUtils.getCurrentUserName(), | ||
metalake, | ||
new TagInfo(tag.name(), tag.comment(), tag.properties()))); | ||
return tag; | ||
} catch (Exception e) { | ||
eventBus.dispatchEvent( | ||
new CreateTagFailureEvent(PrincipalUtils.getCurrentUserName(), metalake, tagInfo, e)); | ||
|
@@ -111,8 +132,14 @@ public Tag createTag( | |
public Tag alterTag(String metalake, String name, TagChange... changes) { | ||
// TODO: alterTagPreEvent | ||
try { | ||
// TODO: alterTagEvent | ||
return dispatcher.alterTag(metalake, name, changes); | ||
Tag tag = dispatcher.alterTag(metalake, name, changes); | ||
eventBus.dispatchEvent( | ||
new AlterTagEvent( | ||
PrincipalUtils.getCurrentUserName(), | ||
metalake, | ||
changes, | ||
new TagInfo(tag.name(), tag.comment(), tag.properties()))); | ||
return tag; | ||
} catch (Exception e) { | ||
eventBus.dispatchEvent( | ||
new AlterTagFailureEvent( | ||
|
@@ -125,8 +152,10 @@ public Tag alterTag(String metalake, String name, TagChange... changes) { | |
public boolean deleteTag(String metalake, String name) { | ||
// TODO: deleteTagPreEvent | ||
try { | ||
// TODO: deleteTagEvent | ||
return dispatcher.deleteTag(metalake, name); | ||
boolean isExists = dispatcher.deleteTag(metalake, name); | ||
eventBus.dispatchEvent( | ||
new DeleteTagEvent(PrincipalUtils.getCurrentUserName(), metalake, isExists)); | ||
return isExists; | ||
} catch (Exception e) { | ||
eventBus.dispatchEvent( | ||
new DeleteTagFailureEvent(PrincipalUtils.getCurrentUserName(), metalake, name, e)); | ||
|
@@ -138,8 +167,11 @@ public boolean deleteTag(String metalake, String name) { | |
public MetadataObject[] listMetadataObjectsForTag(String metalake, String name) { | ||
// TODO: listMetadataObjectsForTagPreEvent | ||
try { | ||
// TODO: listMetadataObjectsForTagEvent | ||
return dispatcher.listMetadataObjectsForTag(metalake, name); | ||
MetadataObject[] metadataObjects = dispatcher.listMetadataObjectsForTag(metalake, name); | ||
eventBus.dispatchEvent( | ||
new ListMetadataObjectsForTagEvent( | ||
PrincipalUtils.getCurrentUserName(), metalake, name, metadataObjects)); | ||
return metadataObjects; | ||
} catch (Exception e) { | ||
eventBus.dispatchEvent( | ||
new ListMetadataObjectsForTagFailureEvent( | ||
|
@@ -152,8 +184,11 @@ public MetadataObject[] listMetadataObjectsForTag(String metalake, String name) | |
public String[] listTagsForMetadataObject(String metalake, MetadataObject metadataObject) { | ||
// TODO: listTagsForMetadataObjectPreEvent | ||
try { | ||
// TODO: listTagsForMetadataObjectEvent | ||
return dispatcher.listTagsForMetadataObject(metalake, metadataObject); | ||
String[] tags = dispatcher.listTagsForMetadataObject(metalake, metadataObject); | ||
eventBus.dispatchEvent( | ||
new ListTagsForMetadataObjectEvent( | ||
PrincipalUtils.getCurrentUserName(), metalake, metadataObject, tags)); | ||
return tags; | ||
} catch (Exception e) { | ||
eventBus.dispatchEvent( | ||
new ListTagsForMetadataObjectFailureEvent( | ||
|
@@ -166,8 +201,11 @@ public String[] listTagsForMetadataObject(String metalake, MetadataObject metada | |
public Tag[] listTagsInfoForMetadataObject(String metalake, MetadataObject metadataObject) { | ||
// TODO: listTagsInfoForMetadataObjectPreEvent | ||
try { | ||
// TODO: listTagsInfoForMetadataObjectEvent | ||
return dispatcher.listTagsInfoForMetadataObject(metalake, metadataObject); | ||
Tag[] tags = dispatcher.listTagsInfoForMetadataObject(metalake, metadataObject); | ||
eventBus.dispatchEvent( | ||
new ListTagsInfoForMetadataObjectEvent( | ||
PrincipalUtils.getCurrentUserName(), metalake, metadataObject, tags)); | ||
return tags; | ||
} catch (Exception e) { | ||
eventBus.dispatchEvent( | ||
new ListTagsInfoForMetadataObjectFailureEvent( | ||
|
@@ -181,9 +219,18 @@ public String[] associateTagsForMetadataObject( | |
String metalake, MetadataObject metadataObject, String[] tagsToAdd, String[] tagsToRemove) { | ||
// TODO: associateTagsForMetadataObjectPreEvent | ||
try { | ||
// TODO: associateTagsForMetadataObjectEvent | ||
return dispatcher.associateTagsForMetadataObject( | ||
metalake, metadataObject, tagsToAdd, tagsToRemove); | ||
String[] associatedTags = | ||
dispatcher.associateTagsForMetadataObject( | ||
metalake, metadataObject, tagsToAdd, tagsToRemove); | ||
eventBus.dispatchEvent( | ||
new AssociateTagsForMetadataObjectEvent( | ||
PrincipalUtils.getCurrentUserName(), | ||
metalake, | ||
metadataObject, | ||
tagsToAdd, | ||
tagsToRemove, | ||
associatedTags)); | ||
return associatedTags; | ||
} catch (Exception e) { | ||
eventBus.dispatchEvent( | ||
new AssociateTagsForMetadataObjectFailureEvent( | ||
|
@@ -201,8 +248,11 @@ public String[] associateTagsForMetadataObject( | |
public Tag getTagForMetadataObject(String metalake, MetadataObject metadataObject, String name) { | ||
// TODO: getTagForMetadataObjectPreEvent | ||
try { | ||
// TODO: getTagForMetadataObjectEvent | ||
return dispatcher.getTagForMetadataObject(metalake, metadataObject, name); | ||
Tag tag = dispatcher.getTagForMetadataObject(metalake, metadataObject, name); | ||
eventBus.dispatchEvent( | ||
new GetTagForMetadataObjectEvent( | ||
PrincipalUtils.getCurrentUserName(), metalake, metadataObject, name, tag)); | ||
return tag; | ||
} catch (Exception e) { | ||
eventBus.dispatchEvent( | ||
new GetTagForMetadataObjectFailureEvent( | ||
|
79 changes: 79 additions & 0 deletions
79
core/src/main/java/org/apache/gravitino/listener/api/event/AlterTagEvent.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
/* | ||
* 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.gravitino.listener.api.event; | ||
|
||
import org.apache.gravitino.NameIdentifier; | ||
import org.apache.gravitino.annotation.DeveloperApi; | ||
import org.apache.gravitino.listener.api.info.TagInfo; | ||
import org.apache.gravitino.tag.TagChange; | ||
|
||
/** Represents an event triggered upon the successful alteration of a tag. */ | ||
@DeveloperApi | ||
public final class AlterTagEvent extends TagEvent { | ||
private final TagInfo updatedTagInfo; | ||
private final TagChange[] tagChanges; | ||
|
||
/** | ||
* Constructs an instance of {@code AlterTagEvent}, encapsulating the key details about the | ||
* successful alteration of a tag. | ||
* | ||
* @param user The username of the individual responsible for initiating the tag alteration. | ||
* @param metalake The metalake from which the tag is being altered. | ||
* @param tagChanges An array of {@link TagChange} objects representing the specific changes | ||
* applied to the tag during the alteration process. | ||
* @param updatedTagInfo The post-alteration state of the tag. | ||
*/ | ||
public AlterTagEvent( | ||
String user, String metalake, TagChange[] tagChanges, TagInfo updatedTagInfo) { | ||
super(user, NameIdentifier.of(metalake)); | ||
this.tagChanges = tagChanges; | ||
this.updatedTagInfo = updatedTagInfo; | ||
} | ||
|
||
/** | ||
* Retrieves the final state of the tag as it was returned to the user after successful | ||
* alteration. | ||
* | ||
* @return A {@link TagInfo} instance encapsulating the comprehensive details of the newly altered | ||
* tag. | ||
*/ | ||
public TagInfo updatedTagInfo() { | ||
return updatedTagInfo; | ||
} | ||
|
||
/** | ||
* Retrieves the specific changes that were made to the tag during the alteration process. | ||
* | ||
* @return An array of {@link TagChange} objects detailing each modification applied to the tag. | ||
*/ | ||
public TagChange[] tagChanges() { | ||
return tagChanges; | ||
} | ||
|
||
/** | ||
* Returns the type of operation. | ||
* | ||
* @return the operation type. | ||
*/ | ||
@Override | ||
public OperationType operationType() { | ||
return OperationType.ALTER_TAG; | ||
} | ||
} |
116 changes: 116 additions & 0 deletions
116
...ain/java/org/apache/gravitino/listener/api/event/AssociateTagsForMetadataObjectEvent.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
/* | ||
* 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.gravitino.listener.api.event; | ||
|
||
import org.apache.gravitino.MetadataObject; | ||
import org.apache.gravitino.NameIdentifier; | ||
import org.apache.gravitino.annotation.DeveloperApi; | ||
|
||
/** | ||
* Represents an event that is triggered upon successfully associating tags with a metadata object. | ||
*/ | ||
@DeveloperApi | ||
public final class AssociateTagsForMetadataObjectEvent extends TagEvent { | ||
private final String metalake; | ||
private final MetadataObject metadataObject; | ||
private final String[] tagsToAdd; | ||
private final String[] tagsToRemove; | ||
private final String[] associatedTags; | ||
|
||
/** | ||
* Constructs an instance of {@code AssociateTagsForMetadataObjectEvent}. | ||
* | ||
* @param user The username of the individual who initiated the tag association. | ||
* @param metalake The metalake from which the tags were associated. | ||
* @param metadataObject The metadata object with which the tags were associated. | ||
* @param tagsToAdd The tags that were added. | ||
* @param tagsToRemove The tags that were removed. | ||
* @param associatedTags The resulting list of associated tags after the operation. | ||
*/ | ||
public AssociateTagsForMetadataObjectEvent( | ||
String user, | ||
String metalake, | ||
MetadataObject metadataObject, | ||
String[] tagsToAdd, | ||
String[] tagsToRemove, | ||
String[] associatedTags) { | ||
super(user, NameIdentifier.of(metalake)); | ||
this.metalake = metalake; | ||
this.metadataObject = metadataObject; | ||
this.tagsToAdd = tagsToAdd; | ||
this.tagsToRemove = tagsToRemove; | ||
this.associatedTags = associatedTags; | ||
} | ||
|
||
/** | ||
* Provides the metalake associated with this event. | ||
* | ||
* @return The metalake from which the tags were associated. | ||
*/ | ||
public String metalake() { | ||
return metalake; | ||
} | ||
|
||
/** | ||
* Provides the metadata object associated with this event. | ||
* | ||
* @return The {@link MetadataObject} with which the tags were associated. | ||
*/ | ||
public MetadataObject metadataObject() { | ||
return metadataObject; | ||
} | ||
|
||
/** | ||
* Provides the tags that were added in this operation. | ||
* | ||
* @return An array of tag names that were added. | ||
*/ | ||
public String[] tagsToAdd() { | ||
return tagsToAdd; | ||
} | ||
|
||
/** | ||
* Provides the tags that were removed in this operation. | ||
* | ||
* @return An array of tag names that were removed. | ||
*/ | ||
public String[] tagsToRemove() { | ||
return tagsToRemove; | ||
} | ||
|
||
/** | ||
* Provides the resulting list of associated tags after the operation. | ||
* | ||
* @return An array of tag names representing the associated tags. | ||
*/ | ||
public String[] associatedTags() { | ||
return associatedTags; | ||
} | ||
|
||
/** | ||
* Returns the type of operation. | ||
* | ||
* @return The operation type. | ||
*/ | ||
@Override | ||
public OperationType operationType() { | ||
return OperationType.ASSOCIATE_TAGS_FOR_METADATA_OBJECT; | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could you rename ListTagsFailureEvent to ListTagFailureEvent to keep consistent with other list event?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@FANNG1 , Would it be better to rename
ListTagEvent
toListTagsEvent
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes,
ListTagsEvent
is better