feat(structuredProps) Add delete structured props endpoint and handle…

… null props (datahub-project#11418)
sagar-salvi-apptware · Sep 18, 2024 · de40d25 · de40d25
1 parent cc6cbe2
commit de40d25
Show file tree

Hide file tree

Showing 8 changed files with 130 additions and 19 deletions.
diff --git a/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLEngine.java b/datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLEngine.java
@@ -293,6 +293,7 @@
 import com.linkedin.datahub.graphql.resolvers.step.BatchGetStepStatesResolver;
 import com.linkedin.datahub.graphql.resolvers.step.BatchUpdateStepStatesResolver;
 import com.linkedin.datahub.graphql.resolvers.structuredproperties.CreateStructuredPropertyResolver;
+import com.linkedin.datahub.graphql.resolvers.structuredproperties.DeleteStructuredPropertyResolver;
 import com.linkedin.datahub.graphql.resolvers.structuredproperties.RemoveStructuredPropertiesResolver;
 import com.linkedin.datahub.graphql.resolvers.structuredproperties.UpdateStructuredPropertyResolver;
 import com.linkedin.datahub.graphql.resolvers.structuredproperties.UpsertStructuredPropertiesResolver;
@@ -1344,6 +1345,9 @@ private void configureMutationResolvers(final RuntimeWiring.Builder builder) {
               .dataFetcher(
                   "updateStructuredProperty",
                   new UpdateStructuredPropertyResolver(this.entityClient))
+              .dataFetcher(
+                  "deleteStructuredProperty",
+                  new DeleteStructuredPropertyResolver(this.entityClient))
               .dataFetcher("raiseIncident", new RaiseIncidentResolver(this.entityClient))
               .dataFetcher(
                   "updateIncidentStatus",
@@ -2117,6 +2121,9 @@ private void configureStructuredPropertyResolvers(final RuntimeWiring.Builder bu
                             .getAllowedTypes().stream()
                                 .map(entityTypeType.getKeyProvider())
                                 .collect(Collectors.toList()))));
+    builder.type(
+        "StructuredPropertyEntity",
+        typeWiring -> typeWiring.dataFetcher("exists", new EntityExistsResolver(entityService)));
   }
 
   /**

diff --git a/...edin/datahub/graphql/resolvers/structuredproperties/DeleteStructuredPropertyResolver.java b/...edin/datahub/graphql/resolvers/structuredproperties/DeleteStructuredPropertyResolver.java
@@ -0,0 +1,52 @@
+package com.linkedin.datahub.graphql.resolvers.structuredproperties;
+
+import static com.linkedin.datahub.graphql.resolvers.ResolverUtils.bindArgument;
+
+import com.linkedin.common.urn.Urn;
+import com.linkedin.common.urn.UrnUtils;
+import com.linkedin.datahub.graphql.QueryContext;
+import com.linkedin.datahub.graphql.authorization.AuthorizationUtils;
+import com.linkedin.datahub.graphql.exception.AuthorizationException;
+import com.linkedin.datahub.graphql.generated.DeleteStructuredPropertyInput;
+import com.linkedin.entity.client.EntityClient;
+import graphql.schema.DataFetcher;
+import graphql.schema.DataFetchingEnvironment;
+import java.util.Objects;
+import java.util.concurrent.CompletableFuture;
+import javax.annotation.Nonnull;
+import lombok.extern.slf4j.Slf4j;
+
+@Slf4j
+public class DeleteStructuredPropertyResolver implements DataFetcher<CompletableFuture<Boolean>> {
+
+  private final EntityClient _entityClient;
+
+  public DeleteStructuredPropertyResolver(@Nonnull final EntityClient entityClient) {
+    _entityClient = Objects.requireNonNull(entityClient, "entityClient must not be null");
+  }
+
+  @Override
+  public CompletableFuture<Boolean> get(final DataFetchingEnvironment environment)
+      throws Exception {
+    final QueryContext context = environment.getContext();
+
+    final DeleteStructuredPropertyInput input =
+        bindArgument(environment.getArgument("input"), DeleteStructuredPropertyInput.class);
+    final Urn propertyUrn = UrnUtils.getUrn(input.getUrn());
+
+    return CompletableFuture.supplyAsync(
+        () -> {
+          try {
+            if (!AuthorizationUtils.canManageStructuredProperties(context)) {
+              throw new AuthorizationException(
+                  "Unable to delete structured property. Please contact your admin.");
+            }
+            _entityClient.deleteEntity(context.getOperationContext(), propertyUrn);
+            return true;
+          } catch (Exception e) {
+            throw new RuntimeException(
+                String.format("Failed to perform update against input %s", input), e);
+          }
+        });
+  }
+}
diff --git a/.../java/com/linkedin/datahub/graphql/types/structuredproperty/StructuredPropertyMapper.java b/.../java/com/linkedin/datahub/graphql/types/structuredproperty/StructuredPropertyMapper.java
@@ -2,7 +2,9 @@
 
 import static com.linkedin.metadata.Constants.*;
 
+import com.google.common.collect.ImmutableList;
 import com.linkedin.common.urn.Urn;
+import com.linkedin.common.urn.UrnUtils;
 import com.linkedin.data.DataMap;
 import com.linkedin.data.template.StringArrayMap;
 import com.linkedin.datahub.graphql.QueryContext;
@@ -46,6 +48,9 @@ public StructuredPropertyEntity apply(
     final StructuredPropertyEntity result = new StructuredPropertyEntity();
     result.setUrn(entityResponse.getUrn().toString());
     result.setType(EntityType.STRUCTURED_PROPERTY);
+    // set the default required values for a structured property in case references are still being
+    // cleaned up
+    setDefaultProperty(result);
     EnvelopedAspectMap aspectMap = entityResponse.getAspects();
     MappingHelper<StructuredPropertyEntity> mappingHelper = new MappingHelper<>(aspectMap, result);
     mappingHelper.mapToResult(
@@ -134,4 +139,22 @@ private EntityTypeEntity createEntityTypeEntity(final String entityTypeUrnStr) {
     entityType.setType(EntityType.ENTITY_TYPE);
     return entityType;
   }
+
+  /*
+   * In the case that a property is deleted and the references haven't been cleaned up yet (this process is async)
+   * set a default property to prevent APIs breaking. The UI queries for whether the entity exists and it will
+   * be filtered out.
+   */
+  private void setDefaultProperty(final StructuredPropertyEntity result) {
+    StructuredPropertyDefinition definition = new StructuredPropertyDefinition();
+    definition.setQualifiedName("");
+    definition.setCardinality(PropertyCardinality.SINGLE);
+    definition.setImmutable(true);
+    definition.setValueType(
+        createDataTypeEntity(UrnUtils.getUrn("urn:li:dataType:datahub.string")));
+    definition.setEntityTypes(
+        ImmutableList.of(
+            createEntityTypeEntity(UrnUtils.getUrn("urn:li:entityType:datahub.dataset"))));
+    result.setDefinition(definition);
+  }
 }
diff --git a/datahub-graphql-core/src/main/resources/properties.graphql b/datahub-graphql-core/src/main/resources/properties.graphql
@@ -18,6 +18,11 @@ extend type Mutation {
     Update an existing structured property
     """
     updateStructuredProperty(input: UpdateStructuredPropertyInput!): StructuredPropertyEntity!
+
+    """
+    Delete an existing structured property
+    """
+    deleteStructuredProperty(input: DeleteStructuredPropertyInput!): Boolean!
 }
 
 """
@@ -34,6 +39,11 @@ type StructuredPropertyEntity implements Entity {
     """
     type: EntityType!
 
+    """
+    Whether or not this entity exists on DataHub
+    """
+    exists: Boolean
+
     """
     Definition of this structured property including its name
     """
@@ -457,3 +467,13 @@ input UpdateTypeQualifierInput {
     """
     newAllowedTypes: [String!]
 }
+
+"""
+Input for deleting a form
+"""
+input DeleteStructuredPropertyInput {
+    """
+    The urn of the structured properties that is being deleted
+    """
+    urn: String!
+}
diff --git a/datahub-web-react/src/app/entity/shared/tabs/Dataset/Schema/SchemaTab.tsx b/datahub-web-react/src/app/entity/shared/tabs/Dataset/Schema/SchemaTab.tsx
@@ -79,7 +79,10 @@ export const SchemaTab = ({ properties }: { properties?: any }) => {
     const hasProperties = useMemo(
         () =>
             entityWithSchema?.schemaMetadata?.fields?.some(
-                (schemaField) => !!schemaField.schemaFieldEntity?.structuredProperties?.properties?.length,
+                (schemaField) =>
+                    !!schemaField.schemaFieldEntity?.structuredProperties?.properties?.filter(
+                        (prop) => prop.structuredProperty.exists,
+                    )?.length,
             ),
         [entityWithSchema],
     );

diff --git a/...rc/app/entity/shared/tabs/Dataset/Schema/components/SchemaFieldDrawer/FieldProperties.tsx b/...rc/app/entity/shared/tabs/Dataset/Schema/components/SchemaFieldDrawer/FieldProperties.tsx
@@ -34,14 +34,16 @@ interface Props {
 export default function FieldProperties({ expandedField }: Props) {
     const { schemaFieldEntity } = expandedField;
     const { refetch } = useGetEntityWithSchema(true);
+    const properties =
+        schemaFieldEntity?.structuredProperties?.properties?.filter((prop) => prop.structuredProperty.exists) || [];
 
-    if (!schemaFieldEntity?.structuredProperties?.properties?.length) return null;
+    if (!schemaFieldEntity || !properties.length) return null;
 
     return (
         <>
             <SectionHeader>Properties</SectionHeader>
             <PropertiesWrapper>
-                {schemaFieldEntity.structuredProperties.properties.map((structuredProp) => {
+                {properties.map((structuredProp) => {
                     const isRichText =
                         structuredProp.structuredProperty.definition.valueType?.info.type === StdDataType.RichText;
                     const valuesData = mapStructuredPropertyValues(structuredProp);

diff --git a/datahub-web-react/src/app/entity/shared/tabs/Properties/useStructuredProperties.tsx b/datahub-web-react/src/app/entity/shared/tabs/Properties/useStructuredProperties.tsx
@@ -27,23 +27,26 @@ export function mapStructuredPropertyValues(structuredPropertiesEntry: Structure
 function getStructuredPropertyRows(entityData?: GenericEntityProperties | null) {
     const structuredPropertyRows: PropertyRow[] = [];
 
-    entityData?.structuredProperties?.properties?.forEach((structuredPropertiesEntry) => {
-        const { displayName, qualifiedName } = structuredPropertiesEntry.structuredProperty.definition;
-        structuredPropertyRows.push({
-            displayName: displayName || qualifiedName,
-            qualifiedName,
-            values: mapStructuredPropertyValues(structuredPropertiesEntry),
-            dataType: structuredPropertiesEntry.structuredProperty.definition.valueType,
-            structuredProperty: structuredPropertiesEntry.structuredProperty,
-            type:
-                structuredPropertiesEntry.values[0] && structuredPropertiesEntry.values[0].__typename
-                    ? {
-                          type: typeNameToType[structuredPropertiesEntry.values[0].__typename].type,
-                          nativeDataType: typeNameToType[structuredPropertiesEntry.values[0].__typename].nativeDataType,
-                      }
-                    : undefined,
+    entityData?.structuredProperties?.properties
+        ?.filter((prop) => prop.structuredProperty.exists)
+        .forEach((structuredPropertiesEntry) => {
+            const { displayName, qualifiedName } = structuredPropertiesEntry.structuredProperty.definition;
+            structuredPropertyRows.push({
+                displayName: displayName || qualifiedName,
+                qualifiedName,
+                values: mapStructuredPropertyValues(structuredPropertiesEntry),
+                dataType: structuredPropertiesEntry.structuredProperty.definition.valueType,
+                structuredProperty: structuredPropertiesEntry.structuredProperty,
+                type:
+                    structuredPropertiesEntry.values[0] && structuredPropertiesEntry.values[0].__typename
+                        ? {
+                              type: typeNameToType[structuredPropertiesEntry.values[0].__typename].type,
+                              nativeDataType:
+                                  typeNameToType[structuredPropertiesEntry.values[0].__typename].nativeDataType,
+                          }
+                        : undefined,
+            });
         });
-    });
 
     return structuredPropertyRows;
 }

diff --git a/datahub-web-react/src/graphql/fragments.graphql b/datahub-web-react/src/graphql/fragments.graphql
@@ -1314,6 +1314,7 @@ fragment structuredPropertyFields on StructuredPropertyEntity {
 
 fragment structuredPropertiesFields on StructuredPropertiesEntry {
     structuredProperty {
+        exists
         ...structuredPropertyFields
     }
     values {