Handle edge case where display_name is None

MatMoore · MatMoore · commit e5c840b38b46 · 2024-06-27T17:00:18.000+01:00
via https://ministryofjustice.sentry.io/issues/5529696082/?project=4507181591101440&referrer=github-open-pr-bot
diff --git a/lib/datahub-client/data_platform_catalogue/client/datahub_client.py b/lib/datahub-client/data_platform_catalogue/client/datahub_client.py
@@ -344,7 +344,7 @@ def get_database_details(self, urn: str) -> Database:
                     for entity in response["entities"]["searchResults"]
                     if any(
                         tag.urn == "urn:li:tag:dc_display_in_catalogue"
-                        for tag in parse_tags(entity)
+                        for tag in parse_tags(entity["entity"])
                     )
                 ]
 
diff --git a/lib/datahub-client/data_platform_catalogue/client/graphql/getContainerDetails.graphql b/lib/datahub-client/data_platform_catalogue/client/graphql/getContainerDetails.graphql
@@ -30,7 +30,7 @@ query getContainer($urn: String!) {
     subTypes {
       typeNames
     }
-    entities(input: {start: 0, count: 500}) {
+    entities(input: { start: 0, count: 500 }) {
       total
       searchResults {
         entity {
@@ -171,7 +171,9 @@ fragment datasetDetails on Dataset {
   editableProperties {
     description
   }
-  ..globalTagsFields
+  tags {
+    ...globalTagsFields
+  }
 }
 
 fragment entityContainer on Container {
diff --git a/lib/datahub-client/data_platform_catalogue/client/graphql_helpers.py b/lib/datahub-client/data_platform_catalogue/client/graphql_helpers.py
@@ -36,7 +36,7 @@ def parse_owner(entity: dict[str, Any]) -> OwnerRef:
             else properties.get("fullName", "")
         )
         owner_details = OwnerRef(
-            display_name=display_name,
+            display_name=display_name or "",
             email=properties.get("email", ""),
             urn=owners[0].get("urn", ""),
         )
diff --git a/lib/datahub-client/tests/client/datahub/test_datahub_client.py b/lib/datahub-client/tests/client/datahub/test_datahub_client.py
@@ -517,31 +517,35 @@ def test_get_database_details_filters_entities(
                     "total": 2,
                     "searchResults": [
                         {
-                            "name": "DatasetToShow",
-                            "properties": {
+                            "entity": {
                                 "name": "DatasetToShow",
-                                "description": "Dataset to show",
-                            },
-                            "tags": {
-                                "tags": [
-                                    {
-                                        "tag": {
-                                            "urn": "urn:li:tag:dc_display_in_catalogue",
-                                            "properties": {
-                                                "name": "dc:display_in_catalogue",
-                                            },
+                                "properties": {
+                                    "name": "DatasetToShow",
+                                    "description": "Dataset to show",
+                                },
+                                "tags": {
+                                    "tags": [
+                                        {
+                                            "tag": {
+                                                "urn": "urn:li:tag:dc_display_in_catalogue",
+                                                "properties": {
+                                                    "name": "dc:display_in_catalogue",
+                                                },
+                                            }
                                         }
-                                    }
-                                ]
-                            },
+                                    ]
+                                },
+                            }
                         },
                         {
-                            "name": "DatasetToHide",
-                            "properties": {
+                            "entity": {
                                 "name": "DatasetToHide",
-                                "description": "Dataset to hide",
-                            },
-                            "tags": {"tags": []},
+                                "properties": {
+                                    "name": "DatasetToHide",
+                                    "description": "Dataset to hide",
+                                },
+                                "tags": {"tags": []},
+                            }
                         },
                     ],
                 },
@@ -564,23 +568,25 @@ def test_get_database_details_filters_entities(
             database = datahub_client.get_database_details(urn)
             assert database.tables == [
                 {
-                    "name": "DatasetToShow",
-                    "properties": {
-                        "description": "Dataset to show",
+                    "entity": {
                         "name": "DatasetToShow",
-                    },
-                    "tags": {
-                        "tags": [
-                            {
-                                "tag": {
-                                    "properties": {
-                                        "name": "dc:display_in_catalogue",
+                        "properties": {
+                            "description": "Dataset to show",
+                            "name": "DatasetToShow",
+                        },
+                        "tags": {
+                            "tags": [
+                                {
+                                    "tag": {
+                                        "properties": {
+                                            "name": "dc:display_in_catalogue",
+                                        },
+                                        "urn": "urn:li:tag:dc_display_in_catalogue",
                                     },
-                                    "urn": "urn:li:tag:dc_display_in_catalogue",
                                 },
-                            },
-                        ],
-                    },
+                            ],
+                        },
+                    }
                 }
             ]
 

Original file line number	Diff line number	Diff line change
`@@ -344,7 +344,7 @@ def get_database_details(self, urn: str) -> Database:`
`344`	`344`	`for entity in response["entities"]["searchResults"]`
`345`	`345`	`if any(`
`346`	`346`	`tag.urn == "urn:li:tag:dc_display_in_catalogue"`
`347`		`- for tag in parse_tags(entity)`
	`347`	`+ for tag in parse_tags(entity["entity"])`
`348`	`348`	`)`
`349`	`349`	`]`
`350`	`350`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ query getContainer($urn: String!) {`
`30`	`30`	`subTypes {`
`31`	`31`	`typeNames`
`32`	`32`	`}`
`33`		`- entities(input: {start: 0, count: 500}) {`
	`33`	`+ entities(input: { start: 0, count: 500 }) {`
`34`	`34`	`total`
`35`	`35`	`searchResults {`
`36`	`36`	`entity {`
`@@ -171,7 +171,9 @@ fragment datasetDetails on Dataset {`
`171`	`171`	`editableProperties {`
`172`	`172`	`description`
`173`	`173`	`}`
`174`		`- ..globalTagsFields`
	`174`	`+ tags {`
	`175`	`+ ...globalTagsFields`
	`176`	`+ }`
`175`	`177`	`}`
`176`	`178`
`177`	`179`	`fragment entityContainer on Container {`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ def parse_owner(entity: dict[str, Any]) -> OwnerRef:`
`36`	`36`	`else properties.get("fullName", "")`
`37`	`37`	`)`
`38`	`38`	`owner_details = OwnerRef(`
`39`		`- display_name=display_name,`
	`39`	`+ display_name=display_name or "",`
`40`	`40`	`email=properties.get("email", ""),`
`41`	`41`	`urn=owners[0].get("urn", ""),`
`42`	`42`	`)`