[CHORE] adds asset reporting infra

[runspired]

Before running these commands you will want to run

yarn workspace ember-data ember b -e production

• snapshot the state node ./bin/asset-size-tracking/generate-analysis.js
• see an analysis node ./bin/asset-size-tracking/print-analysis.js
• diff the current vendor file against the snapshot node ./bin/asset-size-tracking/generate-diff.js
• generate diff as gh-action that fails if package sizes regress
• post analysis as comment for clear visibility
• make analysis and dist files downloadable artifacts

[rwjblue]

The calculation of compressed size per package and per module provides misleading information. Compressing a single module does not properly reflect the impact that modules contents has on the final asset sizes (e.g. over weighing small changes to module output that are shared across many modules and therefore ignoring the concepts behind compression algorithms like gzip/brotli).

A better / more wholistic system would be to do something like:

1. Do a prod build
2. Gather the minified sizes of each module in the build
3. Gather the minified + compressed sizes of the full vendor.js asset
4. Determine the “estimated compressed size” of each module via MODULE_MIN_SIZE / FULL_BUNDLE_MIN_SIZE * FULL_BUNDLE_COMPRESSED_SIZE

It looks like you have all of the building blocks to do that calculation in this PR already, so hopefully it is not a massive change.

[rwjblue]

@runspired - Can you have the comment use the <detail><summmary></summary></detail> setup? That way the comment is much smaller (collapsed) when it is essentially reporting that there is no change in size...

[github-actions]

Asset Size Report for 29710da

EmberData has not changed in size

If any packages had changed sizes they would be listed here.

Full Asset Analysis

Asset Size Report
=================


Library: EmberData
┌────────────┬─────────────┐
│  (index)   │   Values    │
├────────────┼─────────────┤
│   bytes    │ '177.38 KB' │
│ compressed │ '37.27 KB'  │
│  packages  │     10      │
│  modules   │     49      │
└────────────┴─────────────┘

Package: @ember-data/store
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '86.46 KB' │
│  compressed  │ '18.17 KB' │
│ % Of Library │   '48.7'   │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/store/-private                    | 85.54 KB  | 17.97 KB   | 98.9          | 48.2
	@ember-data/store/index                       | 936 B     | 196.67 B   | 1.1           | 0.5

Package: @ember-data/record-data
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '23.77 KB' │
│  compressed  │ '5.00 KB'  │
│ % Of Library │   '13.4'   │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/record-data/-private              | 23.77 KB  | 5.00 KB    | 100.0         | 13.4

Package: @ember-data/serializer
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '19.36 KB' │
│  compressed  │ '4.07 KB'  │
│ % Of Library │   '10.9'   │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/serializer/json                   | 7.10 KB   | 1.49 KB    | 36.7          | 4.0
	@ember-data/serializer/-private               | 5.36 KB   | 1.13 KB    | 27.7          | 3.0
	@ember-data/serializer/json-api               | 3.77 KB   | 811.27 B   | 19.5          | 2.1
	@ember-data/serializer/rest                   | 2.68 KB   | 576.36 B   | 13.8          | 1.5
	@ember-data/serializer/index                  | 243 B     | 51.05 B    | 1.2           | 0.1
	@ember-data/serializer/transform              | 215 B     | 45.17 B    | 1.1           | 0.1

Package: @ember-data/adapter
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '14.52 KB' │
│  compressed  │ '3.05 KB'  │
│ % Of Library │   '8.2'    │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/adapter/rest                      | 7.60 KB   | 1.60 KB    | 52.3          | 4.3
	@ember-data/adapter/-private                  | 3.50 KB   | 753.07 B   | 24.1          | 2.0
	@ember-data/adapter/error                     | 1.91 KB   | 411.62 B   | 13.2          | 1.1
	@ember-data/adapter/json-api                  | 830 B     | 174.4 B    | 5.6           | 0.5
	@ember-data/adapter/index                     | 719 B     | 151.07 B   | 4.8           | 0.4

Package: @ember-data/model
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '10.64 KB' │
│  compressed  │ '2.24 KB'  │
│ % Of Library │   '6.0'    │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/model/-private                    | 10.17 KB  | 2.14 KB    | 95.5          | 5.7
	@ember-data/model/index                       | 486 B     | 102.11 B   | 4.5           | 0.3

Package: ember-data
┌──────────────┬───────────┐
│   (index)    │  Values   │
├──────────────┼───────────┤
│    bytes     │ '9.76 KB' │
│  compressed  │ '2.05 KB' │
│ % Of Library │   '5.5'   │
└──────────────┴───────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	ember-data/index                              | 2.42 KB   | 520.89 B   | 24.8          | 1.4
	ember-data/-private                           | 2.02 KB   | 434.53 B   | 20.7          | 1.1
	ember-data/adapters/errors                    | 1.19 KB   | 255.71 B   | 12.2          | 0.7
	ember-data/setup-container                    | 503 B     | 105.69 B   | 5.0           | 0.3
	ember-data/store                              | 406 B     | 85.3 B     | 4.1           | 0.2
	ember-data/relationships                      | 318 B     | 66.81 B    | 3.2           | 0.2
	ember-data/serializers/embedded-records-mixin | 274 B     | 57.57 B    | 2.7           | 0.2
	ember-data/serializers/json-api               | 251 B     | 52.74 B    | 2.5           | 0.1
	ember-data/adapters/json-api                  | 245 B     | 51.47 B    | 2.5           | 0.1
	ember-data/serializers/json                   | 243 B     | 51.05 B    | 2.4           | 0.1
	ember-data/serializers/rest                   | 243 B     | 51.05 B    | 2.4           | 0.1
	ember-data/transform                          | 241 B     | 50.63 B    | 2.4           | 0.1
	ember-data/adapters/rest                      | 237 B     | 49.79 B    | 2.4           | 0.1
	ember-data/serializer                         | 232 B     | 48.74 B    | 2.3           | 0.1
	ember-data/adapter                            | 226 B     | 47.48 B    | 2.3           | 0.1
	ember-data/model                              | 222 B     | 46.64 B    | 2.2           | 0.1
	ember-data/attr                               | 218 B     | 45.8 B     | 2.2           | 0.1
	ember-data/initialize-store-service           | 207 B     | 43.49 B    | 2.1           | 0.1
	ember-data/version                            | 162 B     | 34.03 B    | 1.6           | 0.1

Package: ember-inflector
┌──────────────┬───────────┐
│   (index)    │  Values   │
├──────────────┼───────────┤
│    bytes     │ '7.90 KB' │
│  compressed  │ '1.66 KB' │
│ % Of Library │   '4.5'   │
└──────────────┴───────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	ember-inflector/lib/system/inflector          | 2.75 KB   | 591.91 B   | 34.8          | 1.6
	ember-inflector/lib/system/inflections        | 1.57 KB   | 338.29 B   | 19.9          | 0.9
	ember-inflector/index                         | 1.12 KB   | 241.21 B   | 14.2          | 0.6
	ember-inflector/lib/ext/string                | 783 B     | 164.52 B   | 9.7           | 0.4
	ember-inflector/lib/system                    | 452 B     | 94.97 B    | 5.6           | 0.2
	ember-inflector/lib/system/string             | 351 B     | 73.75 B    | 4.3           | 0.2
	ember-inflector/lib/helpers/pluralize         | 348 B     | 73.12 B    | 4.3           | 0.2
	ember-inflector/lib/utils/make-helper         | 308 B     | 64.71 B    | 3.8           | 0.2
	ember-inflector/lib/helpers/singularize       | 271 B     | 56.94 B    | 3.4           | 0.1

Package: @ember-data/debug
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '2.68 KB'  │
│  compressed  │ '576.36 B' │
│ % Of Library │   '1.5'    │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/debug/index                       | 2.19 KB   | 471.51 B   | 81.8          | 1.2
	@ember-data/debug/setup                       | 499 B     | 104.85 B   | 18.2          | 0.3

Package: @ember-data/canary-features
┌──────────────┬───────────┐
│   (index)    │  Values   │
├──────────────┼───────────┤
│    bytes     │ '1.24 KB' │
│  compressed  │ '265.8 B' │
│ % Of Library │   '0.7'   │
└──────────────┴───────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/canary-features/index             | 927 B     | 194.78 B   | 73.3          | 0.5
	@ember-data/canary-features/default-features  | 338 B     | 71.02 B    | 26.7          | 0.2

Package: @ember/ordered-set
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '1.05 KB'  │
│  compressed  │ '226.51 B' │
│ % Of Library │   '0.6'    │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember/ordered-set/index                      | 1.05 KB   | 226.51 B   | 100.0         | 0.6

[simonihmig]

A better / more wholistic system would be to do something like:
[...]

Fwiw, that's exactly what broccoli-concat-analyser / ember-cli-bundle-analyzer is doing! (stefanpenner/broccoli-concat-analyser#20)

[simonihmig]

In the downloadable artefact, the master-analysis.txt has a bunch of source code appended. Probably not intended?

[runspired]

@simonihmig yeah we switched over the calc. RE appended output in the artifact that’s intentional. It’s a flag you can pass, and helps you see what you had parsed out.