fix: role retrieval bug in the metadata command, and introduce backstage support-versions check during export. (#2661)

* fix: wrong role retrieval which could break the metadata command behavior.

Signed-off-by: David Festal <dfestal@redhat.com>

* fix: add a backstage supported version check and fix

Signed-off-by: David Festal <dfestal@redhat.com>

* Fix maintainability issues raised by Sonar

Signed-off-by: David Festal <dfestal@redhat.com>

---------

Signed-off-by: David Festal <dfestal@redhat.com>

Author: davidfestal

.changeset/giant-spies-tap.md

@@ -0,0 +1,5 @@
+---
+"@janus-idp/cli": patch
+---
+
+Fix wrong role retrieval which could break the `metadata` command behavior.

.changeset/swift-plums-join.md

@@ -0,0 +1,5 @@
+---
+"@janus-idp/cli": patch
+---
+
+Check backstage the `support-versions` field value during export, and fix it if possible while emitting a warning.

packages/cli/src/commands/export-dynamic-plugin/command.ts

@@ -19,6 +19,7 @@ import { PackageRoles } from '@backstage/cli-node';
 import chalk from 'chalk';
 import { OptionValues } from 'commander';
 import fs from 'fs-extra';
+import * as semver from 'semver';
 
 import path from 'path';
 
@@ -74,5 +75,49 @@ export async function command(opts: OptionValues): Promise<void> {
     });
   }
 
+  await checkBackstageSupportedVersions(targetPath);
+
   await applyDevOptions(opts, rawPkg.name, roleInfo, targetPath);
 }
+
+async function checkBackstageSupportedVersions(targetPath: string) {
+  const targetPackageFile = path.join(targetPath, 'package.json');
+  const targetPackage = await fs.readJSON(targetPackageFile);
+  const supportedVersions: string | undefined =
+    targetPackage.backstage?.['supported-versions'];
+  const backstageJson = path.join(paths.targetRoot, '/backstage.json');
+  if (!fs.existsSync(backstageJson)) {
+    return;
+  }
+  const backstageVersion: string = (await fs.readJSON(backstageJson)).version;
+  if (supportedVersions) {
+    const singleVersionInSupportedVersions = semver.valid(
+      supportedVersions,
+      true,
+    );
+    const supportedVersionsRange = singleVersionInSupportedVersions
+      ? `~${supportedVersions}`
+      : supportedVersions;
+
+    if (semver.subset(`~${backstageVersion}`, supportedVersionsRange)) {
+      return;
+    }
+    const errorMessage = `The ${chalk.cyan('backstage.supported-versions')} field in the package descriptor is not compatible with the backstage version specified in the ${chalk.cyan('backstage.json')} file: ${chalk.cyan(supportedVersions)} vs ${chalk.cyan(backstageVersion)}.`;
+    if (!singleVersionInSupportedVersions) {
+      throw new Error(errorMessage);
+    }
+    Task.log(
+      chalk.yellow(
+        `${errorMessage}\nOverriding it with ${chalk.cyan(backstageVersion)}.`,
+      ),
+    );
+  } else {
+    Task.log(
+      `Filling ${chalk.cyan('supported-versions')} with ${chalk.cyan(backstageVersion)}.`,
+    );
+  }
+  targetPackage.backstage['supported-versions'] = backstageVersion;
+  await fs.writeJSON(targetPackageFile, targetPackage, {
+    spaces: 2,
+  });
+}

packages/cli/src/commands/package-dynamic-plugins/command.ts

@@ -37,7 +37,7 @@ export async function command(opts: OptionValues): Promise<void> {
     paths.resolveTarget('package.json'),
   )) as PackageJson;
   const workspacePackageRole =
-    PackageRoles.detectRoleFromPackage(workspacePackage);
+    PackageRoles.getRoleFromPackage(workspacePackage);
   const workspacePackageRoleInfo =
     workspacePackageRole !== undefined
       ? PackageRoles.getRoleInfo(workspacePackageRole)
@@ -166,13 +166,13 @@ export async function command(opts: OptionValues): Promise<void> {
             );
           } catch (err) {
             Task.log(
-              `Encountered an error parsing configuration at ${pluginConfigPath}, no example configuration will be displayed`,
+              `Encountered an error parsing configuration at ${pluginConfigPath}, no example configuration will be displayed. The error was ${err}`,
             );
           }
         }
       } catch (err) {
         Task.log(
-          `Encountered an error copying static assets for plugin ${packageFilePath}, the plugin will not be packaged.  The error was ${err}`,
+          `Encountered an error copying static assets for plugin ${packageFilePath}, the plugin will not be packaged. The error was ${err}`,
         );
       }
     }
@@ -279,7 +279,7 @@ async function discoverPluginPackages() {
       packageJsonFilePaths.map(async packageFilePath => {
         const packageJson = (await fs.readJson(packageFilePath)) as PackageJson;
         const packageRole = PackageRoles.getRoleFromPackage(packageJson);
-        const packageRoleInfo = PackageRoles.getRoleInfo(packageRole || '');
+        const packageRoleInfo = PackageRoles.getRoleInfo(packageRole ?? '');
         const packageDirectory = path.dirname(packageFilePath);
         return {
           packageDirectory,