Add resource count and warning to info display #4822

alexdebrie · 2018-03-11T01:38:02Z

What did you implement:

This PR does two things:

When displaying Stack Info, it includes a resources: indication that shows the number of resources in the CloudFormation stack:

If there are 150+ resources in a service, it displays a warning that the user is approaching the 200 resource limit for CloudFormation and links them to a blog post on how to avoid it:

Hat tip to @Vadorequest for this idea initially. I thought it was a great idea. 💥 .

I'll update the tests as needed but want to make sure we're good on the visuals first. Once those are settled, I'll make sure the tests pass.

How did you implement it:

As part of the aws:info:gatherData hook, I make a listStackResources API call for the CloudFormation stack and add it to the gatheredData object. Then I print it out in the displayServiceInfo() method.

How can we verify it:

Run sls info in a deployed service. It should show resources: in the info. Similarly, it should show in the Service Information block after a deploy.
If you want to test the warning, set up a service with 30 HTTP functions and deploy it. It should display a warning.

Todos:

Write tests
Write documentation
Fix linting errors
Make sure code coverage hasn't dropped
Provide verification config / commands / resources
Enable "Allow edits from maintainers" for this PR
Update the messages below

Is this ready for review?: NO
Is it a breaking change?: NO

Vadorequest · 2018-03-11T08:29:32Z

@alexdebrie Looks great on the visual/UI. As far as the implementation goes, it looks perfect. 👍

horike37

@alexdebrie
Nice! The information and warning would be beneficial for many users!
I just added some comments for the implementation.
Cloud you confirm those?

horike37 · 2018-03-12T21:18:54Z

lib/plugins/aws/info/display.js

+    message += `${chalk.yellow('stack:')} ${info.stack}\n`;
+    message += `${chalk.yellow('resources:')} ${info.resourceCount}`;
+
+    if (info.resourceCount >= 150) {


Would be good to verify if it has the object key like this if (_.has(info, 'resourceCount') && info.resourceCount >= 150)

horike37 · 2018-03-12T21:21:35Z

lib/plugins/aws/info/getResourceCount.js

+    return this.provider.request('CloudFormation',
+      'listStackResources',
+      { StackName: stackName })
+    .then((result) => {


You can write simpler like this .then(result => {

horike37 · 2018-03-12T21:24:03Z

lib/plugins/aws/info/getResourceCount.js

+      'listStackResources',
+      { StackName: stackName })
+    .then((result) => {
+      if (result) {


Use lodash for consistency. if (!isEmpty(result)) {

horike37 · 2018-03-12T21:32:05Z

lib/plugins/aws/info/getResourceCount.test.js

+      outputs: [],
+    };
+
+    return awsInfo.getResourceCount().then(() => {


Use chai-as-promised style like this https://github.com/serverless/serverless/blob/master/lib/plugins/plugin/plugin.test.js

@horike37 I don't quite understand this one. Which line is a good example in the plugin.test.js?

@alexdebrie
Please see this line. You can test if it returns fulfilled or rejected as a promise by using chai-as-promised. Otherwise, you can't handle the test process if the current test is and returns rejected.
https://github.com/serverless/serverless/blob/master/lib/plugins/plugin/plugin.test.js#L55

@horike37 Thanks! I gave it a shot -- let me know if that's right 😄

horike37 · 2018-03-12T21:32:41Z

lib/plugins/aws/info/getResourceCount.test.js

+      outputs: [],
+    };
+
+    return awsInfo.getResourceCount().then(() => {


Use chai-as-promised style like this https://github.com/serverless/serverless/blob/master/lib/plugins/plugin/plugin.test.js

@horike37 Same question as above

Ah, sorry. this is duplicate of the above comment, please ignore.

… ResourceCount

horike37 · 2018-03-13T06:53:00Z

@alexdebrie
I have re-thought about the warning, which may be annoying some people since the warning message is displayed when the number of resources is more than 150, and you can't remove that even if the problem has been resolved on users end.

I think the message may be unnecessary. What do you think?

alexdebrie · 2018-03-13T12:00:04Z

@horike37 Yea, I see what you're saying. The problem is this can't ever really be "resolved" for a user unless they remove resources. If they have more than 150 resources, they're in that danger zone of hitting the 200 resource limit. This limit is a pretty common problem, so we'd like to give users a heads up before they run directly into it without warning.

Open to other thoughts on how to surface this for users while also not being annoying to others. cc @HyperBrain @brianneisler

HyperBrain · 2018-03-13T12:03:47Z

@alexdebrie What about restricting the warning to verbose mode only?

this.options.verbose && this.serverless.cli.log(...);

Then it is hidden during normal installs and users can get the warning additionally to other detailed output. Maybe at some threshold it can be even emitted without verbose mode enabled, like something above 190, because then every new resource added is likely to break the deployment.

alexdebrie · 2018-03-13T12:16:09Z

@HyperBrain To me, the biggest point of this is to provide helpful guidance to less-experienced users before they hit the wall head on. I'm guessing the less-experienced users won't be using verbose mode as often, and 190+ resources seems pretty late to start warning them.

How big of an annoyance is the additional warning message? I feel like it's a pretty small subset of users that:

Have more than 150 resources;
Understand the CloudFormation resource limit and are OK with their status; and
Get annoyed by the extra output.

But maybe I'm misjudging that 😄

HyperBrain · 2018-03-13T12:22:38Z

In regards to new users, it seems fair to emit the warning to let them know. I'm also fine to have the warning unconditionally for now 😄

A further improvement would then be to add log levels to the cli in general and put this "warning" into an "info" level. By default Serverless would show everything (error, warning and info) and thus show the warning for users that are new or unexperienced. More experienced users could then restrict the levels to "error" and/or "warning" by a config property or switch and would not see it.

I think with such a level implementation everyone can be happy.

alexdebrie · 2018-03-13T13:19:19Z

@HyperBrain Agreed! That would be a good solution 😄

Vadorequest · 2018-03-13T13:19:50Z

My first thought about it was to allow to add some kind of settings in the serverless.yml in order to hide such messages, that way people would get the warning and if it gets annoying they can just disable it through the serverless.yml file. But logging level works too, as long as it's displayed by default because that's too sensitive to be hidden by default.

HyperBrain · 2018-03-13T13:23:18Z

Logging levels are imo better, because settings in serverless.yml are service configuration settings. The output of warning messages is more a Serverless CLI setting than a service/project setting.
So, having log level settings in the SLS configuration file (I think it was serverlessrc globally or locally) would be the proper approach.

HyperBrain · 2018-03-13T13:27:52Z

I restarted the Travis build (had a hang). However, I'm not allowed to restart the appveyor build 🤔 . @pmuens Can you give me some rights there?

Vadorequest · 2018-03-13T13:47:16Z

@HyperBrain I actually agree, it has nothing to do with the serverless.yml indeed. It was just my first thought, but logging level makes more sense.

ronkorving · 2018-07-13T09:14:59Z

This is a great feature! I'm sad to see this hasn't gotten much attention for a while. Is this still going places?

pmuens

This looks great! Thanks @alexdebrie 👍

Nice feature which can be really helpful! I just looked through the code and it's almost GTM. Just added one comment regarding a removed restoring of a stub. Other than that I think it should be GTM

pmuens · 2019-01-23T12:28:28Z

lib/plugins/aws/info/index.test.js

@@ -52,7 +55,7 @@ describe('AwsInfo', () => {

  afterEach(() => {
    awsInfo.validate.restore();
-    awsInfo.getStackInfo.restore();


What happened to getStackInfo here? Shouldn't we restore it as well since I see the corresponding stub above 🤔

Good catch, @pmuens ! I have no idea why I did that, so I added it back. 😄

eahefnawy

A very belated "thank you" @alexdebrie 😄

pmuens

Thanks for updating @alexdebrie 👍

And +100 for the descriptive commit message "Restore the missing restore " 👌 😂

This feature is super nifty. Just gave it a spin and it works great!

Stale review

Add resource count and warning to info display

39b62d9

alexdebrie and others added 3 commits March 12, 2018 00:54

Add / update tests

88efb54

Linter

1d6fbe3

Merge branch 'master' into ResourceCount

8135ae0

horike37 previously requested changes Mar 12, 2018

View reviewed changes

alexdebrie added 2 commits March 13, 2018 01:55

PR fixes

0f42d4c

Merge branch 'ResourceCount' of github.com:serverless/serverless into…

5f86332

… ResourceCount

Use chai-as-promised

c575de2

pmuens added the pr/in-progress label Jan 15, 2019

pmuens suggested changes Jan 23, 2019

View reviewed changes

pmuens self-assigned this Jan 23, 2019

pmuens added pr/in-review and removed pr/in-progress labels Jan 23, 2019

eahefnawy previously approved these changes Jan 23, 2019

View reviewed changes

Restore the missing restore

4caa108

alexdebrie dismissed eahefnawy’s stale review via 4caa108 January 23, 2019 17:11

pmuens approved these changes Jan 24, 2019

View reviewed changes

pmuens merged commit 36f9829 into master Jan 24, 2019

pmuens deleted the ResourceCount branch January 24, 2019 11:23

pmuens added this to the 1.36.4 milestone Feb 5, 2019

shortjared added the enhancement label Feb 6, 2019

medikoo mentioned this pull request Oct 13, 2021

refactor(CLI): Introduce modern warning about resource limit #10086

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add resource count and warning to info display #4822

Add resource count and warning to info display #4822

alexdebrie commented Mar 11, 2018

Vadorequest commented Mar 11, 2018

horike37 left a comment

horike37 Mar 12, 2018

horike37 Mar 12, 2018

horike37 Mar 12, 2018

horike37 Mar 12, 2018

alexdebrie Mar 13, 2018

horike37 Mar 13, 2018

alexdebrie Mar 13, 2018

horike37 Mar 12, 2018

alexdebrie Mar 13, 2018

horike37 Mar 13, 2018

horike37 commented Mar 13, 2018

alexdebrie commented Mar 13, 2018

HyperBrain commented Mar 13, 2018 •

edited

alexdebrie commented Mar 13, 2018

HyperBrain commented Mar 13, 2018 •

edited

alexdebrie commented Mar 13, 2018

Vadorequest commented Mar 13, 2018

HyperBrain commented Mar 13, 2018

HyperBrain commented Mar 13, 2018

Vadorequest commented Mar 13, 2018

ronkorving commented Jul 13, 2018

pmuens left a comment

pmuens Jan 23, 2019

alexdebrie Jan 23, 2019

eahefnawy left a comment

pmuens left a comment

Add resource count and warning to info display #4822

Add resource count and warning to info display #4822

Conversation

alexdebrie commented Mar 11, 2018

What did you implement:

How did you implement it:

How can we verify it:

Todos:

Vadorequest commented Mar 11, 2018

horike37 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

horike37 commented Mar 13, 2018

alexdebrie commented Mar 13, 2018

HyperBrain commented Mar 13, 2018 • edited

alexdebrie commented Mar 13, 2018

HyperBrain commented Mar 13, 2018 • edited

alexdebrie commented Mar 13, 2018

Vadorequest commented Mar 13, 2018

HyperBrain commented Mar 13, 2018

HyperBrain commented Mar 13, 2018

Vadorequest commented Mar 13, 2018

ronkorving commented Jul 13, 2018

pmuens left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eahefnawy left a comment

Choose a reason for hiding this comment

pmuens left a comment

Choose a reason for hiding this comment

HyperBrain commented Mar 13, 2018 •

edited

HyperBrain commented Mar 13, 2018 •

edited