@squiz/dxp-cli-next 5.26.0-develop.3 → 5.26.0-develop.4

package/lib/migration/index.js

@@ -6,11 +6,13 @@ 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 revert_1 = __importDefault(require("./revert/revert"));
 const setMigrationSettings_1 = __importDefault(require("./settings/setMigrationSettings"));
 const migrationCommand = new commander_1.Command('migration');
 migrationCommand
     .description('AI Page Migration Service Commands')
     .addCommand((0, createMigration_1.default)())
     .addCommand((0, getMigration_1.default)())
+    .addCommand((0, revert_1.default)())
     .addCommand((0, setMigrationSettings_1.default)());
 exports.default = migrationCommand;

package/lib/migration/revert/revert.d.ts

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

package/lib/migration/revert/revert.js

@@ -0,0 +1,48 @@
+"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 revertMigrationCommand = () => {
+    const revertCommand = new commander_1.Command('revert')
+        .name('revert')
+        .description('Revert the current stage of a migration using the AI Page migration service')
+        .addOption(new commander_1.Option('--migration-id <string>', 'The ID of the migration to revert').makeOptionMandatory())
+        .addOption(new commander_1.Option('--asset-id <string>', 'The ID of the asset to revert 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)('Reverting...').start();
+        yield (0, utils_1.throwErrorIfNotLoggedIn)(revertCommand);
+        try {
+            const response = yield (0, utils_1.revertMigration)(options);
+            spinner.succeed(response.message);
+        }
+        catch (error) {
+            spinner.fail();
+            (0, utils_1.handleCommandError)(revertCommand, error);
+        }
+    }));
+    if (process.env.ENABLE_OVERRIDE_MIGRATION_URL === 'true') {
+        revertCommand.addOption(new commander_1.Option('-ou, --overrideUrl <string>', 'Developer option to override the entire migration url with a custom value'));
+    }
+    return revertCommand;
+};
+exports.default = revertMigrationCommand;

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

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

package/lib/migration/revert/revert.spec.js

@@ -0,0 +1,150 @@
+"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 revert_1 = __importDefault(require("./revert"));
+const utils = __importStar(require("../utils"));
+jest.mock('../utils');
+jest.mock('../../ApplicationStore');
+const mockUtils = utils;
+describe('revertMigrationCommand', () => {
+    beforeEach(() => {
+        jest.clearAllMocks();
+        jest.resetAllMocks();
+    });
+    describe('command configuration', () => {
+        it('should have correct command name and description', () => {
+            const program = (0, revert_1.default)();
+            expect(program.name()).toBe('revert');
+            expect(program.description()).toBe('Revert the current stage of a migration using the AI Page migration service');
+        });
+        it('should have required migration-id option', () => {
+            const program = (0, revert_1.default)();
+            const options = program.options;
+            const migrationIdOption = options.find((opt) => opt.long === '--migration-id');
+            expect(migrationIdOption).toBeDefined();
+            expect(migrationIdOption === null || migrationIdOption === void 0 ? void 0 : migrationIdOption.mandatory).toBe(true);
+        });
+        it('should have optional asset-id option', () => {
+            const program = (0, revert_1.default)();
+            const options = program.options;
+            const assetIdOption = options.find((opt) => opt.long === '--asset-id');
+            expect(assetIdOption).toBeDefined();
+            expect(assetIdOption === null || assetIdOption === void 0 ? void 0 : assetIdOption.mandatory).toBe(false);
+        });
+        it('should have optional tenant option', () => {
+            const program = (0, revert_1.default)();
+            const options = program.options;
+            const tenantOption = options.find((opt) => opt.long === '--tenant');
+            expect(tenantOption).toBeDefined();
+            expect(tenantOption === null || tenantOption === void 0 ? void 0 : tenantOption.mandatory).toBe(false);
+        });
+    });
+    describe('command execution', () => {
+        it('should revert migration successfully with required options', () => __awaiter(void 0, void 0, void 0, function* () {
+            const mockResponse = { message: 'Migration reverted successfully' };
+            mockUtils.revertMigration.mockResolvedValue(mockResponse);
+            mockUtils.throwErrorIfNotLoggedIn.mockResolvedValue();
+            const program = (0, revert_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                'migration',
+                'revert',
+                '--migration-id',
+                'migration-123',
+                '--asset-id',
+                'asset-456',
+            ]);
+            expect(mockUtils.throwErrorIfNotLoggedIn).toHaveBeenCalledWith(program);
+            expect(mockUtils.revertMigration).toHaveBeenCalledWith({
+                migrationId: 'migration-123',
+                assetId: 'asset-456',
+            });
+            expect(mockUtils.handleCommandError).not.toHaveBeenCalled();
+        }));
+        it('should revert migration with tenant option', () => __awaiter(void 0, void 0, void 0, function* () {
+            const mockResponse = { message: 'Migration reverted successfully' };
+            mockUtils.revertMigration.mockResolvedValue(mockResponse);
+            mockUtils.throwErrorIfNotLoggedIn.mockResolvedValue();
+            const program = (0, revert_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                'migration',
+                'revert',
+                '--migration-id',
+                'migration-123',
+                '--asset-id',
+                'asset-456',
+                '--tenant',
+                'test-tenant',
+            ]);
+            expect(mockUtils.revertMigration).toHaveBeenCalledWith({
+                migrationId: 'migration-123',
+                assetId: 'asset-456',
+                tenant: 'test-tenant',
+            });
+        }));
+        it('should handle revert migration error', () => __awaiter(void 0, void 0, void 0, function* () {
+            const error = new Error('Revert failed');
+            mockUtils.revertMigration.mockRejectedValue(error);
+            mockUtils.throwErrorIfNotLoggedIn.mockResolvedValue();
+            const program = (0, revert_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                'migration',
+                'revert',
+                '--migration-id',
+                'migration-123',
+                '--asset-id',
+                'asset-456',
+            ]);
+            expect(mockUtils.handleCommandError).toHaveBeenCalledWith(program, error);
+        }));
+        it('should include override URL option 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, revert_1.default)();
+            const options = program.options;
+            const overrideUrlOption = options.find((opt) => opt.long === '--overrideUrl');
+            expect(overrideUrlOption).toBeDefined();
+            expect(overrideUrlOption === null || overrideUrlOption === void 0 ? void 0 : overrideUrlOption.mandatory).toBe(false);
+            process.env.ENABLE_OVERRIDE_MIGRATION_URL = originalEnv;
+        }));
+    });
+});

package/lib/migration/types.d.ts

@@ -35,6 +35,11 @@ export interface GetMigrationAPIResponse {
     previewPageAssetId?: string;
     componentsTarDownloadUrl?: string;
 }
+export interface RevertMigrationOptions extends GetMigrationOptions {
+}
+export interface RevertMigrationAPIResponse {
+    message: string;
+}
 export interface SetMigrationSettingOptions {
     matrixUrl: string;
     matrixIdentifier: string;

package/lib/migration/utils.d.ts

@@ -1,5 +1,5 @@
 import { Command } from 'commander';
-import { CreateMigrationOptions, CreateMigrationAPIResponse, GetMigrationOptions, GetMigrationAPIResponse, SetMigrationSettingOptions, SetMigrationSettingAPIResponse } from './types';
+import { CreateMigrationOptions, CreateMigrationAPIResponse, GetMigrationOptions, GetMigrationAPIResponse, RevertMigrationOptions, RevertMigrationAPIResponse, SetMigrationSettingOptions, SetMigrationSettingAPIResponse } 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>;
@@ -11,4 +11,5 @@ export declare function getMigrationHeaders(tenantID?: string): Promise<Record<s
 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>;
+export declare function revertMigration(options: RevertMigrationOptions): Promise<RevertMigrationAPIResponse>;
 export declare function setMigrationSetting(options: SetMigrationSettingOptions): Promise<SetMigrationSettingAPIResponse>;

package/lib/migration/utils.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setMigrationSetting = exports.getMigration = exports.createMigration = exports.uploadFileToS3 = exports.getMigrationHeaders = exports.createTarFile = exports.validateExportFolder = exports.redactKey = exports.validateAxiosStatus = exports.buildMigrationUrl = exports.throwErrorIfNotLoggedIn = exports.handleCommandError = void 0;
+exports.setMigrationSetting = exports.revertMigration = exports.getMigration = exports.createMigration = exports.uploadFileToS3 = exports.getMigrationHeaders = exports.createTarFile = exports.validateExportFolder = exports.redactKey = 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"));
@@ -233,6 +233,30 @@ function getMigration(options) {
     });
 }
 exports.getMigration = getMigration;
+function revertMigration(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.post(`${migrationUrl}/migrations/${options.migrationId}/assets/${options.assetId}/rollback`, {}, {
+                headers: Object.assign({ 'Content-Type': 'application/json' }, (yield getMigrationHeaders(options.tenant))),
+            });
+            if (response.status !== 200) {
+                throw new Error(`Failed to revert migration: ${response.status}`);
+            }
+            return response.data;
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                throw error;
+            }
+            throw new Error(`Failed to revert migration: ${error}`);
+        }
+    });
+}
+exports.revertMigration = revertMigration;
 function setMigrationSetting(options) {
     return __awaiter(this, void 0, void 0, function* () {
         const apiService = new ApiService_1.ApiService({

package/lib/migration/utils.spec.js

@@ -547,4 +547,71 @@ describe('Migration Utils', () => {
             expect(mockApiServiceInstance.client.get).toHaveBeenCalledWith('https://example.com/__dxp/service/aiapps/migration/migrations/migration-123/assets/asset-456', expect.any(Object));
         }));
     });
+    describe('revertMigration', () => {
+        const mockOptions = {
+            migrationId: 'migration-123',
+            assetId: 'asset-456',
+            tenant: 'test-tenant',
+        };
+        const mockApiServiceInstance = {
+            client: {
+                post: jest.fn(),
+            },
+        };
+        beforeEach(() => {
+            mockApiService.mockImplementation(() => mockApiServiceInstance);
+            mockFetchApplicationConfig.mockResolvedValue({
+                baseUrl: 'https://test.example.com',
+                tenant: 'test-tenant',
+                region: 'us-east-1',
+            });
+        });
+        it('should revert migration successfully', () => __awaiter(void 0, void 0, void 0, function* () {
+            const mockResponse = {
+                status: 200,
+                data: { message: 'Migration reverted successfully' },
+            };
+            mockApiServiceInstance.client.post.mockResolvedValue(mockResponse);
+            const result = yield (0, utils_1.revertMigration)(mockOptions);
+            expect(result).toEqual({ message: 'Migration reverted successfully' });
+            expect(mockApiServiceInstance.client.post).toHaveBeenCalledWith('https://test.example.com/__dxp/service/aiapps/migration/migrations/migration-123/assets/asset-456/rollback', {}, {
+                headers: {
+                    'Content-Type': 'application/json',
+                    'x-dxp-tenant': 'test-tenant',
+                },
+            });
+        }));
+        it('should handle non-success status codes', () => __awaiter(void 0, void 0, void 0, function* () {
+            const mockResponse = {
+                status: 400,
+                data: {},
+            };
+            mockApiServiceInstance.client.post.mockResolvedValue(mockResponse);
+            yield expect((0, utils_1.revertMigration)(mockOptions)).rejects.toThrow('Failed to revert migration: 400');
+        }));
+        it('should handle API service errors', () => __awaiter(void 0, void 0, void 0, function* () {
+            const error = new Error('Network error');
+            mockApiServiceInstance.client.post.mockRejectedValue(error);
+            yield expect((0, utils_1.revertMigration)(mockOptions)).rejects.toThrow('Network error');
+        }));
+        it('should handle unknown errors', () => __awaiter(void 0, void 0, void 0, function* () {
+            mockApiServiceInstance.client.post.mockRejectedValue('Unknown error');
+            yield expect((0, utils_1.revertMigration)(mockOptions)).rejects.toThrow('Failed to revert migration: Unknown error');
+        }));
+        it('should use override URL when provided', () => __awaiter(void 0, void 0, void 0, function* () {
+            const mockResponse = {
+                status: 200,
+                data: { message: 'Migration reverted successfully' },
+            };
+            mockApiServiceInstance.client.post.mockResolvedValue(mockResponse);
+            const optionsWithOverride = Object.assign(Object.assign({}, mockOptions), { overrideUrl: 'https://custom.migration.url' });
+            yield (0, utils_1.revertMigration)(optionsWithOverride);
+            expect(mockApiServiceInstance.client.post).toHaveBeenCalledWith('https://custom.migration.url/migrations/migration-123/assets/asset-456/rollback', {}, {
+                headers: {
+                    'Content-Type': 'application/json',
+                    'x-dxp-tenant': 'test-tenant',
+                },
+            });
+        }));
+    });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dxp-cli-next",
-  "version": "5.26.0-develop.3",
+  "version": "5.26.0-develop.4",
   "repository": {
     "url": "https://gitlab.squiz.net/dxp/dxp-cli-next"
   },