feat: Update VS code to be compatible with the global config (#287)

brandenrodgers · web-flow · commit 853531099f75 · 2025-06-16T14:40:32.000-04:00
* update VS code to be compatible with the global config

* support config migrations
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -587,7 +587,7 @@
         ]
     },
     "dependencies": {
-        "@hubspot/local-dev-lib": "^3.1.0",
+        "@hubspot/local-dev-lib": "^3.7.0",
         "@hubspot/project-parsing-lib": "0.2.0",
         "dayjs": "^1.11.7",
         "debounce": "1.2.1",
diff --git a/src/lib/auth.ts b/src/lib/auth.ts
@@ -1,12 +1,19 @@
-import { commands } from 'vscode';
+import { commands, window } from 'vscode';
 import { COMMANDS, EVENTS } from './constants';
 import {
   findConfig,
   loadConfig,
   validateConfig,
   setConfig,
   setConfigPath,
+  getConfigPath,
 } from '@hubspot/local-dev-lib/config';
+import {
+  getDeprecatedConfig,
+  getGlobalConfig,
+  mergeConfigProperties,
+  mergeExistingConfigs,
+} from '@hubspot/local-dev-lib/config/migrate';
 
 const onLoadPath = (configPath: string) => {
   commands.executeCommand('setContext', 'hubspot.configPath', configPath);
@@ -22,24 +29,66 @@ export const loadHubspotConfigFile = (rootPath: string) => {
     return;
   }
 
-  console.log(`rootPath: ${rootPath}`);
+  const deprecatedConfigPath = findConfig(rootPath);
+  const globalConfigPath = getConfigPath(undefined, true);
+
+  const resolvedConfigPath = globalConfigPath || deprecatedConfigPath;
+
+  if (!resolvedConfigPath) {
+    return;
+  }
+
+  // We need to call loadConfig to ensure the isActive() check returns true for global config
+  loadConfig(resolvedConfigPath);
+
+  if (deprecatedConfigPath && globalConfigPath) {
+    const mergeConfigCopy = 'Merge accounts';
+    window
+      .showWarningMessage(
+        `Found both global and deprecated account configuration files. Click "Merge configuration files" to merge them automatically.`,
+        mergeConfigCopy
+      )
+      .then((selection) => {
+        if (selection === mergeConfigCopy) {
+          window.showInformationMessage(
+            `Merging accounts from ${deprecatedConfigPath} into ${globalConfigPath}. Your existing configuration file will be archived.`
+          );
+
+          const deprecatedConfig = getDeprecatedConfig(deprecatedConfigPath);
+          const globalConfig = getGlobalConfig();
 
-  const path = findConfig(rootPath);
+          let success = false;
+          try {
+            const { initialConfig: GlobalConfigWithPropertiesMerged } =
+              mergeConfigProperties(globalConfig!, deprecatedConfig!, true);
 
-  console.log(`path: ${path}`);
+            mergeExistingConfigs(
+              GlobalConfigWithPropertiesMerged,
+              deprecatedConfig!
+            );
+            success = true;
+          } catch (error) {
+            throw new Error('Error merging configuration files: ' + error);
+          }
 
-  if (!path) {
+          if (success) {
+            window.showInformationMessage(`Config files successfully merged.`);
+            initializeConfig(rootPath);
+          }
+        }
+      });
     return;
   }
-  onLoadPath(path);
 
-  loadConfig(path);
+  onLoadPath(resolvedConfigPath);
 
   if (!validateConfig()) {
-    throw new Error(`Invalid config could not be loaded: ${path}`);
+    throw new Error(
+      `Invalid config could not be loaded: ${resolvedConfigPath}`
+    );
   } else {
     commands.executeCommand(EVENTS.ON_CONFIG_UPDATED);
-    return path;
+    return resolvedConfigPath;
   }
 };
 
diff --git a/src/lib/commands/account.ts b/src/lib/commands/account.ts
@@ -1,5 +1,6 @@
 import { commands, ExtensionContext, Uri } from 'vscode';
 import { CLIAccount_DEPRECATED } from '@hubspot/local-dev-lib/types/Accounts';
+import { getAccountIdentifier } from '@hubspot/local-dev-lib/config/getAccountIdentifier';
 import { COMMANDS } from '../constants';
 
 export const registerCommands = (context: ExtensionContext) => {
@@ -9,7 +10,7 @@ export const registerCommands = (context: ExtensionContext) => {
       async (hubspotAccount: CLIAccount_DEPRECATED) => {
         const pakUrl = `https://app.hubspot${
           hubspotAccount.env === 'qa' ? 'qa' : ''
-        }.com/personal-access-key/${hubspotAccount.portalId}`;
+        }.com/personal-access-key/${getAccountIdentifier(hubspotAccount)}`;
 
         commands.executeCommand('vscode.open', Uri.parse(pakUrl));
       }
@@ -21,7 +22,7 @@ export const registerCommands = (context: ExtensionContext) => {
       async (hubspotAccount: CLIAccount_DEPRECATED) => {
         const designManagerUrl = `https://app.hubspot${
           hubspotAccount.env === 'qa' ? 'qa' : ''
-        }.com/design-manager/${hubspotAccount.portalId}`;
+        }.com/design-manager/${getAccountIdentifier(hubspotAccount)}`;
 
         commands.executeCommand('vscode.open', Uri.parse(designManagerUrl));
       }
diff --git a/src/lib/commands/config.ts b/src/lib/commands/config.ts
@@ -1,10 +1,4 @@
 import { commands, window, ExtensionContext } from 'vscode';
-import { updateStatusBarItems } from '../statusBar';
-import { COMMANDS, TRACKED_EVENTS } from '../constants';
-import { getDisplayedHubspotPortalInfo } from '../helpers';
-import { portalNameInvalid } from '../validation';
-import { trackEvent } from '../tracking';
-import { showAutoDismissedStatusBarMessage } from '../messaging';
 import {
   getConfig,
   deleteAccount,
@@ -15,7 +9,17 @@ import {
   getConfigAccounts,
 } from '@hubspot/local-dev-lib/config';
 import { CLIConfig } from '@hubspot/local-dev-lib/types/Config';
-import { CLIAccount_DEPRECATED } from '@hubspot/local-dev-lib/types/Accounts';
+import {
+  CLIAccount,
+  CLIAccount_DEPRECATED,
+} from '@hubspot/local-dev-lib/types/Accounts';
+import { getAccountIdentifier } from '@hubspot/local-dev-lib/config/getAccountIdentifier';
+import { updateStatusBarItems } from '../statusBar';
+import { COMMANDS, TRACKED_EVENTS } from '../constants';
+import { getDisplayedHubspotPortalInfo } from '../helpers';
+import { portalNameInvalid } from '../validation';
+import { trackEvent } from '../tracking';
+import { showAutoDismissedStatusBarMessage } from '../messaging';
 
 const showRenameAccountPrompt = (accountToRename: CLIAccount_DEPRECATED) => {
   window
@@ -24,7 +28,8 @@ const showRenameAccountPrompt = (accountToRename: CLIAccount_DEPRECATED) => {
     })
     .then(async (newName: string | undefined) => {
       if (newName) {
-        const oldName = accountToRename.name || accountToRename.portalId;
+        const oldName =
+          accountToRename.name || getAccountIdentifier(accountToRename);
         const config: CLIConfig | null = getConfig();
         let invalidReason = '';
         if (config) {
@@ -39,6 +44,7 @@ const showRenameAccountPrompt = (accountToRename: CLIAccount_DEPRECATED) => {
             return;
           }
           renameAccount(String(oldName), newName);
+          commands.executeCommand(COMMANDS.ACCOUNTS_REFRESH);
           showAutoDismissedStatusBarMessage(
             `Successfully renamed default account from ${oldName} to ${newName}.`
           );
@@ -66,7 +72,7 @@ export const registerCommands = (context: ExtensionContext) => {
           typeof defaultAccount === 'string' ||
           typeof defaultAccount === 'number'
             ? defaultAccount
-            : defaultAccount.name || defaultAccount.portalId;
+            : defaultAccount.name || getAccountIdentifier(defaultAccount);
         console.log('Setting default account to: ', newDefaultAccount);
         updateDefaultAccount(newDefaultAccount);
         await trackEvent(TRACKED_EVENTS.UPDATE_DEFAULT_ACCOUNT);
@@ -85,19 +91,20 @@ export const registerCommands = (context: ExtensionContext) => {
       COMMANDS.CONFIG.SELECT_DEFAULT_ACCOUNT,
       async () => {
         const defaultAccount = getConfigDefaultAccount();
-        const portals: CLIAccount_DEPRECATED[] = getConfigAccounts() || [];
+        const accounts: CLIAccount[] = getConfigAccounts() || [];
 
-        if (portals && portals.length !== 0) {
+        if (accounts && accounts.length !== 0) {
           window
             .showQuickPick(
-              portals.map((p: CLIAccount_DEPRECATED) => {
+              accounts.map((a: CLIAccount) => {
                 return {
-                  label: getDisplayedHubspotPortalInfo(p),
+                  label: getDisplayedHubspotPortalInfo(a),
                   description:
-                    defaultAccount === p.portalId || defaultAccount === p.name
+                    defaultAccount === getAccountIdentifier(a) ||
+                    defaultAccount === a.name
                       ? '(default)'
                       : '',
-                  portal: p,
+                  account: a,
                 };
               }),
               {
@@ -107,7 +114,8 @@ export const registerCommands = (context: ExtensionContext) => {
             .then(async (selection) => {
               if (selection) {
                 const newDefaultAccount =
-                  selection.portal.name || selection.portal.portalId;
+                  selection.account.name ||
+                  getAccountIdentifier(selection.account);
                 if (!newDefaultAccount) {
                   window.showErrorMessage(
                     'No account selected; Choose an account to set as default'
@@ -140,9 +148,9 @@ export const registerCommands = (context: ExtensionContext) => {
     commands.registerCommand(
       COMMANDS.CONFIG.DELETE_ACCOUNT,
       async (accountToDelete) => {
-        const portals: CLIAccount_DEPRECATED[] = getConfigAccounts() || [];
+        const accounts: CLIAccount[] = getConfigAccounts() || [];
         const accountIdentifier =
-          accountToDelete.name || accountToDelete.portalId;
+          accountToDelete.name || getAccountIdentifier(accountToDelete);
 
         await window
           .showInformationMessage(
@@ -152,7 +160,7 @@ export const registerCommands = (context: ExtensionContext) => {
           )
           .then(async (answer) => {
             if (answer === 'Yes') {
-              if (portals && portals.length === 1) {
+              if (accounts && accounts.length === 1) {
                 deleteConfigFile();
                 showAutoDismissedStatusBarMessage(
                   `Successfully deleted account ${accountIdentifier}. The config file has been deleted because there are no more authenticated accounts.`
@@ -165,6 +173,7 @@ export const registerCommands = (context: ExtensionContext) => {
               }
               await trackEvent(TRACKED_EVENTS.DELETE_ACCOUNT);
               commands.executeCommand(COMMANDS.REMOTE_FS.HARD_REFRESH);
+              commands.executeCommand(COMMANDS.ACCOUNTS_REFRESH);
               updateStatusBarItems();
             }
           });
diff --git a/src/lib/helpers.ts b/src/lib/helpers.ts
@@ -1,10 +1,9 @@
 import { dirname } from 'path';
 import { window, commands, workspace, StatusBarAlignment } from 'vscode';
 import { getAccountId } from '@hubspot/local-dev-lib/config';
-
-import { COMMANDS } from './constants';
-import { CLIConfig } from '@hubspot/local-dev-lib/types/Config';
 import { CLIAccount_DEPRECATED } from '@hubspot/local-dev-lib/types/Accounts';
+import { getAccountIdentifier } from '@hubspot/local-dev-lib/config/getAccountIdentifier';
+import { COMMANDS } from './constants';
 
 const { exec } = require('node:child_process');
 
@@ -17,24 +16,13 @@ export const getRootPath = () => {
   return workspaceFolders[0].uri.fsPath;
 };
 
-export const getDefaultPortalFromConfig = (config: CLIConfig) => {
-  return (
-    config &&
-    'portals' in config &&
-    config.portals &&
-    config.portals.find(
-      (p: CLIAccount_DEPRECATED) =>
-        p.portalId === config.defaultPortal || p.name === config.defaultPortal
-    )
-  );
-};
-
 export const getDisplayedHubspotPortalInfo = (
   portalData: CLIAccount_DEPRECATED
 ) => {
+  const accountIdentifier = getAccountIdentifier(portalData);
   return portalData.name
-    ? `${portalData.name} - ${portalData.portalId}`
-    : `${portalData.portalId}`;
+    ? `${portalData.name} - ${accountIdentifier}`
+    : `${accountIdentifier}`;
 };
 
 export const runTerminalCommand = async (
diff --git a/src/lib/providers/treedata/accounts.ts b/src/lib/providers/treedata/accounts.ts
@@ -6,21 +6,27 @@ import {
   TreeItem,
   TreeItemCollapsibleState,
 } from 'vscode';
-import { getDisplayedHubspotPortalInfo } from '../../helpers';
-
-import { getConfig } from '@hubspot/local-dev-lib/config';
+import {
+  getConfig,
+  getConfigAccounts,
+  getConfigDefaultAccount,
+} from '@hubspot/local-dev-lib/config';
+import { getAccountIdentifier } from '@hubspot/local-dev-lib/config/getAccountIdentifier';
 import { CLIConfig } from '@hubspot/local-dev-lib/types/Config';
-import { CLIAccount_DEPRECATED } from '@hubspot/local-dev-lib/types/Accounts';
+import {
+  CLIAccount,
+  CLIAccount_DEPRECATED,
+} from '@hubspot/local-dev-lib/types/Accounts';
+import { getDisplayedHubspotPortalInfo } from '../../helpers';
 
-const isDefaultPortal = (
-  portal: CLIAccount_DEPRECATED,
-  config: CLIConfig | null
-) => {
+const isDefaultAccount = (account: CLIAccount, config: CLIConfig | null) => {
+  if (!config) {
+    return false;
+  }
+  const accountIdentifier = getAccountIdentifier(account);
+  const defaultAccount = getConfigDefaultAccount();
   return (
-    config &&
-    'defaultPortal' in config &&
-    (config.defaultPortal === portal.portalId ||
-      config.defaultPortal === portal.name)
+    accountIdentifier === defaultAccount || account.name === defaultAccount
   );
 };
 
@@ -56,17 +62,18 @@ export class AccountsProvider
     return new AccountTreeItem(
       name,
       p,
-      { isDefault: isDefaultPortal(p, this.config) ?? false },
+      { isDefault: isDefaultAccount(p, this.config) ?? false },
       TreeItemCollapsibleState.None
     );
   }
 
   getChildren(): Thenable<CLIAccount_DEPRECATED[] | undefined> {
     console.log('AccountsProvider:getChildren');
     this.config = getConfig();
+    const accounts = getConfigAccounts();
 
-    if (this.config && 'portals' in this.config && this.config.portals) {
-      return Promise.resolve(this.config.portals);
+    if (accounts) {
+      return Promise.resolve(accounts);
     }
 
     return Promise.resolve([]);
@@ -89,7 +96,7 @@ export class AccountTreeItem extends TreeItem {
     }
     this.tooltip = `${options.isDefault ? '* Default Account\n' : ''}${
       portalData.name ? `Name: ${portalData.name}\n` : ''
-    }ID: ${portalData.portalId}\n${
+    }ID: ${getAccountIdentifier(portalData)}\n${
       portalData.env ? `Environment: ${portalData.env}\n` : ''
     }${
       portalData.sandboxAccountType
diff --git a/src/lib/statusBar.ts b/src/lib/statusBar.ts
diff --git a/src/lib/uri.ts b/src/lib/uri.ts

Original file line number	Diff line number	Diff line change
`@@ -587,7 +587,7 @@`
`587`	`587`	`]`
`588`	`588`	`},`
`589`	`589`	`"dependencies": {`
`590`		`- "@hubspot/local-dev-lib": "^3.1.0",`
	`590`	`+ "@hubspot/local-dev-lib": "^3.7.0",`
`591`	`591`	`"@hubspot/project-parsing-lib": "0.2.0",`
`592`	`592`	`"dayjs": "^1.11.7",`
`593`	`593`	`"debounce": "1.2.1",`