feat(bigquery): WIP add samples for access policies #3975

hivanalejandro · 2025-02-13T20:01:14Z

Description

Add sample for viewing access policy to dataset

Step of Internal: b/394478489

Checklist

I have followed guidelines from CONTRIBUTING.MD and Samples Style Guide
Tests pass: npm test (see Testing)
Lint pass: npm run lint (see Style)
Please merge this PR for me once it is approved

- Configure main app.js entry point - Configure viewDatasetAccessPolicy.js file

- Add viewTableOrViewAccessPolicy to the app.js entry point - Configure viewTableOrViewAccessPolicy.js file

snippet-bot · 2025-02-13T20:01:22Z

Here is the summary of changes.

You are about to add 2 region tags.

bigquery/cloud-client/src/viewDatasetAccessPolicy.js:19, tag bigquery_view_dataset_access_policy
bigquery/cloud-client/src/viewTableOrViewAccessPolicy.js:19, tag bigquery_view_table_or_view_access_policy

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

Refresh this comment

…ataset-access-policy

…ix linting errors

…eOrViewAccess.test.js

…ataset-access-policy

eapl-gemugami

I left a few comments. Please let me know if you require further details.

eapl-gemugami · 2025-02-13T22:53:09Z

bigquery/cloud-client/src/viewDatasetAccessPolicy.js

+/**
+ * View access policies for a BigQuery dataset
+ * 
+ * @param {object} [overrideValues] Optional parameters to override defaults


David Cavazos advised in this Python PR Review against Overriding parameters as it may be confusing. Having these things commented out as TODOs and passing them as arguments to the function.

For an example see:

nodejs-docs-samples/compute/createInstance.js

Lines 35 to 52 in 102eaed

function main(

projectId,

zone,

instanceName,

machineType = 'n1-standard-1',

sourceImage = 'projects/debian-cloud/global/images/family/debian-11',

networkName = 'global/networks/default'

) {

// [START compute_instances_create]

/**

* TODO(developer): Uncomment and replace these variables before running the sample.

*/

// const projectId = 'YOUR_PROJECT_ID';

// const zone = 'europe-central2-b'

// const instanceName = 'YOUR_INSTANCE_NAME'

// const machineType = 'n1-standard-1';

// const sourceImage = 'projects/debian-cloud/global/images/family/debian-11';

// const networkName = 'global/networks/default';

eapl-gemugami · 2025-02-13T23:19:17Z

bigquery/cloud-client/src/viewDatasetAccessPolicy.js

+        const [metadata] = await dataset.getMetadata();
+
+        // Shows the Access policy as a list of access entries
+        console.log("Access entries:", metadata.access);


Based on the conversation with iennae and this Python PR Review it's better to only show one way, not the 'pretty output', and also how to access each parameter.

I have refactored it here, I think it's cleaner:
https://github.com/GoogleCloudPlatform/python-docs-samples/blob/72c9bbc6fea691022105d14b4f152ea4e029c2c7/bigquery/cloud-client/view_dataset_access_policy.py#L38-L43

eapl-gemugami · 2025-02-13T23:23:07Z

bigquery/cloud-client/test/viewDatasetAccessPolicy.test.js

+        sinon.stub(BigQuery.prototype, "dataset").callsFake(bigQueryStub.dataset);
+
+        // Spy on console.log
+        consoleLogSpy = sinon.spy(console, "log");


Based on this Python PR Review
Please don't check stdout/stderr directly. This was a very early approach but it's very error prone and results in (Python) flaky tests. If there's something you want to check from the sample, return it from the sample function and check the value here directly.

You may use this pattern instead?

nodejs-docs-samples/compute/test/createInstanceTemplates.test.js

Lines 86 to 89 in 102eaed

const outputCreate = execSync(

`node create-instance-templates/createTemplate ${projectId} ${templateName}`

);

assert.match(outputCreate, /Instance template created./);

eapl-gemugami · 2025-02-13T23:23:32Z

bigquery/cloud-client/test/viewDatasetAccessPolicy.test.js

+        await viewDatasetAccessPolicy({ datasetId });
+
+        // Verify BigQuery client was called correctly
+        assert.ok(consoleLogSpy.calledWith("Access entries:", [sampleAccessEntry]));


See my previous comment about checking stdout/stederr

eapl-gemugami · 2025-02-18T18:23:22Z

bigquery/cloud-client/app.js

+
+async function main() {
+  try {
+    const projectId = process.env.GOOGLE_CLOUD_PROJECT;


For Python I found that the previous developer was using the client project, instead of this environment variable, as we do for other samples.

As the tests are still passing, I left the client.project instead.

conftest.py#L38

eapl-gemugami · 2025-02-20T21:29:46Z

bigquery/cloud-client/test/viewTableOrViewAccessPolicy.test.js

+        members: ['user:[email protected]'],
+      },
+    ],
+    etag: 'CAE=',


I haven't seen this etag before, where does it come from?
For instance I know that "ACAB" is a default empty policy (view_table_or_view_access_policy_test.py#L21)

eapl-gemugami · 2025-02-20T21:30:57Z

bigquery/cloud-client/test/viewTableOrViewAccessPolicy.test.js

+    assert.ok(bigQueryStub.dataset().table.calledWith(params.resourceName));
+
+    assert.ok(
+      consoleLogSpy.calledWith(


I don't know if spying on the console is the best practice for tests on Node.
Otherwise, It could be done on the returned object.

eapl-gemugami · 2025-02-20T21:31:31Z

bigquery/cloud-client/viewDatasetAccessPolicy.js

+/**
+ * View access policies for a BigQuery dataset
+ *
+ * @param {object} [overrideValues] Optional parameters to override defaults


Same comment as for previous samples on object vs Object.

eapl-gemugami · 2025-02-20T21:32:46Z

bigquery/cloud-client/viewDatasetAccessPolicy.js

+    // Get properties for an AccessEntry
+    if (metadata.access && metadata.access.length > 0) {
+      console.log(`Details for Access entry 0 in dataset '${datasetId}':`);
+      console.log(`Role: ${metadata.access[0].role || 'N/A'}`);


Is N/A a good practice for JS? 'undefined' or blank could be more natural for the developer?

eapl-gemugami · 2025-02-20T21:36:58Z

bigquery/cloud-client/test/viewDatasetAccessPolicy.test.js

+    await viewDatasetAccessPolicy({datasetId});
+
+    // Verify BigQuery client was called correctly
+    assert.ok(bigQueryStub.dataset.calledWith(datasetId));


Are these tests run on the API or are they mocked?

tests are mocked

hivanalejandro added 4 commits February 13, 2025 18:51

feat(bigquery): initial project setup

5925b0f

feat(bigquery): basic structure

e24c2e8

- Configure main app.js entry point - Configure viewDatasetAccessPolicy.js file

feat(bigquery): Add table and view access policy viewer

84ec0f6

- Add viewTableOrViewAccessPolicy to the app.js entry point - Configure viewTableOrViewAccessPolicy.js file

feat(bigquery): Add viewDatasetAccessPolicy tests

21f786e

hivanalejandro requested review from a team as code owners February 13, 2025 20:01

product-auto-label bot added api: bigquery Issues related to the BigQuery API. samples Issues that are directly related to samples. labels Feb 13, 2025

hivanalejandro marked this pull request as draft February 13, 2025 20:01

hivanalejandro requested a review from eapl-gemugami February 13, 2025 20:02

hivanalejandro added 14 commits February 14, 2025 14:56

feat(bigquery): Add viewTableOrViewAccessPolicy tests

5d408c7

fix(bigquery): Fix linting errors

62e343a

Merge branch 'main' into hivanalejandro/bigquery/create-sample/view-d…

c87d659

…ataset-access-policy

feat(bigquery): Add revokeTableOrViewAccess feawture and tests

58ee72a

feat(bigquery): Update app.js file to add revokeTableOrViewAccess & f…

62ebc2c

…ix linting errors

fix(bigquery):Fix headers for revokeTableOrViewAccess.js & revokeTabl…

9d0ce88

…eOrViewAccess.test.js

feat(bigquery): Add bigquery_revoke_access_to_table_or_view tag

627536a

fix(bigquery): Update if/else to if/else if

70cfb83

feat(bigquery): Add grantAccessToDataset sample and tests

ff35988

Merge branch 'main' into hivanalejandro/bigquery/create-sample/view-d…

b8ad0f4

…ataset-access-policy

fix(bigquery): Update lint error

7b38e5a

feat(bigquery): Add grantAccessToTableOrView sample

5cfa8dc

feat(bigquery): Add grantAccessToTableOrView test

ccf30d6

feat(bigquery): Update app.js file with new samples

eb32aa8

hivanalejandro changed the title ~~feat(bigquery): WIP create sample 'viewTableOrViewAccessPolicy' & 'viewDatasetAccessPolicy'~~ feat(bigquery): WIP feat(bigquery): add samples for access policies Feb 20, 2025

hivanalejandro changed the title ~~feat(bigquery): WIP feat(bigquery): add samples for access policies~~ feat(bigquery): WIP add samples for access policies Feb 20, 2025

hivanalejandro added 3 commits February 20, 2025 18:28

feat(bigquery): Add revokeDatasetAccess sample

0a5f5dd

feat(bigquery): Add revokeDatasetAccess tests

6c40940

feat(bigquery): Update app.js file with new sample

b600729

hivanalejandro added 2 commits February 20, 2025 18:50

Merge branch 'main' into hivanalejandro/bigquery/create-sample/view-d…

c7a1821

…ataset-access-policy

chore(bigquery): Update project structure

db956a7

hivanalejandro requested review from alarconesparza, OremGLG and iennae February 20, 2025 20:24

eapl-gemugami reviewed Feb 20, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(bigquery): WIP add samples for access policies #3975

feat(bigquery): WIP add samples for access policies #3975

hivanalejandro commented Feb 13, 2025 •

edited

Loading

snippet-bot bot commented Feb 13, 2025

eapl-gemugami left a comment

eapl-gemugami Feb 13, 2025

eapl-gemugami Feb 13, 2025

eapl-gemugami Feb 13, 2025

eapl-gemugami Feb 13, 2025

eapl-gemugami Feb 18, 2025

eapl-gemugami Feb 20, 2025

eapl-gemugami Feb 20, 2025

eapl-gemugami Feb 20, 2025

eapl-gemugami Feb 20, 2025

eapl-gemugami Feb 20, 2025

hivanalejandro Feb 20, 2025

	function main(
	projectId,
	zone,
	instanceName,
	machineType = 'n1-standard-1',
	sourceImage = 'projects/debian-cloud/global/images/family/debian-11',
	networkName = 'global/networks/default'
	) {
	// [START compute_instances_create]
	/**
	* TODO(developer): Uncomment and replace these variables before running the sample.
	*/
	// const projectId = 'YOUR_PROJECT_ID';
	// const zone = 'europe-central2-b'
	// const instanceName = 'YOUR_INSTANCE_NAME'
	// const machineType = 'n1-standard-1';
	// const sourceImage = 'projects/debian-cloud/global/images/family/debian-11';
	// const networkName = 'global/networks/default';

	const outputCreate = execSync(
	`node create-instance-templates/createTemplate ${projectId} ${templateName}`
	);
	assert.match(outputCreate, /Instance template created./);

feat(bigquery): WIP add samples for access policies #3975

Are you sure you want to change the base?

feat(bigquery): WIP add samples for access policies #3975

Conversation

hivanalejandro commented Feb 13, 2025 • edited Loading

Description

Checklist

snippet-bot bot commented Feb 13, 2025

eapl-gemugami left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hivanalejandro commented Feb 13, 2025 •

edited

Loading