grpc
/
grpc-node
mirror of https://github.com/grpc/grpc-node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

proto-loader: fix linting issues 

This commit makes the linter pass for proto-loader.
This commit is contained in:
cjihrig 2019-04-01 16:29:50 -04:00
parent cbff0b4601
commit c5cc74e589
No known key found for this signature in database
GPG Key ID: 7434390BDBE9B9C5
2 changed files with 127 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

118
packages/proto-loader/src/index.ts
View File

@ -15,33 +15,34 @@
* limitations under the License.
*
*/
import * as Protobuf from 'protobufjs';
import * as descriptor from 'protobufjs/ext/descriptor';
import * as fs from 'fs';
import * as path from 'path';
import * as Protobuf from 'protobufjs';
import * as descriptor from 'protobufjs/ext/descriptor';
import camelCase = require('lodash.camelcase');
declare module 'protobufjs' {
interface Type {
toDescriptor(protoVersion: string): Protobuf.Message<descriptor.IDescriptorProto> & descriptor.IDescriptorProto;
toDescriptor(protoVersion: string): Protobuf
.Message<descriptor.IDescriptorProto>&descriptor.IDescriptorProto;
}
interface Root {
toDescriptor(protoVersion: string): Protobuf.Message<descriptor.IFileDescriptorSet> & descriptor.IFileDescriptorSet;
toDescriptor(protoVersion: string): Protobuf
.Message<descriptor.IFileDescriptorSet>&descriptor.IFileDescriptorSet;
}
interface Enum {
toDescriptor(protoVersion: string): Protobuf.Message<descriptor.IEnumDescriptorProto> & descriptor.IEnumDescriptorProto;
toDescriptor(protoVersion: string):
Protobuf.Message<descriptor.IEnumDescriptorProto>&
descriptor.IEnumDescriptorProto;
}
}
export interface Serialize<T> {
(value: T): Buffer;
}
export interface Serialize<T> { (value: T): Buffer; }
export interface Deserialize<T> {
(bytes: Buffer): T;
}
export interface Deserialize<T> { (bytes: Buffer): T; }
export interface ProtobufTypeDefinition {
format: string;
@ -74,13 +75,12 @@ export interface ServiceDefinition {
[index: string]: MethodDefinition<object, object>;
}
export type AnyDefinition = ServiceDefinition | MessageTypeDefinition | EnumTypeDefinition;
export type AnyDefinition =
ServiceDefinition|MessageTypeDefinition|EnumTypeDefinition;
export interface PackageDefinition {
[index: string]: AnyDefinition;
}
export interface PackageDefinition { [index: string]: AnyDefinition; }
export type Options = Protobuf.IParseOptions & Protobuf.IConversionOptions & {
export type Options = Protobuf.IParseOptions&Protobuf.IConversionOptions&{
includeDirs?: string[];
};
@ -101,31 +101,41 @@ function joinName(baseName: string, name: string): string {
}
}
type HandledReflectionObject = Protobuf.Service | Protobuf.Type | Protobuf.Enum;
type HandledReflectionObject = Protobuf.Service|Protobuf.Type|Protobuf.Enum;
function isHandledReflectionObject(obj: Protobuf.ReflectionObject): obj is HandledReflectionObject {
return obj instanceof Protobuf.Service || obj instanceof Protobuf.Type || obj instanceof Protobuf.Enum;
function isHandledReflectionObject(obj: Protobuf.ReflectionObject):
obj is HandledReflectionObject {
return obj instanceof Protobuf.Service || obj instanceof Protobuf.Type ||
obj instanceof Protobuf.Enum;
}
function isNamespaceBase(obj: Protobuf.ReflectionObject): obj is Protobuf.NamespaceBase {
function isNamespaceBase(obj: Protobuf.ReflectionObject):
obj is Protobuf.NamespaceBase {
return obj instanceof Protobuf.Namespace || obj instanceof Protobuf.Root;
}
function getAllHandledReflectionObjects(obj: Protobuf.ReflectionObject, parentName: string): Array<[string, HandledReflectionObject]> {
function getAllHandledReflectionObjects(
obj: Protobuf.ReflectionObject,
parentName: string): Array<[string, HandledReflectionObject]> {
const objName = joinName(parentName, obj.name);
if (isHandledReflectionObject(obj)) {
return [[objName, obj]];
} else {
if (isNamespaceBase(obj) && typeof obj.nested !== undefined) {
return Object.keys(obj.nested!).map((name) => {
return getAllHandledReflectionObjects(obj.nested![name], objName);
}).reduce((accumulator, currentValue) => accumulator.concat(currentValue), []);
return Object.keys(obj.nested!)
.map((name) => {
return getAllHandledReflectionObjects(obj.nested![name], objName);
})
.reduce(
(accumulator, currentValue) => accumulator.concat(currentValue),
[]);
}
}
return [];
}
function createDeserializer(cls: Protobuf.Type, options: Options): Deserialize<object> {
function createDeserializer(
cls: Protobuf.Type, options: Options): Deserialize<object> {
return function deserialize(argBuf: Buffer): object {
return cls.toObject(cls.decode(argBuf), options);
};
@ -138,7 +148,9 @@ function createSerializer(cls: Protobuf.Type): Serialize<object> {
};
}
function createMethodDefinition(method: Protobuf.Method, serviceName: string, options: Options): MethodDefinition<object, object> {
function createMethodDefinition(
method: Protobuf.Method, serviceName: string,
options: Options): MethodDefinition<object, object> {
/* This is only ever called after the corresponding root.resolveAll(), so we
* can assume that the resolved request and response types are non-null */
const requestType: Protobuf.Type = method.resolvedRequestType!;
@ -158,7 +170,9 @@ function createMethodDefinition(method: Protobuf.Method, serviceName: string, op
};
}
function createServiceDefinition(service: Protobuf.Service, name: string, options: Options): ServiceDefinition {
function createServiceDefinition(
service: Protobuf.Service, name: string,
options: Options): ServiceDefinition {
const def: ServiceDefinition = {};
for (const method of service.methodsArray) {
def[method.name] = createMethodDefinition(method, name, options);
@ -166,29 +180,37 @@ function createServiceDefinition(service: Protobuf.Service, name: string, option
return def;
}
const fileDescriptorCache: Map<Protobuf.Root, Buffer[]> = new Map<Protobuf.Root, Buffer[]>();
const fileDescriptorCache: Map<Protobuf.Root, Buffer[]> =
new Map<Protobuf.Root, Buffer[]>();
function getFileDescriptors(root: Protobuf.Root): Buffer[] {
if (fileDescriptorCache.has(root)) {
return fileDescriptorCache.get(root)!;
} else {
const descriptorList: descriptor.IFileDescriptorProto[] = root.toDescriptor('proto3').file;
const bufferList: Buffer[] = descriptorList.map(value => Buffer.from(descriptor.FileDescriptorProto.encode(value).finish()));
const descriptorList: descriptor.IFileDescriptorProto[] =
root.toDescriptor('proto3').file;
const bufferList: Buffer[] = descriptorList.map(
value =>
Buffer.from(descriptor.FileDescriptorProto.encode(value).finish()));
fileDescriptorCache.set(root, bufferList);
return bufferList;
}
}
function createMessageDefinition(message: Protobuf.Type): MessageTypeDefinition {
const messageDescriptor: protobuf.Message<descriptor.IDescriptorProto> = message.toDescriptor('proto3');
function createMessageDefinition(message: Protobuf.Type):
MessageTypeDefinition {
const messageDescriptor: protobuf.Message<descriptor.IDescriptorProto> =
message.toDescriptor('proto3');
return {
format: 'Protocol Buffer 3 DescriptorProto',
type: messageDescriptor.$type.toObject(messageDescriptor, descriptorOptions),
type:
messageDescriptor.$type.toObject(messageDescriptor, descriptorOptions),
fileDescriptorProtos: getFileDescriptors(message.root)
};
}
function createEnumDefinition(enumType: Protobuf.Enum): EnumTypeDefinition {
const enumDescriptor: protobuf.Message<descriptor.IEnumDescriptorProto> = enumType.toDescriptor('proto3');
const enumDescriptor: protobuf.Message<descriptor.IEnumDescriptorProto> =
enumType.toDescriptor('proto3');
return {
format: 'Protocol Buffer 3 EnumDescriptorProto',
type: enumDescriptor.$type.toObject(enumDescriptor, descriptorOptions),
@ -197,11 +219,15 @@ function createEnumDefinition(enumType: Protobuf.Enum): EnumTypeDefinition {
}
/**
* function createDefinition(obj: Protobuf.Service, name: string, options: Options): ServiceDefinition;
* function createDefinition(obj: Protobuf.Type, name: string, options: Options): MessageTypeDefinition;
* function createDefinition(obj: Protobuf.Enum, name: string, options: Options): EnumTypeDefinition;
* function createDefinition(obj: Protobuf.Service, name: string, options:
* Options): ServiceDefinition; function createDefinition(obj: Protobuf.Type,
* name: string, options: Options): MessageTypeDefinition; function
* createDefinition(obj: Protobuf.Enum, name: string, options: Options):
* EnumTypeDefinition;
*/
function createDefinition(obj: HandledReflectionObject, name: string, options: Options): AnyDefinition {
function createDefinition(
obj: HandledReflectionObject, name: string,
options: Options): AnyDefinition {
if (obj instanceof Protobuf.Service) {
return createServiceDefinition(obj, name, options);
} else if (obj instanceof Protobuf.Type) {
@ -213,7 +239,8 @@ function createDefinition(obj: HandledReflectionObject, name: string, options: O
}
}
function createPackageDefinition(root: Protobuf.Root, options: Options): PackageDefinition {
function createPackageDefinition(
root: Protobuf.Root, options: Options): PackageDefinition {
const def: PackageDefinition = {};
root.resolveAll();
for (const [name, obj] of getAllHandledReflectionObjects(root, '')) {
@ -265,12 +292,14 @@ function addIncludePathResolver(root: Protobuf.Root, includePaths: string[]) {
* name
* @param options.includeDirs Paths to search for imported `.proto` files.
*/
export function load(filename: string, options?: Options): Promise<PackageDefinition> {
export function load(
filename: string, options?: Options): Promise<PackageDefinition> {
const root: Protobuf.Root = new Protobuf.Root();
options = options || {};
if (!!options.includeDirs) {
if (!(Array.isArray(options.includeDirs))) {
return Promise.reject(new Error('The includeDirs option must be an array'));
return Promise.reject(
new Error('The includeDirs option must be an array'));
}
addIncludePathResolver(root, options.includeDirs as string[]);
}
@ -280,7 +309,8 @@ export function load(filename: string, options?: Options): Promise<PackageDefini
});
}
export function loadSync(filename: string, options?: Options): PackageDefinition {
export function loadSync(
filename: string, options?: Options): PackageDefinition {
const root: Protobuf.Root = new Protobuf.Root();
options = options || {};
if (!!options.includeDirs) {
@ -299,8 +329,8 @@ export function loadSync(filename: string, options?: Options): PackageDefinition
// Protobuf.js exposes: any, duration, empty, field_mask, struct, timestamp,
// and wrappers. compiler/plugin is excluded in Protobuf.js and here.
const wellKnownProtos = ['api', 'descriptor', 'source_context', 'type'];
const sourceDir = path.join(path.dirname(require.resolve('protobufjs')),
'google', 'protobuf');
const sourceDir = path.join(
path.dirname(require.resolve('protobufjs')), 'google', 'protobuf');
for (const proto of wellKnownProtos) {
const file = path.join(sourceDir, `${proto}.proto`);

86
packages/proto-loader/test/descriptor_type_test.ts
View File

@ -22,7 +22,8 @@ import * as proto_loader from '../src/index';
// Relative path from build output directory to test_protos directory
const TEST_PROTO_DIR = `${__dirname}/../../test_protos/`;
type TypeDefinition = proto_loader.EnumTypeDefinition | proto_loader.MessageTypeDefinition;
type TypeDefinition =
proto_loader.EnumTypeDefinition|proto_loader.MessageTypeDefinition;
function isTypeObject(obj: proto_loader.AnyDefinition): obj is TypeDefinition {
return 'format' in obj;
@ -30,42 +31,61 @@ function isTypeObject(obj: proto_loader.AnyDefinition): obj is TypeDefinition {
describe('Descriptor types', () => {
it('Should be output for each enum', (done) => {
proto_loader.load(`${TEST_PROTO_DIR}/enums.proto`).then((packageDefinition) => {
assert('Enum1' in packageDefinition);
assert(isTypeObject(packageDefinition.Enum1));
// Need additional check because compiler doesn't understand asserts
if(isTypeObject(packageDefinition.Enum1)) {
const enum1Def: TypeDefinition = packageDefinition.Enum1;
assert.strictEqual(enum1Def.format, 'Protocol Buffer 3 EnumDescriptorProto');
}
proto_loader.load(`${TEST_PROTO_DIR}/enums.proto`)
.then(
(packageDefinition) => {
assert('Enum1' in packageDefinition);
assert(isTypeObject(packageDefinition.Enum1));
// Need additional check because compiler doesn't understand
// asserts
if (isTypeObject(packageDefinition.Enum1)) {
const enum1Def: TypeDefinition = packageDefinition.Enum1;
assert.strictEqual(
enum1Def.format, 'Protocol Buffer 3 EnumDescriptorProto');
}
assert('Enum2' in packageDefinition);
assert(isTypeObject(packageDefinition.Enum2));
// Need additional check because compiler doesn't understand asserts
if(isTypeObject(packageDefinition.Enum2)) {
const enum2Def: TypeDefinition = packageDefinition.Enum2;
assert.strictEqual(enum2Def.format, 'Protocol Buffer 3 EnumDescriptorProto');
}
done();
}, (error) => {done(error);});
assert('Enum2' in packageDefinition);
assert(isTypeObject(packageDefinition.Enum2));
// Need additional check because compiler doesn't understand
// asserts
if (isTypeObject(packageDefinition.Enum2)) {
const enum2Def: TypeDefinition = packageDefinition.Enum2;
assert.strictEqual(
enum2Def.format, 'Protocol Buffer 3 EnumDescriptorProto');
}
done();
},
(error) => {
done(error);
});
});
it('Should be output for each message', (done) => {
proto_loader.load(`${TEST_PROTO_DIR}/messages.proto`).then((packageDefinition) => {
assert('LongValues' in packageDefinition);
assert(isTypeObject(packageDefinition.LongValues));
if(isTypeObject(packageDefinition.LongValues)) {
const longValuesDef: TypeDefinition = packageDefinition.LongValues;
assert.strictEqual(longValuesDef.format, 'Protocol Buffer 3 DescriptorProto');
}
proto_loader.load(`${TEST_PROTO_DIR}/messages.proto`)
.then(
(packageDefinition) => {
assert('LongValues' in packageDefinition);
assert(isTypeObject(packageDefinition.LongValues));
if (isTypeObject(packageDefinition.LongValues)) {
const longValuesDef: TypeDefinition =
packageDefinition.LongValues;
assert.strictEqual(
longValuesDef.format, 'Protocol Buffer 3 DescriptorProto');
}
assert('SequenceValues' in packageDefinition);
assert(isTypeObject(packageDefinition.SequenceValues));
if(isTypeObject(packageDefinition.SequenceValues)) {
const sequenceValuesDef: TypeDefinition = packageDefinition.SequenceValues;
assert.strictEqual(sequenceValuesDef.format, 'Protocol Buffer 3 DescriptorProto');
}
done();
}, (error) => {done(error);});
assert('SequenceValues' in packageDefinition);
assert(isTypeObject(packageDefinition.SequenceValues));
if (isTypeObject(packageDefinition.SequenceValues)) {
const sequenceValuesDef: TypeDefinition =
packageDefinition.SequenceValues;
assert.strictEqual(
sequenceValuesDef.format,
'Protocol Buffer 3 DescriptorProto');
}
done();
},
(error) => {
done(error);
});
});
it('Can use well known Google protos', () => {