perf!: perform minimal accounts query when loading config

We've done this performance improvement many times elsewhere, but for
posterity:

When we load a user's configuration, we perform a query to the Netlify
API requesting information about which accounts a user is a member of.
To do this, we query the `/accounts` endpoint, which is an expensive
operation: It frequently takes 4+ seconds to get a response from this
endpoint. This query happens as part of every CLI startup cycle.

By requesting a more minimal set of `accounts` data, we can shave 2-3
seconds off almost every command's startup time.

Author: ndhoule

package-lock.json

@@ -62,7 +62,7 @@
     "@netlify/blobs": "8.1.2",
     "@netlify/build": "30.1.1",
     "@netlify/build-info": "9.0.2",
-    "@netlify/config": "21.0.6",
+    "@netlify/config": "21.0.7",
     "@netlify/edge-bundler": "12.4.0",
     "@netlify/edge-functions": "2.11.1",
     "@netlify/headers-parser": "8.0.0",

package.json

@@ -581,7 +581,7 @@ export default class BaseCommand extends Command {
       token,
       ...apiUrlOpts,
     })
-    const { accounts, buildDir, config, configPath, repositoryRoot, siteInfo } = cachedConfig
+    const { accounts = [], buildDir, config, configPath, repositoryRoot, siteInfo } = cachedConfig
     let { env } = cachedConfig
     if (flags.offlineEnv) {
       env = {}

src/commands/base-command.ts

@@ -25,7 +25,7 @@ import { configureRepo } from '../../utils/init/config.js'
 import { deployedSiteExists, getGitHubLink, getTemplateName } from '../../utils/sites/create-template.js'
 import { callLinkSite, createRepo, validateTemplate } from '../../utils/sites/utils.js'
 import { track } from '../../utils/telemetry/index.js'
-import type { Account, SiteInfo } from '../../utils/types.js'
+import type { SiteInfo } from '../../utils/types.js'
 import type BaseCommand from '../base-command.js'
 
 import { getSiteNameInput } from './sites-create.js'
@@ -60,7 +60,7 @@ export const sitesCreateTemplate = async (repository: string, options: OptionVal
         type: 'list',
         name: 'accountSlug',
         message: 'Team:',
-        choices: accounts.map((account: Account) => ({
+        choices: accounts.map((account) => ({
           value: account.slug,
           name: account.name,
         })),

src/commands/sites/sites-create-template.ts

@@ -42,16 +42,8 @@ export const status = async (options: OptionValues, command: BaseCommand) => {
     Name: user.full_name,
     Email: user.email,
     GitHub: ghuser,
+    Teams: accounts.map(({ name }) => name),
   }
-  const teamsData = {}
-
-  accounts.forEach((team) => {
-    // @ts-expect-error TS(7053) FIXME: Element implicitly has an 'any' type because expre... Remove this comment to see the full error message
-    teamsData[team.name] = team.roles_allowed.join(' ')
-  })
-
-  // @ts-expect-error TS(2339) FIXME: Property 'Teams' does not exist on type '{ Name: a... Remove this comment to see the full error message
-  accountData.Teams = teamsData
 
   // @ts-expect-error
   const cleanAccountData = clean(accountData)

src/commands/status/status.ts

@@ -2,7 +2,7 @@ import type { NetlifyAPI } from 'netlify'
 
 import type { FrameworksAPIPaths } from '../utils/frameworks-api.ts'
 import type CLIState from '../utils/cli-state.js'
-import type { Account, GlobalConfigStore, SiteInfo } from '../utils/types.ts'
+import type { MinimalAccount, GlobalConfigStore, SiteInfo } from '../utils/types.ts'
 import type { NormalizedCachedConfigConfig } from '../utils/command-helpers.js'
 import type { CachedConfig } from '../lib/build.js'
 
@@ -22,7 +22,7 @@ export type NetlifySite = {
  * TODO(serhalp): Rename. These aren't options. They're more like context.
  */
 export type NetlifyOptions = {
-  accounts: Account[]
+  accounts: MinimalAccount[]
   api: NetlifyAPI
   apiOpts: {
     userAgent: string

src/commands/types.d.ts

@@ -7,14 +7,14 @@ import tomlify from 'tomlify-j0.4'
 import type { OptionValues } from 'commander'
 
 import { getFeatureFlagsFromSiteInfo } from '../utils/feature-flags.js'
-import type { Account, EnvironmentVariables, Plugin, SiteInfo } from '../utils/types.js'
+import type { MinimalAccount, EnvironmentVariables, Plugin, SiteInfo } from '../utils/types.js'
 
 import { getBootstrapURL } from './edge-functions/bootstrap.js'
 import { featureFlags as edgeFunctionsFeatureFlags } from './edge-functions/consts.js'
 import type { EdgeFunctionDeclaration } from './edge-functions/proxy.js'
 
 export interface CachedConfig {
-  accounts: Account[]
+  accounts: MinimalAccount[] | undefined
   buildDir: string
   env: EnvironmentVariables
   repositoryRoot: string

src/lib/build.ts

@@ -184,23 +184,17 @@ type EnvVarValue = {
   context: string
 }
 
-export interface Account {
+export type MinimalAccount = {
   id: string
   name: string
   slug: string
-  type: string
-  capabilities: Record<string, { included: string; used: string }>
-  billing_name: string
-  billing_email: string
-  billing_details: string
-  billing_period: string
-  payment_method_id: string
+  default: boolean
+  team_logo_url: string | null
+  on_pro_trial: boolean
+  organization_id: string | null
   type_name: string
-  type_id: string
-  owner_ids: string[]
-  roles_allowed: string[]
-  created_at: string
-  updated_at: string
+  type_slug: string
+  members_count: number
 }
 
 export interface GitHubRepo {

src/utils/types.ts

@@ -13,5 +13,8 @@ exports[`fixture: empty-project > should print status for a linked site 2`] = `
 {
   "Email": "[email protected]",
   "Name": "Test User",
+  "Teams": [
+    "Test User",
+  ],
 }
 `;

tests/integration/commands/status/__snapshots__/status.test.ts.snap

@@ -2,6 +2,7 @@ import { expect, test } from 'vitest'
 
 import { FixtureTestContext, setupFixtureTests } from '../../utils/fixture.js'
 import { getCLIOptions, withMockApi } from '../../utils/mock-api.js'
+import type { MinimalAccount } from '../../../../src/utils/types.js'
 
 const siteInfo = {
   account_slug: 'test-account',
@@ -13,7 +14,20 @@ const siteInfo = {
 
 const user = { full_name: 'Test User', email: '[email protected]' }
 
-const accounts = [{ slug: siteInfo.account_slug, name: user.full_name, roles_allowed: [] }]
+const accounts: MinimalAccount[] = [
+  {
+    id: 'user-id',
+    name: user.full_name,
+    slug: siteInfo.account_slug,
+    default: true,
+    team_logo_url: null,
+    on_pro_trial: false,
+    organization_id: null,
+    type_name: 'placeholder',
+    type_slug: 'placeholder',
+    members_count: 1,
+  },
+]
 
 const routes = [
   { path: 'sites/site_id', response: siteInfo },