Remove 'sideEffects' field from package.jsons #7057
Conversation
|
I've run nightly tests on this PR and found no failing tests. I still need to check if this change affects bundle sizes. |
There was a problem hiding this comment.
Reviewed 3 of 3 files at r1, all commit messages.
Reviewable status:complete! 1 of 1 approvals obtained
|
I'm seeing some size differences in custom bundles: With this change: Without |
|
This may require a more extensive refactor than I initially anticipated. tfjs-core exports all the ops from |
`train.ts` exports optimizers by copying them from the `OptimizerConstructors` class onto a `train` object. This is unnecessary because the `OptimizerConstructors` class constructor is a subtype of the `train` object's type (i.e. it has all the properties that `train` has). Instead of creating a new `train` object, this PR re-exports `OptimizerConstructors` as `train`. This has no direct effect now, but if / when re remove the `sideEffects` field from `package.json`, it helps some bundlers (esbuild) do tree-shaking.
Each `Optimizer` lists its class name as a static property of the class so it can be serialized and deserialized. This prevents the class from being tree-shaken because bundlers will compile it like this:
```
class SomeOptimizer {
...
}
// The bundler can not remove this assignment because
// SomeOptimizer.className could be a setter with a side effect.
SomeOptimizer.className = 'SomeOptimizer';
```
This PR uses a static getter for the class name instead, which bundlers can tree-shake properly.
Enable the TypeScript [`esModuleInterop` flag](https://www.typescriptlang.org/tsconfig#esModuleInterop), which was released in TS2.7 and is a recommended config option. This removes the need for some workarounds we use for rollup plugins and Long. Upgrade Long from 4.0.0 to 5.2.1.
Some of tfjs's package.json files have a
sideEffectsfield to mark certain files as side-effectful for bundlers. However, bundlers can do static analysis to find side effects automatically, and this is usually more accurate and less error-prone than relying on a manually maintained list.This PR removes the
sideEffectsfield from the package.json files.Fixes #4259
Fixes #5182
To see the logs from the Cloud Build CI, please join either our discussion or announcement mailing list.
This change is