@middy/service-discovery 3.0.0-alpha.6 → 3.0.0-alpha.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +27 -17
  2. package/index.js +2 -65
  3. package/package.json +4 -4
package/README.md CHANGED
@@ -1,26 +1,36 @@
1
- # Middy serviceDiscovery middleware
2
-
3
- <div align="center">
4
- <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.png"/>
5
- </div>
6
-
7
1
  <div align="center">
2
+ <h1>Middy Service Discovery middleware</h1>
3
+ <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.svg"/>
8
4
  <p><strong>Service Discovery middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda</strong></p>
9
- </div>
10
-
11
- <div align="center">
12
5
  <p>
13
- <a href="http://badge.fury.io/js/%40middy%2Fsts">
14
- <img src="https://badge.fury.io/js/%40middy%2Fsts.svg" alt="npm version" style="max-width:100%;">
6
+ <a href="https://www.npmjs.com/package/@middy/service-discovery?activeTab=versions">
7
+ <img src="https://badge.fury.io/js/%40middy%2Fservice-discovery.svg" alt="npm version" style="max-width:100%;">
8
+ </a>
9
+ <a href="https://packagephobia.com/result?p=@middy/service-discovery">
10
+ <img src="https://packagephobia.com/badge?p=@middy/service-discovery" alt="npm install size" style="max-width:100%;">
11
+ </a>
12
+ <a href="https://github.com/middyjs/middy/actions">
13
+ <img src="https://github.com/middyjs/middy/workflows/Tests/badge.svg" alt="GitHub Actions test status badge" style="max-width:100%;">
14
+ </a>
15
+ <br/>
16
+ <a href="https://standardjs.com/">
17
+ <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style" style="max-width:100%;">
15
18
  </a>
16
19
  <a href="https://snyk.io/test/github/middyjs/middy">
17
20
  <img src="https://snyk.io/test/github/middyjs/middy/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/middyjs/middy" style="max-width:100%;">
18
21
  </a>
19
- <a href="https://standardjs.com/">
20
- <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style" style="max-width:100%;">
22
+ <a href="https://lgtm.com/projects/g/middyjs/middy/context:javascript">
23
+ <img src="https://img.shields.io/lgtm/grade/javascript/g/middyjs/middy.svg?logo=lgtm&logoWidth=18" alt="Language grade: JavaScript" style="max-width:100%;">
24
+ </a>
25
+ <a href="https://bestpractices.coreinfrastructure.org/projects/5280">
26
+ <img src="https://bestpractices.coreinfrastructure.org/projects/5280/badge" alt="Core Infrastructure Initiative (CII) Best Practices" style="max-width:100%;">
21
27
  </a>
28
+ <br/>
22
29
  <a href="https://gitter.im/middyjs/Lobby">
23
- <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter" style="max-width:100%;">
30
+ <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter" style="max-width:100%;">
31
+ </a>
32
+ <a href="https://stackoverflow.com/questions/tagged/middy?sort=Newest&uqlId=35052">
33
+ <img src="https://img.shields.io/badge/StackOverflow-[middy]-yellow" alt="Ask questions on StackOverflow" style="max-width:100%;">
24
34
  </a>
25
35
  </p>
26
36
  </div>
@@ -39,9 +49,9 @@ npm install --save @middy/service-discovery
39
49
  ## Options
40
50
 
41
51
  - `AwsClient` (object) (default `AWS.STS`): AWS.STS class constructor (e.g. that has been instrumented with AWS XRay). Must be from `aws-sdk` v2.
42
- - `awsClientOptions` (object) (optional): Options to pass to AWS.STS class constructor.
43
- - `awsClientAssumeRole` (string) (optional): Internal key where secrets are stored. See [@middy/sts](/packages/sts/README.md) on to set this.
44
- - `awsClientCapture` (function) (optional): Enable XRay by passing `captureAWSClient` from `aws-xray-sdk` in.
52
+ - `awsClientOptions` (object) (default `undefined`): Options to pass to AWS.STS class constructor.
53
+ - `awsClientAssumeRole` (string) (default `undefined`): Internal key where secrets are stored. See [@middy/sts](/packages/sts/README.md) on to set this.
54
+ - `awsClientCapture` (function) (default `undefined`): Enable XRay by passing `captureAWSClient` from `aws-xray-sdk` in.
45
55
  - `fetchData` (object) (required): Mapping of internal key name to API request parameters.
46
56
  - `disablePrefetch` (boolean) (default `false`): On cold start requests will trigger early if they can. Setting `awsClientAssumeRole` disables prefetch.
47
57
  - `cacheKey` (string) (default `sts`): Cache key for the fetched data responses. Must be unique across all middleware.
package/index.js CHANGED
@@ -1,66 +1,3 @@
1
- import { canPrefetch, createPrefetchClient, createClient, getCache, getInternal, processCache, modifyCache } from '@middy/util';
2
- import ServiceDiscovery from 'aws-sdk/clients/servicediscovery.js';
3
- const defaults = {
4
- AwsClient: ServiceDiscovery,
5
- awsClientOptions: {},
6
- awsClientAssumeRole: undefined,
7
- awsClientCapture: undefined,
8
- fetchData: {},
9
- disablePrefetch: false,
10
- cacheKey: 'cloud-map',
11
- cacheExpiry: -1,
12
- setToContext: false
13
- };
1
+ import{canPrefetch,createPrefetchClient,createClient,getCache,getInternal,processCache,modifyCache}from'@middy/util';import ServiceDiscovery from'aws-sdk/clients/servicediscovery.js';const defaults={AwsClient:ServiceDiscovery,awsClientOptions:{},awsClientAssumeRole:undefined,awsClientCapture:undefined,fetchData:{},disablePrefetch:false,cacheKey:'cloud-map',cacheExpiry:-1,setToContext:false};const serviceDiscoveryMiddleware=(opts={})=>{const options={...defaults,...opts};const fetch=(request,cachedValues={})=>{const values={};for(const internalKey of Object.keys(options.fetchData)){if(cachedValues[internalKey])continue;values[internalKey]=client.discoverInstances(options.fetchData[internalKey]).promise().then(resp=>resp.Instances).catch(e=>{const value=getCache(options.cacheKey).value??{};value[internalKey]=undefined;modifyCache(options.cacheKey,value);throw e})}return values};let prefetch,client;if(canPrefetch(options)){client=createPrefetchClient(options);prefetch=processCache(options,fetch)}const serviceDiscoveryMiddlewareBefore=async request=>{if(!client){client=await createClient(options,request)}const{value}=prefetch??processCache(options,fetch,request);Object.assign(request.internal,value);if(options.setToContext){const data=await getInternal(Object.keys(options.fetchData),request);if(options.setToContext)Object.assign(request.context,data)}prefetch=null};return{before:serviceDiscoveryMiddlewareBefore}};export default serviceDiscoveryMiddleware
14
2
 
15
- const serviceDiscoveryMiddleware = (opts = {}) => {
16
- const options = { ...defaults,
17
- ...opts
18
- };
19
-
20
- const fetch = (request, cachedValues = {}) => {
21
- const values = {};
22
-
23
- for (const internalKey of Object.keys(options.fetchData)) {
24
- if (cachedValues[internalKey]) continue;
25
- values[internalKey] = client.discoverInstances(options.fetchData[internalKey]).promise().then(resp => resp.Instances).catch(e => {
26
- const value = getCache(options.cacheKey).value ?? {};
27
- value[internalKey] = undefined;
28
- modifyCache(options.cacheKey, value);
29
- throw e;
30
- });
31
- }
32
-
33
- return values;
34
- };
35
-
36
- let prefetch, client;
37
-
38
- if (canPrefetch(options)) {
39
- client = createPrefetchClient(options);
40
- prefetch = processCache(options, fetch);
41
- }
42
-
43
- const serviceDiscoveryMiddlewareBefore = async request => {
44
- if (!client) {
45
- client = await createClient(options, request);
46
- }
47
-
48
- const {
49
- value
50
- } = prefetch ?? processCache(options, fetch, request);
51
- Object.assign(request.internal, value);
52
-
53
- if (options.setToContext) {
54
- const data = await getInternal(Object.keys(options.fetchData), request);
55
- if (options.setToContext) Object.assign(request.context, data);
56
- }
57
-
58
- prefetch = null;
59
- };
60
-
61
- return {
62
- before: serviceDiscoveryMiddlewareBefore
63
- };
64
- };
65
-
66
- export default serviceDiscoveryMiddleware;
3
+ //# sourceMappingURL=index.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@middy/service-discovery",
3
- "version": "3.0.0-alpha.6",
3
+ "version": "3.0.0-alpha.7",
4
4
  "description": "Service Discovery (Cloud Map) instances middleware for the middy framework",
5
5
  "type": "module",
6
6
  "engines": {
@@ -47,12 +47,12 @@
47
47
  },
48
48
  "homepage": "https://github.com/middyjs/middy#readme",
49
49
  "dependencies": {
50
- "@middy/util": "^3.0.0-alpha.6"
50
+ "@middy/util": "^3.0.0-alpha.7"
51
51
  },
52
52
  "devDependencies": {
53
- "@middy/core": "^3.0.0-alpha.6",
53
+ "@middy/core": "^3.0.0-alpha.7",
54
54
  "aws-sdk": "^2.939.0",
55
55
  "aws-xray-sdk": "^3.3.3"
56
56
  },
57
- "gitHead": "176660ed3e0716d6bfb635c77251b301e0e24720"
57
+ "gitHead": "5cef39ebe49c201f97d71bb0680004de4b82cb91"
58
58
  }