|
| 1 | +package com.linkedin.metadata.entity.versioning.sideeffects; |
| 2 | + |
| 3 | +import static com.linkedin.metadata.Constants.*; |
| 4 | + |
| 5 | +import com.datahub.util.RecordUtils; |
| 6 | +import com.linkedin.common.VersionProperties; |
| 7 | +import com.linkedin.common.urn.Urn; |
| 8 | +import com.linkedin.data.template.RecordTemplate; |
| 9 | +import com.linkedin.entity.Aspect; |
| 10 | +import com.linkedin.events.metadata.ChangeType; |
| 11 | +import com.linkedin.metadata.aspect.RetrieverContext; |
| 12 | +import com.linkedin.metadata.aspect.batch.ChangeMCP; |
| 13 | +import com.linkedin.metadata.aspect.batch.MCLItem; |
| 14 | +import com.linkedin.metadata.aspect.batch.MCPItem; |
| 15 | +import com.linkedin.metadata.aspect.patch.GenericJsonPatch; |
| 16 | +import com.linkedin.metadata.aspect.patch.PatchOperationType; |
| 17 | +import com.linkedin.metadata.aspect.plugins.config.AspectPluginConfig; |
| 18 | +import com.linkedin.metadata.aspect.plugins.hooks.MCPSideEffect; |
| 19 | +import com.linkedin.metadata.entity.ebean.batch.ChangeItemImpl; |
| 20 | +import com.linkedin.metadata.entity.ebean.batch.PatchItemImpl; |
| 21 | +import com.linkedin.metadata.models.AspectSpec; |
| 22 | +import com.linkedin.metadata.models.EntitySpec; |
| 23 | +import com.linkedin.metadata.utils.EntityKeyUtils; |
| 24 | +import com.linkedin.versionset.VersionSetProperties; |
| 25 | +import java.util.Collection; |
| 26 | +import java.util.List; |
| 27 | +import java.util.stream.Stream; |
| 28 | +import javax.annotation.Nonnull; |
| 29 | +import javax.annotation.Nullable; |
| 30 | +import lombok.Getter; |
| 31 | +import lombok.Setter; |
| 32 | +import lombok.experimental.Accessors; |
| 33 | +import lombok.extern.slf4j.Slf4j; |
| 34 | + |
| 35 | +/** |
| 36 | + * Side effect that updates the isLatest property for the referenced versioned entity's Version |
| 37 | + * Properties aspect. |
| 38 | + */ |
| 39 | +@Slf4j |
| 40 | +@Getter |
| 41 | +@Setter |
| 42 | +@Accessors(chain = true) |
| 43 | +public class VersionPropertiesSideEffect extends MCPSideEffect { |
| 44 | + @Nonnull private AspectPluginConfig config; |
| 45 | + |
| 46 | + @Override |
| 47 | + protected Stream<ChangeMCP> applyMCPSideEffect( |
| 48 | + Collection<ChangeMCP> changeMCPS, @Nonnull RetrieverContext retrieverContext) { |
| 49 | + return changeMCPS.stream().flatMap(item -> processMCP(item, retrieverContext)); |
| 50 | + } |
| 51 | + |
| 52 | + @Override |
| 53 | + protected Stream<MCPItem> postMCPSideEffect( |
| 54 | + Collection<MCLItem> mclItems, @Nonnull RetrieverContext retrieverContext) { |
| 55 | + return Stream.of(); |
| 56 | + } |
| 57 | + |
| 58 | + private static Stream<ChangeMCP> processMCP( |
| 59 | + ChangeMCP changeMCP, @Nonnull RetrieverContext retrieverContext) { |
| 60 | + Urn entityUrn = changeMCP.getUrn(); |
| 61 | + |
| 62 | + if (!VERSION_PROPERTIES_ASPECT_NAME.equals(changeMCP.getAspectName())) { |
| 63 | + return Stream.empty(); |
| 64 | + } |
| 65 | + |
| 66 | + VersionProperties versionProperties = changeMCP.getAspect(VersionProperties.class); |
| 67 | + if (versionProperties == null) { |
| 68 | + log.error("Unable to process version properties for urn: {}", changeMCP.getUrn()); |
| 69 | + return Stream.empty(); |
| 70 | + } |
| 71 | + |
| 72 | + Urn versionSetUrn = versionProperties.getVersionSet(); |
| 73 | + Aspect versionSetPropertiesAspect = |
| 74 | + retrieverContext |
| 75 | + .getAspectRetriever() |
| 76 | + .getLatestAspectObject(versionSetUrn, VERSION_SET_PROPERTIES_ASPECT_NAME); |
| 77 | + if (versionSetPropertiesAspect == null) { |
| 78 | + return createVersionSet(versionProperties, changeMCP, retrieverContext); |
| 79 | + } |
| 80 | + |
| 81 | + // Version set exists -- only update if there is a new latest |
| 82 | + VersionSetProperties versionSetProperties = |
| 83 | + RecordUtils.toRecordTemplate(VersionSetProperties.class, versionSetPropertiesAspect.data()); |
| 84 | + Urn prevLatest = versionSetProperties.getLatest(); |
| 85 | + if (prevLatest.equals(entityUrn)) { |
| 86 | + return Stream.empty(); |
| 87 | + } |
| 88 | + |
| 89 | + VersionProperties prevLatestVersionProperties = null; |
| 90 | + Aspect prevLatestVersionPropertiesAspect = |
| 91 | + retrieverContext |
| 92 | + .getAspectRetriever() |
| 93 | + .getLatestAspectObject(prevLatest, VERSION_PROPERTIES_ASPECT_NAME); |
| 94 | + if (prevLatestVersionPropertiesAspect != null) { |
| 95 | + prevLatestVersionProperties = |
| 96 | + RecordUtils.toRecordTemplate( |
| 97 | + VersionProperties.class, prevLatestVersionPropertiesAspect.data()); |
| 98 | + if (versionProperties.getSortId().compareTo(prevLatestVersionProperties.getSortId()) <= 0) { |
| 99 | + return Stream.empty(); |
| 100 | + } |
| 101 | + } |
| 102 | + |
| 103 | + // New version properties is the new latest |
| 104 | + return updateVersionSetLatest( |
| 105 | + versionProperties, prevLatestVersionProperties, prevLatest, changeMCP, retrieverContext); |
| 106 | + } |
| 107 | + |
| 108 | + private static Stream<ChangeMCP> createVersionSet( |
| 109 | + @Nonnull VersionProperties versionProperties, |
| 110 | + ChangeMCP changeMCP, |
| 111 | + @Nonnull RetrieverContext retrieverContext) { |
| 112 | + versionProperties.setIsLatest(true); |
| 113 | + |
| 114 | + Urn entityUrn = changeMCP.getUrn(); |
| 115 | + Urn versionSetUrn = versionProperties.getVersionSet(); |
| 116 | + |
| 117 | + AspectSpec keyAspectSpec = |
| 118 | + retrieverContext |
| 119 | + .getAspectRetriever() |
| 120 | + .getEntityRegistry() |
| 121 | + .getEntitySpec(VERSION_SET_ENTITY_NAME) |
| 122 | + .getKeyAspectSpec(); |
| 123 | + RecordTemplate versionSetKey = |
| 124 | + EntityKeyUtils.convertUrnToEntityKey(versionSetUrn, keyAspectSpec); |
| 125 | + ChangeMCP createVersionSetKey = |
| 126 | + ChangeItemImpl.builder() |
| 127 | + .urn(versionSetUrn) |
| 128 | + .aspectName(VERSION_SET_KEY_ASPECT_NAME) |
| 129 | + .changeType(ChangeType.UPSERT) |
| 130 | + .recordTemplate(versionSetKey) |
| 131 | + .auditStamp(changeMCP.getAuditStamp()) |
| 132 | + .systemMetadata(changeMCP.getSystemMetadata()) |
| 133 | + .build(retrieverContext.getAspectRetriever()); |
| 134 | + |
| 135 | + VersionSetProperties versionSetPropertiesWithNewLatest = |
| 136 | + new VersionSetProperties() |
| 137 | + .setVersioningScheme(versionProperties.getVersioningScheme()) |
| 138 | + .setLatest(entityUrn); |
| 139 | + ChangeMCP createVersionSetProperties = |
| 140 | + ChangeItemImpl.builder() |
| 141 | + .urn(versionSetUrn) |
| 142 | + .aspectName(VERSION_SET_PROPERTIES_ASPECT_NAME) |
| 143 | + .changeType(ChangeType.UPSERT) |
| 144 | + .recordTemplate(versionSetPropertiesWithNewLatest) |
| 145 | + .auditStamp(changeMCP.getAuditStamp()) |
| 146 | + .systemMetadata(changeMCP.getSystemMetadata()) |
| 147 | + .build(retrieverContext.getAspectRetriever()); |
| 148 | + |
| 149 | + return Stream.of(createVersionSetKey, createVersionSetProperties); |
| 150 | + } |
| 151 | + |
| 152 | + private static Stream<ChangeMCP> updateVersionSetLatest( |
| 153 | + @Nonnull VersionProperties versionProperties, |
| 154 | + @Nullable VersionProperties prevLatestVersionProperties, |
| 155 | + @Nonnull Urn prevLatest, |
| 156 | + ChangeMCP changeMCP, |
| 157 | + @Nonnull RetrieverContext retrieverContext) { |
| 158 | + versionProperties.setIsLatest(true); |
| 159 | + |
| 160 | + Urn entityUrn = changeMCP.getUrn(); |
| 161 | + Urn versionSetUrn = versionProperties.getVersionSet(); |
| 162 | + |
| 163 | + VersionSetProperties versionSetPropertiesWithNewLatest = |
| 164 | + new VersionSetProperties() |
| 165 | + .setVersioningScheme(versionProperties.getVersioningScheme()) |
| 166 | + .setLatest(entityUrn); |
| 167 | + ChangeMCP updateVersionSetProperties = |
| 168 | + ChangeItemImpl.builder() |
| 169 | + .urn(versionSetUrn) |
| 170 | + .aspectName(VERSION_SET_PROPERTIES_ASPECT_NAME) |
| 171 | + .changeType(ChangeType.UPSERT) |
| 172 | + .recordTemplate(versionSetPropertiesWithNewLatest) |
| 173 | + .auditStamp(changeMCP.getAuditStamp()) |
| 174 | + .systemMetadata(changeMCP.getSystemMetadata()) |
| 175 | + .build(retrieverContext.getAspectRetriever()); |
| 176 | + |
| 177 | + if (prevLatestVersionProperties == null) { |
| 178 | + return Stream.of(updateVersionSetProperties); |
| 179 | + } |
| 180 | + |
| 181 | + EntitySpec entitySpec = |
| 182 | + retrieverContext |
| 183 | + .getAspectRetriever() |
| 184 | + .getEntityRegistry() |
| 185 | + .getEntitySpec(prevLatest.getEntityType()); |
| 186 | + GenericJsonPatch.PatchOp patchOp = new GenericJsonPatch.PatchOp(); |
| 187 | + patchOp.setOp(PatchOperationType.ADD.getValue()); |
| 188 | + patchOp.setPath("/isLatest"); |
| 189 | + patchOp.setValue(false); |
| 190 | + ChangeMCP updateOldLatestVersionProperties = |
| 191 | + PatchItemImpl.builder() |
| 192 | + .urn(prevLatest) |
| 193 | + .entitySpec(entitySpec) |
| 194 | + .aspectName(VERSION_PROPERTIES_ASPECT_NAME) |
| 195 | + .aspectSpec(entitySpec.getAspectSpec(VERSION_PROPERTIES_ASPECT_NAME)) |
| 196 | + .patch(GenericJsonPatch.builder().patch(List.of(patchOp)).build().getJsonPatch()) |
| 197 | + .auditStamp(changeMCP.getAuditStamp()) |
| 198 | + .systemMetadata(changeMCP.getSystemMetadata()) |
| 199 | + .build(retrieverContext.getAspectRetriever().getEntityRegistry()) |
| 200 | + .applyPatch(prevLatestVersionProperties, retrieverContext.getAspectRetriever()); |
| 201 | + |
| 202 | + return Stream.of(updateVersionSetProperties, updateOldLatestVersionProperties); |
| 203 | + } |
| 204 | +} |
0 commit comments