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

package/lib/migration/get/getMigration.spec.js

@@ -0,0 +1,278 @@
+"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 getMigration_1 = __importDefault(require("./getMigration"));
+const utils = __importStar(require("../utils"));
+const ApplicationStore = __importStar(require("../../ApplicationStore"));
+jest.mock('../utils');
+jest.mock('../../ApplicationStore');
+const mockUtils = utils;
+const mockApplicationStore = ApplicationStore;
+describe('getMigrationCommand', () => {
+    let logSpy;
+    let mockGetMigrationResponse;
+    beforeEach(() => {
+        nock_1.default.cleanAll();
+        jest.clearAllMocks();
+        jest.resetAllMocks();
+        logSpy = jest.spyOn(console, 'log').mockImplementation(() => { });
+        mockApplicationStore.getApplicationFile.mockResolvedValue('session-cookie');
+        mockUtils.throwErrorIfNotLoggedIn.mockResolvedValue(undefined);
+        mockGetMigrationResponse = {
+            migrationId: 'migration-123',
+            assetId: 'asset-456',
+            stage: 'completed',
+            status: 'success',
+            stageDetail: 'Migration completed successfully',
+            previewPageAssetId: 'preview-789',
+            componentDownloadUrl: 'https://download.example.com/components.zip',
+        };
+        mockUtils.getMigration.mockResolvedValue(mockGetMigrationResponse);
+    });
+    afterEach(() => {
+        logSpy.mockRestore();
+    });
+    describe('successful migration retrieval', () => {
+        it('should get migration successfully with required options', () => __awaiter(void 0, void 0, void 0, function* () {
+            const program = (0, getMigration_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                '--migration-id',
+                'migration-123',
+                '--asset-id',
+                'asset-456',
+            ]);
+            expect(mockUtils.throwErrorIfNotLoggedIn).toHaveBeenCalledWith(program);
+            expect(mockUtils.getMigration).toHaveBeenCalledWith({
+                migrationId: 'migration-123',
+                assetId: 'asset-456',
+            });
+            expect(mockUtils.getMigration).toHaveBeenCalledTimes(1);
+            expect(mockUtils.handleCommandError).not.toHaveBeenCalled();
+        }));
+        it('should get migration with tenant option', () => __awaiter(void 0, void 0, void 0, function* () {
+            const program = (0, getMigration_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                '--migration-id',
+                'migration-123',
+                '--asset-id',
+                'asset-456',
+                '--tenant',
+                'test-tenant',
+            ]);
+            expect(mockUtils.getMigration).toHaveBeenCalledWith({
+                migrationId: 'migration-123',
+                assetId: 'asset-456',
+                tenant: 'test-tenant',
+            });
+        }));
+        it('should get 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, getMigration_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                '--migration-id',
+                'migration-123',
+                '--asset-id',
+                'asset-456',
+                '--overrideUrl',
+                'https://custom.migration.url',
+            ]);
+            expect(mockUtils.getMigration).toHaveBeenCalledWith({
+                migrationId: 'migration-123',
+                assetId: 'asset-456',
+                overrideUrl: 'https://custom.migration.url',
+            });
+            process.env.ENABLE_OVERRIDE_MIGRATION_URL = originalEnv;
+        }));
+        it('should get migration without asset-id option', () => __awaiter(void 0, void 0, void 0, function* () {
+            const program = (0, getMigration_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                '--migration-id',
+                'migration-123',
+            ]);
+            expect(mockUtils.getMigration).toHaveBeenCalledWith({
+                migrationId: 'migration-123',
+            });
+        }));
+    });
+    describe('error scenarios', () => {
+        it('should handle getMigration API error', () => __awaiter(void 0, void 0, void 0, function* () {
+            const apiError = new Error('Migration not found');
+            mockUtils.getMigration.mockRejectedValue(apiError);
+            mockUtils.handleCommandError.mockImplementation(() => { });
+            const program = (0, getMigration_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                '--migration-id',
+                'migration-123',
+                '--asset-id',
+                'asset-456',
+            ]);
+            expect(mockUtils.handleCommandError).toHaveBeenCalledWith(program, apiError);
+        }));
+        it('should handle network error', () => __awaiter(void 0, void 0, void 0, function* () {
+            const networkError = new Error('Network connection failed');
+            mockUtils.getMigration.mockRejectedValue(networkError);
+            mockUtils.handleCommandError.mockImplementation(() => { });
+            const program = (0, getMigration_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                '--migration-id',
+                'migration-123',
+                '--asset-id',
+                'asset-456',
+            ]);
+            expect(mockUtils.handleCommandError).toHaveBeenCalledWith(program, networkError);
+        }));
+    });
+    describe('required options validation', () => {
+        it('should require migration-id option', () => {
+            const program = (0, getMigration_1.default)().exitOverride();
+            expect(() => {
+                program.parse(['node', 'dxp-cli', '--asset-id', 'asset-456']);
+            }).toThrow();
+        });
+        it('should not require asset-id option', () => {
+            const program = (0, getMigration_1.default)().exitOverride();
+            expect(() => {
+                program.parse(['node', 'dxp-cli', '--migration-id', 'migration-123']);
+            }).not.toThrow();
+        });
+    });
+    describe('command configuration', () => {
+        it('should have correct command name and description', () => {
+            const program = (0, getMigration_1.default)();
+            expect(program.name()).toBe('get');
+            expect(program.description()).toBe('Get a migration using the AI Page migration service');
+        });
+        it('should parse options correctly', () => {
+            const program = (0, getMigration_1.default)();
+            program.parse([
+                'node',
+                'dxp-cli',
+                '--migration-id',
+                'migration-123',
+                '--asset-id',
+                'asset-456',
+                '--tenant',
+                'test-tenant',
+            ]);
+            const opts = program.opts();
+            expect(opts.migrationId).toBe('migration-123');
+            expect(opts.assetId).toBe('asset-456');
+            expect(opts.tenant).toBe('test-tenant');
+        });
+        it('should parse options with kebab-case to camelCase conversion', () => {
+            const program = (0, getMigration_1.default)();
+            program.parse([
+                'node',
+                'dxp-cli',
+                '--migration-id',
+                'migration-123',
+                '--asset-id',
+                'asset-456',
+            ]);
+            const opts = program.opts();
+            expect(opts.migrationId).toBe('migration-123');
+            expect(opts.assetId).toBe('asset-456');
+        });
+    });
+    describe('spinner and output behavior', () => {
+        it('should display appropriate spinner messages during execution', () => __awaiter(void 0, void 0, void 0, function* () {
+            const program = (0, getMigration_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                '--migration-id',
+                'migration-123',
+                '--asset-id',
+                'asset-456',
+            ]);
+            expect(mockUtils.throwErrorIfNotLoggedIn).toHaveBeenCalledWith(program);
+            expect(mockUtils.getMigration).toHaveBeenCalled();
+        }));
+        it('should format output correctly', () => __awaiter(void 0, void 0, void 0, function* () {
+            const program = (0, getMigration_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                '--migration-id',
+                'migration-123',
+                '--asset-id',
+                'asset-456',
+            ]);
+            expect(mockUtils.getMigration).toHaveBeenCalledWith({
+                migrationId: 'migration-123',
+                assetId: 'asset-456',
+            });
+        }));
+    });
+    describe('override URL configuration', () => {
+        it('should work 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, getMigration_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                '--migration-id',
+                'migration-123',
+                '--asset-id',
+                'asset-456',
+                '--overrideUrl',
+                'https://custom.migration.url',
+            ]);
+            expect(mockUtils.getMigration).toHaveBeenCalledWith({
+                migrationId: 'migration-123',
+                assetId: 'asset-456',
+                overrideUrl: 'https://custom.migration.url',
+            });
+            process.env.ENABLE_OVERRIDE_MIGRATION_URL = originalEnv;
+        }));
+    });
+});

package/lib/migration/index.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+declare const migrationCommand: Command;
+export default migrationCommand;

package/lib/migration/index.js

@@ -0,0 +1,14 @@
+"use strict";
+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 createMigration_1 = __importDefault(require("./create/createMigration"));
+const getMigration_1 = __importDefault(require("./get/getMigration"));
+const migrationCommand = new commander_1.Command('migration');
+migrationCommand
+    .description('AI Page Migration Service Commands')
+    .addCommand((0, createMigration_1.default)())
+    .addCommand((0, getMigration_1.default)());
+exports.default = migrationCommand;

package/lib/migration/types.d.ts

@@ -0,0 +1,37 @@
+export interface CreateMigrationOptions {
+    assetId: string;
+    previewAssetId: string;
+    matrixUrl: string;
+    tenant?: string;
+    overrideUrl?: string;
+}
+export interface CreateMigrationAPIResponse {
+    assetMigration: {
+        migrationId: string;
+        assetId: string;
+        xmlFilePath: string;
+        matrixUrl: string;
+        previewAssetId: string;
+        stage: string;
+        status: string;
+        created: number;
+        updated: number;
+        migrationIdAssetId: string;
+    };
+    uploadUrl: string;
+}
+export interface GetMigrationOptions {
+    migrationId: string;
+    assetId: string;
+    tenant?: string;
+    overrideUrl?: string;
+}
+export interface GetMigrationAPIResponse {
+    migrationId: string;
+    assetId: string;
+    stage: string;
+    status: string;
+    stageDetails?: string;
+    previewPageAssetId?: string;
+    componentsTarDownloadUrl?: string;
+}

package/lib/migration/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/migration/utils.d.ts

@@ -0,0 +1,12 @@
+import { Command } from 'commander';
+import { CreateMigrationOptions, CreateMigrationAPIResponse, GetMigrationOptions, GetMigrationAPIResponse } from './types';
+export declare function handleCommandError(command: Command, error: Error): void;
+export declare function throwErrorIfNotLoggedIn(command: Command): Promise<void>;
+export declare function buildMigrationUrl(tenantID?: string, overrideUrl?: string): Promise<string>;
+export declare function validateAxiosStatus(status: number): boolean;
+export declare function validateExportFolder(exportPath: string): void;
+export declare function createTarFile(exportPath: string): Promise<string>;
+export declare function getMigrationHeaders(tenantID?: string): Promise<Record<string, string>>;
+export declare function uploadFileToS3(uploadUrl: string, filePath: string, tenantID?: string): Promise<string>;
+export declare function createMigration(options: CreateMigrationOptions): Promise<CreateMigrationAPIResponse>;
+export declare function getMigration(options: GetMigrationOptions): Promise<GetMigrationAPIResponse>;

package/lib/migration/utils.js

@@ -0,0 +1,225 @@
+"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 });
+exports.getMigration = exports.createMigration = exports.uploadFileToS3 = exports.getMigrationHeaders = exports.createTarFile = exports.validateExportFolder = exports.validateAxiosStatus = exports.buildMigrationUrl = exports.throwErrorIfNotLoggedIn = exports.handleCommandError = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const chalk_1 = __importDefault(require("chalk"));
+const ApplicationConfig_1 = require("../ApplicationConfig");
+const axios_1 = __importDefault(require("axios"));
+const ApplicationStore_1 = require("../ApplicationStore");
+const child_process_1 = require("child_process");
+const ApiService_1 = require("../ApiService");
+function handleCommandError(command, error) {
+    var _a, _b, _c, _d;
+    if (axios_1.default.isAxiosError(error)) {
+        let message = `${error.message}`;
+        if ((_b = (_a = error.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.message) {
+            message += `: ${error.response.data.message}`;
+        }
+        if ((_d = (_c = error.response) === null || _c === void 0 ? void 0 : _c.data) === null || _d === void 0 ? void 0 : _d.details) {
+            message += ` - ${error.response.data.details}`;
+        }
+        command.error(chalk_1.default.red(message));
+    }
+    else {
+        if (!!process.env.DEBUG && error.stack) {
+            command.error(error.stack);
+        }
+        if (error.message) {
+            command.error(chalk_1.default.red(error.message));
+        }
+        else {
+            command.error(chalk_1.default.red('An unknown error occurred'));
+        }
+    }
+}
+exports.handleCommandError = handleCommandError;
+function throwErrorIfNotLoggedIn(command) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!(yield (0, ApplicationStore_1.getApplicationFile)(ApplicationStore_1.STORE_FILES.sessionCookie))) {
+            command.error(chalk_1.default.red('You must login to interact with the migration service. See `dxp-next auth login`'));
+        }
+    });
+}
+exports.throwErrorIfNotLoggedIn = throwErrorIfNotLoggedIn;
+function buildMigrationUrl(tenantID, overrideUrl) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!overrideUrl) {
+            const existingConfig = yield (0, ApplicationConfig_1.fetchApplicationConfig)(tenantID);
+            return `${existingConfig.baseUrl}/__dxp/service/aiapps/migration`;
+        }
+        else {
+            return overrideUrl;
+        }
+    });
+}
+exports.buildMigrationUrl = buildMigrationUrl;
+function validateAxiosStatus(status) {
+    return status < 400;
+}
+exports.validateAxiosStatus = validateAxiosStatus;
+function validateExportFolder(exportPath) {
+    // Check if the export folder exists
+    if (!fs_1.default.existsSync(exportPath)) {
+        throw new Error(`Export folder does not exist: ${exportPath}`);
+    }
+    // Check if it's a directory
+    if (!fs_1.default.statSync(exportPath).isDirectory()) {
+        throw new Error(`Export path is not a directory: ${exportPath}`);
+    }
+    // Check for nested export folder structure (e.g., ./export/export/...)
+    const nestedExportPath = path_1.default.join(exportPath, 'export');
+    if (!fs_1.default.existsSync(nestedExportPath)) {
+        throw new Error(`Nested export folder does not exist: ${nestedExportPath}`);
+    }
+    if (!fs_1.default.statSync(nestedExportPath).isDirectory()) {
+        throw new Error(`Nested export path is not a directory: ${nestedExportPath}`);
+    }
+    // Check for export.xml file in the nested export directory
+    const exportXmlPath = path_1.default.join(nestedExportPath, 'export.xml');
+    if (!fs_1.default.existsSync(exportXmlPath)) {
+        throw new Error(`export.xml file does not exist in: ${nestedExportPath}`);
+    }
+    if (!fs_1.default.statSync(exportXmlPath).isFile()) {
+        throw new Error(`export.xml is not a valid file: ${exportXmlPath}`);
+    }
+}
+exports.validateExportFolder = validateExportFolder;
+function createTarFile(exportPath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const tarFileName = `export_${Date.now()}.tar.gz`;
+        const tarFilePath = path_1.default.join(process.cwd(), tarFileName);
+        return new Promise((resolve, reject) => {
+            const tar = (0, child_process_1.spawn)('tar', [
+                '-czf',
+                tarFilePath,
+                '-C',
+                path_1.default.dirname(exportPath),
+                path_1.default.basename(exportPath),
+            ]);
+            tar.on('close', code => {
+                if (code === 0) {
+                    resolve(tarFilePath);
+                }
+                else {
+                    reject(new Error(`tar command failed with exit code ${code}`));
+                }
+            });
+            tar.on('error', error => {
+                reject(new Error(`Failed to create tar file: ${error.message}`));
+            });
+        });
+    });
+}
+exports.createTarFile = createTarFile;
+function getMigrationHeaders(tenantID) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const existingConfig = yield (0, ApplicationConfig_1.fetchApplicationConfig)(tenantID);
+        return {
+            'x-dxp-tenant': existingConfig.tenant,
+        };
+    });
+}
+exports.getMigrationHeaders = getMigrationHeaders;
+function uploadFileToS3(uploadUrl, filePath, tenantID) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const fileBuffer = fs_1.default.readFileSync(filePath);
+        const response = yield fetch(uploadUrl, {
+            method: 'PUT',
+            body: fileBuffer,
+            headers: Object.assign({}, (yield getMigrationHeaders(tenantID))),
+        });
+        return response.url;
+    });
+}
+exports.uploadFileToS3 = uploadFileToS3;
+function createMigration(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const apiService = new ApiService_1.ApiService({
+            validateStatus: validateAxiosStatus,
+        });
+        const migrationUrl = yield buildMigrationUrl(options.tenant, options.overrideUrl);
+        try {
+            const payload = {
+                assetId: options.assetId,
+                previewAssetId: options.previewAssetId,
+                matrixUrl: options.matrixUrl,
+            };
+            const response = yield apiService.client.post(`${migrationUrl}/migrations`, payload, {
+                headers: Object.assign({ 'Content-Type': 'application/json' }, (yield getMigrationHeaders(options.tenant))),
+            });
+            if (response.status !== 200 && response.status !== 201) {
+                throw new Error(`Migration creation failed with status: ${response.status}`);
+            }
+            // Validate response structure
+            const { assetMigration, uploadUrl } = response.data || {};
+            if (!(assetMigration === null || assetMigration === void 0 ? void 0 : assetMigration.migrationId) ||
+                !(assetMigration === null || assetMigration === void 0 ? void 0 : assetMigration.assetId) ||
+                !(assetMigration === null || assetMigration === void 0 ? void 0 : assetMigration.stage) ||
+                !(assetMigration === null || assetMigration === void 0 ? void 0 : assetMigration.status)) {
+                throw new Error('Invalid response format from migration service');
+            }
+            if (!uploadUrl) {
+                throw new Error('Upload URL not found in response');
+            }
+            return {
+                assetMigration,
+                uploadUrl,
+            };
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                throw error;
+            }
+            throw new Error(`Failed to create migration: ${error}`);
+        }
+    });
+}
+exports.createMigration = createMigration;
+function getMigration(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const apiService = new ApiService_1.ApiService({
+            validateStatus: validateAxiosStatus,
+        });
+        const migrationUrl = yield buildMigrationUrl(options.tenant, options.overrideUrl);
+        try {
+            const response = yield apiService.client.get(`${migrationUrl}/migrations/${options.migrationId}/assets/${options.assetId}`, {
+                headers: Object.assign({ 'Content-Type': 'application/json' }, (yield getMigrationHeaders(options.tenant))),
+            });
+            if (response.status !== 200) {
+                throw new Error(`Failed to get migration: ${response.status}`);
+            }
+            if (!(response === null || response === void 0 ? void 0 : response.data)) {
+                throw new Error('No data returned from migration service');
+            }
+            return {
+                migrationId: response.data.migrationId,
+                assetId: response.data.assetId,
+                stage: response.data.stage,
+                status: response.data.status,
+                stageDetails: response.data.stageDetails,
+                previewPageAssetId: response.data.previewPageAssetId,
+                componentsTarDownloadUrl: response.data.componentsTarDownloadUrl,
+            };
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                throw error;
+            }
+            throw new Error(`Failed to get migration: ${error}`);
+        }
+    });
+}
+exports.getMigration = getMigration;

package/lib/migration/utils.spec.d.ts

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