Add ci script to check examples #28009

oBusk · 2021-08-12T10:34:19Z

If #27983, #28003, #28007 and #28008 were all accepted and merged, I think it'd be possible to keep examples being correct/prepared by running a Github action to check some basic things that seems to be forgotten in examples.

Furthermore, #27121 also did some more cleanup that would be nice to check. So this PR also updates the script to check these things:

Add private: true

Remove version (because they are irrelevant for packages that are not meant to be published)

Remove name (because they are optional for packages that are not meant to be published, and when someone clones an example, they often rename it and the property becomes stale)

Remove author

Remove description

Remove license

It's not very pretty, but I'm not sure how to replace sponge in a good way in the shell script

oBusk · 2021-08-12T11:03:23Z

The script could also

make sure dependencies.next = "latest" (I'm assuming this is the expected behaviour)
make sure dependencies.react and dependencies.react-dom is recommended version?

oBusk · 2021-08-12T15:55:51Z

It was mentioned that this should be added to to the build-test-deploy/lint job. This PR currently adds this as a separate workflow/job. Should I change this?

ijjk · 2021-08-12T15:58:42Z

I think it would be good to keep it in the build_test_deploy workflow, it can be a separate job from lint if it's faster though

…s-ci

ijjk · 2021-08-14T12:56:11Z

Failing test suites

Commit: fd2947d

test/acceptance/ReactRefreshLogBox.dev.test.js

server-side only compilation errors

Expand output

● server-side only compilation errors

ScriptTimeoutError: script timeout
  (Session info: headless chrome=92.0.4515.131)

  72 |
  73 |             // Wait for application to re-hydrate:
> 74 |             await browser.executeAsyncScript(function () {
     |             ^
  75 |               var callback = arguments[arguments.length - 1]
  76 |               if (window.__NEXT_HYDRATED) {
  77 |                 callback()

  at Object.throwDecodedError (../node_modules/selenium-webdriver/lib/error.js:550:15)
  at parseHttpResponse (../node_modules/selenium-webdriver/lib/http.js:565:13)
  at Executor.execute (../node_modules/selenium-webdriver/lib/http.js:491:26)
      at runMicrotasks (<anonymous>)
  at Proxy.execute (../node_modules/selenium-webdriver/lib/webdriver.js:700:17)
  at Object.patch (acceptance/helpers.js:74:13)
  at Object.<anonymous> (acceptance/ReactRefreshLogBox.dev.test.js:1422:3)

…s-ci

oBusk · 2021-08-14T16:09:15Z

#27983, #28003, #28007 and #28008 have all been merged! 🎉🥳

So I ran the script again commited the remaining cleanups, and now the CI-check is completing succesfully! 🎉

This includes the cleanups of #27121

Should these rules for examples be added to some documentation? Some guidelines for adding examples? Could arguably add it as a checkpoint to the PR template for examples, ◻ scripts/check-examples completes. But obviously, It won't run on windows 🤔 Maybe it should be a .js script instead

ijjk · 2021-08-14T16:12:35Z

Stats from current PR

Default Build (Increase detected ⚠️)

General

	vercel/next.js canary	oBusk/next.js check-examples-ci	Change
buildDuration	13.3s	13.4s	⚠️ +71ms
buildDurationCached	3.3s	3.3s	-10ms
nodeModulesSize	49.1 MB	49.1 MB	✓

Page Load Tests Overall increase ✓

	vercel/next.js canary	oBusk/next.js check-examples-ci	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.602	2.62	⚠️ +0.02
/ avg req/sec	960.97	954.13	⚠️ -6.84
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.443	1.418	-0.03
/error-in-render avg req/sec	1732.13	1762.66	+30.53

Client Bundles (main, webpack, commons)

	vercel/next.js canary	oBusk/next.js check-examples-ci	Change
745.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42.2 kB	42.2 kB	✓
main-HASH.js gzip	23.1 kB	23.1 kB	✓
webpack-HASH.js gzip	1.44 kB	1.44 kB	✓
Overall change	67 kB	67 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	oBusk/next.js check-examples-ci	Change
polyfills-a4..dd70.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	oBusk/next.js check-examples-ci	Change
_app-HASH.js gzip	980 B	980 B	✓
_error-HASH.js gzip	194 B	194 B	✓
amp-HASH.js gzip	312 B	312 B	✓
css-HASH.js gzip	329 B	329 B	✓
dynamic-HASH.js gzip	2.64 kB	2.64 kB	✓
head-HASH.js gzip	350 B	350 B	✓
hooks-HASH.js gzip	904 B	904 B	✓
image-HASH.js gzip	4.13 kB	4.13 kB	✓
index-HASH.js gzip	261 B	261 B	✓
link-HASH.js gzip	1.66 kB	1.66 kB	✓
routerDirect..HASH.js gzip	319 B	319 B	✓
script-HASH.js gzip	387 B	387 B	✓
withRouter-HASH.js gzip	320 B	320 B	✓
bb14e60e810b..30f.css gzip	125 B	125 B	✓
Overall change	12.9 kB	12.9 kB	✓

Client Build Manifests

	vercel/next.js canary	oBusk/next.js check-examples-ci	Change
_buildManifest.js gzip	491 B	491 B	✓
Overall change	491 B	491 B	✓

Rendered Page Sizes

	vercel/next.js canary	oBusk/next.js check-examples-ci	Change
index.html gzip	540 B	540 B	✓
link.html gzip	552 B	552 B	✓
withRouter.html gzip	532 B	532 B	✓
Overall change	1.62 kB	1.62 kB	✓

Webpack 4 Mode (Decrease detected ✓)

General

	vercel/next.js canary	oBusk/next.js check-examples-ci	Change
buildDuration	11.3s	11s	-292ms
buildDurationCached	4.5s	4.3s	-228ms
nodeModulesSize	49.1 MB	49.1 MB	✓

Page Load Tests Overall decrease ⚠️

	vercel/next.js canary	oBusk/next.js check-examples-ci	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.629	2.679	⚠️ +0.05
/ avg req/sec	950.85	933.07	⚠️ -17.78
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.464	1.493	⚠️ +0.03
/error-in-render avg req/sec	1708.11	1674.75	⚠️ -33.36

Client Bundles (main, webpack, commons)

	vercel/next.js canary	oBusk/next.js check-examples-ci	Change
16.HASH.js gzip	186 B	186 B	✓
677f882d2ed8..HASH.js gzip	14 kB	14 kB	✓
framework.HASH.js gzip	41.9 kB	41.9 kB	✓
main-HASH.js gzip	10.6 kB	10.6 kB	✓
webpack-HASH.js gzip	1.19 kB	1.19 kB	✓
Overall change	67.9 kB	67.9 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	oBusk/next.js check-examples-ci	Change
polyfills-a4..dd70.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	oBusk/next.js check-examples-ci	Change
_app-HASH.js gzip	965 B	965 B	✓
_error-HASH.js gzip	3.71 kB	3.71 kB	✓
amp-HASH.js gzip	552 B	552 B	✓
css-HASH.js gzip	333 B	333 B	✓
dynamic-HASH.js gzip	2.83 kB	2.83 kB	✓
head-HASH.js gzip	2.97 kB	2.97 kB	✓
hooks-HASH.js gzip	911 B	911 B	✓
index-HASH.js gzip	231 B	231 B	✓
link-HASH.js gzip	1.64 kB	1.64 kB	✓
routerDirect..HASH.js gzip	298 B	298 B	✓
script-HASH.js gzip	2.95 kB	2.95 kB	✓
withRouter-HASH.js gzip	294 B	294 B	✓
e025d2764813..52f.css gzip	125 B	125 B	✓
Overall change	17.8 kB	17.8 kB	✓

Client Build Manifests

	vercel/next.js canary	oBusk/next.js check-examples-ci	Change
_buildManifest.js gzip	497 B	497 B	✓
Overall change	497 B	497 B	✓

Rendered Page Sizes

	vercel/next.js canary	oBusk/next.js check-examples-ci	Change
index.html gzip	585 B	585 B	✓
link.html gzip	598 B	598 B	✓
withRouter.html gzip	579 B	579 B	✓
Overall change	1.76 kB	1.76 kB	✓

Commit: e12bc1e

ijjk · 2021-08-14T18:33:51Z

Hmm we could potentially add these as tasks in the PR template good point cc @leerob

ijjk

Thanks for these PRs! 🙌

oBusk added 4 commits August 12, 2021 12:31

Add ci script to check examples

709262c

Install moreutils for sponge command.

a634f65

It's not very pretty, but I'm not sure how to replace sponge in a good way in the shell script

Prettier names in the workflow

3e1ca3e

Merge branch 'canary' into check-examples-ci

9403316

oBusk marked this pull request as ready for review August 12, 2021 10:46

oBusk requested review from huozhi, ijjk, padmaia, shuding, styfle and timneutkens as code owners August 12, 2021 10:46

This comment has been minimized.

Sign in to view

oBusk mentioned this pull request Aug 12, 2021

Make sure all example packages has private: true #28008

Merged

Move "check-examples" into build_test_deploy workflow

a55a02f

This comment has been minimized.

Sign in to view

Merge branch 'canary' into check-examples-ci

3a0b723

This comment has been minimized.

Sign in to view

Merge branch 'canary' of github.com:vercel/next.js into check-example…

9773884

…s-ci

oBusk mentioned this pull request Aug 14, 2021

Remove licence from all example/package.json that has them #28007

Merged

oBusk added 2 commits August 14, 2021 14:26

Start breaking the jq script into multiple lines

57253d5

Add checks for cleanups in vercel#27121

fd2947d

This comment has been minimized.

Sign in to view

oBusk added 2 commits August 14, 2021 18:00

Merge branch 'canary' of github.com:vercel/next.js into check-example…

a0b3095

…s-ci

Run the check-examples.sh script to cleanup all remaining examples.

e12bc1e

oBusk requested review from leerob and lfades as code owners August 14, 2021 16:01

ijjk added the examples Issue/PR related to examples label Aug 14, 2021

ijjk approved these changes Aug 14, 2021

View reviewed changes

ijjk merged commit 971b17f into vercel:canary Aug 14, 2021

oBusk deleted the check-examples-ci branch August 18, 2021 09:52

vercel locked as resolved and limited conversation to collaborators Jan 28, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ci script to check examples #28009

Add ci script to check examples #28009

oBusk commented Aug 12, 2021 •

edited

This comment has been minimized.

oBusk commented Aug 12, 2021

oBusk commented Aug 12, 2021

ijjk commented Aug 12, 2021

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ijjk commented Aug 14, 2021

oBusk commented Aug 14, 2021

ijjk commented Aug 14, 2021

ijjk commented Aug 14, 2021

ijjk left a comment

Add ci script to check examples #28009

Add ci script to check examples #28009

Conversation

oBusk commented Aug 12, 2021 • edited

This comment has been minimized.

oBusk commented Aug 12, 2021

oBusk commented Aug 12, 2021

ijjk commented Aug 12, 2021

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ijjk commented Aug 14, 2021

Failing test suites

oBusk commented Aug 14, 2021

ijjk commented Aug 14, 2021

Stats from current PR

ijjk commented Aug 14, 2021

ijjk left a comment

Choose a reason for hiding this comment

oBusk commented Aug 12, 2021 •

edited