Make brotli-size optional by styfle

[siddharthkp]

Description

1. Remove brotli-size from dependencies
2. Add try-catch around require('brotli-size')
3. Warn if using brotli option but missing brotli-size

Motivation and Context

It turns out the brotli-size (#194) is quite big and doesn't install very nicely on Windows.

See the following issues:

Fixes #202
Fixes #213

[eseliger]

Great stuff!

[styfle]

Eventually, we might even get brotli support in Node Core.
See nodejs/node#20458

[XhmikosR]

@siddharthkp: I currently have downgraded bundlesize to 0.15. This should be squashed and merged ASAP.

Node.js 10.0.0 is out for quite some time.

[siddharthkp]

@styfle Do you think the build should error out instead of passing if brotli-size is not installed?

(Check out the result of the build)

I have added you as a collaborator so you can commit directly to this branch (instead of a fork)

[styfle]

@siddharthkp That's a good point since they specifically said they wanted to use brotli. Maybe the correct thing to do is fail fast and just throw instead of a warning:

throw new Error('Missing optional dependency. Install it with: npm install --save brotli-size')

Thoughts?

[eseliger]

I agree with you guys
Requesting to check the size based on brotli compression and getting an OK return code seems wrong

[styfle]

@siddharthkp Ok the build is failing as expected now that there is a throw.

How should we fix the tests so that brotli-size is installed? Add to devDependencies?

[eseliger]

how about running it once and checking for failure and then running npm i brotli-size and running again and check for success?

[styfle]

@eseliger That was my first thought but I don't see a test harness so I'm not sure how to assert that and error was thrown with the current test commands.

[eseliger]

hmm maybe some script like this will work

bundlezise

if [ $? -eq 0 ]
then
  echo "Should have failed"
  exit 1
else
  exit 0
fi

[siddharthkp]

I don't think you should throw an error here. I would say, the travis build should pass because it only invokes bundlesize and the bundlesize build status should error out with the right message.

This should help: https://github.com/siddharthkp/bundlesize/blob/master/src/build.js#L32

[styfle]

I'm not sure I understand. Do you want to make the change on this branch?

[siddharthkp]

yep, this branch

[jakebolam]

I think siddharthkp was saying that you can make bundlesize exit with non-zero, so travis doesn't fail, but report bundlesize failure status to GitHub

In an offshoot version of bundlesize, we've elected to fail the build
https://github.com/bundlewatch/bundlewatch/blob/master/src/app/getLocalFileDetails/getSize.js#L12

[siddharthkp]

I'd suggest the way to fail the bundlesize build would be the companion error method: https://github.com/siddharthkp/bundlesize/blob/master/src/build.js#L32

[styfle]

@siddharthkp Would you like to implement this?

[siddharthkp]

I don't mind, it might take me some time to get to this though 😅

[palashmon]

There is a CI build error coming due to this line:

> eslint src store/*.js

/home/travis/build/siddharthkp/bundlesize/src/compressed-size.js
  1:9  error  'warn' is assigned a value but never used  no-unused-vars
✖ 1 problem (1 error, 0 warnings)

Please remove this line.

[XhmikosR]

Hey, guys. Any news? I'm still using a downgraded version due to no node.js 10.x support.

[styfle]

I think @siddharthkp still wanted to make a change here.

Another related issue worth pursuing is to get brotli support in Node Core.
Put a 👍 on this issue: nodejs/node#18964

[XhmikosR]

@siddharthkp: friendly ping!

[XhmikosR]

Is the package abandoned @siddharthkp ?

[styfle]

FYI, brotli support landed in Node core and should be in the next release.