feat(graph): allow sharing VCS branches through a lockfile (#4899)

* feat(graph): allow sharing VCS branches through a lockfile * fix: sean's review comments * fix: generate docs * fix(graph:pull): make sure there's a session before fetching schema * fix(tests): update graph snapshots * fix(deps): upgrade onegraph-internal with lockfile support * fix: remove wrong optimization
netlify · Aug 4, 2022 · ad84a46 · ad84a46 · github-actions · Aug 4, 2022
1 parent b3dc897
commit ad84a46
Show file tree

Hide file tree

Showing 13 changed files with 232 additions and 44 deletions.
diff --git a/README.md b/README.md
@@ -165,7 +165,7 @@ Manage netlify functions
 | [`graph:init`](/docs/commands/graph.md#graphinit) | Initialize all the resources for Netlify Graph  |
 | [`graph:library`](/docs/commands/graph.md#graphlibrary) | Generate the Graph function library  |
 | [`graph:operations`](/docs/commands/graph.md#graphoperations) | List all of the locally available operations  |
-| [`graph:pull`](/docs/commands/graph.md#graphpull) | Pull down your local Netlify Graph schema, and process pending Graph edit events  |
+| [`graph:pull`](/docs/commands/graph.md#graphpull) | Pull your remote Netlify Graph schema locally, and process pending Graph edit events  |
 
 
 ### [init](/docs/commands/init.md)

diff --git a/docs/README.md b/docs/README.md
@@ -121,7 +121,7 @@ Manage netlify functions
 | [`graph:init`](/docs/commands/graph.md#graphinit) | Initialize all the resources for Netlify Graph  |
 | [`graph:library`](/docs/commands/graph.md#graphlibrary) | Generate the Graph function library  |
 | [`graph:operations`](/docs/commands/graph.md#graphoperations) | List all of the locally available operations  |
-| [`graph:pull`](/docs/commands/graph.md#graphpull) | Pull down your local Netlify Graph schema, and process pending Graph edit events  |
+| [`graph:pull`](/docs/commands/graph.md#graphpull) | Pull your remote Netlify Graph schema locally, and process pending Graph edit events  |
 
 
 ### [init](/docs/commands/init.md)

diff --git a/docs/commands/graph.md b/docs/commands/graph.md
@@ -28,7 +28,7 @@ netlify graph
 | [`graph:init`](/docs/commands/graph.md#graphinit) | Initialize all the resources for Netlify Graph  |
 | [`graph:library`](/docs/commands/graph.md#graphlibrary) | Generate the Graph function library  |
 | [`graph:operations`](/docs/commands/graph.md#graphoperations) | List all of the locally available operations  |
-| [`graph:pull`](/docs/commands/graph.md#graphpull) | Pull down your local Netlify Graph schema, and process pending Graph edit events  |
+| [`graph:pull`](/docs/commands/graph.md#graphpull) | Pull your remote Netlify Graph schema locally, and process pending Graph edit events  |
 
 
 **Examples**
@@ -147,7 +147,7 @@ netlify graph:operations
 ---
 ## `graph:pull`
 
-Pull down your local Netlify Graph schema, and process pending Graph edit events
+Pull your remote Netlify Graph schema locally, and process pending Graph edit events
 
 **Usage**
 

diff --git a/docs/commands/index.md b/docs/commands/index.md
@@ -102,7 +102,7 @@ Manage netlify functions
 | [`graph:init`](/docs/commands/graph.md#graphinit) | Initialize all the resources for Netlify Graph  |
 | [`graph:library`](/docs/commands/graph.md#graphlibrary) | Generate the Graph function library  |
 | [`graph:operations`](/docs/commands/graph.md#graphoperations) | List all of the locally available operations  |
-| [`graph:pull`](/docs/commands/graph.md#graphpull) | Pull down your local Netlify Graph schema, and process pending Graph edit events  |
+| [`graph:pull`](/docs/commands/graph.md#graphpull) | Pull your remote Netlify Graph schema locally, and process pending Graph edit events  |
 
 
 ### [init](/docs/commands/init.md)

diff --git a/npm-shrinkwrap.json b/npm-shrinkwrap.json
diff --git a/package.json b/package.json
@@ -291,7 +291,7 @@
     "multiparty": "^4.2.1",
     "netlify": "^12.0.0",
     "netlify-headers-parser": "^6.0.2",
-    "netlify-onegraph-internal": "0.4.1",
+    "netlify-onegraph-internal": "0.4.2",
     "netlify-redirect-parser": "^13.0.5",
     "netlify-redirector": "^0.2.1",
     "node-fetch": "^2.6.0",

diff --git a/src/commands/graph/graph-edit.js b/src/commands/graph/graph-edit.js
@@ -48,6 +48,7 @@ const graphEdit = async (options, command) => {
     netlifyToken,
     site,
     state,
+    netlifyGraphConfig,
   })
 
   const { branch } = gitRepoInfo()

diff --git a/src/commands/graph/graph-init.js b/src/commands/graph/graph-init.js
@@ -5,6 +5,7 @@ const { OneGraphClient } = require('netlify-onegraph-internal')
 const { v4: uuidv4 } = require('uuid')
 
 const { OneGraphCliClient, ensureCLISession } = require('../../lib/one-graph/cli-client')
+const { getNetlifyGraphConfig } = require('../../lib/one-graph/cli-netlify-graph')
 const { NETLIFYDEVERR, chalk, error, exit, getToken, log } = require('../../utils')
 const { msg } = require('../login/login')
 
@@ -63,11 +64,13 @@ const graphInit = async (options, command) => {
 
   await ensureAppForSite(netlifyToken, siteId)
 
+  const netlifyGraphConfig = await getNetlifyGraphConfig({ command, options })
   await ensureCLISession({
     metadata: {},
     netlifyToken,
     site,
     state,
+    netlifyGraphConfig,
   })
 
   let envChanged = false

diff --git a/src/commands/graph/graph-library.js b/src/commands/graph/graph-library.js
@@ -1,4 +1,5 @@
 // @ts-check
+const { readLockfile } = require('../../lib/one-graph/cli-client')
 const {
   buildSchema,
   defaultExampleOperationsDoc,
@@ -9,7 +10,7 @@ const {
   readGraphQLOperationsSourceFile,
   readGraphQLSchemaFile,
 } = require('../../lib/one-graph/cli-netlify-graph')
-const { error, log } = require('../../utils')
+const { NETLIFYDEVERR, chalk, error, log } = require('../../utils')
 
 /**
  * Creates the `netlify graph:library` command
@@ -42,10 +43,23 @@ const graphLibrary = async (options, command) => {
   const parsedDoc = parse(currentOperationsDoc)
   const { fragments, functions } = extractFunctionsFromOperationDoc(parsedDoc)
 
+  const lockfile = readLockfile({ siteRoot: command.netlify.site.root })
+
+  if (lockfile == null) {
+    error(
+      `${NETLIFYDEVERR} Error: no lockfile found, unable to run \`netlify graph:library\`. To pull a remote schema (and create a lockfile), run ${chalk.yellow(
+        'netlify graph:pull',
+      )} `,
+    )
+  }
+
+  const schemaId = lockfile && lockfile.locked.schemaId
+
   generateFunctionsFile({
     logger: log,
     netlifyGraphConfig,
     schema,
+    schemaId,
     operationsDoc: currentOperationsDoc,
     functions,
     fragments,

diff --git a/src/commands/graph/graph-pull.js b/src/commands/graph/graph-pull.js
@@ -34,6 +34,13 @@ const graphPull = async (options, command) => {
   const { jwt } = await OneGraphCliClient.getGraphJwtForSite({ siteId, nfToken: netlifyToken })
 
   const oneGraphSessionId = loadCLISession(state)
+  if (!oneGraphSessionId) {
+    warn(
+      'No local Netlify Graph session found, skipping command queue drain. Create a new session by running `netlify graph:edit`.',
+    )
+    return
+  }
+
   await refetchAndGenerateFromOneGraph({
     logger: log,
     netlifyGraphConfig,
@@ -43,13 +50,6 @@ const graphPull = async (options, command) => {
     sessionId: oneGraphSessionId,
   })
 
-  if (!oneGraphSessionId) {
-    warn(
-      'No local Netlify Graph session found, skipping command queue drain. Create a new session by running `netlify graph:edit`.',
-    )
-    return
-  }
-
   const schemaString = readGraphQLSchemaFile(netlifyGraphConfig)
 
   let schema
@@ -106,7 +106,7 @@ const graphPull = async (options, command) => {
 const createGraphPullCommand = (program) =>
   program
     .command('graph:pull')
-    .description('Pull down your local Netlify Graph schema, and process pending Graph edit events')
+    .description('Pull your remote Netlify Graph schema locally, and process pending Graph edit events')
     .action(async (options, command) => {
       await graphPull(options, command)
     })