From ca3f772550e5ea38eeb25173127ac0e3432ca004 Mon Sep 17 00:00:00 2001 From: Angel Caamal Date: Thu, 19 Mar 2026 00:04:05 +0000 Subject: [PATCH 1/2] feat(storage): introduce notification samples and tests for migration --- storage/createNotification.js | 63 ++++++++++++ storage/deleteNotification.js | 59 +++++++++++ storage/getMetadataNotifications.js | 67 +++++++++++++ storage/listNotifications.js | 61 ++++++++++++ storage/package.json | 30 ++++++ storage/resources/.gitignore | 1 + storage/resources/resourcesSub1/testSub1.txt | 2 + storage/resources/test.txt | 1 + storage/resources/test2.txt | 1 + storage/scripts/cleanup | 44 +++++++++ storage/system-test/notifications.test.js | 99 +++++++++++++++++++ ...t_9d800329-00da-4cdd-9a3e-7ac6743d5813.txt | 0 12 files changed, 428 insertions(+) create mode 100644 storage/createNotification.js create mode 100644 storage/deleteNotification.js create mode 100644 storage/getMetadataNotifications.js create mode 100644 storage/listNotifications.js create mode 100644 storage/package.json create mode 100644 storage/resources/.gitignore create mode 100644 storage/resources/resourcesSub1/testSub1.txt create mode 100644 storage/resources/test.txt create mode 100644 storage/resources/test2.txt create mode 100644 storage/scripts/cleanup create mode 100644 storage/system-test/notifications.test.js create mode 100644 storage/system-test/test_9d800329-00da-4cdd-9a3e-7ac6743d5813.txt diff --git a/storage/createNotification.js b/storage/createNotification.js new file mode 100644 index 0000000000..447e0037c5 --- /dev/null +++ b/storage/createNotification.js @@ -0,0 +1,63 @@ +// Copyright 2020 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +'use strict'; + +/** + * This application demonstrates how to perform basic operations on files with + * the Google Cloud Storage API. + * + * For more information, see the README.md under /storage and the documentation + * at https://cloud.google.com/storage/docs. + */ +const uuid = require('uuid'); + +function main( + bucketName = 'my-bucket', + topic = `nodejs-storage-samples-${uuid.v4()}` +) { + // [START storage_create_bucket_notifications] + /** + * TODO(developer): Uncomment the following lines before running the sample. + */ + // The ID of your GCS bucket + // const bucketName = 'your-unique-bucket-name'; + + // The name of a topic + // const topic = 'my-topic'; + + // Imports the Google Cloud client library + const {Storage} = require('@google-cloud/storage'); + + // Creates a client + const storage = new Storage(); + + async function createNotification() { + try { + // Creates a notification + await storage.bucket(bucketName).createNotification(topic); + + console.log('Notification subscription created.'); + } catch (error) { + console.error( + 'Error executing create notification:', + error.message || error + ); + } + } + + createNotification(); + // [END storage_create_bucket_notifications] +} +main(...process.argv.slice(2)); diff --git a/storage/deleteNotification.js b/storage/deleteNotification.js new file mode 100644 index 0000000000..90ac6b18af --- /dev/null +++ b/storage/deleteNotification.js @@ -0,0 +1,59 @@ +// Copyright 2020 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +'use strict'; + +/** + * This application demonstrates how to perform basic operations on files with + * the Google Cloud Storage API. + * + * For more information, see the README.md under /storage and the documentation + * at https://cloud.google.com/storage/docs. + */ + +function main(bucketName = 'my-bucket', notificationId = '1') { + // [START storage_delete_bucket_notification] + /** + * TODO(developer): Uncomment the following lines before running the sample. + */ + // The ID of your GCS bucket + // const bucketName = 'your-unique-bucket-name'; + + // The ID of the notification + // const notificationId = '1'; + + // Imports the Google Cloud client library + const {Storage} = require('@google-cloud/storage'); + + // Creates a client + const storage = new Storage(); + + async function deleteNotification() { + try { + // Deletes the notification from the bucket + await storage.bucket(bucketName).notification(notificationId).delete(); + + console.log(`Notification ${notificationId} deleted.`); + } catch (error) { + console.error( + 'Error executing delete notification:', + error.message || error + ); + } + } + + deleteNotification(); + // [END storage_delete_bucket_notification] +} +main(...process.argv.slice(2)); diff --git a/storage/getMetadataNotifications.js b/storage/getMetadataNotifications.js new file mode 100644 index 0000000000..c1719a840f --- /dev/null +++ b/storage/getMetadataNotifications.js @@ -0,0 +1,67 @@ +// Copyright 2020 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +'use strict'; + +/** + * This application demonstrates how to perform basic operations on files with + * the Google Cloud Storage API. + * + * For more information, see the README.md under /storage and the documentation + * at https://cloud.google.com/storage/docs. + */ + +function main(bucketName = 'my-bucket', notificationId = '1') { + // [START storage_print_pubsub_bucket_notification] + /** + * TODO(developer): Uncomment the following lines before running the sample. + */ + // The ID of your GCS bucket + // const bucketName = 'your-unique-bucket-name'; + + // The ID of the notification + // const notificationId = '1'; + + // Imports the Google Cloud client library + const {Storage} = require('@google-cloud/storage'); + + // Creates a client + const storage = new Storage(); + + async function getMetadata() { + try { + // Get the notification metadata + const [metadata] = await storage + .bucket(bucketName) + .notification(notificationId) + .getMetadata(); + + console.log(`ID: ${metadata.id}`); + console.log(`Topic: ${metadata.topic}`); + console.log(`Event Types: ${metadata.event_types}`); + console.log(`Custom Attributes: ${metadata.custom_attributes}`); + console.log(`Payload Format: ${metadata.payload_format}`); + console.log(`Object Name Prefix: ${metadata.object_name_prefix}`); + console.log(`Etag: ${metadata.etag}`); + console.log(`Self Link: ${metadata.selfLink}`); + console.log(`Kind: ${metadata.kind}`); + } catch (error) { + console.error('Error executing get metadata:', error.message || error); + } + } + + getMetadata(); + // [END storage_print_pubsub_bucket_notification] +} +main(...process.argv.slice(2)); diff --git a/storage/listNotifications.js b/storage/listNotifications.js new file mode 100644 index 0000000000..c41a39a1b7 --- /dev/null +++ b/storage/listNotifications.js @@ -0,0 +1,61 @@ +// Copyright 2020 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +'use strict'; + +/** + * This application demonstrates how to perform basic operations on files with + * the Google Cloud Storage API. + * + * For more information, see the README.md under /storage and the documentation + * at https://cloud.google.com/storage/docs. + */ + +function main(bucketName = 'my-bucket') { + // [START storage_list_bucket_notifications] + /** + * TODO(developer): Uncomment the following lines before running the sample. + */ + // The ID of your GCS bucket + // const bucketName = 'your-unique-bucket-name'; + + // Imports the Google Cloud client library + const {Storage} = require('@google-cloud/storage'); + + // Creates a client + const storage = new Storage(); + + async function listNotifications() { + try { + // Lists notifications in the bucket + const [notifications] = await storage + .bucket(bucketName) + .getNotifications(); + + console.log('Notifications:'); + notifications.forEach(notification => { + console.log(notification.id); + }); + } catch (error) { + console.error( + 'Error executing list notifications:', + error.message || error + ); + } + } + + listNotifications(); + // [END storage_list_bucket_notifications] +} +main(...process.argv.slice(2)); diff --git a/storage/package.json b/storage/package.json new file mode 100644 index 0000000000..71acc18ab5 --- /dev/null +++ b/storage/package.json @@ -0,0 +1,30 @@ +{ + "name": "@google-cloud/storage-samples", + "description": "Samples for the Cloud Storage Client Library for Node.js.", + "license": "Apache-2.0", + "author": "Google Inc.", + "engines": { + "node": ">=12" + }, + "repository": "googleapis/nodejs-storage", + "private": true, + "files": [ + "*.js" + ], + "scripts": { + "cleanup": "node scripts/cleanup", + "test": "mocha system-test/*.js --timeout 800000" + }, + "dependencies": { + "@google-cloud/pubsub": "^4.0.0", + "@google-cloud/storage": "^7.19.0", + "node-fetch": "^2.6.7", + "uuid": "^8.0.0", + "yargs": "^16.0.0" + }, + "devDependencies": { + "chai": "^4.2.0", + "mocha": "^8.0.0", + "p-limit": "^3.1.0" + } +} diff --git a/storage/resources/.gitignore b/storage/resources/.gitignore new file mode 100644 index 0000000000..6738013702 --- /dev/null +++ b/storage/resources/.gitignore @@ -0,0 +1 @@ +downloaded.txt diff --git a/storage/resources/resourcesSub1/testSub1.txt b/storage/resources/resourcesSub1/testSub1.txt new file mode 100644 index 0000000000..51f4b307d5 --- /dev/null +++ b/storage/resources/resourcesSub1/testSub1.txt @@ -0,0 +1,2 @@ +Sub1 +Hello World! \ No newline at end of file diff --git a/storage/resources/test.txt b/storage/resources/test.txt new file mode 100644 index 0000000000..c57eff55eb --- /dev/null +++ b/storage/resources/test.txt @@ -0,0 +1 @@ +Hello World! \ No newline at end of file diff --git a/storage/resources/test2.txt b/storage/resources/test2.txt new file mode 100644 index 0000000000..010302410b --- /dev/null +++ b/storage/resources/test2.txt @@ -0,0 +1 @@ +Hello World 2! \ No newline at end of file diff --git a/storage/scripts/cleanup b/storage/scripts/cleanup new file mode 100644 index 0000000000..61bd73114f --- /dev/null +++ b/storage/scripts/cleanup @@ -0,0 +1,44 @@ +#!/usr/bin/env node + +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +'use strict'; + +const {Storage} = require('@google-cloud/storage'); +const storage = new Storage(); +const NAME_REG_EXP = /^nodejs-storage-samples-[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$/; + +storage + .getBuckets() + .then(([buckets]) => { + let promise = Promise.resolve(); + + buckets + .filter((bucket) => NAME_REG_EXP.test(bucket.name)) + .forEach((bucket) => { + promise = promise.then(() => { + return bucket.deleteFiles() + .then(() => bucket.deleteFiles(), console.error) + .then(() => { + console.log(`Deleting ${bucket.name}`); + return bucket.delete(); + }, console.error) + .catch(console.error); + }); + }); + }) + .catch((err) => { + console.error('ERROR:', err); + }); diff --git a/storage/system-test/notifications.test.js b/storage/system-test/notifications.test.js new file mode 100644 index 0000000000..ef88d8b07c --- /dev/null +++ b/storage/system-test/notifications.test.js @@ -0,0 +1,99 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +'use strict'; + +const {PubSub} = require('@google-cloud/pubsub'); +const {Storage} = require('@google-cloud/storage'); +const {assert} = require('chai'); +const {before, after, it} = require('mocha'); +const cp = require('child_process'); +const uuid = require('uuid'); + +const execSync = cmd => cp.execSync(cmd, {encoding: 'utf-8'}); + +const storage = new Storage(); +const bucketName = `nodejs-storage-samples-${uuid.v4()}`; +const bucket = storage.bucket(bucketName); +const notificationId = '1'; +const notification = bucket.notification(notificationId); +const topicName = `nodejs-storage-samples-${uuid.v4()}`; +const pubsub = new PubSub(); +const topic = pubsub.topic(topicName); + +before(async () => { + await bucket.create(); + await topic.create(); + await topic.iam.setPolicy({ + bindings: [ + { + role: 'roles/pubsub.editor', + members: ['allUsers'], + }, + ], + }); +}); + +after(async () => { + await bucket.delete().catch(console.error); + await topic.delete().catch(console.error); +}); + +it('should create a notification', async () => { + const output = execSync( + `node createNotification.js ${bucketName} ${topicName}` + ); + assert.match(output, /Notification subscription created./); + const [exists] = await notification.exists(); + assert.strictEqual(exists, true); +}); + +it('should list notifications', async () => { + const output = execSync(`node listNotifications.js ${bucketName}`); + assert.match(output, /Notifications:/); + assert.match(output, new RegExp(notificationId)); +}); + +it('should get metadata', async () => { + const metadata = await notification.getMetadata(); + const output = execSync( + `node getMetadataNotifications.js ${bucketName} ${notificationId}` + ); + assert.match(output, /ID:/); + assert.match(output, new RegExp(metadata.id)); + assert.match(output, /Topic:/); + assert.match(output, new RegExp(metadata.topic)); + assert.match(output, /Event Types:/); + assert.match(output, new RegExp(metadata.event_types)); + assert.match(output, /Custom Attributes:/); + assert.match(output, new RegExp(metadata.custom_attributes)); + assert.match(output, /Payload Format:/); + assert.match(output, new RegExp(metadata.payload_format)); + assert.match(output, /Object Name Prefix:/); + assert.match(output, new RegExp(metadata.object_name_prefix)); + assert.match(output, /Etag:/); + assert.match(output, /Self Link:/); + assert.match(output, new RegExp(metadata.selfLink)); + assert.match(output, /Kind:/); + assert.match(output, new RegExp(metadata.kind)); +}); + +it('should delete a notification', async () => { + const output = execSync( + `node deleteNotification.js ${bucketName} ${notificationId}` + ); + assert.match(output, new RegExp(`Notification ${notificationId} deleted.`)); + const [exists] = await notification.exists(); + assert.strictEqual(exists, false); +}); diff --git a/storage/system-test/test_9d800329-00da-4cdd-9a3e-7ac6743d5813.txt b/storage/system-test/test_9d800329-00da-4cdd-9a3e-7ac6743d5813.txt new file mode 100644 index 0000000000..e69de29bb2 From 21d8feb33d930a03a2dd4a90a31fff9d76053424 Mon Sep 17 00:00:00 2001 From: Angel Caamal Date: Mon, 23 Mar 2026 19:19:31 +0000 Subject: [PATCH 2/2] fix(storage): apply code review suggestions for IAM permissions --- storage/system-test/notifications.test.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/storage/system-test/notifications.test.js b/storage/system-test/notifications.test.js index ef88d8b07c..c90d72b81c 100644 --- a/storage/system-test/notifications.test.js +++ b/storage/system-test/notifications.test.js @@ -35,11 +35,12 @@ const topic = pubsub.topic(topicName); before(async () => { await bucket.create(); await topic.create(); + const [gcsServiceAccount] = await storage.getServiceAccount(); await topic.iam.setPolicy({ bindings: [ { role: 'roles/pubsub.editor', - members: ['allUsers'], + members: [`serviceAccount:${gcsServiceAccount.emailAddress}`], }, ], });