fix(app-config-writer): wrong prerequisites check in convert preview-config

.changeset/long-planets-sing.md

@@ -0,0 +1,5 @@
+---
+'@sap-ux/app-config-writer': patch
+---
+
+fix: wrong convert preview-config prerequisites check for usage of cds-plugin-ui5

packages/app-config-writer/src/preview-config/prerequisites.ts

@@ -1,9 +1,18 @@
 import { join } from 'path';
 import type { Editor } from 'mem-fs-editor';
-import type { Package } from '@sap-ux/project-access';
+import { type Package, findCapProjectRoot, FileName, checkCdsUi5PluginEnabled } from '@sap-ux/project-access';
 import type { ToolsLogger } from '@sap-ux/logger';
 import { satisfies, valid } from 'semver';
 
+const packageName = {
+    WDIO_QUNIT_SERVICE: 'wdio-qunit-service',
+    KARMA_UI5: 'karma-ui5',
+    UI5_CLI: '@ui5/cli',
+    SAP_UX_UI5_TOOLING: '@sap/ux-ui5-tooling',
+    SAP_UX_UI5_MIDDLEWARE_FE_MOCKSERVER: '@sap-ux/ui5-middleware-fe-mockserver',
+    SAP_GRUNT_SAPUI5_BESTPRACTICE_BUILD: '@sap/grunt-sapui5-bestpractice-build'
+} as const;
+
 /**
  * Check if the version of the given package is lower than the minimal version.
  *
@@ -35,6 +44,21 @@ function isLowerThanMinimalVersion(
     return !satisfies(minVersionInfo, versionInfo);
 }
 
+/**
+ * Check if the project is a CAP project that uses 'cds-plugin-ui5'.
+ *
+ * @param basePath - base path of the app
+ * @param fs - file system reference
+ * @returns indicator if the project is a CAP project that uses 'cds-plugin-ui5'
+ */
+async function isUsingCdsPluginUi5(basePath: string, fs: Editor): Promise<boolean> {
+    const capProjectRootPath = await findCapProjectRoot(basePath, false, fs);
+    if (!capProjectRootPath) {
+        return false;
+    }
+    return await checkCdsUi5PluginEnabled(capProjectRootPath, fs);
+}
+
 /**
  * Check if the prerequisites for the conversion are met.
  * - UI5 CLI version 3.0.0 or higher is being used.
@@ -53,59 +77,61 @@ export async function checkPrerequisites(
     convertTests: boolean = false,
     logger?: ToolsLogger
 ): Promise<boolean> {
-    const packageJsonPath = join(basePath, 'package.json');
+    const packageJsonPath = join(basePath, FileName.Package);
     const packageJson = fs.readJSON(packageJsonPath) as Package | undefined;
     let prerequisitesMet = true;
 
     if (!packageJson) {
-        throw Error(`File 'package.json' not found at '${basePath}'`);
+        throw Error(`File '${FileName.Package}' not found at '${basePath}'`);
     }
 
     const sapui5BestpracticeBuildExists =
-        !!packageJson?.devDependencies?.['@sap/grunt-sapui5-bestpractice-build'] ||
-        !!packageJson?.dependencies?.['@sap/grunt-sapui5-bestpractice-build'];
+        !!packageJson?.devDependencies?.[packageName.SAP_GRUNT_SAPUI5_BESTPRACTICE_BUILD] ||
+        !!packageJson?.dependencies?.[packageName.SAP_GRUNT_SAPUI5_BESTPRACTICE_BUILD];
     if (sapui5BestpracticeBuildExists) {
         logger?.error(
-            "Conversion from '@sap/grunt-sapui5-bestpractice-build' is not supported. You must migrate to UI5 CLI version 3.0.0 or higher. For more information, see https://sap.github.io/ui5-tooling/v3/updates/migrate-v3."
+            `Conversion from '${packageName.SAP_GRUNT_SAPUI5_BESTPRACTICE_BUILD}' is not supported. You must migrate to UI5 CLI version 3.0.0 or higher. For more information, see https://sap.github.io/ui5-tooling/v3/updates/migrate-v3.`
         );
         prerequisitesMet = false;
     }
 
-    if (isLowerThanMinimalVersion(packageJson, '@ui5/cli', '3.0.0')) {
+    if (isLowerThanMinimalVersion(packageJson, packageName.UI5_CLI, '3.0.0')) {
         logger?.error(
             'UI5 CLI version 3.0.0 or higher is required to convert the preview to virtual files. For more information, see https://sap.github.io/ui5-tooling/v3/updates/migrate-v3.'
         );
         prerequisitesMet = false;
     }
 
-    if (isLowerThanMinimalVersion(packageJson, '@sap/ux-ui5-tooling', '1.15.4', false)) {
+    if (isLowerThanMinimalVersion(packageJson, packageName.SAP_UX_UI5_TOOLING, '1.15.4', false)) {
         logger?.error(
             'UX UI5 Tooling version 1.15.4 or higher is required to convert the preview to virtual files. For more information, see https://www.npmjs.com/package/@sap/ux-ui5-tooling.'
         );
         prerequisitesMet = false;
     }
 
     const ui5MiddlewareMockserverExists =
-        !!packageJson?.devDependencies?.['@sap-ux/ui5-middleware-fe-mockserver'] ||
-        !!packageJson?.dependencies?.['@sap-ux/ui5-middleware-fe-mockserver'];
-    const cdsPluginUi5Exists =
-        !!packageJson?.devDependencies?.['cds-plugin-ui5'] || !!packageJson?.dependencies?.['cds-plugin-ui5'];
-    if (!ui5MiddlewareMockserverExists && !cdsPluginUi5Exists) {
+        !!packageJson?.devDependencies?.[packageName.SAP_UX_UI5_MIDDLEWARE_FE_MOCKSERVER] ||
+        !!packageJson?.dependencies?.[packageName.SAP_UX_UI5_MIDDLEWARE_FE_MOCKSERVER];
+    if (!ui5MiddlewareMockserverExists && !(await isUsingCdsPluginUi5(basePath, fs))) {
         logger?.error(
-            "Conversion from 'sap/ui/core/util/MockServer' is not supported. You must migrate from '@sap-ux/ui5-middleware-fe-mockserver'. For more information, see https://www.npmjs.com/package/@sap-ux/ui5-middleware-fe-mockserver."
+            `Conversion from 'sap/ui/core/util/MockServer' or '@sap/ux-ui5-fe-mockserver-middleware' is not supported. You must migrate to '${packageName.SAP_UX_UI5_MIDDLEWARE_FE_MOCKSERVER}' first. For more information, see https://www.npmjs.com/package/@sap-ux/ui5-middleware-fe-mockserver.`
         );
         prerequisitesMet = false;
     }
 
-    if (convertTests && (packageJson?.devDependencies?.['karma-ui5'] ?? packageJson?.dependencies?.['karma-ui5'])) {
+    if (
+        convertTests &&
+        (packageJson?.devDependencies?.[packageName.KARMA_UI5] ?? packageJson?.dependencies?.[packageName.KARMA_UI5])
+    ) {
         logger?.warn(
             "This app seems to use Karma as a test runner. Please note that the converter does not convert any Karma configuration files. Please update your karma configuration ('ui5.configPath' and 'ui5.testpage') according to the new virtual endpoints after the conversion."
         );
     }
 
     if (
         convertTests &&
-        (packageJson?.devDependencies?.['wdio-qunit-service'] ?? packageJson?.dependencies?.['wdio-qunit-service'])
+        (packageJson?.devDependencies?.[packageName.WDIO_QUNIT_SERVICE] ??
+            packageJson?.dependencies?.[packageName.WDIO_QUNIT_SERVICE])
     ) {
         logger?.warn(
             'This app seems to use the WebdriverIO QUnit Service as a test runner. Please note that the converter does not convert any WebdriverIO configuration files. Please update your WebdriverIO QUnit Service test paths according to the new virtual endpoints after the conversion.'

packages/app-config-writer/test/unit/preview-config/prerequisites.test.ts

@@ -3,17 +3,20 @@ import { create } from 'mem-fs-editor';
 import { create as createStorage } from 'mem-fs';
 import { join } from 'path';
 import { ToolsLogger } from '@sap-ux/logger';
+import * as ProjectAccess from '@sap-ux/project-access';
 
 describe('prerequisites', () => {
     const logger = new ToolsLogger();
     const errorLogMock = jest.spyOn(ToolsLogger.prototype, 'error').mockImplementation(() => {});
     const warnLogMock = jest.spyOn(ToolsLogger.prototype, 'warn').mockImplementation(() => {});
     const basePath = join(__dirname, '../../fixtures/preview-config');
+    jest.spyOn(ProjectAccess, 'findCapProjectRoot').mockResolvedValue(basePath);
     const fs = create(createStorage());
 
     beforeEach(() => {
         jest.clearAllMocks();
         fs.delete(join(basePath, 'various-configs', 'package.json'));
+        jest.spyOn(ProjectAccess, 'checkCdsUi5PluginEnabled').mockResolvedValue(true);
     });
 
     test('check prerequisites w/o package.json', async () => {
@@ -42,19 +45,13 @@ describe('prerequisites', () => {
     });
 
     test('check prerequisites with UI5 cli ^3 dependency', async () => {
-        fs.write(
-            join(basePath, 'package.json'),
-            JSON.stringify({ devDependencies: { '@ui5/cli': '^3', 'cds-plugin-ui5': '6.6.6' } })
-        );
+        fs.write(join(basePath, 'package.json'), JSON.stringify({ devDependencies: { '@ui5/cli': '^3' } }));
 
         expect(await checkPrerequisites(basePath, fs, false, logger)).toBeTruthy();
     });
 
     test('check prerequisites with UI5 cli ^2 dependency', async () => {
-        fs.write(
-            join(basePath, 'package.json'),
-            JSON.stringify({ devDependencies: { '@ui5/cli': '^2', 'cds-plugin-ui5': '6.6.6' } })
-        );
+        fs.write(join(basePath, 'package.json'), JSON.stringify({ devDependencies: { '@ui5/cli': '^2' } }));
 
         expect(await checkPrerequisites(basePath, fs, false, logger)).toBeFalsy();
         expect(errorLogMock).toHaveBeenCalledWith(
@@ -66,7 +63,7 @@ describe('prerequisites', () => {
         fs.write(
             join(basePath, 'package.json'),
             JSON.stringify({
-                devDependencies: { '@sap/ux-ui5-tooling': '1.16.0', '@ui5/cli': '^3', 'cds-plugin-ui5': '6.6.6' }
+                devDependencies: { '@sap/ux-ui5-tooling': '1.16.0', '@ui5/cli': '^3' }
             })
         );
 
@@ -77,7 +74,7 @@ describe('prerequisites', () => {
         fs.write(
             join(basePath, 'package.json'),
             JSON.stringify({
-                devDependencies: { '@sap/ux-ui5-tooling': '1', '@ui5/cli': '^3', 'cds-plugin-ui5': '6.6.6' }
+                devDependencies: { '@sap/ux-ui5-tooling': '1', '@ui5/cli': '^3' }
             })
         );
 
@@ -88,7 +85,7 @@ describe('prerequisites', () => {
         fs.write(
             join(basePath, 'package.json'),
             JSON.stringify({
-                devDependencies: { '@sap/ux-ui5-tooling': 'latest', '@ui5/cli': '^3', 'cds-plugin-ui5': '6.6.6' }
+                devDependencies: { '@sap/ux-ui5-tooling': 'latest', '@ui5/cli': '^3' }
             })
         );
 
@@ -108,19 +105,17 @@ describe('prerequisites', () => {
     });
 
     test('check prerequisites w/o mockserver dependency', async () => {
+        jest.spyOn(ProjectAccess, 'checkCdsUi5PluginEnabled').mockResolvedValue(false);
         fs.write(join(basePath, 'package.json'), JSON.stringify({ devDependencies: { '@ui5/cli': '3.0.0' } }));
 
         expect(await checkPrerequisites(basePath, fs, false, logger)).toBeFalsy();
         expect(errorLogMock).toHaveBeenCalledWith(
-            "Conversion from 'sap/ui/core/util/MockServer' is not supported. You must migrate from '@sap-ux/ui5-middleware-fe-mockserver'. For more information, see https://www.npmjs.com/package/@sap-ux/ui5-middleware-fe-mockserver."
+            "Conversion from 'sap/ui/core/util/MockServer' or '@sap/ux-ui5-fe-mockserver-middleware' is not supported. You must migrate to '@sap-ux/ui5-middleware-fe-mockserver' first. For more information, see https://www.npmjs.com/package/@sap-ux/ui5-middleware-fe-mockserver."
         );
     });
 
     test('check prerequisites w/o mockserver dependency but with cds-plugin-ui5 dependency', async () => {
-        fs.write(
-            join(basePath, 'package.json'),
-            JSON.stringify({ devDependencies: { '@ui5/cli': '3.0.0', 'cds-plugin-ui5': '6.6.6' } })
-        );
+        fs.write(join(basePath, 'package.json'), JSON.stringify({ devDependencies: { '@ui5/cli': '3.0.0' } }));
 
         expect(await checkPrerequisites(basePath, fs, false, logger)).toBeTruthy();
     });

packages/cap-config-writer/src/cap-config/index.ts

@@ -2,19 +2,8 @@ import { join } from 'path';
 import { create as createStorage } from 'mem-fs';
 import { create } from 'mem-fs-editor';
 import type { Editor } from 'mem-fs-editor';
-import type { Package, CdsVersionInfo } from '@sap-ux/project-access';
-import {
-    addCdsPluginUi5,
-    enableWorkspaces,
-    ensureMinCdsVersion,
-    getWorkspaceInfo,
-    hasCdsPluginUi5,
-    satisfiesMinCdsVersion,
-    minCdsVersion
-} from './package-json';
-export { satisfiesMinCdsVersion } from './package-json';
-import type { CdsUi5PluginInfo } from './types';
-import { satisfies } from 'semver';
+import type { Package } from '@sap-ux/project-access';
+import { addCdsPluginUi5, enableWorkspaces, ensureMinCdsVersion } from './package-json';
 
 /**
  * Enable workspace and cds-plugin-ui5 for given CAP project.
@@ -37,86 +26,3 @@ export async function enableCdsUi5Plugin(basePath: string, fs?: Editor): Promise
     fs.writeJSON(packageJsonPath, packageJson);
     return fs;
 }
-
-/**
- * Check if cds-plugin-ui5 is enabled on a CAP project. Checks also all prerequisites, like minimum @sap/cds version.
- * Overloaded function that returns detailed CAP plugin info.
- *
- * @param basePath - root path of the CAP project, where package.json is located
- * @param [fs] - optional: the memfs editor instance
- * @returns true: cds-plugin-ui5 and all prerequisites are fulfilled; false: cds-plugin-ui5 is not enabled or not all prerequisites are fulfilled
- */
-export async function checkCdsUi5PluginEnabled(basePath: string, fs?: Editor): Promise<boolean>;
-
-/**
- * Check if cds-plugin-ui5 is enabled on a CAP project. Checks also all prerequisites, like minimum @sap/cds version.
- *
- * @param basePath - root path of the CAP project, where package.json is located
- * @param [fs] - optional: the memfs editor instance
- * @param [moreInfo] if true return an object specifying detailed info about the cds and workspace state
- * @returns false if package.json is not found at specified path or {@link CdsUi5PluginInfo} with additional info
- */
-export async function checkCdsUi5PluginEnabled(
-    basePath: string,
-    fs?: Editor,
-    moreInfo?: boolean
-): Promise<boolean | CdsUi5PluginInfo>;
-
-/**
- * Check if cds-plugin-ui5 is enabled on a CAP project. Checks also all prerequisites, like minimum @sap/cds version.
- *
- * @param basePath - root path of the CAP project, where package.json is located
- * @param [fs] - optional: the memfs editor instance
- * @param [moreInfo] if true return an object specifying detailed info about the cds and workspace state
- * @param {CdsVersionInfo} [cdsVersionInfo] - If provided will be used instead of parsing the package.json file to determine the cds version.
- * @returns false if package.json is not found at specified path or {@link CdsUi5PluginInfo} with additional info
- */
-export async function checkCdsUi5PluginEnabled(
-    basePath: string,
-    fs?: Editor,
-    moreInfo?: boolean,
-    cdsVersionInfo?: CdsVersionInfo
-): Promise<boolean | CdsUi5PluginInfo>;
-
-/**
- * Implementation of the overloaded function.
- * Check if cds-plugin-ui5 is enabled on a CAP project. Checks also all prerequisites, like minimum @sap/cds version.
- *
- * @param basePath - root path of the CAP project, where package.json is located
- * @param [fs] - optional: the memfs editor instance
- * @param [moreInfo] if true return an object specifying detailed info about the cds and workspace state
- * @param {CdsVersionInfo} [cdsVersionInfo] - If provided will be used instead of parsing the package.json file to determine the cds version.
- * @returns false if package.json is not found at specified path or {@link CdsUi5PluginInfo} with additional info or true if
- * cds-plugin-ui5 and all prerequisites are fulfilled
- */
-export async function checkCdsUi5PluginEnabled(
-    basePath: string,
-    fs?: Editor,
-    moreInfo?: boolean,
-    cdsVersionInfo?: CdsVersionInfo
-): Promise<boolean | CdsUi5PluginInfo> {
-    if (!fs) {
-        fs = create(createStorage());
-    }
-    const packageJsonPath = join(basePath, 'package.json');
-    if (!fs.exists(packageJsonPath)) {
-        return false;
-    }
-    const packageJson = fs.readJSON(packageJsonPath) as Package;
-    const { workspaceEnabled } = await getWorkspaceInfo(basePath, packageJson);
-    const cdsInfo: CdsUi5PluginInfo = {
-        // Below line checks if 'cdsVersionInfo' is available and contains version information.
-        // If it does, it uses that version information to determine if it satisfies the minimum CDS version required.
-        // If 'cdsVersionInfo' is not available or does not contain version information,it falls back to check the version specified in the package.json file.
-        hasMinCdsVersion: cdsVersionInfo?.version
-            ? satisfies(cdsVersionInfo?.version, `>=${minCdsVersion}`)
-            : satisfiesMinCdsVersion(packageJson),
-        isWorkspaceEnabled: workspaceEnabled,
-        hasCdsUi5Plugin: hasCdsPluginUi5(packageJson),
-        isCdsUi5PluginEnabled: false
-    };
-    cdsInfo.isCdsUi5PluginEnabled = cdsInfo.hasMinCdsVersion && cdsInfo.isWorkspaceEnabled && cdsInfo.hasCdsUi5Plugin;
-    return moreInfo ? cdsInfo : cdsInfo.isCdsUi5PluginEnabled;
-}
-
-export { minCdsVersion };