netlify-cli 9.2.0 → 9.3.0

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "netlify-cli",
-  "version": "9.2.0",
+  "version": "9.3.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "netlify-cli",
-      "version": "9.2.0",
+      "version": "9.3.0",
       "hasInstallScript": true,
       "license": "MIT",
       "dependencies": {
@@ -82,7 +82,7 @@
         "multiparty": "^4.2.1",
         "netlify": "^11.0.0",
         "netlify-headers-parser": "^6.0.1",
-        "netlify-onegraph-internal": "0.0.39",
+        "netlify-onegraph-internal": "0.0.42",
         "netlify-redirect-parser": "^13.0.2",
         "netlify-redirector": "^0.2.1",
         "node-fetch": "^2.6.0",
@@ -16484,9 +16484,9 @@
       }
     },
     "node_modules/netlify-onegraph-internal": {
-      "version": "0.0.39",
-      "resolved": "https://registry.npmjs.org/netlify-onegraph-internal/-/netlify-onegraph-internal-0.0.39.tgz",
-      "integrity": "sha512-ekx1INpJGTU2t6TkvlnzFXuaFGrf5PM9we13Oq4mFbynhfuwN3NmnDRSIGl2g6ae9ZpvzTCVSIr13u/HMWjxpA==",
+      "version": "0.0.42",
+      "resolved": "https://registry.npmjs.org/netlify-onegraph-internal/-/netlify-onegraph-internal-0.0.42.tgz",
+      "integrity": "sha512-p9pxhXRmDtwxIcLE/H5iq+NfsjaoOQrBs00Ynac+0XWg3UoSsFenhTiY4lWBK3RbwpZqtkv+v4Z8eO+10YDr5w==",
       "dependencies": {
         "graphql": "16.0.0",
         "node-fetch": "^2.6.0",
@@ -35806,9 +35806,9 @@
       }
     },
     "netlify-onegraph-internal": {
-      "version": "0.0.39",
-      "resolved": "https://registry.npmjs.org/netlify-onegraph-internal/-/netlify-onegraph-internal-0.0.39.tgz",
-      "integrity": "sha512-ekx1INpJGTU2t6TkvlnzFXuaFGrf5PM9we13Oq4mFbynhfuwN3NmnDRSIGl2g6ae9ZpvzTCVSIr13u/HMWjxpA==",
+      "version": "0.0.42",
+      "resolved": "https://registry.npmjs.org/netlify-onegraph-internal/-/netlify-onegraph-internal-0.0.42.tgz",
+      "integrity": "sha512-p9pxhXRmDtwxIcLE/H5iq+NfsjaoOQrBs00Ynac+0XWg3UoSsFenhTiY4lWBK3RbwpZqtkv+v4Z8eO+10YDr5w==",
       "requires": {
         "graphql": "16.0.0",
         "node-fetch": "^2.6.0",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "netlify-cli",
   "description": "Netlify command line tool",
-  "version": "9.2.0",
+  "version": "9.3.0",
   "author": "Netlify Inc.",
   "contributors": [
     "Abraham Schilling <AbrahamSchilling@gmail.com> (https://gitlab.com/n4bb12)",
@@ -164,7 +164,6 @@
     "url": "https://github.com/netlify/cli/issues"
   },
   "scripts": {
-    "snap": "ava --verbose -u tests/integration/**/*graph*.test.js",
     "prepare": "husky install node_modules/@netlify/eslint-config-node/.husky/",
     "start": "node ./bin/run",
     "test": "run-s format test:dev",
@@ -271,7 +270,7 @@
     "multiparty": "^4.2.1",
     "netlify": "^11.0.0",
     "netlify-headers-parser": "^6.0.1",
-    "netlify-onegraph-internal": "0.0.39",
+    "netlify-onegraph-internal": "0.0.42",
     "netlify-redirect-parser": "^13.0.2",
     "netlify-redirector": "^0.2.1",
     "node-fetch": "^2.6.0",

package/src/commands/graph/graph-edit.js

@@ -1,7 +1,13 @@
 // @ts-check
 const gitRepoInfo = require('git-repo-info')
 
-const { OneGraphCliClient, generateSessionName, loadCLISession } = require('../../lib/one-graph/cli-client')
+const {
+  OneGraphCliClient,
+  createCLISession,
+  generateSessionName,
+  loadCLISession,
+  upsertMergeCLISessionMetadata,
+} = require('../../lib/one-graph/cli-client')
 const {
   defaultExampleOperationsDoc,
   getGraphEditUrlBySiteId,
@@ -11,7 +17,7 @@ const {
 const { NETLIFYDEVERR, chalk, error } = require('../../utils')
 const { openBrowser } = require('../../utils/open-browser')
 
-const { createCLISession, createPersistedQuery, ensureAppForSite, updateCLISessionMetadata } = OneGraphCliClient
+const { createPersistedQuery, ensureAppForSite } = OneGraphCliClient
 
 /**
  * Creates the `netlify graph:edit` command
@@ -32,8 +38,6 @@ const graphEdit = async (options, command) => {
   }
   const netlifyGraphConfig = await getNetlifyGraphConfig({ command, options })
 
-  const { branch } = gitRepoInfo()
-
   let graphqlDocument = readGraphQLOperationsSourceFile(netlifyGraphConfig)
 
   if (graphqlDocument.trim().length === 0) {
@@ -47,11 +51,12 @@ const graphEdit = async (options, command) => {
   let oneGraphSessionId = loadCLISession(state)
   if (!oneGraphSessionId) {
     const sessionName = generateSessionName()
-    const oneGraphSession = await createCLISession(netlifyToken, site.id, sessionName, null)
+    const oneGraphSession = await createCLISession({ netlifyToken, siteId: site.id, sessionName, metadata: {} })
     state.set('oneGraphSessionId', oneGraphSession.id)
     oneGraphSessionId = state.get('oneGraphSessionId')
   }
 
+  const { branch } = gitRepoInfo()
   const persistedDoc = await createPersistedQuery(netlifyToken, {
     appId: siteId,
     description: 'Temporary snapshot of local queries',
@@ -59,7 +64,16 @@ const graphEdit = async (options, command) => {
     tags: ['netlify-cli', `session:${oneGraphSessionId}`, `git-branch:${branch}`],
   })
 
-  await updateCLISessionMetadata(netlifyToken, siteId, oneGraphSessionId, { docId: persistedDoc.id })
+  const newMetadata = { docId: persistedDoc.id }
+
+  await upsertMergeCLISessionMetadata({
+    netlifyGraphConfig,
+    netlifyToken,
+    siteId,
+    siteRoot: site.root,
+    oneGraphSessionId,
+    newMetadata,
+  })
 
   const graphEditUrl = getGraphEditUrlBySiteId({ siteId, oneGraphSessionId })
 

package/src/lib/one-graph/cli-client.js

@@ -24,7 +24,7 @@ const {
 
 const { parse } = GraphQL
 const { defaultExampleOperationsDoc, extractFunctionsFromOperationDoc } = NetlifyGraph
-const { createCLISession, createPersistedQuery, ensureAppForSite, updateCLISessionMetadata } = OneGraphClient
+const { createPersistedQuery, ensureAppForSite, updateCLISessionMetadata } = OneGraphClient
 
 const internalConsole = {
   log,
@@ -284,9 +284,89 @@ const handleCliSessionEvent = async ({ event, netlifyGraphConfig, netlifyToken,
   }
 }
 
-const persistNewOperationsDocForSession = async ({ netlifyToken, oneGraphSessionId, operationsDoc, siteId }) => {
+/**
+ *
+ * @param {object} input
+ * @param {string} input.netlifyToken The (typically netlify) access token that is used for authentication, if any
+ * @param {string} input.oneGraphSessionId The id of the cli session to fetch the current metadata for
+ * @param {object} input.siteId The site object that contains the root file path for the site
+ */
+const getCLISession = async ({ netlifyToken, oneGraphSessionId, siteId }) => {
+  const input = {
+    appId: siteId,
+    sessionId: oneGraphSessionId,
+    authToken: netlifyToken,
+    desiredEventCount: 1,
+  }
+  return await OneGraphClient.fetchCliSession(input)
+}
+
+/**
+ *
+ * @param {object} input
+ * @param {string} input.netlifyToken The (typically netlify) access token that is used for authentication, if any
+ * @param {string} input.oneGraphSessionId The id of the cli session to fetch the current metadata for
+ * @param {string} input.siteId The site object that contains the root file path for the site
+ */
+const getCLISessionMetadata = async ({ netlifyToken, oneGraphSessionId, siteId }) => {
+  const { errors, session } = await getCLISession({ netlifyToken, oneGraphSessionId, siteId })
+  return { metadata: session && session.metadata, errors }
+}
+
+/**
+ * Look at the current project, filesystem, etc. and determine relevant metadata for a cli session
+ * @param {object} input
+ * @param {string} input.siteRoot The root file path for the site
+ * @returns {Record<string, any>} Any locally detected facts that are relevant to include in the cli session metadata
+ */
+const detectLocalCLISessionMetadata = ({ siteRoot }) => {
   const { branch } = gitRepoInfo()
+  const hostname = os.hostname()
+  const userInfo = os.userInfo({ encoding: 'utf-8' })
+  const { username } = userInfo
+
+  const detectedMetadata = {
+    gitBranch: branch,
+    hostname,
+    username,
+    siteRoot,
+  }
 
+  return detectedMetadata
+}
+
+/**
+ * Fetch the existing cli session metadata if it exists, and mutate it remotely with the passed in metadata
+ * @param {object} input
+ * @param {NetlifyGraph.NetlifyGraphConfig} input.netlifyGraphConfig The (typically netlify) access token that is used for authentication, if any
+ * @param {string} input.netlifyToken The (typically netlify) access token that is used for authentication, if any
+ * @param {string} input.oneGraphSessionId The id of the cli session to fetch the current metadata for
+ * @param {string} input.siteId The site object that contains the root file path for the site
+ * @param {string} input.siteRoot The root file path for the site
+ * @param {object} input.newMetadata The metadata to merge into (with priority) the existing metadata
+ * @returns {Promise<object>}
+ */
+const upsertMergeCLISessionMetadata = async ({ netlifyToken, newMetadata, oneGraphSessionId, siteId, siteRoot }) => {
+  const { errors, metadata } = await getCLISessionMetadata({ netlifyToken, oneGraphSessionId, siteId })
+  if (errors) {
+    warn(`Error fetching cli session metadata: ${JSON.stringify(errors, null, 2)}`)
+  }
+
+  const detectedMetadata = detectLocalCLISessionMetadata({ siteRoot })
+
+  const finalMetadata = { ...metadata, ...detectedMetadata, ...newMetadata }
+  return OneGraphClient.updateCLISessionMetadata(netlifyToken, siteId, oneGraphSessionId, finalMetadata)
+}
+
+const persistNewOperationsDocForSession = async ({
+  netlifyGraphConfig,
+  netlifyToken,
+  oneGraphSessionId,
+  operationsDoc,
+  siteId,
+  siteRoot,
+}) => {
+  const { branch } = gitRepoInfo()
   const payload = {
     appId: siteId,
     description: 'Temporary snapshot of local queries',
@@ -295,13 +375,25 @@ const persistNewOperationsDocForSession = async ({ netlifyToken, oneGraphSession
   }
   const persistedDoc = await createPersistedQuery(netlifyToken, payload)
   const newMetadata = await { docId: persistedDoc.id }
-  const result = await OneGraphClient.updateCLISessionMetadata(netlifyToken, siteId, oneGraphSessionId, newMetadata)
+  const result = await upsertMergeCLISessionMetadata({
+    netlifyGraphConfig,
+    netlifyToken,
+    siteId,
+    oneGraphSessionId,
+    newMetadata,
+    siteRoot,
+  })
 
   if (result.errors) {
     warn(`Unable to update session metadata with updated operations doc ${JSON.stringify(result.errors, null, 2)}`)
   }
 }
 
+const createCLISession = ({ metadata, netlifyToken, sessionName, siteId }) => {
+  const result = OneGraphClient.createCLISession(netlifyToken, siteId, sessionName, metadata)
+  return result
+}
+
 /**
  * Load the CLI session id from the local state
  * @param {StateConfig} state
@@ -324,7 +416,12 @@ const startOneGraphCLISession = async (input) => {
   if (!oneGraphSessionId) {
     const sessionName = generateSessionName()
     const sessionMetadata = {}
-    const oneGraphSession = await OneGraphClient.createCLISession(netlifyToken, site.id, sessionName, sessionMetadata)
+    const oneGraphSession = await createCLISession({
+      netlifyToken,
+      siteId: site.id,
+      sessionName,
+      metadata: sessionMetadata,
+    })
     state.set('oneGraphSessionId', oneGraphSession.id)
     oneGraphSessionId = state.get('oneGraphSessionId')
   }
@@ -339,10 +436,12 @@ const startOneGraphCLISession = async (input) => {
       regenerateFunctionsFileFromOperationsFile({ netlifyGraphConfig, schema })
       const newOperationsDoc = readGraphQLOperationsSourceFile(netlifyGraphConfig)
       await persistNewOperationsDocForSession({
+        netlifyGraphConfig,
         netlifyToken,
         oneGraphSessionId,
         operationsDoc: newOperationsDoc,
         siteId: site.id,
+        siteRoot: site.root,
       })
     },
     onAdd: async (filePath) => {
@@ -350,10 +449,12 @@ const startOneGraphCLISession = async (input) => {
       regenerateFunctionsFileFromOperationsFile({ netlifyGraphConfig, schema })
       const newOperationsDoc = readGraphQLOperationsSourceFile(netlifyGraphConfig)
       await persistNewOperationsDocForSession({
+        netlifyGraphConfig,
         netlifyToken,
         oneGraphSessionId,
         operationsDoc: newOperationsDoc,
         siteId: site.id,
+        siteRoot: site.root,
       })
     },
   })
@@ -395,7 +496,6 @@ const generateSessionName = () => {
 
 const OneGraphCliClient = {
   ackCLISessionEvents: OneGraphClient.ackCLISessionEvents,
-  createCLISession,
   createPersistedQuery,
   fetchCliSessionEvents: OneGraphClient.fetchCliSessionEvents,
   ensureAppForSite,
@@ -404,6 +504,7 @@ const OneGraphCliClient = {
 
 module.exports = {
   OneGraphCliClient,
+  createCLISession,
   extractFunctionsFromOperationDoc,
   handleCliSessionEvent,
   generateSessionName,
@@ -412,4 +513,5 @@ module.exports = {
   persistNewOperationsDocForSession,
   refetchAndGenerateFromOneGraph,
   startOneGraphCLISession,
+  upsertMergeCLISessionMetadata,
 }

package/src/lib/one-graph/cli-netlify-graph.js

@@ -167,6 +167,8 @@ const getNetlifyGraphConfig = async ({ command, options, settings }) => {
     }
   }
 
+  const defaulFunctionsPath = ['netlify', 'functions']
+
   const siteRoot = [path.sep, ...filterRelativePathItems(site.root.split(path.sep))]
 
   const tsConfig = 'tsconfig.json'
@@ -178,7 +180,7 @@ const getNetlifyGraphConfig = async ({ command, options, settings }) => {
   const detectedFunctionsPathString = getFunctionsDir({ config, options })
   const detectedFunctionsPath = detectedFunctionsPathString
     ? [path.sep, ...detectedFunctionsPathString.split(path.sep)]
-    : null
+    : defaulFunctionsPath
   const baseConfig = { ...NetlifyGraph.defaultNetlifyGraphConfig, ...userSpecifiedConfig }
   const defaultFrameworkConfig = makeDefaultFrameworkConfig({ baseConfig, detectedFunctionsPath, siteRoot })