@squiz/dxp-cli-next 5.28.0 → 5.29.0

package/lib/migration/create/create.js

@@ -31,7 +31,7 @@ const createMigrationCommand = () => {
     })
         .action((options) => __awaiter(void 0, void 0, void 0, function* () {
         yield (0, utils_1.throwErrorIfNotLoggedIn)(createCommand);
-        let spinner = (0, ora_1.default)('Creating migration').start();
+        const spinner = (0, ora_1.default)('Creating migration').start();
         try {
             // Create migration
             const response = yield (0, utils_1.createMigration)(options);
@@ -39,8 +39,6 @@ const createMigrationCommand = () => {
                 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();
             spinner.succeed(`Successfully created migration: ${JSON.stringify({
                 migrationId: response.assetMigration.migrationId,
                 assetId: response.assetMigration.assetId,

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

@@ -65,7 +65,6 @@ describe('createMigrationCommand', () => {
                 updated: 1234567890,
                 migrationIdAssetId: 'migration-123-asset-456',
             },
-            uploadUrl: 'https://upload.s3.amazonaws.com',
         };
         mockCreateMigration.createMigration.mockResolvedValue(mockCreateMigrationResponse);
     });

package/lib/migration/next/next.js

@@ -45,6 +45,21 @@ const nextStageCommand = () => {
         const spinner = (0, ora_1.default)('Starting next stage').start();
         try {
             const { stageOptions: stageOptionsPath } = options, otherOptions = __rest(options, ["stageOptions"]);
+            const migration = yield (0, utils_1.getMigration)(otherOptions);
+            if (!migration) {
+                throw new Error('Migration not found');
+            }
+            const { stage, status, assetId } = migration;
+            const needsConfirmation = (stage === 'preview' && status === 'complete') ||
+                (stage === 'morph' && status === 'awaiting-confirmation');
+            if (needsConfirmation) {
+                spinner.stop();
+                const shouldProceed = yield (0, utils_1.promptForMorphConfirmation)(stage, status, assetId);
+                if (!shouldProceed) {
+                    return;
+                }
+                spinner.start('Starting next stage');
+            }
             const stageOptions = (0, utils_1.loadStageOptionsFromFile)(stageOptionsPath);
             const response = yield (0, utils_1.nextStage)(Object.assign(Object.assign({}, otherOptions), (stageOptions && { stageOptions })));
             spinner.succeed(response.message);

package/lib/migration/next/next.spec.js

@@ -40,11 +40,14 @@ const next_1 = __importDefault(require("./next"));
 const utils = __importStar(require("../utils/common"));
 const ApplicationStore = __importStar(require("../../ApplicationStore"));
 const nextStageModule = __importStar(require("../utils/nextStage"));
+const getMigrationModule = __importStar(require("../utils/getMigration"));
 jest.mock('../utils/common');
 jest.mock('../utils/nextStage');
+jest.mock('../utils/getMigration');
 jest.mock('../../ApplicationStore');
 const mockUtils = utils;
 const mockNextStage = nextStageModule;
+const mockGetMigration = getMigrationModule;
 const mockApplicationStore = ApplicationStore;
 describe('nextStageCommand', () => {
     let logSpy;
@@ -60,6 +63,18 @@ describe('nextStageCommand', () => {
             message: 'Successfully started next stage',
         };
         mockNextStage.nextStage.mockResolvedValue(mockNextStageResponse);
+        mockGetMigration.getMigration.mockResolvedValue({
+            migrationId: 'migration-123',
+            assetId: 'asset-456',
+            stage: 'validation',
+            status: 'completed',
+            xmlFilePath: 'test.xml',
+            matrixUrl: 'http://test.com',
+            previewAssetId: 'preview-123',
+            created: 1234567890,
+            updated: 1234567890,
+            migrationIdAssetId: 'migration-123-asset-456',
+        });
     });
     afterEach(() => {
         logSpy.mockRestore();
@@ -77,6 +92,10 @@ describe('nextStageCommand', () => {
                 'asset-456',
             ]);
             expect(mockUtils.throwErrorIfNotLoggedIn).toHaveBeenCalledWith(program);
+            expect(mockGetMigration.getMigration).toHaveBeenCalledWith({
+                migrationId: 'migration-123',
+                assetId: 'asset-456',
+            });
             expect(mockNextStage.nextStage).toHaveBeenCalledWith({
                 migrationId: 'migration-123',
                 assetId: 'asset-456',
@@ -97,6 +116,11 @@ describe('nextStageCommand', () => {
                 '--tenant',
                 'test-tenant',
             ]);
+            expect(mockGetMigration.getMigration).toHaveBeenCalledWith({
+                migrationId: 'migration-123',
+                assetId: 'asset-456',
+                tenant: 'test-tenant',
+            });
             expect(mockNextStage.nextStage).toHaveBeenCalledWith({
                 migrationId: 'migration-123',
                 assetId: 'asset-456',
@@ -116,6 +140,10 @@ describe('nextStageCommand', () => {
                 '--stage-options',
                 './src/__tests__/migration/stageOptionsInput.json',
             ]);
+            expect(mockGetMigration.getMigration).toHaveBeenCalledWith({
+                migrationId: 'migration-123',
+                assetId: 'asset-456',
+            });
             expect(mockNextStage.nextStage).toHaveBeenCalledWith({
                 migrationId: 'migration-123',
                 assetId: 'asset-456',
@@ -128,6 +156,22 @@ describe('nextStageCommand', () => {
         }));
     });
     describe('error scenarios', () => {
+        it('should handle getMigration error', () => __awaiter(void 0, void 0, void 0, function* () {
+            const migrationError = new Error('Failed to get migration: TypeError: Invalid URL');
+            mockGetMigration.getMigration.mockRejectedValue(migrationError);
+            mockUtils.handleCommandError.mockImplementation(() => { });
+            const program = (0, next_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                'next',
+                '--migration-id',
+                'migration-123',
+                '--asset-id',
+                'asset-456',
+            ]);
+            expect(mockUtils.handleCommandError).toHaveBeenCalledWith(program, migrationError);
+        }));
         it('should handle nextStage API error', () => __awaiter(void 0, void 0, void 0, function* () {
             const apiError = new Error('Failed to start next stage');
             mockNextStage.nextStage.mockRejectedValue(apiError);

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

@@ -3,5 +3,4 @@ export interface CreateMigrationOptions extends CommonCommandOptions, Pick<Asset
 }
 export interface CreateMigrationApiResponse {
     assetMigration: AssetMigration;
-    uploadUrl: string;
 }

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

@@ -28,5 +28,4 @@ export declare function buildMigrationUrl(tenantID?: string, overrideUrl?: strin
  */
 export declare function validateAxiosStatus(status: number): boolean;
 export declare function getMigrationHeaders(tenantID?: string, isJson?: boolean): Promise<Record<string, string>>;
-export declare function uploadFileToS3(uploadUrl: string, filePath: string, tenantID?: string): Promise<string>;
 export declare function redactKey(key: string, visibleChars?: number): string;

package/lib/migration/utils/common.js

@@ -12,8 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.redactKey = exports.uploadFileToS3 = exports.getMigrationHeaders = exports.validateAxiosStatus = exports.buildMigrationUrl = exports.throwErrorIfNotLoggedIn = exports.handleCommandError = void 0;
-const fs_1 = __importDefault(require("fs"));
+exports.redactKey = exports.getMigrationHeaders = exports.validateAxiosStatus = exports.buildMigrationUrl = exports.throwErrorIfNotLoggedIn = exports.handleCommandError = void 0;
 const chalk_1 = __importDefault(require("chalk"));
 const ApplicationConfig_1 = require("../../ApplicationConfig");
 const axios_1 = __importDefault(require("axios"));
@@ -105,18 +104,6 @@ function getMigrationHeaders(tenantID, isJson = true) {
     });
 }
 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: yield getMigrationHeaders(tenantID, false),
-        });
-        return response.url;
-    });
-}
-exports.uploadFileToS3 = uploadFileToS3;
 function redactKey(key, visibleChars = 3) {
     if (!key)
         return '';

package/lib/migration/utils/common.spec.js

@@ -155,37 +155,6 @@ describe('Migration Utils', () => {
             expect(mockFetchApplicationConfig).toHaveBeenCalledWith('tenant-id');
         }));
     });
-    describe('uploadFileToS3', () => {
-        beforeEach(() => {
-            mockFs.readFileSync.mockReturnValue(Buffer.from('file content'));
-            mockFetchApplicationConfig.mockResolvedValue({
-                tenant: 'test-tenant',
-                baseUrl: 'https://example.com',
-                region: 'au',
-            });
-        });
-        it('uploads file successfully', () => __awaiter(void 0, void 0, void 0, function* () {
-            const mockResponse = {
-                url: 'https://s3.amazonaws.com/uploaded-file',
-            };
-            mockFetch.mockResolvedValue(mockResponse);
-            const result = yield (0, _1.uploadFileToS3)('https://upload.url', '/path/to/file.tar.gz', 'tenant-id');
-            expect(result).toBe('https://s3.amazonaws.com/uploaded-file');
-            expect(mockFetch).toHaveBeenCalledWith('https://upload.url', {
-                method: 'PUT',
-                body: Buffer.from('file content'),
-                headers: {
-                    'x-dxp-tenant': 'test-tenant',
-                },
-            });
-        }));
-        it('handles file read error', () => __awaiter(void 0, void 0, void 0, function* () {
-            mockFs.readFileSync.mockImplementation(() => {
-                throw new Error('File not found');
-            });
-            yield expect((0, _1.uploadFileToS3)('https://upload.url', '/nonexistent/file.tar.gz')).rejects.toThrow('File not found');
-        }));
-    });
     describe('redactKey', () => {
         it('redacts key correctly', () => {
             expect((0, _1.redactKey)('1234567890', 3)).toBe('*******890');

package/lib/migration/utils/createMigration.js

@@ -37,19 +37,15 @@ function createMigration(options) {
                 throw new Error(`Migration creation failed with status: ${response.status}`);
             }
             // Validate response structure
-            const { assetMigration, uploadUrl } = response.data || {};
+            const { assetMigration } = 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) {

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

@@ -161,7 +161,6 @@ describe('createMigration', () => {
                             updated: 1234567890,
                             migrationIdAssetId: 'migration-123-asset-123',
                         },
-                        uploadUrl: 'https://upload.s3.amazonaws.com',
                     },
                 };
                 mockApiServiceInstance.client.post.mockResolvedValue(mockResponse);
@@ -195,27 +194,11 @@ describe('createMigration', () => {
                             stage: 'pending',
                             status: 'created',
                         },
-                        uploadUrl: 'https://upload.s3.amazonaws.com',
                     },
                 };
                 mockApiServiceInstance.client.post.mockResolvedValue(mockResponse);
                 yield expect((0, _1.createMigration)(mockOptions)).rejects.toThrow('Invalid response format from migration service');
             }));
-            it('handles missing upload URL', () => __awaiter(void 0, void 0, void 0, function* () {
-                const mockResponse = {
-                    status: 200,
-                    data: {
-                        assetMigration: {
-                            migrationId: 'migration-123',
-                            assetId: 'asset-123',
-                            stage: 'pending',
-                            status: 'created',
-                        },
-                    },
-                };
-                mockApiServiceInstance.client.post.mockResolvedValue(mockResponse);
-                yield expect((0, _1.createMigration)(mockOptions)).rejects.toThrow('Upload URL not found in response');
-            }));
             it('handles API service errors', () => __awaiter(void 0, void 0, void 0, function* () {
                 const error = new Error('Network error');
                 mockApiServiceInstance.client.post.mockRejectedValue(error);

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

@@ -6,3 +6,4 @@ export * from './nextStage';
 export * from './setMigrationSettings';
 export * from './revertMigration';
 export * from './loadStageOptionsFromFile';
+export * from './promptForMorphConfirmation';

package/lib/migration/utils/index.js

@@ -22,3 +22,4 @@ __exportStar(require("./nextStage"), exports);
 __exportStar(require("./setMigrationSettings"), exports);
 __exportStar(require("./revertMigration"), exports);
 __exportStar(require("./loadStageOptionsFromFile"), exports);
+__exportStar(require("./promptForMorphConfirmation"), exports);

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

@@ -0,0 +1,5 @@
+/**
+ * Prompts the user for confirmation when about to trigger morph stages.
+ * Returns true if user has chosen to confirm.
+ */
+export declare function promptForMorphConfirmation(stage: string, status: string, assetId: string): Promise<boolean>;

package/lib/migration/utils/promptForMorphConfirmation.js

@@ -0,0 +1,55 @@
+"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.promptForMorphConfirmation = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const inquirer_1 = __importDefault(require("inquirer"));
+/**
+ * Prompts the user for confirmation when about to trigger morph stages.
+ * Returns true if user has chosen to confirm.
+ */
+function promptForMorphConfirmation(stage, status, assetId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let message;
+        let abortMessage;
+        if (stage === 'preview' && status === 'complete') {
+            message = `You are about to morph the live asset (${assetId}). Do you wish to continue? [y/N]`;
+            abortMessage = 'Morph stage not run';
+        }
+        else if (stage === 'morph' && status === 'awaiting-confirmation') {
+            message = `You are about to permanently delete the standard page bodycopies for asset ${assetId}, please ensure that the client has confirmed the live asset is functioning as expected. This can NOT be undone. Do you wish to continue? [y/N]`;
+            abortMessage = 'Morph cleanup not run';
+        }
+        else {
+            return true;
+        }
+        const choice = yield inquirer_1.default.prompt([
+            {
+                type: 'list',
+                name: 'confirm',
+                message,
+                choices: [
+                    { name: 'No', value: false },
+                    { name: 'Yes', value: true },
+                ],
+                default: false, // Default answer is No
+            },
+        ]);
+        if (!choice.confirm) {
+            console.log(chalk_1.default.yellow(abortMessage));
+        }
+        return choice.confirm;
+    });
+}
+exports.promptForMorphConfirmation = promptForMorphConfirmation;

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

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

package/lib/migration/utils/promptForMorphConfirmation.spec.js

@@ -0,0 +1,101 @@
+"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 promptForMorphConfirmation_1 = require("./promptForMorphConfirmation");
+const chalk_1 = __importDefault(require("chalk"));
+jest.mock('inquirer', () => ({
+    prompt: jest.fn(),
+}));
+const mockConsoleLog = jest.spyOn(console, 'log').mockImplementation();
+const mockPrompt = require('inquirer').prompt;
+describe('promptForMorphConfirmation', () => {
+    beforeEach(() => {
+        jest.clearAllMocks();
+    });
+    afterAll(() => {
+        mockConsoleLog.mockRestore();
+    });
+    describe('Preview to Morph stage', () => {
+        it('should prompt for confirmation when stage is preview and status is complete', () => __awaiter(void 0, void 0, void 0, function* () {
+            mockPrompt.mockResolvedValue({ confirm: true });
+            const result = yield (0, promptForMorphConfirmation_1.promptForMorphConfirmation)('preview', 'complete', 'asset123');
+            expect(mockPrompt).toHaveBeenCalledWith([
+                {
+                    type: 'list',
+                    name: 'confirm',
+                    message: 'You are about to morph the live asset (asset123). Do you wish to continue? [y/N]',
+                    choices: [
+                        { name: 'No', value: false },
+                        { name: 'Yes', value: true },
+                    ],
+                    default: false,
+                },
+            ]);
+            expect(result).toBe(true);
+            expect(mockConsoleLog).not.toHaveBeenCalled();
+        }));
+        it('should return false and show abort message when user selects No for preview stage', () => __awaiter(void 0, void 0, void 0, function* () {
+            mockPrompt.mockResolvedValue({ confirm: false });
+            const result = yield (0, promptForMorphConfirmation_1.promptForMorphConfirmation)('preview', 'complete', 'asset456');
+            expect(result).toBe(false);
+            expect(mockConsoleLog).toHaveBeenCalledWith(chalk_1.default.yellow('Morph stage not run'));
+        }));
+    });
+    describe('Morph Cleanup stage', () => {
+        it('should prompt for confirmation when stage is morph and status is awaiting-confirmation', () => __awaiter(void 0, void 0, void 0, function* () {
+            mockPrompt.mockResolvedValue({ confirm: true });
+            const result = yield (0, promptForMorphConfirmation_1.promptForMorphConfirmation)('morph', 'awaiting-confirmation', 'asset789');
+            expect(mockPrompt).toHaveBeenCalledWith([
+                {
+                    type: 'list',
+                    name: 'confirm',
+                    message: 'You are about to permanently delete the standard page bodycopies for asset asset789, please ensure that the client has confirmed the live asset is functioning as expected. This can NOT be undone. Do you wish to continue? [y/N]',
+                    choices: [
+                        { name: 'No', value: false },
+                        { name: 'Yes', value: true },
+                    ],
+                    default: false,
+                },
+            ]);
+            expect(result).toBe(true);
+            expect(mockConsoleLog).not.toHaveBeenCalled();
+        }));
+        it('should return false and show abort message when user selects No for morph cleanup stage', () => __awaiter(void 0, void 0, void 0, function* () {
+            mockPrompt.mockResolvedValue({ confirm: false });
+            const result = yield (0, promptForMorphConfirmation_1.promptForMorphConfirmation)('morph', 'awaiting-confirmation', 'asset999');
+            expect(result).toBe(false);
+            expect(mockConsoleLog).toHaveBeenCalledWith(chalk_1.default.yellow('Morph cleanup not run'));
+        }));
+    });
+    describe('Other stages', () => {
+        it('should return true without prompting for preview stage with non-complete status', () => __awaiter(void 0, void 0, void 0, function* () {
+            const result = yield (0, promptForMorphConfirmation_1.promptForMorphConfirmation)('preview', 'running', 'asset123');
+            expect(result).toBe(true);
+            expect(mockPrompt).not.toHaveBeenCalled();
+            expect(mockConsoleLog).not.toHaveBeenCalled();
+        }));
+        it('should return true without prompting for other stages', () => __awaiter(void 0, void 0, void 0, function* () {
+            const result = yield (0, promptForMorphConfirmation_1.promptForMorphConfirmation)('export-to-json', 'complete', 'asset123');
+            expect(result).toBe(true);
+            expect(mockPrompt).not.toHaveBeenCalled();
+            expect(mockConsoleLog).not.toHaveBeenCalled();
+        }));
+        it('should return true without prompting for unknown stage and status combinations', () => __awaiter(void 0, void 0, void 0, function* () {
+            const result = yield (0, promptForMorphConfirmation_1.promptForMorphConfirmation)('unknown', 'unknown-status', 'asset123');
+            expect(result).toBe(true);
+            expect(mockPrompt).not.toHaveBeenCalled();
+            expect(mockConsoleLog).not.toHaveBeenCalled();
+        }));
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dxp-cli-next",
-  "version": "5.28.0",
+  "version": "5.29.0",
   "repository": {
     "url": "https://gitlab.squiz.net/dxp/dxp-cli-next"
   },