fix(functions): WIP update and fix functions_billing_stop sample
#4085
Conversation
product-auto-label
bot
added
api: cloudfunctions
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @eapl-gemugami, 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!
Summary of Changes
This pull request addresses issue b/403855924 by updating and validating the functions_billing_stop sample for a Cloud Run Function to meet current Node 20 requirements. The sample is used in the disable-billing-with-notifications#create-cloud-run-function documentation.
Highlights
- Node.js 20 Compatibility: The sample has been updated to ensure compatibility with Node.js 20 runtime environment.
- .gcloudignore update: A
.gcloudignorefile was added to prevent uploadingnode_modulesto Google Cloud Platform. - Code Validation: The code has been validated to ensure it functions correctly with the updated dependencies and Node.js version.
Changelog
Click here to see the changelog
- functions/billing/stop_billing/.gcloudignore
- Added a
.gcloudignorefile to prevent uploadingnode_modulesand other unnecessary files to Google Cloud Platform. This improves deployment speed and reduces the size of the deployed function.
- Added a
- functions/billing/stop_billing/index.js
- Updated the copyright year to 2025.
- The code was reviewed and updated to ensure compatibility with Node.js 20 and the latest versions of the Google Cloud Functions Framework and Billing client libraries.
- No functional changes were made to the core logic of the function.
- functions/billing/stop_billing/package.json
- Updated the
engines.nodefield to'>=20.0.0'to specify the required Node.js version. - Updated the versions of
@google-cloud/billing,@google-cloud/functions-framework, andgcp-metadatato their latest versions. - Updated the versions of dev dependencies such as
c8,gaxios,mocha,promise-retry,proxyquire,sinon, andwait-portto their latest versions.
- Updated the
- functions/billing/stop_billing/test/index.test.js
- No changes were made to this file.
- functions/billing/stop_billing/test/periodic.test.js
- No changes were made to this file.
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.
Node twenty's call,
Billing stops before the fall,
A budget's defense.
Footnotes
-
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. ↩
There was a problem hiding this comment.
Code Review
The pull request updates and fixes the functions_billing_stop sample for a Cloud Run Function, ensuring it meets current Node 20 requirements. The changes include updates to dependencies, the .gcloudignore file, and the main function logic. The tests have also been updated to reflect these changes. Overall, the changes seem well-structured and address the identified issue.
Summary of Findings
- Missing test case: The test case for disabling billing is currently marked as skipped (
xit). It should be enabled and validated to ensure the function works as expected. - Copyright year: The copyright year in
index.jsis set to 2025. Please confirm that this is the correct year. - Simulated billing disable: The billing disable function is currently simulating the disable. The actual billing disable code should be enabled.
Merge Readiness
The pull request is almost ready for merging. However, the test case for disabling billing is currently skipped and the billing disable function is simulating the disable. These issues should be addressed before merging. I am unable to directly approve this pull request, and recommend that others review and approve this code before merging.
| // DEBUG: Simulate disabling billing | ||
| console.log('Billing disabled. (Simulated)'); | ||
|
|
||
| /* | ||
| const [response] = await billing.updateProjectBillingInfo({ | ||
| name: projectName, | ||
| resource: body, // Disable billing | ||
| }); | ||
|
|
||
| console.log(`Billing disabled: ${JSON.stringify(response)}`); | ||
| */ |
There was a problem hiding this comment.
The billing disable function is currently simulating the disable. To fully test this, the actual billing disable code should be enabled and the simulation removed. Consider adding a configuration option to control whether the function actually disables billing, to avoid unintended consequences during testing.
// DEBUG: Simulate disabling billing
// console.log('Billing disabled. (Simulated)');
const [response] = await billing.updateProjectBillingInfo({
name: projectName,
resource: {billingAccountName: ''}, // Disable billing
});
console.log(`Billing disabled: ${JSON.stringify(response)}`);There was a problem hiding this comment.
This will be fixed in the final PR. This is left to show how the sample is currently tested in the Cloud Run Environment.
| }); | ||
|
|
||
| describe('functions_billing_stop', () => { | ||
| xit('should disable billing when budget is exceeded', async () => { |
There was a problem hiding this comment.
This test case is currently marked as skipped (xit). It should be enabled and validated to ensure the function works as expected. Consider adding assertions to verify that billing is actually disabled after the function is executed.
| xit('should disable billing when budget is exceeded', async () => { | |
| it('should disable billing when budget is exceeded', async () => { |
snippet-bot
bot
removed
the
snippet-bot:force-run
|
Here is the summary of changes. You are about to add 1 region tag.
This comment is generated by snippet-bot.
|
…g billing - Style fixes - Fix comments
|
@davidcavazos if you could also take a look at this one; thanks! |
|
@davidcavazos for this sample I'm planning to add a Unit Test similar to that on Python stop_billing_test.py The current one is just a copy from the test in the parent folder. |
Description
Fixes b/403855924
This sample for a Cloud Run Function used in disable-billing-with-notifications#create-cloud-run-function is updated and validated to current Node 20 requirements.
Checklist
npm test(see Testing)npm run lint(see Style)GoogleCloudPlatform/nodejs-docs-samples. Not a fork.