feat(gatsby): Store site metadata (#26162)

Store pid

Allow lockfile to be ignored for services that don't need to be running

Get correct port for running service

Add last run time

init site info in gatsby new

Store metadata on build

Make getService generic so we can avoid casting

Log exception

Co-authored-by: gatsbybot <[email protected]>

Author: ascorbic

packages/gatsby-cli/src/init-starter.ts

@@ -9,10 +9,11 @@ import isValid from "is-valid-path"
 import sysPath from "path"
 import prompts from "prompts"
 import url from "url"
-
+import { createServiceLock } from "gatsby-core-utils/dist/service-lock"
 import report from "./reporter"
 import { getPackageManager, promptPackageManager } from "./util/package-manager"
 import { isTTY } from "./util/is-tty"
+import reporter from "../lib/reporter"
 
 const spawnWithArgs = (
   file: string,
@@ -341,8 +342,28 @@ export async function initStarter(
   trackCli(`NEW_PROJECT`, {
     starterName: hostedInfo ? hostedInfo.shortcut() : `local:starter`,
   })
-  if (hostedInfo) await clone(hostedInfo, rootPath)
-  else await copy(starterPath, rootPath)
+  if (hostedInfo) {
+    await clone(hostedInfo, rootPath)
+  } else {
+    await copy(starterPath, rootPath)
+  }
+
+  const sitePath = sysPath.resolve(rootPath)
+
+  const sitePackageJson = await fs
+    .readJSON(sysPath.join(sitePath, `package.json`))
+    .catch(() => {
+      reporter.verbose(
+        `Could not read "${sysPath.join(sitePath, `package.json`)}"`
+      )
+    })
+
+  await createServiceLock(sitePath, `metadata`, {
+    name: sitePackageJson?.name || rootPath,
+    sitePath,
+    lastRun: Date.now(),
+  }).then(unlock => unlock?.())
+
   successMessage(rootPath)
   trackCli(`NEW_PROJECT_END`)
 }

packages/gatsby-core-utils/src/service-lock.ts

@@ -66,17 +66,21 @@ export const createServiceLock = async (
   }
 }
 
-export const getService = async (
+export const getService = async <T = Record<string, unknown>>(
   programPath: string,
-  serviceName: string
-): Promise<string | null> => {
+  serviceName: string,
+  ignoreLockfile: boolean = false
+): Promise<T | null> => {
   if (isCI()) return memoryServices[serviceName] || null
 
   const siteDir = getSiteDir(programPath)
   const serviceDataFile = getDataFilePath(siteDir, serviceName)
 
   try {
-    if (await lockfile.check(serviceDataFile, lockfileOptions)) {
+    if (
+      ignoreLockfile ||
+      (await lockfile.check(serviceDataFile, lockfileOptions))
+    ) {
       return JSON.parse(
         await fs.readFile(serviceDataFile, `utf8`).catch(() => `null`)
       )

packages/gatsby/src/commands/build.ts

@@ -36,6 +36,7 @@ import {
   markWebpackStatusAsPending,
   markWebpackStatusAsDone,
 } from "../utils/webpack-status"
+import { createServiceLock } from "gatsby-core-utils/dist/service-lock"
 
 let cachedPageData
 let cachedWebpackCompilationHash
@@ -63,6 +64,12 @@ module.exports = async function build(program: IBuildArgs): Promise<void> {
     )
   }
 
+  await createServiceLock(program.directory, `metadata`, {
+    name: program.sitePackageJson.name,
+    sitePath: program.directory,
+    lastRun: Date.now(),
+  }).then(unlock => unlock?.())
+
   markWebpackStatusAsPending()
 
   const publicDir = path.join(program.directory, `public`)

packages/gatsby/src/commands/develop.ts

@@ -9,7 +9,10 @@ import { detectPortInUseAndPrompt } from "../utils/detect-port-in-use-and-prompt
 import socket from "socket.io"
 import fs from "fs-extra"
 import { isCI, slash } from "gatsby-core-utils"
-import { createServiceLock } from "gatsby-core-utils/dist/service-lock"
+import {
+  createServiceLock,
+  getService,
+} from "gatsby-core-utils/dist/service-lock"
 import { UnlockFn } from "gatsby-core-utils/src/service-lock"
 import reporter from "gatsby-cli/lib/reporter"
 import { getSslCert } from "../utils/get-ssl-cert"
@@ -265,10 +268,19 @@ module.exports = async (program: IProgram): Promise<void> => {
         port: proxyPort,
       }
     )
+    // We don't need to keep a lock on this, as it's just site metadata
+    await createServiceLock(program.directory, `metadata`, {
+      name: program.sitePackageJson.name,
+      sitePath: program.directory,
+      pid: process.pid,
+      lastRun: Date.now(),
+    }).then(unlock => unlock?.())
 
     if (!statusUnlock || !developUnlock) {
+      const data = await getService(program.directory, `developproxy`)
+      const port = data?.port || 8000
       console.error(
-        `Looks like develop for this site is already running. Try visiting http://localhost:8000/ maybe?`
+        `Looks like develop for this site is already running. Try visiting http://localhost:${port}/ maybe?`
       )
       process.exit(1)
     }