Skip to content

fix: standardize getSecret sample#4114

Merged
iennae merged 4 commits intomainfrom
sigje-update-getSecret
Jun 26, 2025
Merged

fix: standardize getSecret sample#4114
iennae merged 4 commits intomainfrom
sigje-update-getSecret

Conversation

@iennae
Copy link
Copy Markdown
Contributor

@iennae iennae commented Jun 26, 2025

Description

Adds consistency; try/catch;

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).

@iennae iennae requested review from a team as code owners June 26, 2025 06:20
@snippet-bot
Copy link
Copy Markdown

snippet-bot Bot commented Jun 26, 2025

Here is the summary of changes.

You are about to add 1 region tag.
You are about to delete 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 samples Issues that are directly related to samples. api: secretmanager Issues related to the Secret Manager API. labels Jun 26, 2025
Copy link
Copy Markdown
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 @iennae, 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 refactors the getSecret sample for Google Cloud Secret Manager to enhance its robustness, consistency, and adherence to best practices. The changes standardize the sample's structure, improve error handling, ensure proper resource cleanup, and make the core function more reusable.

Highlights

  • Standardized Function Signature: The getSecret function has been refactored to explicitly accept projectId and secretId as parameters, making it more modular and testable. The main function now handles argument parsing from process.argv and process.env.
  • Improved Error Handling: A try/catch block has been added around the client.getSecret call to gracefully handle potential API errors, providing more robust error reporting.
  • Resource Management: The SecretManagerServiceClient is now properly closed using await client.close() within a finally block, ensuring efficient resource cleanup regardless of success or failure.
  • Enhanced Logging: The sample's output has been refined to provide more informative messages, including specific details about the secret's replication policy or noting its absence.
  • Module Export: The getSecret function is now exported via module.exports.getSecret, allowing it to be easily imported and used in other modules or for testing purposes.
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
Copy Markdown
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 refactors the getSecret sample to improve its structure and add error handling, which is a positive change. However, my review identified a critical issue where the changes break existing tests. I've also pointed out a high-severity issue in the error handling logic that could suppress failures and a medium-severity issue regarding missing input validation. I've provided code suggestions to address these points. Once these are resolved, the sample will be much more robust and reliable.

Comment thread secret-manager/getSecret.js
Comment on lines +45 to +47
} catch (err) {
console.error('Failed to retrieve secret ${name}:', err);
} finally {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

high

There are a couple of issues in the catch block:

  1. The error message uses template literal syntax (${name}) inside a single-quoted string. This prevents string interpolation, so the literal text ${name} will be logged instead of the secret's name. To fix this, you should use backticks (`) to create a template literal string.
  2. The catch block logs the error but doesn't re-throw it. This causes the getSecret function to implicitly return undefined on failure. When run from the command line, the script will then exit with a success code (0) even though an error occurred. The error should be re-thrown to ensure the process exits with a non-zero status code, correctly indicating failure.
  } catch (err) {
    console.error(`Failed to retrieve secret '${name}':`, err);
    throw err;
  }

Comment thread secret-manager/getSecret.js Dismissed
Copy link
Copy Markdown
Contributor

@NimJay NimJay left a comment

Choose a reason for hiding this comment

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

Thanks for doing this, @iennae! Changes look good.
I assume we'll have to re-update the sample (a bit more) once the samples from the "Copy-paste-runnable" workshopping is complete/approved (e.g., to move the client to global scope, etc.).

Ready the merge.

@iennae iennae merged commit 4cee7b2 into main Jun 26, 2025
17 checks passed
@iennae iennae deleted the sigje-update-getSecret branch June 26, 2025 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: secretmanager Issues related to the Secret Manager API. samples Issues that are directly related to samples.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants