feat: Allow specifying Data Product URN via UI (datahub-project#9386)

Co-authored-by: Aseem Bansal <[email protected]>

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/exception/DataHubDataFetcherExceptionHandler.java

@@ -12,35 +12,49 @@
 @Slf4j
 public class DataHubDataFetcherExceptionHandler implements DataFetcherExceptionHandler {
 
+  private static final String DEFAULT_ERROR_MESSAGE = "An unknown error occurred.";
+
   @Override
   public DataFetcherExceptionHandlerResult onException(
       DataFetcherExceptionHandlerParameters handlerParameters) {
     Throwable exception = handlerParameters.getException();
     SourceLocation sourceLocation = handlerParameters.getSourceLocation();
     ResultPath path = handlerParameters.getPath();
 
-    log.error("Failed to execute DataFetcher", exception);
-
     DataHubGraphQLErrorCode errorCode = DataHubGraphQLErrorCode.SERVER_ERROR;
-    String message = "An unknown error occurred.";
+    String message = DEFAULT_ERROR_MESSAGE;
 
-    // note: make sure to access the true error message via `getCause()`
-    if (exception.getCause() instanceof IllegalArgumentException) {
+    IllegalArgumentException illException =
+        findFirstThrowableCauseOfClass(exception, IllegalArgumentException.class);
+    if (illException != null) {
+      log.error("Failed to execute", illException);
       errorCode = DataHubGraphQLErrorCode.BAD_REQUEST;
-      message = exception.getCause().getMessage();
+      message = illException.getMessage();
     }
 
-    if (exception instanceof DataHubGraphQLException) {
-      errorCode = ((DataHubGraphQLException) exception).errorCode();
-      message = exception.getMessage();
+    DataHubGraphQLException graphQLException =
+        findFirstThrowableCauseOfClass(exception, DataHubGraphQLException.class);
+    if (graphQLException != null) {
+      log.error("Failed to execute", graphQLException);
+      errorCode = graphQLException.errorCode();
+      message = graphQLException.getMessage();
     }
 
-    if (exception.getCause() instanceof DataHubGraphQLException) {
-      errorCode = ((DataHubGraphQLException) exception.getCause()).errorCode();
-      message = exception.getCause().getMessage();
+    if (illException == null && graphQLException == null) {
+      log.error("Failed to execute", exception);
     }
-
     DataHubGraphQLError error = new DataHubGraphQLError(message, path, sourceLocation, errorCode);
     return DataFetcherExceptionHandlerResult.newResult().error(error).build();
   }
+
+  <T extends Throwable> T findFirstThrowableCauseOfClass(Throwable throwable, Class<T> clazz) {
+    while (throwable != null) {
+      if (clazz.isInstance(throwable)) {
+        return (T) throwable;
+      } else {
+        throwable = throwable.getCause();
+      }
+    }
+    return null;
+  }
 }

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/dataproduct/CreateDataProductResolver.java

@@ -47,6 +47,7 @@ public CompletableFuture<DataProduct> get(final DataFetchingEnvironment environm
           try {
             final Urn dataProductUrn =
                 _dataProductService.createDataProduct(
+                    input.getId(),
                     input.getProperties().getName(),
                     input.getProperties().getDescription(),
                     authentication);

datahub-graphql-core/src/main/resources/entity.graphql

@@ -11055,6 +11055,10 @@ input CreateDataProductInput {
     The primary key of the Domain
     """
     domainUrn: String!
+    """
+    An optional id for the new data product
+    """
+    id: String
 }
 
 """

datahub-web-react/src/app/entity/domain/DataProductsTab/CreateDataProductModal.tsx

@@ -32,6 +32,7 @@ export default function CreateDataProductModal({ domain, onCreateDataProduct, on
             variables: {
                 input: {
                     domainUrn: domain.urn,
+                    id: builderState.id,
                     properties: {
                         name: builderState.name,
                         description: builderState.description || undefined,
@@ -49,10 +50,10 @@ export default function CreateDataProductModal({ domain, onCreateDataProduct, on
                     onClose();
                 }
             })
-            .catch(() => {
+            .catch(( error ) => {
                 onClose();
                 message.destroy();
-                message.error({ content: 'Failed to create Data Product. An unexpected error occurred' });
+                message.error({ content: `Failed to create Data Product: ${error.message}.` });
             });
     }
 

datahub-web-react/src/app/entity/domain/DataProductsTab/DataProductAdvancedOption.tsx

@@ -0,0 +1,68 @@
+import React from "react";
+import { Collapse, Form, Input, Typography } from "antd";
+import styled from "styled-components";
+import { validateCustomUrnId } from '../../../shared/textUtil';
+import { DataProductBuilderFormProps } from "./types";
+
+
+const FormItem = styled(Form.Item)`
+    .ant-form-item-label {
+        padding-bottom: 2px;
+    }
+`;
+
+const FormItemWithMargin = styled(FormItem)`
+    margin-bottom: 16px;
+`;
+
+const FormItemNoMargin = styled(FormItem)`
+    margin-bottom: 0;
+`;
+
+const AdvancedLabel = styled(Typography.Text)`
+    color: #373d44;
+`;
+
+export function DataProductAdvancedOption({builderState, updateBuilderState }: DataProductBuilderFormProps){
+
+    function updateDataProductId(id: string) {
+        updateBuilderState({
+            ...builderState,
+            id,
+        });
+    }
+
+    return (
+        <Collapse ghost>
+            <Collapse.Panel header={<AdvancedLabel>Advanced Options</AdvancedLabel>} key="1">
+                <FormItemWithMargin
+                    label={<Typography.Text strong>Data Product Id</Typography.Text>}
+                    help="By default, a random UUID will be generated to uniquely identify this data product. If
+                        you'd like to provide a custom id instead to more easily keep track of this data product,
+                        you may provide it here. Be careful, you cannot easily change the data product id after
+                        creation."
+                >
+                    <FormItemNoMargin
+                        rules={[
+                            () => ({
+                                validator(_, value) {
+                                    if (value && validateCustomUrnId(value)) {
+                                        return Promise.resolve();
+                                    }
+                                    return Promise.reject(new Error('Please enter a valid Data product id'));
+                                },
+                            }),
+                        ]}
+                    >
+                        <Input 
+                            data-testid="data-product-id" 
+                            placeholder="engineering" 
+                            value={builderState.id}
+                            onChange={(e) => updateDataProductId(e.target.value)}
+                        />
+                    </FormItemNoMargin>
+                </FormItemWithMargin>
+            </Collapse.Panel>
+        </Collapse>
+    )
+}

datahub-web-react/src/app/entity/domain/DataProductsTab/DataProductBuilderForm.tsx

@@ -3,18 +3,14 @@ import React from 'react';
 import styled from 'styled-components';
 import { Editor as MarkdownEditor } from '../../shared/tabs/Documentation/components/editor/Editor';
 import { ANTD_GRAY } from '../../shared/constants';
-import { DataProductBuilderState } from './types';
+import { DataProductBuilderFormProps } from './types';
+import { DataProductAdvancedOption } from './DataProductAdvancedOption';
 
 const StyledEditor = styled(MarkdownEditor)`
     border: 1px solid ${ANTD_GRAY[4]};
 `;
 
-type Props = {
-    builderState: DataProductBuilderState;
-    updateBuilderState: (newState: DataProductBuilderState) => void;
-};
-
-export default function DataProductBuilderForm({ builderState, updateBuilderState }: Props) {
+export default function DataProductBuilderForm({ builderState, updateBuilderState }: DataProductBuilderFormProps) {
     function updateName(name: string) {
         updateBuilderState({
             ...builderState,
@@ -47,6 +43,7 @@ export default function DataProductBuilderForm({ builderState, updateBuilderStat
             <Form.Item label={<Typography.Text strong>Description</Typography.Text>}>
                 <StyledEditor doNotFocus content={builderState.description} onChange={updateDescription} />
             </Form.Item>
+            <DataProductAdvancedOption builderState={builderState} updateBuilderState={updateBuilderState}/>
         </Form>
     );
 }

datahub-web-react/src/app/entity/domain/DataProductsTab/types.ts

@@ -1,4 +1,10 @@
 export type DataProductBuilderState = {
     name: string;
+    id?: string;
     description?: string;
 };
+
+export type DataProductBuilderFormProps = {
+    builderState: DataProductBuilderState;
+    updateBuilderState: (newState: DataProductBuilderState) => void;
+};

metadata-service/services/src/main/java/com/linkedin/metadata/service/DataProductService.java

@@ -1,5 +1,7 @@
 package com.linkedin.metadata.service;
 
+import static com.linkedin.metadata.Constants.DATA_PRODUCT_ENTITY_NAME;
+
 import com.datahub.authentication.Authentication;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableSet;
@@ -22,6 +24,7 @@
 import com.linkedin.metadata.graph.GraphClient;
 import com.linkedin.metadata.query.filter.RelationshipDirection;
 import com.linkedin.metadata.utils.EntityKeyUtils;
+import com.linkedin.r2.RemoteInvocationException;
 import java.util.List;
 import java.util.Objects;
 import java.util.UUID;
@@ -58,11 +61,26 @@ public DataProductService(@Nonnull EntityClient entityClient, @Nonnull GraphClie
    * @return the urn of the newly created DataProduct
    */
   public Urn createDataProduct(
-      @Nullable String name, @Nullable String description, @Nonnull Authentication authentication) {
+      @Nullable String id,
+      @Nullable String name,
+      @Nullable String description,
+      @Nonnull Authentication authentication) {
 
     // 1. Generate a unique id for the new DataProduct.
     final DataProductKey key = new DataProductKey();
-    key.setId(UUID.randomUUID().toString());
+    if (id != null && !id.isBlank()) {
+      key.setId(id);
+    } else {
+      key.setId(UUID.randomUUID().toString());
+    }
+    try {
+      if (_entityClient.exists(
+          EntityKeyUtils.convertEntityKeyToUrn(key, DATA_PRODUCT_ENTITY_NAME), authentication)) {
+        throw new IllegalArgumentException("This Data product already exists!");
+      }
+    } catch (RemoteInvocationException e) {
+      throw new RuntimeException("Unable to check for existence of Data Product!");
+    }
 
     // 2. Create a new instance of DataProductProperties
     final DataProductProperties properties = new DataProductProperties();

smoke-test/tests/privileges/test_privileges.py

@@ -63,7 +63,7 @@ def _ensure_cant_perform_action(session, json,assertion_key):
     action_response.raise_for_status()
     action_data = action_response.json()
 
-    assert action_data["errors"][0]["extensions"]["code"] == 403
+    assert action_data["errors"][0]["extensions"]["code"] == 403, action_data["errors"][0]
     assert action_data["errors"][0]["extensions"]["type"] == "UNAUTHORIZED"
     assert action_data["data"][assertion_key] == None
 
@@ -367,8 +367,9 @@ def test_privilege_to_create_and_manage_policies():
 
     # Verify new user can't create a policy
     create_policy = {
-        "query": """mutation createPolicy($input: PolicyUpdateInput!) {\n
-            createPolicy(input: $input) }""",
+        "query": """mutation createPolicy($input: PolicyUpdateInput!) {
+            createPolicy(input: $input) 
+        }""",
         "variables": {
             "input": {
                 "type": "PLATFORM",