Skip to content

chore(grpc): migrate from grpc to @grpc/grpc-js in getting-started-grpc example #4077

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

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

Conversation

hivanalejandro
Copy link
Contributor

@hivanalejandro hivanalejandro commented Apr 22, 2025

Description

Fixes b/410998134

Checklist

@product-auto-label product-auto-label bot added samples Issues that are directly related to samples. api: endpoints Issues related to the Cloud Endpoints API. labels Apr 22, 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.

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 migrates the gRPC implementation in the getting-started-grpc example from the deprecated grpc package to @grpc/grpc-js. This involves updating the dependencies in package.json, and modifying the client and server code to use the new @grpc/grpc-js package and @grpc/proto-loader for loading protobuf definitions. The bind call on the server is also updated to bindAsync.

Highlights

  • Dependency Update: The grpc dependency is replaced with @grpc/grpc-js and @grpc/proto-loader in package.json.
  • Code Migration: The client and server code are updated to use @grpc/grpc-js and @grpc/proto-loader for loading protobuf definitions. This includes changes to how the proto file is loaded and how the server is started.
  • API Change: The server.bind call is updated to server.bindAsync in server.js to align with the new gRPC implementation.

Changelog

  • endpoints/getting-started-grpc/client.js
    • Replaced grpc with @grpc/grpc-js and @grpc/proto-loader.
    • Updated protobuf loading to use protoLoader.loadSync and grpc.loadPackageDefinition.
  • endpoints/getting-started-grpc/package.json
    • Replaced grpc dependency with @grpc/grpc-js and added @grpc/proto-loader.
    • Removed trailing newline.
  • endpoints/getting-started-grpc/server.js
    • Replaced grpc with @grpc/grpc-js and @grpc/proto-loader.
    • Updated protobuf loading to use protoLoader.loadSync and grpc.loadPackageDefinition.
    • Updated server.bind to server.bindAsync.
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.


gRPC's call,
Async binds enthrall,
New versions arise,
Old code slowly dies,
Progress for us all.

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

The pull request migrates the getting-started-grpc example from the deprecated grpc package to @grpc/grpc-js. This is a necessary update to ensure the example remains functional and uses the recommended gRPC library for Node.js. The changes look good overall, but there are a few minor points to consider.

Summary of Findings

  • gRPC method call: The addProtoService method is deprecated and has been replaced with addService. The code has been updated to use addService.
  • Asynchronous binding: The bind method is deprecated and has been replaced with bindAsync. The code has been updated to use bindAsync.

Merge Readiness

The pull request is almost ready to be merged. The migration from the deprecated grpc package to @grpc/grpc-js is well-handled. Please address the comments regarding the deprecated methods to ensure the code is up-to-date with the latest gRPC practices. 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.

It runs well in my local environment, good work!
I found a question while trying to run it, and a warning which you might address.

`0.0.0.0:${PORT}`,
grpc.ServerCredentials.createInsecure(),
() => {
server.start();
Copy link
Contributor

Choose a reason for hiding this comment

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

issue: While running the script, the following warning is shown:
DeprecationWarning: Calling start() is no longer necessary. It can be safely omitted.
The signature '(): void' of 'server.start' is deprecated.ts(6387)

You may delete this call.

Copy link
Contributor

Choose a reason for hiding this comment

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

question: How did you test this file?
While trying to run it with node client.js -h localhost:PORT I'm getting:
One of API_KEY or JWT_AUTH_TOKEN must be set.

It's not clear in the README.md how to do it. You could add a link to get-id-token#generic-dev to indicate that the development-only token obtain by gcloud auth print-identity-token works.

The that worked was: node client.js -h localhost:PORT -j ID_TOKEN.
I think you should update the README.

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

Successfully merging this pull request may close these issues.

2 participants