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.

Sign up for GitHub

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

feat(gatsby): decouple html activities #28648

Merged
merged 1 commit into from
Dec 16, 2020
Merged

feat(gatsby): decouple html activities #28648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions packages/gatsby/src/commands/build-html.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ export const buildRenderer = async (
return doBuildRenderer(program, config, stage)
}

const deleteRenderer = async (rendererPath: string): Promise<void> => {
export const deleteRenderer = async (rendererPath: string): Promise<void> => {
try {
await fs.remove(rendererPath)
await fs.remove(`${rendererPath}.map`)
Expand Down Expand Up @@ -143,7 +143,7 @@ class BuildHTMLError extends Error {
}
}

const doBuildPages = async (
export const doBuildPages = async (
rendererPath: string,
pagePaths: Array<string>,
activity: IActivity,
Expand All @@ -166,6 +166,7 @@ const doBuildPages = async (
}
}

// TODO remove in v4 - this could be a "public" api
export const buildHTML = async ({
program,
stage,
Expand All @@ -181,7 +182,5 @@ export const buildHTML = async ({
}): Promise<void> => {
const rendererPath = await buildRenderer(program, stage, activity.span)
await doBuildPages(rendererPath, pagePaths, activity, workerPool)
if (stage !== `develop-html`) {
await deleteRenderer(rendererPath)
}
await deleteRenderer(rendererPath)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is now done inside start-server

}
33 changes: 26 additions & 7 deletions packages/gatsby/src/commands/build.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import signalExit from "signal-exit"
import fs from "fs-extra"
import telemetry from "gatsby-telemetry"

import { buildHTML } from "./build-html"
import { doBuildPages, buildRenderer, deleteRenderer } from "./build-html"
import { buildProductionBundle } from "./build-javascript"
import { bootstrap } from "../bootstrap"
import apiRunnerNode from "../utils/api-runner-node"
Expand Down Expand Up @@ -231,6 +231,20 @@ module.exports = async function build(program: IBuildArgs): Promise<void> {
}
}

const buildSSRBundleActivityProgress = report.activityTimer(
`Building HTML renderer`,
{ parentSpan: buildSpan }
)
buildSSRBundleActivityProgress.start()
let pageRenderer: string
try {
pageRenderer = await buildRenderer(program, Stage.BuildHTML, buildSpan)
} catch (err) {
buildActivityTimer.panic(structureWebpackErrors(Stage.BuildHTML, err))
} finally {
buildSSRBundleActivityProgress.end()
}

const buildHTMLActivityProgress = report.createProgress(
`Building static HTML for pages`,
pagePaths.length,
Expand All @@ -241,13 +255,12 @@ module.exports = async function build(program: IBuildArgs): Promise<void> {
)
buildHTMLActivityProgress.start()
try {
await buildHTML({
program,
stage: Stage.BuildHTML,
await doBuildPages(
pageRenderer,
pagePaths,
activity: buildHTMLActivityProgress,
workerPool,
})
buildHTMLActivityProgress,
workerPool
)
} catch (err) {
let id = `95313` // TODO: verify error IDs exist
const context = {
Expand All @@ -271,6 +284,12 @@ module.exports = async function build(program: IBuildArgs): Promise<void> {
}
buildHTMLActivityProgress.end()

try {
await deleteRenderer(pageRenderer)
} catch (err) {
// pass through
}

let deletedPageKeys: Array<string> = []
if (process.env.GATSBY_EXPERIMENTAL_PAGE_BUILD_ON_DATA_CHANGES) {
const deletePageDataActivityTimer = report.activityTimer(
Expand Down
18 changes: 9 additions & 9 deletions packages/gatsby/src/utils/start-server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,16 +113,15 @@ module.exports = {

// Remove the following when merging GATSBY_EXPERIMENTAL_DEV_SSR
const directoryPath = withBasePath(directory)
const { buildHTML } = require(`../commands/build-html`)
const { buildRenderer, doBuildPages } = require(`../commands/build-html`)
const createIndexHtml = async (activity: ActivityTracker): Promise<void> => {
try {
await buildHTML({
const rendererPath = await buildRenderer(
program,
stage: Stage.DevelopHTML,
pagePaths: [`/`],
workerPool,
activity,
})
Stage.DevelopHTML,
activity.span
)
await doBuildPages(rendererPath, [`/`], activity, workerPool)
} catch (err) {
if (err.name !== `WebpackError`) {
report.panic(err)
Expand All @@ -139,9 +138,10 @@ module.exports = {
}
const indexHTMLActivity = report.phantomActivity(`building index.html`, {})

let pageRenderer: string
if (process.env.GATSBY_EXPERIMENTAL_DEV_SSR) {
const { buildRenderer } = require(`../commands/build-html`)
await buildRenderer(program, Stage.DevelopHTML)
pageRenderer = await buildRenderer(program, Stage.DevelopHTML)
const { initDevWorkerPool } = require(`./dev-ssr/render-dev-html`)
initDevWorkerPool()
} else {
Expand Down Expand Up @@ -495,7 +495,7 @@ module.exports = {
// Let renderDevHTML figure it out.
page: undefined,
store,
htmlComponentRendererPath: `${program.directory}/public/render-page.js`,
htmlComponentRendererPath: pageRenderer,
Copy link
Contributor

Choose a reason for hiding this comment

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

I think pageRenderer will be undefined here for the else codepath on lines 147-153:

 let pageRenderer: string
  if (process.env.GATSBY_EXPERIMENTAL_DEV_SSR) {
    // ...
    pageRenderer = await buildRenderer(program, Stage.DevelopHTML)
    // ...
  } else {
    // we don't set `pageRenderer` value in this codepath

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It should be in the same process.env.GATSBY_EXPERIMENTAL_DEV_SSR, right? I've tested it and didn't have an issue.

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh, true. Didn't see the this if. Still surprised TS doesn't complain about this. But it's probably because renderDevHTML is not fully typed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good point 😂

directory: program.directory,
})
const status = process.env.GATSBY_EXPERIMENTAL_DEV_SSR ? 404 : 200
Expand Down