feat: allow to explicitly disable wrapper plugins (#62)

jrichter1 · web-flow · commit 39984e247765 · 2026-03-25T17:49:08.000+05:30
* feat: allow to explicitly disable wrapper plugins

Signed-off-by: Jan Richter &lt;jrichter@redhat.com&gt;

* restrict to PR checks and bump version

---------

Signed-off-by: Jan Richter &lt;jrichter@redhat.com&gt;
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -33,7 +33,7 @@ export default defineConfig({
       { text: "Examples", link: "/examples/" },
       { text: "Overlay Testing", link: "/overlay/" },
       {
-        text: "v1.1.13",
+        text: "v1.1.22",
         items: [{ text: "Changelog", link: "/changelog" }],
       },
     ],
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -2,7 +2,13 @@
 
 All notable changes to this project will be documented in this file.
 
-## [1.1.21] - Current
+## [1.1.22] - Current
+
+### Added
+
+- **disableWrappers option for rhdh.configure**: Allows listing plugins whose wrappers will be disabled in the dynamic plugins config to allow the use of PR images when a wrapper is enabled by default for the same plugin. This option is ignored if the `GIT_PR_NUMBER` environment variable is not set.
+
+## [1.1.21]
 
 ### Fixed
 
@@ -87,7 +93,7 @@ All notable changes to this project will be documented in this file.
 - `VAULT_GH_2FA_SECRET` - GitHub user secret for 2 factor authentication
 - `VAULT_GITHUB_USER_TOKEN` - Github user token
 
-## [1.1.12] - Current
+## [1.1.12]
 
 ### Changed
 
diff --git a/docs/guide/configuration/disable-wrappers.md b/docs/guide/configuration/disable-wrappers.md
@@ -0,0 +1,38 @@
+# Disabling Conflicting Wrappers
+
+Some plugins are included as wrappers in RHDH and are enabled by default.
+
+When the plugin metadata is injected from overlays for such plugin, it will lead to duplicate plugin configuration.
+
+For example, if the `dynamic-plugins.default.yaml` file contains a wrapper config like this:
+```yaml
+  - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-adoption-insights
+    disabled: false
+    ...
+```
+
+The plugin metadata injection might generate a plugin entry such as:
+```yaml
+  - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-adoption-insights:pr_1967__0.6.2!red-hat-developer-hub-backstage-plugin-adoption-insights
+  disabled: false
+  ...
+```
+
+Both entries configure the same plugin, but since the sources are different, one does not override the other, leading to conflicts and initContainer failure. For the deployment to run successfully using the latest oci image, the wrapper must be explicitly disabled.
+
+## Configuring Wrappers to Disable
+
+The `disableWrappers` option can be used to disable wrapper plugins:
+
+```typescript
+await rhdh.configure({
+    auth: "keycloak",
+    disableWrappers: ['wrapper-plugin-1', 'wrapper-plugin-2', etc],
+  });
+await rhdh.deploy();
+```
+
+Wrapper plugin packages are defined as `./dynamic-plugins/dist/$plugin-name`. Use the `$plugin-name` in `disableWrappers` list.
+Make sure that the plugin name matches the dynamic plugins default config.
+
+Note that this option is ignored outside of PR checks, since there is no metadata injection enabled in such case.
diff --git a/docs/guide/configuration/index.md b/docs/guide/configuration/index.md
@@ -10,6 +10,7 @@ The package provides configuration tools for ESLint, TypeScript, and RHDH deploy
 | [ESLint Configuration](/guide/configuration/eslint-config) | Pre-configured ESLint rules |
 | [TypeScript Configuration](/guide/configuration/typescript-config) | Base TypeScript settings |
 | [Environment Variables](/guide/configuration/environment-variables) | All environment variables |
+| [Disabling Conflicting Wrappers](/guide/configuration/disable-wrappers) | Disabling pre-enabled wrappers that may cause configuration conflicts |
 
 ## Project Configuration
 
diff --git a/docs/overlay/examples/basic-plugin.md b/docs/overlay/examples/basic-plugin.md
@@ -68,7 +68,7 @@ workspaces/<plugin>/e2e-tests/
     "eslint-plugin-check-file": "^3.3.1",
     "eslint-plugin-playwright": "^2.4.0",
     "prettier": "^3.7.4",
-    "@red-hat-developer-hub/e2e-test-utils": "1.1.13",
+    "@red-hat-developer-hub/e2e-test-utils": "1.1.22",
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.50.0"
   }
diff --git a/docs/overlay/examples/tech-radar.md b/docs/overlay/examples/tech-radar.md
@@ -71,7 +71,7 @@ workspaces/tech-radar/e2e-tests/
     "eslint-plugin-check-file": "^3.3.1",
     "eslint-plugin-playwright": "^2.4.0",
     "prettier": "^3.7.4",
-    "@red-hat-developer-hub/e2e-test-utils": "1.1.13",
+    "@red-hat-developer-hub/e2e-test-utils": "1.1.22",
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.50.0"
   }
diff --git a/docs/overlay/test-structure/directory-layout.md b/docs/overlay/test-structure/directory-layout.md
@@ -68,7 +68,7 @@ Defines the test package with dependencies and scripts:
     "eslint-plugin-check-file": "^3.3.1",
     "eslint-plugin-playwright": "^2.4.0",
     "prettier": "^3.7.4",
-    "@red-hat-developer-hub/e2e-test-utils": "1.1.13",
+    "@red-hat-developer-hub/e2e-test-utils": "1.1.22",
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.50.0"
   }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@red-hat-developer-hub/e2e-test-utils",
-  "version": "1.1.21",
+  "version": "1.1.22",
   "description": "Test utilities for RHDH E2E tests",
   "license": "Apache-2.0",
   "repository": {
diff --git a/src/deployment/rhdh/deployment.ts b/src/deployment/rhdh/deployment.ts
@@ -7,6 +7,7 @@ import {
   loadAndInjectPluginMetadata,
   generateDynamicPluginsConfigFromMetadata,
   getNormalizedPluginMergeKey,
+  disablePluginWrappers,
 } from "../../utils/plugin-metadata.js";
 import { envsubst } from "../../utils/common.js";
 import { runOnce } from "../../playwright/run-once.js";
@@ -121,6 +122,9 @@ export class RHDHDeployment {
     const userConfigPath = this.deploymentConfig.dynamicPlugins;
     const userConfigExists = userConfigPath && fs.existsSync(userConfigPath);
     const authConfig = AUTH_CONFIG_PATHS[this.deploymentConfig.auth];
+    const wrapperPlugins = disablePluginWrappers(
+      this.deploymentConfig.disableWrappers,
+    );
 
     // If user's dynamic-plugins config doesn't exist, auto-generate from metadata
     if (!userConfigExists) {
@@ -136,13 +140,20 @@ export class RHDHDeployment {
         [DEFAULT_CONFIG_PATHS.dynamicPlugins, authConfig.dynamicPlugins],
         { arrayMergeStrategy: { byKey: "package" } },
       );
-      return deepMerge(authPlugins, metadataConfig, {
+      const dynamicPlugins = deepMerge(authPlugins, metadataConfig, {
         arrayMergeStrategy: {
           byKey: "package",
           normalizeKey: (item) =>
             getNormalizedPluginMergeKey(item as Record<string, unknown>),
         },
       });
+
+      if (!process.env.GIT_PR_NUMBER) {
+        return dynamicPlugins;
+      }
+      return deepMerge(dynamicPlugins, wrapperPlugins, {
+        arrayMergeStrategy: "concat",
+      });
     }
 
     // User config exists - merge provided configs and inject metadata for listed plugins only
@@ -159,6 +170,12 @@ export class RHDHDeployment {
     dynamicPluginsConfig =
       await loadAndInjectPluginMetadata(dynamicPluginsConfig);
 
+    if (process.env.GIT_PR_NUMBER) {
+      dynamicPluginsConfig = deepMerge(dynamicPluginsConfig, wrapperPlugins, {
+        arrayMergeStrategy: "concat",
+      });
+    }
+
     return dynamicPluginsConfig;
   }
 
@@ -407,6 +424,7 @@ export class RHDHDeployment {
       secrets: input.secrets ?? `tests/config/rhdh-secrets.yaml`,
       dynamicPlugins:
         input.dynamicPlugins ?? `tests/config/dynamic-plugins.yaml`,
+      disableWrappers: input.disableWrappers ?? [],
     };
 
     if (method === "helm") {
diff --git a/src/deployment/rhdh/types.ts b/src/deployment/rhdh/types.ts
@@ -11,6 +11,7 @@ export type DeploymentOptions = {
   method?: DeploymentMethod;
   valueFile?: string;
   subscription?: string;
+  disableWrappers?: string[];
 };
 
 export type HelmDeploymentConfig = {
@@ -30,6 +31,7 @@ export type DeploymentConfigBase = {
   appConfig: string;
   secrets: string;
   dynamicPlugins: string;
+  disableWrappers: string[];
 };
 
 export type DeploymentConfig = DeploymentConfigBase &
diff --git a/src/utils/plugin-metadata.ts b/src/utils/plugin-metadata.ts
@@ -436,6 +436,28 @@ export function injectMetadataConfig(
   };
 }
 
+/**
+ * Generates dynamic-plugins configuration for wrapper plugins
+ * that need to be disabled. Each plugin entry contains:
+ *  - package: ./dynamic-plugins/dist/$plugin-name
+ *  - disabled: true
+ *
+ * @param plugins list of wrapper plugin names
+ * @returns Dynamic plugins configuration that disables listed wrapper plugins
+ */
+export function disablePluginWrappers(plugins: string[]): DynamicPluginsConfig {
+  const pluginConfig: DynamicPluginsConfig = {
+    plugins: [],
+  };
+  for (const plugin of plugins) {
+    pluginConfig.plugins!.push({
+      package: `./dynamic-plugins/dist/${plugin}`,
+      disabled: true,
+    });
+  }
+  return pluginConfig;
+}
+
 /**
  * Generates a complete dynamic-plugins configuration from metadata files.
  * Iterates through all metadata files and creates plugin entries with:

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ export default defineConfig({`
`33`	`33`	`{ text: "Examples", link: "/examples/" },`
`34`	`34`	`{ text: "Overlay Testing", link: "/overlay/" },`
`35`	`35`	`{`
`36`		`- text: "v1.1.13",`
	`36`	`+ text: "v1.1.22",`
`37`	`37`	`items: [{ text: "Changelog", link: "/changelog" }],`
`38`	`38`	`},`
`39`	`39`	`],`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ workspaces/<plugin>/e2e-tests/`
`68`	`68`	`"eslint-plugin-check-file": "^3.3.1",`
`69`	`69`	`"eslint-plugin-playwright": "^2.4.0",`
`70`	`70`	`"prettier": "^3.7.4",`
`71`		`- "@red-hat-developer-hub/e2e-test-utils": "1.1.13",`
	`71`	`+ "@red-hat-developer-hub/e2e-test-utils": "1.1.22",`
`72`	`72`	`"typescript": "^5.9.3",`
`73`	`73`	`"typescript-eslint": "^8.50.0"`
`74`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ workspaces/tech-radar/e2e-tests/`
`71`	`71`	`"eslint-plugin-check-file": "^3.3.1",`
`72`	`72`	`"eslint-plugin-playwright": "^2.4.0",`
`73`	`73`	`"prettier": "^3.7.4",`
`74`		`- "@red-hat-developer-hub/e2e-test-utils": "1.1.13",`
	`74`	`+ "@red-hat-developer-hub/e2e-test-utils": "1.1.22",`
`75`	`75`	`"typescript": "^5.9.3",`
`76`	`76`	`"typescript-eslint": "^8.50.0"`
`77`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ Defines the test package with dependencies and scripts:`
`68`	`68`	`"eslint-plugin-check-file": "^3.3.1",`
`69`	`69`	`"eslint-plugin-playwright": "^2.4.0",`
`70`	`70`	`"prettier": "^3.7.4",`
`71`		`- "@red-hat-developer-hub/e2e-test-utils": "1.1.13",`
	`71`	`+ "@red-hat-developer-hub/e2e-test-utils": "1.1.22",`
`72`	`72`	`"typescript": "^5.9.3",`
`73`	`73`	`"typescript-eslint": "^8.50.0"`
`74`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@red-hat-developer-hub/e2e-test-utils",`
`3`		`- "version": "1.1.21",`
	`3`	`+ "version": "1.1.22",`
`4`	`4`	`"description": "Test utilities for RHDH E2E tests",`
`5`	`5`	`"license": "Apache-2.0",`
`6`	`6`	`"repository": {`