Skip to content

v1 reflection: Bail out early for required configs not passed #7

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

v1 reflection: Bail out early for required configs not passed #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5e35c2
v1 reflection: Bail out early for required configs not passed
deve-sh Nov 3, 2025
a83817c
Add check for credentials to be passed in gRPC Client constructor
deve-sh Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 29 additions & 19 deletions src/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,16 @@ export class Client {
options?: object,
metadata?: Metadata
) {
if (!url) {
throw new Error('Error: url is required for server reflection');
}

if (!credentials) {
throw new Error(
'Error: credentials parameter is required for server reflection'
);
}

Comment on lines +60 to +69
Copy link
Collaborator Author

@deve-sh deve-sh Nov 3, 2025

Choose a reason for hiding this comment

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

Why not have this error handled and caught in the supported API evaluation function? Because we want the consumer of this library to know even before they reach the stage of calling the reflection API.

If the constructor crashes at initialization, hence notifying the consumer of the problem in their implementation. The listServices function will never be invoked in the first place.

This mimics the behaviour we had earlier.

this.url = url;
this.credentials = credentials;
this.clientOptions = options;
Expand Down Expand Up @@ -114,27 +124,27 @@ export class Client {
supportedReflectionAPIVersions[
version as keyof typeof supportedReflectionAPIVersions
];
const {
service: servicePromise,
client: clientPromise,
} = protocolConfig;

const [protocolService, protocolClient] = await Promise.all([
servicePromise,
clientPromise,
]);

const grpcClientForProtocol = new protocolService.ServerReflectionClient(
this.url,
this.credentials,
this.clientOptions
);

const request = new protocolClient.ServerReflectionRequest();
try {
const {service: servicePromise, client: clientPromise} =
protocolConfig;

const [protocolService, protocolClient] = await Promise.all([
servicePromise,
clientPromise,
]);

const grpcClientForProtocol =
new protocolService.ServerReflectionClient(
this.url,
this.credentials,
this.clientOptions
);

request.setListServices('*');
const request = new protocolClient.ServerReflectionRequest();

request.setListServices('*');

try {
const [reflectionResponse] = await this.sendReflectionRequest(
request,
grpcClientForProtocol
Expand Down Expand Up @@ -174,7 +184,7 @@ export class Client {
});

const resultWithServiceError = evaluationResults.find(res => {
// Something is actually wrong with the gRPC service
// Something is actually wrong with the gRPC service or client
return res.error && res.error.code !== GrpcStatus.UNIMPLEMENTED;
});

Expand Down