@hodfords/nestjs-grpc-helper 12.3.1 → 12.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +218 -1
- package/commands/generate-sdk.command.js +8 -2
- package/commands/generate-sdk.command.js.map +1 -1
- package/constants/sdk-toolchain.const.d.ts +25 -0
- package/constants/sdk-toolchain.const.js +38 -0
- package/constants/sdk-toolchain.const.js.map +1 -0
- package/decorators/grpc-param.decorator.js +5 -4
- package/decorators/grpc-param.decorator.js.map +1 -1
- package/decorators/property.decorator.js +6 -3
- package/decorators/property.decorator.js.map +1 -1
- package/documents/microservice-document.controller.d.ts +1 -1
- package/dto/sort.dto.d.ts +1 -1
- package/dto/sort.dto.js +1 -1
- package/dto/sort.dto.js.map +1 -1
- package/helpers/generate.helper.d.ts +4 -3
- package/helpers/generate.helper.js +41 -3
- package/helpers/generate.helper.js.map +1 -1
- package/helpers/grpc-method.helper.js +1 -3
- package/helpers/grpc-method.helper.js.map +1 -1
- package/helpers/sdk-naming.helper.d.ts +7 -0
- package/helpers/sdk-naming.helper.js +197 -0
- package/helpers/sdk-naming.helper.js.map +1 -0
- package/helpers/sdk-output.helper.d.ts +6 -0
- package/helpers/sdk-output.helper.js +84 -0
- package/helpers/sdk-output.helper.js.map +1 -0
- package/helpers/shell.helper.d.ts +4 -0
- package/helpers/shell.helper.js +36 -0
- package/helpers/shell.helper.js.map +1 -1
- package/helpers/wire-response.helper.d.ts +8 -0
- package/helpers/wire-response.helper.js +23 -0
- package/helpers/wire-response.helper.js.map +1 -0
- package/index.d.ts +3 -0
- package/index.js +3 -0
- package/index.js.map +1 -1
- package/package.json +3 -1
- package/sdk-stub/helpers/grpc.helper.d.ts +1 -0
- package/sdk-stub/helpers/grpc.helper.js +11 -13
- package/sdk-stub/helpers/grpc.helper.js.map +1 -1
- package/sdk-stub/helpers/grpc.helper.spec.ts +46 -0
- package/sdk-stub/helpers/grpc.helper.ts +19 -12
- package/services/generate-proto.service.d.ts +1 -1
- package/services/generate-proto.service.js +11 -19
- package/services/generate-proto.service.js.map +1 -1
- package/services/go-sdk-generator.service.d.ts +26 -0
- package/services/go-sdk-generator.service.js +227 -0
- package/services/go-sdk-generator.service.js.map +1 -0
- package/services/protoc.service.d.ts +5 -0
- package/services/protoc.service.js +26 -0
- package/services/protoc.service.js.map +1 -0
- package/services/rust-sdk-generator.service.d.ts +24 -0
- package/services/rust-sdk-generator.service.js +201 -0
- package/services/rust-sdk-generator.service.js.map +1 -0
- package/services/sdk-descriptor.service.d.ts +13 -0
- package/services/sdk-descriptor.service.js +142 -0
- package/services/sdk-descriptor.service.js.map +1 -0
- package/templates/go/client.hbs +171 -0
- package/templates/go/enums.hbs +14 -0
- package/templates/go/errors.hbs +55 -0
- package/templates/go/go-mod.hbs +8 -0
- package/templates/rust/cargo-toml.hbs +13 -0
- package/templates/rust/client.hbs +100 -0
- package/templates/rust/enums.hbs +61 -0
- package/templates/rust/error.hbs +52 -0
- package/templates/rust/lib.hbs +17 -0
- package/types/sdk-build-config.type.d.ts +15 -0
- package/types/sdk-build-config.type.js +1 -1
- package/types/sdk-build-config.type.js.map +1 -1
- package/types/sdk-descriptor.type.d.ts +29 -0
- package/types/sdk-descriptor.type.js +2 -0
- package/types/sdk-descriptor.type.js.map +1 -0
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
import { Logger } from '@nestjs/common';
|
|
2
|
+
import fs from 'fs-extra';
|
|
3
|
+
import path from 'node:path';
|
|
4
|
+
import { PROTOC_TOOL, RUST_SDK_TOOLCHAIN } from '../constants/sdk-toolchain.const.js';
|
|
5
|
+
import { enumMemberName, toRustIdentifier, toSnakeCase, toUpperCamelCase } from '../helpers/sdk-naming.helper.js';
|
|
6
|
+
import { RUST_OWNED_PATHS, stageOwnedPaths } from '../helpers/sdk-output.helper.js';
|
|
7
|
+
import { findBinary, isVersionAtLeast, readBinaryVersion, runBinary } from '../helpers/shell.helper.js';
|
|
8
|
+
import { GenerateProtoService } from './generate-proto.service.js';
|
|
9
|
+
import { HbsGeneratorService } from './hbs-generator.service.js';
|
|
10
|
+
import { ProtocService } from './protoc.service.js';
|
|
11
|
+
import { SdkDescriptorService } from './sdk-descriptor.service.js';
|
|
12
|
+
const rustNativeTypes = { string: 'String', bool: 'bool', float: 'f32' };
|
|
13
|
+
const generatedDir = 'src/generated';
|
|
14
|
+
const defaultCrateVersion = '0.1.0';
|
|
15
|
+
const reservedMethodNames = [
|
|
16
|
+
'connect',
|
|
17
|
+
'new',
|
|
18
|
+
'with_origin',
|
|
19
|
+
'with_interceptor',
|
|
20
|
+
'send_compressed',
|
|
21
|
+
'accept_compressed',
|
|
22
|
+
'max_decoding_message_size',
|
|
23
|
+
'max_encoding_message_size',
|
|
24
|
+
'clone'
|
|
25
|
+
];
|
|
26
|
+
function rustTypeName(name) {
|
|
27
|
+
return toRustIdentifier(toUpperCamelCase(name));
|
|
28
|
+
}
|
|
29
|
+
export class RustSdkGeneratorService extends HbsGeneratorService {
|
|
30
|
+
config;
|
|
31
|
+
protocService;
|
|
32
|
+
static requiredTools = [PROTOC_TOOL, ...RUST_SDK_TOOLCHAIN.tools];
|
|
33
|
+
logger = new Logger(RustSdkGeneratorService.name);
|
|
34
|
+
outputDir;
|
|
35
|
+
constructor(config, protocService = new ProtocService()) {
|
|
36
|
+
super();
|
|
37
|
+
this.config = config;
|
|
38
|
+
this.protocService = protocService;
|
|
39
|
+
this.outputDir = path.resolve(process.cwd(), this.config.rust.output);
|
|
40
|
+
}
|
|
41
|
+
generate(descriptor) {
|
|
42
|
+
descriptor ??= new SdkDescriptorService().describe();
|
|
43
|
+
if (!descriptor.services.length) {
|
|
44
|
+
throw new Error('No gRPC microservice with a @GrpcAction method is registered; nothing to generate.');
|
|
45
|
+
}
|
|
46
|
+
this.protocService.assertTools(RustSdkGeneratorService.requiredTools);
|
|
47
|
+
this.writeOwnedPaths(this.renderFiles(descriptor));
|
|
48
|
+
this.format();
|
|
49
|
+
if (this.config.rust.build) {
|
|
50
|
+
this.build();
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
renderFiles(descriptor) {
|
|
54
|
+
return new Map([
|
|
55
|
+
[
|
|
56
|
+
'Cargo.toml',
|
|
57
|
+
this.compileTemplate('rust/cargo-toml.hbs', {
|
|
58
|
+
crateName: this.config.rust.crateName,
|
|
59
|
+
version: this.config.rust.version ?? defaultCrateVersion,
|
|
60
|
+
rustVersion: RUST_SDK_TOOLCHAIN.minRustVersion,
|
|
61
|
+
crates: RUST_SDK_TOOLCHAIN.crates
|
|
62
|
+
})
|
|
63
|
+
],
|
|
64
|
+
[
|
|
65
|
+
'src/client.rs',
|
|
66
|
+
this.compileTemplate('rust/client.hbs', {
|
|
67
|
+
services: descriptor.services.map((service) => this.buildServiceView(service))
|
|
68
|
+
})
|
|
69
|
+
],
|
|
70
|
+
['src/error.rs', this.compileTemplate('rust/error.hbs', {})],
|
|
71
|
+
[
|
|
72
|
+
'src/enums.rs',
|
|
73
|
+
this.compileTemplate('rust/enums.hbs', {
|
|
74
|
+
enums: descriptor.enums.map((item) => this.buildEnumView(item))
|
|
75
|
+
})
|
|
76
|
+
]
|
|
77
|
+
]);
|
|
78
|
+
}
|
|
79
|
+
writeOwnedPaths(files) {
|
|
80
|
+
stageOwnedPaths(this.outputDir, RUST_OWNED_PATHS, (stagingDir) => {
|
|
81
|
+
new GenerateProtoService(this.config.name, stagingDir).generate();
|
|
82
|
+
fs.ensureDirSync(path.join(stagingDir, generatedDir));
|
|
83
|
+
this.protocService.run(['--proto_path=.', `--prost_out=${generatedDir}`, `--tonic_out=${generatedDir}`, 'microservice.proto'], stagingDir);
|
|
84
|
+
files.set('src/lib.rs', this.compileTemplate('rust/lib.hbs', this.locateGeneratedFiles(stagingDir)));
|
|
85
|
+
for (const [file, content] of files) {
|
|
86
|
+
fs.outputFileSync(path.join(stagingDir, file), content);
|
|
87
|
+
}
|
|
88
|
+
});
|
|
89
|
+
}
|
|
90
|
+
locateGeneratedFiles(rootDir) {
|
|
91
|
+
const generatedPath = path.join(rootDir, generatedDir);
|
|
92
|
+
const files = fs.readdirSync(generatedPath).filter((file) => file.endsWith('.rs'));
|
|
93
|
+
const tonicFiles = files.filter((file) => file.endsWith('.tonic.rs'));
|
|
94
|
+
const protoFiles = files.filter((file) => !file.endsWith('.tonic.rs'));
|
|
95
|
+
if (protoFiles.length !== 1 || tonicFiles.length !== 1) {
|
|
96
|
+
throw new Error(`Expected one prost file and one tonic file in ${generatedDir}, found: ${files.join(', ') || 'none'}.`);
|
|
97
|
+
}
|
|
98
|
+
const [protoFile] = protoFiles;
|
|
99
|
+
const [tonicFile] = tonicFiles;
|
|
100
|
+
const protoContent = fs.readFileSync(path.join(generatedPath, protoFile), 'utf8');
|
|
101
|
+
return { protoFile, tonicFile, includeTonicFile: !protoContent.includes(tonicFile) };
|
|
102
|
+
}
|
|
103
|
+
buildServiceView(service) {
|
|
104
|
+
const typeName = toUpperCamelCase(service.name);
|
|
105
|
+
const description = service.description ? ` ${service.description}` : '';
|
|
106
|
+
return {
|
|
107
|
+
clientName: `${typeName}Client`,
|
|
108
|
+
moduleName: `${toSnakeCase(service.name)}_client`,
|
|
109
|
+
docLines: `Client of the ${service.name} service.${description}`.split('\n'),
|
|
110
|
+
methods: service.methods.map((method) => this.buildMethodView(service, method))
|
|
111
|
+
};
|
|
112
|
+
}
|
|
113
|
+
buildMethodView(service, method) {
|
|
114
|
+
const snakeName = toSnakeCase(method.name);
|
|
115
|
+
if (reservedMethodNames.includes(snakeName)) {
|
|
116
|
+
throw new Error(`Rust SDK: rpc "${service.name}.${method.name}" maps to the reserved method name "${snakeName}". Rename the rpc.`);
|
|
117
|
+
}
|
|
118
|
+
const docLines = (method.description || `Calls the ${method.name} rpc.`).split('\n');
|
|
119
|
+
if (method.metadataKeys.length) {
|
|
120
|
+
docLines.push(`Metadata read by the server: ${method.metadataKeys.join(', ')}.`);
|
|
121
|
+
}
|
|
122
|
+
return {
|
|
123
|
+
fnName: toRustIdentifier(snakeName),
|
|
124
|
+
docLines,
|
|
125
|
+
requestType: method.requestType ? `pb::${rustTypeName(method.requestType)}` : undefined,
|
|
126
|
+
requestArg: method.requestType ? 'request' : '()',
|
|
127
|
+
isStream: method.isStream,
|
|
128
|
+
returnType: this.returnType(method),
|
|
129
|
+
unwrapExpr: this.unwrapExpression(method)
|
|
130
|
+
};
|
|
131
|
+
}
|
|
132
|
+
returnType(method) {
|
|
133
|
+
switch (method.responseKind) {
|
|
134
|
+
case 'empty':
|
|
135
|
+
return '()';
|
|
136
|
+
case 'list':
|
|
137
|
+
return `Vec<pb::${rustTypeName(method.responseType)}>`;
|
|
138
|
+
case 'native':
|
|
139
|
+
return rustNativeTypes[method.responseType];
|
|
140
|
+
case 'nativeList':
|
|
141
|
+
return `Vec<${rustNativeTypes[method.responseType]}>`;
|
|
142
|
+
case 'nullable':
|
|
143
|
+
return `Option<pb::${rustTypeName(method.responseType)}>`;
|
|
144
|
+
case 'nullableNative':
|
|
145
|
+
return `Option<${rustNativeTypes[method.responseType]}>`;
|
|
146
|
+
default:
|
|
147
|
+
return `pb::${rustTypeName(method.responseType)}`;
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
unwrapExpression(method) {
|
|
151
|
+
switch (method.responseKind) {
|
|
152
|
+
case 'list':
|
|
153
|
+
case 'nativeList':
|
|
154
|
+
return 'response.items';
|
|
155
|
+
case 'native':
|
|
156
|
+
case 'nullable':
|
|
157
|
+
return 'response.value';
|
|
158
|
+
case 'nullableNative':
|
|
159
|
+
return 'response.value.map(|native| native.value)';
|
|
160
|
+
default:
|
|
161
|
+
return 'response';
|
|
162
|
+
}
|
|
163
|
+
}
|
|
164
|
+
buildEnumView(item) {
|
|
165
|
+
const isNumber = item.valueType === 'number';
|
|
166
|
+
return {
|
|
167
|
+
rustName: rustTypeName(item.name),
|
|
168
|
+
isNumber,
|
|
169
|
+
entries: item.entries.map((entry) => ({
|
|
170
|
+
variant: toRustIdentifier(enumMemberName(entry.key)),
|
|
171
|
+
literal: isNumber ? String(entry.value) : JSON.stringify(String(entry.value))
|
|
172
|
+
}))
|
|
173
|
+
};
|
|
174
|
+
}
|
|
175
|
+
format() {
|
|
176
|
+
if (!findBinary('cargo')) {
|
|
177
|
+
this.logger.warn('cargo is not on PATH; the generated Rust files are left unformatted.');
|
|
178
|
+
return;
|
|
179
|
+
}
|
|
180
|
+
try {
|
|
181
|
+
runBinary('cargo', ['fmt'], this.outputDir);
|
|
182
|
+
}
|
|
183
|
+
catch (error) {
|
|
184
|
+
const reason = error instanceof Error ? error.message : String(error);
|
|
185
|
+
this.logger.warn(`cargo fmt failed; the generated Rust files are left unformatted: ${reason}`);
|
|
186
|
+
}
|
|
187
|
+
}
|
|
188
|
+
build() {
|
|
189
|
+
if (!findBinary('cargo')) {
|
|
190
|
+
throw new Error('"rust.build" is true but cargo is not on PATH.');
|
|
191
|
+
}
|
|
192
|
+
const { minRustVersion } = RUST_SDK_TOOLCHAIN;
|
|
193
|
+
const version = readBinaryVersion('cargo');
|
|
194
|
+
if (version && !isVersionAtLeast(version, minRustVersion)) {
|
|
195
|
+
throw new Error(`"rust.build" needs Rust ${minRustVersion} or newer, found ${version}. Run "rustup update stable".`);
|
|
196
|
+
}
|
|
197
|
+
this.logger.log('Building the Rust SDK');
|
|
198
|
+
runBinary('cargo', ['check'], this.outputDir);
|
|
199
|
+
}
|
|
200
|
+
}
|
|
201
|
+
//# sourceMappingURL=rust-sdk-generator.service.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rust-sdk-generator.service.js","sourceRoot":"","sources":["../../../lib/services/rust-sdk-generator.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAsB,MAAM,qCAAqC,CAAC;AAC1G,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAClH,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AACpF,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAQxG,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,eAAe,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AACzE,MAAM,YAAY,GAAG,eAAe,CAAC;AACrC,MAAM,mBAAmB,GAAG,OAAO,CAAC;AAIpC,MAAM,mBAAmB,GAAG;IACxB,SAAS;IACT,KAAK;IACL,aAAa;IACb,kBAAkB;IAClB,iBAAiB;IACjB,mBAAmB;IACnB,2BAA2B;IAC3B,2BAA2B;IAC3B,OAAO;CACV,CAAC;AAGF,SAAS,YAAY,CAAC,IAAY;IAC9B,OAAO,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;AACpD,CAAC;AAED,MAAM,OAAO,uBAAwB,SAAQ,mBAAmB;IAOhD;IACA;IAPZ,MAAM,CAAU,aAAa,GAAyB,CAAC,WAAW,EAAE,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAEzF,MAAM,GAAG,IAAI,MAAM,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;IAClD,SAAS,CAAS;IAE1B,YACY,MAA0B,EAC1B,gBAA+B,IAAI,aAAa,EAAE;QAE1D,KAAK,EAAE,CAAC;QAHA,WAAM,GAAN,MAAM,CAAoB;QAC1B,kBAAa,GAAb,aAAa,CAAqC;QAG1D,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1E,CAAC;IAED,QAAQ,CAAC,UAA0B;QAC/B,UAAU,KAAK,IAAI,oBAAoB,EAAE,CAAC,QAAQ,EAAE,CAAC;QACrD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,oFAAoF,CAAC,CAAC;QAC1G,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAC;QACtE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC;QAEnD,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,KAAK,EAAE,CAAC;QACjB,CAAC;IACL,CAAC;IAEO,WAAW,CAAC,UAAyB;QACzC,OAAO,IAAI,GAAG,CAAC;YACX;gBACI,YAAY;gBACZ,IAAI,CAAC,eAAe,CAAC,qBAAqB,EAAE;oBACxC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS;oBACrC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,mBAAmB;oBACxD,WAAW,EAAE,kBAAkB,CAAC,cAAc;oBAC9C,MAAM,EAAE,kBAAkB,CAAC,MAAM;iBACpC,CAAC;aACL;YACD;gBACI,eAAe;gBACf,IAAI,CAAC,eAAe,CAAC,iBAAiB,EAAE;oBACpC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;iBACjF,CAAC;aACL;YACD,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;YAC5D;gBACI,cAAc;gBACd,IAAI,CAAC,eAAe,CAAC,gBAAgB,EAAE;oBACnC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;iBAClE,CAAC;aACL;SACJ,CAAC,CAAC;IACP,CAAC;IAEO,eAAe,CAAC,KAA0B;QAC9C,eAAe,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAgB,EAAE,CAAC,UAAU,EAAE,EAAE;YAC7D,IAAI,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,QAAQ,EAAE,CAAC;YAClE,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC;YACtD,IAAI,CAAC,aAAa,CAAC,GAAG,CAClB,CAAC,gBAAgB,EAAE,eAAe,YAAY,EAAE,EAAE,eAAe,YAAY,EAAE,EAAE,oBAAoB,CAAC,EACtG,UAAU,CACb,CAAC;YACF,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,eAAe,CAAC,cAAc,EAAE,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YACrG,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC;gBAClC,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5D,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAOO,oBAAoB,CAAC,OAAe;QACxC,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACvD,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QACnF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;QACtE,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;QAEvE,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,KAAK,CACX,iDAAiD,YAAY,YAAY,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,GAAG,CACzG,CAAC;QACN,CAAC;QAED,MAAM,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC;QAC/B,MAAM,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC;QAC/B,MAAM,YAAY,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,EAAE,MAAM,CAAC,CAAC;QAElF,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;IACzF,CAAC;IAEO,gBAAgB,CAAC,OAA6B;QAClD,MAAM,QAAQ,GAAG,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAEzE,OAAO;YAEH,UAAU,EAAE,GAAG,QAAQ,QAAQ;YAC/B,UAAU,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS;YACjD,QAAQ,EAAE,iBAAiB,OAAO,CAAC,IAAI,YAAY,WAAW,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;YAC5E,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;SAClF,CAAC;IACN,CAAC;IAEO,eAAe,CAAC,OAA6B,EAAE,MAA2B;QAC9E,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,mBAAmB,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CACX,kBAAkB,OAAO,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,uCAAuC,SAAS,oBAAoB,CACpH,CAAC;QACN,CAAC;QACD,MAAM,QAAQ,GAAG,CAAC,MAAM,CAAC,WAAW,IAAI,aAAa,MAAM,CAAC,IAAI,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACrF,IAAI,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YAC7B,QAAQ,CAAC,IAAI,CAAC,gCAAgC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrF,CAAC;QAED,OAAO;YAEH,MAAM,EAAE,gBAAgB,CAAC,SAAS,CAAC;YACnC,QAAQ;YACR,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,YAAY,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS;YACvF,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI;YACjD,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;YACnC,UAAU,EAAE,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;SAC5C,CAAC;IACN,CAAC;IAEO,UAAU,CAAC,MAA2B;QAC1C,QAAQ,MAAM,CAAC,YAAY,EAAE,CAAC;YAC1B,KAAK,OAAO;gBACR,OAAO,IAAI,CAAC;YAChB,KAAK,MAAM;gBACP,OAAO,WAAW,YAAY,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC;YAC3D,KAAK,QAAQ;gBACT,OAAO,eAAe,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;YAChD,KAAK,YAAY;gBACb,OAAO,OAAO,eAAe,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC;YAC1D,KAAK,UAAU;gBACX,OAAO,cAAc,YAAY,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC;YAC9D,KAAK,gBAAgB;gBACjB,OAAO,UAAU,eAAe,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC;YAC7D;gBACI,OAAO,OAAO,YAAY,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;QAC1D,CAAC;IACL,CAAC;IAEO,gBAAgB,CAAC,MAA2B;QAChD,QAAQ,MAAM,CAAC,YAAY,EAAE,CAAC;YAC1B,KAAK,MAAM,CAAC;YACZ,KAAK,YAAY;gBACb,OAAO,gBAAgB,CAAC;YAC5B,KAAK,QAAQ,CAAC;YACd,KAAK,UAAU;gBACX,OAAO,gBAAgB,CAAC;YAC5B,KAAK,gBAAgB;gBAEjB,OAAO,2CAA2C,CAAC;YACvD;gBACI,OAAO,UAAU,CAAC;QAC1B,CAAC;IACL,CAAC;IAEO,aAAa,CAAC,IAAuB;QACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC;QAE7C,OAAO;YACH,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;YACjC,QAAQ;YAER,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBAClC,OAAO,EAAE,gBAAgB,CAAC,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACpD,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;aAChF,CAAC,CAAC;SACN,CAAC;IACN,CAAC;IAEO,MAAM;QACV,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,sEAAsE,CAAC,CAAC;YACzF,OAAO;QACX,CAAC;QACD,IAAI,CAAC;YACD,SAAS,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAChD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,MAAM,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACtE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,oEAAoE,MAAM,EAAE,CAAC,CAAC;QACnG,CAAC;IACL,CAAC;IAEO,KAAK;QACT,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACtE,CAAC;QACD,MAAM,EAAE,cAAc,EAAE,GAAG,kBAAkB,CAAC;QAC9C,MAAM,OAAO,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,OAAO,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,cAAc,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,KAAK,CACX,2BAA2B,cAAc,oBAAoB,OAAO,+BAA+B,CACtG,CAAC;QACN,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;QACzC,SAAS,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAClD,CAAC"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { SdkDescriptor } from '../types/sdk-descriptor.type.js';
|
|
2
|
+
export declare class SdkDescriptorService {
|
|
3
|
+
private logger;
|
|
4
|
+
describe(): SdkDescriptor;
|
|
5
|
+
private describeService;
|
|
6
|
+
private describeMethod;
|
|
7
|
+
private describeResponse;
|
|
8
|
+
private describeEnums;
|
|
9
|
+
private findEnumSkipReason;
|
|
10
|
+
private findNameProblem;
|
|
11
|
+
private findDuplicate;
|
|
12
|
+
private describeEnumEntries;
|
|
13
|
+
}
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
import { RESPONSE_METADATA_KEY } from '@hodfords/nestjs-response';
|
|
2
|
+
import { Logger } from '@nestjs/common';
|
|
3
|
+
import { isFunction, isUndefined } from '@nestjs/common/utils/shared.utils.js';
|
|
4
|
+
import { isEmpty } from 'es-toolkit/compat';
|
|
5
|
+
import { GRPC_DESCRIPTION_METADATA_KEY, GRPC_METADATA_PARAMETERS_METADATA_KEY, GRPC_METHOD_METADATA_KEY, GRPC_PARAM_INDEX_METADATA_KEY, GRPC_STREAM_METADATA_KEY } from '../constants/metadata-key.const.js';
|
|
6
|
+
import { isEnumProperty } from '../helpers/api-property.helper.js';
|
|
7
|
+
import { extractProperties } from '../helpers/property.helper.js';
|
|
8
|
+
import { enumMemberName } from '../helpers/sdk-naming.helper.js';
|
|
9
|
+
import { isPrimitiveType } from '../helpers/type.helper.js';
|
|
10
|
+
import { resolveWireResponse } from '../helpers/wire-response.helper.js';
|
|
11
|
+
import { microserviceStorage } from '../storages/microservice.storage.js';
|
|
12
|
+
const nativeTypes = {
|
|
13
|
+
String: 'string',
|
|
14
|
+
Boolean: 'bool',
|
|
15
|
+
Number: 'float'
|
|
16
|
+
};
|
|
17
|
+
export class SdkDescriptorService {
|
|
18
|
+
logger = new Logger(SdkDescriptorService.name);
|
|
19
|
+
describe() {
|
|
20
|
+
return {
|
|
21
|
+
services: microserviceStorage
|
|
22
|
+
.map((constructor) => this.describeService(constructor))
|
|
23
|
+
.filter((service) => service.methods.length > 0),
|
|
24
|
+
enums: this.describeEnums()
|
|
25
|
+
};
|
|
26
|
+
}
|
|
27
|
+
describeService(constructor) {
|
|
28
|
+
const methods = Object.getOwnPropertyNames(constructor.prototype)
|
|
29
|
+
.filter((propertyKey) => Reflect.hasMetadata(GRPC_METHOD_METADATA_KEY, constructor.prototype, propertyKey))
|
|
30
|
+
.map((propertyKey) => this.describeMethod(constructor, propertyKey));
|
|
31
|
+
return {
|
|
32
|
+
name: constructor.name,
|
|
33
|
+
description: Reflect.getMetadata(GRPC_DESCRIPTION_METADATA_KEY, constructor),
|
|
34
|
+
methods
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
describeMethod(constructor, propertyKey) {
|
|
38
|
+
const prototype = constructor.prototype;
|
|
39
|
+
const params = Reflect.getMetadata('design:paramtypes', prototype, propertyKey);
|
|
40
|
+
const parameterIndex = Reflect.getMetadata(GRPC_PARAM_INDEX_METADATA_KEY, prototype, propertyKey);
|
|
41
|
+
const response = Reflect.getMetadata(RESPONSE_METADATA_KEY, prototype[propertyKey]);
|
|
42
|
+
const metadataParams = Reflect.getMetadata(GRPC_METADATA_PARAMETERS_METADATA_KEY, prototype, propertyKey) || [];
|
|
43
|
+
return {
|
|
44
|
+
name: propertyKey,
|
|
45
|
+
description: Reflect.getMetadata(GRPC_DESCRIPTION_METADATA_KEY, prototype, propertyKey),
|
|
46
|
+
requestType: isUndefined(parameterIndex) ? undefined : params[parameterIndex].name,
|
|
47
|
+
...this.describeResponse(response),
|
|
48
|
+
isStream: Boolean(Reflect.getMetadata(GRPC_STREAM_METADATA_KEY, prototype, propertyKey)),
|
|
49
|
+
metadataKeys: metadataParams.map((param) => param.name)
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
describeResponse(response) {
|
|
53
|
+
const { responseKind, wireResponseType } = resolveWireResponse(response);
|
|
54
|
+
const className = response?.responseClass.name;
|
|
55
|
+
return {
|
|
56
|
+
responseKind,
|
|
57
|
+
responseType: isPrimitiveType(response?.responseClass) ? nativeTypes[className] : className,
|
|
58
|
+
wireResponseType
|
|
59
|
+
};
|
|
60
|
+
}
|
|
61
|
+
describeEnums() {
|
|
62
|
+
const enums = new Map();
|
|
63
|
+
const properties = Object.values(extractProperties()).flat();
|
|
64
|
+
for (const { option } of properties) {
|
|
65
|
+
const isEnum = isEnumProperty(option) || (isFunction(option.enum) && !isEmpty(option.enumName));
|
|
66
|
+
if (!isEnum || enums.has(option.enumName)) {
|
|
67
|
+
continue;
|
|
68
|
+
}
|
|
69
|
+
const entries = this.describeEnumEntries(option.enum);
|
|
70
|
+
if (!entries.length) {
|
|
71
|
+
continue;
|
|
72
|
+
}
|
|
73
|
+
const isNumber = option.type === 'number' || entries.every((entry) => typeof entry.value === 'number');
|
|
74
|
+
const item = {
|
|
75
|
+
name: option.enumName,
|
|
76
|
+
valueType: isNumber ? 'number' : 'string',
|
|
77
|
+
entries
|
|
78
|
+
};
|
|
79
|
+
const skipReason = this.findEnumSkipReason(item, option.type === 'number');
|
|
80
|
+
if (skipReason) {
|
|
81
|
+
this.logger.warn(`Enum ${item.name} is skipped in the Rust and Go SDKs: ${skipReason}.`);
|
|
82
|
+
enums.set(option.enumName, undefined);
|
|
83
|
+
continue;
|
|
84
|
+
}
|
|
85
|
+
enums.set(option.enumName, item);
|
|
86
|
+
}
|
|
87
|
+
return Array.from(enums.values()).filter(Boolean);
|
|
88
|
+
}
|
|
89
|
+
findEnumSkipReason(item, isDeclaredNumber) {
|
|
90
|
+
const values = item.entries.map((entry) => entry.value);
|
|
91
|
+
if (isDeclaredNumber && values.some((value) => typeof value !== 'number')) {
|
|
92
|
+
return 'it is declared as a number but has non-numeric values';
|
|
93
|
+
}
|
|
94
|
+
if (item.valueType === 'string' && values.some((value) => typeof value !== 'string')) {
|
|
95
|
+
return 'it mixes string and number values';
|
|
96
|
+
}
|
|
97
|
+
if (item.valueType === 'number') {
|
|
98
|
+
const fraction = item.entries.find((entry) => !Number.isInteger(entry.value));
|
|
99
|
+
if (fraction) {
|
|
100
|
+
return `value ${fraction.value} of member "${fraction.key}" is not an integer`;
|
|
101
|
+
}
|
|
102
|
+
const outOfRange = item.entries.find((entry) => Number(entry.value) < -(2 ** 31) || Number(entry.value) >= 2 ** 31);
|
|
103
|
+
if (outOfRange) {
|
|
104
|
+
return `value ${outOfRange.value} of member "${outOfRange.key}" does not fit in an int32`;
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
return (this.findDuplicate(item, (entry) => String(entry.value), 'have the same value') ??
|
|
108
|
+
this.findNameProblem(item));
|
|
109
|
+
}
|
|
110
|
+
findNameProblem(item) {
|
|
111
|
+
const empty = item.entries.find((entry) => !enumMemberName(entry.key));
|
|
112
|
+
if (empty) {
|
|
113
|
+
return `member "${empty.key}" maps to an empty name`;
|
|
114
|
+
}
|
|
115
|
+
return this.findDuplicate(item, (entry) => enumMemberName(entry.key), 'map to the same name');
|
|
116
|
+
}
|
|
117
|
+
findDuplicate(item, keyOf, problem) {
|
|
118
|
+
const seen = new Map();
|
|
119
|
+
for (const entry of item.entries) {
|
|
120
|
+
const key = keyOf(entry);
|
|
121
|
+
if (seen.has(key)) {
|
|
122
|
+
return `members "${seen.get(key)}" and "${entry.key}" ${problem}`;
|
|
123
|
+
}
|
|
124
|
+
seen.set(key, entry.key);
|
|
125
|
+
}
|
|
126
|
+
return undefined;
|
|
127
|
+
}
|
|
128
|
+
describeEnumEntries(enumOption) {
|
|
129
|
+
const source = isFunction(enumOption) ? enumOption() : enumOption;
|
|
130
|
+
if (Array.isArray(source)) {
|
|
131
|
+
return Array.from(new Set(source)).map((value) => ({ key: String(value), value }));
|
|
132
|
+
}
|
|
133
|
+
if (!source || typeof source !== 'object') {
|
|
134
|
+
return [];
|
|
135
|
+
}
|
|
136
|
+
const record = source;
|
|
137
|
+
return Object.keys(record)
|
|
138
|
+
.filter((key) => isNaN(Number(key)))
|
|
139
|
+
.map((key) => ({ key, value: record[key] }));
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
//# sourceMappingURL=sdk-descriptor.service.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sdk-descriptor.service.js","sourceRoot":"","sources":["../../../lib/services/sdk-descriptor.service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,qBAAqB,EAAoB,MAAM,2BAA2B,CAAC;AACpF,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AAC/E,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EACH,6BAA6B,EAC7B,qCAAqC,EACrC,wBAAwB,EACxB,6BAA6B,EAC7B,wBAAwB,EAC3B,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAW1E,MAAM,WAAW,GAAkC;IAC/C,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,MAAM;IACf,MAAM,EAAE,OAAO;CAClB,CAAC;AASF,MAAM,OAAO,oBAAoB;IACrB,MAAM,GAAG,IAAI,MAAM,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IAEvD,QAAQ;QACJ,OAAO;YACH,QAAQ,EAAE,mBAAmB;iBACxB,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;iBACvD,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;YACpD,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE;SAC9B,CAAC;IACN,CAAC;IAEO,eAAe,CAAC,WAAqB;QACzC,MAAM,OAAO,GAAG,MAAM,CAAC,mBAAmB,CAAC,WAAW,CAAC,SAAS,CAAC;aAC5D,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,wBAAwB,EAAE,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;aAC1G,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;QAEzE,OAAO;YACH,IAAI,EAAE,WAAW,CAAC,IAAI;YACtB,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,6BAA6B,EAAE,WAAW,CAAC;YAC5E,OAAO;SACV,CAAC;IACN,CAAC;IAEO,cAAc,CAAC,WAAqB,EAAE,WAAmB;QAC7D,MAAM,SAAS,GAAG,WAAW,CAAC,SAAS,CAAC;QACxC,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,mBAAmB,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;QAChF,MAAM,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,6BAA6B,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;QAClG,MAAM,QAAQ,GAAqB,OAAO,CAAC,WAAW,CAAC,qBAAqB,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;QACtG,MAAM,cAAc,GAChB,OAAO,CAAC,WAAW,CAAC,qCAAqC,EAAE,SAAS,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC;QAE7F,OAAO;YACH,IAAI,EAAE,WAAW;YACjB,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,6BAA6B,EAAE,SAAS,EAAE,WAAW,CAAC;YACvF,WAAW,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,IAAI;YAClF,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC;YAClC,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,wBAAwB,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;YACxF,YAAY,EAAE,cAAc,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;SAC1D,CAAC;IACN,CAAC;IAEO,gBAAgB,CAAC,QAA0B;QAC/C,MAAM,EAAE,YAAY,EAAE,gBAAgB,EAAE,GAAG,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACzE,MAAM,SAAS,GAAG,QAAQ,EAAE,aAAa,CAAC,IAAI,CAAC;QAE/C,OAAO;YACH,YAAY;YACZ,YAAY,EAAE,eAAe,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;YAC3F,gBAAgB;SACnB,CAAC;IACN,CAAC;IAEO,aAAa;QACjB,MAAM,KAAK,GAAG,IAAI,GAAG,EAA6B,CAAC;QACnD,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAE7D,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,UAAU,EAAE,CAAC;YAElC,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;YAChG,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACxC,SAAS;YACb,CAAC;YAED,MAAM,OAAO,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACtD,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;gBAClB,SAAS;YACb,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC;YACvG,MAAM,IAAI,GAAsB;gBAC5B,IAAI,EAAE,MAAM,CAAC,QAAQ;gBACrB,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ;gBACzC,OAAO;aACV,CAAC;YACF,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;YAC3E,IAAI,UAAU,EAAE,CAAC;gBACb,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,wCAAwC,UAAU,GAAG,CAAC,CAAC;gBAEzF,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;gBACtC,SAAS;YACb,CAAC;YACD,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACrC,CAAC;QAED,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;IAMO,kBAAkB,CAAC,IAAuB,EAAE,gBAAyB;QACzE,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACxD,IAAI,gBAAgB,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,EAAE,CAAC;YACxE,OAAO,uDAAuD,CAAC;QACnE,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,EAAE,CAAC;YACnF,OAAO,mCAAmC,CAAC;QAC/C,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YAC9E,IAAI,QAAQ,EAAE,CAAC;gBACX,OAAO,SAAS,QAAQ,CAAC,KAAK,eAAe,QAAQ,CAAC,GAAG,qBAAqB,CAAC;YACnF,CAAC;YAED,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAChC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAChF,CAAC;YACF,IAAI,UAAU,EAAE,CAAC;gBACb,OAAO,SAAS,UAAU,CAAC,KAAK,eAAe,UAAU,CAAC,GAAG,4BAA4B,CAAC;YAC9F,CAAC;QACL,CAAC;QAED,OAAO,CACH,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,qBAAqB,CAAC;YAC/E,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAC7B,CAAC;IACN,CAAC;IAOO,eAAe,CAAC,IAAuB;QAC3C,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QACvE,IAAI,KAAK,EAAE,CAAC;YACR,OAAO,WAAW,KAAK,CAAC,GAAG,yBAAyB,CAAC;QACzD,CAAC;QACD,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,sBAAsB,CAAC,CAAC;IAClG,CAAC;IAEO,aAAa,CACjB,IAAuB,EACvB,KAA8D,EAC9D,OAAe;QAEf,MAAM,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;QACvC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAC/B,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;YACzB,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChB,OAAO,YAAY,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,KAAK,CAAC,GAAG,KAAK,OAAO,EAAE,CAAC;YACtE,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAGO,mBAAmB,CAAC,UAAmB;QAC3C,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;QAClE,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAkB,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QACxG,CAAC;QACD,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YACxC,OAAO,EAAE,CAAC;QACd,CAAC;QAED,MAAM,MAAM,GAAG,MAAyC,CAAC;QAEzD,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;aACrB,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;aACnC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IACrD,CAAC;CACJ"}
|
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
// Code generated by @hodfords/nestjs-grpc-helper. DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
package {{packageName}}
|
|
4
|
+
|
|
5
|
+
import (
|
|
6
|
+
"context"
|
|
7
|
+
"errors"
|
|
8
|
+
"io"
|
|
9
|
+
"strings"
|
|
10
|
+
"time"
|
|
11
|
+
|
|
12
|
+
"google.golang.org/grpc"
|
|
13
|
+
"google.golang.org/grpc/metadata"
|
|
14
|
+
"google.golang.org/protobuf/types/known/emptypb"
|
|
15
|
+
|
|
16
|
+
"{{{module}}}/pb"
|
|
17
|
+
)
|
|
18
|
+
|
|
19
|
+
var _ *emptypb.Empty
|
|
20
|
+
|
|
21
|
+
// Option configures a client or a single call.
|
|
22
|
+
type Option func(*config)
|
|
23
|
+
|
|
24
|
+
type config struct {
|
|
25
|
+
timeout time.Duration
|
|
26
|
+
md metadata.MD
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
// WithTimeout sets the deadline of unary calls. Passed to a constructor it is the default;
|
|
30
|
+
// passed to a call it overrides the default. Streams only use a timeout passed to the call.
|
|
31
|
+
func WithTimeout(timeout time.Duration) Option {
|
|
32
|
+
return func(c *config) {
|
|
33
|
+
c.timeout = timeout
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
// WithMetadata adds outgoing gRPC metadata. A later value for the same key replaces the earlier one,
|
|
38
|
+
// so metadata passed to a call overrides metadata passed to the constructor.
|
|
39
|
+
func WithMetadata(md metadata.MD) Option {
|
|
40
|
+
return func(c *config) {
|
|
41
|
+
merged := c.md.Copy()
|
|
42
|
+
for key, values := range md {
|
|
43
|
+
merged[strings.ToLower(key)] = append([]string(nil), values...)
|
|
44
|
+
}
|
|
45
|
+
c.md = merged
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
func newConfig(opts []Option) config {
|
|
50
|
+
var c config
|
|
51
|
+
for _, opt := range opts {
|
|
52
|
+
opt(&c)
|
|
53
|
+
}
|
|
54
|
+
return c
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
func (c config) with(opts []Option) config {
|
|
58
|
+
next := config{timeout: c.timeout, md: c.md.Copy()}
|
|
59
|
+
for _, opt := range opts {
|
|
60
|
+
opt(&next)
|
|
61
|
+
}
|
|
62
|
+
return next
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
func (c config) withoutTimeout() config {
|
|
66
|
+
return config{md: c.md.Copy()}
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
func prepare(ctx context.Context, cfg config) (context.Context, context.CancelFunc) {
|
|
70
|
+
if len(cfg.md) > 0 {
|
|
71
|
+
existing, _ := metadata.FromOutgoingContext(ctx)
|
|
72
|
+
merged := existing.Copy()
|
|
73
|
+
for key, values := range cfg.md {
|
|
74
|
+
merged[key] = append([]string(nil), values...)
|
|
75
|
+
}
|
|
76
|
+
ctx = metadata.NewOutgoingContext(ctx, merged)
|
|
77
|
+
}
|
|
78
|
+
if cfg.timeout > 0 {
|
|
79
|
+
return context.WithTimeout(ctx, cfg.timeout)
|
|
80
|
+
}
|
|
81
|
+
return context.WithCancel(ctx)
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
// Stream is a typed server stream. Recv returns io.EOF when the server has finished.
|
|
85
|
+
type Stream[T any] struct {
|
|
86
|
+
recv func() (T, error)
|
|
87
|
+
cancel context.CancelFunc
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
func (s *Stream[T]) Recv() (T, error) {
|
|
91
|
+
value, err := s.recv()
|
|
92
|
+
if err != nil {
|
|
93
|
+
s.cancel()
|
|
94
|
+
}
|
|
95
|
+
return value, err
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
// Close stops the stream before the server has finished.
|
|
99
|
+
func (s *Stream[T]) Close() {
|
|
100
|
+
s.cancel()
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
func wrapStreamError(err error) error {
|
|
104
|
+
if errors.Is(err, io.EOF) {
|
|
105
|
+
return io.EOF
|
|
106
|
+
}
|
|
107
|
+
return wrapError(err)
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
// optional returns nil when a nullable primitive response carries no value.
|
|
111
|
+
func optional[T any](present bool, value T) *T {
|
|
112
|
+
if !present {
|
|
113
|
+
return nil
|
|
114
|
+
}
|
|
115
|
+
return &value
|
|
116
|
+
}
|
|
117
|
+
{{#each services}}
|
|
118
|
+
|
|
119
|
+
{{#each docLines}}
|
|
120
|
+
// {{{this}}}
|
|
121
|
+
{{/each}}
|
|
122
|
+
type {{clientName}} struct {
|
|
123
|
+
client pb.{{clientName}}
|
|
124
|
+
defaults config
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
func New{{clientName}}(conn grpc.ClientConnInterface, opts ...Option) *{{clientName}} {
|
|
128
|
+
client := &{{clientName}}{client: pb.New{{clientName}}(conn), defaults: newConfig(opts)}
|
|
129
|
+
return client
|
|
130
|
+
}
|
|
131
|
+
{{#each methods}}
|
|
132
|
+
|
|
133
|
+
{{#each docLines}}
|
|
134
|
+
// {{{this}}}
|
|
135
|
+
{{/each}}
|
|
136
|
+
func (c *{{../clientName}}) {{goName}}(ctx context.Context{{#if requestType}}, req {{{requestType}}}{{/if}}, opts ...Option) {{{signatureReturn}}} {
|
|
137
|
+
{{#if isStream}}
|
|
138
|
+
ctx, cancel := prepare(ctx, c.defaults.withoutTimeout().with(opts))
|
|
139
|
+
stream, err := c.client.{{goName}}(ctx, {{{requestArg}}})
|
|
140
|
+
if err != nil {
|
|
141
|
+
cancel()
|
|
142
|
+
return nil, wrapError(err)
|
|
143
|
+
}
|
|
144
|
+
recv := func() ({{{returnType}}}, error) {
|
|
145
|
+
res, err := stream.Recv()
|
|
146
|
+
if err != nil {
|
|
147
|
+
var zero {{{returnType}}}
|
|
148
|
+
return zero, wrapStreamError(err)
|
|
149
|
+
}
|
|
150
|
+
return {{{unwrapExpr}}}, nil
|
|
151
|
+
}
|
|
152
|
+
return &Stream[{{{returnType}}}]{recv: recv, cancel: cancel}, nil
|
|
153
|
+
{{else}}
|
|
154
|
+
ctx, cancel := prepare(ctx, c.defaults.with(opts))
|
|
155
|
+
defer cancel()
|
|
156
|
+
{{#if isEmpty}}
|
|
157
|
+
if _, err := c.client.{{goName}}(ctx, {{{requestArg}}}); err != nil {
|
|
158
|
+
return wrapError(err)
|
|
159
|
+
}
|
|
160
|
+
return nil
|
|
161
|
+
{{else}}
|
|
162
|
+
res, err := c.client.{{goName}}(ctx, {{{requestArg}}})
|
|
163
|
+
if err != nil {
|
|
164
|
+
return {{{zeroValue}}}, wrapError(err)
|
|
165
|
+
}
|
|
166
|
+
return {{{unwrapExpr}}}, nil
|
|
167
|
+
{{/if}}
|
|
168
|
+
{{/if}}
|
|
169
|
+
}
|
|
170
|
+
{{/each}}
|
|
171
|
+
{{/each}}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
// Code generated by @hodfords/nestjs-grpc-helper. DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
package {{packageName}}
|
|
4
|
+
{{#each enums}}
|
|
5
|
+
|
|
6
|
+
// {{goName}} lists the values accepted for {{name}} fields. The field itself keeps its wire type.
|
|
7
|
+
type {{goName}} {{goType}}
|
|
8
|
+
|
|
9
|
+
const (
|
|
10
|
+
{{#each entries}}
|
|
11
|
+
{{constName}} {{../goName}} = {{{literal}}}
|
|
12
|
+
{{/each}}
|
|
13
|
+
)
|
|
14
|
+
{{/each}}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
// Code generated by @hodfords/nestjs-grpc-helper. DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
package {{packageName}}
|
|
4
|
+
|
|
5
|
+
import (
|
|
6
|
+
"encoding/json"
|
|
7
|
+
"fmt"
|
|
8
|
+
|
|
9
|
+
"google.golang.org/grpc/codes"
|
|
10
|
+
"google.golang.org/grpc/status"
|
|
11
|
+
)
|
|
12
|
+
|
|
13
|
+
// Error is a business error returned by the service. The server sends it as an ABORTED status
|
|
14
|
+
// whose message is the JSON object {"message", "code", "errors"}.
|
|
15
|
+
type Error struct {
|
|
16
|
+
Code int
|
|
17
|
+
Message string
|
|
18
|
+
Errors json.RawMessage
|
|
19
|
+
status *status.Status
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
func (e *Error) Error() string {
|
|
23
|
+
return fmt.Sprintf("service error %d: %s", e.Code, e.Message)
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
// GRPCStatus returns the original status, so status.FromError keeps working.
|
|
27
|
+
func (e *Error) GRPCStatus() *status.Status {
|
|
28
|
+
return e.status
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
type errorPayload struct {
|
|
32
|
+
Message json.RawMessage `json:"message"`
|
|
33
|
+
Code int `json:"code"`
|
|
34
|
+
Errors json.RawMessage `json:"errors"`
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
func wrapError(err error) error {
|
|
38
|
+
st, ok := status.FromError(err)
|
|
39
|
+
if !ok || st.Code() != codes.Aborted {
|
|
40
|
+
return err
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
var payload errorPayload
|
|
44
|
+
if json.Unmarshal([]byte(st.Message()), &payload) != nil {
|
|
45
|
+
return err
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
message := string(payload.Message)
|
|
49
|
+
var text string
|
|
50
|
+
if json.Unmarshal(payload.Message, &text) == nil {
|
|
51
|
+
message = text
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
return &Error{Code: payload.Code, Message: message, Errors: payload.Errors, status: st}
|
|
55
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Generated by @hodfords/nestjs-grpc-helper. Do not edit.
|
|
2
|
+
[package]
|
|
3
|
+
name = "{{crateName}}"
|
|
4
|
+
version = "{{version}}"
|
|
5
|
+
edition = "2021"
|
|
6
|
+
rust-version = "{{rustVersion}}"
|
|
7
|
+
|
|
8
|
+
[dependencies]
|
|
9
|
+
prost = "{{crates.prost}}"
|
|
10
|
+
tonic = "{{crates.tonic}}"
|
|
11
|
+
tokio-stream = "{{crates.tokioStream}}"
|
|
12
|
+
serde_json = "{{crates.serdeJson}}"
|
|
13
|
+
thiserror = "{{crates.thiserror}}"
|