@squiz/dxp-cli-next 5.25.3 → 5.26.0-develop.2

package/lib/__tests__/integration/main.spec.js

@@ -17,6 +17,8 @@ describe('dxp', () => {
             'job-runner     Job Runner Service Commands',
             'datastore      Datastore Service Commands',
             'cdp            Customer Data Platform Service Commands',
+            // TODO: Migration is hidden behind feature flag.
+            // 'migration      AI Page Migration Service Commands',
             // TODO: Porter is hidden behind feature flag.
             // 'porter         Porter Service Commands',
         ]);
@@ -33,6 +35,8 @@ describe('dxp', () => {
             'job-runner     Job Runner Service Commands',
             'datastore      Datastore Service Commands',
             'cdp            Customer Data Platform Service Commands',
+            // TODO: Migration is hidden behind feature flag.
+            // 'migration      AI Page Migration Service Commands',
             'porter         Porter Service Commands',
         ]);
     });

package/lib/dxp.js

@@ -18,6 +18,7 @@ const datastore_1 = __importDefault(require("./datastore"));
 const cdp_1 = __importDefault(require("./cdp"));
 const porter_1 = __importDefault(require("./porter"));
 const page_1 = __importDefault(require("./page"));
+const migration_1 = __importDefault(require("./migration"));
 const program = new commander_1.default.Command();
 const packageJson = require('../package.json');
 const version = packageJson.version;
@@ -36,6 +37,9 @@ if (process.env.ENABLE_PORTER === 'true') {
 if (process.env.ENABLE_PAGE_LAYOUTS === 'true') {
     program.addCommand(page_1.default);
 }
+if (process.env.ENABLE_MIGRATION === 'true') {
+    program.addCommand(migration_1.default);
+}
 program
     .action(() => {
     program.help();

package/lib/migration/create/createMigration.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+declare const createMigrationCommand: () => Command;
+export default createMigrationCommand;

package/lib/migration/create/createMigration.js

@@ -0,0 +1,82 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const chalk_1 = __importDefault(require("chalk"));
+const ora_1 = __importDefault(require("ora"));
+const fs_1 = __importDefault(require("fs"));
+const utils_1 = require("../utils");
+const createMigrationCommand = () => {
+    const createCommand = new commander_1.Command('create')
+        .name('create')
+        .description('Create a new migration using the AI Page migration service')
+        .addOption(new commander_1.Option('--asset-id <string>', 'The ID of the asset to be migrated').makeOptionMandatory())
+        .addOption(new commander_1.Option('--preview-asset-id <string>', 'The ID of the folder that will be used as the parent of the migrated asset generated during the Preview stage').makeOptionMandatory())
+        .addOption(new commander_1.Option('--matrix-url <string>', 'Matrix URL for the migration').makeOptionMandatory())
+        .addOption(new commander_1.Option('-t, --tenant <string>', 'Tenant ID to run against. If not provided will use configured tenant from login'))
+        .argument('<exportPath>', 'Path to the export folder (e.g., ./export)')
+        .configureOutput({
+        outputError(str, write) {
+            write(chalk_1.default.red(str));
+        },
+    })
+        .action((exportPath, options) => __awaiter(void 0, void 0, void 0, function* () {
+        yield (0, utils_1.throwErrorIfNotLoggedIn)(createCommand);
+        let spinner = (0, ora_1.default)('Validating export folder structure').start();
+        try {
+            // Validate export folder structure
+            (0, utils_1.validateExportFolder)(exportPath);
+            spinner.succeed('Export folder structure validated');
+            // Create tar file
+            spinner = (0, ora_1.default)('Creating tar file from export folder').start();
+            const tarFilePath = yield (0, utils_1.createTarFile)(exportPath);
+            if (!tarFilePath) {
+                throw new Error('Tar file creation failed');
+            }
+            spinner.succeed(`Tar file created: ${tarFilePath}`);
+            // Create migration
+            spinner = (0, ora_1.default)('Creating migration').start();
+            const response = yield (0, utils_1.createMigration)(options);
+            if (!response) {
+                throw new Error('Migration creation failed');
+            }
+            spinner.succeed('Migration created successfully');
+            // Upload file to S3
+            spinner = (0, ora_1.default)('Uploading file to S3').start();
+            const uploadUrl = response.uploadUrl;
+            const s3Url = yield (0, utils_1.uploadFileToS3)(uploadUrl, tarFilePath, options.tenant);
+            if (!s3Url) {
+                throw new Error('File upload failed');
+            }
+            spinner.succeed('File uploaded to S3');
+            // Clean up tar file
+            fs_1.default.unlinkSync(tarFilePath);
+            spinner.succeed(`Successfully created migration: ${JSON.stringify({
+                migrationId: response.assetMigration.migrationId,
+                assetId: response.assetMigration.assetId,
+                stage: response.assetMigration.stage,
+                status: response.assetMigration.status,
+            })}`);
+        }
+        catch (error) {
+            spinner.fail();
+            (0, utils_1.handleCommandError)(createCommand, error);
+        }
+    }));
+    if (process.env.ENABLE_OVERRIDE_MIGRATION_URL === 'true') {
+        createCommand.addOption(new commander_1.Option('-ou, --overrideUrl <string>', 'Developer option to override the entire migration url with a custom value'));
+    }
+    return createCommand;
+};
+exports.default = createMigrationCommand;

package/lib/migration/create/createMigration.spec.d.ts

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

package/lib/migration/create/createMigration.spec.js

@@ -0,0 +1,381 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const nock_1 = __importDefault(require("nock"));
+const createMigration_1 = __importDefault(require("./createMigration"));
+const utils = __importStar(require("../utils"));
+const ApplicationStore = __importStar(require("../../ApplicationStore"));
+const fs_1 = __importDefault(require("fs"));
+jest.mock('../utils');
+jest.mock('../../ApplicationStore');
+jest.mock('fs');
+const mockUtils = utils;
+const mockApplicationStore = ApplicationStore;
+const mockFs = fs_1.default;
+describe('createMigrationCommand', () => {
+    let logSpy;
+    let mockCreateMigrationResponse;
+    beforeEach(() => {
+        nock_1.default.cleanAll();
+        jest.clearAllMocks();
+        jest.resetAllMocks();
+        logSpy = jest.spyOn(console, 'log').mockImplementation(() => { });
+        mockApplicationStore.getApplicationFile.mockResolvedValue('session-cookie');
+        mockUtils.throwErrorIfNotLoggedIn.mockResolvedValue(undefined);
+        mockUtils.validateExportFolder.mockImplementation(() => { });
+        mockUtils.createTarFile.mockResolvedValue('/path/to/export_123.tar.gz');
+        mockUtils.uploadFileToS3.mockResolvedValue('https://s3.amazonaws.com/uploaded-file');
+        mockFs.unlinkSync.mockImplementation(() => { });
+        mockCreateMigrationResponse = {
+            assetMigration: {
+                migrationId: 'migration-123',
+                assetId: 'asset-456',
+                stage: 'pending',
+                status: 'created',
+                xmlFilePath: '/path/to/xml',
+                matrixUrl: 'https://matrix.example.com',
+                previewAssetId: 'preview-789',
+                created: 1234567890,
+                updated: 1234567890,
+                migrationIdAssetId: 'migration-123-asset-456',
+            },
+            uploadUrl: 'https://upload.s3.amazonaws.com',
+        };
+        mockUtils.createMigration.mockResolvedValue(mockCreateMigrationResponse);
+    });
+    afterEach(() => {
+        logSpy.mockRestore();
+    });
+    describe('successful migration creation', () => {
+        it('should create migration successfully with all required options', () => __awaiter(void 0, void 0, void 0, function* () {
+            const program = (0, createMigration_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                '--asset-id',
+                'asset-123',
+                '--preview-asset-id',
+                'preview-456',
+                '--matrix-url',
+                'https://matrix.example.com',
+                '/path/to/export',
+            ]);
+            expect(mockUtils.throwErrorIfNotLoggedIn).toHaveBeenCalledWith(program);
+            expect(mockUtils.validateExportFolder).toHaveBeenCalledWith('/path/to/export');
+            expect(mockUtils.createTarFile).toHaveBeenCalledWith('/path/to/export');
+            expect(mockUtils.createMigration).toHaveBeenCalledWith({
+                assetId: 'asset-123',
+                previewAssetId: 'preview-456',
+                matrixUrl: 'https://matrix.example.com',
+            });
+            expect(mockUtils.uploadFileToS3).toHaveBeenCalledWith('https://upload.s3.amazonaws.com', '/path/to/export_123.tar.gz', undefined);
+            expect(mockFs.unlinkSync).toHaveBeenCalledWith('/path/to/export_123.tar.gz');
+            expect(mockUtils.validateExportFolder).toHaveBeenCalledTimes(1);
+            expect(mockUtils.createTarFile).toHaveBeenCalledTimes(1);
+            expect(mockUtils.createMigration).toHaveBeenCalledTimes(1);
+            expect(mockUtils.uploadFileToS3).toHaveBeenCalledTimes(1);
+            expect(mockFs.unlinkSync).toHaveBeenCalledTimes(1);
+            expect(mockUtils.handleCommandError).not.toHaveBeenCalled();
+        }));
+        it('should create migration with tenant option', () => __awaiter(void 0, void 0, void 0, function* () {
+            const program = (0, createMigration_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                '--asset-id',
+                'asset-123',
+                '--preview-asset-id',
+                'preview-456',
+                '--matrix-url',
+                'https://matrix.example.com',
+                '--tenant',
+                'test-tenant',
+                '/path/to/export',
+            ]);
+            expect(mockUtils.createMigration).toHaveBeenCalledWith({
+                assetId: 'asset-123',
+                previewAssetId: 'preview-456',
+                matrixUrl: 'https://matrix.example.com',
+                tenant: 'test-tenant',
+            });
+            expect(mockUtils.uploadFileToS3).toHaveBeenCalledWith('https://upload.s3.amazonaws.com', '/path/to/export_123.tar.gz', 'test-tenant');
+        }));
+        it('should create migration with override URL when environment variable is set', () => __awaiter(void 0, void 0, void 0, function* () {
+            const originalEnv = process.env.ENABLE_OVERRIDE_MIGRATION_URL;
+            process.env.ENABLE_OVERRIDE_MIGRATION_URL = 'true';
+            const program = (0, createMigration_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                '--asset-id',
+                'asset-123',
+                '--preview-asset-id',
+                'preview-456',
+                '--matrix-url',
+                'https://matrix.example.com',
+                '--overrideUrl',
+                'https://custom.migration.url',
+                '/path/to/export',
+            ]);
+            expect(mockUtils.createMigration).toHaveBeenCalledWith({
+                assetId: 'asset-123',
+                previewAssetId: 'preview-456',
+                matrixUrl: 'https://matrix.example.com',
+                overrideUrl: 'https://custom.migration.url',
+            });
+            process.env.ENABLE_OVERRIDE_MIGRATION_URL = originalEnv;
+        }));
+    });
+    describe('error scenarios', () => {
+        it('should handle validation error for export folder', () => __awaiter(void 0, void 0, void 0, function* () {
+            const validationError = new Error('Export folder does not exist');
+            mockUtils.validateExportFolder.mockImplementation(() => {
+                throw validationError;
+            });
+            mockUtils.handleCommandError.mockImplementation(() => { });
+            const program = (0, createMigration_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                '--asset-id',
+                'asset-123',
+                '--preview-asset-id',
+                'preview-456',
+                '--matrix-url',
+                'https://matrix.example.com',
+                '/invalid/path',
+            ]);
+            expect(mockUtils.handleCommandError).toHaveBeenCalledWith(program, validationError);
+            expect(mockUtils.createTarFile).not.toHaveBeenCalled();
+        }));
+        it('should handle tar file creation failure', () => __awaiter(void 0, void 0, void 0, function* () {
+            mockUtils.createTarFile.mockResolvedValue(null);
+            const program = (0, createMigration_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                '--asset-id',
+                'asset-123',
+                '--preview-asset-id',
+                'preview-456',
+                '--matrix-url',
+                'https://matrix.example.com',
+                '/path/to/export',
+            ]);
+            expect(mockUtils.createMigration).not.toHaveBeenCalled();
+            expect(mockUtils.uploadFileToS3).not.toHaveBeenCalled();
+        }));
+        it('should handle migration creation failure', () => __awaiter(void 0, void 0, void 0, function* () {
+            mockUtils.createMigration.mockResolvedValue(null);
+            const program = (0, createMigration_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                '--asset-id',
+                'asset-123',
+                '--preview-asset-id',
+                'preview-456',
+                '--matrix-url',
+                'https://matrix.example.com',
+                '/path/to/export',
+            ]);
+            expect(mockUtils.uploadFileToS3).not.toHaveBeenCalled();
+            expect(mockFs.unlinkSync).not.toHaveBeenCalled();
+        }));
+        it('should handle S3 upload failure', () => __awaiter(void 0, void 0, void 0, function* () {
+            mockUtils.uploadFileToS3.mockResolvedValue(null);
+            const program = (0, createMigration_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                '--asset-id',
+                'asset-123',
+                '--preview-asset-id',
+                'preview-456',
+                '--matrix-url',
+                'https://matrix.example.com',
+                '/path/to/export',
+            ]);
+            expect(mockFs.unlinkSync).not.toHaveBeenCalled();
+        }));
+        it('should handle migration API error', () => __awaiter(void 0, void 0, void 0, function* () {
+            const apiError = new Error('Migration API failed');
+            mockUtils.createMigration.mockRejectedValue(apiError);
+            mockUtils.handleCommandError.mockImplementation(() => { });
+            const program = (0, createMigration_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                '--asset-id',
+                'asset-123',
+                '--preview-asset-id',
+                'preview-456',
+                '--matrix-url',
+                'https://matrix.example.com',
+                '/path/to/export',
+            ]);
+            expect(mockUtils.handleCommandError).toHaveBeenCalledWith(program, apiError);
+        }));
+        it('should handle not being logged in', () => __awaiter(void 0, void 0, void 0, function* () {
+            const loginError = new Error('Not logged in');
+            mockUtils.throwErrorIfNotLoggedIn.mockImplementation(() => {
+                throw loginError;
+            });
+            const program = (0, createMigration_1.default)();
+            yield expect(program.parseAsync([
+                'node',
+                'dxp-cli',
+                '--asset-id',
+                'asset-123',
+                '--preview-asset-id',
+                'preview-456',
+                '--matrix-url',
+                'https://matrix.example.com',
+                '/path/to/export',
+            ])).rejects.toThrow('Not logged in');
+            expect(mockUtils.validateExportFolder).not.toHaveBeenCalled();
+        }));
+    });
+    describe('required options validation', () => {
+        it('should require assetid option', () => {
+            const program = (0, createMigration_1.default)().exitOverride();
+            expect(() => {
+                program.parse([
+                    'node',
+                    'dxp-cli',
+                    '--preview-asset-id',
+                    'preview-456',
+                    '--matrix-url',
+                    'https://matrix.example.com',
+                    '/path/to/export',
+                ]);
+            }).toThrow();
+        });
+        it('should require previewAssetid option', () => {
+            const program = (0, createMigration_1.default)().exitOverride();
+            expect(() => {
+                program.parse([
+                    'node',
+                    'dxp-cli',
+                    '--asset-id',
+                    'asset-123',
+                    '--matrix-url',
+                    'https://matrix.example.com',
+                    '/path/to/export',
+                ]);
+            }).toThrow();
+        });
+        it('should require matrixUrl option', () => {
+            const program = (0, createMigration_1.default)().exitOverride();
+            expect(() => {
+                program.parse([
+                    'node',
+                    'dxp-cli',
+                    '--asset-id',
+                    'asset-123',
+                    '--preview-asset-id',
+                    'preview-456',
+                    '/path/to/export',
+                ]);
+            }).toThrow();
+        });
+        it('should require exportPath argument', () => {
+            const program = (0, createMigration_1.default)().exitOverride();
+            expect(() => {
+                program.parse([
+                    'node',
+                    'dxp-cli',
+                    '--asset-id',
+                    'asset-123',
+                    '--preview-asset-id',
+                    'preview-456',
+                    '--matrix-url',
+                    'https://matrix.example.com',
+                ]);
+            }).toThrow();
+        });
+    });
+    describe('command configuration', () => {
+        it('should have correct command name and description', () => {
+            const program = (0, createMigration_1.default)();
+            expect(program.name()).toBe('create');
+            expect(program.description()).toBe('Create a new migration using the AI Page migration service');
+        });
+        it('should parse options correctly', () => {
+            const program = (0, createMigration_1.default)();
+            program.parse([
+                'node',
+                'dxp-cli',
+                '--asset-id',
+                'asset-123',
+                '--preview-asset-id',
+                'preview-456',
+                '--matrix-url',
+                'https://matrix.example.com',
+                '--tenant',
+                'test-tenant',
+                '/path/to/export',
+            ]);
+            const opts = program.opts();
+            expect(opts.assetId).toBe('asset-123');
+            expect(opts.previewAssetId).toBe('preview-456');
+            expect(opts.matrixUrl).toBe('https://matrix.example.com');
+            expect(opts.tenant).toBe('test-tenant');
+        });
+    });
+    describe('spinner and output behavior', () => {
+        it('should display appropriate spinner messages during execution', () => __awaiter(void 0, void 0, void 0, function* () {
+            const program = (0, createMigration_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                '--asset-id',
+                'asset-123',
+                '--preview-asset-id',
+                'preview-456',
+                '--matrix-url',
+                'https://matrix.example.com',
+                '/path/to/export',
+            ]);
+            expect(mockUtils.validateExportFolder).toHaveBeenCalledWith('/path/to/export');
+            expect(mockUtils.createTarFile).toHaveBeenCalledWith('/path/to/export');
+            expect(mockUtils.createMigration).toHaveBeenCalled();
+            expect(mockUtils.uploadFileToS3).toHaveBeenCalled();
+            expect(mockFs.unlinkSync).toHaveBeenCalled();
+        }));
+    });
+});

package/lib/migration/get/getMigration.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+declare const getMigrationCommand: () => Command;
+export default getMigrationCommand;

package/lib/migration/get/getMigration.js

@@ -0,0 +1,47 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chalk_1 = __importDefault(require("chalk"));
+const commander_1 = require("commander");
+const utils_1 = require("../utils");
+const ora_1 = __importDefault(require("ora"));
+const getMigrationCommand = () => {
+    const getCommand = new commander_1.Command('get')
+        .name('get')
+        .description('Get a migration using the AI Page migration service')
+        .addOption(new commander_1.Option('--migration-id <string>', 'The ID of the migration to get').makeOptionMandatory())
+        .addOption(new commander_1.Option('--asset-id <string>', 'The ID of the asset to get the migration for'))
+        .addOption(new commander_1.Option('-t, --tenant <string>', 'Tenant ID to run against. If not provided will use configured tenant from login'))
+        .configureOutput({
+        outputError(str, write) {
+            write(chalk_1.default.red(str));
+        },
+    })
+        .action((options) => __awaiter(void 0, void 0, void 0, function* () {
+        const spinner = (0, ora_1.default)('Getting migration').start();
+        yield (0, utils_1.throwErrorIfNotLoggedIn)(getCommand);
+        try {
+            const response = yield (0, utils_1.getMigration)(options);
+            spinner.succeed(`Migration details: ${JSON.stringify(response, null, 2)}`);
+        }
+        catch (error) {
+            (0, utils_1.handleCommandError)(getCommand, error);
+        }
+    }));
+    if (process.env.ENABLE_OVERRIDE_MIGRATION_URL === 'true') {
+        getCommand.addOption(new commander_1.Option('-ou, --overrideUrl <string>', 'Developer option to override the entire migration url with a custom value'));
+    }
+    return getCommand;
+};
+exports.default = getMigrationCommand;

package/lib/migration/get/getMigration.spec.d.ts

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