provide revalidateReason to getStaticProps

[ztanner]

Provides a revalidateReason argument to getStaticProps ("stale" | "on-demand" | "build").

• Build indicates it was run at build time
• On-demand indicates it was run as a side effect of on-demand revalidation
• Stale indicates the resource was considered stale (either due to being in dev mode, or an expired revalidate period)

This will allow changing behavior based on the context in which it's called.

Closes NEXT-1900

[ztanner]

• provide revalidateReason to getStaticProps #64258 👈
• canary

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @ztanner and the rest of your teammates on Graphite

[ijjk]

Tests Passed

[ijjk]

Stats from current PR

Default Build (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	vercel/next.js 04-09-provide_revalidateReason_to_getStaticProps	Change
buildDuration	14s	14.1s	N/A
buildDurationCached	7.4s	6.2s	N/A
nodeModulesSize	199 MB	199 MB	⚠️ +2.68 kB
nextStartRea..uration (ms)	396ms	400ms	N/A

Client Bundles (main, webpack)

	vercel/next.js canary	vercel/next.js 04-09-provide_revalidateReason_to_getStaticProps	Change
2453-HASH.js gzip	31.4 kB	31.4 kB	N/A
3304.HASH.js gzip	181 B	181 B	✓
3f784ff6-HASH.js gzip	53.7 kB	53.7 kB	✓
8299-HASH.js gzip	5.05 kB	5.05 kB	N/A
framework-HASH.js gzip	45.2 kB	45.2 kB	✓
main-app-HASH.js gzip	242 B	236 B	N/A
main-HASH.js gzip	32.2 kB	32.2 kB	N/A
webpack-HASH.js gzip	1.68 kB	1.68 kB	N/A
Overall change	99 kB	99 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	vercel/next.js 04-09-provide_revalidateReason_to_getStaticProps	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	vercel/next.js 04-09-provide_revalidateReason_to_getStaticProps	Change
_app-HASH.js gzip	196 B	197 B	N/A
_error-HASH.js gzip	184 B	184 B	✓
amp-HASH.js gzip	505 B	505 B	✓
css-HASH.js gzip	324 B	325 B	N/A
dynamic-HASH.js gzip	2.5 kB	2.5 kB	N/A
edge-ssr-HASH.js gzip	258 B	258 B	✓
head-HASH.js gzip	352 B	352 B	✓
hooks-HASH.js gzip	370 B	371 B	N/A
image-HASH.js gzip	4.22 kB	4.22 kB	N/A
index-HASH.js gzip	259 B	259 B	✓
link-HASH.js gzip	2.67 kB	2.67 kB	N/A
routerDirect..HASH.js gzip	314 B	312 B	N/A
script-HASH.js gzip	386 B	386 B	✓
withRouter-HASH.js gzip	309 B	309 B	✓
1afbb74e6ecf..834.css gzip	106 B	106 B	✓
Overall change	2.36 kB	2.36 kB	✓

Client Build Manifests

	vercel/next.js canary	vercel/next.js 04-09-provide_revalidateReason_to_getStaticProps	Change
_buildManifest.js gzip	483 B	485 B	N/A
Overall change	0 B	0 B	✓

Rendered Page Sizes

	vercel/next.js canary	vercel/next.js 04-09-provide_revalidateReason_to_getStaticProps	Change
index.html gzip	529 B	529 B	✓
link.html gzip	542 B	541 B	N/A
withRouter.html gzip	524 B	523 B	N/A
Overall change	529 B	529 B	✓

Edge SSR bundle Size

	vercel/next.js canary	vercel/next.js 04-09-provide_revalidateReason_to_getStaticProps	Change
edge-ssr.js gzip	95.4 kB	95.4 kB	N/A
page.js gzip	3.06 kB	3.06 kB	N/A
Overall change	0 B	0 B	✓

Middleware size

	vercel/next.js canary	vercel/next.js 04-09-provide_revalidateReason_to_getStaticProps	Change
middleware-b..fest.js gzip	625 B	626 B	N/A
middleware-r..fest.js gzip	151 B	151 B	✓
middleware.js gzip	25.5 kB	25.5 kB	N/A
edge-runtime..pack.js gzip	839 B	839 B	✓
Overall change	990 B	990 B	✓

Next Runtimes

	vercel/next.js canary	vercel/next.js 04-09-provide_revalidateReason_to_getStaticProps	Change
app-page-exp...dev.js gzip	170 kB	170 kB	✓
app-page-exp..prod.js gzip	97.3 kB	97.3 kB	✓
app-page-tur..prod.js gzip	99.1 kB	99.1 kB	✓
app-page-tur..prod.js gzip	93.3 kB	93.3 kB	✓
app-page.run...dev.js gzip	144 kB	144 kB	✓
app-page.run..prod.js gzip	91.8 kB	91.8 kB	✓
app-route-ex...dev.js gzip	21.4 kB	21.4 kB	✓
app-route-ex..prod.js gzip	15.1 kB	15.1 kB	✓
app-route-tu..prod.js gzip	15.1 kB	15.1 kB	✓
app-route-tu..prod.js gzip	14.9 kB	14.9 kB	✓
app-route.ru...dev.js gzip	21.1 kB	21.1 kB	✓
app-route.ru..prod.js gzip	14.9 kB	14.9 kB	✓
pages-api-tu..prod.js gzip	9.55 kB	9.55 kB	✓
pages-api.ru...dev.js gzip	9.82 kB	9.82 kB	✓
pages-api.ru..prod.js gzip	9.55 kB	9.55 kB	✓
pages-turbo...prod.js gzip	22.5 kB	22.5 kB	N/A
pages.runtim...dev.js gzip	23.1 kB	23.1 kB	N/A
pages.runtim..prod.js gzip	22.4 kB	22.5 kB	N/A
server.runti..prod.js gzip	51.1 kB	51.1 kB	✓
Overall change	879 kB	879 kB	✓

build cache Overall increase ⚠️

	vercel/next.js canary	vercel/next.js 04-09-provide_revalidateReason_to_getStaticProps	Change
0.pack gzip	1.58 MB	1.58 MB	N/A
index.pack gzip	106 kB	107 kB	⚠️ +358 B
Overall change	106 kB	107 kB	⚠️ +358 B

Diff details

Diff for middleware.js

Diff too large to display

Diff for edge-ssr.js

Diff too large to display

Diff for main-app-HASH.js

@@ -1,52 +1,53 @@
 (self["webpackChunk_N_E"] = self["webpackChunk_N_E"] || []).push([
   [1744],
-  {
-    /***/ 3923: /***/ function (
+  [
+    /* 0 */
+    /***/ function (
       __unused_webpack_module,
       __unused_webpack_exports,
       __webpack_require__
     ) {
       Promise.resolve(/* import() eager */).then(
-        __webpack_require__.t.bind(__webpack_require__, 3880, 23)
+        __webpack_require__.t.bind(__webpack_require__, 9832, 23)
       );
       Promise.resolve(/* import() eager */).then(
-        __webpack_require__.t.bind(__webpack_require__, 9489, 23)
+        __webpack_require__.t.bind(__webpack_require__, 7756, 23)
       );
       Promise.resolve(/* import() eager */).then(
-        __webpack_require__.t.bind(__webpack_require__, 8247, 23)
+        __webpack_require__.t.bind(__webpack_require__, 7409, 23)
       );
       Promise.resolve(/* import() eager */).then(
-        __webpack_require__.t.bind(__webpack_require__, 7769, 23)
+        __webpack_require__.t.bind(__webpack_require__, 3711, 23)
       );
       Promise.resolve(/* import() eager */).then(
-        __webpack_require__.t.bind(__webpack_require__, 287, 23)
+        __webpack_require__.t.bind(__webpack_require__, 8725, 23)
       );
       Promise.resolve(/* import() eager */).then(
-        __webpack_require__.t.bind(__webpack_require__, 5070, 23)
+        __webpack_require__.t.bind(__webpack_require__, 615, 23)
       );
       Promise.resolve(/* import() eager */).then(
-        __webpack_require__.t.bind(__webpack_require__, 5768, 23)
+        __webpack_require__.t.bind(__webpack_require__, 3035, 23)
       );
       Promise.resolve(/* import() eager */).then(
-        __webpack_require__.t.bind(__webpack_require__, 3738, 23)
+        __webpack_require__.t.bind(__webpack_require__, 8456, 23)
       );
       Promise.resolve(/* import() eager */).then(
-        __webpack_require__.bind(__webpack_require__, 8568)
+        __webpack_require__.bind(__webpack_require__, 2499)
       );
       Promise.resolve(/* import() eager */).then(
-        __webpack_require__.t.bind(__webpack_require__, 2360, 23)
+        __webpack_require__.t.bind(__webpack_require__, 162, 23)
       );
 
       /***/
     },
-  },
+  ],
   /******/ function (__webpack_require__) {
     // webpackRuntimeModules
     /******/ var __webpack_exec__ = function (moduleId) {
       return __webpack_require__((__webpack_require__.s = moduleId));
     };
-    /******/ __webpack_require__.O(0, [1904, 2453], function () {
-      return __webpack_exec__(733), __webpack_exec__(3923);
+    /******/ __webpack_require__.O(0, [5658, 6901], function () {
+      return __webpack_exec__(1428), __webpack_exec__(0);
     });
     /******/ var __webpack_exports__ = __webpack_require__.O();
     /******/ _N_E = __webpack_exports__;

Diff for pages-turbo...time.prod.js

Diff too large to display

Diff for pages.runtime.dev.js

Diff too large to display

Diff for pages.runtime.prod.js

Diff too large to display

Commit: 9954c92

[ijjk]

Thanks!