Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(build): remove sourcemaps, minified compiler build #5645

Merged
merged 1 commit into from
Apr 10, 2024

Conversation

alicewriteswrongs
Copy link
Contributor

@alicewriteswrongs alicewriteswrongs commented Apr 9, 2024

This removes sourcemaps from the cli, compiler, and dev-server bundles and also removes the unused minified compiler build. All these changes are made to the esbuild-based build.

We realized recently that the minified compiler is no longer necessary (it was previously used for in-browser compilation support, and was removed in #4317) and the sourcemaps are similarly not useful, but do take up a significant amount of space.

Without this change a packed Stencil tarball is around 12MB, and with this change it drops to 3.5MB.

STENCIL-1242

Documentation

Does this introduce a breaking change?

  • Yes
  • No

Testing

Test that you can build and use Stencil with this change.

Also try out the 'debug' build, which is building like so:

DEBUG=true npm run build

that should produce sourcemaps for all the files bundled with Esbuild.

Copy link
Contributor

github-actions bot commented Apr 9, 2024

--strictNullChecks error report

Typechecking with --strictNullChecks resulted in 1137 errors on this branch.

That's the same number of errors on main, so at least we're not creating new ones!

reports and statistics

Our most error-prone files
Path Error Count
src/dev-server/index.ts 37
src/dev-server/server-process.ts 32
src/compiler/prerender/prerender-main.ts 22
src/runtime/client-hydrate.ts 20
src/testing/puppeteer/puppeteer-element.ts 20
src/screenshot/connector-base.ts 19
src/runtime/vdom/vdom-render.ts 17
src/dev-server/request-handler.ts 15
src/compiler/prerender/prerender-optimize.ts 14
src/compiler/sys/stencil-sys.ts 14
src/sys/node/node-sys.ts 14
src/compiler/prerender/prerender-queue.ts 13
src/compiler/sys/in-memory-fs.ts 13
src/runtime/connected-callback.ts 13
src/runtime/set-value.ts 13
src/compiler/output-targets/output-www.ts 12
src/compiler/transformers/test/parse-vdom.spec.ts 12
src/compiler/transformers/transform-utils.ts 12
src/compiler/transpile/transpile-module.ts 12
src/mock-doc/test/attribute.spec.ts 12
Our most common errors
Typescript Error Code Count
TS2322 361
TS2345 344
TS18048 204
TS18047 82
TS2722 37
TS2532 24
TS2531 21
TS2454 14
TS2790 11
TS2352 9
TS2769 8
TS2538 8
TS2416 7
TS2493 3
TS18046 2
TS2684 1
TS2430 1

Unused exports report

There are 14 unused exports on this PR. That's the same number of errors on main, so at least we're not creating new ones!

Unused exports
File Line Identifier
src/runtime/bootstrap-lazy.ts 21 setNonce
src/screenshot/screenshot-fs.ts 18 readScreenshotData
src/testing/testing-utils.ts 198 withSilentWarn
src/utils/index.ts 145 CUSTOM
src/utils/index.ts 269 normalize
src/utils/index.ts 7 escapeRegExpSpecialCharacters
src/compiler/app-core/app-data.ts 25 BUILD
src/compiler/app-core/app-data.ts 115 Env
src/compiler/app-core/app-data.ts 117 NAMESPACE
src/compiler/fs-watch/fs-watch-rebuild.ts 123 updateCacheFromRebuild
src/compiler/types/validate-primary-package-output-target.ts 61 satisfies
src/compiler/types/validate-primary-package-output-target.ts 61 Record
src/testing/puppeteer/puppeteer-declarations.ts 485 WaitForEventOptions
src/compiler/sys/fetch/write-fetch-success.ts 7 writeFetchSuccessSync

Copy link
Contributor

github-actions bot commented Apr 9, 2024

PR built and packed!

Download the tarball here: https://github.com/ionic-team/stencil/actions/runs/8633844862/artifacts/1401993138

If your browser saves files to ~/Downloads you can install it like so:

unzip -d ~/Downloads ~/Downloads/stencil-core-4.15.0-dev.1712762818.04c44c7.tgz.zip && npm install ~/Downloads/stencil-core-4.15.0-dev.1712762818.04c44c7.tgz

@alicewriteswrongs alicewriteswrongs force-pushed the ap/remove-sourcemaps branch 2 times, most recently from 4f955ac to d2864e2 Compare April 9, 2024 20:42
@alicewriteswrongs alicewriteswrongs marked this pull request as ready for review April 9, 2024 20:43
@alicewriteswrongs alicewriteswrongs requested a review from a team as a code owner April 9, 2024 20:43
Copy link
Contributor

@rwaskiewicz rwaskiewicz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did a search for stencil.min.js across the entire Ionic Org in GitHub, and found a couple of places I think we should also look into as a part of this effort:

  1. This section of the Stencil Site. I think that we can safely remove the offending sentence in the same files that Christian updated in ionic-team/stencil-site@999d831

  2. We still have a reference to this file in the compiler itself, at

    return sys.getRemoteModuleUrl({ moduleId: '@stencil/core', path: 'compiler/stencil.min.js' });
    . I wonder if we overlooked the possibility of pulling in Stencil from a CDN in a way that isn't to use the deprecated compiler APIs 🤔 jsdelivr reports 4/5 of the most versions are for v4.0.0 and lower. Either way, it looks like this is a part of the public API (we export this createSystem fn) - can you swap this out with stencil.js and validate that works in a small Node project that calls createSystem?

.gitignore Show resolved Hide resolved
scripts/esbuild/util.ts Outdated Show resolved Hide resolved
@alicewriteswrongs
Copy link
Contributor Author

@rwaskiewicz good catch, opened a docs PR here: ionic-team/stencil-site#1397

@rwaskiewicz
Copy link
Contributor

@alicewriteswrongs it looks like the second part of my original feedback wasn't addressed (#5645 (review))

  1. We still have a reference to this file in the compiler itself, at
    return sys.getRemoteModuleUrl({ moduleId: '@stencil/core', path: 'compiler/stencil.min.js' });
    . I wonder if we overlooked the possibility of pulling in Stencil from a CDN in a way that isn't to use the deprecated compiler APIs 🤔 jsdelivr reports 4/5 of the most versions are for v4.0.0 and lower. Either way, it looks like this is a part of the public API (we export this createSystem fn) - can you swap this out with stencil.js and validate that works in a small Node project that calls createSystem?

Copy link
Contributor

@rwaskiewicz rwaskiewicz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bah, sorry, meant to "request changes" rather than comment just now

alicewriteswrongs added a commit to ionic-team/stencil-site that referenced this pull request Apr 10, 2024
@alicewriteswrongs
Copy link
Contributor Author

yeah was just looking at that, I made that change and then installed in a project locally and created a small node script to import and use the compiler API and it works fine

Copy link
Member

@tanner-reits tanner-reits left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM once the change to src/compiler/sys/stencil-sys.ts is made

@alicewriteswrongs
Copy link
Contributor Author

just pushed the commit that changes that lil function over

This removes sourcemaps from the cli, compiler, and dev-server bundles
and also removes the unused minified compiler build. All these changes
are made to the esbuild-based build.

We realized recently that the minified compiler is no longer necessary
(it was previously used for in-browser compilation support, and was
removed in #4317) and the sourcemaps are similarly not useful, but do
take up a significant amount of space.

Without this change a packed Stencil tarball is around 12MB, and with
this change it drops to 3.5MB.

This also adds a check to the Esbuild-based build pipeline where if you
run it with the `DEBUG` environment variable it will build sourcemaps
for all of the bundles built with Esbuild, so building like

```sh
DEBUG=true npm run build
```

will produce a debugging-friendly local build with sourcemaps.

STENCIL-1242
@alicewriteswrongs alicewriteswrongs added this pull request to the merge queue Apr 10, 2024
Merged via the queue into main with commit 83cc0b9 Apr 10, 2024
121 checks passed
@alicewriteswrongs alicewriteswrongs deleted the ap/remove-sourcemaps branch April 10, 2024 15:38
alicewriteswrongs added a commit to ionic-team/stencil-site that referenced this pull request Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants