@hubspot/cli 8.1.0 → 8.1.2-experimental.0

package/commands/project/deploy.js

@@ -1,57 +1,60 @@
 import { fetchProject } from '@hubspot/local-dev-lib/api/projects';
 import { getConfigAccountById } from '@hubspot/local-dev-lib/config';
 import { isHubSpotHttpError } from '@hubspot/local-dev-lib/errors/index';
-import { isV2Project } from '../../lib/projects/platformVersion.js';
-import { trackCommandUsage } from '../../lib/usageTracking.js';
+import { isLegacyProject } from '@hubspot/project-parsing-lib/projects';
 import { logError, ApiErrorContext } from '../../lib/errorHandlers/index.js';
-import { getProjectConfig } from '../../lib/projects/config.js';
+import { getProjectConfig, validateProjectConfig, } from '../../lib/projects/config.js';
 import { projectNamePrompt } from '../../lib/prompts/projectNamePrompt.js';
+import { projectProfilePrompt } from '../../lib/prompts/projectProfilePrompt.js';
 import { promptUser } from '../../lib/prompts/promptUtils.js';
 import { EXIT_CODES } from '../../lib/enums/exitCodes.js';
 import { uiLogger } from '../../lib/ui/logger.js';
+import { makeWrappedYargsHandler } from '../../lib/yargs/makeWrappedYargsHandler.js';
 import { makeYargsBuilder } from '../../lib/yargsUtils.js';
-import { loadProfile, logProfileFooter, logProfileHeader, enforceProfileUsage, } from '../../lib/projects/projectProfiles.js';
+import { loadProfile } from '../../lib/projects/projectProfiles.js';
 import { PROJECT_DEPLOY_TEXT } from '../../lib/constants.js';
 import { commands } from '../../lang/en.js';
 import { handleProjectDeploy, validateBuildIdForDeploy, logDeployErrors, } from '../../lib/projects/deploy.js';
 const command = 'deploy';
 const describe = commands.project.deploy.describe;
 async function handler(args) {
-    const { derivedAccountId, project: projectOption, buildId: buildIdOption, force: forceOption, deployLatestBuild: deployLatestBuildOption, json: formatOutputAsJson, } = args;
+    const { derivedAccountId, project: projectOption, buildId: buildIdOption, force: forceOption, deployLatestBuild: deployLatestBuildOption, json: formatOutputAsJson, profile: profileOption, useEnv: useEnvOption, exit, addUsageMetadata, } = args;
     const accountConfig = getConfigAccountById(derivedAccountId);
     const accountType = accountConfig && accountConfig.accountType;
     let targetAccountId;
     const jsonOutput = {};
     const { projectConfig, projectDir } = await getProjectConfig();
-    if (isV2Project(projectConfig?.platformVersion)) {
-        if (args.profile) {
-            logProfileHeader(args.profile);
-            let profile;
-            try {
-                profile = loadProfile(projectConfig, projectDir, args.profile);
-            }
-            catch (error) {
-                logError(error);
-                process.exit(EXIT_CODES.ERROR);
+    let isInProjectDirectory = false;
+    // Validate project config, but it's valid to run this command from outside a project dir
+    try {
+        validateProjectConfig(projectConfig, projectDir);
+        isInProjectDirectory = true;
+    }
+    catch (e) { }
+    if (isInProjectDirectory &&
+        !isLegacyProject(projectConfig?.platformVersion)) {
+        try {
+            const profileName = await projectProfilePrompt(projectDir, projectConfig, profileOption, !!useEnvOption);
+            if (profileName) {
+                // Use loadProfile instead of loadAndValidateProfile because the local
+                // profile does not need to be valid to successfully deploy
+                const profile = loadProfile(projectConfig, projectDir, profileName);
+                targetAccountId = profile.accountId;
+                uiLogger.log(commands.project.deploy.profileMessage(profileName, targetAccountId));
+                uiLogger.log('');
             }
-            targetAccountId = profile.accountId;
-            logProfileFooter(profile);
         }
-        else {
-            // A profile must be specified if this project has profiles configured
-            try {
-                await enforceProfileUsage(projectConfig, projectDir);
-            }
-            catch (error) {
-                logError(error);
-                process.exit(EXIT_CODES.ERROR);
-            }
+        catch (error) {
+            logError(error);
+            return exit(EXIT_CODES.ERROR);
         }
     }
     if (!targetAccountId) {
         targetAccountId = derivedAccountId;
     }
-    trackCommandUsage('project-deploy', accountType ? { type: accountType } : undefined, targetAccountId);
+    if (accountType) {
+        addUsageMetadata({ type: accountType });
+    }
     let projectName = projectOption;
     if (!projectOption && projectConfig) {
         projectName = projectConfig.name;
@@ -66,13 +69,13 @@ async function handler(args) {
         const { data: { latestBuild, deployedBuildId }, } = await fetchProject(targetAccountId, projectName);
         if (!latestBuild || !latestBuild.buildId) {
             uiLogger.error(commands.project.deploy.errors.noBuilds);
-            return process.exit(EXIT_CODES.ERROR);
+            return exit(EXIT_CODES.ERROR);
         }
         if (buildIdToDeploy) {
             const validationResult = validateBuildIdForDeploy(buildIdToDeploy, deployedBuildId, latestBuild.buildId, projectName, targetAccountId);
             if (validationResult !== true) {
                 uiLogger.error(validationResult.toString());
-                return process.exit(EXIT_CODES.ERROR);
+                return exit(EXIT_CODES.ERROR);
             }
         }
         else {
@@ -93,11 +96,11 @@ async function handler(args) {
         }
         if (!buildIdToDeploy) {
             uiLogger.error(commands.project.deploy.errors.noBuildId);
-            return process.exit(EXIT_CODES.ERROR);
+            return exit(EXIT_CODES.ERROR);
         }
-        const deployResult = await handleProjectDeploy(targetAccountId, projectName, buildIdToDeploy, isV2Project(projectConfig?.platformVersion), forceOption);
+        const deployResult = await handleProjectDeploy(targetAccountId, projectName, buildIdToDeploy, isLegacyProject(projectConfig?.platformVersion), forceOption);
         if (!deployResult) {
-            return process.exit(EXIT_CODES.ERROR);
+            return exit(EXIT_CODES.ERROR);
         }
         else if (formatOutputAsJson) {
             jsonOutput.deployId = deployResult.deployId;
@@ -124,16 +127,16 @@ async function handler(args) {
                 request: 'project deploy',
             }));
         }
-        return process.exit(EXIT_CODES.ERROR);
+        return exit(EXIT_CODES.ERROR);
     }
     if (formatOutputAsJson) {
         uiLogger.json(jsonOutput);
     }
     if (deploySuccess) {
-        process.exit(EXIT_CODES.SUCCESS);
+        return exit(EXIT_CODES.SUCCESS);
     }
     else {
-        process.exit(EXIT_CODES.ERROR);
+        return exit(EXIT_CODES.ERROR);
     }
 }
 function projectDeployBuilder(yargs) {
@@ -191,6 +194,6 @@ const projectDeployCommand = {
     command,
     describe,
     builder,
-    handler,
+    handler: makeWrappedYargsHandler('project-deploy', handler),
 };
 export default projectDeployCommand;

package/commands/project/dev/deprecatedFlow.js

@@ -1,4 +1,5 @@
-import { getConfigAccountById, getAllConfigAccounts, getConfigAccountEnvironment, } from '@hubspot/local-dev-lib/config';
+import { getConfigAccountById, getLinkedOrAllConfigAccounts, getConfigAccountEnvironment, } from '@hubspot/local-dev-lib/config';
+import { getHsSettingsFileIfExists, getHsSettingsFilePath, } from '@hubspot/local-dev-lib/config/hsSettings';
 import { findProjectComponents, getProjectComponentTypes, } from '../../../lib/projects/structure.js';
 import { ComponentTypes } from '../../../types/Projects.js';
 import { commands } from '../../../lang/en.js';
@@ -8,10 +9,12 @@ import LocalDevManager_DEPRECATED from '../../../lib/projects/localDev/LocalDevM
 import { confirmDefaultAccountIsTarget, suggestRecommendedNestedAccount, checkIfAccountFlagIsSupported, checkIfDefaultAccountIsSupported, createSandboxForLocalDev, createDeveloperTestAccountForLocalDev, useExistingDevTestAccount, checkIfParentAccountIsAuthed, hasSandboxes, } from '../../../lib/projects/localDev/helpers/account.js';
 import { createInitialBuildForNewProject, createNewProjectForLocalDev, } from '../../../lib/projects/localDev/helpers/project.js';
 import { handleExit } from '../../../lib/process.js';
+import { getErrorMessage } from '../../../lib/errorHandlers/index.js';
 import { isSandbox, isDeveloperTestAccount, } from '../../../lib/accountTypes.js';
 import { ensureProjectExists } from '../../../lib/projects/ensureProjectExists.js';
+import { isDirectoryLinked, addAccountToLinkedSettings, } from '../../../lib/link/linkUtils.js';
 export async function deprecatedProjectDevFlow({ args, accountId, projectConfig, projectDir, }) {
-    const { userProvidedAccount, derivedAccountId } = args;
+    const { userProvidedAccount, derivedAccountId, exit } = args;
     const env = getConfigAccountEnvironment(derivedAccountId);
     const components = await findProjectComponents(projectDir);
     const runnableComponents = components.filter(component => component.runnable);
@@ -21,20 +24,22 @@ export async function deprecatedProjectDevFlow({ args, accountId, projectConfig,
     const accountConfig = getConfigAccountById(accountId);
     if (!accountConfig) {
         uiLogger.error(commands.project.dev.errors.noAccount(accountId));
-        process.exit(EXIT_CODES.ERROR);
+        return exit(EXIT_CODES.ERROR);
     }
     if (runnableComponents.length === 0) {
         uiLogger.error(commands.project.dev.errors.noRunnableComponents);
-        process.exit(EXIT_CODES.SUCCESS);
+        return exit(EXIT_CODES.SUCCESS);
     }
     else if (hasPrivateApps && hasPublicApps) {
         uiLogger.error(commands.project.dev.errors.invalidProjectComponents);
-        process.exit(EXIT_CODES.SUCCESS);
+        return exit(EXIT_CODES.SUCCESS);
     }
-    const accounts = getAllConfigAccounts();
+    const hsSettings = getHsSettingsFileIfExists();
+    const directoryIsLinked = isDirectoryLinked(hsSettings);
+    const accounts = getLinkedOrAllConfigAccounts();
     if (!accounts) {
         uiLogger.error(commands.project.dev.errors.noAccountsInConfig);
-        process.exit(EXIT_CODES.ERROR);
+        return exit(EXIT_CODES.ERROR);
     }
     let bypassRecommendedAccountPrompt = false;
     if (isDeveloperTestAccount(accountConfig)) {
@@ -54,20 +59,36 @@ export async function deprecatedProjectDevFlow({ args, accountId, projectConfig,
     let targetTestingAccountId = userProvidedAccount ? derivedAccountId : null;
     // Check that the default account or flag option is valid for the type of app in this project
     if (userProvidedAccount) {
-        checkIfAccountFlagIsSupported(accountConfig, hasPublicApps);
+        try {
+            checkIfAccountFlagIsSupported(accountConfig, hasPublicApps);
+        }
+        catch (e) {
+            uiLogger.error(getErrorMessage(e));
+            return exit(EXIT_CODES.SUCCESS);
+        }
         if (hasPublicApps) {
             targetProjectAccountId = accountConfig.parentAccountId || null;
         }
     }
     else {
-        await checkIfDefaultAccountIsSupported(accountConfig, hasPublicApps);
+        await checkIfDefaultAccountIsSupported(accountConfig, hasPublicApps, exit);
+    }
+    if (directoryIsLinked) {
+        uiLogger.log('');
+        uiLogger.info(commands.account.subcommands.link.shared.usingLinkedAccounts(getHsSettingsFilePath()));
     }
     // The user is targeting an account type that we recommend developing on
     if (!targetProjectAccountId && bypassRecommendedAccountPrompt) {
         targetTestingAccountId = derivedAccountId;
-        await confirmDefaultAccountIsTarget(accountConfig);
+        await confirmDefaultAccountIsTarget(accountConfig, exit);
         if (hasPublicApps) {
-            checkIfParentAccountIsAuthed(accountConfig);
+            try {
+                checkIfParentAccountIsAuthed(accountConfig);
+            }
+            catch (e) {
+                uiLogger.error(getErrorMessage(e));
+                return exit(EXIT_CODES.SUCCESS);
+            }
             targetProjectAccountId = accountConfig.parentAccountId || null;
         }
         else {
@@ -84,23 +105,45 @@ export async function deprecatedProjectDevFlow({ args, accountId, projectConfig,
         targetTestingAccountId = targetAccountId;
         // Only used for developer test accounts that are not yet in the config
         if (notInConfigAccount) {
-            await useExistingDevTestAccount(env, notInConfigAccount);
+            const accountAdded = await useExistingDevTestAccount(env, notInConfigAccount);
+            if (!accountAdded) {
+                return exit(EXIT_CODES.SUCCESS);
+            }
+            if (directoryIsLinked) {
+                addAccountToLinkedSettings(notInConfigAccount.id);
+            }
         }
         createNewSandbox = hasPrivateApps && createNestedAccount;
         createNewDeveloperTestAccount = hasPublicApps && createNestedAccount;
     }
     if (createNewSandbox) {
-        targetProjectAccountId = await createSandboxForLocalDev(derivedAccountId, accountConfig, env);
+        try {
+            targetProjectAccountId = await createSandboxForLocalDev(derivedAccountId, accountConfig, env);
+        }
+        catch {
+            return exit(EXIT_CODES.ERROR);
+        }
         // We will be running our tests against this new sandbox account
         targetTestingAccountId = targetProjectAccountId;
+        if (directoryIsLinked) {
+            addAccountToLinkedSettings(targetProjectAccountId);
+        }
     }
     if (createNewDeveloperTestAccount) {
-        targetTestingAccountId = await createDeveloperTestAccountForLocalDev(derivedAccountId, accountConfig, env);
+        try {
+            targetTestingAccountId = await createDeveloperTestAccountForLocalDev(derivedAccountId, accountConfig, env, false);
+        }
+        catch {
+            return exit(EXIT_CODES.ERROR);
+        }
         targetProjectAccountId = derivedAccountId;
+        if (directoryIsLinked) {
+            addAccountToLinkedSettings(targetTestingAccountId);
+        }
     }
     if (!targetProjectAccountId || !targetTestingAccountId) {
         uiLogger.error(commands.project.dev.errors.noAccount(accountId));
-        process.exit(EXIT_CODES.ERROR);
+        return exit(EXIT_CODES.ERROR);
     }
     // eslint-disable-next-line prefer-const
     let { projectExists, project } = await ensureProjectExists(targetProjectAccountId, projectConfig.name, {
@@ -115,8 +158,8 @@ export async function deprecatedProjectDevFlow({ args, accountId, projectConfig,
         isGithubLinked = Boolean(project.sourceIntegration && project.sourceIntegration.source === 'GITHUB');
     }
     else {
-        project = await createNewProjectForLocalDev(projectConfig, targetProjectAccountId, createNewSandbox, hasPublicApps);
-        deployedBuild = await createInitialBuildForNewProject(projectConfig, projectDir, targetProjectAccountId);
+        project = await createNewProjectForLocalDev(projectConfig, targetProjectAccountId, createNewSandbox, hasPublicApps, exit);
+        deployedBuild = await createInitialBuildForNewProject(projectConfig, projectDir, targetProjectAccountId, exit);
     }
     const LocalDev = new LocalDevManager_DEPRECATED({
         runnableComponents,
@@ -129,6 +172,8 @@ export async function deprecatedProjectDevFlow({ args, accountId, projectConfig,
         projectId: project.id,
         targetAccountId: targetTestingAccountId,
         env,
+        exit,
+        port: args.port,
     });
     await LocalDev.start();
     handleExit(({ isSIGHUP }) => LocalDev.stop(!isSIGHUP));

package/commands/project/dev/index.d.ts

@@ -1,5 +1,5 @@
-import { Argv, CommandModule } from 'yargs';
-import { ProjectDevArgs } from '../../../types/Yargs.js';
+import { Argv } from 'yargs';
+import { ProjectDevArgs, YargsCommandModule } from '../../../types/Yargs.js';
 export declare const builder: (yargs: Argv) => Promise<Argv<ProjectDevArgs>>;
-declare const projectDevCommand: CommandModule<unknown, ProjectDevArgs>;
+declare const projectDevCommand: YargsCommandModule<unknown, ProjectDevArgs>;
 export default projectDevCommand;

package/commands/project/dev/index.js

@@ -1,48 +1,52 @@
-import { trackCommandUsage } from '../../../lib/usageTracking.js';
 import { getConfigAccountIfExists } from '@hubspot/local-dev-lib/config';
-import { getAllHsProfiles, } from '@hubspot/project-parsing-lib/profiles';
 import { getProjectConfig, validateProjectConfig, } from '../../../lib/projects/config.js';
 import { EXIT_CODES } from '../../../lib/enums/exitCodes.js';
 import { uiLine } from '../../../lib/ui/index.js';
+import { makeWrappedYargsHandler } from '../../../lib/yargs/makeWrappedYargsHandler.js';
 import { deprecatedProjectDevFlow } from './deprecatedFlow.js';
 import { unifiedProjectDevFlow } from './unifiedFlow.js';
-import { isV2Project } from '../../../lib/projects/platformVersion.js';
+import { isLegacyProject } from '@hubspot/project-parsing-lib/projects';
 import { makeYargsBuilder } from '../../../lib/yargsUtils.js';
-import { loadProfile } from '../../../lib/projects/projectProfiles.js';
+import { loadAndValidateProfile } from '../../../lib/projects/projectProfiles.js';
 import { commands } from '../../../lang/en.js';
 import { uiLogger } from '../../../lib/ui/logger.js';
 import { logError } from '../../../lib/errorHandlers/index.js';
-import path from 'path';
-import { listPrompt } from '../../../lib/prompts/promptUtils.js';
+import { projectProfilePrompt } from '../../../lib/prompts/projectProfilePrompt.js';
+import { isPromptExitError } from '../../../lib/errors/PromptExitError.js';
+import { LOCAL_DEV_DEFAULT_PORT } from '../../../lib/constants.js';
 const command = 'dev';
 const describe = commands.project.dev.describe;
 function validateAccountFlags(testingAccount, projectAccount, userProvidedAccount, useV2) {
     // Legacy projects do not support targetTestingAccount and targetProjectAccount
     if (testingAccount && projectAccount && !useV2) {
-        uiLogger.error(commands.project.dev.errors.unsupportedAccountFlagLegacy);
-        process.exit(EXIT_CODES.ERROR);
+        throw new Error(commands.project.dev.errors.unsupportedAccountFlagLegacy);
     }
     if (userProvidedAccount && useV2) {
-        uiLogger.error(commands.project.dev.errors.unsupportedAccountFlagV2);
-        process.exit(EXIT_CODES.ERROR);
+        throw new Error(commands.project.dev.errors.unsupportedAccountFlagV2);
     }
 }
 async function handler(args) {
-    const { derivedAccountId, userProvidedAccount, testingAccount, projectAccount, } = args;
+    const { derivedAccountId, userProvidedAccount, testingAccount, projectAccount, profile: profileOption, exit, addUsageMetadata, } = args;
     const { projectConfig, projectDir } = await getProjectConfig();
     try {
         validateProjectConfig(projectConfig, projectDir);
     }
     catch (error) {
         logError(error);
-        process.exit(EXIT_CODES.ERROR);
+        return exit(EXIT_CODES.ERROR);
     }
-    const useV2Projects = isV2Project(projectConfig.platformVersion);
+    const useV2Projects = !isLegacyProject(projectConfig.platformVersion);
     if (!projectDir) {
         uiLogger.error(commands.project.dev.errors.noProjectConfig);
-        process.exit(EXIT_CODES.ERROR);
+        return exit(EXIT_CODES.ERROR);
+    }
+    try {
+        validateAccountFlags(testingAccount, projectAccount, userProvidedAccount, useV2Projects);
+    }
+    catch (error) {
+        logError(error);
+        return exit(EXIT_CODES.ERROR);
     }
-    validateAccountFlags(testingAccount, projectAccount, userProvidedAccount, useV2Projects);
     uiLogger.log(commands.project.dev.logs.header);
     if (useV2Projects) {
         uiLogger.log(commands.project.dev.logs.learnMoreMessageV2);
@@ -66,19 +70,12 @@ async function handler(args) {
         targetProjectAccountId = derivedAccountId;
     }
     // Determine profile name: from flag or prompt
-    if (!targetProjectAccountId && isV2Project(projectConfig.platformVersion)) {
-        let profileName = args.profile;
-        if (!profileName) {
-            const existingProfiles = await getAllHsProfiles(path.join(projectDir, projectConfig.srcDir));
-            if (existingProfiles.length !== 0) {
-                profileName = await listPrompt(commands.project.dev.prompts.selectProfile, {
-                    choices: existingProfiles,
-                });
-            }
-        }
+    if (!targetProjectAccountId &&
+        !isLegacyProject(projectConfig.platformVersion)) {
+        const profileName = await projectProfilePrompt(projectDir, projectConfig, profileOption);
         if (profileName) {
             try {
-                profile = loadProfile(projectConfig, projectDir, profileName);
+                profile = await loadAndValidateProfile(projectConfig, projectDir, profileName);
                 targetProjectAccountId = profile.accountId;
                 uiLogger.log('');
                 uiLogger.log(commands.project.dev.logs.profileProjectAccountExplanation(targetProjectAccountId, profileName));
@@ -86,7 +83,7 @@ async function handler(args) {
             catch (error) {
                 logError(error);
                 uiLine();
-                process.exit(EXIT_CODES.ERROR);
+                return exit(EXIT_CODES.ERROR);
             }
         }
     }
@@ -98,27 +95,36 @@ async function handler(args) {
             uiLogger.log(commands.project.dev.logs.defaultProjectAccountExplanation(targetProjectAccountId));
         }
     }
-    trackCommandUsage('project-dev', {}, targetProjectAccountId);
-    if (isV2Project(projectConfig.platformVersion)) {
-        const targetTestingAccountId = testingAccount
-            ? getConfigAccountIfExists(testingAccount)?.accountId
-            : undefined;
-        await unifiedProjectDevFlow({
-            args,
-            targetProjectAccountId,
-            providedTargetTestingAccountId: targetTestingAccountId,
-            projectConfig,
-            projectDir,
-            profileConfig: profile,
-        });
+    addUsageMetadata({ accountId: targetProjectAccountId ?? undefined });
+    try {
+        if (!isLegacyProject(projectConfig.platformVersion)) {
+            const targetTestingAccountId = testingAccount
+                ? getConfigAccountIfExists(testingAccount)?.accountId
+                : undefined;
+            await unifiedProjectDevFlow({
+                args,
+                targetProjectAccountId,
+                providedTargetTestingAccountId: targetTestingAccountId,
+                projectConfig,
+                projectDir,
+                profileConfig: profile,
+            });
+        }
+        else {
+            await deprecatedProjectDevFlow({
+                args,
+                accountId: targetProjectAccountId,
+                projectConfig,
+                projectDir,
+            });
+        }
     }
-    else {
-        await deprecatedProjectDevFlow({
-            args,
-            accountId: targetProjectAccountId,
-            projectConfig,
-            projectDir,
-        });
+    catch (e) {
+        if (isPromptExitError(e)) {
+            throw e;
+        }
+        logError(e);
+        return exit(EXIT_CODES.ERROR);
     }
 }
 function projectDevBuilder(yargs) {
@@ -144,6 +150,11 @@ function projectDevBuilder(yargs) {
         type: 'string',
         description: commands.project.dev.options.account,
     });
+    yargs.option('port', {
+        type: 'number',
+        description: commands.project.dev.options.port,
+        default: LOCAL_DEV_DEFAULT_PORT,
+    });
     yargs.example([['$0 project dev', commands.project.dev.examples.default]]);
     yargs.conflicts('profile', 'account');
     yargs.conflicts('profile', 'testing-account');
@@ -158,7 +169,7 @@ export const builder = makeYargsBuilder(projectDevBuilder, command, describe, {
 const projectDevCommand = {
     command,
     describe,
-    handler,
+    handler: makeWrappedYargsHandler('project-dev', handler),
     builder,
 };
 export default projectDevCommand;