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

Integrate tsec into the linting process #33746

Merged
merged 3 commits into from Feb 25, 2022
Merged

Conversation

jgoping
Copy link
Contributor

@jgoping jgoping commented Jan 27, 2022

Linked to issue #32209.

Feature

  • Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
  • Related issues linked using fixes #number
  • Integration tests added
  • Documentation added
  • Telemetry added. In case of a feature if it's used or not.
  • Errors have helpful link attached, see contributing.md

Motivation

This is a pull request to begin integrating Trusted Types into the Next.js codebase. Background information can be found here.

tsec is a wrapper around tsc that performs Trusted Types checking. Any violations it detects will be caught and returned as an error. In this pull request, tsec has been added to the linting process for the packages next and react-dev-overlay as these were identified to have Trusted Types violations. To avoid these errors from failing the lint checks, all of the violations have been added to exemption lists. In future pull requests, these violations will be fixed and removed from the exemption list. Once Next.js is fully compatible with Trusted Types, application developers can choose to enforce Trusted Types without being blocked by the framework.

Notes

  • Currently, tsec has been added to the lint-typescript process. However, it can also be checked during each build or moved into its own script.
  • tsec is added as a dependency to the root package.json, although it can alternatively be added to the next and react-web-overlay package.json files if this is seen as a better practice.

@ijjk

This comment has been minimized.

@ijjk
Copy link
Member

ijjk commented Feb 23, 2022

Stats from current PR

Default Build (Increase detected ⚠️)
General Overall decrease ✓
vercel/next.js canary jgoping/next.js tsec-integration Change
buildDuration 14.7s 15s ⚠️ +287ms
buildDurationCached 5.7s 5.6s -180ms
nodeModulesSize 367 MB 367 MB -28 B
Page Load Tests Overall increase ✓
vercel/next.js canary jgoping/next.js tsec-integration Change
/ failed reqs 0 0
/ total time (seconds) 2.874 2.884 ⚠️ +0.01
/ avg req/sec 869.77 866.72 ⚠️ -3.05
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.333 1.318 -0.01
/error-in-render avg req/sec 1875.75 1896.97 +21.22
Client Bundles (main, webpack)
vercel/next.js canary jgoping/next.js tsec-integration Change
450.HASH.js gzip 179 B 179 B
framework-HASH.js gzip 42 kB 42 kB
main-HASH.js gzip 27.8 kB 27.8 kB
webpack-HASH.js gzip 1.44 kB 1.44 kB
Overall change 71.5 kB 71.5 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary jgoping/next.js tsec-integration Change
polyfills-HASH.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary jgoping/next.js tsec-integration Change
_app-HASH.js gzip 1.36 kB 1.36 kB
_error-HASH.js gzip 194 B 194 B
amp-HASH.js gzip 312 B 312 B
css-HASH.js gzip 326 B 326 B
dynamic-HASH.js gzip 2.57 kB 2.57 kB
head-HASH.js gzip 350 B 350 B
hooks-HASH.js gzip 919 B 919 B
image-HASH.js gzip 5.05 kB 5.05 kB
index-HASH.js gzip 263 B 263 B
link-HASH.js gzip 2.26 kB 2.26 kB
routerDirect..HASH.js gzip 321 B 321 B
script-HASH.js gzip 383 B 383 B
withRouter-HASH.js gzip 318 B 318 B
85e02e95b279..7e3.css gzip 107 B 107 B
Overall change 14.7 kB 14.7 kB
Client Build Manifests
vercel/next.js canary jgoping/next.js tsec-integration Change
_buildManifest.js gzip 460 B 460 B
Overall change 460 B 460 B
Rendered Page Sizes
vercel/next.js canary jgoping/next.js tsec-integration Change
index.html gzip 530 B 530 B
link.html gzip 544 B 544 B
withRouter.html gzip 525 B 525 B
Overall change 1.6 kB 1.6 kB

Default Build with SWC (Increase detected ⚠️)
General Overall decrease ✓
vercel/next.js canary jgoping/next.js tsec-integration Change
buildDuration 18.3s 18.5s ⚠️ +260ms
buildDurationCached 5.6s 6.3s ⚠️ +603ms
nodeModulesSize 367 MB 367 MB -28 B
Page Load Tests Overall increase ✓
vercel/next.js canary jgoping/next.js tsec-integration Change
/ failed reqs 0 0
/ total time (seconds) 2.825 2.844 ⚠️ +0.02
/ avg req/sec 885.1 879.03 ⚠️ -6.07
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.379 1.304 -0.07
/error-in-render avg req/sec 1812.5 1916.63 +104.13
Client Bundles (main, webpack)
vercel/next.js canary jgoping/next.js tsec-integration Change
450.HASH.js gzip 179 B 179 B
framework-HASH.js gzip 42.1 kB 42.1 kB
main-HASH.js gzip 27.8 kB 27.8 kB
webpack-HASH.js gzip 1.44 kB 1.44 kB
Overall change 71.6 kB 71.6 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary jgoping/next.js tsec-integration Change
polyfills-HASH.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary jgoping/next.js tsec-integration Change
_app-HASH.js gzip 1.35 kB 1.35 kB
_error-HASH.js gzip 180 B 180 B
amp-HASH.js gzip 305 B 305 B
css-HASH.js gzip 321 B 321 B
dynamic-HASH.js gzip 2.56 kB 2.56 kB
head-HASH.js gzip 342 B 342 B
hooks-HASH.js gzip 911 B 911 B
image-HASH.js gzip 5.08 kB 5.08 kB
index-HASH.js gzip 256 B 256 B
link-HASH.js gzip 2.28 kB 2.28 kB
routerDirect..HASH.js gzip 314 B 314 B
script-HASH.js gzip 375 B 375 B
withRouter-HASH.js gzip 309 B 309 B
85e02e95b279..7e3.css gzip 107 B 107 B
Overall change 14.7 kB 14.7 kB
Client Build Manifests
vercel/next.js canary jgoping/next.js tsec-integration Change
_buildManifest.js gzip 459 B 459 B
Overall change 459 B 459 B
Rendered Page Sizes
vercel/next.js canary jgoping/next.js tsec-integration Change
index.html gzip 534 B 534 B
link.html gzip 547 B 547 B
withRouter.html gzip 528 B 528 B
Overall change 1.61 kB 1.61 kB
Commit: 00e3b44

Copy link
Member

@ijjk ijjk left a comment

Choose a reason for hiding this comment

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

Looks good to land this to incrementally implement this, thanks for the PR!

@ijjk ijjk merged commit ce4923c into vercel:canary Feb 25, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants