feat: refactor getSite to base-command (#5743)

* feat: add hook, convert functions-list

* fix: clarify names

* feat: refactor deploy command, add search by name to base command

* feat: convert link

* feat: convert open-admin

* feat: convert open:site

* feat: error out on getSiteByName

* fix: format

* feat: convert sites:delete

* fix: undo convert sites:delete as it was wrong :D

* feat: convert status:hooks

* chore: format

* feat: convert unlink

* feat: return error instead of just calling error

* fix: throw error if undefined

Author: sarahetter

src/commands/base-command.mjs

@@ -24,6 +24,7 @@ import {
   warn,
 } from '../utils/command-helpers.mjs'
 import getGlobalConfig from '../utils/get-global-config.mjs'
+import { getSiteByName } from '../utils/get-site.mjs'
 import openBrowser from '../utils/open-browser.mjs'
 import StateConfig from '../utils/state-config.mjs'
 import { identify, track } from '../utils/telemetry/index.mjs'
@@ -440,11 +441,24 @@ export default class BaseCommand extends Command {
       certificateFile: options.httpProxyCertificateFilename,
     })
     const apiOpts = { ...apiUrlOpts, agent }
+    const api = new NetlifyAPI(token || '', apiOpts)
+
+    // If a user passes a site name as an option instead of a site ID to options.site, the siteInfo object
+    // will only have the property siteInfo.id. Checking for one of the other properties ensures that we can do
+    // a re-call of the api.getSite() that is done in @netlify/config so we have the proper site object in all
+    // commands.
+    // options.site as a site name (and not just site id) was introduced for the deploy command, so users could
+    // deploy by name along with by id
+    let siteData = siteInfo
+    if (!siteData.url && options.site) {
+      siteData = await getSiteByName(api, options.site)
+    }
+
     const globalConfig = await getGlobalConfig()
 
     actionCommand.netlify = {
       // api methods
-      api: new NetlifyAPI(token || '', apiOpts),
+      api,
       apiOpts,
       repositoryRoot,
       // current site context
@@ -458,8 +472,8 @@ export default class BaseCommand extends Command {
           state.set('siteId', id)
         },
       },
-      // Site information retrieved using the API
-      siteInfo,
+      // Site information retrieved using the API (api.getSite())
+      siteInfo: siteData,
       // Configuration from netlify.[toml/yml]
       config: normalizedConfig,
       // Used to avoid calling @netlify/config again

src/commands/deploy/deploy.mjs

@@ -7,6 +7,7 @@ import { runCoreSteps } from '@netlify/build'
 import { restoreConfig, updateConfig } from '@netlify/config'
 import { Option } from 'commander'
 import inquirer from 'inquirer'
+import isEmpty from 'lodash/isEmpty.js'
 import isObject from 'lodash/isObject.js'
 import prettyjson from 'prettyjson'
 
@@ -488,7 +489,7 @@ const printResults = ({ deployToProduction, json, results, runBuildCommand }) =>
  * @param {import('../base-command.mjs').default} command
  */
 const deploy = async (options, command) => {
-  const { api, site } = command.netlify
+  const { api, site, siteInfo } = command.netlify
   const alias = options.alias || options.branch
 
   command.setAnalyticsPayload({ open: options.open, prod: options.prod, json: options.json, alias: Boolean(alias) })
@@ -503,35 +504,12 @@ const deploy = async (options, command) => {
 
   await command.authenticate(options.auth)
 
-  let siteId = options.site || site.id
+  let siteId = site.id || options.site
 
   let siteData = {}
-  if (siteId) {
-    try {
-      const [{ siteError, siteFoundById }, sites] = await Promise.all([
-        api
-          .getSite({ siteId })
-          .then((data) => ({ siteFoundById: data }))
-          .catch((error_) => ({ siteError: error_ })),
-        api.listSites({ name: options.site, filter: 'all' }),
-      ])
-      const siteFoundByName = sites.find((filteredSite) => filteredSite.name === options.site)
-      if (siteFoundById) {
-        siteData = siteFoundById
-      } else if (siteFoundByName) {
-        siteData = siteFoundByName
-        siteId = siteFoundByName.id
-      } else {
-        throw siteError
-      }
-    } catch (error_) {
-      // TODO specifically handle known cases (e.g. no account access)
-      if (error_.status === 404) {
-        error('Site not found')
-      } else {
-        error(error_.message)
-      }
-    }
+  if (siteId && !isEmpty(siteInfo)) {
+    siteData = siteInfo
+    siteId = siteData.id
   } else {
     log("This folder isn't linked to a site yet")
     const NEW_SITE = '+  Create & configure a new site'

src/commands/functions/functions-list.mjs

@@ -1,8 +1,9 @@
 // @ts-check
 import AsciiTable from 'ascii-table'
 
-import { error, exit, log, logJson, warn } from '../../utils/command-helpers.mjs'
+import { exit, log, logJson } from '../../utils/command-helpers.mjs'
 import { getFunctions, getFunctionsDir } from '../../utils/functions/index.mjs'
+import requiresSiteInfo from '../../utils/hooks/requires-site-info.mjs'
 
 const normalizeFunction = function (deployedFunctions, { name, urlPath: url }) {
   const isDeployed = deployedFunctions.some((deployedFunction) => deployedFunction.n === name)
@@ -15,31 +16,9 @@ const normalizeFunction = function (deployedFunctions, { name, urlPath: url }) {
  * @param {import('../base-command.mjs').default} command
  */
 const functionsList = async (options, command) => {
-  const { api, config, site } = command.netlify
+  const { config, siteInfo } = command.netlify
 
-  // get deployed site details
-  // copied from `netlify status`
-  const siteId = site.id
-  if (!siteId) {
-    warn('Did you run `netlify link` yet?')
-    error(`You don't appear to be in a folder that is linked to a site`)
-  }
-  let siteData
-  try {
-    siteData = await api.getSite({ siteId })
-  } catch (error_) {
-    // unauthorized
-    if (error_.status === 401) {
-      warn(`Log in with a different account or re-link to a site you have permission for`)
-      error(`Not authorized to view the currently linked site (${siteId})`)
-    }
-    // missing
-    if (error_.status === 404) {
-      error(`The site this folder is linked to can't be found`)
-    }
-    error(error_)
-  }
-  const deploy = siteData.published_deploy || {}
+  const deploy = siteInfo.published_deploy || {}
   const deployedFunctions = deploy.available_functions || []
 
   const functionsDir = getFunctionsDir({ options, config })
@@ -91,4 +70,5 @@ NOT the same as listing the functions that have been deployed. For that info you
     )
     .option('-f, --functions <dir>', 'Specify a functions directory to list')
     .option('--json', 'Output function data as JSON')
+    .hook('preAction', requiresSiteInfo)
     .action(functionsList)

src/commands/link/link.mjs

@@ -1,6 +1,7 @@
 // @ts-check
 import { Option } from 'commander'
 import inquirer from 'inquirer'
+import isEmpty from 'lodash/isEmpty.js'
 
 import { listSites } from '../../lib/api.mjs'
 import { chalk, error, exit, log } from '../../utils/command-helpers.mjs'
@@ -250,28 +251,23 @@ export const link = async (options, command) => {
     api,
     repositoryRoot,
     site: { id: siteId },
+    siteInfo,
     state,
   } = command.netlify
 
-  let siteData
-  try {
-    // @ts-ignore types from API are wrong they cannot recognize `getSite` of API
-    siteData = await api.getSite({ siteId })
-  } catch {
-    // silent api error
-  }
+  let siteData = siteInfo
 
   // Add .netlify to .gitignore file
   await ensureNetlifyIgnore(repositoryRoot)
 
   // Site id is incorrect
-  if (siteId && !siteData) {
+  if (siteId && isEmpty(siteData)) {
     log(`"${siteId}" was not found in your Netlify account.`)
     log(`Please double check your siteID and which account you are logged into via \`netlify status\`.`)
     return exit()
   }
 
-  if (siteData) {
+  if (!isEmpty(siteInfo)) {
     // If already linked to site. exit and prompt for unlink
     log(`Site already linked to "${siteData.name}"`)
     log(`Admin url: ${siteData.admin_url}`)

src/commands/open/open-admin.mjs

@@ -1,4 +1,5 @@
-import { error, exit, log, warn } from '../../utils/command-helpers.mjs'
+import { exit, log } from '../../utils/command-helpers.mjs'
+import requiresSiteInfo from '../../utils/hooks/requires-site-info.mjs'
 import openBrowser from '../../utils/open-browser.mjs'
 
 /**
@@ -7,42 +8,14 @@ import openBrowser from '../../utils/open-browser.mjs'
  * @param {import('../base-command.mjs').default} command
  */
 export const openAdmin = async (options, command) => {
-  const { api, site } = command.netlify
+  const { siteInfo } = command.netlify
 
   await command.authenticate()
 
-  const siteId = site.id
+  log(`Opening "${siteInfo.name}" site admin UI:`)
+  log(`> ${siteInfo.admin_url}`)
 
-  if (!siteId) {
-    warn(`No Site ID found in current directory.
-Run \`netlify link\` to connect to this folder to a site`)
-    return false
-  }
-
-  let siteData
-  try {
-    siteData = await api.getSite({ siteId })
-    log(`Opening "${siteData.name}" site admin UI:`)
-    log(`> ${siteData.admin_url}`)
-  } catch (error_) {
-    // unauthorized
-    if (error_.status === 401) {
-      warn(`Log in with a different account or re-link to a site you have permission for`)
-      error(`Not authorized to view the currently linked site (${siteId})`)
-    }
-    // site not found
-    if (error_.status === 404) {
-      log()
-      log('Please double check this ID and verify you are logged in with the correct account')
-      log()
-      log('To fix this, run `netlify unlink` then `netlify link` to reconnect to the correct site ID')
-      log()
-      error(`Site "${siteId}" not found in account`)
-    }
-    error(error_)
-  }
-
-  await openBrowser({ url: siteData.admin_url })
+  await openBrowser({ url: siteInfo.admin_url })
   exit()
 }
 
@@ -56,4 +29,5 @@ export const createOpenAdminCommand = (program) =>
     .command('open:admin')
     .description('Opens current site admin UI in Netlify')
     .addExamples(['netlify open:admin'])
+    .hook('preAction', requiresSiteInfo)
     .action(openAdmin)

src/commands/open/open-site.mjs

@@ -1,4 +1,5 @@
-import { error, exit, log, warn } from '../../utils/command-helpers.mjs'
+import { exit, log } from '../../utils/command-helpers.mjs'
+import requiresSiteInfo from '../../utils/hooks/requires-site-info.mjs'
 import openBrowser from '../../utils/open-browser.mjs'
 
 /**
@@ -7,33 +8,13 @@ import openBrowser from '../../utils/open-browser.mjs'
  * @param {import('../base-command.mjs').default} command
  */
 export const openSite = async (options, command) => {
-  const { api, site } = command.netlify
+  const { siteInfo } = command.netlify
 
   await command.authenticate()
 
-  const siteId = site.id
-
-  if (!siteId) {
-    warn(`No Site ID found in current directory.
-Run \`netlify link\` to connect to this folder to a site`)
-    return false
-  }
-
-  let siteData
-  let url
-  try {
-    siteData = await api.getSite({ siteId })
-    url = siteData.ssl_url || siteData.url
-    log(`Opening "${siteData.name}" site url:`)
-    log(`> ${url}`)
-  } catch (error_) {
-    // unauthorized
-    if (error_.status === 401) {
-      warn(`Log in with a different account or re-link to a site you have permission for`)
-      error(`Not authorized to view the currently linked site (${siteId})`)
-    }
-    error(error_)
-  }
+  const url = siteInfo.ssl_url || siteInfo.url
+  log(`Opening "${siteInfo.name}" site url:`)
+  log(`> ${url}`)
 
   await openBrowser({ url })
   exit()
@@ -49,4 +30,5 @@ export const createOpenSiteCommand = (program) =>
     .command('open:site')
     .description('Opens current site url in browser')
     .addExamples(['netlify open:site'])
+    .hook('preAction', requiresSiteInfo)
     .action(openSite)

src/commands/status/status-hooks.mjs

@@ -1,43 +1,22 @@
 // @ts-check
 import prettyjson from 'prettyjson'
 
-import { error, log, warn } from '../../utils/command-helpers.mjs'
+import { log } from '../../utils/command-helpers.mjs'
+import requiresSiteInfo from '../../utils/hooks/requires-site-info.mjs'
 
 /**
  * The status:hooks command
  * @param {import('commander').OptionValues} options
  * @param {import('../base-command.mjs').default} command
  */
 const statusHooks = async (options, command) => {
-  const { api, site } = command.netlify
+  const { api, siteInfo } = command.netlify
 
   await command.authenticate()
 
-  const siteId = site.id
-  if (!siteId) {
-    warn('Did you run `netlify link` yet?')
-    error(`You don't appear to be in a folder that is linked to a site`)
-  }
-
-  let siteData
-  try {
-    siteData = await api.getSite({ siteId })
-  } catch (error_) {
-    // unauthorized
-    if (error_.status === 401) {
-      warn(`Log in with a different account or re-link to a site you have permission for`)
-      error(`Not authorized to view the currently linked site (${siteId})`)
-    }
-    // missing
-    if (error_.status === 404) {
-      error(`The site this folder is linked to can't be found`)
-    }
-    error(error_)
-  }
-
-  const ntlHooks = await api.listHooksBySiteId({ siteId: siteData.id })
+  const ntlHooks = await api.listHooksBySiteId({ siteId: siteInfo.id })
   const data = {
-    site: siteData.name,
+    site: siteInfo.name,
     hooks: {},
   }
   ntlHooks.forEach((hook) => {
@@ -47,8 +26,8 @@ const statusHooks = async (options, command) => {
       id: hook.id,
       disabled: hook.disabled,
     }
-    if (siteData.build_settings?.repo_url) {
-      data.hooks[hook.id].repo_url = siteData.build_settings.repo_url
+    if (siteInfo.build_settings?.repo_url) {
+      data.hooks[hook.id].repo_url = siteInfo.build_settings.repo_url
     }
   })
   log(`─────────────────┐
@@ -63,4 +42,8 @@ Site Hook Status │
  * @returns
  */
 export const createStatusHooksCommand = (program) =>
-  program.command('status:hooks').description('Print hook information of the linked site').action(statusHooks)
+  program
+    .command('status:hooks')
+    .description('Print hook information of the linked site')
+    .hook('preAction', requiresSiteInfo)
+    .action(statusHooks)

src/commands/unlink/unlink.mjs

@@ -8,21 +8,15 @@ import { track } from '../../utils/telemetry/index.mjs'
  * @param {import('../base-command.mjs').default} command
  */
 const unlink = async (options, command) => {
-  const { site, state } = command.netlify
+  const { site, siteInfo, state } = command.netlify
   const siteId = site.id
 
   if (!siteId) {
     log(`Folder is not linked to a Netlify site. Run 'netlify link' to link it`)
     return exit()
   }
 
-  let siteData = {}
-  try {
-    // @ts-ignore types from API are wrong they cannot recognize `getSite` of API
-    siteData = await command.netlify.api.getSite({ siteId })
-  } catch {
-    // ignore errors if we can't get the site
-  }
+  const siteData = siteInfo
 
   state.delete('siteId')