Skip to content

UI: Hide User Card from config.userCard.enabled option#10545

Merged
DaanHoogland merged 1 commit intoapache:mainfrom
OlegChuev:feature/hide-user-card-with-config
Aug 29, 2025
Merged

UI: Hide User Card from config.userCard.enabled option#10545
DaanHoogland merged 1 commit intoapache:mainfrom
OlegChuev:feature/hide-user-card-with-config

Conversation

@OlegChuev
Copy link
Copy Markdown
Contributor

@OlegChuev OlegChuev commented Mar 11, 2025

Description

This PR makes the User Card toggleable via config.json, which is particularly useful when users shouldn’t be aware of API docs or other information.

Types of changes

  • Breaking change (fix or feature that would cause existing functionality to change)
  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (improves an existing feature and functionality)
  • Cleanup (Code refactoring and cleanup, that may add test cases)
  • build/CI
  • test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

  • Major
  • Minor

Bug Severity

  • BLOCKER
  • Critical
  • Major
  • Minor
  • Trivial

Screenshots (if appropriate):

With "enabled": true and when enabled absent from the config.json
image

With "enabled": false:

image

How Has This Been Tested?

How did you try to break this feature and the system with this change?

@DaanHoogland
Copy link
Copy Markdown
Contributor

DaanHoogland commented Mar 12, 2025

@blueorangutan ui

@DaanHoogland DaanHoogland added this to the 4.21.0 milestone Mar 12, 2025
@blueorangutan
Copy link
Copy Markdown

blueorangutan commented Mar 12, 2025

@DaanHoogland a Jenkins job has been kicked to build UI QA env. I'll keep you posted as I make progress.

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 12, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 16.26%. Comparing base (b387bc1) to head (4632795).
⚠️ Report is 467 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff            @@
##               main   #10545   +/-   ##
=========================================
  Coverage     16.26%   16.26%           
  Complexity    13389    13389           
=========================================
  Files          5674     5674           
  Lines        498927   498927           
  Branches      60337    60337           
=========================================
+ Hits          81157    81159    +2     
+ Misses       408729   408728    -1     
+ Partials       9041     9040    -1
Flag Coverage Δ
uitests 3.99% <ø> (ø)
unittests 17.12% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@blueorangutan
Copy link
Copy Markdown

blueorangutan commented Mar 12, 2025

UI build: ✔️
Live QA URL: https://qa.cloudstack.cloud/simulator/pr/10545 (QA-JID-576)

@bernardodemarco bernardodemarco self-requested a review March 14, 2025 15:05
bernardodemarco
bernardodemarco approved these changes Apr 4, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@bernardodemarco bernardodemarco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, manually tested it

  1. I locally ran the UI environment (npm run start)
  2. Accessed the ui/public/config.json file and changed the enabled property of the userCard object from true to false
  3. Verified that the card was not displayed to end users:
    image
  4. Changed the enabled property back to true and verified that the card was correctly displayed to end users:
    image

@sureshanaparti sureshanaparti moved this to In Progress in Apache CloudStack 4.21.0 Jun 5, 2025
@fmaximus
Copy link
Copy Markdown
Contributor

fmaximus commented Jul 1, 2025

Can we maybe also rename it to helpCard, as the name userCard is completely wrong.

@RosiKyu RosiKyu assigned RosiKyu and unassigned RosiKyu Aug 16, 2025
@weizhouapache weizhouapache modified the milestones: 4.21.0, 4.22.0 Aug 29, 2025
@vishesh92 vishesh92 requested a review from Copilot August 29, 2025 09:10
Copilot AI reviewed Aug 29, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds the ability to hide the User Card component from the dashboard via a configuration option. The enhancement allows administrators to control whether users can see the User Card, which may contain API documentation or other sensitive information.

  • Adds a configurable enabled property to the userCard configuration object
  • Implements conditional rendering of the User Card component based on the configuration setting
  • Defaults to showing the User Card when the configuration is not specified (backwards compatibility)

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
ui/src/views/dashboard/UsageDashboard.vue Adds conditional rendering logic to hide/show User Card based on config
ui/public/config.json Adds the enabled property to userCard configuration with default value

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

DaanHoogland
DaanHoogland approved these changes Aug 29, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@DaanHoogland DaanHoogland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clgtm

vishesh92
vishesh92 approved these changes Aug 29, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@vishesh92 vishesh92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm. didn't test.

@DaanHoogland DaanHoogland merged commit 2105794 into apache:main Aug 29, 2025
25 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in Apache CloudStack 4.22.0 Aug 29, 2025
dhslove pushed a commit to ablecloud-team/ablestack-cloud that referenced this pull request Sep 4, 2025
@OlegChuev @OlegChuev-MD @dhslove
UI: Hide User Card from config.userCard.enabled option (apache#10545)
8f39af2 
Co-authored-by: OlegChuev <o.chuev@mobidev.biz>
@sudo87 sudo87 mentioned this pull request Dec 10, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@DaanHoogland DaanHoogland DaanHoogland approved these changes

@vishesh92 vishesh92 vishesh92 approved these changes

@bernardodemarco bernardodemarco bernardodemarco approved these changes

@shwstppr shwstppr Awaiting requested review from shwstppr

Assignees

No one assigned

Labels

component:UI

Projects

No open projects
Apache CloudStack 4.22.0
Status: Done

Milestone

4.22.0

Development

Successfully merging this pull request may close these issues.