feat(gatsby): Add activity for writing out page-data.json files to th…

…e public directory (#31987)

Co-authored-by: Ward Peeters <ward@coding-tech.com>
Co-authored-by: gatsbybot <mathews.kyle+gatsbybot@gmail.com>

packages/gatsby/src/utils/__tests__/get-page-data.ts

@@ -37,6 +37,18 @@ jest.mock(`fs-extra`, () => {
   }
 })
 
+jest.mock(`gatsby-cli/lib/reporter`, () => {
+  return {
+    createProgress: (): any => {
+      return {
+        start: jest.fn(),
+        tick: jest.fn(),
+        end: jest.fn(),
+      }
+    },
+  }
+})
+
 describe(`get-page-data-util`, () => {
   const queryResultContent = {
     data: {

packages/gatsby/src/utils/page-data.ts

@@ -136,7 +136,12 @@ export async function flush(): Promise<void> {
 
   const { pagePaths } = pendingPageDataWrites
 
-  const pagesToWrite = pagePaths.values()
+  const writePageDataActivity = reporter.createProgress(
+    `Writing page-data.json files to public directory`,
+    pagePaths.size,
+    0
+  )
+  writePageDataActivity.start()
 
   const flushQueue = fastq(async (pagePath, cb) => {
     const page = pages.get(pagePath)
@@ -181,6 +186,8 @@ export async function flush(): Promise<void> {
         }
       )
 
+      writePageDataActivity.tick()
+
       if (program?._?.[0] === `develop`) {
         websocketManager.emitPageData({
           id: pagePath,
@@ -199,7 +206,7 @@ export async function flush(): Promise<void> {
     return cb(null, true)
   }, 25)
 
-  for (const pagePath of pagesToWrite) {
+  for (const pagePath of pagePaths) {
     flushQueue.push(pagePath, () => {})
   }
 
@@ -209,7 +216,9 @@ export async function flush(): Promise<void> {
     })
   }
 
+  writePageDataActivity.end()
   isFlushing = false
+
   return
 }