fix(bigquery): Update samples and tests format issues

Author: hivanalejandro

bigquery/cloud-client/grantAccessToDataset.js

@@ -31,63 +31,63 @@ async function grantAccessToDataset(datasetId, entityId, role) {
     PRECONDITION_FAILED: 412,
   };
 
-  // TODO(developer): Update and un-comment below lines
+  // TODO(developer): Update and un-comment below lines.
 
-  // ID of the dataset to revoke access to
+  // ID of the dataset to revoke access to.
   // datasetId = "my_project_id.my_dataset_name";
 
-  // ID of the user or group from whom you are adding access
+  // ID of the user or group from whom you are adding access.
   // Alternatively, the JSON REST API representation of the entity,
-  // such as a view's table reference
+  // such as a view's table reference.
   // entityId = "[email protected]";
 
   // One of the "Basic roles for datasets" described here:
   // https://cloud.google.com/bigquery/docs/access-control-basic-roles#dataset-basic-roles
   // role = "READER";
 
-  // Type of entity you are granting access to
+  // Type of entity you are granting access to.
   // Find allowed allowed entity type names here:
   // https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#resource:-dataset
   // In this case, we're using groupByEmail
   const entityType = 'groupByEmail';
 
-  // Instantiate a client
+  // Instantiate a client.
   const client = new BigQuery();
 
   try {
-    // Get a reference to the dataset
+    // Get a reference to the dataset.
     const [dataset] = await client.dataset(datasetId).get();
 
-    // The 'access entries' list is immutable. Create a copy for modifications
+    // The 'access entries' list is immutable. Create a copy for modifications.
     const entries = Array.isArray(dataset.metadata.access)
       ? [...dataset.metadata.access]
       : [];
 
-    // Append an AccessEntry to grant the role to a dataset
+    // Append an AccessEntry to grant the role to a dataset.
     // Find more details about the AccessEntry object in the BigQuery documentation:
     // https://cloud.google.com/python/docs/reference/bigquery/latest/google.cloud.bigquery.dataset.AccessEntry
     entries.push({
       role: role,
       [entityType]: entityId,
     });
 
-    // Assign the list of AccessEntries back to the dataset
+    // Assign the list of AccessEntries back to the dataset.
     const metadata = {
       access: entries,
     };
 
     // Update will only succeed if the dataset
-    // has not been modified externally since retrieval
+    // has not been modified externally since retrieval.
     //
     // See the BigQuery client library documentation for more details on metadata updates
-    // https://cloud.google.com/bigquery/docs/updating-model-metadata
+    // https://cloud.google.com/nodejs/docs/reference/bigquery/latest
 
-    // Update just the 'access entries' property of the dataset
+    // Update just the 'access entries' property of the dataset.
     const [updatedDataset] = await client
       .dataset(datasetId)
       .setMetadata(metadata);
 
-    // Show a success message
+    // Show a success message.
     console.log(
       `Role '${role}' granted for entity '${entityId}'` +
         ` in dataset '${datasetId}'.`
@@ -96,7 +96,6 @@ async function grantAccessToDataset(datasetId, entityId, role) {
     return updatedDataset.access;
   } catch (error) {
     if (error.code === HTTP_STATUS.PRECONDITION_FAILED) {
-      // A read-modify-write error (PreconditionFailed equivalent)
       console.error(
         `Dataset '${datasetId}' was modified remotely before this update. ` +
           'Fetch the latest version and retry.'

bigquery/cloud-client/grantAccessToTableOrView.js

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-const {BigQuery} = require('@google-cloud/bigquery');
+'use strict';
 
 /**
  * Grants access to a BigQuery table or view for a specified principal
@@ -32,42 +32,44 @@ async function grantAccessToTableOrView(
   role
 ) {
   // [START bigquery_grant_access_to_table_or_view]
+  const {BigQuery} = require('@google-cloud/bigquery');
+
   // TODO(developer): Update and un-comment below lines
 
-  // Google Cloud Platform project
+  // Google Cloud Platform project.
   // projectId = "my_project_id"
 
-  // Dataset where the table or view is
+  // Dataset where the table or view is.
   // datasetId = "my_dataset"
 
-  // Table or view name to get the access policy
+  // Table or view name to get the access policy.
   // resourceName = "my_table"
 
-  // The principal requesting access to the table or view
+  // The principal requesting access to the table or view.
   // Find more details about principal identifiers here:
   // https://cloud.google.com/iam/docs/principal-identifiers
   // principalId = "user:[email protected]"
 
-  // Role to assign to the member
+  // Role to assign to the member.
   // role = "roles/bigquery.dataViewer"
 
-  // Instantiate a client
+  // Instantiate a client.
   const client = new BigQuery();
 
-  // Get the table reference
+  // Get the table reference.
   const dataset = client.dataset(datasetId);
   const table = dataset.table(resourceName);
 
-  // Get the IAM access policy for the table or view
+  // Get the IAM access policy for the table or view.
   const [policy] = await table.getIamPolicy();
 
-  // Initialize bindings if they do not exist
+  // Initialize bindings if they do not exist.
   if (!policy.bindings) {
     policy.bindings = [];
   }
 
   // To grant access to a table or view
-  // add bindings to the Table or View policy
+  // add bindings to the Table or View policy.
   //
   // Find more details about Policy and Binding objects here:
   // https://cloud.google.com/security-command-center/docs/reference/rest/Shared.Types/Policy
@@ -78,10 +80,10 @@ async function grantAccessToTableOrView(
   };
   policy.bindings.push(binding);
 
-  // Set the IAM access policy with updated bindings
+  // Set the IAM access policy with updated bindings.
   const [updatedPolicy] = await table.setIamPolicy(policy);
 
-  // Show a success message
+  // Show a success message.
   console.log(
     `Role '${role}' granted for principal '${principalId}' on resource '${datasetId}.${resourceName}'.`
   );

bigquery/cloud-client/revokeDatasetAccess.js

@@ -14,10 +14,6 @@
 
 'use strict';
 
-// [START bigquery_revoke_dataset_access]
-
-const {BigQuery} = require('@google-cloud/bigquery');
-
 // Define enum for HTTP codes
 const HTTP_STATUS = {
   PRECONDITION_FAILED: 412,
@@ -33,67 +29,72 @@ const HTTP_STATUS = {
  * @returns {Promise<Array>} A promise that resolves to the updated access entries
  */
 async function revokeDatasetAccess(datasetId, entityId) {
-  // Create a client
-  const bigquery = new BigQuery();
+  // [START bigquery_revoke_dataset_access]
+  // Imports the Google Cloud client library.
+  const {BigQuery} = require('@google-cloud/bigquery');
 
-  // TODO (developer): Update and un-comment below lines
+  // TODO (developer): Update and un-comment below lines.
 
-  // ID of the dataset to revoke access to
+  // ID of the dataset to revoke access to.
   // datasetId = "your-project.your_dataset"
 
-  // ID of the user or group from whom you are revoking access
+  // ID of the user or group from whom you are revoking access.
   // Alternatively, the JSON REST API representation of the entity,
-  // such as a view's table reference
+  // such as a view's table reference.
   // entityId = "[email protected]"
 
+  // Instantiate a client.
+  const bigquery = new BigQuery();
+
   // Get a reference to the dataset.
   const [dataset] = await bigquery.dataset(datasetId).get();
 
   // To revoke access to a dataset, remove elements from the access list
   //
   // See the BigQuery client library documentation for more details on access entries
+  // https://cloud.google.com/nodejs/docs/reference/secret-manager/4.1.4
 
   // Filter access entries to exclude entries matching the specified entity_id
-  // and assign a new list back to the access list
+  // and assign a new list back to the access list.
   dataset.metadata.access = dataset.metadata.access.filter(entry => {
-    // Check for entity_id (specific match)
+    // Check for entity_id (specific match).
     if (entry.entity_id === entityId) {
       console.log(
         `Found matching entity_id: ${entry.entity_id}, removing entry`
       );
       return false;
     }
 
-    // Check for userByEmail field
+    // Check for userByEmail field.
     if (entry.userByEmail === entityId) {
       console.log(
         `Found matching userByEmail: ${entry.userByEmail}, removing entry`
       );
       return false;
     }
 
-    // Check for groupByEmail field
+    // Check for groupByEmail field.
     if (entry.groupByEmail === entityId) {
       console.log(
         `Found matching groupByEmail: ${entry.groupByEmail}, removing entry`
       );
       return false;
     }
 
-    // Keep all other entries
+    // Keep all other entries.
     return true;
   });
 
   // Update will only succeed if the dataset
-  // has not been modified externally since retrieval
+  // has not been modified externally since retrieval.
 
   try {
-    // Update just the access entries property of the dataset
+    // Update just the access entries property of the dataset.
     const [updatedDataset] = await dataset.setMetadata(dataset.metadata);
 
     return updatedDataset.access;
   } catch (error) {
-    // Check if it's a precondition failed error (a read-modify-write error)
+    // Check if it's a precondition failed error (a read-modify-write error).
     if (error.code === HTTP_STATUS.PRECONDITION_FAILED) {
       console.log(
         `Dataset '${dataset.id}' was modified remotely before this update. ` +

bigquery/cloud-client/revokeTableOrViewAccess.js

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+'use strict';
+
 /**
  * Revokes access to a BigQuery table or view
  * @param {string} projectId The ID of the Google Cloud project
@@ -29,77 +31,77 @@ async function revokeAccessToTableOrView(
   principalToRemove = null
 ) {
   // [START bigquery_revoke_access_to_table_or_view]
-  // Imports the Google Cloud client library
+  // Imports the Google Cloud client library.
   const {BigQuery} = require('@google-cloud/bigquery');
 
   // TODO (developer): Update and un-comment below lines
   // Google Cloud Platform project.
   // projectId = "my_project_id"
 
-  // Dataset where the table or view is
+  // Dataset where the table or view is.
   // datasetId = "my_dataset"
 
-  // Table or view name to get the access policy
+  // Table or view name to get the access policy.
   // resourceName = "my_table"
 
-  // (Optional) Role to remove from the table or view
+  // (Optional) Role to remove from the table or view.
   // roleToRemove = "roles/bigquery.dataViewer"
 
-  // (Optional) Principal to remove from the table or view
+  // (Optional) Principal to remove from the table or view.
   // principalToRemove = "user:[email protected]"
 
   // Find more information about roles and principals (refered as members) here:
   // https://cloud.google.com/security-command-center/docs/reference/rest/Shared.Types/Binding
 
-  // Instantiate a client
+  // Instantiate a client.
   const client = new BigQuery();
 
-  // Get the table reference
+  // Get the table reference.
   const dataset = client.dataset(datasetId);
   const table = dataset.table(resourceName);
 
-  // Get the IAM access policy for the table or view
+  // Get the IAM access policy for the table or view.
   const [policy] = await table.getIamPolicy();
 
-  // Initialize bindings of they do not exist
+  // Initialize bindings of they do not exist.
   if (!policy.bindings) {
     policy.bindings = [];
   }
 
   // To revoke access to a table or view,
-  // remove bindings from the Table or View policy
+  // remove bindings from the Table or View policy.
   //
   // Find more details about Policy objects here:
   // https://cloud.google.com/security-command-center/docs/reference/rest/Shared.Types/Policy
 
   if (roleToRemove) {
     // Filter out all bindings with the `roleToRemove`
-    // and assign a new list back to the policy bindings
+    // and assign a new list back to the policy bindings.
     policy.bindings = policy.bindings.filter(b => b.role !== roleToRemove);
   }
 
   if (principalToRemove) {
-    // Create a copy to match original code structure
+    // The `bindings` list is immutable. Create a copy for modifications.
     const bindings = [...policy.bindings];
 
-    // Filter out the principal from each binding
+    // Filter out the principal from each binding.
     for (const binding of bindings) {
       if (binding.members) {
         binding.members = binding.members.filter(m => m !== principalToRemove);
       }
     }
 
-    // Filter out bindings with empty members
+    // Filter out bindings with empty members.
     policy.bindings = bindings.filter(
       binding => binding.members && binding.members.length > 0
     );
   }
 
   try {
-    // Set the IAM access policy with updated bindings
+    // Set the IAM access policy with updated bindings.
     await table.setIamPolicy(policy);
 
-    // Get the policy again to confirm it's set correctly
+    // Get the policy again to confirm it's set correctly.
     const [verifiedPolicy] = await table.getIamPolicy();
 
     if (verifiedPolicy && verifiedPolicy.bindings) {

bigquery/cloud-client/viewDatasetAccessPolicy.js

@@ -24,10 +24,10 @@ function viewDatasetAccessPolicy(datasetId) {
   // Import the Google Cloud client library.
   const {BigQuery} = require('@google-cloud/bigquery');
 
-  // Create a client
+  // Instantiate a client.
   const bigquery = new BigQuery();
 
-  // TODO (developer): Update and un-comment below lines
+  // TODO (developer): Update and un-comment below lines.
   // Dataset from which to get the access policy
   // datasetId = "my_dataset";
 
@@ -39,6 +39,7 @@ function viewDatasetAccessPolicy(datasetId) {
 
     // Show the list of AccessEntry objects.
     // More details about the AccessEntry object in the BigQuery documentation
+    // https://cloud.google.com/nodejs/docs/reference/bigquery/latest
     console.log(
       `${accessEntries.length} Access entries in dataset '${datasetId}':`
     );