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

package/lib/migration/get/getMigration.js

@@ -36,6 +36,7 @@ const getMigrationCommand = () => {
             spinner.succeed(`Migration details: ${JSON.stringify(response, null, 2)}`);
         }
         catch (error) {
+            spinner.fail();
             (0, utils_1.handleCommandError)(getCommand, error);
         }
     }));

package/lib/migration/index.js

@@ -6,9 +6,11 @@ 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 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, getMigration_1.default)())
+    .addCommand((0, setMigrationSettings_1.default)());
 exports.default = migrationCommand;

package/lib/migration/settings/setMigrationSettings.d.ts

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

package/lib/migration/settings/setMigrationSettings.js

@@ -0,0 +1,49 @@
+"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 setMigrationSettingsCommand = () => {
+    const settingsCommand = new commander_1.Command('settings')
+        .name('settings')
+        .description('Set settings for the migration service')
+        .addOption(new commander_1.Option('--matrix-url <string>', 'The URL of the Matrix instance').makeOptionMandatory())
+        .addOption(new commander_1.Option('--matrix-identifier <string>', 'The component service identifier used by the asset and components being migrated').makeOptionMandatory())
+        .addOption(new commander_1.Option('--matrix-key <string>', 'The Asset Management API key for the Migrator API to interact with Matrix API').makeOptionMandatory())
+        .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)('Setting migration configuration...').start();
+        yield (0, utils_1.throwErrorIfNotLoggedIn)(settingsCommand);
+        try {
+            const response = yield (0, utils_1.setMigrationSetting)(options);
+            spinner.succeed(`Migration settings updated: ${JSON.stringify(response, null, 2)}`);
+        }
+        catch (error) {
+            spinner.fail();
+            (0, utils_1.handleCommandError)(settingsCommand, error);
+        }
+    }));
+    if (process.env.ENABLE_OVERRIDE_MIGRATION_URL === 'true') {
+        settingsCommand.addOption(new commander_1.Option('-ou, --overrideUrl <string>', 'Developer option to override the entire migration url with a custom value'));
+    }
+    return settingsCommand;
+};
+exports.default = setMigrationSettingsCommand;

package/lib/migration/settings/setMigrationSettings.spec.d.ts

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

package/lib/migration/settings/setMigrationSettings.spec.js

@@ -0,0 +1,275 @@
+"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 setMigrationSettings_1 = __importDefault(require("./setMigrationSettings"));
+const utils = __importStar(require("../utils"));
+const ApplicationStore = __importStar(require("../../ApplicationStore"));
+jest.mock('../utils');
+jest.mock('../../ApplicationStore');
+const mockUtils = utils;
+const mockApplicationStore = ApplicationStore;
+describe('setMigrationSettingsCommand', () => {
+    let logSpy;
+    let mockSetMigrationSettingResponse;
+    beforeEach(() => {
+        nock_1.default.cleanAll();
+        jest.clearAllMocks();
+        jest.resetAllMocks();
+        logSpy = jest.spyOn(console, 'log').mockImplementation(() => { });
+        mockApplicationStore.getApplicationFile.mockResolvedValue('session-cookie');
+        mockUtils.throwErrorIfNotLoggedIn.mockResolvedValue(undefined);
+        mockSetMigrationSettingResponse = {
+            matrixUrl: 'https://matrix.example.com',
+            matrixIdentifier: '@user:matrix.example.com',
+            matrixKey: '***********123',
+        };
+        mockUtils.setMigrationSetting.mockResolvedValue(mockSetMigrationSettingResponse);
+    });
+    afterEach(() => {
+        logSpy.mockRestore();
+    });
+    describe('successful migration setting update', () => {
+        it('should set migration settings successfully with required options', () => __awaiter(void 0, void 0, void 0, function* () {
+            const program = (0, setMigrationSettings_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                'migration',
+                'settings',
+                '--matrix-url',
+                'https://matrix.example.com',
+                '--matrix-identifier',
+                '@user:matrix.example.com',
+                '--matrix-key',
+                'secret-key-123',
+            ]);
+            expect(mockUtils.throwErrorIfNotLoggedIn).toHaveBeenCalledWith(program);
+            expect(mockUtils.setMigrationSetting).toHaveBeenCalledWith({
+                matrixUrl: 'https://matrix.example.com',
+                matrixIdentifier: '@user:matrix.example.com',
+                matrixKey: 'secret-key-123',
+            });
+            expect(mockUtils.setMigrationSetting).toHaveBeenCalledTimes(1);
+            expect(mockUtils.handleCommandError).not.toHaveBeenCalled();
+        }));
+        it('should set migration settings with tenant option', () => __awaiter(void 0, void 0, void 0, function* () {
+            const program = (0, setMigrationSettings_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                'migration',
+                'settings',
+                '--matrix-url',
+                'https://matrix.example.com',
+                '--matrix-identifier',
+                '@user:matrix.example.com',
+                '--matrix-key',
+                'secret-key-123',
+                '--tenant',
+                'test-tenant',
+            ]);
+            expect(mockUtils.setMigrationSetting).toHaveBeenCalledWith({
+                matrixUrl: 'https://matrix.example.com',
+                matrixIdentifier: '@user:matrix.example.com',
+                matrixKey: 'secret-key-123',
+                tenant: 'test-tenant',
+            });
+        }));
+        it('should set migration settings 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, setMigrationSettings_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                'migration',
+                'settings',
+                '--matrix-url',
+                'https://matrix.example.com',
+                '--matrix-identifier',
+                '@user:matrix.example.com',
+                '--matrix-key',
+                'secret-key-123',
+                '--overrideUrl',
+                'https://custom.migration.url',
+            ]);
+            expect(mockUtils.setMigrationSetting).toHaveBeenCalledWith({
+                matrixUrl: 'https://matrix.example.com',
+                matrixIdentifier: '@user:matrix.example.com',
+                matrixKey: 'secret-key-123',
+                overrideUrl: 'https://custom.migration.url',
+            });
+            process.env.ENABLE_OVERRIDE_MIGRATION_URL = originalEnv;
+        }));
+    });
+    describe('error scenarios', () => {
+        it('should handle setMigrationSetting API error', () => __awaiter(void 0, void 0, void 0, function* () {
+            const apiError = new Error('Settings update failed');
+            mockUtils.setMigrationSetting.mockRejectedValue(apiError);
+            mockUtils.handleCommandError.mockImplementation(() => { });
+            const program = (0, setMigrationSettings_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                'migration',
+                'settings',
+                '--matrix-url',
+                'https://matrix.example.com',
+                '--matrix-identifier',
+                '@user:matrix.example.com',
+                '--matrix-key',
+                'secret-key-123',
+            ]);
+            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.setMigrationSetting.mockRejectedValue(networkError);
+            mockUtils.handleCommandError.mockImplementation(() => { });
+            const program = (0, setMigrationSettings_1.default)();
+            yield program.parseAsync([
+                'node',
+                'dxp-cli',
+                'migration',
+                'settings',
+                '--matrix-url',
+                'https://matrix.example.com',
+                '--matrix-identifier',
+                '@user:matrix.example.com',
+                '--matrix-key',
+                'secret-key-123',
+            ]);
+            expect(mockUtils.handleCommandError).toHaveBeenCalledWith(program, networkError);
+        }));
+    });
+    describe('required options validation', () => {
+        it('should require matrixUrl option', () => {
+            const program = (0, setMigrationSettings_1.default)().exitOverride();
+            expect(() => {
+                program.parse([
+                    'node',
+                    'dxp-cli',
+                    'migration',
+                    'settings',
+                    '--matrix-identifier',
+                    '@user:matrix.example.com',
+                    '--matrix-key',
+                    'secret-key-123',
+                ]);
+            }).toThrow();
+        });
+        it('should require matrixIdentifier option', () => {
+            const program = (0, setMigrationSettings_1.default)().exitOverride();
+            expect(() => {
+                program.parse([
+                    'node',
+                    'dxp-cli',
+                    'migration',
+                    'settings',
+                    '--matrix-url',
+                    'https://matrix.example.com',
+                    '--matrix-key',
+                    'secret-key-123',
+                ]);
+            }).toThrow();
+        });
+        it('should require matrixKey option', () => {
+            const program = (0, setMigrationSettings_1.default)().exitOverride();
+            expect(() => {
+                program.parse([
+                    'node',
+                    'dxp-cli',
+                    'migration',
+                    'settings',
+                    '--matrix-url',
+                    'https://matrix.example.com',
+                    '--matrix-identifier',
+                    '@user:matrix.example.com',
+                ]);
+            }).toThrow();
+        });
+    });
+    describe('command configuration', () => {
+        it('should have correct command name and description', () => {
+            const program = (0, setMigrationSettings_1.default)();
+            expect(program.name()).toBe('settings');
+            expect(program.description()).toBe('Set settings for the migration service');
+        });
+        it('should parse options correctly', () => {
+            const program = (0, setMigrationSettings_1.default)();
+            program.parse([
+                'node',
+                'dxp-cli',
+                'migration',
+                'settings',
+                '--matrix-url',
+                'https://matrix.example.com',
+                '--matrix-identifier',
+                '@user:matrix.example.com',
+                '--matrix-key',
+                'secret-key-123',
+                '--tenant',
+                'test-tenant',
+            ]);
+            const opts = program.opts();
+            expect(opts.matrixUrl).toBe('https://matrix.example.com');
+            expect(opts.matrixIdentifier).toBe('@user:matrix.example.com');
+            expect(opts.matrixKey).toBe('secret-key-123');
+            expect(opts.tenant).toBe('test-tenant');
+        });
+        it('should parse options with kebab-case to camelCase conversion', () => {
+            const program = (0, setMigrationSettings_1.default)();
+            program.parse([
+                'node',
+                'dxp-cli',
+                'migration',
+                'settings',
+                '--matrix-url',
+                'https://matrix.example.com',
+                '--matrix-identifier',
+                '@user:matrix.example.com',
+                '--matrix-key',
+                'secret-key-123',
+            ]);
+            const opts = program.opts();
+            expect(opts.matrixUrl).toBe('https://matrix.example.com');
+            expect(opts.matrixIdentifier).toBe('@user:matrix.example.com');
+            expect(opts.matrixKey).toBe('secret-key-123');
+        });
+    });
+});

package/lib/migration/types.d.ts

@@ -35,3 +35,15 @@ export interface GetMigrationAPIResponse {
     previewPageAssetId?: string;
     componentsTarDownloadUrl?: string;
 }
+export interface SetMigrationSettingOptions {
+    matrixUrl: string;
+    matrixIdentifier: string;
+    matrixKey: string;
+    tenant?: string;
+    overrideUrl?: string;
+}
+export interface SetMigrationSettingAPIResponse {
+    matrixUrl: string;
+    matrixIdentifier: string;
+    matrixKey: string;
+}

package/lib/migration/utils.d.ts

@@ -1,12 +1,14 @@
 import { Command } from 'commander';
-import { CreateMigrationOptions, CreateMigrationAPIResponse, GetMigrationOptions, GetMigrationAPIResponse } from './types';
+import { CreateMigrationOptions, CreateMigrationAPIResponse, GetMigrationOptions, GetMigrationAPIResponse, 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>;
 export declare function validateAxiosStatus(status: number): boolean;
+export declare function redactKey(key: string, visibleChars?: number): string;
 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>;
+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.getMigration = exports.createMigration = exports.uploadFileToS3 = exports.getMigrationHeaders = exports.createTarFile = exports.validateExportFolder = exports.validateAxiosStatus = exports.buildMigrationUrl = exports.throwErrorIfNotLoggedIn = exports.handleCommandError = void 0;
+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;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const chalk_1 = __importDefault(require("chalk"));
@@ -70,6 +70,16 @@ function validateAxiosStatus(status) {
     return status < 400;
 }
 exports.validateAxiosStatus = validateAxiosStatus;
+function redactKey(key, visibleChars = 3) {
+    if (!key)
+        return '';
+    const len = key.length;
+    if (len <= visibleChars)
+        return '*'.repeat(len);
+    const masked = '*'.repeat(len - visibleChars);
+    return masked + key.slice(-visibleChars);
+}
+exports.redactKey = redactKey;
 function validateExportFolder(exportPath) {
     // Check if the export folder exists
     if (!fs_1.default.existsSync(exportPath)) {
@@ -223,3 +233,42 @@ function getMigration(options) {
     });
 }
 exports.getMigration = getMigration;
+function setMigrationSetting(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 = {
+                matrixUrl: options.matrixUrl,
+                matrixIdentifier: options.matrixIdentifier,
+                matrixKey: options.matrixKey,
+            };
+            const response = yield apiService.client.post(`${migrationUrl}/settings`, payload, {
+                headers: Object.assign({ 'Content-Type': 'application/json' }, (yield getMigrationHeaders(options.tenant))),
+            });
+            if (response.status !== 200 && response.status !== 201) {
+                throw new Error(`Migration settings update failed with status: ${response.status}`);
+            }
+            if (!(response === null || response === void 0 ? void 0 : response.data)) {
+                throw new Error('No data returned from migration service');
+            }
+            const responseData = {
+                matrixUrl: response.data.matrixUrl,
+                matrixIdentifier: response.data.matrixIdentifier,
+                matrixKey: response.data.matrixKey
+                    ? redactKey(response.data.matrixKey, 3)
+                    : '',
+            };
+            return responseData;
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                throw error;
+            }
+            throw new Error(`Failed to set migration settings: ${error}`);
+        }
+    });
+}
+exports.setMigrationSetting = setMigrationSetting;

package/lib/migration/utils.spec.js

@@ -145,6 +145,13 @@ describe('Migration Utils', () => {
             expect((0, utils_1.validateAxiosStatus)(500)).toBe(false);
         });
     });
+    describe('redactKey', () => {
+        it('redacts key correctly', () => {
+            expect((0, utils_1.redactKey)('1234567890', 3)).toBe('*******890');
+            expect((0, utils_1.redactKey)('1234567890', 1)).toBe('*********0');
+            expect((0, utils_1.redactKey)('1234567890', 10)).toBe('**********');
+        });
+    });
     describe('validateExportFolder', () => {
         beforeEach(() => {
             mockPath.join.mockImplementation((...paths) => paths.join('/'));

package/package.json

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