Merge pull request #224 from Shubha-accenture/bigquery-api-check

Perform the Bigquery API check on the server side instead of directly from the UI.

Author: ojarjur

dataproc_jupyter_plugin/controllers/bigquery.py

@@ -14,11 +14,12 @@
 
 
 import json
+import subprocess
 
 import aiohttp
 import tornado
 from jupyter_server.base.handlers import APIHandler
-
+from google.cloud.jupyter_config.config import async_run_gcloud_subcommand
 from dataproc_jupyter_plugin import credentials
 from dataproc_jupyter_plugin.services import bigquery
 
@@ -158,3 +159,17 @@ async def post(self):
         except Exception as e:
             self.log.exception("Error fetching search data")
             self.finish({"error": str(e)})
+
+
+class CheckApiController(APIHandler):
+    @tornado.web.authenticated
+    async def post(self):
+        try:
+            project_id = await credentials._gcp_project()
+            cmd = f"services list --enabled --project={project_id} | grep bigquery.googleapis.com"
+            result = await async_run_gcloud_subcommand(cmd)
+            is_enabled = bool(result.strip())
+            self.finish({"success": True, "is_enabled": is_enabled})
+
+        except Exception as e:
+            self.finish({"success": False, "is_enabled": False, "error": str(e)})

dataproc_jupyter_plugin/handlers.py

@@ -230,6 +230,7 @@ def full_path(name):
         "bigQueryPreview": bigquery.PreviewController,
         "bigQueryProjectsList": bigquery.ProjectsController,
         "bigQuerySearch": bigquery.SearchController,
+        "bigQueryApiEnabled": bigquery.CheckApiController,
     }
     handlers = [(full_path(name), handler) for name, handler in handlersMap.items()]
     web_app.add_handlers(host_pattern, handlers)

src/bigQuery/bigQueryService.tsx

@@ -421,17 +421,17 @@ export class BigQueryService {
     }
   };
 
-  static listBigQueryDatasetsAPIService = async (projectId: string) => {
-    const pageToken = '';
+  static checkBigQueryDatasetsAPIService = async () => {
     try {
-      const data: any = await requestAPI(
-        `bigQueryDataset?project_id=${projectId}&pageToken=${pageToken}`
-      );
+      const data: any = await requestAPI(`bigQueryApiEnabled`, {
+        method: 'POST'
+      });
       return data;
     } catch (reason) {
       return reason;
     }
   };
+
   static getBigQuerySearchCatalogAPIService = async () => {
     try {
       const data: any = await requestAPI(

src/index.ts

@@ -181,9 +181,7 @@ const extension: JupyterFrontEndPlugin<void> = {
       const credentials = await authApi();
       if (credentials?.project_id) {
         bigqueryDatasetsResponse =
-          await BigQueryService.listBigQueryDatasetsAPIService(
-            credentials.project_id
-          );
+          await BigQueryService.checkBigQueryDatasetsAPIService();
       }
 
       const dataCatalogResponse =
@@ -195,53 +193,57 @@ const extension: JupyterFrontEndPlugin<void> = {
           errorKey: 'error.message',
           errorMessage: 'Cloud Dataproc API has not been used in project',
           notificationMessage: 'The Cloud Dataproc API is not enabled.',
-          enableLink:
-            'https://console.cloud.google.com/apis/library/dataproc.googleapis.com'
+          enableLink: `https://console.cloud.google.com/apis/library/dataproc.googleapis.com?project=${credentials?.project_id}`
         },
         {
           response: bigqueryDatasetsResponse,
           errorKey: 'error',
+          checkType: 'bigquery',
           errorMessage: 'has not enabled BigQuery',
           notificationMessage: 'The BigQuery API is not enabled.',
-          enableLink:
-            'https://console.cloud.google.com/apis/library/bigquery.googleapis.com'
+          enableLink: `https://console.cloud.google.com/apis/library/bigquery.googleapis.com?project=${credentials?.project_id}`
         },
         {
           response: dataCatalogResponse,
           errorKey: 'error',
           errorMessage:
             'Google Cloud Data Catalog API has not been used in project',
           notificationMessage: 'Google Cloud Data Catalog API is not enabled.',
-          enableLink:
-            'https://console.cloud.google.com/apis/library/datacatalog.googleapis.com'
+          enableLink: `https://console.cloud.google.com/apis/library/datacatalog.googleapis.com?project=${credentials?.project_id}`
         }
       ];
-
-      apiChecks.forEach(
-        ({
-          response,
-          errorKey,
-          errorMessage,
-          notificationMessage,
-          enableLink
-        }) => {
-          const errorValue = errorKey
+      apiChecks.forEach(check => {
+        if (check.checkType === 'bigquery') {
+          if (check.response && check.response.is_enabled === false) {
+            Notification.error(check.notificationMessage, {
+              actions: [
+                {
+                  label: 'Enable',
+                  callback: () => window.open(check.enableLink, '_blank'),
+                  displayType: 'link'
+                }
+              ],
+              autoClose: false
+            });
+          }
+        } else {
+          const errorValue = check.errorKey
             .split('.')
-            .reduce((acc, key) => acc?.[key], response);
-          if (errorValue && errorValue.includes(errorMessage)) {
-            Notification.error(notificationMessage, {
+            .reduce((acc, key) => acc?.[key], check.response);
+          if (errorValue && errorValue.includes(check.errorMessage)) {
+            Notification.error(check.notificationMessage, {
               actions: [
                 {
                   label: 'Enable',
-                  callback: () => window.open(enableLink, '_blank'),
+                  callback: () => window.open(check.enableLink, '_blank'),
                   displayType: 'link'
                 }
               ],
               autoClose: false
             });
           }
         }
-      );
+      });
     };
 
     await checkAllApisEnabled();
@@ -340,10 +342,7 @@ const extension: JupyterFrontEndPlugin<void> = {
         panelDpms.addWidget(new dpmsWidget(app as JupyterLab, themeManager));
         onThemeChanged();
         app.shell.add(panelDpms, 'left', { rank: 1001 });
-        DataprocLoggingService.log(
-          'Metastore is enabled',
-          LOG_LEVEL.INFO
-        );
+        DataprocLoggingService.log('Metastore is enabled', LOG_LEVEL.INFO);
       }
 
       if (enableCloudStorage) {
@@ -358,10 +357,7 @@ const extension: JupyterFrontEndPlugin<void> = {
         );
         onThemeChanged();
         app.shell.add(panelGcs, 'left', { rank: 1002 });
-        DataprocLoggingService.log(
-          'Cloud storage is enabled',
-          LOG_LEVEL.INFO
-        );
+        DataprocLoggingService.log('Cloud storage is enabled', LOG_LEVEL.INFO);
       }
     };
     onSidePanelEnabled();