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.

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-recipes): Add GatsbyPage provider #25248

Merged
merged 9 commits into from
Jul 9, 2020
Merged
2 changes: 1 addition & 1 deletion packages/gatsby-core-utils/src/service-lock.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ const lockfileOptions = {
stale: 5000,
}

type UnlockFn = () => Promise<void>
export type UnlockFn = () => Promise<void>

const memoryServices = {}
export const createServiceLock = async (
Expand Down
40 changes: 40 additions & 0 deletions packages/gatsby-recipes/src/create-types.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@ test(`create-types`, () => {
"resolve": [Function],
"type": "File",
},
"createGatsbyPage": Object {
"args": Object {
"gatsbyPage": Object {
"type": "GatsbyPageInput",
},
},
"resolve": [Function],
"type": "GatsbyPage",
},
"createGatsbyPlugin": Object {
"args": Object {
"gatsbyPlugin": Object {
Expand Down Expand Up @@ -94,6 +103,15 @@ test(`create-types`, () => {
"resolve": [Function],
"type": "File",
},
"destroyGatsbyPage": Object {
"args": Object {
"gatsbyPage": Object {
"type": "GatsbyPageInput",
},
},
"resolve": [Function],
"type": "GatsbyPage",
},
"destroyGatsbyPlugin": Object {
"args": Object {
"gatsbyPlugin": Object {
Expand Down Expand Up @@ -166,6 +184,15 @@ test(`create-types`, () => {
"resolve": [Function],
"type": "File",
},
"updateGatsbyPage": Object {
"args": Object {
"gatsbyPage": Object {
"type": "GatsbyPageInput",
},
},
"resolve": [Function],
"type": "GatsbyPage",
},
"updateGatsbyPlugin": Object {
"args": Object {
"gatsbyPlugin": Object {
Expand Down Expand Up @@ -224,6 +251,10 @@ test(`create-types`, () => {
`)
expect(result.queryTypes).toMatchInlineSnapshot(`
Object {
"allGatsbyPage": Object {
"resolve": [Function],
"type": "GatsbyPageConnection",
},
"allGatsbyPlugin": Object {
"resolve": [Function],
"type": "GatsbyPluginConnection",
Expand Down Expand Up @@ -258,6 +289,15 @@ test(`create-types`, () => {
"resolve": [Function],
"type": "File",
},
"gatsbyPage": Object {
"args": Object {
"id": Object {
"type": "String",
},
},
"resolve": [Function],
"type": "GatsbyPage",
},
"gatsbyPlugin": Object {
"args": Object {
"id": Object {
Expand Down
105 changes: 105 additions & 0 deletions packages/gatsby-recipes/src/providers/gatsby/page.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
const Joi = require(`@hapi/joi`)
const { getService } = require(`gatsby-core-utils/dist/service-lock`)
const fetch = require(`node-fetch`)

const { REQUIRES_KEYS } = require(`./utils/constants`)
const resourceSchema = require(`../resource-schema`)

module.exports.create = () => {}
module.exports.update = () => {}
module.exports.read = async ({ root }, id) => {
const result = await queryDevelopAPI(
{ root },
`
{
sitePage(id: { eq: "${id}" }) {
path
component
internalComponentName
componentChunkName
matchPath
id
componentPath
isCreatedByStatefulCreatePages
}
}
`
)

return result.data.sitePage
}
module.exports.destroy = () => {}
module.exports.config = {}

const queryDevelopAPI = async ({ root }, query) => {
const { port } = await getService(root, `developproxy`)

return fetch(`http://localhost:${port}/___graphql`, {
mxstbr marked this conversation as resolved.
Show resolved Hide resolved
method: `POST`,
body: JSON.stringify({
query,
}),
headers: {
Accept: `application/json`,
"Content-Type": `application/json`,
},
}).then(res => res.json())
}

module.exports.all = async ({ root }) => {
const result = await queryDevelopAPI(
{ root },
`
{
allSitePage {
nodes {
path
component
internalComponentName
componentChunkName
matchPath
id
componentPath
isCreatedByStatefulCreatePages
}
}
}
`
)

return result.data.allSitePage.nodes
}
const schema = {
internalComponentName: Joi.string(),
path: Joi.string(),
matchPath: Joi.string().optional(),
component: Joi.string(),
componentChunkName: Joi.string(),
isCreatedByStatefulCreatePages: Joi.boolean(),
pluginCreatorId: Joi.string(),
componentPath: Joi.string(),
...resourceSchema,
}

const validate = resource => {
if (REQUIRES_KEYS.includes(resource.name) && !resource.key) {
return {
error: `${resource.name} requires a key to be set`,
}
}

if (resource.key && resource.key === resource.name) {
return {
error: `${resource.name} requires a key to be different than the plugin name`,
}
}

return Joi.validate(resource, schema, { abortEarly: false })
}

exports.schema = schema
exports.validate = validate

module.exports.plan = async () => {
return {}
}
2 changes: 2 additions & 0 deletions packages/gatsby-recipes/src/resources.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
const fileResource = require(`./providers/fs/file`)
const directoryResource = require(`./providers/fs/directory`)
const gatsbyPageResource = require(`./providers/gatsby/page`)
const gatsbyPluginResource = require(`./providers/gatsby/plugin`)
const gatsbyShadowFileResource = require(`./providers/gatsby/shadow-file`)
const npmPackageResource = require(`./providers/npm/package`)
Expand All @@ -10,6 +11,7 @@ const gitIgnoreResource = require(`./providers/git/ignore`)
const componentResourceMapping = {
File: fileResource,
Directory: directoryResource,
GatsbyPage: gatsbyPageResource,
GatsbyPlugin: gatsbyPluginResource,
GatsbyShadowFile: gatsbyShadowFileResource,
NPMPackage: npmPackageResource,
Expand Down
26 changes: 20 additions & 6 deletions packages/gatsby/src/commands/develop.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ 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 { UnlockFn } from "gatsby-core-utils/src/service-lock"
import reporter from "gatsby-cli/lib/reporter"
import getSslCert from "../utils/get-ssl-cert"
import { startDevelopProxy } from "../utils/develop-proxy"
Expand Down Expand Up @@ -170,18 +171,31 @@ module.exports = async (program: IProgram): Promise<void> => {
cmd(args);
`)

let unlock
let unlocks: Array<UnlockFn> = []
if (!isCI()) {
unlock = await createServiceLock(program.directory, `developstatusserver`, {
port: statusServerPort,
})
const statusUnlock = await createServiceLock(
program.directory,
`developstatusserver`,
{
port: statusServerPort,
}
)
const developUnlock = await createServiceLock(
program.directory,
`developproxy`,
{
port: proxyPort,
}
)

if (!unlock) {
if (!statusUnlock || !developUnlock) {
console.error(
`Looks like develop for this site is already running. Try visiting http://localhost:8000/ maybe?`
)
process.exit(1)
}

unlocks = unlocks.concat([statusUnlock, developUnlock])
}

const statusServer = http.createServer().listen(statusServerPort)
Expand Down Expand Up @@ -260,7 +274,7 @@ module.exports = async (program: IProgram): Promise<void> => {
process.on(`beforeExit`, async () => {
await Promise.all([
watcher?.close(),
unlock?.(),
...unlocks.map(unlock => unlock()),
new Promise(resolve => {
statusServer.close(resolve)
}),
Expand Down