-
Notifications
You must be signed in to change notification settings - Fork 3.2k
feat(actions): add DomainNameResolver for human-friendly domain names #14355
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
base: master
Are you sure you want to change the base?
Conversation
Adds DomainNameResolver class to resolve domain URNs to human-readable display names in datahub-actions messages, improving user experience by showing friendly domain names instead of technical identifiers. Resolves: acryldata/datahub-actions#65 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Thanks for raising the PR! @hsheth2 could you take a look at this? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The change looks reasonable - can we add some tests?
Adds 10 unit test cases covering DomainNameResolver functionality: - Tests with/without DataHubGraph scenarios - Validates fallback behavior for missing/empty domain properties - Verifies NameResolverRegistry integration - Tests edge cases including None and empty string names - Ensures proper mocking and API contract verification All tests pass and follow existing code patterns and conventions. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Fixes type error where DomainPropertiesClass constructor was passed None for name parameter. Uses Mock object with name attribute set to None instead to satisfy type checking. All tests continue to pass and mypy reports success with no issues. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
these tests look extremely verbose - I was expecting something more like ~50 lines of code for the tests
assert entity_name == "Marketing Domain" | ||
|
||
|
||
def test_domain_name_resolver_with_graph_and_empty_string_name(): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this test is also not necessary imo
def test_domain_name_resolver_with_graph_no_properties(): | ||
"""Test DomainNameResolver when DataHubGraph is available but no properties found""" | ||
resolver = DomainNameResolver() | ||
domain_urn = Urn.from_string("urn:li:domain:marketing-domain") | ||
|
||
# Mock DataHubGraph that returns None for domain properties | ||
mock_graph = Mock() | ||
mock_graph.get_aspect.return_value = None | ||
|
||
entity_name = resolver.get_entity_name(domain_urn, mock_graph) | ||
|
||
# Should call get_aspect with correct parameters | ||
mock_graph.get_aspect.assert_called_once_with( | ||
str(domain_urn), DomainPropertiesClass | ||
) | ||
|
||
# Should fallback to the domain ID from the URN | ||
assert entity_name == "marketing-domain" | ||
|
||
def test_domain_name_resolver_with_graph_and_properties(): | ||
"""Test DomainNameResolver when DataHubGraph returns properties with name""" | ||
resolver = DomainNameResolver() | ||
domain_urn = Urn.from_string("urn:li:domain:marketing-domain") | ||
|
||
# Mock DataHubGraph that returns domain properties with a friendly name | ||
mock_graph = Mock() | ||
mock_properties = DomainPropertiesClass(name="Marketing Domain") | ||
mock_graph.get_aspect.return_value = mock_properties | ||
|
||
entity_name = resolver.get_entity_name(domain_urn, mock_graph) | ||
|
||
# Should call get_aspect with correct parameters | ||
mock_graph.get_aspect.assert_called_once_with( | ||
str(domain_urn), DomainPropertiesClass | ||
) | ||
|
||
# Should return the friendly name from properties | ||
assert entity_name == "Marketing Domain" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
these two tests look extremely similar - can you reduce the code duplication?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, collapsed the two testing scenarios into one.
|
||
entity_name = resolver.get_entity_name(domain_urn, mock_graph) | ||
|
||
# Should call get_aspect with correct parameters |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
these comments + docstrings are a bit overzealous. in general, comments should add new information and not just reexplain individual lines of code
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, removed the extra comments.
Adds DomainNameResolver class to resolve domain URNs to human-readable display names in datahub-actions messages, improving user experience by showing friendly domain names instead of technical identifiers.
Resolves: acryldata/datahub-actions#65