@hubspot/cli 7.7.0-experimental.3 → 7.7.0

package/lib/projects/__tests__/localDevProjectHelpers.test.js

@@ -0,0 +1,122 @@
+import fs from 'fs-extra';
+import os from 'os';
+import { vi, describe, it, expect, beforeEach, afterEach } from 'vitest';
+import { downloadProject } from '@hubspot/local-dev-lib/api/projects';
+import { extractZipArchive } from '@hubspot/local-dev-lib/archive';
+import { isDeepEqual } from '@hubspot/local-dev-lib/isDeepEqual';
+import { translate } from '@hubspot/project-parsing-lib';
+import { isDeployedProjectUpToDateWithLocal } from '../localDev/helpers/project.js';
+// Mock all external dependencies
+vi.mock('@hubspot/local-dev-lib/api/projects');
+vi.mock('@hubspot/local-dev-lib/archive');
+vi.mock('@hubspot/project-parsing-lib');
+vi.mock('@hubspot/local-dev-lib/isDeepEqual');
+vi.mock('fs-extra');
+vi.mock('os');
+vi.mock('../../utils/isDeepEqual.js');
+describe('isDeployedProjectUpToDateWithLocal', () => {
+    const mockProjectName = 'test-project';
+    const mockAccountId = 123456;
+    const mockBuildId = 789;
+    const mockProjectConfig = {
+        name: mockProjectName,
+        srcDir: 'src',
+        platformVersion: '1.0.0',
+    };
+    const mockLocalNode = {
+        uid: 'component1',
+        componentType: 'APP',
+        localDev: {
+            componentRoot: '/local/path',
+            componentConfigPath: '/local/path/config.json',
+            configUpdatedSinceLastUpload: false,
+            removed: false,
+            parsingErrors: [],
+        },
+        componentDeps: {},
+        metaFilePath: '/local/path',
+        config: { name: 'Component 1' },
+        files: [],
+    };
+    const mockLocalProjectNodes = {
+        component1: mockLocalNode,
+    };
+    const mockTempDir = '/tmp/test-temp-dir';
+    const mockZippedProject = Buffer.from('fake-zip-data');
+    beforeEach(() => {
+        vi.clearAllMocks();
+        // Mock fs.mkdtemp
+        fs.mkdtemp.mockResolvedValue(mockTempDir);
+        // Mock fs.pathExists
+        fs.pathExists.mockResolvedValue(true);
+        // Mock fs.remove
+        fs.remove.mockResolvedValue(undefined);
+        // Mock os.tmpdir
+        os.tmpdir.mockReturnValue('/tmp');
+    });
+    afterEach(() => {
+        vi.restoreAllMocks();
+    });
+    describe('when projects are identical', () => {
+        it('should return true for identical projects', async () => {
+            // Mock downloadProject
+            downloadProject.mockResolvedValue({
+                data: mockZippedProject,
+            });
+            // Mock extractZipArchive
+            extractZipArchive.mockResolvedValue(undefined);
+            // Mock translate to return identical nodes
+            translate.mockResolvedValue({
+                intermediateNodesIndexedByUid: mockLocalProjectNodes,
+            });
+            // Mock isDeepEqual to return true for identical projects
+            isDeepEqual.mockReturnValue(true);
+            const result = await isDeployedProjectUpToDateWithLocal(mockProjectConfig, mockAccountId, mockBuildId, mockLocalProjectNodes);
+            expect(result).toBe(true);
+            expect(isDeepEqual).toHaveBeenCalledWith(mockLocalProjectNodes, mockLocalProjectNodes, ['localDev']);
+            expect(fs.remove).toHaveBeenCalledWith(mockTempDir);
+        });
+    });
+    describe('when projects are different', () => {
+        it('should return false for different projects', async () => {
+            // Mock downloadProject
+            downloadProject.mockResolvedValue({
+                data: mockZippedProject,
+            });
+            // Mock extractZipArchive
+            extractZipArchive.mockResolvedValue(undefined);
+            // Mock translate to return different nodes
+            const differentDeployedNodes = {};
+            translate.mockResolvedValue({
+                intermediateNodesIndexedByUid: differentDeployedNodes,
+            });
+            // Mock isDeepEqual to return false for different projects
+            isDeepEqual.mockReturnValue(false);
+            const result = await isDeployedProjectUpToDateWithLocal(mockProjectConfig, mockAccountId, mockBuildId, mockLocalProjectNodes);
+            expect(result).toBe(false);
+            expect(isDeepEqual).toHaveBeenCalledWith(mockLocalProjectNodes, differentDeployedNodes, ['localDev']);
+        });
+    });
+    describe('error handling', () => {
+        it('should clean up temp directory even when errors occur', async () => {
+            // Mock downloadProject to throw an error after temp dir is created
+            downloadProject.mockRejectedValue(new Error('Download Error'));
+            const result = await isDeployedProjectUpToDateWithLocal(mockProjectConfig, mockAccountId, mockBuildId, mockLocalProjectNodes);
+            expect(result).toBe(false);
+            expect(fs.remove).toHaveBeenCalledWith(mockTempDir);
+        });
+        it('should handle translateForLocalDev errors', async () => {
+            // Mock downloadProject
+            downloadProject.mockResolvedValue({
+                data: mockZippedProject,
+            });
+            // Mock extractZipArchive
+            extractZipArchive.mockResolvedValue(undefined);
+            // Mock translate to throw an error
+            translate.mockRejectedValue(new Error('Translation Error'));
+            const result = await isDeployedProjectUpToDateWithLocal(mockProjectConfig, mockAccountId, mockBuildId, mockLocalProjectNodes);
+            expect(result).toBe(false);
+            expect(fs.remove).toHaveBeenCalledWith(mockTempDir);
+        });
+    });
+});

package/lib/projects/__tests__/platformVersion.test.d.ts

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

package/lib/projects/__tests__/platformVersion.test.js

@@ -0,0 +1,23 @@
+import { useV3Api } from '../platformVersion.js';
+describe('platformVersion', () => {
+    describe('useV3Api', () => {
+        it('returns true if platform version is UNSTABLE', () => {
+            expect(useV3Api('UNSTABLE')).toBe(true);
+        });
+        it('returns true if platform version is equal to the minimum', () => {
+            expect(useV3Api('2025.2')).toBe(true);
+        });
+        it('returns true if platform version is greater than the minimum', () => {
+            expect(useV3Api('2026.2')).toBe(true);
+        });
+        it('returns false if platform version is less than the minimum', () => {
+            expect(useV3Api('2025.0')).toBe(false);
+        });
+        it('returns false if platform version is invalid', () => {
+            expect(useV3Api(null)).toBe(false);
+        });
+        it('returns false for an invalid platform version', () => {
+            expect(useV3Api('notplaformversion')).toBe(false);
+        });
+    });
+});

package/lib/projects/__tests__/projects.test.d.ts

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

package/lib/projects/__tests__/projects.test.js

@@ -0,0 +1,84 @@
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+import { EXIT_CODES } from '../../enums/exitCodes.js';
+import { validateProjectConfig } from '../../projects/config.js';
+import { logger } from '@hubspot/local-dev-lib/logger';
+vi.mock('@hubspot/local-dev-lib/logger');
+describe('lib/projects', () => {
+    describe('validateProjectConfig()', () => {
+        let projectDir;
+        let exitMock;
+        beforeAll(() => {
+            projectDir = fs.mkdtempSync(path.join(os.tmpdir(), 'projects-'));
+            fs.mkdirSync(path.join(projectDir, 'src'));
+        });
+        beforeEach(() => {
+            // @ts-expect-error - Mocking process.exit
+            exitMock = vi
+                .spyOn(process, 'exit')
+                .mockImplementation(() => undefined);
+        });
+        afterEach(() => {
+            exitMock.mockRestore();
+        });
+        it('rejects undefined configuration', () => {
+            // @ts-ignore Testing invalid input
+            validateProjectConfig(null, projectDir);
+            expect(exitMock).toHaveBeenCalledWith(EXIT_CODES.ERROR);
+            expect(logger.error).toHaveBeenCalledWith(expect.stringMatching(/.*Unable to locate a project configuration file. Try running again from a project directory, or run*/));
+        });
+        it('rejects configuration with missing name', () => {
+            // @ts-ignore Testing invalid input
+            validateProjectConfig({ srcDir: '.' }, projectDir);
+            expect(exitMock).toHaveBeenCalledWith(EXIT_CODES.ERROR);
+            expect(logger.error).toHaveBeenCalledWith(expect.stringMatching(/.*missing required fields*/));
+        });
+        it('rejects configuration with missing srcDir', () => {
+            // @ts-ignore Testing invalid input
+            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', () => {
+                validateProjectConfig({ name: 'hello', srcDir: '..', platformVersion: '' }, projectDir);
+                expect(exitMock).toHaveBeenCalledWith(EXIT_CODES.ERROR);
+                expect(logger.error).toHaveBeenCalledWith(expect.stringContaining('srcDir: ".."'));
+            });
+            it('for root directory', () => {
+                validateProjectConfig({ name: 'hello', srcDir: '/', platformVersion: '' }, projectDir);
+                expect(exitMock).toHaveBeenCalledWith(EXIT_CODES.ERROR);
+                expect(logger.error).toHaveBeenCalledWith(expect.stringContaining('srcDir: "/"'));
+            });
+            it('for complicated directory', () => {
+                const srcDir = './src/././../src/../../src';
+                validateProjectConfig({ name: 'hello', srcDir, platformVersion: '' }, projectDir);
+                expect(exitMock).toHaveBeenCalledWith(EXIT_CODES.ERROR);
+                expect(logger.error).toHaveBeenCalledWith(expect.stringContaining(`srcDir: "${srcDir}"`));
+            });
+        });
+        it('rejects configuration with srcDir that does not exist', () => {
+            validateProjectConfig({ name: 'hello', srcDir: 'foo', platformVersion: '' }, 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', () => {
+                validateProjectConfig({ name: 'hello', srcDir: '.', platformVersion: '' }, projectDir);
+                expect(exitMock).not.toHaveBeenCalled();
+                expect(logger.error).not.toHaveBeenCalled();
+            });
+            it('for relative directory', () => {
+                validateProjectConfig({ name: 'hello', srcDir: './src', platformVersion: '' }, projectDir);
+                expect(exitMock).not.toHaveBeenCalled();
+                expect(logger.error).not.toHaveBeenCalled();
+            });
+            it('for implied relative directory', () => {
+                validateProjectConfig({ name: 'hello', srcDir: 'src', platformVersion: '' }, projectDir);
+                expect(exitMock).not.toHaveBeenCalled();
+                expect(logger.error).not.toHaveBeenCalled();
+            });
+        });
+    });
+});

package/lib/projects/__tests__/structure.test.d.ts

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

package/lib/projects/__tests__/structure.test.js

@@ -0,0 +1,211 @@
+import fs from 'fs';
+import * as HSfs from '@hubspot/local-dev-lib/fs';
+import { logger } from '@hubspot/local-dev-lib/logger';
+import { getComponentTypeFromConfigFile, loadConfigFile, getAppCardConfigs, getIsLegacyApp, componentIsApp, findProjectComponents, getProjectComponentTypes, getComponentUid, componentIsPublicApp, } from '../structure.js';
+import { ComponentTypes } from '../../../types/Projects.js';
+vi.mock('fs');
+vi.mock('@hubspot/local-dev-lib/fs');
+vi.mock('@hubspot/local-dev-lib/logger');
+const mockedReadFileSync = fs.readFileSync;
+const mockedWalk = HSfs.walk;
+const getMockPrivateAppConfig = (cards = []) => ({
+    name: 'test-app',
+    description: 'test-description',
+    uid: 'test-uid',
+    scopes: ['test-scope'],
+    public: true,
+    extensions: {
+        crm: {
+            cards,
+        },
+    },
+});
+describe('lib/projects/structure', () => {
+    describe('getComponentTypeFromConfigFile()', () => {
+        it('returns correct type for public app config', () => {
+            expect(getComponentTypeFromConfigFile('public-app.json')).toBe(ComponentTypes.PublicApp);
+        });
+        it('returns correct type for private app config', () => {
+            expect(getComponentTypeFromConfigFile('app.json')).toBe(ComponentTypes.PrivateApp);
+        });
+        it('returns correct type for theme config', () => {
+            expect(getComponentTypeFromConfigFile('theme.json')).toBe(ComponentTypes.HublTheme);
+        });
+        it('returns null for unknown config file', () => {
+            expect(getComponentTypeFromConfigFile('unknown.json')).toBeNull();
+        });
+    });
+    describe('loadConfigFile()', () => {
+        it('returns parsed JSON when file exists', () => {
+            const mockConfig = { name: 'test-app' };
+            mockedReadFileSync.mockReturnValue(JSON.stringify(mockConfig));
+            expect(loadConfigFile('test/path/app.json')).toEqual(mockConfig);
+        });
+        it('returns null when file read fails', () => {
+            mockedReadFileSync.mockImplementation(() => {
+                throw new Error('File not found');
+            });
+            expect(loadConfigFile('nonexistent/path/app.json')).toBeNull();
+            expect(logger.debug).toHaveBeenCalled();
+        });
+    });
+    describe('getAppCardConfigs()', () => {
+        const mockAppPath = '/test/path';
+        it('returns empty array when no cards exist', () => {
+            const appConfig = getMockPrivateAppConfig();
+            expect(getAppCardConfigs(appConfig, mockAppPath)).toEqual([]);
+        });
+        it('returns array of card configs when valid cards exist', () => {
+            const mockCardConfig = { type: 'crm-card' };
+            mockedReadFileSync.mockReturnValue(JSON.stringify(mockCardConfig));
+            const appConfig = getMockPrivateAppConfig([{ file: 'card.json' }]);
+            expect(getAppCardConfigs(appConfig, mockAppPath)).toEqual([
+                mockCardConfig,
+            ]);
+        });
+    });
+    describe('getIsLegacyApp()', () => {
+        const mockAppPath = '/test/path';
+        it('returns true for a legacy app', () => {
+            const cardConfig = { type: 'crm-card' };
+            const appConfig = getMockPrivateAppConfig([{ file: 'card.json' }]);
+            mockedReadFileSync.mockReturnValue(JSON.stringify(cardConfig));
+            expect(getIsLegacyApp(appConfig, mockAppPath)).toBe(true);
+        });
+        it('returns false when the app has no cards', () => {
+            const appConfig = getMockPrivateAppConfig();
+            expect(getIsLegacyApp(appConfig, mockAppPath)).toBe(false);
+        });
+        it('returns false for non-legacy app', () => {
+            const cardConfig = {
+                data: { module: { file: 'ReactCard.jsx' } },
+            };
+            const appConfig = getMockPrivateAppConfig([{ file: 'card.json' }]);
+            mockedReadFileSync.mockReturnValue(JSON.stringify(cardConfig));
+            expect(getIsLegacyApp(appConfig, mockAppPath)).toBe(false);
+        });
+    });
+    describe('findProjectComponents()', () => {
+        it('returns an empty array of components when no components are found', async () => {
+            mockedWalk.mockReturnValue([]);
+            const components = await findProjectComponents('');
+            expect(components).toEqual([]);
+        });
+        it('returns an array of components when components are found', async () => {
+            const cardConfig = { type: 'crm-card' };
+            const appConfig = getMockPrivateAppConfig();
+            const component = {
+                type: ComponentTypes.PrivateApp,
+                config: appConfig,
+                runnable: true,
+                path: '',
+            };
+            mockedWalk.mockReturnValue(['app.json']);
+            mockedReadFileSync
+                .mockReturnValueOnce(JSON.stringify(appConfig))
+                .mockReturnValueOnce(JSON.stringify(cardConfig));
+            const components = await findProjectComponents('');
+            expect(components).toEqual([component]);
+        });
+    });
+    describe('getProjectComponentTypes()', () => {
+        it('returns the correct component types', () => {
+            const component = {
+                type: ComponentTypes.PrivateApp,
+                config: getMockPrivateAppConfig(),
+                runnable: true,
+                path: 'test/path',
+            };
+            const components = [component];
+            expect(getProjectComponentTypes(components)).toEqual({
+                [ComponentTypes.PrivateApp]: true,
+            });
+        });
+        it('returns the correct component types for multiple components', () => {
+            const component1 = {
+                type: ComponentTypes.PrivateApp,
+                config: getMockPrivateAppConfig(),
+                runnable: true,
+                path: 'test/path',
+            };
+            const component2 = {
+                type: ComponentTypes.PublicApp,
+                // Config doesn't matter for this test so we can use a private app config
+                config: getMockPrivateAppConfig(),
+                runnable: true,
+                path: 'test/path',
+            };
+            const components = [component1, component2];
+            expect(getProjectComponentTypes(components)).toEqual({
+                [ComponentTypes.PrivateApp]: true,
+                [ComponentTypes.PublicApp]: true,
+            });
+        });
+        it('returns an empty object when no components are provided', () => {
+            const components = [];
+            expect(getProjectComponentTypes(components)).toEqual({});
+        });
+    });
+    describe('getComponentUid()', () => {
+        it('returns uid from the component config', () => {
+            const component = {
+                type: ComponentTypes.PrivateApp,
+                config: getMockPrivateAppConfig(),
+                runnable: true,
+                path: 'test/path',
+            };
+            expect(getComponentUid(component)).toBe(component.config.uid);
+        });
+        it('returns null for null input', () => {
+            expect(getComponentUid(null)).toBeNull();
+        });
+    });
+    describe('componentIsApp()', () => {
+        it('returns true for public app component', () => {
+            const component = {
+                type: ComponentTypes.PublicApp,
+                // Config doesn't matter for this test so we can use a private app config
+                config: getMockPrivateAppConfig(),
+                runnable: true,
+                path: 'test/path',
+            };
+            expect(componentIsApp(component)).toBe(true);
+        });
+        it('returns true for private app component', () => {
+            const component = {
+                type: ComponentTypes.PrivateApp,
+                config: getMockPrivateAppConfig(),
+                runnable: true,
+                path: 'test/path',
+            };
+            expect(componentIsApp(component)).toBe(true);
+        });
+        it('returns false for null input', () => {
+            expect(componentIsApp(null)).toBe(false);
+        });
+    });
+    describe('componentIsPublicApp()', () => {
+        it('returns true for public app component', () => {
+            const component = {
+                type: ComponentTypes.PublicApp,
+                // Config doesn't matter for this test so we can use a private app config
+                config: getMockPrivateAppConfig(),
+                runnable: true,
+                path: 'test/path',
+            };
+            expect(componentIsPublicApp(component)).toBe(true);
+        });
+        it('returns false for private app component', () => {
+            const component = {
+                type: ComponentTypes.PrivateApp,
+                config: getMockPrivateAppConfig(),
+                runnable: true,
+                path: 'test/path',
+            };
+            expect(componentIsPublicApp(component)).toBe(false);
+        });
+        it('returns false for null input', () => {
+            expect(componentIsPublicApp(null)).toBe(false);
+        });
+    });
+});

package/lib/projects/__tests__/upload.test.d.ts

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

package/lib/projects/__tests__/upload.test.js

@@ -0,0 +1,82 @@
+import fs from 'fs-extra';
+import os from 'os';
+import path from 'path';
+import { vi } from 'vitest';
+import { validateSourceDirectory } from '../upload.js';
+import { uiLogger } from '../../ui/logger.js';
+import { lib } from '../../../lang/en.js';
+import { useV3Api } from '../platformVersion.js';
+import ProjectValidationError from '../../errors/ProjectValidationError.js';
+import { walk } from '@hubspot/local-dev-lib/fs';
+// Mock dependencies
+vi.mock('../../ui/logger.js');
+vi.mock('../platformVersion.js');
+vi.mock('@hubspot/local-dev-lib/fs');
+describe('lib/projects/upload', () => {
+    describe('validateSourceDirectory', () => {
+        let tempDir;
+        let srcDir;
+        let projectConfig;
+        beforeEach(() => {
+            tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'upload-test-'));
+            srcDir = path.join(tempDir, 'src');
+            fs.mkdirSync(srcDir, { recursive: true });
+            projectConfig = {
+                name: 'test-project',
+                srcDir: 'src',
+                platformVersion: '2025.2',
+            };
+            vi.clearAllMocks();
+        });
+        afterEach(() => {
+            fs.removeSync(tempDir);
+        });
+        it('should throw ProjectValidationError when source directory is empty', async () => {
+            vi.mocked(walk).mockResolvedValue([]);
+            await expect(validateSourceDirectory(srcDir, projectConfig, tempDir)).rejects.toThrow(ProjectValidationError);
+            expect(walk).toHaveBeenCalledWith(srcDir, ['node_modules']);
+        });
+        it('should warn about legacy files in V3 projects', async () => {
+            vi.mocked(useV3Api).mockReturnValue(true);
+            const legacyFilePath = path.join(srcDir, 'app', 'serverless.json');
+            vi.mocked(walk).mockResolvedValue([legacyFilePath]);
+            await validateSourceDirectory(srcDir, projectConfig, tempDir);
+            expect(uiLogger.warn).toHaveBeenCalledWith(lib.projectUpload.handleProjectUpload.legacyFileDetected('src/app/serverless.json', '2025.2'));
+        });
+        it('should warn about multiple legacy files', async () => {
+            vi.mocked(useV3Api).mockReturnValue(true);
+            const filePaths = [
+                path.join(srcDir, 'app1', 'serverless.json'),
+                path.join(srcDir, 'app2', 'app.json'),
+                path.join(srcDir, 'app3', 'public-app.json'),
+            ];
+            vi.mocked(walk).mockResolvedValue(filePaths);
+            await validateSourceDirectory(srcDir, projectConfig, tempDir);
+            expect(uiLogger.warn).toHaveBeenCalledTimes(3);
+            expect(uiLogger.warn).toHaveBeenCalledWith(lib.projectUpload.handleProjectUpload.legacyFileDetected('src/app1/serverless.json', '2025.2'));
+            expect(uiLogger.warn).toHaveBeenCalledWith(lib.projectUpload.handleProjectUpload.legacyFileDetected('src/app2/app.json', '2025.2'));
+            expect(uiLogger.warn).toHaveBeenCalledWith(lib.projectUpload.handleProjectUpload.legacyFileDetected('src/app3/public-app.json', '2025.2'));
+        });
+        it('should not warn about non-legacy files', async () => {
+            vi.mocked(useV3Api).mockReturnValue(true);
+            const filePaths = [
+                path.join(srcDir, 'component.js'),
+                path.join(srcDir, 'config.json'),
+            ];
+            vi.mocked(walk).mockResolvedValue(filePaths);
+            await validateSourceDirectory(srcDir, projectConfig, tempDir);
+            expect(uiLogger.warn).not.toHaveBeenCalled();
+        });
+        it('should not warn about legacy files in non-V3 projects', async () => {
+            vi.mocked(useV3Api).mockReturnValue(false);
+            projectConfig.platformVersion = '2025.1';
+            const filePaths = [
+                path.join(srcDir, 'app', 'serverless.json'),
+                path.join(srcDir, 'app', 'app.json'),
+            ];
+            vi.mocked(walk).mockResolvedValue(filePaths);
+            await validateSourceDirectory(srcDir, projectConfig, tempDir);
+            expect(uiLogger.warn).not.toHaveBeenCalled();
+        });
+    });
+});

package/lib/projects/add/__tests__/legacyAddComponent.test.d.ts

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