Skip to content
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

feat(forms) Add CRUD endpoints to GraphQL for Form entities #10825

Conversation

chriscollins3456
Copy link
Collaborator

@chriscollins3456 chriscollins3456 commented Jul 1, 2024

This PR adds new GraphQL endpoints that allows users with the MANAGE_FORMS platform permission to create a new form, update an existing form, and delete a form.

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Summary by CodeRabbit

  • New Features

    • Introduced the ability to create, update, and delete forms via new GraphQL mutations.
    • Added privilege for managing documentation forms.
  • Bug Fixes

    • Improved authorization checks for form-related operations.
  • Tests

    • Added test cases to validate form creation, deletion, and update functionalities.
  • Chores

    • Updated policies.json to include the new privilege "MANAGE_DOCUMENTATION_FORMS" in relevant sections.

Copy link
Contributor

coderabbitai bot commented Jul 1, 2024

Warning

Rate limit exceeded

@chriscollins3456 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 26 minutes and 50 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 008e508 and 9ad0d8a.

Walkthrough

The changes introduce new GraphQL resolvers for managing forms, including creating, deleting, and updating forms, and add supporting utilities and tests. Authorization capabilities have been enhanced with a new function to manage form permissions. Additionally, the DataHub API has been extended for comprehensive form management, including new privileges in policy configurations.

Changes

File(s) Change Summary
GraphQL Resolvers & Core
...graphql/GmsGraphQLEngine.java Added resolvers for creating, deleting, and updating forms with respective imports.
...graphql/authorization/AuthorizationUtils.java Added a function canManageForms to check user permissions for managing forms.
...graphql/resolvers/form/CreateFormResolver.java Introduced resolver for creating forms, including authorization validation and input mapping.
...graphql/resolvers/form/DeleteFormResolver.java Introduced resolver for deleting forms, with authorization checks and asynchronous deletion.
...graphql/resolvers/form/UpdateFormResolver.java Introduced resolver for updating forms using UpdateFormInput, applying patches to form data.
...resolvers/mutate/util/FormUtils.java Added methods to map form-related inputs to objects like FormInfo, FormPrompt, and FormActorAssignment.
...resources/forms.graphql Added new mutations for creating, updating, and deleting forms, along with their input types.
Tests
...graphql/resolvers/form/...ResolverTest.java Added tests for create, delete, and update form resolvers, including success, unauthorized, and failure scenarios.
Metadata Service & Related
...patch/builder/FormInfoPatchBuilder.java Added methods for various form operations including setting name, description, adding/removing prompts, users, and groups.
...patch/PatchTest.java Added classes and methods for testing form prompt methods and structured properties.
...examples/FormCreate.java Added an example for creating forms and submitting for metadata compliance.
...examples/FormUpdate.java Added an example for updating form prompts and associated metadata aspects.
...form/FormService.java Added imports and implemented the createForm method for creating forms using FormInfo.
...authorization/PoliciesConfig.java Added MANAGE_DOCUMENTATION_FORMS_PRIVILEGE for managing forms and included it in PLATFORM_PRIVILEGES.
Configuration
...resources/boot/policies.json Updated with MANAGE_DOCUMENTATION_FORMS privilege in various sections for root users, admins, and editors.

🌼 Whiskers twitch, CodeRabbit sends
A joyful rhyme as this update descends.
Forms are managed with ease and grace,
Resolvers in place, no data misplaced.
With tests and utilities, we're set to go,
To new horizons, our systems will flow. 🌸🐰


Tip

Early access features: enabled

We are currently testing the following features in early access:

  • OpenAI gpt-4o model for code reviews and chat: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues.
  • OSS projects are currently opted into early access features by default.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added ingestion PR or Issue related to the ingestion of metadata product PR or Issue related to the DataHub UI/UX devops PR or Issue related to DataHub backend & deployment labels Jul 1, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 27

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 64d4172 and 09f2b45.

Files selected for processing (16)
  • datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLEngine.java (2 hunks)
  • datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/authorization/AuthorizationUtils.java (1 hunks)
  • datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/form/CreateFormResolver.java (1 hunks)
  • datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/form/DeleteFormResolver.java (1 hunks)
  • datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/form/UpdateFormResolver.java (1 hunks)
  • datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/mutate/util/FormUtils.java (3 hunks)
  • datahub-graphql-core/src/main/resources/forms.graphql (2 hunks)
  • datahub-graphql-core/src/test/java/com/linkedin/datahub/graphql/resolvers/form/CreateFormResolverTest.java (1 hunks)
  • datahub-graphql-core/src/test/java/com/linkedin/datahub/graphql/resolvers/form/DeleteFormResolverTest.java (1 hunks)
  • datahub-graphql-core/src/test/java/com/linkedin/datahub/graphql/resolvers/form/UpdateFormResolverTest.java (1 hunks)
  • entity-registry/src/main/java/com/linkedin/metadata/aspect/patch/builder/FormInfoPatchBuilder.java (1 hunks)
  • metadata-integration/java/datahub-client/src/test/java/datahub/client/patch/PatchTest.java (3 hunks)
  • metadata-integration/java/examples/src/main/java/io/datahubproject/examples/FormCreate.java (1 hunks)
  • metadata-integration/java/examples/src/main/java/io/datahubproject/examples/FormUpdate.java (1 hunks)
  • metadata-service/services/src/main/java/com/linkedin/metadata/service/FormService.java (3 hunks)
  • metadata-utils/src/main/java/com/linkedin/metadata/authorization/PoliciesConfig.java (2 hunks)
Files not reviewed due to errors (2)
  • datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/authorization/AuthorizationUtils.java (no review received)
  • metadata-utils/src/main/java/com/linkedin/metadata/authorization/PoliciesConfig.java (no review received)
Additional comments not posted (34)
metadata-integration/java/examples/src/main/java/io/datahubproject/examples/FormUpdate.java (4)

1-1: Consider adding a class-level Javadoc comment.

Adding a Javadoc comment describing the purpose of this class will improve maintainability and readability.

/**
 * Example class demonstrating how to update a form using DataHub APIs.
 */

19-19: Consider adding a Javadoc comment for the constructor.

Adding a Javadoc comment describing the purpose of the constructor will improve maintainability and readability.

/**
 * Private constructor to prevent instantiation.
 */

21-22: Consider adding a Javadoc comment for the main method.

Adding a Javadoc comment describing the purpose of the main method and its parameters will improve maintainability and readability.

/**
 * Main method demonstrating how to update a form using DataHub APIs.
 *
 * @param args Command line arguments (not used).
 * @throws IOException If an I/O error occurs.
 * @throws ExecutionException If the computation threw an exception.
 * @throws InterruptedException If the current thread was interrupted while waiting.
 */

52-52: Consider securely handling the token.

The token is currently an empty string. Ensure that the token is securely handled and retrieved from a secure source.
[SECURITY]

// TODO: Retrieve the token from a secure source
String token = "";
metadata-integration/java/examples/src/main/java/io/datahubproject/examples/FormCreate.java (4)

1-1: Consider adding a class-level Javadoc comment.

Adding a Javadoc comment describing the purpose of this class will improve maintainability and readability.

/**
 * Example class demonstrating how to create a form using DataHub APIs.
 */

18-18: Consider adding a Javadoc comment for the constructor.

Adding a Javadoc comment describing the purpose of the constructor will improve maintainability and readability.

/**
 * Private constructor to prevent instantiation.
 */

22-23: Consider adding a Javadoc comment for the main method.

Adding a Javadoc comment describing the purpose of the main method and its parameters will improve maintainability and readability.

/**
 * Main method demonstrating how to create a form using DataHub APIs.
 *
 * @param args Command line arguments (not used).
 * @throws IOException If an I/O error occurs.
 * @throws ExecutionException If the computation threw an exception.
 * @throws InterruptedException If the current thread was interrupted while waiting.
 */

63-63: Consider securely handling the token.

The token is currently an empty string. Ensure that the token is securely handled and retrieved from a secure source.
[SECURITY]

// TODO: Retrieve the token from a secure source
String token = "";
datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/form/DeleteFormResolver.java (4)

1-1: Consider adding a class-level Javadoc comment.

Adding a Javadoc comment describing the purpose of this class will improve maintainability and readability.

/**
 * Resolver for deleting a form entity.
 */

19-20: Consider adding a class-level Javadoc comment for the class.

Adding a Javadoc comment describing the purpose of this class will improve maintainability and readability.

/**
 * Resolver for deleting a form entity.
 */

24-26: Consider adding a Javadoc comment for the constructor.

Adding a Javadoc comment describing the purpose of the constructor and its parameters will improve maintainability and readability.

/**
 * Constructs a DeleteFormResolver.
 *
 * @param entityClient the entity client used to delete the form entity.
 */

28-64: Consider adding a Javadoc comment for the get method.

Adding a Javadoc comment describing the purpose of the method, its parameters, and its return value will improve maintainability and readability.

/**
 * Deletes a form entity.
 *
 * @param environment the data fetching environment.
 * @return a CompletableFuture indicating whether the deletion was successful.
 * @throws Exception if an error occurs during deletion.
 */
datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/form/CreateFormResolver.java (5)

1-1: Consider adding a class-level Javadoc comment.

Adding a Javadoc comment describing the purpose of this class will improve maintainability and readability.

/**
 * Resolver for creating a form entity.
 */

28-28: Consider adding a class-level Javadoc comment for the class.

Adding a Javadoc comment describing the purpose of this class will improve maintainability and readability.

/**
 * Resolver for creating a form entity.
 */

33-37: Consider adding a Javadoc comment for the constructor.

Adding a Javadoc comment describing the purpose of the constructor and its parameters will improve maintainability and readability.

/**
 * Constructs a CreateFormResolver.
 *
 * @param entityClient the entity client used to create the form entity.
 * @param formService the form service used to manage form entities.
 */

39-66: Consider adding a Javadoc comment for the get method.

Adding a Javadoc comment describing the purpose of the method, its parameters, and its return value will improve maintainability and readability.

/**
 * Creates a form entity.
 *
 * @param environment the data fetching environment.
 * @return a CompletableFuture containing the created form entity.
 * @throws Exception if an error occurs during creation.
 */

68-82: Consider adding a Javadoc comment for the validatePrompts method.

Adding a Javadoc comment describing the purpose of the method, its parameters, and its behavior will improve maintainability and readability.

/**
 * Validates the prompts in the form creation input.
 *
 * @param prompts the list of prompts to validate.
 * @throws IllegalArgumentException if a prompt with type STRUCTURED_PROPERTY or FIELDS_STRUCTURED_PROPERTY has no structured property params.
 */
datahub-graphql-core/src/test/java/com/linkedin/datahub/graphql/resolvers/form/DeleteFormResolverTest.java (4)

24-41: Test Case: Ensure successful form deletion

The testGetSuccess method correctly tests the successful deletion of a form. It verifies that the resolver calls the deleteEntity method on the EntityClient when the user has the necessary permissions.


43-61: Test Case: Ensure unauthorized access is handled

The testGetUnauthorized method correctly tests the handling of unauthorized access. It verifies that the resolver does not call the deleteEntity method on the EntityClient when the user lacks the necessary permissions.


63-81: Test Case: Ensure failure during form deletion is handled

The testGetFailure method correctly tests the handling of a failure during form deletion. It verifies that the resolver calls the deleteEntity method but does not call deleteEntityReferences when the deletion fails.


83-89: Helper Method: Mock EntityClient for testing

The initMockEntityClient method correctly mocks the EntityClient for different test scenarios. It throws a RemoteInvocationException when shouldSucceed is false, simulating a failure during the deletion process.

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/form/UpdateFormResolver.java (2)

29-31: Constructor: Ensure non-null EntityClient

The constructor correctly ensures that the EntityClient is not null, preventing potential NullPointerException issues.


33-97: Method: Validate form update logic

The get method correctly implements the logic for updating a form. It includes permission checks, validation of the form's existence, and updates to form details using FormInfoPatchBuilder. The method also handles exceptions appropriately, providing meaningful error messages.

datahub-graphql-core/src/test/java/com/linkedin/datahub/graphql/resolvers/form/UpdateFormResolverTest.java (4)

29-47: Test Case: Ensure successful form update

The testGetSuccess method correctly tests the successful update of a form. It verifies that the resolver calls the ingestProposal method on the EntityClient when the user has the necessary permissions.


49-65: Test Case: Ensure unauthorized access is handled

The testGetUnauthorized method correctly tests the handling of unauthorized access. It verifies that the resolver does not call the ingestProposal method on the EntityClient when the user lacks the necessary permissions.


67-83: Test Case: Ensure failure during form update is handled

The testGetFailure method correctly tests the handling of a failure during form update. It verifies that the resolver calls the ingestProposal method, but the operation fails as expected.


85-104: Helper Method: Mock EntityClient for testing

The initMockEntityClient method correctly mocks the EntityClient for different test scenarios. It provides mock responses for the getV2 and exists methods based on the shouldSucceed parameter.

datahub-graphql-core/src/test/java/com/linkedin/datahub/graphql/resolvers/form/CreateFormResolverTest.java (5)

31-50: Test Case: Ensure successful form creation

The testGetSuccess method correctly tests the successful creation of a form. It verifies that the resolver calls the createForm method on the FormService when the user has the necessary permissions.


52-69: Test Case: Ensure unauthorized access is handled

The testGetUnauthorized method correctly tests the handling of unauthorized access. It verifies that the resolver does not call the createForm method on the FormService when the user lacks the necessary permissions.


71-88: Test Case: Ensure failure during form creation is handled

The testGetFailure method correctly tests the handling of a failure during form creation. It verifies that the resolver calls the createForm method, but the operation fails as expected.


90-102: Helper Method: Mock FormService for testing

The initMockFormService method correctly mocks the FormService for different test scenarios. It throws a RuntimeException when shouldSucceed is false, simulating a failure during form creation.


104-115: Helper Method: Mock EntityClient for testing

The initMockEntityClient method correctly mocks the EntityClient for different test scenarios. It provides mock responses for the getV2 method.

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLEngine.java (2)

175-179: Imports Approved.

The new imports for CreateFormResolver, DeleteFormResolver, and UpdateFormResolver are correctly added and necessary for the new functionalities.


1327-1329: Form Management Resolvers Approved.

The new data fetchers for createForm, deleteForm, and updateForm are correctly added and associated with their respective resolvers. Ensure that these resolvers are thoroughly tested.

@@ -1050,6 +1053,28 @@ private void verifyEntityExists(@Nonnull OperationContext opContext, @Nonnull fi
}
}

/** Create a form given the formInfo aspect. */
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding input validation for the formInfo parameter.

While the method is well-structured, it's important to validate the formInfo object to ensure it contains the necessary data before proceeding.

Objects.requireNonNull(formInfo, "formInfo cannot be null");
// Additional validation logic here

Comment on lines +1062 to +1065
FormKey formKey = new FormKey();
String formId = id != null ? id : UUID.randomUUID().toString();
formKey.setId(formId);
Urn formUrn = EntityKeyUtils.convertEntityKeyToUrn(formKey, FORM_ENTITY_NAME);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding logging for better traceability.

Adding logging statements can help trace the flow of data and debug issues more effectively.

log.info("Creating form with ID: {}", formId);

Comment on lines +1067 to +1075
try {
this.entityClient.ingestProposal(
opContext,
AspectUtils.buildMetadataChangeProposal(formUrn, FORM_INFO_ASPECT_NAME, formInfo),
false);
return formUrn;
} catch (Exception e) {
throw new RuntimeException("Failed to create form", e);
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Improve error handling by adding logging.

Logging the error message can provide more context when debugging issues.

log.error("Failed to create form with ID: {}", formId, e);
throw new RuntimeException("Failed to create form", e);

Comment on lines 693 to 714
@Test
@Ignore
public void testLocalFormInfoRemove() {
RestEmitter restEmitter = new RestEmitter(RestEmitterConfig.builder().build());
try {
MetadataChangeProposal formInfoPatch =
new FormInfoPatchBuilder()
.urn(UrnUtils.getUrn("urn:li:form:123456"))
.removePrompts(List.of("1234", "abcd"))
.setName("Metadata Initiative 2024 (edited - again)")
.setDescription(null)
.removeAssignedUser("urn:li:corpuser:admin")
.removeAssignedGroup("urn:li:corpGroup:jdoe")
.build();
Future<MetadataWriteResponse> response = restEmitter.emit(formInfoPatch);

System.out.println(response.get().getResponseContent());

} catch (IOException | ExecutionException | InterruptedException e) {
System.out.println(Arrays.asList(e.getStackTrace()));
}
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add assertions to validate the emitted response.

The test function testLocalFormInfoRemove removes form prompts and emits a metadata change proposal. However, it lacks assertions to validate the response content.

-  System.out.println(response.get().getResponseContent());
+  MetadataWriteResponse writeResponse = response.get();
+  assertNotNull(writeResponse);
+  assertTrue(writeResponse.isSuccessful());
+  System.out.println(writeResponse.getResponseContent());
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
@Test
@Ignore
public void testLocalFormInfoRemove() {
RestEmitter restEmitter = new RestEmitter(RestEmitterConfig.builder().build());
try {
MetadataChangeProposal formInfoPatch =
new FormInfoPatchBuilder()
.urn(UrnUtils.getUrn("urn:li:form:123456"))
.removePrompts(List.of("1234", "abcd"))
.setName("Metadata Initiative 2024 (edited - again)")
.setDescription(null)
.removeAssignedUser("urn:li:corpuser:admin")
.removeAssignedGroup("urn:li:corpGroup:jdoe")
.build();
Future<MetadataWriteResponse> response = restEmitter.emit(formInfoPatch);
System.out.println(response.get().getResponseContent());
} catch (IOException | ExecutionException | InterruptedException e) {
System.out.println(Arrays.asList(e.getStackTrace()));
}
}
@Test
@Ignore
public void testLocalFormInfoRemove() {
RestEmitter restEmitter = new RestEmitter(RestEmitterConfig.builder().build());
try {
MetadataChangeProposal formInfoPatch =
new FormInfoPatchBuilder()
.urn(UrnUtils.getUrn("urn:li:form:123456"))
.removePrompts(List.of("1234", "abcd"))
.setName("Metadata Initiative 2024 (edited - again)")
.setDescription(null)
.removeAssignedUser("urn:li:corpuser:admin")
.removeAssignedGroup("urn:li:corpGroup:jdoe")
.build();
Future<MetadataWriteResponse> response = restEmitter.emit(formInfoPatch);
MetadataWriteResponse writeResponse = response.get();
assertNotNull(writeResponse);
assertTrue(writeResponse.isSuccessful());
System.out.println(writeResponse.getResponseContent());
} catch (IOException | ExecutionException | InterruptedException e) {
System.out.println(Arrays.asList(e.getStackTrace()));
}
}

Comment on lines 650 to 691
@Test
@Ignore
public void testLocalFormInfoAdd() {
RestEmitter restEmitter = new RestEmitter(RestEmitterConfig.builder().build());
try {
FormPrompt newPrompt =
new FormPrompt()
.setId("1234")
.setTitle("First Prompt")
.setType(FormPromptType.STRUCTURED_PROPERTY)
.setRequired(true)
.setStructuredPropertyParams(
new StructuredPropertyParams()
.setUrn(UrnUtils.getUrn("urn:li:structuredProperty:property1")));
FormPrompt newPrompt2 =
new FormPrompt()
.setId("abcd")
.setTitle("Second Prompt")
.setType(FormPromptType.FIELDS_STRUCTURED_PROPERTY)
.setRequired(false)
.setStructuredPropertyParams(
new StructuredPropertyParams()
.setUrn(UrnUtils.getUrn("urn:li:structuredProperty:property1")));

MetadataChangeProposal formInfoPatch =
new FormInfoPatchBuilder()
.urn(UrnUtils.getUrn("urn:li:form:123456"))
.addPrompts(List.of(newPrompt, newPrompt2))
.setName("Metadata Initiative 2024 (edited)")
.setDescription("Edited description")
.setOwnershipForm(true)
.addAssignedUser("urn:li:corpuser:admin")
.addAssignedGroup("urn:li:corpGroup:jdoe")
.build();
Future<MetadataWriteResponse> response = restEmitter.emit(formInfoPatch);

System.out.println(response.get().getResponseContent());

} catch (IOException | ExecutionException | InterruptedException e) {
System.out.println(Arrays.asList(e.getStackTrace()));
}
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add assertions to validate the emitted response.

The test function testLocalFormInfoAdd sets up form prompts and emits a metadata change proposal. However, it lacks assertions to validate the response content.

-  System.out.println(response.get().getResponseContent());
+  MetadataWriteResponse writeResponse = response.get();
+  assertNotNull(writeResponse);
+  assertTrue(writeResponse.isSuccessful());
+  System.out.println(writeResponse.getResponseContent());
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
@Test
@Ignore
public void testLocalFormInfoAdd() {
RestEmitter restEmitter = new RestEmitter(RestEmitterConfig.builder().build());
try {
FormPrompt newPrompt =
new FormPrompt()
.setId("1234")
.setTitle("First Prompt")
.setType(FormPromptType.STRUCTURED_PROPERTY)
.setRequired(true)
.setStructuredPropertyParams(
new StructuredPropertyParams()
.setUrn(UrnUtils.getUrn("urn:li:structuredProperty:property1")));
FormPrompt newPrompt2 =
new FormPrompt()
.setId("abcd")
.setTitle("Second Prompt")
.setType(FormPromptType.FIELDS_STRUCTURED_PROPERTY)
.setRequired(false)
.setStructuredPropertyParams(
new StructuredPropertyParams()
.setUrn(UrnUtils.getUrn("urn:li:structuredProperty:property1")));
MetadataChangeProposal formInfoPatch =
new FormInfoPatchBuilder()
.urn(UrnUtils.getUrn("urn:li:form:123456"))
.addPrompts(List.of(newPrompt, newPrompt2))
.setName("Metadata Initiative 2024 (edited)")
.setDescription("Edited description")
.setOwnershipForm(true)
.addAssignedUser("urn:li:corpuser:admin")
.addAssignedGroup("urn:li:corpGroup:jdoe")
.build();
Future<MetadataWriteResponse> response = restEmitter.emit(formInfoPatch);
System.out.println(response.get().getResponseContent());
} catch (IOException | ExecutionException | InterruptedException e) {
System.out.println(Arrays.asList(e.getStackTrace()));
}
}
@Test
@Ignore
public void testLocalFormInfoAdd() {
RestEmitter restEmitter = new RestEmitter(RestEmitterConfig.builder().build());
try {
FormPrompt newPrompt =
new FormPrompt()
.setId("1234")
.setTitle("First Prompt")
.setType(FormPromptType.STRUCTURED_PROPERTY)
.setRequired(true)
.setStructuredPropertyParams(
new StructuredPropertyParams()
.setUrn(UrnUtils.getUrn("urn:li:structuredProperty:property1")));
FormPrompt newPrompt2 =
new FormPrompt()
.setId("abcd")
.setTitle("Second Prompt")
.setType(FormPromptType.FIELDS_STRUCTURED_PROPERTY)
.setRequired(false)
.setStructuredPropertyParams(
new StructuredPropertyParams()
.setUrn(UrnUtils.getUrn("urn:li:structuredProperty:property1")));
MetadataChangeProposal formInfoPatch =
new FormInfoPatchBuilder()
.urn(UrnUtils.getUrn("urn:li:form:123456"))
.addPrompts(List.of(newPrompt, newPrompt2))
.setName("Metadata Initiative 2024 (edited)")
.setDescription("Edited description")
.setOwnershipForm(true)
.addAssignedUser("urn:li:corpuser:admin")
.addAssignedGroup("urn:li:corpGroup:jdoe")
.build();
Future<MetadataWriteResponse> response = restEmitter.emit(formInfoPatch);
MetadataWriteResponse writeResponse = response.get();
assertNotNull(writeResponse);
assertTrue(writeResponse.isSuccessful());
System.out.println(writeResponse.getResponseContent());
} catch (IOException | ExecutionException | InterruptedException e) {
System.out.println(Arrays.asList(e.getStackTrace()));
}
}

Comment on lines +211 to +215
@Nonnull
public static List<FormPrompt> mapPromptsToAdd(
@Nonnull final List<CreatePromptInput> promptsToAdd) {
return promptsToAdd.stream().map(FormUtils::mapPrompt).collect(Collectors.toList());
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure the promptsToAdd parameter is sanitized.

The mapPromptsToAdd method does not sanitize the input promptsToAdd. Ensure that the input is sanitized to prevent potential security issues.

public static List<FormPrompt> mapPromptsToAdd(
    @Nonnull final List<CreatePromptInput> promptsToAdd) {
    return promptsToAdd.stream().map(prompt -> mapPrompt(sanitizeInput(prompt))).collect(Collectors.toList());
}

Comment on lines +33 to +35
final DeleteFormInput input =
bindArgument(environment.getArgument("input"), DeleteFormInput.class);
final Urn formUrn = UrnUtils.getUrn(input.getUrn());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding input validation.

Validate the input parameter to ensure it is not null before proceeding.

final DeleteFormInput input = 
    bindArgument(environment.getArgument("input"), DeleteFormInput.class);
Objects.requireNonNull(input, "input must not be null");

Comment on lines +37 to +63
return CompletableFuture.supplyAsync(
() -> {
try {
if (!AuthorizationUtils.canManageForms(context)) {
throw new AuthorizationException("Unable to delete form. Please contact your admin.");
}
_entityClient.deleteEntity(context.getOperationContext(), formUrn);
// Asynchronously Delete all references to the entity (to return quickly)
CompletableFuture.runAsync(
() -> {
try {
_entityClient.deleteEntityReferences(context.getOperationContext(), formUrn);
} catch (Exception e) {
log.error(
String.format(
"Caught exception while attempting to clear all entity references for Form with urn %s",
formUrn),
e);
}
});

return true;
} catch (Exception e) {
throw new RuntimeException(
String.format("Failed to perform update against input %s", input), e);
}
});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding more granular error handling.

The catch block is catching all exceptions and throwing a RuntimeException. Consider handling specific exceptions to provide more detailed error messages.

try {
  if (!AuthorizationUtils.canManageForms(context)) {
    throw new AuthorizationException("Unable to delete form. Please contact your admin.");
  }
  _entityClient.deleteEntity(context.getOperationContext(), formUrn);
  // Asynchronously Delete all references to the entity (to return quickly)
  CompletableFuture.runAsync(
      () -> {
        try {
          _entityClient.deleteEntityReferences(context.getOperationContext(), formUrn);
        } catch (Exception e) {
          log.error(
              String.format(
                  "Caught exception while attempting to clear all entity references for Form with urn %s",
                  formUrn),
              e);
        }
      });
  return true;
} catch (AuthorizationException e) {
  throw e;
} catch (Exception e) {
  throw new RuntimeException(
      String.format("Failed to perform update against input %s", input), e);
}

Comment on lines +43 to +45
final CreateFormInput input =
bindArgument(environment.getArgument("input"), CreateFormInput.class);
final FormInfo formInfo = FormUtils.mapFormInfo(input);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding input validation.

Validate the input parameter to ensure it is not null before proceeding.

final CreateFormInput input = 
    bindArgument(environment.getArgument("input"), CreateFormInput.class);
Objects.requireNonNull(input, "input must not be null");

Comment on lines +47 to +65
return CompletableFuture.supplyAsync(
() -> {
try {
if (!AuthorizationUtils.canManageForms(context)) {
throw new AuthorizationException("Unable to create form. Please contact your admin.");
}
validatePrompts(input.getPrompts());

Urn formUrn =
_formService.createForm(context.getOperationContext(), formInfo, input.getId());
EntityResponse response =
_entityClient.getV2(
context.getOperationContext(), Constants.FORM_ENTITY_NAME, formUrn, null);
return FormMapper.map(context, response);
} catch (Exception e) {
throw new RuntimeException(
String.format("Failed to perform update against input %s", input), e);
}
});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding more granular error handling.

The catch block is catching all exceptions and throwing a RuntimeException. Consider handling specific exceptions to provide more detailed error messages.

try {
  if (!AuthorizationUtils.canManageForms(context)) {
    throw new AuthorizationException("Unable to create form. Please contact your admin.");
  }
  validatePrompts(input.getPrompts());
  Urn formUrn =
      _formService.createForm(context.getOperationContext(), formInfo, input.getId());
  EntityResponse response =
      _entityClient.getV2(
          context.getOperationContext(), Constants.FORM_ENTITY_NAME, formUrn, null);
  return FormMapper.map(context, response);
} catch (AuthorizationException e) {
  throw e;
} catch (Exception e) {
  throw new RuntimeException(
      String.format("Failed to perform update against input %s", input), e);
}

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 09f2b45 and 008e508.

Files selected for processing (1)
  • metadata-service/war/src/main/resources/boot/policies.json (3 hunks)
Additional comments not posted (3)
metadata-service/war/src/main/resources/boot/policies.json (3)

37-38: Addition of "MANAGE_DOCUMENTATION_FORMS" privilege in the Root User policy

The "MANAGE_DOCUMENTATION_FORMS" privilege has been added to the Root User policy. This change ensures that users with root access can manage documentation forms.


183-184: Addition of "MANAGE_DOCUMENTATION_FORMS" privilege in the Admin Platform policy

The "MANAGE_DOCUMENTATION_FORMS" privilege has been added to the Admin Platform policy. This change ensures that administrators have the necessary permissions to manage documentation forms.


270-271: Addition of "MANAGE_DOCUMENTATION_FORMS" privilege in the Editor Platform policy

The "MANAGE_DOCUMENTATION_FORMS" privilege has been added to the Editor Platform policy. This change ensures that editors have the necessary permissions to manage documentation forms.

@chriscollins3456 chriscollins3456 force-pushed the cc--forms-crud-graphql branch from 008e508 to 9ad0d8a Compare July 2, 2024 14:34
@chriscollins3456 chriscollins3456 changed the title WIP - feat(forms) Add CRUD endpoints to GraphQL for Form entities feat(forms) Add CRUD endpoints to GraphQL for Form entities Jul 2, 2024
@chriscollins3456 chriscollins3456 merged commit 3175571 into datahub-project:master Jul 2, 2024
36 of 38 checks passed
aviv-julienjehannet pushed a commit to aviv-julienjehannet/datahub that referenced this pull request Jul 17, 2024
arosanda added a commit to infobip/datahub that referenced this pull request Sep 23, 2024
* feat(forms) Handle deleting forms references when hard deleting forms (datahub-project#10820)

* refactor(ui): Misc improvements to the setup ingestion flow (ingest uplift 1/2)  (datahub-project#10764)

Co-authored-by: John Joyce <[email protected]>
Co-authored-by: John Joyce <[email protected]>

* fix(ingestion/airflow-plugin): pipeline tasks discoverable in search (datahub-project#10819)

* feat(ingest/transformer): tags to terms transformer (datahub-project#10758)

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

* fix(ingestion/unity-catalog): fixed issue with profiling with GE turned on (datahub-project#10752)

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

* feat(forms) Add java SDK for form entity PATCH + CRUD examples (datahub-project#10822)

* feat(SDK) Add java SDK for structuredProperty entity PATCH + CRUD examples (datahub-project#10823)

* feat(SDK) Add StructuredPropertyPatchBuilder in python sdk and provide sample CRUD files (datahub-project#10824)

* feat(forms) Add CRUD endpoints to GraphQL for Form entities (datahub-project#10825)

* add flag for includeSoftDeleted in scroll entities API (datahub-project#10831)

* feat(deprecation) Return actor entity with deprecation aspect (datahub-project#10832)

* feat(structuredProperties) Add CRUD graphql APIs for structured property entities (datahub-project#10826)

* add scroll parameters to openapi v3 spec (datahub-project#10833)

* fix(ingest): correct profile_day_of_week implementation (datahub-project#10818)

* feat(ingest/glue): allow ingestion of empty databases from Glue (datahub-project#10666)

Co-authored-by: Harshal Sheth <[email protected]>

* feat(cli): add more details to get cli (datahub-project#10815)

* fix(ingestion/glue): ensure date formatting works on all platforms for aws glue (datahub-project#10836)

* fix(ingestion): fix datajob patcher (datahub-project#10827)

* fix(smoke-test): add suffix in temp file creation (datahub-project#10841)

* feat(ingest/glue): add helper method to permit user or group ownership (datahub-project#10784)

* feat(): Show data platform instances in policy modal if they are set on the policy (datahub-project#10645)

Co-authored-by: Hendrik Richert <[email protected]>

* docs(patch): add patch documentation for how implementation works (datahub-project#10010)

Co-authored-by: John Joyce <[email protected]>

* fix(jar): add missing custom-plugin-jar task (datahub-project#10847)

* fix(): also check exceptions/stack trace when filtering log messages (datahub-project#10391)

Co-authored-by: John Joyce <[email protected]>

* docs(): Update posts.md (datahub-project#9893)

Co-authored-by: Hyejin Yoon <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* chore(ingest): update acryl-datahub-classify version (datahub-project#10844)

* refactor(ingest): Refactor structured logging to support infos, warnings, and failures structured reporting to UI (datahub-project#10828)

Co-authored-by: John Joyce <[email protected]>
Co-authored-by: Harshal Sheth <[email protected]>

* fix(restli): log aspect-not-found as a warning rather than as an error (datahub-project#10834)

* fix(ingest/nifi): remove duplicate upstream jobs (datahub-project#10849)

* fix(smoke-test): test access to create/revoke personal access tokens (datahub-project#10848)

* fix(smoke-test): missing test for move domain (datahub-project#10837)

* ci: update usernames to not considered for community (datahub-project#10851)

* env: change defaults for data contract visibility (datahub-project#10854)

* fix(ingest/tableau): quote special characters in external URL (datahub-project#10842)

* fix(smoke-test): fix flakiness of auto complete test

* ci(ingest): pin dask dependency for feast (datahub-project#10865)

* fix(ingestion/lookml): liquid template resolution and view-to-view cll (datahub-project#10542)

* feat(ingest/audit): add client id and version in system metadata props (datahub-project#10829)

* chore(ingest): Mypy 1.10.1 pin (datahub-project#10867)

* docs: use acryl-datahub-actions as expected python package to install (datahub-project#10852)

* docs: add new js snippet (datahub-project#10846)

* refactor(ingestion): remove company domain for security reason (datahub-project#10839)

* fix(ingestion/spark): Platform instance and column level lineage fix (datahub-project#10843)

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* feat(ingestion/tableau): optionally ingest multiple sites and create site containers (datahub-project#10498)

Co-authored-by: Yanik Häni <[email protected]>

* fix(ingestion/looker): Add sqlglot dependency and remove unused sqlparser (datahub-project#10874)

* fix(manage-tokens): fix manage access token policy (datahub-project#10853)

* Batch get entity endpoints (datahub-project#10880)

* feat(system): support conditional write semantics (datahub-project#10868)

* fix(build): upgrade vercel builds to Node 20.x (datahub-project#10890)

* feat(ingest/lookml): shallow clone repos (datahub-project#10888)

* fix(ingest/looker): add missing dependency (datahub-project#10876)

* fix(ingest): only populate audit stamps where accurate (datahub-project#10604)

* fix(ingest/dbt): always encode tag urns (datahub-project#10799)

* fix(ingest/redshift): handle multiline alter table commands (datahub-project#10727)

* fix(ingestion/looker): column name missing in explore (datahub-project#10892)

* fix(lineage) Fix lineage source/dest filtering with explored per hop limit (datahub-project#10879)

* feat(conditional-writes): misc updates and fixes (datahub-project#10901)

* feat(ci): update outdated action (datahub-project#10899)

* feat(rest-emitter): adding async flag to rest emitter (datahub-project#10902)

Co-authored-by: Gabe Lyons <[email protected]>

* feat(ingest): add snowflake-queries source (datahub-project#10835)

* fix(ingest): improve `auto_materialize_referenced_tags_terms` error handling (datahub-project#10906)

* docs: add new company to adoption list (datahub-project#10909)

* refactor(redshift): Improve redshift error handling with new structured reporting system (datahub-project#10870)

Co-authored-by: John Joyce <[email protected]>
Co-authored-by: Harshal Sheth <[email protected]>

* feat(ui) Finalize support for all entity types on forms (datahub-project#10915)

* Index ExecutionRequestResults status field (datahub-project#10811)

* feat(ingest): grafana connector (datahub-project#10891)

Co-authored-by: Shirshanka Das <[email protected]>
Co-authored-by: Harshal Sheth <[email protected]>

* fix(gms) Add Form entity type to EntityTypeMapper (datahub-project#10916)

* feat(dataset): add support for external url in Dataset (datahub-project#10877)

* docs(saas-overview) added missing features to observe section (datahub-project#10913)

Co-authored-by: John Joyce <[email protected]>

* fix(ingest/spark): Fixing Micrometer warning (datahub-project#10882)

* fix(structured properties): allow application of structured properties without schema file (datahub-project#10918)

* fix(data-contracts-web) handle other schedule types (datahub-project#10919)

* fix(ingestion/tableau): human-readable message for PERMISSIONS_MODE_SWITCHED error (datahub-project#10866)

Co-authored-by: Harshal Sheth <[email protected]>

* Add feature flag for view defintions (datahub-project#10914)

Co-authored-by: Ethan Cartwright <[email protected]>

* feat(ingest/BigQuery): refactor+parallelize dataset metadata extraction (datahub-project#10884)

* fix(airflow): add error handling around render_template() (datahub-project#10907)

* feat(ingestion/sqlglot): add optional `default_dialect` parameter to sqlglot lineage (datahub-project#10830)

* feat(mcp-mutator): new mcp mutator plugin (datahub-project#10904)

* fix(ingest/bigquery): changes helper function to decode unicode scape sequences (datahub-project#10845)

* feat(ingest/postgres): fetch table sizes for profile (datahub-project#10864)

* feat(ingest/abs): Adding azure blob storage ingestion source (datahub-project#10813)

* fix(ingest/redshift): reduce severity of SQL parsing issues (datahub-project#10924)

* fix(build): fix lint fix web react (datahub-project#10896)

* fix(ingest/bigquery): handle quota exceeded for project.list requests (datahub-project#10912)

* feat(ingest): report extractor failures more loudly (datahub-project#10908)

* feat(ingest/snowflake): integrate snowflake-queries into main source (datahub-project#10905)

* fix(ingest): fix docs build (datahub-project#10926)

* fix(ingest/snowflake): fix test connection (datahub-project#10927)

* fix(ingest/lookml): add view load failures to cache (datahub-project#10923)

* docs(slack) overhauled setup instructions and screenshots (datahub-project#10922)

Co-authored-by: John Joyce <[email protected]>

* fix(airflow): Add comma parsing of owners to DataJobs (datahub-project#10903)

* fix(entityservice): fix merging sideeffects (datahub-project#10937)

* feat(ingest): Support System Ingestion Sources, Show and hide system ingestion sources with Command-S (datahub-project#10938)

Co-authored-by: John Joyce <[email protected]>

* chore() Set a default lineage filtering end time on backend when a start time is present (datahub-project#10925)

Co-authored-by: John Joyce <[email protected]>
Co-authored-by: John Joyce <[email protected]>

* Added relationships APIs to V3. Added these generic APIs to V3 swagger doc. (datahub-project#10939)

* docs: add learning center to docs (datahub-project#10921)

* doc: Update hubspot form id (datahub-project#10943)

* chore(airflow): add python 3.11 w/ Airflow 2.9 to CI (datahub-project#10941)

* fix(ingest/Glue): column upstream lineage between S3 and Glue (datahub-project#10895)

* fix(ingest/abs): split abs utils into multiple files (datahub-project#10945)

* doc(ingest/looker): fix doc for sql parsing documentation (datahub-project#10883)

Co-authored-by: Harshal Sheth <[email protected]>

* fix(ingest/bigquery): Adding missing BigQuery types (datahub-project#10950)

* fix(ingest/setup): feast and abs source setup (datahub-project#10951)

* fix(connections) Harden adding /gms to connections in backend (datahub-project#10942)

* feat(siblings) Add flag to prevent combining siblings in the UI (datahub-project#10952)

* fix(docs): make graphql doc gen more automated (datahub-project#10953)

* feat(ingest/athena): Add option for Athena partitioned profiling (datahub-project#10723)

* fix(spark-lineage): default timeout for future responses (datahub-project#10947)

* feat(datajob/flow): add environment filter using info aspects (datahub-project#10814)

* fix(ui/ingest): correct privilege used to show tab (datahub-project#10483)

Co-authored-by: Kunal-kankriya <[email protected]>

* feat(ingest/looker): include dashboard urns in browse v2 (datahub-project#10955)

* add a structured type to batchGet in OpenAPI V3 spec (datahub-project#10956)

* fix(ui): scroll on the domain sidebar to show all domains (datahub-project#10966)

* fix(ingest/sagemaker): resolve incorrect variable assignment for SageMaker API call (datahub-project#10965)

* fix(airflow/build): Pinning mypy (datahub-project#10972)

* Fixed a bug where the OpenAPI V3 spec was incorrect. The bug was introduced in datahub-project#10939. (datahub-project#10974)

* fix(ingest/test): Fix for mssql integration tests (datahub-project#10978)

* fix(entity-service) exist check correctly extracts status (datahub-project#10973)

* fix(structuredProps) casing bug in StructuredPropertiesValidator (datahub-project#10982)

* bugfix: use anyOf instead of allOf when creating references in openapi v3 spec (datahub-project#10986)

* fix(ui): Remove ant less imports (datahub-project#10988)

* feat(ingest/graph): Add get_results_by_filter to DataHubGraph (datahub-project#10987)

* feat(ingest/cli): init does not actually support environment variables (datahub-project#10989)

* fix(ingest/graph): Update get_results_by_filter graphql query (datahub-project#10991)

* feat(ingest/spark): Promote beta plugin (datahub-project#10881)

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* feat(ingest): support domains in meta -> "datahub" section (datahub-project#10967)

* feat(ingest): add `check server-config` command (datahub-project#10990)

* feat(cli): Make consistent use of DataHubGraphClientConfig (datahub-project#10466)

Deprecates get_url_and_token() in favor of a more complete option: load_graph_config() that returns a full DatahubClientConfig.
This change was then propagated across previous usages of get_url_and_token so that connections to DataHub server from the client respect the full breadth of configuration specified by DatahubClientConfig.

I.e: You can now specify disable_ssl_verification: true in your ~/.datahubenv file so that all cli functions to the server work when ssl certification is disabled.

Fixes datahub-project#9705

* fix(ingest/s3): Fixing container creation when there is no folder in path (datahub-project#10993)

* fix(ingest/looker): support platform instance for dashboards & charts (datahub-project#10771)

* feat(ingest/bigquery): improve handling of information schema in sql parser (datahub-project#10985)

* feat(ingest): improve `ingest deploy` command (datahub-project#10944)

* fix(backend): allow excluding soft-deleted entities in relationship-queries; exclude soft-deleted members of groups (datahub-project#10920)

- allow excluding soft-deleted entities in relationship-queries
- exclude soft-deleted members of groups

* fix(ingest/looker): downgrade missing chart type log level (datahub-project#10996)

* doc(acryl-cloud): release docs for 0.3.4.x (datahub-project#10984)

Co-authored-by: John Joyce <[email protected]>
Co-authored-by: RyanHolstien <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Pedro Silva <[email protected]>

* fix(protobuf/build): Fix protobuf check jar script (datahub-project#11006)

* fix(ui/ingest): Support invalid cron jobs (datahub-project#10998)

* fix(ingest): fix graph config loading (datahub-project#11002)

Co-authored-by: Pedro Silva <[email protected]>

* feat(docs): Document __DATAHUB_TO_FILE_ directive (datahub-project#10968)

Co-authored-by: Harshal Sheth <[email protected]>

* fix(graphql/upsertIngestionSource): Validate cron schedule; parse error in CLI (datahub-project#11011)

* feat(ece): support custom ownership type urns in ECE generation (datahub-project#10999)

* feat(assertion-v2): changed Validation tab to Quality and created new Governance tab (datahub-project#10935)

* fix(ingestion/glue): Add support for missing config options for profiling in Glue (datahub-project#10858)

* feat(propagation): Add models for schema field docs, tags, terms (datahub-project#2959) (datahub-project#11016)

Co-authored-by: Chris Collins <[email protected]>

* docs: standardize terminology to DataHub Cloud (datahub-project#11003)

* fix(ingestion/transformer): replace the externalUrl container (datahub-project#11013)

* docs(slack) troubleshoot docs (datahub-project#11014)

* feat(propagation): Add graphql API (datahub-project#11030)

Co-authored-by: Chris Collins <[email protected]>

* feat(propagation):  Add models for Action feature settings (datahub-project#11029)

* docs(custom properties): Remove duplicate from sidebar (datahub-project#11033)

* feat(models): Introducing Dataset Partitions Aspect (datahub-project#10997)

Co-authored-by: John Joyce <[email protected]>
Co-authored-by: John Joyce <[email protected]>

* feat(propagation): Add Documentation Propagation Settings (datahub-project#11038)

* fix(models): chart schema fields mapping, add dataHubAction entity, t… (datahub-project#11040)

* fix(ci): smoke test lint failures (datahub-project#11044)

* docs: fix learning center color scheme & typo (datahub-project#11043)

* feat: add cloud main page (datahub-project#11017)

Co-authored-by: Jay <[email protected]>

* feat(restore-indices): add additional step to also clear system metadata service (datahub-project#10662)

Co-authored-by: John Joyce <[email protected]>

* docs: fix typo (datahub-project#11046)

* fix(lint): apply spotless (datahub-project#11050)

* docs(airflow): example query to get datajobs for a dataflow (datahub-project#11034)

* feat(cli): Add run-id option to put sub-command (datahub-project#11023)

Adds an option to assign run-id to a given put command execution. 
This is useful when transformers do not exist for a given ingestion payload, we can follow up with custom metadata and assign it to an ingestion pipeline.

* fix(ingest): improve sql error reporting calls (datahub-project#11025)

* fix(airflow): fix CI setup (datahub-project#11031)

* feat(ingest/dbt): add experimental `prefer_sql_parser_lineage` flag (datahub-project#11039)

* fix(ingestion/lookml): enable stack-trace in lookml logs (datahub-project#10971)

* (chore): Linting fix (datahub-project#11015)

* chore(ci): update deprecated github actions (datahub-project#10977)

* Fix ALB configuration example (datahub-project#10981)

* chore(ingestion-base): bump base image packages (datahub-project#11053)

* feat(cli): Trim report of dataHubExecutionRequestResult to max GMS size (datahub-project#11051)

* fix(ingestion/lookml): emit dummy sql condition for lookml custom condition tag (datahub-project#11008)

Co-authored-by: Harshal Sheth <[email protected]>

* fix(ingestion/powerbi): fix issue with broken report lineage (datahub-project#10910)

* feat(ingest/tableau): add retry on timeout (datahub-project#10995)

* change generate kafka connect properties from env (datahub-project#10545)

Co-authored-by: david-leifker <[email protected]>

* fix(ingest): fix oracle cronjob ingestion (datahub-project#11001)

Co-authored-by: david-leifker <[email protected]>

* chore(ci): revert update deprecated github actions (datahub-project#10977) (datahub-project#11062)

* feat(ingest/dbt-cloud): update metadata_endpoint inference (datahub-project#11041)

* build: Reduce size of datahub-frontend-react image by 50-ish% (datahub-project#10878)

Co-authored-by: david-leifker <[email protected]>

* fix(ci): Fix lint issue in datahub_ingestion_run_summary_provider.py (datahub-project#11063)

* docs(ingest): update developing-a-transformer.md (datahub-project#11019)

* feat(search-test): update search tests from datahub-project#10408 (datahub-project#11056)

* feat(cli): add aspects parameter to DataHubGraph.get_entity_semityped (datahub-project#11009)

Co-authored-by: Harshal Sheth <[email protected]>

* docs(airflow): update min version for plugin v2 (datahub-project#11065)

* doc(ingestion/tableau): doc update for derived permission (datahub-project#11054)

Co-authored-by: Pedro Silva <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Harshal Sheth <[email protected]>

* fix(py): remove dep on types-pkg_resources (datahub-project#11076)

* feat(ingest/mode): add option to exclude restricted (datahub-project#11081)

* fix(ingest): set lastObserved in sdk when unset (datahub-project#11071)

* doc(ingest): Update capabilities (datahub-project#11072)

* chore(vulnerability): Log Injection (datahub-project#11090)

* chore(vulnerability): Information exposure through a stack trace (datahub-project#11091)

* chore(vulnerability): Comparison of narrow type with wide type in loop condition (datahub-project#11089)

* chore(vulnerability): Insertion of sensitive information into log files (datahub-project#11088)

* chore(vulnerability): Risky Cryptographic Algorithm (datahub-project#11059)

* chore(vulnerability): Overly permissive regex range (datahub-project#11061)

Co-authored-by: Harshal Sheth <[email protected]>

* fix: update customer data (datahub-project#11075)

* fix(models): fixing the datasetPartition models (datahub-project#11085)

Co-authored-by: John Joyce <[email protected]>

* fix(ui): Adding view, forms GraphQL query, remove showing a fallback error message on unhandled GraphQL error (datahub-project#11084)

Co-authored-by: John Joyce <[email protected]>

* feat(docs-site): hiding learn more from cloud page (datahub-project#11097)

* fix(docs): Add correct usage of orFilters in search API docs (datahub-project#11082)

Co-authored-by: Jay <[email protected]>

* fix(ingest/mode): Regexp in mode name matcher didn't allow underscore (datahub-project#11098)

* docs: Refactor customer stories section (datahub-project#10869)

Co-authored-by: Jeff Merrick <[email protected]>

* fix(release): fix full/slim suffix on tag (datahub-project#11087)

* feat(config): support alternate hashing algorithm for doc id (datahub-project#10423)

Co-authored-by: david-leifker <[email protected]>
Co-authored-by: John Joyce <[email protected]>

* fix(emitter): fix typo in get method of java kafka emitter (datahub-project#11007)

* fix(ingest): use correct native data type in all SQLAlchemy sources by compiling data type using dialect (datahub-project#10898)

Co-authored-by: Harshal Sheth <[email protected]>

* chore: Update contributors list in PR labeler (datahub-project#11105)

* feat(ingest): tweak stale entity removal messaging (datahub-project#11064)

* fix(ingestion): enforce lastObserved timestamps in SystemMetadata (datahub-project#11104)

* fix(ingest/powerbi): fix broken lineage between chart and dataset (datahub-project#11080)

* feat(ingest/lookml): CLL support for sql set in sql_table_name attribute of lookml view (datahub-project#11069)

* docs: update graphql docs on forms & structured properties (datahub-project#11100)

* test(search): search openAPI v3 test (datahub-project#11049)

* fix(ingest/tableau): prevent empty site content urls (datahub-project#11057)

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* feat(entity-client): implement client batch interface (datahub-project#11106)

* fix(snowflake): avoid reporting warnings/info for sys tables (datahub-project#11114)

* fix(ingest): downgrade column type mapping warning to info (datahub-project#11115)

* feat(api): add AuditStamp to the V3 API entity/aspect response (datahub-project#11118)

* fix(ingest/redshift): replace r'\n' with '\n' to avoid token error redshift serverless… (datahub-project#11111)

* fix(entiy-client): handle null entityUrn case for restli (datahub-project#11122)

* fix(sql-parser): prevent bad urns from alter table lineage (datahub-project#11092)

* fix(ingest/bigquery): use small batch size if use_tables_list_query_v2 is set (datahub-project#11121)

* fix(graphql): add missing entities to EntityTypeMapper and EntityTypeUrnMapper (datahub-project#10366)

* feat(ui): Changes to allow editable dataset name (datahub-project#10608)

Co-authored-by: Jay Kadambi <[email protected]>

* fix: remove saxo (datahub-project#11127)

* feat(mcl-processor): Update mcl processor hooks (datahub-project#11134)

* fix(openapi): fix openapi v2 endpoints & v3 documentation update

* Revert "fix(openapi): fix openapi v2 endpoints & v3 documentation update"

This reverts commit 573c1cb.

* docs(policies): updates to policies documentation (datahub-project#11073)

* fix(openapi): fix openapi v2 and v3 docs update (datahub-project#11139)

* feat(auth): grant type and acr values custom oidc parameters support (datahub-project#11116)

* fix(mutator): mutator hook fixes (datahub-project#11140)

* feat(search): support sorting on multiple fields (datahub-project#10775)

* feat(ingest): various logging improvements (datahub-project#11126)

* fix(ingestion/lookml): fix for sql parsing error (datahub-project#11079)

Co-authored-by: Harshal Sheth <[email protected]>

* feat(docs-site) cloud page spacing and content polishes (datahub-project#11141)

* feat(ui) Enable editing structured props on fields (datahub-project#11042)

* feat(tests): add md5 and last computed to testResult model (datahub-project#11117)

* test(openapi): openapi regression smoke tests (datahub-project#11143)

* fix(airflow): fix tox tests + update docs (datahub-project#11125)

* docs: add chime to adoption stories (datahub-project#11142)

* fix(ingest/databricks): Updating code to work with Databricks sdk 0.30 (datahub-project#11158)

* fix(kafka-setup): add missing script to image (datahub-project#11190)

* fix(config): fix hash algo config (datahub-project#11191)

* test(smoke-test): updates to smoke-tests (datahub-project#11152)

* fix(elasticsearch): refactor idHashAlgo setting (datahub-project#11193)

* chore(kafka): kafka version bump (datahub-project#11211)

* readd UsageStatsWorkUnit

* fix merge problems

* change logo

---------

Co-authored-by: Chris Collins <[email protected]>
Co-authored-by: John Joyce <[email protected]>
Co-authored-by: John Joyce <[email protected]>
Co-authored-by: John Joyce <[email protected]>
Co-authored-by: dushayntAW <[email protected]>
Co-authored-by: sagar-salvi-apptware <[email protected]>
Co-authored-by: Aseem Bansal <[email protected]>
Co-authored-by: Kevin Chun <[email protected]>
Co-authored-by: jordanjeremy <[email protected]>
Co-authored-by: skrydal <[email protected]>
Co-authored-by: Harshal Sheth <[email protected]>
Co-authored-by: david-leifker <[email protected]>
Co-authored-by: sid-acryl <[email protected]>
Co-authored-by: Julien Jehannet <[email protected]>
Co-authored-by: Hendrik Richert <[email protected]>
Co-authored-by: Hendrik Richert <[email protected]>
Co-authored-by: RyanHolstien <[email protected]>
Co-authored-by: Felix Lüdin <[email protected]>
Co-authored-by: Pirry <[email protected]>
Co-authored-by: Hyejin Yoon <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: cburroughs <[email protected]>
Co-authored-by: ksrinath <[email protected]>
Co-authored-by: Mayuri Nehate <[email protected]>
Co-authored-by: Kunal-kankriya <[email protected]>
Co-authored-by: Shirshanka Das <[email protected]>
Co-authored-by: ipolding-cais <[email protected]>
Co-authored-by: Tamas Nemeth <[email protected]>
Co-authored-by: Shubham Jagtap <[email protected]>
Co-authored-by: haeniya <[email protected]>
Co-authored-by: Yanik Häni <[email protected]>
Co-authored-by: Gabe Lyons <[email protected]>
Co-authored-by: Gabe Lyons <[email protected]>
Co-authored-by: 808OVADOZE <[email protected]>
Co-authored-by: noggi <[email protected]>
Co-authored-by: Nicholas Pena <[email protected]>
Co-authored-by: Jay <[email protected]>
Co-authored-by: ethan-cartwright <[email protected]>
Co-authored-by: Ethan Cartwright <[email protected]>
Co-authored-by: Nadav Gross <[email protected]>
Co-authored-by: Patrick Franco Braz <[email protected]>
Co-authored-by: pie1nthesky <[email protected]>
Co-authored-by: Joel Pinto Mata (KPN-DSH-DEX team) <[email protected]>
Co-authored-by: Ellie O'Neil <[email protected]>
Co-authored-by: Ajoy Majumdar <[email protected]>
Co-authored-by: deepgarg-visa <[email protected]>
Co-authored-by: Tristan Heisler <[email protected]>
Co-authored-by: Andrew Sikowitz <[email protected]>
Co-authored-by: Davi Arnaut <[email protected]>
Co-authored-by: Pedro Silva <[email protected]>
Co-authored-by: amit-apptware <[email protected]>
Co-authored-by: Sam Black <[email protected]>
Co-authored-by: Raj Tekal <[email protected]>
Co-authored-by: Steffen Grohsschmiedt <[email protected]>
Co-authored-by: jaegwon.seo <[email protected]>
Co-authored-by: Renan F. Lima <[email protected]>
Co-authored-by: Matt Exchange <[email protected]>
Co-authored-by: Jonny Dixon <[email protected]>
Co-authored-by: Pedro Silva <[email protected]>
Co-authored-by: Pinaki Bhattacharjee <[email protected]>
Co-authored-by: Jeff Merrick <[email protected]>
Co-authored-by: skrydal <[email protected]>
Co-authored-by: AndreasHegerNuritas <[email protected]>
Co-authored-by: jayasimhankv <[email protected]>
Co-authored-by: Jay Kadambi <[email protected]>
Co-authored-by: David Leifker <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops PR or Issue related to DataHub backend & deployment ingestion PR or Issue related to the ingestion of metadata product PR or Issue related to the DataHub UI/UX
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants