@hubspot/cli 7.7.19-experimental.2 → 7.7.20-experimental.0

package/commands/project/__tests__/deploy.test.js

@@ -0,0 +1,344 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = require("axios");
+const yargs_1 = __importDefault(require("yargs"));
+const chalk_1 = __importDefault(require("chalk"));
+const configUtils = __importStar(require("@hubspot/local-dev-lib/config"));
+const logger_1 = require("@hubspot/local-dev-lib/logger");
+const projectApiUtils = __importStar(require("@hubspot/local-dev-lib/api/projects"));
+const ui = __importStar(require("../../../lib/ui"));
+const commonOpts_1 = require("../../../lib/commonOpts");
+const projectUtils = __importStar(require("../../../lib/projects/config"));
+const projectUrlUtils = __importStar(require("../../../lib/projects/urls"));
+const buildAndDeploy_1 = require("../../../lib/projects/buildAndDeploy");
+const projectNamePrompt = __importStar(require("../../../lib/prompts/projectNamePrompt"));
+const promptUtils = __importStar(require("../../../lib/prompts/promptUtils"));
+const usageTracking_1 = require("../../../lib/usageTracking");
+const exitCodes_1 = require("../../../lib/enums/exitCodes");
+const exampleProject_json_1 = __importDefault(require("./fixtures/exampleProject.json"));
+const testUtils_1 = require("../../../lib/testUtils");
+const deploy_1 = __importDefault(require("../deploy"));
+vi.mock('@hubspot/local-dev-lib/logger');
+vi.mock('@hubspot/local-dev-lib/api/projects');
+vi.mock('@hubspot/local-dev-lib/config');
+vi.mock('../../../lib/commonOpts');
+vi.mock('../../../lib/validation');
+vi.mock('../../../lib/projects/config');
+vi.mock('../../../lib/projects/urls');
+vi.mock('../../../lib/projects/buildAndDeploy');
+vi.mock('../../../lib/prompts/projectNamePrompt');
+vi.mock('../../../lib/prompts/promptUtils');
+vi.mock('../../../lib/usageTracking');
+vi.spyOn(ui, 'uiLine');
+const uiLinkSpy = vi.spyOn(ui, 'uiLink').mockImplementation(text => text);
+const uiCommandReferenceSpy = vi.spyOn(ui, 'uiCommandReference');
+const uiAccountDescriptionSpy = vi.spyOn(ui, 'uiAccountDescription');
+const getProjectConfigSpy = vi.spyOn(projectUtils, 'getProjectConfig');
+const projectNamePromptSpy = vi.spyOn(projectNamePrompt, 'projectNamePrompt');
+const getProjectDetailUrlSpy = vi.spyOn(projectUrlUtils, 'getProjectDetailUrl');
+const fetchProjectSpy = vi.spyOn(projectApiUtils, 'fetchProject');
+const deployProjectSpy = vi.spyOn(projectApiUtils, 'deployProject');
+const getAccountConfigSpy = vi.spyOn(configUtils, 'getAccountConfig');
+const promptUserSpy = vi.spyOn(promptUtils, 'promptUser');
+const processExitSpy = vi.spyOn(process, 'exit');
+const optionsSpy = vi
+    .spyOn(yargs_1.default, 'options')
+    .mockReturnValue(yargs_1.default);
+const exampleSpy = vi
+    .spyOn(yargs_1.default, 'example')
+    .mockReturnValue(yargs_1.default);
+const conflictsSpy = vi
+    .spyOn(yargs_1.default, 'conflicts')
+    .mockReturnValue(yargs_1.default);
+describe('commands/project/deploy', () => {
+    const projectFlag = 'project';
+    const buildFlag = 'build';
+    const profileFlag = 'profile';
+    const forceFlag = 'force';
+    describe('command', () => {
+        it('should have the correct command structure', () => {
+            expect(deploy_1.default.command).toEqual('deploy');
+        });
+    });
+    describe('describe', () => {
+        it('should contain the beta tag', () => {
+            expect(deploy_1.default.describe).toContain('[BETA]');
+        });
+        it('should provide a description', () => {
+            expect(deploy_1.default.describe).toBeDefined();
+        });
+    });
+    describe('builder', () => {
+        it('should support the correct options', () => {
+            deploy_1.default.builder(yargs_1.default);
+            expect(conflictsSpy).toHaveBeenCalledTimes(2);
+            expect(conflictsSpy).toHaveBeenNthCalledWith(1, profileFlag, projectFlag);
+            expect(conflictsSpy).toHaveBeenNthCalledWith(2, profileFlag, 'account');
+            expect(optionsSpy).toHaveBeenCalledTimes(1);
+            expect(optionsSpy).toHaveBeenCalledWith({
+                [projectFlag]: expect.objectContaining({ type: 'string' }),
+                [buildFlag]: expect.objectContaining({
+                    alias: ['build-id'],
+                    type: 'number',
+                }),
+                [profileFlag]: expect.objectContaining({
+                    type: 'string',
+                    alias: ['p'],
+                    hidden: true,
+                }),
+                [forceFlag]: expect.objectContaining({
+                    type: 'boolean',
+                    alias: ['f'],
+                }),
+            });
+            expect(commonOpts_1.addConfigOptions).toHaveBeenCalledTimes(1);
+            expect(commonOpts_1.addConfigOptions).toHaveBeenCalledWith(yargs_1.default);
+            expect(commonOpts_1.addAccountOptions).toHaveBeenCalledTimes(1);
+            expect(commonOpts_1.addAccountOptions).toHaveBeenCalledWith(yargs_1.default);
+            expect(commonOpts_1.addUseEnvironmentOptions).toHaveBeenCalledTimes(1);
+            expect(commonOpts_1.addUseEnvironmentOptions).toHaveBeenCalledWith(yargs_1.default);
+        });
+        it('should provide examples', () => {
+            deploy_1.default.builder(yargs_1.default);
+            expect(exampleSpy).toHaveBeenCalledTimes(1);
+        });
+    });
+    describe('handler', () => {
+        let projectConfig;
+        const accountType = 'STANDARD';
+        let args;
+        const projectNameFromPrompt = 'project name from prompt';
+        const deployDetails = {
+            id: 123,
+        };
+        const projectDetailUrl = 'http://project-details-page-url.com';
+        const viewProjectsInHubSpot = 'View project builds in HubSpot';
+        beforeEach(() => {
+            args = {
+                project: 'project name from options',
+                buildId: 2,
+                derivedAccountId: 1234567890,
+            };
+            projectConfig = {
+                name: 'project name from config',
+                srcDir: 'src',
+                platformVersion: '2025',
+            };
+            getProjectConfigSpy.mockResolvedValue({
+                projectConfig,
+                projectDir: 'projectDir',
+            });
+            projectNamePromptSpy.mockResolvedValue({
+                projectName: projectNameFromPrompt,
+            });
+            getProjectDetailUrlSpy.mockReturnValue(projectDetailUrl);
+            uiLinkSpy.mockImplementation(text => {
+                return text;
+            });
+            getAccountConfigSpy.mockReturnValue({ accountType, env: 'qa' });
+            fetchProjectSpy.mockReturnValue((0, testUtils_1.mockHubSpotHttpResponse)(exampleProject_json_1.default));
+            deployProjectSpy.mockReturnValue((0, testUtils_1.mockHubSpotHttpResponse)(deployDetails));
+            // Spy on process.exit so our tests don't close when it's called
+            // @ts-expect-error Doesn't match the actual signature because then the linter complains about unused variables
+            processExitSpy.mockImplementation(() => { });
+        });
+        it('should load the account config for the correct account id', async () => {
+            await deploy_1.default.handler(args);
+            expect(getAccountConfigSpy).toHaveBeenCalledTimes(1);
+            expect(getAccountConfigSpy).toHaveBeenCalledWith(args.derivedAccountId);
+        });
+        it('should track the command usage', async () => {
+            await deploy_1.default.handler(args);
+            expect(usageTracking_1.trackCommandUsage).toHaveBeenCalledTimes(1);
+            expect(usageTracking_1.trackCommandUsage).toHaveBeenCalledWith('project-deploy', { type: accountType }, args.derivedAccountId);
+        });
+        it('should load the project config', async () => {
+            await deploy_1.default.handler(args);
+            expect(getProjectConfigSpy).toHaveBeenCalledTimes(1);
+            expect(getProjectConfigSpy).toHaveBeenCalled();
+        });
+        it('should prompt for the project name', async () => {
+            await deploy_1.default.handler(args);
+            expect(projectNamePromptSpy).toHaveBeenCalledTimes(1);
+            expect(projectNamePromptSpy).toHaveBeenCalledWith(args.derivedAccountId, {
+                project: args.project,
+            });
+        });
+        it('should use the project name from the config is a project args is not provided', async () => {
+            delete args.project;
+            await deploy_1.default.handler(args);
+            expect(projectNamePromptSpy).toHaveBeenCalledTimes(1);
+            expect(projectNamePromptSpy).toHaveBeenCalledWith(args.derivedAccountId, {
+                project: projectConfig.name,
+            });
+        });
+        it('should fetch the project details', async () => {
+            await deploy_1.default.handler(args);
+            expect(fetchProjectSpy).toHaveBeenCalledTimes(1);
+            expect(fetchProjectSpy).toHaveBeenCalledWith(args.derivedAccountId, projectNameFromPrompt);
+        });
+        it('should use the name from the prompt if no others are defined', async () => {
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            const { project: __project, ...argsWithoutProject } = args;
+            const promptProjectName = 'project name from the prompt';
+            projectNamePromptSpy.mockResolvedValue({
+                projectName: promptProjectName,
+            });
+            getProjectConfigSpy.mockResolvedValue({
+                projectConfig: null,
+                projectDir: null,
+            });
+            await deploy_1.default.handler(argsWithoutProject);
+            expect(projectNamePromptSpy).toHaveBeenCalledTimes(1);
+            expect(projectNamePromptSpy).toHaveBeenCalledWith(args.derivedAccountId, {});
+            expect(fetchProjectSpy).toHaveBeenCalledTimes(1);
+            expect(fetchProjectSpy).toHaveBeenCalledWith(args.derivedAccountId, promptProjectName);
+        });
+        it('should log an error and exit when latest build is not defined', async () => {
+            fetchProjectSpy.mockReturnValue((0, testUtils_1.mockHubSpotHttpResponse)({}));
+            await deploy_1.default.handler(args);
+            expect(logger_1.logger.error).toHaveBeenCalledTimes(1);
+            expect(logger_1.logger.error).toHaveBeenCalledWith('Deploy error: no builds for this project were found.');
+            expect(processExitSpy).toHaveBeenCalledTimes(1);
+            expect(processExitSpy).toHaveBeenCalledWith(exitCodes_1.EXIT_CODES.ERROR);
+        });
+        it('should log an error and exit when buildId option is not a valid build', async () => {
+            args.buildId = exampleProject_json_1.default.latestBuild.buildId + 1;
+            await deploy_1.default.handler(args);
+            expect(uiLinkSpy).toHaveBeenCalledTimes(1);
+            expect(uiLinkSpy).toHaveBeenCalledWith(viewProjectsInHubSpot, projectDetailUrl);
+            expect(logger_1.logger.error).toHaveBeenCalledTimes(1);
+            expect(logger_1.logger.error).toHaveBeenCalledWith(`Build ${args.buildId} does not exist for project ${projectNameFromPrompt}. ${viewProjectsInHubSpot}`);
+            expect(processExitSpy).toHaveBeenCalledTimes(1);
+            expect(processExitSpy).toHaveBeenCalledWith(exitCodes_1.EXIT_CODES.ERROR);
+        });
+        it('should log an error and exit when buildId option is already deployed', async () => {
+            args.buildId = exampleProject_json_1.default.deployedBuildId;
+            await deploy_1.default.handler(args);
+            expect(uiLinkSpy).toHaveBeenCalledTimes(1);
+            expect(uiLinkSpy).toHaveBeenCalledWith(viewProjectsInHubSpot, projectDetailUrl);
+            expect(logger_1.logger.error).toHaveBeenCalledTimes(1);
+            expect(logger_1.logger.error).toHaveBeenCalledWith(`Build ${args.buildId} is already deployed. ${viewProjectsInHubSpot}`);
+            expect(processExitSpy).toHaveBeenCalledTimes(1);
+            expect(processExitSpy).toHaveBeenCalledWith(exitCodes_1.EXIT_CODES.ERROR);
+        });
+        it('should prompt for build id if no option is provided', async () => {
+            delete args.buildId;
+            promptUserSpy.mockResolvedValue({
+                buildId: exampleProject_json_1.default.latestBuild.buildId,
+            });
+            await deploy_1.default.handler(args);
+            expect(promptUserSpy).toHaveBeenCalledTimes(1);
+        });
+        it('should log an error and exit if the prompted value is invalid', async () => {
+            delete args.buildId;
+            promptUserSpy.mockResolvedValue({});
+            await deploy_1.default.handler(args);
+            expect(promptUserSpy).toHaveBeenCalledTimes(1);
+            expect(logger_1.logger.error).toHaveBeenCalledTimes(1);
+            expect(logger_1.logger.error).toHaveBeenCalledWith('You must specify a build to deploy');
+            expect(processExitSpy).toHaveBeenCalledTimes(1);
+            expect(processExitSpy).toHaveBeenCalledWith(exitCodes_1.EXIT_CODES.ERROR);
+        });
+        it('should deploy the project', async () => {
+            await deploy_1.default.handler(args);
+            expect(deployProjectSpy).toHaveBeenCalledTimes(1);
+            expect(deployProjectSpy).toHaveBeenCalledWith(args.derivedAccountId, projectNameFromPrompt, args.buildId, undefined, undefined);
+        });
+        it('should log an error and exit when the deploy fails', async () => {
+            // @ts-expect-error Testing an edge case where the response is empty
+            deployProjectSpy.mockResolvedValue({});
+            await deploy_1.default.handler(args);
+            expect(logger_1.logger.error).toHaveBeenCalledTimes(1);
+            expect(logger_1.logger.error).toHaveBeenCalledWith(`Deploy error: an unknown error occurred.`);
+            expect(processExitSpy).toHaveBeenCalledTimes(1);
+            expect(processExitSpy).toHaveBeenCalledWith(exitCodes_1.EXIT_CODES.ERROR);
+        });
+        it('should poll the deploy status', async () => {
+            await deploy_1.default.handler(args);
+            expect(buildAndDeploy_1.pollDeployStatus).toHaveBeenCalledTimes(1);
+            expect(buildAndDeploy_1.pollDeployStatus).toHaveBeenCalledWith(args.derivedAccountId, projectNameFromPrompt, deployDetails.id, args.buildId);
+        });
+        it('log an error and exit if a 404 status is returned', async () => {
+            const commandReference = 'hs project upload';
+            const accountDescription = 'SuperCoolTestAccount';
+            uiCommandReferenceSpy.mockReturnValueOnce(commandReference);
+            uiAccountDescriptionSpy.mockReturnValueOnce(accountDescription);
+            fetchProjectSpy.mockImplementation(() => {
+                throw (0, testUtils_1.mockHubSpotHttpError)('OH NO', {
+                    status: axios_1.HttpStatusCode.NotFound,
+                    data: {},
+                });
+            });
+            await deploy_1.default.handler(args);
+            expect(logger_1.logger.error).toHaveBeenCalledTimes(1);
+            expect(logger_1.logger.error).toHaveBeenCalledWith(`The project ${chalk_1.default.bold(projectNameFromPrompt)} does not exist in account ${accountDescription}. Run ${commandReference} to upload your project files to HubSpot.`);
+            expect(processExitSpy).toHaveBeenCalledTimes(1);
+            expect(processExitSpy).toHaveBeenCalledWith(exitCodes_1.EXIT_CODES.ERROR);
+        });
+        it('log an error and exit if a 400 status is returned', async () => {
+            const errorMessage = 'Something bad happened';
+            fetchProjectSpy.mockImplementation(() => {
+                throw (0, testUtils_1.mockHubSpotHttpError)(errorMessage, {
+                    status: axios_1.HttpStatusCode.BadRequest,
+                    data: {},
+                });
+            });
+            await deploy_1.default.handler(args);
+            expect(logger_1.logger.error).toHaveBeenCalledTimes(1);
+            expect(logger_1.logger.error).toHaveBeenCalledWith('The request was bad.');
+            expect(processExitSpy).toHaveBeenCalledTimes(1);
+            expect(processExitSpy).toHaveBeenCalledWith(exitCodes_1.EXIT_CODES.ERROR);
+        });
+        it('log an error another unexpected status code is returned', async () => {
+            const errorMessage = 'Something bad happened';
+            fetchProjectSpy.mockImplementation(() => {
+                throw (0, testUtils_1.mockHubSpotHttpError)(errorMessage, {
+                    status: axios_1.HttpStatusCode.MethodNotAllowed,
+                    data: {},
+                });
+            });
+            await deploy_1.default.handler(args);
+            expect(logger_1.logger.error).toHaveBeenCalledTimes(1);
+            expect(logger_1.logger.error).toHaveBeenCalledWith(`The request for 'project deploy' in account ${args.derivedAccountId} failed due to a client error.`);
+            expect(processExitSpy).toHaveBeenCalledTimes(1);
+            expect(processExitSpy).toHaveBeenCalledWith(exitCodes_1.EXIT_CODES.ERROR);
+        });
+    });
+});

package/commands/project/__tests__/devUnifiedFlow.test.d.ts

@@ -0,0 +1 @@
+export {};