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(cloud-tasks): await async function & correct endpoint URL #4030

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

hivanalejandro
Copy link
Contributor

@hivanalejandro hivanalejandro commented Mar 19, 2025

Description

Fixes b/336410523

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

Checklist

@product-auto-label product-auto-label bot added api: cloudtasks Issues related to the Cloud Tasks API. samples Issues that are directly related to samples. api: tasks Issues related to the Tasks API API. asset: pattern DEE Asset tagging - Pattern. labels Mar 19, 2025
Copy link

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

Hello @hivanalejandro, 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 a bug related to the Cloud Tasks tutorial, specifically fixing an issue where an async function was not being awaited and correcting the endpoint URL in the app.yaml file. The changes ensure that the createHttpTaskWithToken function is properly awaited in the /send-email route handler and that the FUNCTION_URL environment variable points to the correct endpoint (/send-email instead of /sendEmail).

Highlights

  • Bug Fix: The pull request fixes a bug where the createHttpTaskWithToken function was not being awaited, potentially leading to unexpected behavior.
  • Endpoint Correction: The pull request corrects the endpoint URL in the app.yaml file, ensuring that the Cloud Function is invoked correctly.

Changelog

  • cloud-tasks/tutorial-gcf/app/app.yaml
    • Corrected the FUNCTION_URL environment variable to point to the correct endpoint (/send-email). Line 22 was changed from FUNCTION_URL: "https://<region>-<project_id>.cloudfunctions.net/sendEmail" to FUNCTION_URL: "https://<region>-<project_id>.cloudfunctions.net/send-email".
  • cloud-tasks/tutorial-gcf/app/index.js
    • Modified the /send-email route handler to be an async function. Line 31 was changed from app.post('/send-email', (req, res) => { to app.post('/send-email', async (req, res) => {.
    • Awaited the createHttpTaskWithToken function call. Line 36 was changed from createHttpTaskWithToken( to await createHttpTaskWithToken(.
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.


In the realm of code, where tasks reside,
Awaiting functions, side by side.
An endpoint's call, a crucial quest,
To fix the path and put code to the test.

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

@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

The pull request addresses an issue with the endpoint URL in the app.yaml file and ensures that the createHttpTaskWithToken function is awaited in index.js. These changes improve the functionality and reliability of the Cloud Tasks tutorial application.

Summary of Findings

  • Missing await keyword: The original code in index.js was missing the await keyword when calling createHttpTaskWithToken. This has been fixed in this pull request.
  • Incorrect endpoint URL: The endpoint URL in app.yaml was incorrect. It has been corrected from /sendEmail to /send-email in this pull request.

Merge Readiness

The pull request appears to be in good shape and addresses the identified issues. The changes are straightforward and improve the correctness of the application. I am unable to directly approve the pull request, and recommend that others review and approve this code before merging.

Copy link
Contributor

@eapl-gemugami eapl-gemugami left a comment

Choose a reason for hiding this comment

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

LGTM as requested in Internal b/336410523

I think a TW should follow the tutorial to check that the change in the URL and async don't break anything
https://cloud.google.com/tasks/docs/tutorial-gcf

@hivanalejandro hivanalejandro requested a review from iennae March 19, 2025 18:00
@hivanalejandro hivanalejandro marked this pull request as ready for review March 19, 2025 18:01
@hivanalejandro hivanalejandro requested review from a team as code owners March 19, 2025 18:01
@glasnt glasnt self-assigned this Mar 20, 2025
@glasnt
Copy link
Contributor

glasnt commented Mar 20, 2025

Internal bug updated with tutorial content review (full code functionality replication/friction log pending)

@@ -19,7 +19,7 @@ runtime: nodejs16
env_variables:
QUEUE_NAME: "my-queue"
QUEUE_LOCATION: "us-central1"
FUNCTION_URL: "https://<region>-<project_id>.cloudfunctions.net/sendEmail"
FUNCTION_URL: "https://<region>-<project_id>.cloudfunctions.net/send-email"
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not correct: the Cloud Run function URL ends in /sendEmail; the app.post() seen below in the diff is the App Engine endpoint.

Suggested change
FUNCTION_URL: "https://<region>-<project_id>.cloudfunctions.net/send-email"
FUNCTION_URL: "https://<region>-<project_id>.cloudfunctions.net/sendEmail"

@product-auto-label product-auto-label bot removed the api: tasks Issues related to the Tasks API API. label Mar 20, 2025
@hivanalejandro hivanalejandro marked this pull request as draft March 24, 2025 16:47
@hivanalejandro hivanalejandro added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Mar 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: cloudtasks Issues related to the Cloud Tasks API. asset: pattern DEE Asset tagging - Pattern. do not merge Indicates a pull request not ready for merge, due to either quality or timing. samples Issues that are directly related to samples.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants