Sync from internal - version 7.11.1 (#1571)

Author: brandenrodgers

.dockerignore

@@ -23,4 +23,4 @@ acceptance-tests/test-output
 **/.claude/settings.local.json
 
 # Dir to sync to public repo
-temp-repo-sync
+hs-temp-repo-sync

.gitignore

@@ -9,10 +9,11 @@ import {
 } from '../lib/usageTracking.js';
 import { EXIT_CODES } from '../lib/enums/exitCodes.js';
 import {
-  loadAndValidateConfigMiddleware,
+  validateConfigMiddleware,
   injectAccountIdMiddleware,
   validateAccountOptions,
   handleDeprecatedEnvVariables,
+  handleCustomConfigLocationMiddleware,
 } from '../lib/middleware/configMiddleware.js';
 import { autoUpdateCLI } from '../lib/middleware/autoUpdateMiddleware.js';
 import { checkAndWarnGitInclusionMiddleware } from '../lib/middleware/gitMiddleware.js';
@@ -68,7 +69,8 @@ function handleFailure(msg: string, err: Error, yargs: Argv): void {
     logError(err);
   }
 
-  if (msg === null) {
+  if (msg === null && !err) {
+    // Required so running `hs` without a command shows the help
     yargs.showHelp('log');
     process.exit(EXIT_CODES.SUCCESS);
   } else {
@@ -78,13 +80,13 @@ function handleFailure(msg: string, err: Error, yargs: Argv): void {
 
 const argv = yargs(process.argv.slice(2))
   .usage('The command line interface to interact with HubSpot.')
-  // loadConfigMiddleware loads the new hidden config for all commands
   .middleware([
     setCLILogLevel,
     setRequestHeaders,
     handleDeprecatedEnvVariables,
-    loadAndValidateConfigMiddleware,
+    handleCustomConfigLocationMiddleware,
     injectAccountIdMiddleware,
+    validateConfigMiddleware,
     autoUpdateCLI,
     checkAndWarnGitInclusionMiddleware,
     validateAccountOptions,

Dockerfile

@@ -2,8 +2,10 @@ import { MockedFunction } from 'vitest';
 import getStartedCommand from '../getStarted.js';
 import { trackCommandUsage } from '../../lib/usageTracking.js';
 import { promptUser } from '../../lib/prompts/promptUtils.js';
+import { getConfigAccountById } from '@hubspot/local-dev-lib/config';
 import { projectNameAndDestPrompt } from '../../lib/prompts/projectNameAndDestPrompt.js';
 import { cloneGithubRepo } from '@hubspot/local-dev-lib/github';
+import { HubSpotConfigAccount } from '@hubspot/local-dev-lib/types/Accounts';
 import {
   getProjectConfig,
   writeProjectConfig,
@@ -24,6 +26,7 @@ vi.mock('../../lib/ui/logger');
 vi.mock('../../lib/errorHandlers');
 vi.mock('@hubspot/local-dev-lib/github');
 vi.mock('../../lib/dependencyManagement');
+vi.mock('@hubspot/local-dev-lib/config');
 
 vi.mock('open');
 vi.mock('fs-extra', () => ({
@@ -37,6 +40,17 @@ vi.mock('fs-extra', () => ({
 describe('commands/get-started', () => {
   beforeEach(() => {
     vi.clearAllMocks();
+
+    // @TODO Revisit config mocking in tests
+    (
+      getConfigAccountById as MockedFunction<typeof getConfigAccountById>
+    ).mockReturnValue({
+      accountId: 12345,
+      name: 'Test Account',
+      authType: 'personalaccesskey',
+      personalAccessKey: 'test-key',
+      env: 'prod',
+    } as HubSpotConfigAccount);
   });
 
   describe('command', () => {

bin/cli.ts

@@ -13,6 +13,7 @@ import migrateApp from '../project/migrateApp.js';
 import migrate from '../project/migrate.js';
 import cloneApp from '../project/cloneApp.js';
 import installDeps from '../project/installDeps.js';
+import lint from '../project/lint.js';
 import updateDeps from '../project/updateDeps.js';
 import validate from '../project/validate.js';
 import profileCommands from '../project/profile.js';
@@ -39,6 +40,7 @@ vi.mock('../project/migrate', () => ({
   default: {},
 }));
 vi.mock('../project/installDeps');
+vi.mock('../project/lint');
 vi.mock('../project/profile');
 vi.mock('../../lib/commonOpts');
 
@@ -78,6 +80,7 @@ describe('commands/project', () => {
       migrate,
       cloneApp,
       installDeps,
+      lint,
       updateDeps,
       profileCommands,
       validate,

commands/__tests__/getStarted.test.ts

@@ -7,10 +7,12 @@ import accountRenameCommand, { AccountRenameArgs } from '../rename.js';
 import * as config from '@hubspot/local-dev-lib/config';
 import { logError } from '../../../lib/errorHandlers/index.js';
 import { EXIT_CODES } from '../../../lib/enums/exitCodes.js';
+import * as usageTracking from '../../../lib/usageTracking.js';
 
 vi.mock('../../../lib/commonOpts');
 vi.mock('@hubspot/local-dev-lib/config');
 vi.mock('../../../lib/errorHandlers/index.js');
+vi.mock('../../../lib/usageTracking.js');
 
 const positionalSpy = vi
   .spyOn(yargs as Argv, 'positional')
@@ -19,8 +21,9 @@ const exampleSpy = vi
   .spyOn(yargs as Argv, 'example')
   .mockReturnValue(yargs as Argv);
 
-const renameAccountSpy = vi.spyOn(config, 'renameAccount');
+const renameAccountSpy = vi.spyOn(config, 'renameConfigAccount');
 const processExitSpy = vi.spyOn(process, 'exit');
+const trackCommandUsageSpy = vi.spyOn(usageTracking, 'trackCommandUsage');
 
 describe('commands/account/rename', () => {
   const yargsMock = yargs as Argv;
@@ -44,7 +47,7 @@ describe('commands/account/rename', () => {
 
     beforeEach(() => {
       vi.clearAllMocks();
-      renameAccountSpy.mockResolvedValue(undefined);
+      renameAccountSpy.mockReturnValue(undefined);
       processExitSpy.mockImplementation(() => {
         throw new Error('process.exit called');
       });
@@ -58,6 +61,11 @@ describe('commands/account/rename', () => {
       await expect(accountRenameCommand.handler(args)).rejects.toThrow(
         'process.exit called'
       );
+      expect(trackCommandUsageSpy).toHaveBeenCalledWith(
+        'accounts-rename',
+        undefined,
+        undefined
+      );
       expect(renameAccountSpy).toHaveBeenCalledWith(
         'myExistingAccountName',
         'my-new-account-name'
@@ -67,12 +75,19 @@ describe('commands/account/rename', () => {
 
     it('should handle errors when renameAccount throws', async () => {
       const error = new Error('Failed to rename account');
-      renameAccountSpy.mockRejectedValue(error);
+      renameAccountSpy.mockImplementation(() => {
+        throw error;
+      });
 
       await expect(accountRenameCommand.handler(args)).rejects.toThrow(
         'process.exit called'
       );
 
+      expect(trackCommandUsageSpy).toHaveBeenCalledWith(
+        'accounts-rename',
+        undefined,
+        undefined
+      );
       expect(renameAccountSpy).toHaveBeenCalledWith(
         'myExistingAccountName',
         'my-new-account-name'

commands/__tests__/project.test.ts

@@ -1,24 +1,20 @@
 import { Argv, ArgumentsCamelCase } from 'yargs';
 import {
-  loadConfig,
-  updateAccountConfig,
-  writeConfig,
+  updateConfigAccount,
   createEmptyConfigFile,
-  deleteEmptyConfigFile,
+  deleteConfigFileIfEmpty,
+  getConfigFilePath,
+  localConfigFileExists,
+  globalConfigFileExists,
 } from '@hubspot/local-dev-lib/config';
-import {
-  configFileExists,
-  getConfigPath,
-} from '@hubspot/local-dev-lib/config/migrate';
-import { getAccountIdentifier } from '@hubspot/local-dev-lib/config/getAccountIdentifier';
 import {
   getAccessToken,
   updateConfigWithAccessToken,
 } from '@hubspot/local-dev-lib/personalAccessKey';
 import { ENVIRONMENTS } from '@hubspot/local-dev-lib/constants/environments';
 import { toKebabCase } from '@hubspot/local-dev-lib/text';
 import { Environment } from '@hubspot/local-dev-lib/types/Config';
-import { CLIAccount } from '@hubspot/local-dev-lib/types/Accounts';
+import { HubSpotConfigAccount } from '@hubspot/local-dev-lib/types/Accounts';
 import { PERSONAL_ACCESS_KEY_AUTH_METHOD } from '@hubspot/local-dev-lib/constants/auth';
 import { handleMerge, handleMigration } from '../../lib/configMigrate.js';
 import { handleExit } from '../../lib/process.js';
@@ -52,7 +48,7 @@ async function updateConfigWithNewAccount(
   configAlreadyExists: boolean,
   providedPersonalAccessKey?: string,
   accountId?: number
-): Promise<CLIAccount | null> {
+): Promise<HubSpotConfigAccount | null> {
   try {
     const { personalAccessKey } = providedPersonalAccessKey
       ? { personalAccessKey: providedPersonalAccessKey }
@@ -84,10 +80,9 @@ async function updateConfigWithNewAccount(
       updatedConfig.name = (
         await cliAccountNamePrompt(defaultAccountName)
       ).name;
-      updateAccountConfig({
+      updateConfigAccount({
         ...updatedConfig,
       });
-      writeConfig();
     }
 
     return updatedConfig;
@@ -98,8 +93,8 @@ async function updateConfigWithNewAccount(
 }
 
 async function handleConfigMigration(): Promise<boolean> {
-  const deprecatedConfigExists = configFileExists(false);
-  const globalConfigExists = configFileExists(true);
+  const deprecatedConfigExists = localConfigFileExists();
+  const globalConfigExists = globalConfigFileExists();
 
   // No deprecated config exists, so no migration is needed
   if (!deprecatedConfigExists) {
@@ -181,15 +176,13 @@ async function handler(
     process.exit(EXIT_CODES.ERROR);
   }
 
-  const configAlreadyExists = configFileExists(true);
+  const configAlreadyExists = globalConfigFileExists();
 
   if (!configAlreadyExists) {
-    createEmptyConfigFile({}, true);
+    createEmptyConfigFile(true);
   }
 
-  loadConfig('');
-
-  handleExit(deleteEmptyConfigFile);
+  handleExit(deleteConfigFileIfEmpty);
 
   const updatedConfig = await updateConfigWithNewAccount(
     args.qa ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD,
@@ -209,20 +202,20 @@ async function handler(
     process.exit(EXIT_CODES.ERROR);
   }
 
-  const accountId = getAccountIdentifier(updatedConfig);
+  const { accountId, name } = updatedConfig;
 
   if (!configAlreadyExists) {
     uiLogger.log('');
     uiLogger.success(
       commands.account.subcommands.auth.success.configFileCreated(
-        getConfigPath('', true)!
+        getConfigFilePath()
       )
     );
     uiLogger.success(
-      commands.account.subcommands.auth.success.configFileUpdated(accountId!)
+      commands.account.subcommands.auth.success.configFileUpdated(accountId)
     );
   } else {
-    await setAsDefaultAccountPrompt(updatedConfig.name!);
+    await setAsDefaultAccountPrompt(name);
   }
 
   uiFeatureHighlight([