Fix: Report page url fix for PowerBI (#24651)

* report page url fix

* add tests

Author: harshsoni2024

ingestion/src/metadata/ingestion/source/dashboard/powerbi/client.py

@@ -38,6 +38,7 @@
     PowerBIReport,
     PowerBiTable,
     PowerBiToken,
+    ReportPagesAPIResponse,
     ReportsResponse,
     TablesResponse,
     Tile,
@@ -281,6 +282,21 @@ def fetch_dataset_tables(
 
         return None
 
+    def fetch_report_pages(self, group_id: str, report_id: str) -> Optional[List[dict]]:
+        # get report pages for report url formation
+        try:
+            # https://api.powerbi.com/v1.0/myorg/groups/4e57dcbb-***/reports/a2902011-***/pages
+            response_data = self.client.get(
+                f"/myorg/groups/{group_id}/reports/{report_id}/pages"
+            )
+            if response_data:
+                response = ReportPagesAPIResponse(**response_data)
+                return response.value
+        except Exception as exc:
+            logger.debug(traceback.format_exc())
+            logger.warning(f"Error fetching report pages: {exc}")
+        return []
+
     def regex_to_odata_condition(self, regex: str) -> str:
         """
         Convert a regex pattern to an OData filter condition

ingestion/src/metadata/ingestion/source/dashboard/powerbi/metadata.py

@@ -71,6 +71,7 @@
     PowerBiMeasureModel,
     PowerBIReport,
     PowerBiTable,
+    ReportPage,
 )
 from metadata.ingestion.source.database.column_type_parser import ColumnTypeParser
 from metadata.utils import fqn
@@ -305,9 +306,23 @@ def _get_report_url(self, workspace_id: str, dashboard_id: str) -> str:
         """
         Method to build the dashboard url
         """
+        page_id = ""
+        try:
+            pages: Optional[
+                List[ReportPage]
+            ] = self.client.api_client.fetch_report_pages(workspace_id, dashboard_id)
+            if len(pages) >= 1:
+                # get first page out of multiple pages otherwise
+                # get page if of single page
+                page_id = pages[0].name
+            page_id = f"/{page_id}" if page_id else ""
+        except Exception as exc:
+            logger.debug(traceback.format_exc())
+            logger.warning(f"Error building report page url: {exc}")
+        # https://app.powerbi.com/groups/4e57dcbb-***/reports/a2902011-***/098b***?experience=power-bi
         return (
             f"{clean_uri(self.service_connection.hostPort)}/groups/"
-            f"{workspace_id}/reports/{dashboard_id}/ReportSection?experience=power-bi"
+            f"{workspace_id}/reports/{dashboard_id}{page_id}?experience=power-bi"
         )
 
     def _get_dataset_url(self, workspace_id: str, dataset_id: str) -> str:

ingestion/src/metadata/ingestion/source/dashboard/powerbi/models.py

@@ -302,3 +302,22 @@ class DataModelSchema(BaseModel):
 
     tables: Optional[List[PowerBiTable]] = None
     connectionFile: Optional[ConnectionFile] = None
+
+
+class ReportPage(BaseModel):
+    """
+    PowerBI report pages API response
+    single report Page object
+    """
+
+    name: str
+    displayName: Optional[str] = None
+
+
+class ReportPagesAPIResponse(BaseModel):
+    """
+    PowerBI report pages API response
+    """
+
+    odata_context: str = Field(alias="@odata.context")
+    value: Optional[List[ReportPage]] = None

ingestion/tests/unit/topology/dashboard/test_powerbi.py

@@ -23,6 +23,7 @@
     PowerBIDashboard,
     PowerBiTable,
     PowerBITableSource,
+    ReportPage,
     UpstreaDataflow,
 )
 from metadata.utils import fqn
@@ -741,3 +742,87 @@ def test_create_dataset_upstream_dataset_column_lineage(self):
         self.assertEqual(
             result[0].toColumn.root, "service.downstream_dataset.orders.order_id"
         )
+
+    @pytest.mark.order(13)
+    def test_get_report_url(self):
+        """
+        Test report URL generation with different page scenarios
+        """
+        from unittest.mock import MagicMock
+
+        workspace_id = "test-workspace-123"
+        dashboard_id = "test-dashboard-456"
+
+        # Create a mock client with api_client
+        mock_api_client = MagicMock()
+        self.powerbi.client = MagicMock()
+        self.powerbi.client.api_client = mock_api_client
+
+        # Test with multiple pages - should use first page name
+        with patch(
+            "metadata.ingestion.source.dashboard.powerbi.metadata.clean_uri"
+        ) as mock_clean_uri:
+            mock_clean_uri.return_value = "https://app.powerbi.com"
+            mock_api_client.fetch_report_pages.return_value = [
+                ReportPage(name="page1", displayName="Page 1"),
+                ReportPage(name="page2", displayName="Page 2"),
+                ReportPage(name="page3", displayName="Page 3"),
+            ]
+
+            result = self.powerbi._get_report_url(workspace_id, dashboard_id)
+
+            mock_api_client.fetch_report_pages.assert_called_once_with(
+                workspace_id, dashboard_id
+            )
+            self.assertEqual(
+                result,
+                f"https://app.powerbi.com/groups/{workspace_id}/reports/{dashboard_id}/page1?experience=power-bi",
+            )
+
+        # Test with single page - should use that page name
+        with patch(
+            "metadata.ingestion.source.dashboard.powerbi.metadata.clean_uri"
+        ) as mock_clean_uri:
+            mock_clean_uri.return_value = "https://app.powerbi.com"
+            mock_api_client.fetch_report_pages.reset_mock()
+            mock_api_client.fetch_report_pages.return_value = [
+                ReportPage(name="single-page", displayName="Single Page")
+            ]
+
+            result = self.powerbi._get_report_url(workspace_id, dashboard_id)
+
+            self.assertEqual(
+                result,
+                f"https://app.powerbi.com/groups/{workspace_id}/reports/{dashboard_id}/single-page?experience=power-bi",
+            )
+
+        # Test with no pages - should not add page_id
+        with patch(
+            "metadata.ingestion.source.dashboard.powerbi.metadata.clean_uri"
+        ) as mock_clean_uri:
+            mock_clean_uri.return_value = "https://app.powerbi.com"
+            mock_api_client.fetch_report_pages.reset_mock()
+            mock_api_client.fetch_report_pages.return_value = []
+
+            result = self.powerbi._get_report_url(workspace_id, dashboard_id)
+
+            self.assertEqual(
+                result,
+                f"https://app.powerbi.com/groups/{workspace_id}/reports/{dashboard_id}?experience=power-bi",
+            )
+
+        # Test with exception during fetch_report_pages - should handle gracefully
+        with patch(
+            "metadata.ingestion.source.dashboard.powerbi.metadata.clean_uri"
+        ) as mock_clean_uri:
+            mock_clean_uri.return_value = "https://app.powerbi.com"
+            mock_api_client.fetch_report_pages.reset_mock()
+            mock_api_client.fetch_report_pages.side_effect = Exception("API Error")
+
+            result = self.powerbi._get_report_url(workspace_id, dashboard_id)
+
+            # Should build URL without page_id when exception occurs
+            self.assertEqual(
+                result,
+                f"https://app.powerbi.com/groups/{workspace_id}/reports/{dashboard_id}?experience=power-bi",
+            )