feat: additional graph commands, extra graph codegen tests, and type definitions (#4186)

* chore: add graph type defs, codegen snapshot test matrix, update codegen dependency
* feat: add `graph:handler`, `graph:operations`, and `graph:library` commands

Author: sgrove

.gitignore

@@ -32,3 +32,5 @@ site/src/**/*.md
 tests/integration/hugo-site/resources
 tests/integration/hugo-site/out
 tests/integration/hugo-site/.hugo_build.lock
+_test_out/**
+

README.md

@@ -160,6 +160,9 @@ Manage netlify functions
 | Subcommand | description  |
 |:--------------------------- |:-----|
 | [`graph:edit`](/docs/commands/graph.md#graphedit) | Launch the browser to edit your local graph functions from Netlify  |
+| [`graph:handler`](/docs/commands/graph.md#graphhandler) | Generate a handler for a Graph operation given its name. See `graph:operations` for a list of operations.  |
+| [`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  |
 
 

docs/README.md

@@ -117,6 +117,9 @@ Manage netlify functions
 | Subcommand | description  |
 |:--------------------------- |:-----|
 | [`graph:edit`](/docs/commands/graph.md#graphedit) | Launch the browser to edit your local graph functions from Netlify  |
+| [`graph:handler`](/docs/commands/graph.md#graphhandler) | Generate a handler for a Graph operation given its name. See `graph:operations` for a list of operations.  |
+| [`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  |
 
 

docs/commands/graph.md

@@ -23,6 +23,9 @@ netlify graph
 | Subcommand | description  |
 |:--------------------------- |:-----|
 | [`graph:edit`](/docs/commands/graph.md#graphedit) | Launch the browser to edit your local graph functions from Netlify  |
+| [`graph:handler`](/docs/commands/graph.md#graphhandler) | Generate a handler for a Graph operation given its name. See `graph:operations` for a list of operations.  |
+| [`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  |
 
 
@@ -50,6 +53,61 @@ netlify graph:edit
 - `httpProxy` (*string*) - Proxy server address to route requests through.
 - `httpProxyCertificateFilename` (*string*) - Certificate file to use when connecting using a proxy server
 
+---
+## `graph:handler`
+
+Generate a handler for a Graph operation given its name. See `graph:operations` for a list of operations.
+
+**Usage**
+
+```bash
+netlify graph:handler
+```
+
+**Arguments**
+
+- name - Operation name
+
+**Flags**
+
+- `debug` (*boolean*) - Print debugging information
+- `httpProxy` (*string*) - Proxy server address to route requests through.
+- `httpProxyCertificateFilename` (*string*) - Certificate file to use when connecting using a proxy server
+
+---
+## `graph:library`
+
+Generate the Graph function library
+
+**Usage**
+
+```bash
+netlify graph:library
+```
+
+**Flags**
+
+- `debug` (*boolean*) - Print debugging information
+- `httpProxy` (*string*) - Proxy server address to route requests through.
+- `httpProxyCertificateFilename` (*string*) - Certificate file to use when connecting using a proxy server
+
+---
+## `graph:operations`
+
+List all of the locally available operations
+
+**Usage**
+
+```bash
+netlify graph:operations
+```
+
+**Flags**
+
+- `debug` (*boolean*) - Print debugging information
+- `httpProxy` (*string*) - Proxy server address to route requests through.
+- `httpProxyCertificateFilename` (*string*) - Certificate file to use when connecting using a proxy server
+
 ---
 ## `graph:pull`
 

docs/commands/index.md

@@ -98,6 +98,9 @@ Manage netlify functions
 | Subcommand | description  |
 |:--------------------------- |:-----|
 | [`graph:edit`](/docs/commands/graph.md#graphedit) | Launch the browser to edit your local graph functions from Netlify  |
+| [`graph:handler`](/docs/commands/graph.md#graphhandler) | Generate a handler for a Graph operation given its name. See `graph:operations` for a list of operations.  |
+| [`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  |
 
 

npm-shrinkwrap.json

@@ -43,6 +43,7 @@
     "url": "https://github.com/netlify/cli/issues"
   },
   "scripts": {
+    "snap": "ava --verbose -u",
     "prepare": "husky install node_modules/@netlify/eslint-config-node/.husky/",
     "start": "node ./bin/run",
     "test": "run-s format test:dev",
@@ -149,7 +150,7 @@
     "multiparty": "^4.2.1",
     "netlify": "^11.0.0",
     "netlify-headers-parser": "^6.0.1",
-    "netlify-onegraph-internal": "0.0.18",
+    "netlify-onegraph-internal": "0.0.28",
     "netlify-redirect-parser": "^13.0.2",
     "netlify-redirector": "^0.2.1",
     "node-fetch": "^2.6.0",

package.json

@@ -1,3 +1,4 @@
+// @ts-check
 const gitRepoInfo = require('git-repo-info')
 
 const { OneGraphCliClient, generateSessionName, loadCLISession } = require('../../lib/one-graph/cli-client')
@@ -15,7 +16,7 @@ const { createCLISession, createPersistedQuery, ensureAppForSite, updateCLISessi
 /**
  * Creates the `netlify graph:edit` command
  * @param {import('commander').OptionValues} options
- * @param {import('../base-command').BaseCommand} program
+ * @param {import('../base-command').BaseCommand} command
  * @returns
  */
 const graphEdit = async (options, command) => {
@@ -46,7 +47,7 @@ const graphEdit = async (options, command) => {
   let oneGraphSessionId = loadCLISession(state)
   if (!oneGraphSessionId) {
     const sessionName = generateSessionName()
-    const oneGraphSession = await createCLISession(netlifyToken, site.id, sessionName)
+    const oneGraphSession = await createCLISession(netlifyToken, site.id, sessionName, null)
     state.set('oneGraphSessionId', oneGraphSession.id)
     oneGraphSessionId = state.get('oneGraphSessionId')
   }

src/commands/graph/graph-edit.js

@@ -0,0 +1,53 @@
+// @ts-check
+const {
+  buildSchema,
+  generateHandlerByOperationName,
+  getNetlifyGraphConfig,
+  readGraphQLSchemaFile,
+} = require('../../lib/one-graph/cli-netlify-graph')
+const { error } = require('../../utils')
+
+/**
+ * Creates the `netlify graph:handler` command
+ * @param {string} operationName
+ * @param {import('commander').OptionValues} options
+ * @param {import('../base-command').BaseCommand} command
+ * @returns
+ */
+const graphHandler = async (operationName, options, command) => {
+  const netlifyGraphConfig = await getNetlifyGraphConfig({ command, options })
+
+  const schemaString = readGraphQLSchemaFile(netlifyGraphConfig)
+
+  let schema
+
+  try {
+    schema = buildSchema(schemaString)
+  } catch (buildSchemaError) {
+    error(`Error parsing schema: ${buildSchemaError}`)
+  }
+
+  if (!schema) {
+    error(`Failed to parse Netlify GraphQL schema`)
+  }
+
+  generateHandlerByOperationName(netlifyGraphConfig, schema, operationName, {})
+}
+
+/**
+ * Creates the `netlify graph:handler` command
+ * @param {import('../base-command').BaseCommand} program
+ * @returns
+ */
+const createGraphHandlerCommand = (program) =>
+  program
+    .command('graph:handler')
+    .argument('<name>', 'Operation name')
+    .description(
+      'Generate a handler for a Graph operation given its name. See `graph:operations` for a list of operations.',
+    )
+    .action(async (operationName, options, command) => {
+      await graphHandler(operationName, options, command)
+    })
+
+module.exports = { createGraphHandlerCommand }

src/commands/graph/graph-handler.js

@@ -0,0 +1,61 @@
+// @ts-check
+const {
+  buildSchema,
+  defaultExampleOperationsDoc,
+  extractFunctionsFromOperationDoc,
+  generateFunctionsFile,
+  getNetlifyGraphConfig,
+  parse,
+  readGraphQLOperationsSourceFile,
+  readGraphQLSchemaFile,
+} = require('../../lib/one-graph/cli-netlify-graph')
+const { error } = require('../../utils')
+
+/**
+ * Creates the `netlify graph:library` command
+ * @param {import('commander').OptionValues} options
+ * @param {import('../base-command').BaseCommand} command
+ * @returns
+ */
+const graphLibrary = async (options, command) => {
+  const netlifyGraphConfig = await getNetlifyGraphConfig({ command, options })
+
+  const schemaString = readGraphQLSchemaFile(netlifyGraphConfig)
+
+  let schema
+
+  try {
+    schema = buildSchema(schemaString)
+  } catch (buildSchemaError) {
+    error(`Error parsing schema: ${buildSchemaError}`)
+  }
+
+  if (!schema) {
+    error(`Failed to parse Netlify GraphQL schema`)
+  }
+
+  let currentOperationsDoc = readGraphQLOperationsSourceFile(netlifyGraphConfig)
+  if (currentOperationsDoc.trim().length === 0) {
+    currentOperationsDoc = defaultExampleOperationsDoc
+  }
+
+  const parsedDoc = parse(currentOperationsDoc)
+  const { fragments, functions } = extractFunctionsFromOperationDoc(parsedDoc)
+
+  generateFunctionsFile({ netlifyGraphConfig, schema, operationsDoc: currentOperationsDoc, functions, fragments })
+}
+
+/**
+ * Creates the `netlify graph:library` command
+ * @param {import('../base-command').BaseCommand} program
+ * @returns
+ */
+const createGraphLibraryCommand = (program) =>
+  program
+    .command('graph:library')
+    .description('Generate the Graph function library')
+    .action(async (options, command) => {
+      await graphLibrary(options, command)
+    })
+
+module.exports = { createGraphLibraryCommand }