Skip to content

Commit 08f8213

Browse files
AllanZhengYPAllanZhengYP
authored
feat: add event stream serde depedencies (#824)
feat: revive event stream dependencies feat: allow event signer provider in the config feat: rename util-eventstream-node to eventstream-serde-node feat: separate eventstream serde from util package feat: exprimental event stream signing dependencies feat: add eventstream-serde-browser chore: add doc for not supporting eventstream request on browser chore: add ignore files to eventstream dependencies chore: remove middleware-eventstream-signing from PR chore: remove eventstream-signer-node from PR chore(eventstream-serde-node): add unit tests feat: throw error/exception event and terminate event stream chore: fix docs fix: add eventstream-serde-config-resolver
1 parent 082567e commit 08f8213

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+1960
-6
lines changed

Diff for: ‎packages/eventstream-marshaller/src/EventStreamMarshaller.ts

+9-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
import { HeaderMarshaller } from "./HeaderMarshaller";
2-
import { Message, MessageHeaders, MessageHeaderValue } from "./Message";
32
import { splitMessage } from "./splitMessage";
3+
import { Message, MessageHeaders } from "@aws-sdk/types";
44
import { Crc32 } from "@aws-crypto/crc32";
55
import { Decoder, Encoder } from "@aws-sdk/types";
6-
import { toHex } from "@aws-sdk/util-hex-encoding";
76

87
/**
98
* A marshaller that can convert binary-packed event stream messages into
@@ -54,4 +53,12 @@ export class EventStreamMarshaller {
5453

5554
return { headers: this.headerMarshaller.parse(headers), body };
5655
}
56+
57+
/**
58+
* Convert a structured JavaScript object with tagged headers into a binary
59+
* event stream message header.
60+
*/
61+
formatHeaders(rawHeaders: MessageHeaders): Uint8Array {
62+
return this.headerMarshaller.format(rawHeaders);
63+
}
5764
}

Diff for: ‎packages/eventstream-marshaller/src/HeaderMarshaller.spec.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import { HeaderMarshaller } from "./HeaderMarshaller";
2-
import { MessageHeaders } from "./Message";
1+
import { MessageHeaders } from "@aws-sdk/types";
32
import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-universal";
3+
import { HeaderMarshaller } from "./HeaderMarshaller";
44
import { Int64 } from "./Int64";
55

66
describe("HeaderMarshaller", () => {

Diff for: ‎packages/eventstream-marshaller/src/HeaderMarshaller.ts

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1-
import { MessageHeaders, MessageHeaderValue } from "./Message";
2-
import { Decoder, Encoder } from "@aws-sdk/types";
1+
import {
2+
Decoder,
3+
Encoder,
4+
MessageHeaders,
5+
MessageHeaderValue
6+
} from "@aws-sdk/types";
37
import { fromHex, toHex } from "@aws-sdk/util-hex-encoding";
48
import { Int64 } from "./Int64";
59

Diff for: ‎packages/eventstream-marshaller/src/Int64.ts

+3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
import { toHex } from "@aws-sdk/util-hex-encoding";
2+
import { Int64 as IInt64 } from "@aws-sdk/types";
3+
4+
export interface Int64 extends IInt64 {}
25

36
/**
47
* A lossless representation of a signed, 64-bit integer. Instances of this

Diff for: ‎packages/eventstream-serde-browser/.gitignore

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
/node_modules/
2+
/build/
3+
/coverage/
4+
/docs/
5+
*.tsbuildinfo
6+
*.tgz
7+
*.log
8+
package-lock.json

Diff for: ‎packages/eventstream-serde-browser/.npmignore

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
/src/
2+
/coverage/
3+
/docs/
4+
tsconfig.test.json
5+
*.tsbuildinfo
6+
7+
*.spec.js
8+
*.spec.d.ts
9+
*.spec.js.map
10+
11+
*.fixture.js
12+
*.fixture.d.ts
13+
*.fixture.js.map

Diff for: ‎packages/eventstream-serde-browser/LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

Diff for: ‎packages/eventstream-serde-browser/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# @aws-sdk/@aws-sdk/eventstream-serde-browser
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/eventstream-serde-browser/alpha.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-browser)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/eventstream-serde-browser.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-browser)

Diff for: ‎packages/eventstream-serde-browser/package.json

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"name": "@aws-sdk/eventstream-serde-browser",
3+
"version": "1.0.0-alpha.0",
4+
"scripts": {
5+
"prepublishOnly": "tsc",
6+
"pretest": "tsc -p tsconfig.test.json",
7+
"test": "jest"
8+
},
9+
"main": "./build/index.js",
10+
"module": "./build/index.js",
11+
"types": "./build/index.d.ts",
12+
"author": {
13+
"name": "AWS SDK for JavaScript Team",
14+
"url": "https://aws.amazon.com/javascript/"
15+
},
16+
"license": "Apache-2.0",
17+
"dependencies": {
18+
"@aws-sdk/eventstream-marshaller": "^1.0.0-alpha.2",
19+
"@aws-sdk/types": "^1.0.0-alpha.2",
20+
"tslib": "^1.8.0"
21+
},
22+
"devDependencies": {
23+
"@types/jest": "^24.0.12",
24+
"typescript": "~3.4.0",
25+
"jest": "^24.7.1"
26+
},
27+
"engines": {
28+
"node": ">= 10.0.0"
29+
}
30+
}

Diff for: ‎packages/eventstream-serde-browser/src/EventStreamMarshaller.ts

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
import { EventStreamMarshaller as EventMarshaller } from "@aws-sdk/eventstream-marshaller";
2+
import {
3+
Encoder,
4+
Decoder,
5+
Message,
6+
EventStreamMarshaller as IEventStreamMarshaller
7+
} from "@aws-sdk/types";
8+
import { ReadableStreamtoIterable } from "./utils";
9+
import { getChunkedStream } from "./getChunkedStream";
10+
import { getEventMessageStream } from "./getEventMessageStream";
11+
import { getDeserializingStream } from "./getDeserializingStream";
12+
13+
export interface EventStreamMarshaller extends IEventStreamMarshaller {}
14+
15+
export interface EventStreamMarshallerOptions {
16+
utf8Encoder: Encoder;
17+
utf8Decoder: Decoder;
18+
}
19+
20+
export class EventStreamMarshaller {
21+
private readonly eventMarshaller: EventMarshaller;
22+
constructor({ utf8Encoder, utf8Decoder }: EventStreamMarshallerOptions) {
23+
this.eventMarshaller = new EventMarshaller(utf8Encoder, utf8Decoder);
24+
}
25+
26+
deserialize<T>(
27+
body: ReadableStream,
28+
deserializer: (input: { [event: string]: Message }) => T
29+
): AsyncIterable<T> {
30+
const chunkedStream = getChunkedStream(body);
31+
const messageStream = getEventMessageStream(
32+
chunkedStream,
33+
this.eventMarshaller
34+
);
35+
const deserialingStream = getDeserializingStream(
36+
messageStream,
37+
deserializer
38+
);
39+
return ReadableStreamtoIterable(deserialingStream);
40+
}
41+
42+
/**
43+
* Generate a ReadableStream that serialize events
44+
* to event stream binary chunks; Use a pull stream
45+
* here to support low connection speed.
46+
*
47+
* This doesn't work on browser currently because
48+
* browser doesn't support upload streaming.
49+
* reference:
50+
* * https://bugs.chromium.org/p/chromium/issues/detail?id=688906
51+
* * https://bugzilla.mozilla.org/show_bug.cgi?id=1387483
52+
*
53+
*/
54+
serialize<T>(
55+
input: AsyncIterable<T>,
56+
serializer: (event: T) => Message
57+
): ReadableStream {
58+
throw new Error(`event stream request in browser is not supported
59+
Reference: https://bugs.chromium.org/p/chromium/issues/detail?id=688906`);
60+
}
61+
}

0 commit comments

Comments
 (0)