-
Notifications
You must be signed in to change notification settings - Fork 2k
feat(storage): migrate notifications samples and tests #4267
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
iennae
merged 3 commits into
GoogleCloudPlatform:main
from
angelcaamal:notifications-storage-migration
Mar 26, 2026
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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)); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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)); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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)); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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)); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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" | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| downloaded.txt |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| Sub1 | ||
| Hello World! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Hello World! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Hello World 2! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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); | ||
|
angelcaamal marked this conversation as resolved.
|
||
| }); | ||
| }); | ||
| }) | ||
| .catch((err) => { | ||
| console.error('ERROR:', err); | ||
| }); | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.