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

heimwege · 2025-02-14T08:47:23Z

cds-plugin-ui5 is currently being searched in package.json of the app to be converted but must be searched for in CAP root package.json.

This fix currently leads to an exception in project-access checkFilesInSrvFolder in case the CAP srv folder contains sub folders. (fixed in #2923)

Depends on #2926 being merged ✅

…cds-plugin-ui5

changeset-bot · 2025-02-14T08:47:27Z

🦋 Changeset detected

Latest commit: f63da1f

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@sap-ux/app-config-writer	Patch
@sap-ux/create	Patch
@sap-ux/flp-config-sub-generator	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

heimwege · 2025-02-14T09:58:07Z

The new sonar issue seems to be a false positive because casting to Package | undefined is for sure a different type than the inferred JSONSchema7Object | undefined

…uisites

…eview-prerequisites' into fix/app-config-writer/convert-preview-prerequisites

…uisites

sonarqubecloud · 2025-02-17T20:51:36Z

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Klaus-Keller · 2025-02-20T20:13:57Z

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

@@ -35,6 +45,26 @@ function isLowerThanMinimalVersion(
    return !satisfies(minVersionInfo, versionInfo);
 }

+/**


Hi @heimwege, there is already a check for cds plugin in module @sap-ux/cap-config-writer checkCdsUi5PluginEnabled(), see:

open-ux-tools/packages/cap-config-writer/src/cap-config/index.ts

Lines 92 to 122 in 280c822

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 };

I don't think it is a good idea to have a dependency from @sap-ux/app-config-writer to @sap-ux/cap-config-writer, my proposal would be to move the function to @sap-ux/project-access and call it from there in all places.

@Klaus-Keller done in 104f694 ff. Please check carefully as it was a lot of methods and tests to be adjusted

…s and use in app-config-writer

…uisites

Klaus-Keller · 2025-02-21T18:42:37Z

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

@@ -1,4 +1,4 @@
-export { checkCdsUi5PluginEnabled, enableCdsUi5Plugin, satisfiesMinCdsVersion } from './cap-config';


@heimwege, I'm wondering whether we should keep the export checkCdsUi5PluginEnabled for backward compatibility reasons. We would then import and re-export the function. I know of other modules that use the function, search in tools suite for checkCdsUi5PluginEnabled. From a semver perspective this would be breaking changes and require a major version increase, but as we are on a 0.x.y version here we could do such incompatible changes. We just need to be careful and adjust all consumers, not only in this repo.
Let me know what you think.

Klaus-Keller · 2025-02-21T18:51:33Z

.changeset/long-planets-sing.md

@@ -0,0 +1,5 @@
+---


@sap-ux/project-access and @sap-ux/ui5-application-inquirer are missing in changeset

Klaus-Keller · 2025-02-21T19:10:14Z

packages/project-access/src/index.ts

@@ -47,7 +47,13 @@ export {
    readUi5Yaml,
    refreshSpecificationDistTags,
    toReferenceUri,
-    updatePackageScript
+    updatePackageScript,
+    hasCdsPluginUi5,


Do we need to export this? Is it not also part of checkCdsUi5PluginEnabled?

Klaus-Keller · 2025-02-21T19:12:07Z

packages/project-access/src/index.ts

+    getWorkspaceInfo,
+    getWorkspacePackages,


Can we combine getWorkspaceInfo and getWorkspacePackages or add them to results to checkCdsUi5PluginEnabled?

Klaus-Keller · 2025-02-21T19:17:56Z

packages/project-access/src/index.ts

+    hasCdsPluginUi5,
+    getWorkspaceInfo,
+    getWorkspacePackages,
+    minCdsVersion,


Perhaps we add this to constants.ts and change it to Uppercase? Also a more speakable name might help, like MinCdsVersionUi5Plugin?

Klaus-Keller · 2025-02-21T19:20:33Z

packages/project-access/src/index.ts

+    getWorkspaceInfo,
+    getWorkspacePackages,
+    minCdsVersion,
+    hasMinCdsVersion,


Do we need a separate export for this, info is also included in checkCdsUi5PluginEnabled

Klaus-Keller · 2025-02-21T19:26:37Z

packages/project-access/src/project/cap.ts

+ * @returns true: devDependency to cds-plugin-ui5 exists; false: devDependency to cds-plugin-ui5 does not exist
+ */
+export function hasCdsPluginUi5(packageJson: Package): boolean {
+    return !!packageJson.devDependencies?.['cds-plugin-ui5'];


We have already

open-ux-tools/packages/project-access/src/project/dependencies.ts

Lines 15 to 16 in 4859d13

export const hasDependency = (packageJson: Package, dependency: string): boolean =>

!!(packageJson.dependencies?.[dependency] ?? packageJson.devDependencies?.[dependency]);

which checks for both: dependencies and devDependencies which I think is even better, if someone decides to have cds-plgin-ui5 as dependency we still should enable tooling for it

packages/project-access/src/types/cap/index.ts

Co-authored-by: Klaus Keller <[email protected]>

bugfix wrong convert preview-config prerequisites check for usage of …

fb54e35

…cds-plugin-ui5

heimwege added the app-config-writer @sap-ux/app-config-writer label Feb 14, 2025

heimwege requested review from Klaus-Keller and ytpo-lyne February 14, 2025 08:49

heimwege mentioned this pull request Feb 14, 2025

fix(project-access): check for files in srv folder treats directories as files and throws exception #2923

Open

heimwege added the bug Something isn't working label Feb 14, 2025

heimwege added 2 commits February 14, 2025 10:53

fix sonar issue

05778fd

undo fix sonar issue

68591ad

heimwege marked this pull request as ready for review February 17, 2025 08:06

heimwege and others added 4 commits February 17, 2025 09:06

Merge branch 'main' into fix/app-config-writer/convert-preview-prereq…

daabc35

…uisites

refactoring

6304341

Merge remote-tracking branch 'origin/fix/app-config-writer/convert-pr…

eeff9a9

…eview-prerequisites' into fix/app-config-writer/convert-preview-prerequisites

Merge branch 'main' into fix/app-config-writer/convert-preview-prereq…

39dcf76

…uisites

Klaus-Keller reviewed Feb 20, 2025

View reviewed changes

move checkCdsUi5PluginEnabled from cap-config-writer to project-acces…

104f694

…s and use in app-config-writer

heimwege requested a review from a team as a code owner February 21, 2025 16:21

heimwege and others added 4 commits February 21, 2025 17:27

prettier

c65e846

adjust imports

8f3b0a0

Linting auto fix commit

fa8f4a4

Merge branch 'main' into fix/app-config-writer/convert-preview-prereq…

6157b9b

…uisites

Klaus-Keller reviewed Feb 21, 2025

View reviewed changes

packages/project-access/src/types/cap/index.ts Outdated Show resolved Hide resolved

fix typo

f63da1f

Co-authored-by: Klaus Keller <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

heimwege commented Feb 14, 2025 •

edited

Loading

changeset-bot bot commented Feb 14, 2025 •

edited

Loading

heimwege commented Feb 14, 2025

sonarqubecloud bot commented Feb 17, 2025

Klaus-Keller Feb 20, 2025

heimwege Feb 21, 2025 •

edited

Loading

Klaus-Keller Feb 21, 2025

Klaus-Keller Feb 21, 2025

Klaus-Keller Feb 21, 2025

Klaus-Keller Feb 21, 2025

Klaus-Keller Feb 21, 2025

Klaus-Keller Feb 21, 2025

Klaus-Keller Feb 21, 2025

	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 };

		@@ -1,4 +1,4 @@
		export { checkCdsUi5PluginEnabled, enableCdsUi5Plugin, satisfiesMinCdsVersion } from './cap-config';

	export const hasDependency = (packageJson: Package, dependency: string): boolean =>
	!!(packageJson.dependencies?.[dependency] ?? packageJson.devDependencies?.[dependency]);

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

Are you sure you want to change the base?

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

Conversation

heimwege commented Feb 14, 2025 • edited Loading

changeset-bot bot commented Feb 14, 2025 • edited Loading

🦋 Changeset detected

heimwege commented Feb 14, 2025

sonarqubecloud bot commented Feb 17, 2025

Quality Gate passed

Choose a reason for hiding this comment

heimwege Feb 21, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

heimwege commented Feb 14, 2025 •

edited

Loading

changeset-bot bot commented Feb 14, 2025 •

edited

Loading

heimwege Feb 21, 2025 •

edited

Loading