@probitas/client-grpc

gRPC client for Probitas scenario testing framework.

This package provides a gRPC client with Server Reflection support, designed for integration testing of gRPC services. It is a thin wrapper around @probitas/client-connectrpc with protocol: "grpc" pre-configured.

Features

• Native gRPC: Uses gRPC protocol (HTTP/2 with binary protobuf)
• Server Reflection: Auto-discover services and methods at runtime
• TLS Support: Configure secure connections with custom certificates
• Duration Tracking: Built-in timing for performance monitoring
• Error Handling: Test error responses without throwing exceptions
• Resource Management: Implements AsyncDisposable for proper cleanup

Installation

deno add jsr:@probitas/client-grpc

Quick Start

import { createGrpcClient } from "@probitas/client-grpc";

// Create client (uses reflection by default)
const client = createGrpcClient({
  url: "http://localhost:50051",
});

// Call a method
const response = await client.call(
  "echo.EchoService",
  "echo",
  { message: "Hello!" }
);
console.log(response.data());

await client.close();

Service Discovery

// Discover available services
const services = await client.reflection.listServices();
console.log("Services:", services);

// Get method information
const info = await client.reflection.getServiceInfo("echo.EchoService");
console.log("Methods:", info.methods);

Using with using Statement

await using client = createGrpcClient({ url: "http://localhost:50051" });

const res = await client.call("echo.EchoService", "echo", { message: "test" });
console.log(res.data());
// Client automatically closed when block exits

Related Packages

Package	Description
@probitas/client	Core utilities and types
@probitas/client-connectrpc	ConnectRPC client (supports Connect, gRPC, gRPC-Web)

Links

• GitHub Repository
• Probitas Framework
• gRPC

deno add jsr:@probitas/client-grpc

class GrpcError extends ClientError

new GrpcError(message: string, code: ConnectRpcStatusCode, rawMessage: string, options?: ConnectRpcErrorOptions)

class GrpcInternalError extends ConnectRpcError

new GrpcInternalError(rawMessage: string, options?: ConnectRpcErrorOptions)

class GrpcNotFoundError extends ConnectRpcError

new GrpcNotFoundError(rawMessage: string, options?: ConnectRpcErrorOptions)

class GrpcPermissionDeniedError extends ConnectRpcError

new GrpcPermissionDeniedError(rawMessage: string, options?: ConnectRpcErrorOptions)

class GrpcResourceExhaustedError extends ConnectRpcError

new GrpcResourceExhaustedError(rawMessage: string, options?: ConnectRpcErrorOptions)

class GrpcUnauthenticatedError extends ConnectRpcError

new GrpcUnauthenticatedError(rawMessage: string, options?: ConnectRpcErrorOptions)

class GrpcUnavailableError extends ConnectRpcError

new GrpcUnavailableError(rawMessage: string, options?: ConnectRpcErrorOptions)

interface ErrorDetail

interface GrpcClient extends AsyncDisposable

call<TRequest = unknown>(serviceName: string, methodName: string, request: TRequest, options?: ConnectRpcOptions): Promise<ConnectRpcResponse>

serverStream<TRequest = unknown>(serviceName: string, methodName: string, request: TRequest, options?: ConnectRpcOptions): AsyncIterable<ConnectRpcResponse>

clientStream<TRequest = unknown>(serviceName: string, methodName: string, requests: AsyncIterable<TRequest>, options?: ConnectRpcOptions): Promise<ConnectRpcResponse>

bidiStream<TRequest = unknown>(serviceName: string, methodName: string, requests: AsyncIterable<TRequest>, options?: ConnectRpcOptions): AsyncIterable<ConnectRpcResponse>

close(): Promise<void>

interface GrpcClientConfig extends Omit<ConnectRpcClientConfig, "protocol">

interface GrpcErrorOptions extends ErrorOptions

interface GrpcOptions extends CommonOptions

interface GrpcResponse

data<T = any>(): T | null

raw(): unknown

interface MethodInfo

interface ReflectionApi

listServices(): Promise<ServiceInfo[]>

getServiceInfo(serviceName: string): Promise<ServiceDetail>

listMethods(serviceName: string): Promise<MethodInfo[]>

hasService(serviceName: string): Promise<boolean>

interface ServiceDetail

interface ServiceInfo

interface TlsConfig

function createGrpcClient(config: GrpcClientConfig): ConnectRpcClient

const client = createGrpcClient({
  url: "http://localhost:50051",
});

// Call a method
const response = await client.call(
  "echo.EchoService",
  "echo",
  { message: "Hello!" }
);
console.log(response.data());

await client.close();

const client = createGrpcClient({
  url: "http://localhost:50051",
});

// Discover available services
const services = await client.reflection.listServices();
console.log("Available services:", services);

// Get method information
const info = await client.reflection.getServiceInfo("echo.EchoService");
console.log("Methods:", info.methods);

await client.close();

const response = await client.call(
  "user.UserService",
  "getUser",
  { id: "non-existent" },
  { throwOnError: false }
);

if (!response.ok) {
  console.log("Error code:", response.code);  // NOT_FOUND = 5
}

await using client = createGrpcClient({
  url: "http://localhost:50051",
});

const res = await client.call("echo.EchoService", "echo", { message: "test" });
console.log(res.data());
// Client automatically closed when scope exits

function getGrpcStatusName(code: ConnectRpcStatusCode): string

getStatusName(0);  // "OK"
getStatusName(5);  // "NOT_FOUND"
getStatusName(16); // "UNAUTHENTICATED"

function isGrpcStatusCode(code: number): code is ConnectRpcStatusCode

isConnectRpcStatusCode(0);   // true
isConnectRpcStatusCode(16);  // true
isConnectRpcStatusCode(99);  // false

type FileDescriptorSet = MessageShape<FileDescriptorSetSchema>

type GrpcStatusCode = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16

const GrpcStatus: { OK: number; CANCELLED: number; UNKNOWN: number; INVALID_ARGUMENT: number; DEADLINE_EXCEEDED: number; NOT_FOUND: number; ALREADY_EXISTS: number; PERMISSION_DENIED: number; RESOURCE_EXHAUSTED: number; FAILED_PRECONDITION: number; ABORTED: number; OUT_OF_RANGE: number; UNIMPLEMENTED: number; INTERNAL: number; UNAVAILABLE: number; DATA_LOSS: number; UNAUTHENTICATED: number }