@hubspot/cli 6.2.0 → 6.2.2-experimental.0

package/lib/__tests__/dependencyManagement.test.js

@@ -1,243 +0,0 @@
-jest.mock('../projects');
-jest.mock('@hubspot/local-dev-lib/logger');
-jest.mock('@hubspot/local-dev-lib/fs');
-jest.mock('../ui/SpinniesManager');
-jest.mock('fs', () => ({
-  ...jest.requireActual('fs'),
-  existsSync: jest.fn().mockReturnValue(true),
-}));
-
-const util = require('util');
-const {
-  isGloballyInstalled,
-  installPackages,
-  getProjectPackageJsonLocations,
-} = require('../dependencyManagement');
-const { walk } = require('@hubspot/local-dev-lib/fs');
-const path = require('path');
-const { getProjectConfig } = require('../projects');
-const SpinniesManager = require('../ui/SpinniesManager');
-const { existsSync } = require('fs');
-
-describe('cli/lib/dependencyManagement', () => {
-  let execMock;
-
-  const projectDir = path.join('path', 'to', 'project');
-  const srcDir = 'src';
-  const appDir = path.join(projectDir, srcDir, 'app');
-  const appFunctionsDir = path.join(appDir, 'app.functions');
-  const extensionsDir = path.join(appDir, 'exensions');
-  const projectName = 'super cool test project';
-  const installLocations = [appFunctionsDir, extensionsDir];
-
-  beforeEach(() => {
-    execMock = jest.fn();
-    util.promisify = jest.fn().mockReturnValue(execMock);
-    getProjectConfig.mockResolvedValue({
-      projectDir,
-      projectConfig: {
-        srcDir,
-        name: projectName,
-      },
-    });
-  });
-
-  describe('isGloballyInstalled', () => {
-    it('should return true when exec is successful', async () => {
-      const actual = await isGloballyInstalled('npm');
-      expect(actual).toBe(true);
-      expect(execMock).toHaveBeenCalledTimes(1);
-      expect(execMock).toHaveBeenCalledWith('npm --version');
-    });
-
-    it('should return false when exec is unsuccessful', async () => {
-      execMock = jest.fn().mockImplementationOnce(() => {
-        throw new Error('unsuccessful');
-      });
-      util.promisify = jest.fn().mockReturnValueOnce(execMock);
-      const actual = await isGloballyInstalled('npm');
-      expect(actual).toBe(false);
-      expect(execMock).toHaveBeenCalledTimes(1);
-      expect(execMock).toHaveBeenCalledWith('npm --version');
-    });
-  });
-
-  describe('installPackages', () => {
-    it('should setup a loading spinner', async () => {
-      const packages = ['package1', 'package2'];
-      await installPackages({ packages, installLocations });
-      expect(SpinniesManager.init).toHaveBeenCalledTimes(
-        installLocations.length
-      );
-      expect(SpinniesManager.add).toHaveBeenCalledTimes(
-        installLocations.length
-      );
-      expect(SpinniesManager.succeed).toHaveBeenCalledTimes(
-        installLocations.length
-      );
-    });
-
-    it('should install the provided packages in all the provided install locations', async () => {
-      const packages = ['package1', 'package2'];
-      await installPackages({ packages, installLocations });
-
-      expect(execMock).toHaveBeenCalledTimes(installLocations.length);
-      expect(SpinniesManager.add).toHaveBeenCalledTimes(
-        installLocations.length
-      );
-      expect(SpinniesManager.succeed).toHaveBeenCalledTimes(
-        installLocations.length
-      );
-
-      for (const location of installLocations) {
-        expect(execMock).toHaveBeenCalledWith(`npm install package1 package2`, {
-          cwd: location,
-        });
-        expect(SpinniesManager.add).toHaveBeenCalledWith(
-          `installingDependencies-${location}`,
-          {
-            text: `Installing [package1, package2] in ${location}`,
-          }
-        );
-        expect(SpinniesManager.succeed).toHaveBeenCalledWith(
-          `installingDependencies-${location}`,
-          {
-            text: `Installed dependencies in ${location}`,
-          }
-        );
-      }
-    });
-
-    it('should use the provided install locations', async () => {
-      await installPackages({ installLocations });
-      expect(execMock).toHaveBeenCalledTimes(installLocations.length);
-      expect(execMock).toHaveBeenCalledWith(`npm install`, {
-        cwd: appFunctionsDir,
-      });
-      expect(execMock).toHaveBeenCalledWith(`npm install`, {
-        cwd: extensionsDir,
-      });
-    });
-
-    it('should locate the projects package.json files when install locations is not provided', async () => {
-      const installLocations = [
-        path.join(appFunctionsDir, 'package.json'),
-        path.join(extensionsDir, 'package.json'),
-      ];
-
-      walk.mockResolvedValue(installLocations);
-
-      getProjectConfig.mockResolvedValue({
-        projectDir,
-        projectConfig: {
-          srcDir,
-        },
-      });
-
-      await installPackages({});
-      // It's called once per each install location, plus once to check if npm installed
-      expect(execMock).toHaveBeenCalledTimes(installLocations.length + 1);
-      expect(execMock).toHaveBeenCalledWith(`npm install`, {
-        cwd: appFunctionsDir,
-      });
-      expect(execMock).toHaveBeenCalledWith(`npm install`, {
-        cwd: extensionsDir,
-      });
-    });
-
-    it('should throw an error when installing the dependencies fails', async () => {
-      execMock = jest.fn().mockImplementation(command => {
-        if (command !== 'npm --version') {
-          throw new Error('OH NO');
-        }
-      });
-
-      util.promisify = jest.fn().mockReturnValue(execMock);
-
-      const installLocations = [
-        path.join(appFunctionsDir, 'package.json'),
-        path.join(extensionsDir, 'package.json'),
-      ];
-
-      walk.mockResolvedValue(installLocations);
-
-      getProjectConfig.mockResolvedValue({
-        projectDir,
-        projectConfig: {
-          srcDir,
-        },
-      });
-
-      await expect(() => installPackages({})).rejects.toThrowError(
-        `Installing dependencies for ${appFunctionsDir} failed`
-      );
-
-      expect(SpinniesManager.fail).toHaveBeenCalledTimes(
-        installLocations.length
-      );
-
-      expect(SpinniesManager.fail).toHaveBeenCalledWith(
-        `installingDependencies-${appFunctionsDir}`,
-        {
-          text: `Installing dependencies for ${appFunctionsDir} failed`,
-        }
-      );
-      expect(SpinniesManager.fail).toHaveBeenCalledWith(
-        `installingDependencies-${extensionsDir}`,
-        {
-          text: `Installing dependencies for ${extensionsDir} failed`,
-        }
-      );
-    });
-  });
-
-  describe('getProjectPackageJsonFiles', () => {
-    it('should throw an error when ran outside the boundary of a project', async () => {
-      getProjectConfig.mockResolvedValue({});
-      await expect(() => getProjectPackageJsonLocations()).rejects.toThrowError(
-        'No project detected. Run this command from a project directory.'
-      );
-    });
-
-    it('should throw an error if npm is not globally installed', async () => {
-      execMock = jest.fn().mockImplementation(() => {
-        throw new Error('OH NO');
-      });
-      util.promisify = jest.fn().mockReturnValue(execMock);
-      await expect(() => getProjectPackageJsonLocations()).rejects.toThrowError(
-        /This command depends on npm, install/
-      );
-    });
-
-    it('should throw an error if the project directory does not exist', async () => {
-      existsSync.mockReturnValueOnce(false);
-      await expect(() => getProjectPackageJsonLocations()).rejects.toThrowError(
-        `No dependencies to install. The project ${projectName} folder might be missing component or subcomponent files. Learn how to create a project from scratch.: https://developers.hubspot.com/beta-docs/guides/crm/intro/create-a-project`
-      );
-    });
-
-    it('should ignore package.json files in certain directories', async () => {
-      const nodeModulesDir = path.join(appDir, 'node_modules');
-      const viteDir = path.join(appDir, '.vite');
-      const installLocations = [
-        path.join(appFunctionsDir, 'package.json'),
-        path.join(extensionsDir, 'package.json'),
-        path.join(viteDir, 'package.json'),
-        path.join(nodeModulesDir, 'package.json'),
-      ];
-
-      walk.mockResolvedValue(installLocations);
-
-      const actual = await getProjectPackageJsonLocations();
-      expect(actual).toEqual([appFunctionsDir, extensionsDir]);
-    });
-
-    it('should throw an error if no package.json files are found', async () => {
-      walk.mockResolvedValue([]);
-
-      await expect(() => getProjectPackageJsonLocations()).rejects.toThrowError(
-        `No dependencies to install. The project ${projectName} folder might be missing component or subcomponent files. Learn how to create a project from scratch.: https://developers.hubspot.com/beta-docs/guides/crm/intro/create-a-project`
-      );
-    });
-  });
-});

package/lib/__tests__/downloadProjectPrompt.test.js

@@ -1,31 +0,0 @@
-jest.mock('@hubspot/local-dev-lib/api/projects', () => ({
-  fetchProjects: jest.fn().mockResolvedValue({
-    data: { results: [] },
-  }),
-}));
-
-jest.mock('@hubspot/local-dev-lib/config', () => ({
-  getAccountId: jest.fn().mockImplementation(() => 123456789),
-}));
-
-jest.mock('../prompts/promptUtils');
-
-const { downloadProjectPrompt } = require('../prompts/downloadProjectPrompt');
-const { getAccountId } = require('@hubspot/local-dev-lib/config');
-const { fetchProjects } = require('@hubspot/local-dev-lib/api/projects');
-
-describe('downloadProjectPrompt', () => {
-  it('should honor the account passed as an option', async () => {
-    const account = 'Prod';
-    await downloadProjectPrompt({ account });
-    expect(getAccountId).toHaveBeenCalledTimes(1);
-    expect(getAccountId).toHaveBeenCalledWith(account);
-  });
-
-  it('should fetch the projects for the correct accountId', async () => {
-    const account = 'Prod';
-    await downloadProjectPrompt({ account });
-    expect(fetchProjects).toHaveBeenCalledTimes(1);
-    expect(fetchProjects).toHaveBeenCalledWith(123456789);
-  });
-});

package/lib/__tests__/projectLogsManager.test.js

@@ -1,212 +0,0 @@
-jest.mock('../projects');
-jest.mock('@hubspot/local-dev-lib/api/projects');
-
-const ProjectLogsManager = require('../projectLogsManager');
-const { getProjectConfig, ensureProjectExists } = require('../projects');
-const {
-  fetchProjectComponentsMetadata,
-} = require('@hubspot/local-dev-lib/api/projects');
-
-describe('cli/lib/projectLogsManager', () => {
-  const accountId = 12345678;
-  const appId = 999999;
-  const projectName = 'super cool test project';
-  const projectConfig = { projectConfig: { name: projectName } };
-  const projectId = 987654321;
-  const projectDetails = {
-    project: {
-      id: projectId,
-      deployedBuild: {
-        subbuildStatuses: {},
-      },
-    },
-  };
-
-  const function1 = {
-    componentName: 'function1',
-    type: {
-      name: 'APP_FUNCTION',
-    },
-    deployOutput: {
-      appId,
-    },
-  };
-  const functions = [
-    function1,
-    {
-      componentName: 'function2',
-      type: {
-        name: 'APP_FUNCTION',
-      },
-      deployOutput: {
-        appId,
-      },
-    },
-  ];
-
-  beforeEach(() => {
-    ProjectLogsManager.reset();
-
-    getProjectConfig.mockResolvedValue(projectConfig);
-    ensureProjectExists.mockResolvedValue(projectDetails);
-    fetchProjectComponentsMetadata.mockResolvedValue({
-      data: {
-        topLevelComponentMetadata: [
-          {
-            type: {
-              name: 'PRIVATE_APP',
-            },
-            deployOutput: {
-              appId,
-            },
-            featureComponents: [
-              ...functions,
-              {
-                type: {
-                  name: 'NOT_AN_APP_FUNCTION',
-                },
-              },
-            ],
-          },
-        ],
-      },
-    });
-  });
-
-  describe('init', () => {
-    it('should load the project config', async () => {
-      await ProjectLogsManager.init(accountId);
-      expect(getProjectConfig).toHaveBeenCalledTimes(1);
-    });
-
-    it('should throw an error if there is a problem with the config', async () => {
-      getProjectConfig.mockResolvedValue({});
-      await expect(async () =>
-        ProjectLogsManager.init(accountId)
-      ).rejects.toThrow(
-        'No project detected. Run this command again from a project directory.'
-      );
-      expect(getProjectConfig).toHaveBeenCalledTimes(1);
-    });
-
-    it('should ensure the project exists', async () => {
-      await ProjectLogsManager.init(accountId);
-      expect(ensureProjectExists).toHaveBeenCalledTimes(1);
-      expect(ensureProjectExists).toHaveBeenCalledWith(accountId, projectName, {
-        allowCreate: false,
-      });
-    });
-
-    it('should throw an error if there is data missing from the project details', async () => {
-      ensureProjectExists.mockResolvedValue({});
-      await expect(async () =>
-        ProjectLogsManager.init(accountId)
-      ).rejects.toThrow(/There was an error fetching project details/);
-    });
-
-    it('should set all of the expected fields correctly', async () => {
-      await ProjectLogsManager.init(accountId);
-      expect(ProjectLogsManager.projectId).toEqual(projectId);
-      expect(ProjectLogsManager.projectName).toEqual(projectName);
-      expect(ProjectLogsManager.accountId).toEqual(accountId);
-      expect(ProjectLogsManager.functions).toEqual(functions);
-    });
-  });
-
-  describe('fetchFunctionDetails', () => {
-    it('should throw an error if the projectId is null when the method is called', async () => {
-      await expect(async () =>
-        ProjectLogsManager.fetchFunctionDetails()
-      ).rejects.toThrow(
-        'No project detected. Run this command again from a project directory.'
-      );
-    });
-
-    it('should fetch the component metadata', async () => {
-      ProjectLogsManager.projectId = projectId;
-      ProjectLogsManager.accountId = accountId;
-      await ProjectLogsManager.fetchFunctionDetails();
-      expect(fetchProjectComponentsMetadata).toHaveBeenCalledTimes(1);
-      expect(fetchProjectComponentsMetadata).toHaveBeenCalledWith(
-        accountId,
-        projectId
-      );
-    });
-
-    it('should set the functions correctly', async () => {
-      ProjectLogsManager.projectId = projectId;
-      ProjectLogsManager.accountId = accountId;
-      await ProjectLogsManager.fetchFunctionDetails();
-      expect(ProjectLogsManager.functions).toEqual(functions);
-    });
-  });
-
-  describe('getFunctionNames', () => {
-    it('should return an empty array if functions is nullable', async () => {
-      ProjectLogsManager.functions = undefined;
-      expect(ProjectLogsManager.getFunctionNames()).toEqual([]);
-    });
-
-    it('should return an array of the componentNames', async () => {
-      ProjectLogsManager.functions = functions;
-      expect(ProjectLogsManager.getFunctionNames()).toEqual([
-        'function1',
-        'function2',
-      ]);
-    });
-  });
-
-  describe('setFunction', () => {
-    it('should throw an error when functions is nullable', async () => {
-      ProjectLogsManager.functions = undefined;
-      expect(() => ProjectLogsManager.setFunction('foo')).toThrow(
-        `There aren't any functions in this project`
-      );
-    });
-
-    it('should throw an error when the provided function is invalid', async () => {
-      ProjectLogsManager.functions = functions;
-      const badName = 'foo';
-      expect(() => ProjectLogsManager.setFunction(badName)).toThrow(
-        `No function with name "${badName}"`
-      );
-    });
-
-    it('should set the data correctly for public functions', async () => {
-      const functionToChoose = {
-        componentName: 'function1',
-        type: {
-          name: 'APP_FUNCTION',
-        },
-        deployOutput: {
-          endpoint: { path: 'yooooooo', method: ['GET'] },
-        },
-      };
-      ProjectLogsManager.functions = [functionToChoose];
-      ProjectLogsManager.setFunction('function1');
-      expect(ProjectLogsManager.functionName).toEqual('function1');
-      expect(ProjectLogsManager.endpointName).toEqual('yooooooo');
-      expect(ProjectLogsManager.selectedFunction).toEqual(functionToChoose);
-      expect(ProjectLogsManager.method).toEqual(['GET']);
-      expect(ProjectLogsManager.isPublicFunction).toEqual(true);
-    });
-
-    it('should set the data correctly for public functions', async () => {
-      ProjectLogsManager.functions = functions;
-      ProjectLogsManager.setFunction('function1');
-      expect(ProjectLogsManager.selectedFunction).toEqual(function1);
-      expect(ProjectLogsManager.functionName).toEqual('function1');
-      expect(ProjectLogsManager.isPublicFunction).toEqual(false);
-    });
-  });
-
-  describe('reset', () => {
-    it('should reset all the values', async () => {
-      ProjectLogsManager.someRandomField = 'value';
-      expect(ProjectLogsManager.someRandomField).toBeDefined();
-
-      ProjectLogsManager.reset();
-      expect(ProjectLogsManager.isPublicFunction).toBeUndefined();
-    });
-  });
-});

package/lib/__tests__/projects.test.js

@@ -1,140 +0,0 @@
-jest.mock('@hubspot/local-dev-lib/logger');
-
-const fs = require('fs');
-const os = require('os');
-const path = require('path');
-const { EXIT_CODES } = require('../enums/exitCodes');
-const projects = require('../projects');
-const { logger } = require('@hubspot/local-dev-lib/logger');
-
-describe('@hubspot/cli/lib/projects', () => {
-  describe('validateProjectConfig()', () => {
-    let realProcess;
-    let projectDir;
-    let exitMock;
-
-    beforeAll(() => {
-      projectDir = fs.mkdtempSync(path.join(os.tmpdir(), 'projects-'));
-      fs.mkdirSync(path.join(projectDir, 'src'));
-
-      realProcess = process;
-    });
-
-    beforeEach(() => {
-      exitMock = jest.fn();
-      global.process = { ...realProcess, exit: exitMock };
-    });
-
-    afterAll(() => {
-      global.process = realProcess;
-    });
-
-    it('rejects undefined configuration', () => {
-      projects.validateProjectConfig(null, projectDir);
-
-      expect(exitMock).toHaveBeenCalledWith(EXIT_CODES.ERROR);
-      expect(logger.error).toHaveBeenCalledWith(
-        expect.stringMatching(/.*config not found.*/)
-      );
-    });
-
-    it('rejects configuration with missing name', () => {
-      projects.validateProjectConfig({ srcDir: '.' }, projectDir);
-
-      expect(exitMock).toHaveBeenCalledWith(EXIT_CODES.ERROR);
-      expect(logger.error).toHaveBeenCalledWith(
-        expect.stringMatching(/.*missing required fields*/)
-      );
-    });
-
-    it('rejects configuration with missing srcDir', () => {
-      projects.validateProjectConfig({ name: 'hello' }, projectDir);
-
-      expect(exitMock).toHaveBeenCalledWith(EXIT_CODES.ERROR);
-      expect(logger.error).toHaveBeenCalledWith(
-        expect.stringMatching(/.*missing required fields.*/)
-      );
-    });
-
-    describe('rejects configuration with srcDir outside project directory', () => {
-      it('for parent directory', () => {
-        projects.validateProjectConfig(
-          { name: 'hello', srcDir: '..' },
-          projectDir
-        );
-
-        expect(exitMock).toHaveBeenCalledWith(EXIT_CODES.ERROR);
-        expect(logger.error).toHaveBeenCalledWith(
-          expect.stringContaining('srcDir: ".."')
-        );
-      });
-
-      it('for root directory', () => {
-        projects.validateProjectConfig(
-          { name: 'hello', srcDir: '/' },
-          projectDir
-        );
-
-        expect(exitMock).toHaveBeenCalledWith(EXIT_CODES.ERROR);
-        expect(logger.error).toHaveBeenCalledWith(
-          expect.stringContaining('srcDir: "/"')
-        );
-      });
-
-      it('for complicated directory', () => {
-        const srcDir = './src/././../src/../../src';
-
-        projects.validateProjectConfig({ name: 'hello', srcDir }, projectDir);
-
-        expect(exitMock).toHaveBeenCalledWith(EXIT_CODES.ERROR);
-        expect(logger.error).toHaveBeenCalledWith(
-          expect.stringContaining(`srcDir: "${srcDir}"`)
-        );
-      });
-    });
-
-    it('rejects configuration with srcDir that does not exist', () => {
-      projects.validateProjectConfig(
-        { name: 'hello', srcDir: 'foo' },
-        projectDir
-      );
-
-      expect(exitMock).toHaveBeenCalledWith(EXIT_CODES.ERROR);
-      expect(logger.error).toHaveBeenCalledWith(
-        expect.stringMatching(/.*could not be found in.*/)
-      );
-    });
-
-    describe('accepts configuration with valid srcDir', () => {
-      it('for current directory', () => {
-        projects.validateProjectConfig(
-          { name: 'hello', srcDir: '.' },
-          projectDir
-        );
-
-        expect(exitMock).not.toHaveBeenCalled();
-        expect(logger.error).not.toHaveBeenCalled();
-      });
-
-      it('for relative directory', () => {
-        projects.validateProjectConfig(
-          { name: 'hello', srcDir: './src' },
-          projectDir
-        );
-
-        expect(exitMock).not.toHaveBeenCalled();
-        expect(logger.error).not.toHaveBeenCalled();
-      });
-
-      it('for implied relative directory', () => {
-        projects.validateProjectConfig(
-          { name: 'hello', srcDir: 'src' },
-          projectDir
-        );
-
-        expect(exitMock).not.toHaveBeenCalled();
-        expect(logger.error).not.toHaveBeenCalled();
-      });
-    });
-  });
-});