Skip to content

fix(retail): add region tag for nodejs - Update search with query expansion #4119

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

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

Conversation

rebeccaellis
Copy link
Contributor

Description

Fixes #415382524

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)
  • Required CI tests pass (see CI testing)
  • 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

Note: Any check with (dev), (experimental), or (legacy) can be ignored and should not block your PR from merging (see CI testing).

@rebeccaellis rebeccaellis requested review from a team as code owners June 28, 2025 00:04
Copy link

snippet-bot bot commented Jun 28, 2025

Here is the summary of changes.

You are about to add 1 region tag.

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

@product-auto-label product-auto-label bot added api: retail Issues related to the Retail API API. samples Issues that are directly related to samples. labels Jun 28, 2025
Copy link
Contributor

@gemini-code-assist gemini-code-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.

Summary of Changes

Hello @rebeccaellis, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on improving the discoverability and documentation integration of an existing Node.js retail sample. By adding specific region tags, the code snippet can be automatically included in relevant documentation, enhancing the overall developer experience for users looking to implement search with query expansion.

Highlights

  • Documentation/Sample Tagging: I've added [START] and [END] region tags to the search-with-query-expansion-spec.js sample. This helps in automatically extracting and publishing code snippets for documentation, making the sample more discoverable and usable in Google Cloud documentation.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-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.

Code Review

This pull request adds region tags to the search-with-query-expansion-spec.js sample file. The tags are correctly named and placed to create a self-contained, runnable sample. My review provides suggestions to refactor the code within this new sample region to improve its overall quality, readability, and alignment with Node.js best practices.

@@ -13,7 +13,7 @@
// limitations under the License.

'use strict';

// [START retail_search_for_products_with_query_expansion_specification]
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

Now that this code block is being exposed as a sample, it would be beneficial to refactor it for clarity and to align with common JavaScript best practices.

Here are a few suggestions:

  1. Hoist require statements: The require('@google-cloud/retail') call on line 19 should be at the top level of the module, outside the main function. This is standard Node.js practice for better readability and dependency management.

  2. Simplify function structure: The main function defines and immediately calls an inner async function callSearch. This wrapper is redundant and can be removed by moving its logic directly into main, simplifying the control flow.

  3. Improve error handling: The process.on('unhandledRejection', ...) can be replaced with a more explicit .catch() on the main() call. This would also allow the error handling logic to be moved outside the sample's region tags, which is a common and recommended pattern for samples.

Here is an example of a refactored structure:

'use strict';

const {SearchServiceClient} = require('@google-cloud/retail');

// [START retail_search_for_products_with_query_expansion_specification]
async function main() {
  const retailClient = new SearchServiceClient();
  // ... all logic from callSearch ...
}
// [END retail_search_for_products_with_query_expansion_specification]

main().catch(err => {
  console.error(err.message);
  process.exitCode = 1;
});

These changes would significantly improve the readability and maintainability of the sample.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: retail Issues related to the Retail API API. samples Issues that are directly related to samples.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant