UNPKG

serverless-dynamodb-autoscaling

Version:
684 lines (683 loc) 23.8 kB
<!doctype html> <html lang="en"> <head> <title>Code coverage report for src/plugin.ts</title> <meta charset="utf-8" /> <link rel="stylesheet" href="../prettify.css" /> <link rel="stylesheet" href="../base.css" /> <meta name="viewport" content="width=device-width, initial-scale=1"> <style type='text/css'> .coverage-summary .sorter { background-image: url(../sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1> <a href="../index.html">All files</a> / <a href="index.html">src</a> plugin.ts </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> <span class="strong">25.86% </span> <span class="quiet">Statements</span> <span class='fraction'>15/58</span> </div> <div class='fl pad1y space-right2'> <span class="strong">60% </span> <span class="quiet">Branches</span> <span class='fraction'>24/40</span> </div> <div class='fl pad1y space-right2'> <span class="strong">12.5% </span> <span class="quiet">Functions</span> <span class='fraction'>3/24</span> </div> <div class='fl pad1y space-right2'> <span class="strong">31.91% </span> <span class="quiet">Lines</span> <span class='fraction'>15/47</span> </div> </div> </div> <div class='status-line low'></div> <pre><table class="coverage"> <tr><td class="line-count quiet">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207</td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">5x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">4x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import * as assert from 'assert' import * as _ from 'lodash' import * as util from 'util' &nbsp; import Policy from './aws/policy' import Role from './aws/role' import Target from './aws/target' &nbsp; const text = { CLI_DONE: 'Added DynamoDB Auto Scaling to CloudFormation!', CLI_RESOURCE: ' - Building configuration for resource "table/%s%s"', CLI_SKIP: 'Skipping DynamoDB Auto Scaling: %s!', CLI_START: 'Configure DynamoDB Auto Scaling …', INVALID_CONFIGURATION: 'Invalid serverless configuration', NO_AUTOSCALING_CONFIG: 'Not Auto Scaling configuration found', ONLY_AWS_SUPPORT: 'Only supported for AWS provicer' } &nbsp; interface Defaults { read: CapacityConfiguration, write: CapacityConfiguration } &nbsp; class AWSDBAutoScaling { public hooks: {} &nbsp; /** * Constructur */ constructor (private serverless: Serverless) { <span class="fstat-no" title="function not covered" > th</span>is.hooks = { 'p<span class="cstat-no" title="statement not covered" >ackage:compileEvents': this.beforeDeployResources.bind</span>(this) } } &nbsp; /** *<span class="fstat-no" title="function not covered" > G</span>et the current stage name */<span class="cstat-no" title="statement not covered" ></span> private getStage(): string { return this.serverless.getProvider('aws').getStage() } &nbsp; /*<span class="fstat-no" title="function not covered" >*</span> * Get<span class="cstat-no" title="statement not covered" > the current service name</span> */ private getServiceName(): string { return this.serverless.service.getServiceName() } <span class="fstat-no" title="function not covered" ></span> /**<span class="cstat-no" title="statement not covered" ></span> * Get<span class="cstat-no" title="statement not covered" > the current service region</span> */<span class="cstat-no" title="statement not covered" ></span> privat<span class="cstat-no" title="statement not covered" >e getRegion(): string {</span> retu<span class="cstat-no" title="statement not covered" >rn this.serverless.getProvider('aws').getRegion()</span> }<span class="cstat-no" title="statement not covered" ></span> <span class="cstat-no" title="statement not covered" ></span> /** * Validate the request and check if configuration is available */ private validate(): void { assert(this.serverless, text.INVALID_CONFIGURATION) assert(this.serverless.service, text.INVALID_CONFIGURATION) assert(this.serverless.service.provider, text.INVALID_CONFIGURATION) assert(this.serverless.service.provider.name, text.INVALID_CONFIGURATION)<span class="branch-1 cbranch-no" title="branch not covered" ></span> assert(this.serverless.service.provider.name === 'aws', te<span class="branch-0 cbranch-no" title="branch not covered" >xt.ONLY_AWS_SUPPORT)</span> <span class="branch-1 cbranch-no" title="branch not covered" ></span> assert(this.serverless.service.custom, text.NO_AUTOSCALING_CONFIG) assert(this.serverless.service.custom.capacities, text.NO_AUTOSCALING_CONFIG) }<span class="branch-0 cbranch-no" title="branch not covered" ></span> <span class="branch-1 cbranch-no" title="branch not covered" ></span> /**<span class="branch-0 cbranch-no" title="branch not covered" ></span> * Parse configuration and fill up with default values when needed */ private defaults(config: Capacity): Defaults { return { read: { maximum: config.read &amp;&amp; config.read.maximum ? config.read.maximum : 200, <span class="fstat-no" title="function not covered" ></span> minimum: config.read &amp;&amp; config.read.minimum ? config.read.minimum : 5, usage: config<span class="cstat-no" title="statement not covered" >.read &amp;&amp; config.read.u</span>sage ? config.read.usage : 0.75 },<span class="cstat-no" title="statement not covered" ></span> write: { maximum: config.write &amp;&amp; config.write.maximum ? config.write.maximum : 200, minimum: config.write &amp;&amp; config.write.minimum ? config.write.minimum : 5, usage: config.write &amp;&amp; config.write.usage ? config.write.usage : 0.75 } } } <span class="cstat-no" title="statement not covered" ></span> /** * Create CloudFormation<span class="cstat-no" title="statement not covered" > resources for table (and optional index)</span> */ private resources(table: string, index: string, config: Capacity): any[] { const data = this.defaults(config) <span class="cstat-no" title="statement not covered" ></span> const op<span class="cstat-no" title="statement not covered" >tions: Options = {</span> index, region: this.getRegion(), se<span class="cstat-no" title="statement not covered" >rvice: this.getServiceName(),</span> stage:<span class="cstat-no" title="statement not covered" > this.getStage(),</span> table }<span class="cstat-no" title="statement not covered" ></span> &nbsp; // Start processing configuration this.serverless.cli.log( util.format(text.CLI_RESOURCE, table, (index ? ('/index/' + index) : '')) <span class="fstat-no" title="function not covered" > )</span> <span class="cstat-no" title="statement not covered" ></span> // Add role to manage Auto Scaling policies const resources: any[] = [ new Role(options) ] &nbsp; // Only add Auto Scaling for read capacity if configuration set is available if (!!config.read) { <span class="fstat-no" title="function not covered" ></span> resources.push(...this.getPolicyAndTarget(options, data.read, true)) }<span class="cstat-no" title="statement not covered" ></span> <span class="cstat-no" title="statement not covered" ></span> // Only add Auto Sca<span class="cstat-no" title="statement not covered" >ling for write capacity if co</span>nfiguration set is available if (<span class="cstat-no" title="statement not covered" >!!config.write) {</span> resour<span class="cstat-no" title="statement not covered" >ces.push(...this.getP</span>olicyAndTarget(options, data.write, false)) } <span class="cstat-no" title="statement not covered" ><span class="fstat-no" title="function not covered" ></span></span> return resources<span class="cstat-no" title="statement not covered" ><span class="cstat-no" title="statement not covered" ><span class="fstat-no" title="function not covered" ></span></span></span> }<span class="cstat-no" title="statement not covered" ></span> <span class="cstat-no" title="statement not covered" ><span class="cstat-no" title="statement not covered" ><span class="fstat-no" title="function not covered" ></span></span></span> /** * Cre<span class="cstat-no" title="statement not covered" >ate Policy and Tar</span>get resource */ private getPolicyAndTarget(options: Options, data: CapacityConfiguration, read: boolean): any[] { return [ new Policy(options, read, data.usage * 100, 60, 60), new Target(options, read, data.minimum, data.maximum) ] } &nbsp; /** * Generate CloudFormation resources for DynamoDB table and indexes */ private generate(table: string, config: Capacity) { let resources: any[] = [] <span class="fstat-no" title="function not covered" > le</span>t lastRessources: any[] = [] <span class="cstat-no" title="statement not covered" ><span class="cstat-no" title="statement not covered" ><span class="cstat-no" title="statement not covered" ><span class="cstat-no" title="statement not covered" ><span class="cstat-no" title="statement not covered" ><span class="fstat-no" title="function not covered" ><span class="fstat-no" title="function not covered" ><span class="fstat-no" title="function not covered" ><span class="fstat-no" title="function not covered" ></span></span></span></span></span></span></span></span></span> const indexes = this.normalize(config.index) <span class="fstat-no" title="function not covered" > if</span> (!config.indexOnly) { in<span class="cstat-no" title="statement not covered" >dexes.unshift('') // Horrible <span class="fstat-no" title="function not covered" >so</span>luti<span class="cstat-no" title="statement not covered" >on<span class="cstat-no" title="statement not covered" ><span class="cstat-no" title="statement not covered" ><span class="cstat-no" title="statement not covered" ><span class="cstat-no" title="statement not covered" ><span class="fstat-no" title="function not covered" ><span class="fstat-no" title="function not covered" ><span class="fstat-no" title="function not covered" ><span class="fstat-no" title="function not covered" ></span></span></span></span></span></span></span></span></span></span> } &nbsp; indexes.forEach( (index: string) =&gt; { const current = this.resources(table, index, config).map( (resource: any) =&gt; resource.setDependencies(lastRessources).toJSON() ) &nbsp; resources = resources.concat(current) lastRessources = current.map((item: any) =&gt; Object.keys(item).pop()) } ) &nbsp; return resources } &nbsp; /** * Check if parameter is defined and return as array if only a string is provided */ private normalize(data: string|string[]): string[] { if (data &amp;&amp; data.constructor !== Array) { return [ data as string ] } &nbsp; return (data as string[] || []).slice(0) } &nbsp; /** * Process the provided configuration */ private process() { this.serverless.service.custom.capacities.filter( (config: Capacity) =&gt; !!config.read || !!config.write ).forEach( (config: Capacity) =&gt; this.normalize(config.table).forEach( (table: string) =&gt; this.generate(table, config).forEach( (resource: string) =&gt; _.merge( this.serverless.service.provider.compiledCloudFormationTemplate.Resources, resource ) ) ) ) } &nbsp; private beforeDeployResources(): Promise&lt;any&gt; { return Promise.resolve().then( () =&gt; this.validate() ).then( () =&gt; this.serverless.cli.log(util.format(text.CLI_START)) ).then( () =&gt; this.process() ).then( () =&gt; this.serverless.cli.log(util.format(text.CLI_DONE)) ).catch( (err: Error) =&gt; this.serverless.cli.log(util.format(text.CLI_SKIP, err.message)) ) } } &nbsp; module.exports = AWSDBAutoScaling &nbsp;</pre></td></tr> </table></pre> <div class='push'></div><!-- for sticky footer --> </div><!-- /wrapper --> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sun Sep 24 2017 20:09:28 GMT+0000 (UTC) </div> </div> <script src="../prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="../sorter.js"></script> </body> </html>