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

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

@@ -0,0 +1,156 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ApiService_1 = require("../../ApiService");
+const setMigrationSettings_1 = require("./setMigrationSettings");
+const _1 = require(".");
+// Mock dependencies
+jest.mock('../../ApiService');
+jest.mock('../../ApplicationConfig');
+jest.mock('.', () => ({
+    buildMigrationUrl: jest.fn(),
+    getMigrationHeaders: jest.fn(),
+    redactKey: jest.fn(),
+}));
+jest.mock('path');
+jest.mock('child_process');
+jest.mock('axios');
+jest.mock('../../ApplicationConfig');
+jest.mock('../../ApiService');
+// Mock global fetch
+const mockFetch = jest.fn();
+global.fetch = mockFetch;
+const mockApiService = ApiService_1.ApiService;
+const mockBuildMigrationUrl = _1.buildMigrationUrl;
+const mockGetMigrationHeaders = _1.getMigrationHeaders;
+const mockRedactKey = _1.redactKey;
+describe('setMigrationSettings', () => {
+    let mockApiServiceInstance;
+    let mockOptions;
+    beforeEach(() => {
+        jest.clearAllMocks();
+        mockApiServiceInstance = {
+            client: {
+                post: jest.fn(),
+            },
+        };
+        mockApiService.mockImplementation(() => mockApiServiceInstance);
+        mockOptions = {
+            tenant: 'test-tenant',
+            matrixUrl: 'https://matrix.example.com',
+            matrixIdentifier: 'test-identifier',
+            matrixKey: 'test-key-123',
+        };
+        mockBuildMigrationUrl.mockResolvedValue('https://migration.example.com');
+        mockGetMigrationHeaders.mockResolvedValue({
+            'Content-Type': 'application/json',
+            'x-dxp-tenant': 'test-tenant',
+        });
+        mockRedactKey.mockImplementation(key => `***${key.slice(-3)}`);
+    });
+    it('should set migration settings successfully', () => __awaiter(void 0, void 0, void 0, function* () {
+        const mockResponse = {
+            status: 200,
+            data: {
+                matrixUrl: 'https://matrix.example.com',
+                matrixIdentifier: 'test-identifier',
+                matrixKey: 'test-key-123',
+            },
+        };
+        mockApiServiceInstance.client.post.mockResolvedValue(mockResponse);
+        const result = yield (0, setMigrationSettings_1.setMigrationSettings)(mockOptions);
+        expect(result).toEqual({
+            matrixUrl: 'https://matrix.example.com',
+            matrixIdentifier: 'test-identifier',
+            matrixKey: '***123',
+        });
+        expect(mockBuildMigrationUrl).toHaveBeenCalledWith('test-tenant', undefined, 'settings');
+        expect(mockGetMigrationHeaders).toHaveBeenCalledWith('test-tenant');
+        expect(mockApiServiceInstance.client.post).toHaveBeenCalledWith('https://migration.example.com', {
+            matrixUrl: 'https://matrix.example.com',
+            matrixIdentifier: 'test-identifier',
+            matrixKey: 'test-key-123',
+        }, {
+            headers: {
+                'Content-Type': 'application/json',
+                'x-dxp-tenant': 'test-tenant',
+            },
+        });
+    }));
+    it('should handle override URL when provided', () => __awaiter(void 0, void 0, void 0, function* () {
+        const optionsWithOverride = Object.assign(Object.assign({}, mockOptions), { overrideUrl: 'https://custom.migration.url' });
+        mockBuildMigrationUrl.mockResolvedValue('https://custom.migration.url');
+        const mockResponse = {
+            status: 201,
+            data: {
+                matrixUrl: 'https://matrix.example.com',
+                matrixIdentifier: 'test-identifier',
+                matrixKey: 'test-key-123',
+            },
+        };
+        mockApiServiceInstance.client.post.mockResolvedValue(mockResponse);
+        yield (0, setMigrationSettings_1.setMigrationSettings)(optionsWithOverride);
+        expect(mockBuildMigrationUrl).toHaveBeenCalledWith('test-tenant', 'https://custom.migration.url', 'settings');
+    }));
+    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, setMigrationSettings_1.setMigrationSettings)(mockOptions)).rejects.toThrow('Migration settings update failed with status: 400');
+    }));
+    it('should handle missing response data', () => __awaiter(void 0, void 0, void 0, function* () {
+        const mockResponse = {
+            status: 200,
+            data: null,
+        };
+        mockApiServiceInstance.client.post.mockResolvedValue(mockResponse);
+        yield expect((0, setMigrationSettings_1.setMigrationSettings)(mockOptions)).rejects.toThrow('No data returned from migration service');
+    }));
+    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, setMigrationSettings_1.setMigrationSettings)(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, setMigrationSettings_1.setMigrationSettings)(mockOptions)).rejects.toThrow('Failed to set migration settings: Unknown error');
+    }));
+    it('should redact matrix key in response', () => __awaiter(void 0, void 0, void 0, function* () {
+        const mockResponse = {
+            status: 200,
+            data: {
+                matrixUrl: 'https://matrix.example.com',
+                matrixIdentifier: 'test-identifier',
+                matrixKey: 'test-key-123',
+            },
+        };
+        mockApiServiceInstance.client.post.mockResolvedValue(mockResponse);
+        mockRedactKey.mockReturnValue('***123');
+        const result = yield (0, setMigrationSettings_1.setMigrationSettings)(mockOptions);
+        expect(result.matrixKey).toBe('***123');
+        expect(mockRedactKey).toHaveBeenCalledWith('test-key-123', 3);
+    }));
+    it('should handle missing matrix key in response', () => __awaiter(void 0, void 0, void 0, function* () {
+        const mockResponse = {
+            status: 200,
+            data: {
+                matrixUrl: 'https://matrix.example.com',
+                matrixIdentifier: 'test-identifier',
+            },
+        };
+        mockApiServiceInstance.client.post.mockResolvedValue(mockResponse);
+        const result = yield (0, setMigrationSettings_1.setMigrationSettings)(mockOptions);
+        expect(result.matrixKey).toBe('');
+        expect(mockRedactKey).not.toHaveBeenCalled();
+    }));
+});

package/package.json

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

package/lib/migration/types.d.ts

@@ -1,54 +0,0 @@
-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;
-}
-export interface RevertMigrationOptions extends GetMigrationOptions {
-}
-export interface RevertMigrationAPIResponse {
-    message: 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,15 +0,0 @@
-import { Command } from 'commander';
-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>;
-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 revertMigration(options: RevertMigrationOptions): Promise<RevertMigrationAPIResponse>;
-export declare function setMigrationSetting(options: SetMigrationSettingOptions): Promise<SetMigrationSettingAPIResponse>;

package/lib/migration/utils.js

@@ -1,298 +0,0 @@
-"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.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"));
-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 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)) {
-        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;
-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({
-            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;