Skip to content

Commit 7528d20

Browse files
kuhekuhe
committed
fix(core/protocols): decorate service exceptions with unmodeled fields
1 parent 99f5f06 commit 7528d20

13 files changed

+287
-97
lines changed

‎packages/core/src/submodules/protocols/ProtocolLib.ts‎

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { NormalizedSchema, TypeRegistry } from "@smithy/core/schema";
2+
import { decorateServiceException, ServiceException as SDKBaseServiceException } from "@smithy/smithy-client";
23
import type { HttpResponse as IHttpResponse, MetadataBearer, ResponseMetadata, StaticErrorSchema } from "@smithy/types";
34

45
/**
@@ -15,6 +16,8 @@ type ErrorMetadataBearer = MetadataBearer & {
1516
* @internal
1617
*/
1718
export class ProtocolLib {
19+
public constructor(private queryCompat = false) {}
20+
1821
/**
1922
* This is only for REST protocols.
2023
*
@@ -90,10 +93,32 @@ export class ProtocolLib {
9093
const baseExceptionSchema = synthetic.getBaseException();
9194
if (baseExceptionSchema) {
9295
const ErrorCtor = synthetic.getErrorCtor(baseExceptionSchema) ?? Error;
93-
throw Object.assign(new ErrorCtor({ name: errorName }), errorMetadata, dataObject);
96+
throw this.decorateServiceException(
97+
Object.assign(new ErrorCtor({ name: errorName }), errorMetadata),
98+
dataObject
99+
);
100+
}
101+
throw this.decorateServiceException(Object.assign(new Error(errorName), errorMetadata), dataObject);
102+
}
103+
}
104+
105+
/**
106+
* Assigns additions onto exception if not already present.
107+
*/
108+
public decorateServiceException<E extends SDKBaseServiceException>(
109+
exception: E,
110+
additions: Record<string, any> = {}
111+
): E {
112+
if (this.queryCompat) {
113+
const msg = (exception as any).Message ?? additions.Message;
114+
const error = decorateServiceException(exception, additions);
115+
if (msg) {
116+
(error as any).Message = msg;
117+
(error as any).message = msg;
94118
}
95-
throw Object.assign(new Error(errorName), errorMetadata, dataObject);
119+
return error;
96120
}
121+
return decorateServiceException(exception, additions);
97122
}
98123

99124
/**

‎packages/core/src/submodules/protocols/cbor/AwsSmithyRpcV2CborProtocol.spec.ts‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import { HttpResponse } from "@smithy/protocol-http";
44
import type { NumericSchema, StringSchema } from "@smithy/types";
55
import { describe, expect, test as it } from "vitest";
66

7+
import { context } from "../test-schema.spec";
78
import { AwsSmithyRpcV2CborProtocol } from "./AwsSmithyRpcV2CborProtocol";
89

910
describe(AwsSmithyRpcV2CborProtocol.name, () => {
@@ -91,4 +92,41 @@ describe(AwsSmithyRpcV2CborProtocol.name, () => {
9192
Code: "MyQueryError",
9293
});
9394
});
95+
96+
it("decorates service exceptions with unmodeled fields", async () => {
97+
const httpResponse = new HttpResponse({
98+
statusCode: 400,
99+
headers: {},
100+
body: cbor.serialize({
101+
UnmodeledField: "Oh no",
102+
}),
103+
});
104+
105+
const protocol = new AwsSmithyRpcV2CborProtocol({
106+
defaultNamespace: "",
107+
});
108+
109+
const output = await protocol
110+
.deserializeResponse(
111+
{
112+
namespace: "ns",
113+
name: "Empty",
114+
traits: 0,
115+
input: "unit" as const,
116+
output: [3, "ns", "EmptyOutput", 0, [], []],
117+
},
118+
context,
119+
httpResponse
120+
)
121+
.catch((e) => {
122+
return e;
123+
});
124+
125+
expect(output).toMatchObject({
126+
UnmodeledField: "Oh no",
127+
$metadata: {
128+
httpStatusCode: 400,
129+
},
130+
});
131+
});
94132
});

‎packages/core/src/submodules/protocols/cbor/AwsSmithyRpcV2CborProtocol.ts‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import { ProtocolLib } from "../ProtocolLib";
1919
*/
2020
export class AwsSmithyRpcV2CborProtocol extends SmithyRpcV2CborProtocol {
2121
private readonly awsQueryCompatible: boolean;
22-
private readonly mixin = new ProtocolLib();
22+
private readonly mixin: ProtocolLib;
2323

2424
public constructor({
2525
defaultNamespace,
@@ -30,6 +30,7 @@ export class AwsSmithyRpcV2CborProtocol extends SmithyRpcV2CborProtocol {
3030
}) {
3131
super({ defaultNamespace });
3232
this.awsQueryCompatible = !!awsQueryCompatible;
33+
this.mixin = new ProtocolLib(this.awsQueryCompatible);
3334
}
3435

3536
/**
@@ -84,14 +85,17 @@ export class AwsSmithyRpcV2CborProtocol extends SmithyRpcV2CborProtocol {
8485
this.mixin.queryCompatOutput(dataObject, output);
8586
}
8687

87-
throw Object.assign(
88-
exception,
89-
errorMetadata,
90-
{
91-
$fault: ns.getMergedTraits().error,
92-
message,
93-
},
94-
output
88+
throw this.mixin.decorateServiceException(
89+
Object.assign(
90+
exception,
91+
errorMetadata,
92+
{
93+
$fault: ns.getMergedTraits().error,
94+
message,
95+
},
96+
output
97+
),
98+
dataObject
9599
);
96100
}
97101
}

‎packages/core/src/submodules/protocols/json/AwsJson1_1Protocol.spec.ts‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,40 @@ describe(AwsJson1_1Protocol, () => {
8686
},
8787
});
8888
});
89+
90+
it("decorates service exceptions with unmodeled fields", async () => {
91+
const httpResponse = new HttpResponse({
92+
statusCode: 400,
93+
headers: {},
94+
body: Buffer.from(`{"UnmodeledField":"Oh no"}`),
95+
});
96+
97+
const protocol = new AwsJson1_1Protocol({
98+
defaultNamespace: "",
99+
serviceTarget: "JsonRpc11",
100+
});
101+
102+
const output = await protocol
103+
.deserializeResponse(
104+
{
105+
namespace: "ns",
106+
name: "Empty",
107+
traits: 0,
108+
input: "unit" as const,
109+
output: [3, "ns", "EmptyOutput", 0, [], []],
110+
},
111+
context,
112+
httpResponse
113+
)
114+
.catch((e) => {
115+
return e;
116+
});
117+
118+
expect(output).toMatchObject({
119+
UnmodeledField: "Oh no",
120+
$metadata: {
121+
httpStatusCode: 400,
122+
},
123+
});
124+
});
89125
});

‎packages/core/src/submodules/protocols/json/AwsJsonRpcProtocol.ts‎

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export abstract class AwsJsonRpcProtocol extends RpcProtocol {
2525
protected deserializer: ShapeDeserializer<string | Uint8Array>;
2626
protected serviceTarget: string;
2727
private readonly codec: JsonCodec;
28-
private readonly mixin = new ProtocolLib();
28+
private readonly mixin: ProtocolLib;
2929
private readonly awsQueryCompatible: boolean;
3030

3131
protected constructor({
@@ -51,6 +51,7 @@ export abstract class AwsJsonRpcProtocol extends RpcProtocol {
5151
this.serializer = this.codec.createSerializer();
5252
this.deserializer = this.codec.createDeserializer();
5353
this.awsQueryCompatible = !!awsQueryCompatible;
54+
this.mixin = new ProtocolLib(this.awsQueryCompatible);
5455
}
5556

5657
public async serializeRequest<Input extends object>(
@@ -84,6 +85,9 @@ export abstract class AwsJsonRpcProtocol extends RpcProtocol {
8485

8586
protected abstract getJsonRpcVersion(): "1.1" | "1.0";
8687

88+
/**
89+
* @override
90+
*/
8791
protected async handleError(
8892
operationSchema: OperationSchema,
8993
context: HandlerExecutionContext & SerdeFunctions,
@@ -120,14 +124,17 @@ export abstract class AwsJsonRpcProtocol extends RpcProtocol {
120124
this.mixin.queryCompatOutput(dataObject, output);
121125
}
122126

123-
throw Object.assign(
124-
exception,
125-
errorMetadata,
126-
{
127-
$fault: ns.getMergedTraits().error,
128-
message,
129-
},
130-
output
127+
throw this.mixin.decorateServiceException(
128+
Object.assign(
129+
exception,
130+
errorMetadata,
131+
{
132+
$fault: ns.getMergedTraits().error,
133+
message,
134+
},
135+
output
136+
),
137+
dataObject
131138
);
132139
}
133140
}

‎packages/core/src/submodules/protocols/json/AwsRestJsonProtocol.spec.ts‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -410,5 +410,40 @@ describe(AwsRestJsonProtocol.name, () => {
410410
payload: null,
411411
});
412412
});
413+
414+
it("decorates service exceptions with unmodeled fields", async () => {
415+
const httpResponse = new HttpResponse({
416+
statusCode: 400,
417+
headers: {},
418+
body: Buffer.from(`{"UnmodeledField":"Oh no"}`),
419+
});
420+
421+
const protocol = new AwsRestJsonProtocol({
422+
defaultNamespace: "",
423+
});
424+
425+
const output = await protocol
426+
.deserializeResponse(
427+
{
428+
namespace: "ns",
429+
name: "Empty",
430+
traits: 0,
431+
input: "unit" as const,
432+
output: [3, "ns", "EmptyOutput", 0, [], []],
433+
},
434+
context,
435+
httpResponse
436+
)
437+
.catch((e) => {
438+
return e;
439+
});
440+
441+
expect(output).toMatchObject({
442+
UnmodeledField: "Oh no",
443+
$metadata: {
444+
httpStatusCode: 400,
445+
},
446+
});
447+
});
413448
});
414449
});

‎packages/core/src/submodules/protocols/json/AwsRestJsonProtocol.ts‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -139,14 +139,17 @@ export class AwsRestJsonProtocol extends HttpBindingProtocol {
139139
output[name] = this.codec.createDeserializer().readObject(member, dataObject[target]);
140140
}
141141

142-
throw Object.assign(
143-
exception,
144-
errorMetadata,
145-
{
146-
$fault: ns.getMergedTraits().error,
147-
message,
148-
},
149-
output
142+
throw this.mixin.decorateServiceException(
143+
Object.assign(
144+
exception,
145+
errorMetadata,
146+
{
147+
$fault: ns.getMergedTraits().error,
148+
message,
149+
},
150+
output
151+
),
152+
dataObject
150153
);
151154
}
152155

‎packages/core/src/submodules/protocols/query/AwsQueryProtocol.spec.ts‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
import { HttpResponse } from "@smithy/protocol-http";
2+
import { describe, expect, test as it } from "vitest";
3+
4+
import { context } from "../test-schema.spec";
5+
import { AwsQueryProtocol } from "./AwsQueryProtocol";
6+
7+
describe(AwsQueryProtocol.name, () => {
8+
it("decorates service exceptions with unmodeled fields", async () => {
9+
const httpResponse = new HttpResponse({
10+
statusCode: 400,
11+
headers: {},
12+
body: Buffer.from(`<Exception><Error><UnmodeledField>Oh no</UnmodeledField></Error></Exception>`),
13+
});
14+
15+
const protocol = new AwsQueryProtocol({
16+
version: "",
17+
defaultNamespace: "",
18+
xmlNamespace: "ns",
19+
});
20+
21+
const output = await protocol
22+
.deserializeResponse(
23+
{
24+
namespace: "ns",
25+
name: "Empty",
26+
traits: 0,
27+
input: "unit" as const,
28+
output: [3, "ns", "EmptyOutput", 0, [], []],
29+
},
30+
context,
31+
httpResponse
32+
)
33+
.catch((e) => {
34+
return e;
35+
});
36+
37+
expect(output).toMatchObject({
38+
UnmodeledField: "Oh no",
39+
$metadata: {
40+
httpStatusCode: 400,
41+
},
42+
});
43+
});
44+
});

‎packages/core/src/submodules/protocols/query/AwsQueryProtocol.ts‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,9 @@ export class AwsQueryProtocol extends RpcProtocol {
135135
return true;
136136
}
137137

138+
/**
139+
* override
140+
*/
138141
protected async handleError(
139142
operationSchema: OperationSchema,
140143
context: HandlerExecutionContext & SerdeFunctions,
@@ -183,14 +186,17 @@ export class AwsQueryProtocol extends RpcProtocol {
183186
output[name] = this.deserializer.readSchema(member, value);
184187
}
185188

186-
throw Object.assign(
187-
exception,
188-
errorMetadata,
189-
{
190-
$fault: ns.getMergedTraits().error,
191-
message,
192-
},
193-
output
189+
throw this.mixin.decorateServiceException(
190+
Object.assign(
191+
exception,
192+
errorMetadata,
193+
{
194+
$fault: ns.getMergedTraits().error,
195+
message,
196+
},
197+
output
198+
),
199+
dataObject
194200
);
195201
}
196202

‎packages/core/src/submodules/protocols/test-schema.spec.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { collectBody } from "@smithy/core/protocols";
12
import type {
23
BigDecimalSchema,
34
BigIntegerSchema,
@@ -112,6 +113,7 @@ export const deleteObjects: StaticOperationSchema = [
112113
] satisfies StaticOperationSchema;
113114

114115
export const context = {
116+
streamCollector: collectBody,
115117
async endpoint() {
116118
return {
117119
hostname: "localhost",

0 commit comments

Comments
 (0)