feat(api): add AuditStamp to the V3 API entity/aspect response

[ajoymajumdar]

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 a new data model for aspects, enhancing structure and management of data entity attributes.
  • Added new auditing capabilities to track changes or actions associated with data aspects.

• Improvements

  • Simplified data structures for better type safety and usability in data handling.
  • Enhanced metadata management through consistent schema definitions in OpenAPI specifications.
  • Improved semantic clarity and robustness in handling entity aspects within the application.

• Bug Fixes

  • Resolved inconsistencies in metadata handling within entity controllers.

[coderabbitai]

Walkthrough

The recent changes improve the management of data entity aspects within the OpenAPI framework. A new AspectItem class encapsulates essential metadata and audit details, enhancing type safety and clarity throughout the codebase. Other classes have been updated to incorporate this structure, streamlining how aspects and their metadata are handled. Overall, these modifications promote better organization and maintainability of the system's architecture.

Changes

Files	Change Summary
.../AspectItem.java	New AspectItem class created with fields for aspect, systemMetadata, and auditStamp.
.../GenericAspectV3.java	Added a new nullable auditStamp field to GenericAspectV3.
.../GenericEntityV3.java	Updated GenericEntityV3Builder to use AspectItem instead of Pair<RecordTemplate, SystemMetadata> for aspects.
.../OpenAPIV3Generator.java	Renamed a constant for audit management and added schema definitions for AuditStamp and system metadata.
.../controller/EntityController.java	Introduced toAspectItemMap method and updated aspect handling to utilize AspectItem.

Sequence Diagram(s)

sequenceDiagram
    participant Controller
    participant Builder
    participant AspectItem
    participant Metadata

    Controller->>Builder: buildEntityList()
    Builder->>AspectItem: createAspect()
    AspectItem->>Metadata: fetchSystemMetadata()
    AspectItem->>Builder: returnAspectItem()
    Builder->>Controller: return entities with aspects

Loading

Poem

In the fields where data hops,
New structures bloom with joyful flops.
With aspects clear and metadata bright,
Our code now dances, a wondrous sight!
Cheers to changes, let’s celebrate,
For a better future, we can’t wait! 🐰✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 Configuration 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.

[coderabbitai]

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 d6e46b9 and 8535478.

Files selected for processing (5)

• metadata-service/openapi-servlet/models/src/main/java/io/datahubproject/openapi/v3/models/AspectItem.java (1 hunks)
• metadata-service/openapi-servlet/models/src/main/java/io/datahubproject/openapi/v3/models/GenericAspectV3.java (1 hunks)
• metadata-service/openapi-servlet/models/src/main/java/io/datahubproject/openapi/v3/models/GenericEntityV3.java (2 hunks)
• metadata-service/openapi-servlet/src/main/java/io/datahubproject/openapi/v3/OpenAPIV3Generator.java (8 hunks)
• metadata-service/openapi-servlet/src/main/java/io/datahubproject/openapi/v3/controller/EntityController.java (5 hunks)

Additional comments not posted (10)

metadata-service/openapi-servlet/models/src/main/java/io/datahubproject/openapi/v3/models/AspectItem.java (1)

1-15: AspectItem.java looks good.

The class is well-structured and uses Lombok effectively for immutability and builder pattern. All imports are relevant.

metadata-service/openapi-servlet/models/src/main/java/io/datahubproject/openapi/v3/models/GenericAspectV3.java (1)

22-22: Addition of auditStamp field is appropriate.

The auditStamp field enhances the class by allowing optional audit information. The use of @Nullable is suitable.

metadata-service/openapi-servlet/models/src/main/java/io/datahubproject/openapi/v3/models/GenericEntityV3.java (1)

Line range hint 47-75:
Refactoring to use AspectItem improves clarity and type safety.

The change from Pair to AspectItem simplifies the data handling and enhances type safety. The handling of auditStamp is consistent and the use of ObjectMapper is appropriate with proper exception handling.

metadata-service/openapi-servlet/src/main/java/io/datahubproject/openapi/v3/controller/EntityController.java (3)

174-188: Refactoring approved.

The refactoring of buildEntityList to use AspectItem enhances clarity and maintainability by aligning with the new structure.

---

207-212: Refactoring approved.

The refactoring in buildGenericEntity to use AspectItem ensures consistency and improves maintainability.

---

151-164: LGTM! Verify supporting method correctness.

The toAspectItemMap method is well-implemented, utilizing Java Streams to convert aspects into AspectItem instances efficiently.

Ensure that the toRecordTemplate and lookupAspectSpec methods are correctly implemented and handle all edge cases.

Verification successful

---

Supporting Methods Verified: toRecordTemplate and lookupAspectSpec

The implementations of toRecordTemplate and lookupAspectSpec are robust and handle edge cases effectively. These methods are used throughout the codebase, confirming their reliability.

• toRecordTemplate uses RecordUtils for JSON deserialization, handling exceptions appropriately.
• lookupAspectSpec retrieves aspect specifications with a case-insensitive fallback.

No further issues found.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify the implementation of `toRecordTemplate` and `lookupAspectSpec` methods.

# Test: Search for the implementation of `toRecordTemplate` and `lookupAspectSpec`.
# Expect: Correct handling of all edge cases.
ast-grep --lang java --pattern $'$_ toRecordTemplate($_, $_) { $$$ }'
ast-grep --lang java --pattern $'$_ lookupAspectSpec($_, $_) { $$$ }'

Length of output: 141

---

Script:

#!/bin/bash
# Use ripgrep to search for the implementation of `toRecordTemplate` and `lookupAspectSpec` methods across the codebase.

# Search for the `toRecordTemplate` method.
rg 'toRecordTemplate\(' --context 5

# Search for the `lookupAspectSpec` method.
rg 'lookupAspectSpec\(' --context 5

Length of output: 116251

metadata-service/openapi-servlet/src/main/java/io/datahubproject/openapi/v3/OpenAPIV3Generator.java (4)

43-43: Renaming approved.

The renaming of NAME_ASYNC to NAME_AUDIT_STAMP aligns with the focus on audit stamp management, improving code clarity.

---

168-169: Schema definitions approved.

The addition of SystemMetadata and AuditStamp schemas enhances the OpenAPI specification by ensuring proper metadata representation.

---

578-590: Property inclusion approved.

The inclusion of SystemMetadata and AuditStamp in buildAspectRefResponseSchema ensures comprehensive metadata representation.

---

602-602: Parameter name update approved.

Updating parameter names to use NAME_SYSTEM_METADATA improves maintainability and consistency.

[coderabbitai]

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 8535478 and d4a60ce.

Files selected for processing (5)

• metadata-service/openapi-servlet/models/src/main/java/io/datahubproject/openapi/v3/models/AspectItem.java (1 hunks)
• metadata-service/openapi-servlet/models/src/main/java/io/datahubproject/openapi/v3/models/GenericAspectV3.java (1 hunks)
• metadata-service/openapi-servlet/models/src/main/java/io/datahubproject/openapi/v3/models/GenericEntityV3.java (2 hunks)
• metadata-service/openapi-servlet/src/main/java/io/datahubproject/openapi/v3/OpenAPIV3Generator.java (8 hunks)
• metadata-service/openapi-servlet/src/main/java/io/datahubproject/openapi/v3/controller/EntityController.java (5 hunks)

Files skipped from review as they are similar to previous changes (5)

• metadata-service/openapi-servlet/models/src/main/java/io/datahubproject/openapi/v3/models/AspectItem.java
• metadata-service/openapi-servlet/models/src/main/java/io/datahubproject/openapi/v3/models/GenericAspectV3.java
• metadata-service/openapi-servlet/models/src/main/java/io/datahubproject/openapi/v3/models/GenericEntityV3.java
• metadata-service/openapi-servlet/src/main/java/io/datahubproject/openapi/v3/OpenAPIV3Generator.java
• metadata-service/openapi-servlet/src/main/java/io/datahubproject/openapi/v3/controller/EntityController.java

[david-leifker]

@ajoymajumdar Looks good, please run ./gradlew spotlessApply --rerun-tasks and that should fix the linting error.

[coderabbitai]

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 d4a60ce and 7e79b3e.

Files selected for processing (5)

• metadata-service/openapi-servlet/models/src/main/java/io/datahubproject/openapi/v3/models/AspectItem.java (1 hunks)
• metadata-service/openapi-servlet/models/src/main/java/io/datahubproject/openapi/v3/models/GenericAspectV3.java (1 hunks)
• metadata-service/openapi-servlet/models/src/main/java/io/datahubproject/openapi/v3/models/GenericEntityV3.java (3 hunks)
• metadata-service/openapi-servlet/src/main/java/io/datahubproject/openapi/v3/OpenAPIV3Generator.java (8 hunks)
• metadata-service/openapi-servlet/src/main/java/io/datahubproject/openapi/v3/controller/EntityController.java (5 hunks)

Files skipped from review due to trivial changes (1)

• metadata-service/openapi-servlet/models/src/main/java/io/datahubproject/openapi/v3/models/GenericAspectV3.java

Files skipped from review as they are similar to previous changes (3)

• metadata-service/openapi-servlet/models/src/main/java/io/datahubproject/openapi/v3/models/AspectItem.java
• metadata-service/openapi-servlet/models/src/main/java/io/datahubproject/openapi/v3/models/GenericEntityV3.java
• metadata-service/openapi-servlet/src/main/java/io/datahubproject/openapi/v3/OpenAPIV3Generator.java

Additional comments not posted (4)

metadata-service/openapi-servlet/src/main/java/io/datahubproject/openapi/v3/controller/EntityController.java (4)

145-146: LGTM!

The use of toAspectItemMap enhances the readability and maintainability of the code by encapsulating the conversion logic into a separate method.

---

151-164: Well-structured method!

The toAspectItemMap method efficiently converts a list of EnvelopedAspect objects into a map of AspectItem instances using Java Streams. It handles the inclusion of system metadata and audit stamps appropriately.

---

174-188: Good transition to AspectItem!

The transition from Pair<RecordTemplate, SystemMetadata> to AspectItem aligns with the new structure and enhances the semantic clarity of the code.

---

207-212: Effective use of builder pattern!

The use of the builder pattern to construct AspectItem improves code readability and maintainability.