chore() Set a default lineage filtering end time on backend when a start time is present

[jjoyce0510]

Summary

When a user provides a start time, they'd expect the end time to default to "now". This PR makes that a reality in the search/scroll across lineage resolvers.

QA

Validated the change locally to make sure no additional edges were hidden.

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

• Enhancements

  • Improved the calculation of endTimeMillis by using a new utility method, providing more accurate and consistent time handling across lineage queries.
  • Enhanced logic for initializing lineageFlags to better manage start and end times.

• New Features

  • Introduced a method to resolve the end time filter for lineage searches, allowing default to current time if only start time is provided.

[coderabbitai]

Walkthrough

The recent updates primarily enhance how the endTimeMillis parameter is computed in various resolver classes. By leveraging a new utility method getLineageEndTimeMillis from ResolverUtils, the logic ensures that if an endTimeMillis is not provided, it defaults to the current time. This change impacts several resolver classes and a mapper, ensuring a consistent approach to handling lineage end times across different components.

Changes

Files	Change Summary
.../graphql/resolvers/search/ScrollAcrossLineageResolver.java	Updated endTimeMillis calculation using ResolverUtils.getLineageEndTimeMillis method.
.../graphql/resolvers/search/SearchAcrossLineageResolver.java	Enhanced endTimeMillis computation logic, now utilizing ResolverUtils.getLineageEndTimeMillis.
.../graphql/resolvers/load/EntityLineageResultResolver.java	Modified endTimeMillis assignment to use ResolverUtils.getLineageEndTimeMillis and added necessary import statement.
.../graphql/resolvers/search/SearchUtils.java	Introduced a new method getLineageEndTimeMillis that resolves the end time filter for search queries.
.../graphql/resolvers/ResolverUtils.java	Added a new static method getLineageEndTimeMillis for calculating the lineage end time based on provided start and end times or defaulting to the current time.
.../graphql/types/common/mappers/LineageFlagsInputMapper.java	Adjusted endTimeMillis assignment to use ResolverUtils for calculation and included the necessary import.

Sequence Diagram(s)

sequenceDiagram
    participant Input
    participant ScrollAcrossLineageResolver
    participant ResolverUtils
    participant Output

    Input->>ScrollAcrossLineageResolver: get(startTimeMillis, endTimeMillis)
    ScrollAcrossLineageResolver->>ResolverUtils: getLineageEndTimeMillis(startTimeMillis, endTimeMillis)
    ResolverUtils-->>ScrollAcrossLineageResolver: endTimeMillis
    ScrollAcrossLineageResolver-->>Output: Processed Result

Loading

Poem

In the land of code where data flows,
A rabbit tweaks how time end goes.
With Utils' help, the line’s complete,
End time defaults, a tidy feat.
Cheers to changes, neat and sweet! 🐰✨

---

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 298c299 and 8e8b57f.

Files selected for processing (3)

• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/search/ScrollAcrossLineageResolver.java (1 hunks)
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/search/SearchAcrossLineageResolver.java (1 hunks)
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/search/SearchUtils.java (1 hunks)

Additional comments not posted (3)

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/search/ScrollAcrossLineageResolver.java (1)

81-82: Review of endTimeMillis calculation using SearchUtils.getLineageEndTimeMillis

The modification to calculate endTimeMillis using SearchUtils.getLineageEndTimeMillis is a significant improvement. This change ensures that if an endTimeMillis is not provided, the current time is used, which aligns with the PR's objective to set a default end time when a start time is present.

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/search/SearchAcrossLineageResolver.java (1)

114-115: Review of endTimeMillis calculation using SearchUtils.getLineageEndTimeMillis

The modification to calculate endTimeMillis using SearchUtils.getLineageEndTimeMillis in SearchAcrossLineageResolver is consistent with the changes in ScrollAcrossLineageResolver. This consistency across different resolvers ensures a uniform approach to handling default end times, which is beneficial for maintainability and reducing potential bugs.

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/search/SearchUtils.java (1)

334-343: Review of the new method getLineageEndTimeMillis in SearchUtils

The implementation of getLineageEndTimeMillis is straightforward and aligns with the requirements specified in the PR description. The method correctly handles the cases where either endTimeMillis or startTimeMillis is provided, defaulting to the current system time if only the start time is provided. This is a critical addition for ensuring that the system behaves as expected when only a start time is specified by the user.

[coderabbitai]

Actionable comments posted: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8e8b57f and 4edc522.

Files selected for processing (5)

• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/ResolverUtils.java (1 hunks)
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/load/EntityLineageResultResolver.java (2 hunks)
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/search/ScrollAcrossLineageResolver.java (1 hunks)
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/search/SearchAcrossLineageResolver.java (1 hunks)
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/common/mappers/LineageFlagsInputMapper.java (2 hunks)

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

• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/search/ScrollAcrossLineageResolver.java
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/search/SearchAcrossLineageResolver.java

Additional comments not posted (1)

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/load/EntityLineageResultResolver.java (1)

67-70: Correct Implementation of endTimeMillis Handling

The modification to use ResolverUtils.getLineageEndTimeMillis for determining endTimeMillis is correctly implemented and aligns with the PR objectives.

[coderabbitai]

Potential Bug in Setting endTimeMillis

The method correctly calculates endTimeMillis using ResolverUtils.getLineageEndTimeMillis, but it incorrectly sets this value in the result object. It should set the calculated endTimeMillis instead of the one possibly null from lineageFlags.

- result.setEndTimeMillis(lineageFlags.getEndTimeMillis());
+ result.setEndTimeMillis(endTimeMillis);

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

	// Default to "now" if no end time is provided, but start time is provided.
	Long endTimeMillis =
	ResolverUtils.getLineageEndTimeMillis(
	lineageFlags.getStartTimeMillis(), lineageFlags.getEndTimeMillis());
	if (endTimeMillis != null) {
	result.setEndTimeMillis(lineageFlags.getEndTimeMillis());
	}
	// Default to "now" if no end time is provided, but start time is provided.
	Long endTimeMillis =
	ResolverUtils.getLineageEndTimeMillis(
	lineageFlags.getStartTimeMillis(), lineageFlags.getEndTimeMillis());
	if (endTimeMillis != null) {
	result.setEndTimeMillis(endTimeMillis);
	}

[coderabbitai]

Well-Implemented Method for Defaulting endTimeMillis

The new method getLineageEndTimeMillis is implemented correctly. It provides a robust way to handle default end time values based on the presence of start time. This method is central to the PR's functionality and is well-integrated across the necessary files.

Would you like me to help in writing unit tests for this method to cover various edge cases?

[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 4edc522 and 8c779b4.

Files selected for processing (1)

• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/common/mappers/LineageFlagsInputMapper.java (2 hunks)

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

• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/common/mappers/LineageFlagsInputMapper.java