Skip to content

[PoC] feat: add Endpoint Discovery #2339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 48 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
dca536c
feat(middleware-endpoint-discovery): add resolveEndpointDiscoveryClie…
trivikr May 3, 2021
ad96509
chore(client-timestream-query): call resolveEndpointDiscoveryClientCo…
trivikr May 3, 2021
e6d00db
feat(middleware-endpoint-discovery): add getEndpointDiscoveryCommandP…
trivikr May 3, 2021
72cb4d2
chore(client-timestream-query): call endpoint discovery from Query co…
trivikr May 3, 2021
3649ae9
fix: await getCacheKey
trivikr May 3, 2021
3bbcb55
fix: use set/get on LRUCache
trivikr May 3, 2021
b33c1ea
fix: use string as key for LRUCache
trivikr May 3, 2021
924f4fc
chore: move setting of discoveryCommandCtor to client config
trivikr May 3, 2021
08e2c61
chore: rename discoveryEndpointCommandCtor
trivikr May 3, 2021
6a6ef32
chore: store endpointDiscoveryId in an optional param instead of func…
trivikr May 3, 2021
468e7a7
fix: remove deprecated param from getEndpointDiscoveryCommandPlugin
trivikr May 3, 2021
f081547
fix: convert identifiers into Map<String,String>
trivikr May 3, 2021
21b8c6d
fix: wait for parallel endpoint discovery operation to complete
trivikr May 3, 2021
8c3d486
fix: rethrow error is client discovered endpoint is required
trivikr May 3, 2021
78d7db4
feat(endpoint-cache): add Endpoint Cache
trivikr May 6, 2021
c7b76d9
chore: remove direct dependency on lru-cache
trivikr May 6, 2021
869d914
chore: use EndpointCache instead of LRUCache
trivikr May 6, 2021
95b1fbe
chore: disable refresh for a min if error in optional cae
trivikr May 6, 2021
61733c9
chore: wip on handling errors
trivikr May 6, 2021
80d2989
chore: add configuration for endpoint discovery
trivikr May 7, 2021
24ec4b3
chore(clients): add endpointDiscoveryEnabled configuration
trivikr May 7, 2021
ac3aac9
chore: update middleware-endpoint-discovery based on isEndpointDiscov…
trivikr May 7, 2021
5d52e3a
chore: throw error if endpoint is suuplied and endpoint discovery is …
trivikr May 7, 2021
2997d3e
fix: use endpointDiscoveryEnabledProvider
trivikr May 7, 2021
ee708e4
chore: mark endpointDiscoveryEnabledProvider as internal configuration
trivikr May 7, 2021
fa71e9e
chore: throw descriptive error when endpoint discovery fails
trivikr May 8, 2021
8ba316a
chore(test): add tests for configurations
trivikr May 8, 2021
a49d14a
chore: remove region as cache is not shared across clients
trivikr May 8, 2021
1ee8ad7
chore: use commandName in cacheKey only if identifiers are defined
trivikr May 8, 2021
3db4484
chore: ts-ignore undefined check as if already checks it
trivikr May 8, 2021
e92efb6
chore: add test for getCacheKey
trivikr May 8, 2021
f9fcf07
chore: fix typo in configurations test file
trivikr May 8, 2021
1c2f369
test: add resolveEndpointDiscoveryClientConfig.spec.ts
trivikr May 9, 2021
2179fb7
test: add configSelector and defaultSelector tests
trivikr May 9, 2021
27b9f75
test: asrc/updateDiscoveredEndpointInCache.spec.ts
trivikr May 9, 2021
a1242da
test: src/getEndpointDiscoveryCommandPlugin.spec.ts
trivikr May 9, 2021
fe35899
chore: simplify configuration for getCacheKey
trivikr May 9, 2021
04e1741
chore: read endpointDiscoveryCommandCtor from EndpointDiscoveryClient…
trivikr May 9, 2021
6deeb48
fix: sort identifiers keys before stringifying
trivikr May 9, 2021
ac232ce
fix: check for endpoints in cache every second
trivikr May 9, 2021
0a2b5e5
chore: pass config from EndpointDiscoveryClientResolvedConfig to getC…
trivikr May 9, 2021
316b8b6
chore: use endpointCache from EndpointDiscoveryClientResolvedConfig
trivikr May 9, 2021
49ad573
fix: use object for identifiers
trivikr May 9, 2021
f26bec3
test: src/endpointDiscoveryMiddleware.spec.ts
trivikr May 9, 2021
983f110
chore: remove Client suffix from EndpointDiscovery
trivikr May 12, 2021
5004455
chore(client-timestream-query): remove Client suffix from EndpointDis…
trivikr May 12, 2021
0147d41
fix: call command.resolveMiddleware instead of client.send
trivikr May 13, 2021
9048c5e
fix(middleware-endpoint-discovery): call resolveMiddleware instead of…
trivikr May 13, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 22 additions & 3 deletions clients/client-timestream-query/TimestreamQueryClient.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { CancelQueryCommandInput, CancelQueryCommandOutput } from "./commands/CancelQueryCommand";
import { DescribeEndpointsCommandInput, DescribeEndpointsCommandOutput } from "./commands/DescribeEndpointsCommand";
import {
DescribeEndpointsCommand,
DescribeEndpointsCommandInput,
DescribeEndpointsCommandOutput,
} from "./commands/DescribeEndpointsCommand";
import { QueryCommandInput, QueryCommandOutput } from "./commands/QueryCommand";
import { ClientDefaultValues as __ClientDefaultValues } from "./runtimeConfig";
import {
Expand All @@ -17,6 +21,11 @@ import {
getHostHeaderPlugin,
resolveHostHeaderConfig,
} from "@aws-sdk/middleware-host-header";
import {
EndpointDiscoveryInputConfig,
EndpointDiscoveryResolvedConfig,
resolveEndpointDiscoveryConfig,
} from "@aws-sdk/middleware-endpoint-discovery";
import { getLoggerPlugin } from "@aws-sdk/middleware-logger";
import { RetryInputConfig, RetryResolvedConfig, getRetryPlugin, resolveRetryConfig } from "@aws-sdk/middleware-retry";
import {
Expand Down Expand Up @@ -150,11 +159,19 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
* @internal
*/
defaultUserAgentProvider?: Provider<__UserAgent>;

/**
* The provider which populates default for endpointDisvoveryEnabled configuration, if it's
* not passed during client creation.
* @internal
*/
endpointDiscoveryEnabledProvider?: Provider<boolean | undefined>;
}

type TimestreamQueryClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
ClientDefaults &
RegionInputConfig &
EndpointDiscoveryInputConfig &
EndpointsInputConfig &
RetryInputConfig &
HostHeaderInputConfig &
Expand All @@ -168,6 +185,7 @@ export interface TimestreamQueryClientConfig extends TimestreamQueryClientConfig
type TimestreamQueryClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
Required<ClientDefaults> &
RegionResolvedConfig &
EndpointDiscoveryResolvedConfig &
EndpointsResolvedConfig &
RetryResolvedConfig &
HostHeaderResolvedConfig &
Expand Down Expand Up @@ -205,8 +223,9 @@ export class TimestreamQueryClient extends __Client<
let _config_4 = resolveHostHeaderConfig(_config_3);
let _config_5 = resolveAwsAuthConfig(_config_4);
let _config_6 = resolveUserAgentConfig(_config_5);
super(_config_6);
this.config = _config_6;
let _config_7 = resolveEndpointDiscoveryConfig(_config_6, DescribeEndpointsCommand);
super(_config_7);
this.config = _config_7;
this.middlewareStack.use(getRetryPlugin(this.config));
this.middlewareStack.use(getContentLengthPlugin(this.config));
this.middlewareStack.use(getHostHeaderPlugin(this.config));
Expand Down
9 changes: 9 additions & 0 deletions clients/client-timestream-query/commands/QueryCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import {
MetadataBearer as __MetadataBearer,
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";
import { getEndpointDiscoveryCommandPlugin } from "@aws-sdk/middleware-endpoint-discovery";

export interface QueryCommandInput extends QueryRequest {}
export interface QueryCommandOutput extends QueryResponse, __MetadataBearer {}
Expand Down Expand Up @@ -54,7 +55,15 @@ export class QueryCommand extends $Command<QueryCommandInput, QueryCommandOutput
configuration: TimestreamQueryClientResolvedConfig,
options?: __HttpHandlerOptions
): Handler<QueryCommandInput, QueryCommandOutput> {
const isDiscoveredEndpointRequired = true;
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
this.middlewareStack.use(
getEndpointDiscoveryCommandPlugin(configuration, {
isDiscoveredEndpointRequired,
clientStack,
options,
})
);

const stack = clientStack.concat(this.middlewareStack);

Expand Down
1 change: 1 addition & 0 deletions clients/client-timestream-query/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
"@aws-sdk/hash-node": "3.13.1",
"@aws-sdk/invalid-dependency": "3.13.1",
"@aws-sdk/middleware-content-length": "3.13.1",
"@aws-sdk/middleware-endpoint-discovery": "3.0.0",
"@aws-sdk/middleware-host-header": "3.13.1",
"@aws-sdk/middleware-logger": "3.13.1",
"@aws-sdk/middleware-retry": "3.13.1",
Expand Down
1 change: 1 addition & 0 deletions clients/client-timestream-query/runtimeConfig.browser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ export const ClientDefaultValues: Required<ClientDefaults> = {
serviceId: ClientSharedValues.serviceId,
clientVersion: packageInfo.version,
}),
endpointDiscoveryEnabledProvider: () => Promise.resolve(undefined),
maxAttempts: DEFAULT_MAX_ATTEMPTS,
region: invalidProvider("Region is missing"),
requestHandler: new FetchHttpHandler(),
Expand Down
2 changes: 2 additions & 0 deletions clients/client-timestream-query/runtimeConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { decorateDefaultCredentialProvider } from "@aws-sdk/client-sts";
import { NODE_REGION_CONFIG_FILE_OPTIONS, NODE_REGION_CONFIG_OPTIONS } from "@aws-sdk/config-resolver";
import { defaultProvider as credentialDefaultProvider } from "@aws-sdk/credential-provider-node";
import { Hash } from "@aws-sdk/hash-node";
import { NODE_ENDPOINT_DISCOVERY_CONFIG_OPTIONS } from "@aws-sdk/middleware-endpoint-discovery";
import { NODE_MAX_ATTEMPT_CONFIG_OPTIONS } from "@aws-sdk/middleware-retry";
import { loadConfig as loadNodeConfig } from "@aws-sdk/node-config-provider";
import { NodeHttpHandler, streamCollector } from "@aws-sdk/node-http-handler";
Expand All @@ -28,6 +29,7 @@ export const ClientDefaultValues: Required<ClientDefaults> = {
serviceId: ClientSharedValues.serviceId,
clientVersion: packageInfo.version,
}),
endpointDiscoveryEnabledProvider: loadNodeConfig(NODE_ENDPOINT_DISCOVERY_CONFIG_OPTIONS),
maxAttempts: loadNodeConfig(NODE_MAX_ATTEMPT_CONFIG_OPTIONS),
region: loadNodeConfig(NODE_REGION_CONFIG_OPTIONS, NODE_REGION_CONFIG_FILE_OPTIONS),
requestHandler: new NodeHttpHandler(),
Expand Down
201 changes: 201 additions & 0 deletions packages/endpoint-cache/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
17 changes: 17 additions & 0 deletions packages/endpoint-cache/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# @aws-sdk/endpoint-cache

[![NPM version](https://img.shields.io/npm/v/@aws-sdk/endpoint-cache/latest.svg)](https://www.npmjs.com/package/@aws-sdk/endpoint-cache)
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/endpoint-cache.svg)](https://www.npmjs.com/package/@aws-sdk/endpoint-cache)

> An internal package

## Usage

You probably shouldn't, at least directly.

## EndpointCache

- uses `mnemonist/lru-cache` for storing the cache.
- the `set` operation stores milliseconds elapsed since the UNIX epoch in Expires param based on CachePeriodInMinutes provided in Endpoint.
- the `get` operation returns all un-expired endpoints with their Expires values.
- the `getEndpoint` operation returns a randomly selected un-expired endpoint.
5 changes: 5 additions & 0 deletions packages/endpoint-cache/jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
const base = require("../../jest.config.base.js");

module.exports = {
...base,
};
45 changes: 45 additions & 0 deletions packages/endpoint-cache/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
{
"name": "@aws-sdk/endpoint-cache",
"version": "3.0.0",
"scripts": {
"prepublishOnly": "yarn build && downlevel-dts dist/types dist/types/ts3.4",
"build:cjs": "tsc -p tsconfig.cjs.json",
"build:es": "tsc -p tsconfig.es.json",
"build": "yarn build:es && yarn build:cjs",
"test": "jest --passWithNoTests"
},
"author": {
"name": "AWS SDK for JavaScript Team",
"url": "https://aws.amazon.com/javascript/"
},
"license": "Apache-2.0",
"main": "./dist/cjs/index.js",
"module": "./dist/es/index.js",
"types": "./dist/types/index.d.ts",
"dependencies": {
"mnemonist": "0.38.3",
"tslib": "^2.0.0"
},
"devDependencies": {
"@types/jest": "^26.0.4",
"@types/node": "^10.0.0",
"jest": "^26.1.0",
"typescript": "~4.2.4"
},
"engines": {
"node": ">= 10.0.0"
},
"typesVersions": {
"<4.0": {
"types/*": [
"types/ts3.4/*"
]
}
},
"homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/packages/endpoint-cache",
"repository": {
"type": "git",
"url": "https://github.com/aws/aws-sdk-js-v3.git",
"directory": "packages/endpoint-cache"
}
}
Loading