Skip to content

Commit

Permalink
feat: decode grpc status objects and map them to protocol types
Browse files Browse the repository at this point in the history
Status object thrown by grpc commands contains metadata that needs to be serialized in order to map it to custom errors generated through proto files grpc/grpc-web#399
  • Loading branch information
giacomocusinato committed Sep 9, 2024
1 parent 1ec0a8c commit beabb80
Showing 1 changed file with 42 additions and 2 deletions.
44 changes: 42 additions & 2 deletions arduino-ide-extension/src/node/service-error.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,54 @@
import { Metadata, StatusObject } from '@grpc/grpc-js';
import { Status } from './cli-protocol/google/rpc/status_pb';
import { stringToUint8Array } from '../common/utils';
import { ProgrammerIsRequiredForUploadError } from './cli-protocol/cc/arduino/cli/commands/v1/upload_pb';

type ProtoError = typeof ProgrammerIsRequiredForUploadError;
const protoErrorsMap = new Map<string, ProtoError>([
[
'type.googleapis.com/cc.arduino.cli.commands.v1.ProgrammerIsRequiredForUploadError',
ProgrammerIsRequiredForUploadError,
],
// handle other cli defined errors here
]);

export type ServiceError = StatusObject & Error;
export namespace ServiceError {
export function isCancel(arg: unknown): arg is ServiceError & { code: 1 } {
return is(arg) && arg.code === 1; // https://grpc.github.io/grpc/core/md_doc_statuscodes.html
}

export function is(arg: unknown): arg is ServiceError {
return arg instanceof Error && isStatusObjet(arg);
return arg instanceof Error && isStatusObject(arg);
}
function isStatusObjet(arg: unknown): arg is StatusObject {

export function isInstanceOf(arg: unknown, type: unknown): boolean {
if (!isStatusObject(arg)) {
return false;
}

const bin = arg.metadata.get('grpc-status-details-bin')[0];

const uint8Array =
typeof bin === 'string'
? stringToUint8Array(bin)
: new Uint8Array(bin.buffer, bin.byteOffset, bin.byteLength);

const errors = Status.deserializeBinary(uint8Array)
.getDetailsList()
.map((details) => {
const typeUrl = details.getTypeUrl();
const ErrorType = protoErrorsMap.get(typeUrl);
return ErrorType?.deserializeBinary(details.getValue_asU8());
});

return !!errors.find((error) => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return error && error instanceof <any>type;
});
}

function isStatusObject(arg: unknown): arg is StatusObject {
if (typeof arg === 'object') {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const any = arg as any;
Expand Down

0 comments on commit beabb80

Please sign in to comment.