Skip to content
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

fix: (appengine) update region tag in appengine/websockets/app.js & appengine/websockets/views/index.pug #3956

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

hivanalejandro
Copy link
Contributor

@hivanalejandro hivanalejandro commented Jan 21, 2025

Description

Migrate region "appengine_websockets_app" to "gae_websockets_app"
Fixes b/391399101

Migrate region "appengine_websockets_form" to "gae_websockets_form"
Fixes b/391403733

Migrate region "appengine_websockets_index" to "gae_websockets_index"
Fixes b/391405800

Migrate region "appengine_websockets_js" to "gae_websockets_js"
Fixes b/391406425

Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.

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)
  • These samples need a new API enabled in testing projects to pass (let us know which ones)
  • These samples need a new/updated env vars in testing projects set to pass (let us know which ones)
  • This pull request is from a branch created directly off of GoogleCloudPlatform/nodejs-docs-samples. Not a fork.
  • This sample adds a new sample directory, and I updated the CODEOWNERS file with the codeowners for this sample
  • This sample adds a new sample directory, and I created GitHub Actions workflow for this sample
  • This sample adds a new Product API, and I updated the Blunderbuss issue/PR auto-assigner with the codeowners for this sample
  • Please merge this PR for me once it is approved

@hivanalejandro hivanalejandro requested review from a team as code owners January 21, 2025 21:29
Copy link

snippet-bot bot commented Jan 21, 2025

Here is the summary of changes.

You are about to add 4 region tags.

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

Copy link
Contributor

@code-review-assist code-review-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi team,

I'm currently reviewing this pull request and will provide my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly understand the changes:

This pull request by @hivanalejandro updates region tags in several files within the nodejs-docs-samples repository's appengine/websockets directory. The intent is to migrate region tags from appengine_websockets_... to gae_websockets_..., addressing several issues (b/391399101, b/391403733, b/391405800, b/391406425).

Here's a breakdown of the changes:

  • appengine/websockets/app.js: The region tag appengine_websockets_app is updated to gae_websockets_app on lines 17 and 43.
  • appengine/websockets/views/index.pug: The region tags appengine_websockets_index and appengine_websockets_form are updated to gae_websockets_index and gae_websockets_form respectively, on lines 15, 27, 31, 39, and 58.
  • appengine/websockets/views/index.pug: The region tag appengine_websockets_js is updated to gae_websockets_js on lines 45 and 61.

The author has indicated that all tests and lint checks have passed. The pull request also includes a comprehensive checklist to ensure adherence to contribution guidelines.


A little haiku to lighten the mood:

Tags shift, code flows free,
Bugs vanish in the night's calm,
Clean code, joy abounds.

Thanks!
Gemini

@product-auto-label product-auto-label bot added samples Issues that are directly related to samples. api: appengine Issues related to the App Engine Admin API API. asset: pattern DEE Asset tagging - Pattern. labels Jan 21, 2025
Copy link
Contributor

@code-review-assist code-review-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This pull request updates region tags in several files within the appengine/websockets sample. The changes are straightforward and correctly address the specified bugs. The commit messages clearly explain the changes, and the code follows the project's style guidelines. I've referenced the Samples Style Guide in this review.

Here's a summary of the style guide elements I've checked:

  • Region tags: The new region tags are correctly placed and formatted.
  • Comments: The existing comments are clear and concise.
  • Consistency: The changes maintain consistency with the rest of the codebase.

Overall, the changes are well-done and improve the accuracy of the sample code. The checklist items from the pull request template should be reviewed before merging.

Comment on lines +17 to 18
// [START gae_websockets_app]
// [START appengine_websockets_app]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

Per the Samples Style Guide, it's best to remove the old region tags when they are no longer used. Since gae_websockets_app replaces appengine_websockets_app, the latter can be removed.

Suggested change
// [START gae_websockets_app]
// [START appengine_websockets_app]
// [START gae_websockets_app]
const app = require('express')();

@@ -39,5 +40,6 @@
});
}
// [END appengine_websockets_app]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

Per the Samples Style Guide, it's best to remove the old region tags when they are no longer used. Since gae_websockets_app replaces appengine_websockets_app, the latter can be removed.

Suggested change
// [END appengine_websockets_app]
// [END gae_websockets_app]

@hivanalejandro hivanalejandro marked this pull request as draft January 22, 2025 18:29
@hivanalejandro hivanalejandro marked this pull request as draft January 22, 2025 18:29
@hivanalejandro hivanalejandro marked this pull request as ready for review January 23, 2025 14:01
@hivanalejandro hivanalejandro changed the title fix: (appengine) update region tag in lookuptEntry.js in appengine/websockets/app.js & appengine/websockets/views/index.pug fix: (appengine) update region tag in appengine/websockets/app.js & appengine/websockets/views/index.pug Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: appengine Issues related to the App Engine Admin API API. asset: pattern DEE Asset tagging - Pattern. samples Issues that are directly related to samples.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants