@squiz/dxp-cli-next 5.29.1 → 5.30.0-develop.2

package/lib/page/layouts/deploy/deploy.js

@@ -35,7 +35,7 @@ const createDeployCommand = () => {
         .addOption(new commander_1.Option('-t, --tenant <string>', 'Tenant ID to deploy to. If not provided will use configured tenant from login').env('SQUIZ_DXP_TENANT_ID'))
         .addOption(new commander_1.Option('--dry-run', 'Run all pre-deployment processes without deploying').default(false))
         .action((options) => __awaiter(void 0, void 0, void 0, function* () {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e;
         if (options.contentServiceUrl) {
             console.log(`NOTICE: CONTENT_SERVICE_URL is set and will deploy to ${options.contentServiceUrl}`);
         }
@@ -51,9 +51,17 @@ const createDeployCommand = () => {
         try {
             const layout = yield (0, definitions_1.loadLayoutDefinition)(layoutFile);
             if (layout !== undefined) {
+                // Pre-deployment validation: check zones match between YAML and template
+                const zoneValidationError = validateZoneConsistency(layout);
+                if (zoneValidationError) {
+                    throw new Error(zoneValidationError);
+                }
                 const response = yield uploadLayout(apiService.client, layout, contentServiceUrl, options.dryRun);
                 if (!options.dryRun) {
                     exports.logger.info(`Layout "${layout.name}" version ${response.data.version} deployed successfully.`);
+                    // Log the deployed layout URL (clickable)
+                    const layoutUrl = `${baseUrl}/organization/${(_e = options.tenant) !== null && _e !== void 0 ? _e : maybeConfig === null || maybeConfig === void 0 ? void 0 : maybeConfig.tenant}/component-service/all-layouts/${encodeURIComponent(layout.name)}`;
+                    exports.logger.info(`Deployed layout URL: \u001b]8;;${layoutUrl}\u001b\\${layoutUrl}\u001b]8;;\u001b\\`);
                 }
                 else {
                     exports.logger.info(`Layout "${layout.name}" dry run successful.`);
@@ -82,6 +90,7 @@ const createDeployCommand = () => {
 };
 exports.default = createDeployCommand;
 function uploadLayout(client, layout, contentServiceUrl, dryRun) {
+    var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
         try {
             const queryParam = dryRun ? '?_dryRun=true' : '';
@@ -91,7 +100,11 @@ function uploadLayout(client, layout, contentServiceUrl, dryRun) {
             if (response.status === 200) {
                 return response;
             }
-            throw new Error(response.data.message);
+            const error = new Error(response.data.message);
+            if ((_b = (_a = response.data.details) === null || _a === void 0 ? void 0 : _a.input) === null || _b === void 0 ? void 0 : _b.message) {
+                error.message += `: ${response.data.details.input.message}`;
+            }
+            throw error;
         }
         catch (error) {
             throw error;
@@ -106,3 +119,48 @@ function maybeGetApplicationConfig() {
         catch (_a) { }
     });
 }
+/**
+ * Validates that zones defined in YAML match zones used in the Handlebars template
+ * @param layout The layout definition containing zones and template
+ * @returns Error message if validation fails, null if validation passes
+ */
+function validateZoneConsistency(layout) {
+    const yamlZones = Object.keys(layout.zones || {});
+    const template = layout.template;
+    // If no template is provided, skip validation
+    if (!template) {
+        return null;
+    }
+    // Extract zone references from Handlebars template
+    // Look for patterns like {{#each zones.zoneName}}, {{zones.zoneName}}, {{#if zones.zoneName}}
+    const zonePattern = /\{\{(?:#(?:each|if)\s+)?zones\.(\w+)/g;
+    const templateZones = new Set();
+    let match;
+    // Loop through the template and extract the zone names
+    while ((match = zonePattern.exec(template)) !== null) {
+        templateZones.add(match[1]);
+    }
+    // Convert the set to an array
+    const templateZoneArray = Array.from(templateZones);
+    // Find zones defined in YAML but not used in template
+    const unusedYamlZones = yamlZones.filter(zone => !templateZones.has(zone));
+    // Find zones used in template but not defined in YAML
+    const undefinedTemplateZones = templateZoneArray.filter(zone => !yamlZones.includes(zone));
+    // Create an array of errors
+    const errors = [];
+    // Add the unused zones to the errors
+    if (unusedYamlZones.length > 0) {
+        errors.push(`Zones defined in YAML but not used in template: ${unusedYamlZones.join(', ')}`);
+    }
+    // Add the undefined zones to the errors
+    if (undefinedTemplateZones.length > 0) {
+        errors.push(`Zones used in template but not defined in YAML: ${undefinedTemplateZones.join(', ')}`);
+    }
+    // If there are errors, return the errors
+    if (errors.length > 0) {
+        return `Zone consistency validation failed:\n${errors
+            .map(err => `  - ${err}`)
+            .join('\n')}`;
+    }
+    return null;
+}

package/lib/page/layouts/deploy/deploy.spec.js

@@ -92,8 +92,14 @@ describe('deployCommand', () => {
     it('deploys a layout successfully', () => __awaiter(void 0, void 0, void 0, function* () {
         const file = './src/__tests__/layouts/page-layout.yaml';
         const dxpBaseUrl = 'http://dxp-base-url.com';
-        const mockLayout = { name: 'Test Layout' };
-        const mockResponse = { name: 'Test Layout', version: '12345' };
+        const mockLayout = {
+            name: 'test-layout',
+            zones: {
+                content: { displayName: 'Content', description: 'Main content' },
+            },
+            template: '<div>{{zones.content}}</div>',
+        };
+        const mockResponse = { name: 'test-layout', version: '12345' };
         definitions_1.loadLayoutDefinition.mockResolvedValue(mockLayout);
         (0, nock_1.default)(dxpBaseUrl + '/__dxp/service/components-content')
             .post('/page-layout', mockLayout)
@@ -101,14 +107,21 @@ describe('deployCommand', () => {
         const program = (0, deploy_1.default)();
         yield program.parseAsync(createMockArgs({ config: file, dxpBaseUrl }));
         expect(mockLoggerInfoFn).toHaveBeenNthCalledWith(1, `Loading layout data from the file ${file}`);
-        expect(mockLoggerInfoFn).toHaveBeenNthCalledWith(2, 'Layout "Test Layout" version 12345 deployed successfully.');
+        expect(mockLoggerInfoFn).toHaveBeenNthCalledWith(2, 'Layout "test-layout" version 12345 deployed successfully.');
+        expect(mockLoggerInfoFn).toHaveBeenNthCalledWith(3, 'Deployed layout URL: \u001b]8;;http://dxp-base-url.com/organization/myTenant/component-service/all-layouts/test-layout\u001b\\http://dxp-base-url.com/organization/myTenant/component-service/all-layouts/test-layout\u001b]8;;\u001b\\');
     }));
     it('deploys a layout with dry-run option', () => __awaiter(void 0, void 0, void 0, function* () {
         const file = './src/__tests__/layout.yaml';
         const dxpBaseUrl = 'http://dxp-base-url.com';
         const dryRun = true;
-        const mockLayout = { name: 'Test Layout' };
-        const mockResponse = { name: 'Test Layout', version: '12345' };
+        const mockLayout = {
+            name: 'test-layout',
+            zones: {
+                content: { displayName: 'Content', description: 'Main content' },
+            },
+            template: '<div>{{zones.content}}</div>',
+        };
+        const mockResponse = { name: 'test-layout', version: '12345' };
         definitions_1.loadLayoutDefinition.mockResolvedValue(mockLayout);
         (0, nock_1.default)(dxpBaseUrl + '/__dxp/service/components-content')
             .post('/page-layout', mockLayout)
@@ -117,7 +130,7 @@ describe('deployCommand', () => {
         const program = (0, deploy_1.default)();
         yield program.parseAsync(createMockArgs({ config: file, dxpBaseUrl, dryRun }));
         expect(mockLoggerInfoFn).toHaveBeenNthCalledWith(1, `Loading layout data from the file ${file}`);
-        expect(mockLoggerInfoFn).toHaveBeenNthCalledWith(2, 'Layout "Test Layout" dry run successful.');
+        expect(mockLoggerInfoFn).toHaveBeenNthCalledWith(2, 'Layout "test-layout" dry run successful.');
     }));
     it('handles InvalidLoginSessionError', () => __awaiter(void 0, void 0, void 0, function* () {
         const dxpBaseUrl = 'http://dxp-base-url.com';
@@ -159,4 +172,57 @@ describe('deployCommand', () => {
         yield program.parseAsync(createMockArgs({ contentServiceUrl }));
         expect(errorSpy).toHaveBeenCalledWith(expect.stringContaining('An unknown error occurred'));
     }));
+    it('should log additional details when layout validation fails', () => __awaiter(void 0, void 0, void 0, function* () {
+        const dxpBaseUrl = 'http://dxp-base-url.com';
+        (0, nock_1.default)(dxpBaseUrl + '/__dxp/service/components-content')
+            .post('/page-layout')
+            .reply(400, {
+            message: 'Layout validation failed',
+            details: {
+                input: {
+                    message: 'ERROR: Validation failed: "version" is an excess property and therefore is not allowed',
+                },
+            },
+        });
+        const program = (0, deploy_1.default)();
+        errorSpy = jest.spyOn(program, 'error').mockImplementation();
+        yield program.parseAsync(createMockArgs({ dxpBaseUrl }));
+        expect(errorSpy).toHaveBeenCalledWith(expect.stringContaining('Layout validation failed: ERROR: Validation failed: "version" is an excess property and therefore is not allowed'));
+    }));
+    describe('zone consistency validation', () => {
+        it('should handle zone consistency validation errors where zones are used but not defined in the layout', () => __awaiter(void 0, void 0, void 0, function* () {
+            const file = './src/__tests__/layout.yaml';
+            const dxpBaseUrl = 'http://dxp-base-url.com';
+            // Mock layout with zones that don't match the template
+            const mockLayout = {
+                name: 'test-layout',
+                zones: {
+                    col1: { displayName: 'Column 1', description: 'The first column' },
+                },
+                template: '{{zones.col1}} {{zones.col2}}', // col2 is used but not defined in zones
+            };
+            definitions_1.loadLayoutDefinition.mockResolvedValue(mockLayout);
+            const program = (0, deploy_1.default)();
+            errorSpy = jest.spyOn(program, 'error').mockImplementation();
+            yield program.parseAsync(createMockArgs({ config: file, dxpBaseUrl }));
+            expect(errorSpy).toHaveBeenCalledWith(expect.stringMatching(/Zone consistency validation failed[\s\S]*Zones used in template but not defined in YAML: col2/));
+        }));
+        it('should handle zone consistency validation errors where zones are defined but not used in the template', () => __awaiter(void 0, void 0, void 0, function* () {
+            const file = './src/__tests__/layout.yaml';
+            const dxpBaseUrl = 'http://dxp-base-url.com';
+            const mockLayout = {
+                name: 'test-layout',
+                zones: {
+                    col1: { displayName: 'Column 1', description: 'The first column' },
+                    col2: { displayName: 'Column 2', description: 'The second column' }, // col2 is defined but not used in the template
+                },
+                template: '{{zones.col1}}',
+            };
+            definitions_1.loadLayoutDefinition.mockResolvedValue(mockLayout);
+            const program = (0, deploy_1.default)();
+            errorSpy = jest.spyOn(program, 'error').mockImplementation();
+            yield program.parseAsync(createMockArgs({ config: file, dxpBaseUrl }));
+            expect(errorSpy).toHaveBeenCalledWith(expect.stringMatching(/Zone consistency validation failed[\s\S]*Zones defined in YAML but not used in template: col2/));
+        }));
+    });
 });

package/package.json

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