feat: Adding generic typing for previewData #28668

espipj · 2021-08-31T16:51:34Z

on GetServerSidePropsContext and GetStaticPropsContext

As discussed on #21574 having a generic type will give it more flexibility and remove linting errors.

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 feat: add type to previewData #21574
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

on GetServerSidePropsContext and GetStaticPropsContext

ijjk

Hi, can we add a test case for this type change to ensure it is working as expected?

ijjk · 2021-08-31T21:33:09Z

Here's an example SSG page testing the getStaticProps type https://github.com/vercel/next.js/blob/501bfe69695b0e563e88af689105882513c2b370/test/integration/typescript/pages/ssg/%5Bslug%5D.tsx

espipj · 2021-08-31T23:14:28Z

Hey! I've modified the tests for SSG and SSR as they were already testing those specific types. I hope thats fine :)

ijjk · 2021-09-01T00:06:26Z

Failing test suites

Commit: 5fe1dc6

test/integration/typescript/test/index.test.js

TypeScript Features > should build the app

Expand output

● TypeScript Features › should build the app

expect(received).toBe(expected) // Object.is equality

Expected: 0
Received: 1

  85 | `
  86 |         )
> 87 |         app = await launchApp(appDir, appPort)
     |                              ^
  88 |
  89 |         const $ = await get$('/hello')
  90 |         expect($('body').text()).toMatch(/Hello World/)

  at Object.<anonymous> (integration/typescript/test/index.test.js:87:30)

styfle · 2021-09-01T23:30:50Z

packages/next/types/index.d.ts

@@ -115,9 +118,10 @@ export type GetStaticPropsResult<P> =

 export type GetStaticProps<
  P extends { [key: string]: any } = { [key: string]: any },
-  Q extends ParsedUrlQuery = ParsedUrlQuery
+  Q extends ParsedUrlQuery = ParsedUrlQuery,
+  S extends PreviewData = PreviewData


Can we use a consistent name for this, perhaps D instead of P or S?

Sure! I really don't mind I wasn't sure what capital letter to use 😅

Just pushed the changes :)

styfle

Thanks!

ijjk · 2021-09-03T20:51:44Z

Stats from current PR

Default Build (Decrease detected ✓)

General Overall increase ⚠️

	vercel/next.js canary	espipj/next.js fix/previewData-Generic-Type	Change
buildDuration	13.9s	13.9s	⚠️ +54ms
buildDurationCached	3.6s	3.5s	-80ms
nodeModulesSize	49.1 MB	49.1 MB	⚠️ +146 B

Page Load Tests Overall decrease ⚠️

	vercel/next.js canary	espipj/next.js fix/previewData-Generic-Type	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.652	2.69	⚠️ +0.04
/ avg req/sec	942.85	929.22	⚠️ -13.63
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.421	1.451	⚠️ +0.03
/error-in-render avg req/sec	1758.9	1722.88	⚠️ -36.02

Client Bundles (main, webpack, commons)

	vercel/next.js canary	espipj/next.js fix/previewData-Generic-Type	Change
745.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42.2 kB	42.2 kB	✓
main-HASH.js gzip	23.3 kB	23.3 kB	✓
webpack-HASH.js gzip	1.45 kB	1.45 kB	✓
Overall change	67.2 kB	67.2 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	espipj/next.js fix/previewData-Generic-Type	Change
polyfills-a4..dd70.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	espipj/next.js fix/previewData-Generic-Type	Change
_app-HASH.js gzip	979 B	979 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.67 kB	2.67 kB	✓
head-HASH.js gzip	351 B	351 B	✓
hooks-HASH.js gzip	918 B	918 B	✓
image-HASH.js gzip	4.14 kB	4.14 kB	✓
index-HASH.js gzip	261 B	261 B	✓
link-HASH.js gzip	1.66 kB	1.66 kB	✓
routerDirect..HASH.js gzip	318 B	318 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	13 kB	13 kB	✓

Client Build Manifests

	vercel/next.js canary	espipj/next.js fix/previewData-Generic-Type	Change
_buildManifest.js gzip	492 B	492 B	✓
Overall change	492 B	492 B	✓

Rendered Page Sizes

	vercel/next.js canary	espipj/next.js fix/previewData-Generic-Type	Change
index.html gzip	541 B	541 B	✓
link.html gzip	553 B	553 B	✓
withRouter.html gzip	533 B	533 B	✓
Overall change	1.63 kB	1.63 kB	✓

Webpack 4 Mode (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	espipj/next.js fix/previewData-Generic-Type	Change
buildDuration	11.1s	11.5s	⚠️ +331ms
buildDurationCached	4.7s	4.6s	-81ms
nodeModulesSize	49.1 MB	49.1 MB	⚠️ +146 B

Page Load Tests Overall increase ✓

	vercel/next.js canary	espipj/next.js fix/previewData-Generic-Type	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.795	2.631	-0.16
/ avg req/sec	894.53	950.13	+55.6
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.446	1.48	⚠️ +0.03
/error-in-render avg req/sec	1729.09	1689.42	⚠️ -39.67

Client Bundles (main, webpack, commons)

	vercel/next.js canary	espipj/next.js fix/previewData-Generic-Type	Change
16.HASH.js gzip	186 B	186 B	✓
677f882d2ed8..HASH.js gzip	14.1 kB	14.1 kB	✓
framework.HASH.js gzip	41.9 kB	41.9 kB	✓
main-HASH.js gzip	10.7 kB	10.7 kB	✓
webpack-HASH.js gzip	1.19 kB	1.19 kB	✓
Overall change	68.1 kB	68.1 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	espipj/next.js fix/previewData-Generic-Type	Change
polyfills-a4..dd70.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	espipj/next.js fix/previewData-Generic-Type	Change
_app-HASH.js gzip	964 B	964 B	✓
_error-HASH.js gzip	3.8 kB	3.8 kB	✓
amp-HASH.js gzip	552 B	552 B	✓
css-HASH.js gzip	333 B	333 B	✓
dynamic-HASH.js gzip	2.87 kB	2.87 kB	✓
head-HASH.js gzip	3.06 kB	3.06 kB	✓
hooks-HASH.js gzip	924 B	924 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	3.03 kB	3.03 kB	✓
withRouter-HASH.js gzip	295 B	295 B	✓
30809af5c834..565.css gzip	125 B	125 B	✓
Overall change	18.1 kB	18.1 kB	✓

Client Build Manifests

	vercel/next.js canary	espipj/next.js fix/previewData-Generic-Type	Change
_buildManifest.js gzip	500 B	500 B	✓
Overall change	500 B	500 B	✓

Rendered Page Sizes

	vercel/next.js canary	espipj/next.js fix/previewData-Generic-Type	Change
index.html gzip	584 B	584 B	✓
link.html gzip	596 B	596 B	✓
withRouter.html gzip	577 B	577 B	✓
Overall change	1.76 kB	1.76 kB	✓

Commit: 9d5517c

* 'canary' of github.com:filoblu/next.js: Reuse warning from postcss-loader (vercel#28727) Add RenderResult class (vercel#28776) v11.1.3-canary.8 feat: Adding generic typing for previewData (vercel#28668) Change create-next-app getting started text in TypeScript template (vercel#28718) [ESLint Plugin] Updates `no-document-import-in-page` rule to use `path` separators (vercel#28768) Update to new npm publish token (vercel#28772) Ensure build trace handles mixed modules (vercel#28770)

Adding generic typing for previewData

126cfd0

on GetServerSidePropsContext and GetStaticPropsContext

espipj requested review from huozhi, ijjk, padmaia, shuding, styfle and timneutkens as code owners August 31, 2021 16:51

ijjk added the type: next label Aug 31, 2021

ijjk requested changes Aug 31, 2021

View reviewed changes

espipj added 3 commits September 1, 2021 01:00

Formatting changes

6b28dcd

Added Generics for GetStaticProps and GetServerSideProps

d612618

Modified SSG and SSR integration tests with the new generics

5fe1dc6

This comment has been minimized.

Sign in to view

Fixed tests by mocking previewData as we're on a test env

aebf629

This comment has been minimized.

Sign in to view

styfle reviewed Sep 1, 2021

View reviewed changes

Using consistent name for the generic

0cd879c

This comment has been minimized.

Sign in to view

styfle approved these changes Sep 3, 2021

View reviewed changes

styfle requested a review from ijjk September 3, 2021 19:59

ijjk approved these changes Sep 3, 2021

View reviewed changes

Merge branch 'canary' into fix/previewData-Generic-Type

9d5517c

kodiakhq bot merged commit a8088bf into vercel:canary Sep 3, 2021

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Adding generic typing for previewData #28668

feat: Adding generic typing for previewData #28668

espipj commented Aug 31, 2021

ijjk left a comment

ijjk commented Aug 31, 2021

espipj commented Aug 31, 2021

This comment has been minimized.

ijjk commented Sep 1, 2021

This comment has been minimized.

styfle Sep 1, 2021

espipj Sep 2, 2021

espipj Sep 3, 2021

This comment has been minimized.

styfle left a comment

ijjk commented Sep 3, 2021

feat: Adding generic typing for previewData #28668

feat: Adding generic typing for previewData #28668

Conversation

espipj commented Aug 31, 2021

Feature

ijjk left a comment

Choose a reason for hiding this comment

ijjk commented Aug 31, 2021

espipj commented Aug 31, 2021

This comment has been minimized.

ijjk commented Sep 1, 2021

Failing test suites

This comment has been minimized.

styfle Sep 1, 2021

Choose a reason for hiding this comment

espipj Sep 2, 2021

Choose a reason for hiding this comment

espipj Sep 3, 2021

Choose a reason for hiding this comment

This comment has been minimized.

styfle left a comment

Choose a reason for hiding this comment

ijjk commented Sep 3, 2021

Stats from current PR