fix(cli): extend --ignore-version-check (#2616)

This change updates the cli's --ignore-version-check flag to also ignore the check performed on a embedded transitive dependencies that are moved to peer dependencies, when it is known that the mismatch is runtime compatible. Signed-off-by: Stan Lewis <[email protected]> Co-authored-by: Tomas Kral <[email protected]>
janus-idp · Jan 20, 2025 · 684e4ad · 684e4ad
1 parent 8c307f7
commit 684e4ad
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 18 deletions.
diff --git a/.changeset/stale-penguins-tan.md b/.changeset/stale-penguins-tan.md
@@ -0,0 +1,7 @@
+---
+"@janus-idp/cli": patch
+---
+
+fix(cli): extend --ignore-version-check
+
+This change updates the cli's --ignore-version-check flag to also ignore the check performed on an embedded transitive dependencies that are moved to peer dependencies, when it is known that the mismatch is runtime compatible.
diff --git a/packages/cli/src/commands/export-dynamic-plugin/backend-embed-as-code.ts b/packages/cli/src/commands/export-dynamic-plugin/backend-embed-as-code.ts
@@ -168,14 +168,14 @@ export async function backend(
     embedModules({
       filter: filter,
       addDependency: (embeddedModule, dependencyName, newDependencyVersion) =>
-        addToDependenciesForModule(
-          {
+        addToDependenciesForModule({
+          dependency: {
             name: dependencyName,
             version: newDependencyVersion,
           },
-          dependenciesToAdd,
-          embeddedModule,
-        ),
+          dependencies: dependenciesToAdd,
+          module: embeddedModule,
+        }),
     }),
   );
 

diff --git a/packages/cli/src/commands/export-dynamic-plugin/backend-embed-as-dependencies.ts b/packages/cli/src/commands/export-dynamic-plugin/backend-embed-as-dependencies.ts
@@ -221,11 +221,12 @@ throw new Error(
         if (embeddedPkg.peerDependencies) {
           Object.entries(embeddedPkg.peerDependencies).forEach(
             ([name, version]) => {
-              addToDependenciesForModule(
-                { name, version },
-                embeddedPeerDependencies,
-                embeddedPkg.name,
-              );
+              addToDependenciesForModule({
+                dependency: { name, version },
+                dependencies: embeddedPeerDependencies,
+                ignoreVersionCheck,
+                module: embeddedPkg.name,
+              });
             },
           );
         }

diff --git a/packages/cli/src/commands/export-dynamic-plugin/backend-utils.ts b/packages/cli/src/commands/export-dynamic-plugin/backend-utils.ts
@@ -23,11 +23,17 @@ import path from 'path';
 
 import { Task } from '../../lib/tasks';
 
-export function addToDependenciesForModule(
-  dependency: { name: string; version: string },
-  dependencies: { [key: string]: string },
-  module: string,
-): void {
+export function addToDependenciesForModule({
+  dependency,
+  dependencies,
+  ignoreVersionCheck = [],
+  module,
+}: {
+  dependency: { name: string; version: string };
+  dependencies: { [key: string]: string };
+  ignoreVersionCheck?: string[];
+  module: string;
+}): void {
   const existingDependencyVersion = dependencies[dependency.name];
   if (existingDependencyVersion === undefined) {
     dependencies[dependency.name] = dependency.version;
@@ -61,9 +67,15 @@ export function addToDependenciesForModule(
     );
     return;
   }
-  throw new Error(
-    `Several incompatible versions ('${existingDependencyVersion}', '${dependency.version}') of the same transitive dependency ('${dependency.name}') for embedded module ('${module}')`,
-  );
+  if (!ignoreVersionCheck.includes(dependency.name)) {
+    throw new Error(
+      `Several incompatible versions ('${existingDependencyVersion}', '${dependency.version}') of the same transitive dependency ('${dependency.name}') for embedded module ('${module}')`,
+    );
+  } else {
+    Task.log(
+      `Several incompatible versions ('${existingDependencyVersion}', '${dependency.version}') of the same transitive dependency ('${dependency.name}') for embedded module ('${module}') however this has been overridden to use '${dependency.version}'`,
+    );
+  }
 }
 
 export function addToMainDependencies(