CONSOLE-4987: Conditionally render Guided Tour based on capability and disable it for Console E2E tests by krishagarwal278 · Pull Request #15926 · openshift/console

krishagarwal278 · 2026-01-19T09:12:38Z

Summary by CodeRabbit

New Features
- Guided Tour is now governed by a server-side capability flag; visibility can be centrally enabled/disabled.
- Default behavior remains enabled unless the server explicitly sets the Guided Tour to "Disabled".
- Extension manifests and startup logic now recognize and require the Guided Tour capability flag for consistent behavior.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

openshift-ci-robot · 2026-01-19T09:12:41Z

@krishagarwal278: This pull request references CONSOLE-4987 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set.

Details

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

coderabbitai · 2026-01-19T09:13:02Z

📝 Walkthrough

Walkthrough

Adds a new capability feature flag, CONSOLE_CAPABILITY_GUIDEDTOUR_IS_ENABLED: declared in FLAGS, referenced in guided-tour extension manifests, initialized from server capabilities during app startup (defaults enabled unless explicitly disabled), and included in feature-flag test expectations.

Changes

Cohort / File(s)	Summary
Feature flag definition `frontend/packages/console-shared/src/constants/common.ts`	Added enum member `CONSOLE_CAPABILITY_GUIDEDTOUR_IS_ENABLED` to exported `FLAGS` enum.
Console extension manifests `frontend/packages/console-app/console-extensions.json`, `frontend/packages/dev-console/console-extensions.json`	Added `CONSOLE_CAPABILITY_GUIDEDTOUR_IS_ENABLED` to `flags.required` for guided-tour extension entries.
Application initialization `frontend/public/components/app.tsx`	Read `GuidedTourFeature` from `window.SERVER_FLAGS.capabilities` and dispatch/set `CONSOLE_CAPABILITY_GUIDEDTOUR_IS_ENABLED` (defaults to enabled unless `Disabled`).
Feature flag tests `frontend/public/reducers/__tests__/features.spec.tsx`	Updated default feature flags expectation to include `CONSOLE_CAPABILITY_GUIDEDTOUR_IS_ENABLED: undefined`.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check	✅ Passed	The title clearly describes the main change: adding conditional rendering of Guided Tour based on a capability flag and disabling it for E2E tests, which aligns with all file changes across the codebase.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

📝 Generate docstrings

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

openshift-ci-robot · 2026-01-19T09:14:06Z

@krishagarwal278: This pull request references CONSOLE-4987 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set.

Details

In response to this:

Summary by CodeRabbit

New Features

Guided tour feature is now controlled through a server-side capability flag, enabling centralized management and visibility control across environments.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

coderabbitai

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

frontend/public/components/app.tsx (1)

169-196: Backend capability name GuidedTourFeature is not defined in the OpenShift API and will never be emitted.

The code searches for a capability named GuidedTourFeature, but the OpenShift API enum (vendor/github.com/openshift/api/operator/v1/types_console.go) only defines LightspeedButton and GettingStartedBanner as valid ConsoleCapabilityName values. The kubebuilder validation enforces this enum restriction, meaning:

The backend will never emit a capability named GuidedTourFeature

guidedTourCapability will always be undefined

The logic guidedTourCapability?.visibility?.state !== 'Disabled' will always evaluate to true

The flag CONSOLE_CAPABILITY_GUIDEDTOUR_IS_ENABLED will always be enabled, regardless of intent

Add GuidedTourFeature to the ConsoleCapabilityName enum in the OpenShift API types, update the kubebuilder validation enum constraint, and ensure the backend handles emitting this capability.

openshift-ci-robot · 2026-01-19T09:42:20Z

@krishagarwal278: This pull request references CONSOLE-4987 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set.

Details

In response to this:

Summary by CodeRabbit

New Features

Guided Tour is now governed by a server-side capability flag; visibility can be centrally enabled/disabled.

Default behavior remains enabled unless the server explicitly sets the Guided Tour to "Disabled".

Extension manifests and startup logic now recognize and require the Guided Tour capability flag for consistent behavior.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

coderabbitai

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

frontend/public/components/app.tsx (1)

175-196: Backend API sync required: 'GuidedTourFeature' capability not registered.

The backend API definition (vendor/github.com/openshift/api/operator/v1/types_console.go:138) only registers "LightspeedButton" and "GettingStartedBanner" as valid capabilities. The frontend is searching for "GuidedTourFeature" (line 176), which doesn't exist in the API spec and will never be returned by the server.

The condition guidedTourCapability?.visibility?.state !== 'Disabled' evaluates to true when guidedTourCapability is undefined, accidentally enabling the tour for backwards compatibility. However, this bypasses API validation and will break if the backend enforces the capability enum.

The API types must be updated to include "GuidedTourFeature" in the ConsoleCapabilityName enum (line 138 of vendor/github.com/openshift/api/operator/v1/types_console.go), or this frontend code needs to be reverted.

krishagarwal278 · 2026-01-19T11:27:44Z

/retest

krishagarwal278 · 2026-01-20T19:37:54Z

/retest

yanpzhan · 2026-01-21T06:51:54Z

Checked on cluster launched against the pr, the GuidedTour capability is set as Enabled by default in console operator, there is Guided Tour when login console. Set GuidedTour capability as Disabled in console operator. Login console again, there is not Guided Tour.
The feature works as expected.
/verified by yanpzhan

openshift-ci-robot · 2026-01-21T06:52:07Z

@yanpzhan: This PR has been marked as verified by yanpzhan.

Details

In response to this:

Checked on cluster launched against the pr, the GuidedTour capability is set as Enabled by default in console operator, there is Guided Tour when login console. Set GuidedTour capability as Disabled in console operator. Login console again, there is not Guided Tour.
The feature works as expected.
/verified by yanpzhan

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

logonoff

/lgtm

krishagarwal278 · 2026-01-21T19:24:58Z

/assign @jhadvig

openshift-ci · 2026-02-02T13:39:42Z

@krishagarwal278: GitHub didn't allow me to assign the following users: jseseCCS.

Note that only openshift members with read permissions, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time.
For more information please see the contributor guide

Details

In response to this:

px-approval:
/assign @sferich888

docs approval:
/assign @jseseCCS

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

jseseCCS · 2026-02-02T13:54:49Z

one minor suggestion in 1 file. otherwise, LGTM!

jseseCCS · 2026-02-02T13:55:01Z

/label docs-approved

jseseCCS · 2026-02-02T13:52:27Z

frontend/public/components/app.tsx

+    dispatch(
+      setFlag(
+        FLAGS.CONSOLE_CAPABILITY_GUIDEDTOUR_IS_ENABLED,
+        // Default to enabled if capability is not explicitly set (backwards compatibility)


Minor: change “backwards compatibility” → “backward compatibility” for style consistency?

no sure why the comment is needed ?

jhadvig · 2026-02-02T14:32:59Z

frontend/public/components/app.tsx

+      setFlag(
+        FLAGS.CONSOLE_CAPABILITY_GUIDEDTOUR_IS_ENABLED,
+        // Default to enabled if capability is not explicitly set (backwards compatibility)
+        guidedTourCapability?.visibility?.state !== 'Disabled',


Lets follow the pattern from above

guidedTourCapability?.visibility?.state === 'Enabled',

jhadvig · 2026-02-02T14:35:10Z

frontend/public/components/app.tsx

+    dispatch(
+      setFlag(
+        FLAGS.CONSOLE_CAPABILITY_GUIDEDTOUR_IS_ENABLED,
+        // Default to enabled if capability is not explicitly set (backwards compatibility)


no sure why the comment is needed ?

…ndencies to vendor openshift/api with gudiedTour capability

rh-joshbeverly · 2026-02-02T18:12:21Z

/label px-approved

krishagarwal278 · 2026-02-03T07:13:12Z

/retest

jhadvig

Thanks @krishagarwal278 for the update.
The code looks good but I dont see the code responsible for conditionally rendering the GuiderdTour component based on the flag.
Also we need to check if all the e2e tests (besides GuidedTour test itself) set the flag to disabled.

krishagarwal278 · 2026-02-03T13:31:57Z

Hi @jhadvig, thanks for the review!

The conditional rendering is currently handled at the extension manifest level via "required": ["CONSOLE_CAPABILITY_GUIDEDTOUR_IS_ENABLED"] in both console-extensions.json files. QE (@yanpzhan) verified this works as expected.
For e2e tests, GuidedTour is disabled via "disallowed": ["INTEGRATION_TEST"] in the extension manifest.
Shall I add an explicit flag check around <GuidedTour /> if that would make the code clearer? Let me know your preference!

jhadvig · 2026-02-03T15:14:30Z

ok, nice. I see that in the GuidedTour component. In that case we should be fine

/lgtm

openshift-ci · 2026-02-03T15:14:58Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jhadvig, jseseCCS, krishagarwal278, logonoff

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [jhadvig]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

yanpzhan · 2026-02-04T00:43:59Z

/verified by yanpzhan

openshift-ci-robot · 2026-02-04T00:44:10Z

@yanpzhan: This PR has been marked as verified by yanpzhan.

Details

In response to this:

/verified by yanpzhan

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot · 2026-02-04T10:50:58Z

/retest-required

Remaining retests: 0 against base HEAD 1a68f54 and 2 for PR HEAD 9774f79 in total

krishagarwal278 · 2026-02-04T13:08:00Z

/retest

krishagarwal278 · 2026-02-04T18:10:14Z

/retest

openshift-ci-robot · 2026-02-04T22:50:46Z

/retest-required

Remaining retests: 0 against base HEAD d101674 and 1 for PR HEAD 9774f79 in total

openshift-ci-robot · 2026-02-05T14:51:11Z

/retest-required

Remaining retests: 0 against base HEAD 61387af and 0 for PR HEAD 9774f79 in total

openshift-ci · 2026-02-05T20:35:31Z

@krishagarwal278: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jan 19, 2026

openshift-ci bot requested review from rhamilto and sg00dwin January 19, 2026 09:13

openshift-ci bot added component/core Related to console core functionality component/dev-console Related to dev-console component/shared Related to console-shared labels Jan 19, 2026

coderabbitai bot reviewed Jan 19, 2026

View reviewed changes

krishagarwal278 force-pushed the CONSOLE-4987 branch from 725889f to f26a5b3 Compare January 19, 2026 09:41

krishagarwal278 changed the title ~~CONSOLE-4987: Conditionally render Guided Tour based on capability and disable it for Console E2E tests~~ [WIP] CONSOLE-4987: Conditionally render Guided Tour based on capability and disable it for Console E2E tests Jan 19, 2026

openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 19, 2026

coderabbitai bot reviewed Jan 19, 2026

View reviewed changes

krishagarwal278 force-pushed the CONSOLE-4987 branch 3 times, most recently from ff9fa0b to 9feb299 Compare January 19, 2026 12:00

openshift-ci bot added the component/backend Related to backend label Jan 20, 2026

krishagarwal278 changed the title ~~[WIP] CONSOLE-4987: Conditionally render Guided Tour based on capability and disable it for Console E2E tests~~ CONSOLE-4987: Conditionally render Guided Tour based on capability and disable it for Console E2E tests Jan 20, 2026

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 20, 2026

openshift-ci-robot added the verified Signifies that the PR passed pre-merge verification criteria label Jan 21, 2026

logonoff approved these changes Jan 21, 2026

View reviewed changes

openshift-ci bot assigned logonoff Jan 21, 2026

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jan 21, 2026

openshift-ci bot assigned sferich888 Feb 2, 2026

jseseCCS approved these changes Feb 2, 2026

View reviewed changes

openshift-ci bot added the docs-approved Signifies that Docs has signed off on this PR label Feb 2, 2026

jhadvig reviewed Feb 2, 2026

View reviewed changes

openshift-ci-robot removed the verified Signifies that the PR passed pre-merge verification criteria label Feb 2, 2026

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Feb 2, 2026

krishagarwal278 force-pushed the CONSOLE-4987 branch from 10df2be to c27e3f5 Compare February 2, 2026 16:43

Gate Guided Tour behind GuidedTour feature capability and update depe…

9774f79

…ndencies to vendor openshift/api with gudiedTour capability

krishagarwal278 force-pushed the CONSOLE-4987 branch from c27e3f5 to 9774f79 Compare February 2, 2026 16:45

openshift-ci bot added the px-approved Signifies that Product Support has signed off on this PR label Feb 2, 2026

jhadvig reviewed Feb 3, 2026

View reviewed changes

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Feb 3, 2026

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 3, 2026

openshift-ci-robot added the verified Signifies that the PR passed pre-merge verification criteria label Feb 4, 2026

Conversation

krishagarwal278 commented Jan 19, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

openshift-ci-robot commented Jan 19, 2026 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Uh oh!

openshift-ci-robot commented Jan 19, 2026 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

openshift-ci-robot commented Jan 19, 2026 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

krishagarwal278 commented Jan 19, 2026

Uh oh!

krishagarwal278 commented Jan 20, 2026

Uh oh!

yanpzhan commented Jan 21, 2026

Uh oh!

openshift-ci-robot commented Jan 21, 2026

Uh oh!

logonoff left a comment

Choose a reason for hiding this comment

Uh oh!

krishagarwal278 commented Jan 21, 2026

Uh oh!

openshift-ci bot commented Feb 2, 2026

Uh oh!

jseseCCS commented Feb 2, 2026

Uh oh!

jseseCCS commented Feb 2, 2026

Uh oh!

jseseCCS Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

jhadvig Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

jhadvig Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

jhadvig Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

rh-joshbeverly commented Feb 2, 2026

Uh oh!

krishagarwal278 commented Feb 3, 2026

Uh oh!

jhadvig left a comment

Choose a reason for hiding this comment

Uh oh!

krishagarwal278 commented Feb 3, 2026

Uh oh!

jhadvig commented Feb 3, 2026

Uh oh!

openshift-ci bot commented Feb 3, 2026

Uh oh!

yanpzhan commented Feb 4, 2026

Uh oh!

openshift-ci-robot commented Feb 4, 2026

Uh oh!

openshift-ci-robot commented Feb 4, 2026

Uh oh!

krishagarwal278 commented Feb 4, 2026

Uh oh!

krishagarwal278 commented Jan 19, 2026 •

edited by coderabbitai bot

Loading

openshift-ci-robot commented Jan 19, 2026 •

edited by openshift-ci bot

Loading

coderabbitai bot commented Jan 19, 2026 •

edited

Loading

openshift-ci-robot commented Jan 19, 2026 •

edited by openshift-ci bot

Loading

openshift-ci-robot commented Jan 19, 2026 •

edited by openshift-ci bot

Loading