Skip to content

Add tests for V1 and V1 Alpha Server Reflection #6

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 6 commits into
base: master
Choose a base branch
from
Open

Add tests for V1 and V1 Alpha Server Reflection #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2c0e13a
Add tests for V1 and V1 Alpha Server Reflection
deve-sh Oct 30, 2025
28fb948
De-duplicate grpc servers with a base
deve-sh Oct 30, 2025
1b51568
Merge branch 'feat/support-for-v1-server-reflection' into tests/v1-se…
deve-sh Oct 30, 2025
925cd47
Remove unnecessary reflection files
deve-sh Oct 30, 2025
6d46988
tests: Revert complicated widgets test to original proto files
deve-sh Oct 30, 2025
37e175a
tests: Update protoset definitions
deve-sh Oct 30, 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
2 changes: 1 addition & 1 deletion .eslintignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
build/src/reflection_*
Copy link
Collaborator Author

@deve-sh deve-sh Oct 30, 2025

Choose a reason for hiding this comment

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

Not sure why we were linting on built assets, they're obviously not going to adhere to the required eslint standards?

build/*
src/reflection_*
284 changes: 158 additions & 126 deletions test/client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import {describe, before, after, it} from 'mocha';
import {Client} from '../src/client';
import {credentials} from '@postman/grpc-js';
// eslint-disable-next-line node/no-unpublished-import
Expand All @@ -10,135 +11,166 @@ import {
FileDescriptorResponse,
} from '../src/reflection_providers/v1/reflection_pb';

// eslint-disable-next-line no-undef
describe('listServices', () => {
// eslint-disable-next-line no-undef
it('should return services', async () => {
const reflectionClient = new Client(
'localhost:4770',
credentials.createInsecure()
);

const grpcCall = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
on: function (_event: string, listener: (...args: any[]) => void) {
const res = new ServerReflectionResponse();

const service1 = new ServiceResponse();
service1.setName('grpc.reflection.v1alpha.ServerReflection');
const service2 = new ServiceResponse();
service2.setName('phone.Messenger');
const serviceList = [service1, service2];

const listService = new ListServiceResponse();
listService.setServiceList(serviceList);
res.setListServicesResponse(listService);

listener(res);
},
write: function () {},
end: function () {},
};

const mock = sinon.mock(reflectionClient.grpcClient);
mock.expects('serverReflectionInfo').once().returns(grpcCall);

const expectedServices: string[] = [
'grpc.reflection.v1alpha.ServerReflection',
'phone.Messenger',
];
assert.sameMembers(await reflectionClient.listServices(), expectedServices);
describe('server reflection tests', () => {
const reflectionMethodsToTest = [
{name: 'v1', port: 4771},
{name: 'v1alpha', port: 4772},
];

let mockV1Server: {port: number; shutdown: () => Promise<void>};
let mockV1AlphaServer: {port: number; shutdown: () => Promise<void>};

before(async () => {
const v1ServerImport = await import('./test-servers/v1-server'),
v1AlphaServerImport = await import('./test-servers/v1alpha-server');

mockV1Server = await v1ServerImport.start(4771);
mockV1AlphaServer = await v1AlphaServerImport.start(4772);
});
});

// eslint-disable-next-line no-undef
describe('fileContainingSymbol', () => {
// eslint-disable-next-line no-undef
it('should return Root', async () => {
const reflectionClient = new Client(
'localhost:4770',
credentials.createInsecure()
);

const grpcCallPhone = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
on: function (_event: string, listener: (...args: any[]) => void) {
if (_event === 'error') {
return;
}

const res = new ServerReflectionResponse();
const fileDescriptorResponse = new FileDescriptorResponse();
// eslint-disable-next-line prettier/prettier
const protoBytes = Buffer.from([10,11,112,104,111,110,101,46,112,114,111,116,111,18,5,112,104,111,110,101,26,13,99,111,110,116,97,99,116,46,112,114,111,116,111,34,97,10,11,84,101,120,116,82,101,113,117,101,115,116,18,14,10,2,105,100,24,1,32,1,40,9,82,2,105,100,18,24,10,7,109,101,115,115,97,103,101,24,2,32,1,40,9,82,7,109,101,115,115,97,103,101,18,40,10,7,99,111,110,116,97,99,116,24,3,32,1,40,11,50,14,46,112,104,111,110,101,46,67,111,110,116,97,99,116,82,7,99,111,110,116,97,99,116,34,40,10,12,84,101,120,116,82,101,115,112,111,110,115,101,18,24,10,7,115,117,99,99,101,115,115,24,1,32,1,40,8,82,7,115,117,99,99,101,115,115,50,63,10,9,77,101,115,115,101,110,103,101,114,18,50,10,7,77,101,115,115,97,103,101,18,18,46,112,104,111,110,101,46,84,101,120,116,82,101,113,117,101,115,116,26,19,46,112,104,111,110,101,46,84,101,120,116,82,101,115,112,111,110,115,101,98,6,112,114,111,116,111,51]);
fileDescriptorResponse.addFileDescriptorProto(protoBytes);
res.setFileDescriptorResponse(fileDescriptorResponse);

listener(res);
},
write: function () {},
end: function () {},
};

const grpcCallContact = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
on: function (_event: string, listener: (...args: any[]) => void) {
if (_event === 'error') {
return;
}

const res = new ServerReflectionResponse();
const fileDescriptorResponse = new FileDescriptorResponse();
// eslint-disable-next-line prettier/prettier
const protoBytes = Buffer.from([10,13,99,111,110,116,97,99,116,46,112,114,111,116,111,18,5,112,104,111,110,101,34,53,10,7,67,111,110,116,97,99,116,18,18,10,4,110,97,109,101,24,1,32,1,40,9,82,4,110,97,109,101,18,22,10,6,110,117,109,98,101,114,24,2,32,1,40,9,82,6,110,117,109,98,101,114,98,6,112,114,111,116,111,51]);
fileDescriptorResponse.addFileDescriptorProto(protoBytes);
res.setFileDescriptorResponse(fileDescriptorResponse);

listener(res);
},
write: function () {},
end: function () {},
};

const mock = sinon.mock(reflectionClient.grpcClient);
mock.expects('serverReflectionInfo').once().returns(grpcCallPhone);
mock.expects('serverReflectionInfo').once().returns(grpcCallContact);
const root = await reflectionClient.fileContainingSymbol('phone.Messenger');
assert.sameDeepMembers(root.files, ['contact.proto', 'phone.proto']);
after(async () => {
await mockV1Server.shutdown();
await mockV1AlphaServer.shutdown();
});

describe('listServices', async () => {
for (const version of reflectionMethodsToTest) {
it(`should return services: ${version.name}`, async () => {
const reflectionClient = new Client(
`0.0.0.0:${version.port}`,
credentials.createInsecure()
);

await reflectionClient.initialize();

const grpcCall = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
on: function (_event: string, listener: (...args: any[]) => void) {
const res = new ServerReflectionResponse();

const service1 = new ServiceResponse();
service1.setName('grpc.reflection.v1alpha.ServerReflection');
const service2 = new ServiceResponse();
service2.setName('phone.Messenger');
const serviceList = [service1, service2];

const listService = new ListServiceResponse();
listService.setServiceList(serviceList);
res.setListServicesResponse(listService);

listener(res);
},
write: function () {},
end: function () {},
};

const mock = sinon.mock(reflectionClient.grpcClient);
mock.expects('serverReflectionInfo').once().returns(grpcCall);

const expectedServices: string[] = ['phone.Messenger'];
assert.sameMembers(
await reflectionClient.listServices(),
expectedServices
);
});
}
});

describe('fileContainingSymbol', () => {
for (const version of reflectionMethodsToTest) {
it(`should return Root: ${version.name}`, async () => {
const reflectionClient = new Client(
`0.0.0.0:${version.port}`,
credentials.createInsecure()
);

await reflectionClient.initialize();

const grpcCallPhone = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
on: function (_event: string, listener: (...args: any[]) => void) {
if (_event === 'error') {
return;
}

const res = new ServerReflectionResponse();
const fileDescriptorResponse = new FileDescriptorResponse();
// eslint-disable-next-line prettier/prettier
const protoBytes = Buffer.from([10,11,112,104,111,110,101,46,112,114,111,116,111,18,5,112,104,111,110,101,26,13,99,111,110,116,97,99,116,46,112,114,111,116,111,34,97,10,11,84,101,120,116,82,101,113,117,101,115,116,18,14,10,2,105,100,24,1,32,1,40,9,82,2,105,100,18,24,10,7,109,101,115,115,97,103,101,24,2,32,1,40,9,82,7,109,101,115,115,97,103,101,18,40,10,7,99,111,110,116,97,99,116,24,3,32,1,40,11,50,14,46,112,104,111,110,101,46,67,111,110,116,97,99,116,82,7,99,111,110,116,97,99,116,34,40,10,12,84,101,120,116,82,101,115,112,111,110,115,101,18,24,10,7,115,117,99,99,101,115,115,24,1,32,1,40,8,82,7,115,117,99,99,101,115,115,50,63,10,9,77,101,115,115,101,110,103,101,114,18,50,10,7,77,101,115,115,97,103,101,18,18,46,112,104,111,110,101,46,84,101,120,116,82,101,113,117,101,115,116,26,19,46,112,104,111,110,101,46,84,101,120,116,82,101,115,112,111,110,115,101,98,6,112,114,111,116,111,51]);
fileDescriptorResponse.addFileDescriptorProto(protoBytes);
res.setFileDescriptorResponse(fileDescriptorResponse);

listener(res);
},
write: function () {},
end: function () {},
};

const grpcCallContact = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
on: function (_event: string, listener: (...args: any[]) => void) {
if (_event === 'error') {
return;
}

const res = new ServerReflectionResponse();
const fileDescriptorResponse = new FileDescriptorResponse();
// eslint-disable-next-line prettier/prettier
const protoBytes = Buffer.from([10,13,99,111,110,116,97,99,116,46,112,114,111,116,111,18,5,112,104,111,110,101,34,53,10,7,67,111,110,116,97,99,116,18,18,10,4,110,97,109,101,24,1,32,1,40,9,82,4,110,97,109,101,18,22,10,6,110,117,109,98,101,114,24,2,32,1,40,9,82,6,110,117,109,98,101,114,98,6,112,114,111,116,111,51]);
fileDescriptorResponse.addFileDescriptorProto(protoBytes);
res.setFileDescriptorResponse(fileDescriptorResponse);

listener(res);
},
write: function () {},
end: function () {},
};

const mock = sinon.mock(reflectionClient.grpcClient);
mock.expects('serverReflectionInfo').once().returns(grpcCallPhone);
mock.expects('serverReflectionInfo').once().returns(grpcCallContact);
const root = await reflectionClient.fileContainingSymbol(
'phone.Messenger'
);
assert.sameDeepMembers(root.files, ['contact.proto', 'phone.proto']);
});
}
});
});

// eslint-disable-next-line no-undef
describe('fileByFilename', () => {
// eslint-disable-next-line no-undef
it('should return Root', async () => {
const reflectionClient = new Client(
'localhost:4770',
credentials.createInsecure()
);

const grpcCallContact = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
on: function (_event: string, listener: (...args: any[]) => void) {
if (_event === 'error') {
return;
}
const res = new ServerReflectionResponse();
const fileDescriptorResponse = new FileDescriptorResponse();
// eslint-disable-next-line prettier/prettier
const protoBytes = Buffer.from([10,13,99,111,110,116,97,99,116,46,112,114,111,116,111,18,5,112,104,111,110,101,34,53,10,7,67,111,110,116,97,99,116,18,18,10,4,110,97,109,101,24,1,32,1,40,9,82,4,110,97,109,101,18,22,10,6,110,117,109,98,101,114,24,2,32,1,40,9,82,6,110,117,109,98,101,114,98,6,112,114,111,116,111,51]);
fileDescriptorResponse.addFileDescriptorProto(protoBytes);
res.setFileDescriptorResponse(fileDescriptorResponse);

listener(res);
},
write: function () {},
end: function () {},
};

const mock = sinon.mock(reflectionClient.grpcClient);
mock.expects('serverReflectionInfo').once().returns(grpcCallContact);
const root = await reflectionClient.fileByFilename('contact.proto');
assert.deepEqual(root.files, ['contact.proto']);
describe('fileByFilename', () => {
for (const version of reflectionMethodsToTest) {
it(`should return Root: ${version.name}`, async () => {
const reflectionClient = new Client(
`0.0.0.0:${version.port}`,
credentials.createInsecure()
);

await reflectionClient.initialize();

const grpcCallContact = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
on: function (_event: string, listener: (...args: any[]) => void) {
if (_event === 'error') {
return;
}
const res = new ServerReflectionResponse();
const fileDescriptorResponse = new FileDescriptorResponse();
// eslint-disable-next-line prettier/prettier
const protoBytes = Buffer.from([10,13,99,111,110,116,97,99,116,46,112,114,111,116,111,18,5,112,104,111,110,101,34,53,10,7,67,111,110,116,97,99,116,18,18,10,4,110,97,109,101,24,1,32,1,40,9,82,4,110,97,109,101,18,22,10,6,110,117,109,98,101,114,24,2,32,1,40,9,82,6,110,117,109,98,101,114,98,6,112,114,111,116,111,51]);
fileDescriptorResponse.addFileDescriptorProto(protoBytes);
res.setFileDescriptorResponse(fileDescriptorResponse);

listener(res);
},
write: function () {},
end: function () {},
};

const mock = sinon.mock(reflectionClient.grpcClient);
mock.expects('serverReflectionInfo').once().returns(grpcCallContact);
const root = await reflectionClient.fileByFilename('contact.proto');
assert.deepEqual(root.files, ['contact.proto']);
});
}
});
});
14 changes: 14 additions & 0 deletions test/fixtures/server_descriptor.protoset
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

�
test/fixtures/phone.protophone"5
Contact
name ( Rname
number ( Rnumber"a
TextRequest
id ( Rid
message ( Rmessage(
contact ( 2.phone.ContactRcontact"(
TextResponse
success (Rsuccess2?
Messenger2
Message.phone.TextRequest.phone.TextResponsebproto3
Loading