gRPC Client

You are a backend developer creating type-safe gRPC clients in Node.js. The user wants to build a gRPC client with proper error handling, connection management, and type safety using Protocol Buffers.

What to check first

• Run npm list grpc to verify @grpc/grpc-js is installed
• Check that your .proto file exists and defines your service (e.g., service UserService { rpc GetUser(...) returns (...); })
• Confirm the gRPC server is running on the expected host:port (default localhost:50051)

Steps

1. Install @grpc/grpc-js and @grpc/proto-loader packages for gRPC support
2. Load your .proto file using grpc.load() with proto-loader to generate type definitions
3. Create a client stub by calling the service constructor with the server address and credentials
4. Implement error handling with try-catch blocks catching RpcError with code and message properties
5. Add connection state management using client.getChannel().getConnectivityState() before making calls
6. Implement retry logic using exponential backoff for transient errors (UNAVAILABLE, RESOURCE_EXHAUSTED)
7. Add request/response timeout configuration in metadata object passed to each call
8. Wrap the client in a class with methods that handle streaming, unary, and bidirectional RPC patterns

Code

const grpc = require('@grpc/grpc-js');
const protoLoader = require('@grpc/proto-loader');
const path = require('path');

// Load proto file
const packageDefinition = protoLoader.loadSync(
  path.join(__dirname, 'user.proto'),
  {
    keepCase: true,
    longs: String,
    enums: String,
    defaults: true,
    oneofs: true
  }
);

const userProto = grpc.loadPackageDefinition(packageDefinition);

class UserServiceClient {
  constructor(host = 'localhost:50051') {
    this.client = new userProto.user.UserService(
      host,
      grpc.credentials.createInsecure()
    );
    this.maxRetries = 3;
  }

  // Unary RPC with error handling and retries
  async getUser(userId, retries = 0) {
    try {
      const deadline = new Date();
      deadline.setSeconds(deadline.getSeconds() + 5); // 5s timeout

      return new Promise((resolve, reject) => {
        this.client.getUser(
          { user_id: userId },
          { deadline },
          (err, response) => {
            if (err) {
              if (retries < this.maxRetries && this.isRetryable(err.code)) {
                const delay = Math.pow(2, retries) * 100;
                setTimeout(() => {

Note: this example was truncated in the source. See the GitHub repo for the latest full version.

Common Pitfalls

• Treating this skill as a one-shot solution — most workflows need iteration and verification
• Skipping the verification steps — you don't know it worked until you measure
• Applying this skill without understanding the underlying problem — read the related docs first

When NOT to Use This Skill

• When a simpler manual approach would take less than 10 minutes
• On critical production systems without testing in staging first
• When you don't have permission or authorization to make these changes

How to Verify It Worked

• Run the verification steps documented above
• Compare the output against your expected baseline
• Check logs for any warnings or errors — silent failures are the worst kind

Production Considerations

• Test in staging before deploying to production
• Have a rollback plan — every change should be reversible
• Monitor the affected systems for at least 24 hours after the change