Skip to content

Commit a3fdc01

Browse files
AllanZhengYPAllanZhengYP
committed
feat: add a user agent middleware to support custom useragent
1 parent 1f1cd82 commit a3fdc01

File tree

13 files changed

+366
-17
lines changed

13 files changed

+366
-17
lines changed

‎clients/node/client-rds-data-node/RDSDataClient.ts

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
import { contentLengthPlugin } from "@aws-sdk/middleware-content-length";
2-
import * as __aws_sdk_middleware_header_default from "@aws-sdk/middleware-header-default";
2+
import { UserAgentPlugin, UserAgentConfig } from "@aws-sdk/middleware-user-agent";
33
import { retryPlugin, RetryConfig } from "@aws-sdk/retry-middleware";
44
import { signingPlugin, AwsAuthConfiguration } from "@aws-sdk/signing-middleware";
5-
import * as __aws_sdk_util_user_agent_node from "@aws-sdk/util-user-agent-node";
65
import {
76
RDSDataConfiguration,
87
RDSDataResolvedConfiguration,
@@ -28,22 +27,14 @@ export class RDSDataClient extends SmithyClient<HttpOptions, InputTypesUnion, Ou
2827
let intermediaConfig_2 = AwsAuthConfiguration.resolve(intermediaConfig_1);
2928
let intermediaConfig_3 = EndpointsConfig.resolve(intermediaConfig_2);
3029
let intermediaConfig_4 = RetryConfig.resolve(intermediaConfig_3);
31-
this.config = intermediaConfig_4;
30+
let intermediaConfig_5 = UserAgentConfig.resolve(intermediaConfig_4);
31+
this.config = intermediaConfig_5;
3232
super.use(contentLengthPlugin(this.config));
3333
if (this.config.maxRetries > 0) {
34-
super.use(retryPlugin(this.config))
34+
super.use(retryPlugin(this.config));
3535
}
3636
super.use(signingPlugin(this.config));
37-
this.middlewareStack.add(
38-
__aws_sdk_middleware_header_default.headerDefault({
39-
"User-Agent": this.config.defaultUserAgent
40-
}),
41-
{
42-
step: "build",
43-
priority: 0,
44-
tags: { SET_USER_AGENT: true }
45-
}
46-
);
37+
super.use(UserAgentPlugin(this.config));
4738
}
4839

4940
destroy(): void {

‎clients/node/client-rds-data-node/RDSDataConfiguration.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import { fromUtf8, toUtf8 } from '@aws-sdk/util-utf8-node';
1010
import { fromBase64, toBase64 } from '@aws-sdk/util-base64-node';
1111
import { defaultUserAgent } from '@aws-sdk/util-user-agent-node';
1212
import { AwsAuthConfiguration, AwsAuthConfigurationInput } from '@aws-sdk/signing-middleware';
13+
import { UserAgentConfig, UserAgentConfigInput } from '@aws-sdk/middleware-user-agent';
1314
import { RetryConfig, RetryConfigInput } from '@aws-sdk/retry-middleware';
1415
import { name, version } from './package.json';
1516
import {
@@ -47,11 +48,13 @@ export type RDSDataConfiguration = AWSClientRuntimeConfiguration &
4748
RegionConfigurationInput &
4849
RetryConfigInput &
4950
EndpointsConfigInput &
50-
ProtocolConfigInput
51+
ProtocolConfigInput &
52+
UserAgentConfigInput
5153

5254
export type RDSDataResolvedConfiguration = AWSClientRuntimeResolvedConfiguration &
5355
AwsAuthConfiguration.Resolved &
5456
RegionConfiguration.Resolved &
5557
RetryConfig.Resolved &
5658
EndpointsConfig.Resolved &
57-
ProtocolConfig.Resolved
59+
ProtocolConfig.Resolved &
60+
UserAgentConfig.Resolved

‎clients/node/client-rds-data-node/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
"@aws-sdk/invalid-dependency": "^0.1.0-preview.1",
3939
"@aws-sdk/middleware-content-length": "^0.1.0-preview.5",
4040
"@aws-sdk/middleware-deserializer": "^0.1.0-preview.1",
41-
"@aws-sdk/middleware-header-default": "^0.1.0-preview.5",
41+
"@aws-sdk/middleware-user-agent": "^0.1.0-preview.1",
4242
"@aws-sdk/middleware-serializer": "^0.1.0-preview.5",
4343
"@aws-sdk/middleware-stack": "^0.1.0-preview.6",
4444
"@aws-sdk/node-http-handler": "^0.1.0-preview.6",

‎packages/middleware-user-agent/.gitignore

Lines changed: 8 additions & 0 deletions
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

‎packages/middleware-user-agent/.npmignore

Lines changed: 13 additions & 0 deletions
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

‎packages/middleware-user-agent/LICENSE

Lines changed: 201 additions & 0 deletions
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.

‎packages/middleware-user-agent/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# @aws-sdk/@aws-sdk/middleware-user-agent
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/middleware-user-agent/preview.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/middleware-user-agent)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/middleware-user-agent.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/middleware-user-agent)

‎packages/middleware-user-agent/package.json

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"name": "@aws-sdk/middleware-user-agent",
3+
"version": "0.1.0-preview.1",
4+
"scripts": {
5+
"prepublishOnly": "tsc",
6+
"pretest": "tsc -p tsconfig.test.json",
7+
"test": "jest"
8+
},
9+
"main": "./build/index.js",
10+
"types": "./build/index.d.ts",
11+
"author": {
12+
"name": "AWS SDK for JavaScript Team",
13+
"url": "https://aws.amazon.com/javascript/"
14+
},
15+
"license": "Apache-2.0",
16+
"dependencies": {
17+
"@aws-sdk/types": "^0.1.0-preview.5",
18+
"@aws-sdk/protocol-http": "^0.1.0-preview.1",
19+
"tslib": "^1.8.0"
20+
},
21+
"devDependencies": {
22+
"@types/jest": "^24.0.12",
23+
"typescript": "~3.4.0",
24+
"jest": "^24.7.1"
25+
}
26+
}

‎packages/middleware-user-agent/src/configurations.ts

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
export namespace UserAgentConfig {
2+
export interface Input {
3+
/**
4+
* The custom user agent header that would be appended to default one
5+
*/
6+
customUserAgent?: string;
7+
}
8+
export interface PreviouslyResolved {
9+
defaultUserAgent: string;
10+
}
11+
export interface Resolved {
12+
defaultUserAgent: string;
13+
customUserAgent?: string;
14+
}
15+
export function resolve<T>(
16+
input: T & PreviouslyResolved & Input
17+
): T & Resolved {
18+
return input;
19+
}
20+
}
21+
22+
export type UserAgentConfigInput = UserAgentConfig.Input;

‎packages/middleware-user-agent/src/index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
export * from "./configurations";
2+
export * from "./middleware";

0 commit comments

Comments
 (0)