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: decoupled sourcing PoC #561

Draft
wants to merge 18 commits into
base: main
Choose a base branch
from
Draft

feat: decoupled sourcing PoC #561

wants to merge 18 commits into from

Conversation

ascorbic
Copy link
Contributor

@ascorbic ascorbic commented Feb 10, 2023

Summary

PoC for experimental decoupled sourcing support. Test this by installing @netlify/plugin-gatsby@merlin and then setting the env vars GATSBY_CLOUD_DATALAYER, CONTENT_CLOUD_ID and RESOURCE_AUTH_JWT

Test plan

  1. Visit the Deploy Preview (insert link to specific page) ...

Relevant links (GitHub issues, Notion docs, etc.) or a picture of cute animal

Standard checks:

  • Check the Deploy Preview's Demo site for your PR's functionality
  • Add docs when necessary

🧪 Once merged, make sure to update the version if needed and that it was
published correctly.

@netlify
Copy link

netlify bot commented Feb 10, 2023

Deploy Preview for netlify-plugin-gatsby-demo ready!

Name Link
🔨 Latest commit 71db642
🔍 Latest deploy log https://app.netlify.com/sites/netlify-plugin-gatsby-demo/deploys/63f4ed8a55c16a0008a4abe3
😎 Deploy Preview https://deploy-preview-561--netlify-plugin-gatsby-demo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@@ -40,6 +40,7 @@
"prepare": "npm run build"
},
"dependencies": {
"@gatsby-cloud-pkg/merlin-synchronizer": "^0.3.6",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adding it as a dep of the plugin should make it resolvable to builds, but we can do tests with auto-install using feature flags later

Comment on lines 33 to 37
if (
!process.env.GATSBY_CLOUD_DATALAYER ||
!process.env.GATSBY_SITE_ID ||
!process.env.SITE_AUTH_JWT
) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

These currently need to be manually set

Choose a reason for hiding this comment

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

instead of SITE_AUTH_JWT, can we make it RESOURCE_AUTH_JWT

Choose a reason for hiding this comment

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

and instead of GATSBY_SITE_ID lets do CONTENT_CLOUD_ID

Copy link
Contributor Author

Choose a reason for hiding this comment

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

SITE_AUTH_JWT is for merlin-synchronizer, so we'd need to change that module to allow either

* This file was copied from Gatsby core and modified and will be copied back into node_modules/gatsby when Netlify does a cold-cache build.
* See 'helpers/files.ts'
*/

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 injected file is copied from the Gatsby repo with a few small changes to work on Netlify

return originalSourceNodesApiRunner.sourceNodesApiRunner(args)
}

const { synchronize } = require(`@gatsby-cloud-pkg/merlin-synchronizer`)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We may need to replace this with a full resolved path to the dependency if resolving from an auto-installed plugin fails

encoding: `string`,
}).init()

const siteId = process.env.GATSBY_SITE_ID
Copy link

@abhiaiyer91 abhiaiyer91 Feb 10, 2023

Choose a reason for hiding this comment

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

this will be CONTENT_CLOUD_ID

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants