Skip to content

Commit

Permalink
[8.18] [refactoring] Distinguish User Controls from Risk Engine in Da…
Browse files Browse the repository at this point in the history
…shboardEnablementPanel (elastic#212441) (elastic#212519)

# Backport

This will backport the following commits from `main` to `8.18`:
- [[refactoring] Distinguish User Controls from Risk Engine in
DashboardEnablementPanel
(elastic#212441)](elastic#212441)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Charlotte Alexandra
Wilson","email":"CAWilson94@users.noreply.github.com"},"sourceCommit":{"committedDate":"2025-02-26T13:29:21Z","message":"[refactoring]
Distinguish User Controls from Risk Engine in DashboardEnablementPanel
(elastic#212441)\n\n## Summary\nThis PR refactors naming and logic in
EntityStoreEnablementModal to\nimprove readability and better
distinguish between:\n1. Feature enablement state – Whether Risk Score
or Entity Store is\nactually enabled.\n2. User-selected state – Whether
the user has checked the corresponding\ntoggle.\n\n#### Changes\n\n-
Renamed disabled → canToggle to clearly represent UI interaction.\n-
Renamed enablements → userSelectedEnablements to reflect
user-selected\ntoggle states, not feature enablement.\n- Refactored
shouldAllowEnablement logic for clarity and correctness:\n- If riskScore
is enabled, return whether the user has enabled\nentityStore.\n- If
entityStore is enabled, return whether the user has
enabled\nriskScore.\n - Otherwise, return true if either toggle is
selected.\n- Updated corresponding tests to reflect naming and logic
changes.\n\n## Testing/Validation\nManually tested the toggling
behaviour still works as before and modal\nstill shows warning, and
disables the \"enable\" button when there are no\navailable options
selected.\n\n### Validation
Video\n\n\nhttps://github.com/user-attachments/assets/0f2a3f59-e2a0-4c8b-a350-70a9573a8566","sha":"874cee2c575efe75ede0702ac243855abe008a69","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["refactoring","release_note:skip","v9.0.0","Theme:
entity_analytics","Team:Entity
Analytics","backport:version","v8.17.0","v8.18.0","v9.1.0","v8.19.0"],"title":"[refactoring]
Distinguish User Controls from Risk Engine in DashboardEnablementPanel
","number":212441,"url":"https://github.com/elastic/kibana/pull/212441","mergeCommit":{"message":"[refactoring]
Distinguish User Controls from Risk Engine in DashboardEnablementPanel
(elastic#212441)\n\n## Summary\nThis PR refactors naming and logic in
EntityStoreEnablementModal to\nimprove readability and better
distinguish between:\n1. Feature enablement state – Whether Risk Score
or Entity Store is\nactually enabled.\n2. User-selected state – Whether
the user has checked the corresponding\ntoggle.\n\n#### Changes\n\n-
Renamed disabled → canToggle to clearly represent UI interaction.\n-
Renamed enablements → userSelectedEnablements to reflect
user-selected\ntoggle states, not feature enablement.\n- Refactored
shouldAllowEnablement logic for clarity and correctness:\n- If riskScore
is enabled, return whether the user has enabled\nentityStore.\n- If
entityStore is enabled, return whether the user has
enabled\nriskScore.\n - Otherwise, return true if either toggle is
selected.\n- Updated corresponding tests to reflect naming and logic
changes.\n\n## Testing/Validation\nManually tested the toggling
behaviour still works as before and modal\nstill shows warning, and
disables the \"enable\" button when there are no\navailable options
selected.\n\n### Validation
Video\n\n\nhttps://github.com/user-attachments/assets/0f2a3f59-e2a0-4c8b-a350-70a9573a8566","sha":"874cee2c575efe75ede0702ac243855abe008a69"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.17","8.18","8.x"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.17","label":"v8.17.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/212441","number":212441,"mergeCommit":{"message":"[refactoring]
Distinguish User Controls from Risk Engine in DashboardEnablementPanel
(elastic#212441)\n\n## Summary\nThis PR refactors naming and logic in
EntityStoreEnablementModal to\nimprove readability and better
distinguish between:\n1. Feature enablement state – Whether Risk Score
or Entity Store is\nactually enabled.\n2. User-selected state – Whether
the user has checked the corresponding\ntoggle.\n\n#### Changes\n\n-
Renamed disabled → canToggle to clearly represent UI interaction.\n-
Renamed enablements → userSelectedEnablements to reflect
user-selected\ntoggle states, not feature enablement.\n- Refactored
shouldAllowEnablement logic for clarity and correctness:\n- If riskScore
is enabled, return whether the user has enabled\nentityStore.\n- If
entityStore is enabled, return whether the user has
enabled\nriskScore.\n - Otherwise, return true if either toggle is
selected.\n- Updated corresponding tests to reflect naming and logic
changes.\n\n## Testing/Validation\nManually tested the toggling
behaviour still works as before and modal\nstill shows warning, and
disables the \"enable\" button when there are no\navailable options
selected.\n\n### Validation
Video\n\n\nhttps://github.com/user-attachments/assets/0f2a3f59-e2a0-4c8b-a350-70a9573a8566","sha":"874cee2c575efe75ede0702ac243855abe008a69"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Charlotte Alexandra Wilson <CAWilson94@users.noreply.github.com>
  • Loading branch information
kibanamachine and CAWilson94 authored Feb 27, 2025
1 parent 1bc5fbc commit 74665d2
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -223,11 +223,11 @@ export const EnablementPanel: React.FC<EnableEntityStorePanelProps> = ({ state }
toggle={(visible) => setModalState({ visible })}
enableStore={enableEntityStore}
riskScore={{
disabled: riskEngineStatus !== RiskEngineStatusEnum.NOT_INSTALLED,
canToggle: riskEngineStatus === RiskEngineStatusEnum.NOT_INSTALLED,
checked: riskEngineStatus === RiskEngineStatusEnum.NOT_INSTALLED,
}}
entityStore={{
disabled: entityStoreStatus === 'running',
canToggle: entityStoreStatus !== 'running',
checked: entityStoreStatus === 'not_installed',
}}
/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ const defaultProps = {
visible: true,
toggle: mockToggle,
enableStore: mockEnableStore,
riskScore: { disabled: false, checked: false },
entityStore: { disabled: false, checked: false },
riskScore: { canToggle: false, checked: false },
entityStore: { canToggle: false, checked: false },
};

const allEntityEnginePrivileges: EntityAnalyticsPrivileges = {
Expand Down Expand Up @@ -149,17 +149,17 @@ describe('EntityStoreEnablementModal', () => {
it('should show proceed warning when riskScore is enabled but entityStore is disabled and unchecked', () => {
renderComponent({
...defaultProps,
riskScore: { disabled: false, checked: false }, // Enabled & Checked
entityStore: { disabled: true, checked: false }, // Disabled & Unchecked
riskScore: { canToggle: false, checked: false }, // Enabled & Checked
entityStore: { canToggle: true, checked: false }, // Disabled & Unchecked
});
expect(screen.getByText('Please enable at least one option to proceed.')).toBeInTheDocument();
});

it('should show proceed warning when entityStore is enabled but riskScore is disabled and unchecked', () => {
renderComponent({
...defaultProps,
entityStore: { disabled: false, checked: false }, // Enabled & Checked
riskScore: { disabled: true, checked: false }, // Disabled & Unchecked
entityStore: { canToggle: false, checked: false }, // Enabled & Checked
riskScore: { canToggle: true, checked: false }, // Disabled & Unchecked
});
expect(screen.getByText('Please enable at least one option to proceed.')).toBeInTheDocument();
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,27 +45,27 @@ interface EntityStoreEnablementModalProps {
toggle: (visible: boolean) => void;
enableStore: (enablements: Enablements) => () => void;
riskScore: {
disabled?: boolean;
canToggle?: boolean;
checked?: boolean;
};
entityStore: {
disabled?: boolean;
canToggle?: boolean;
checked?: boolean;
};
}

const shouldAllowEnablement = (
riskScoreEnabled: boolean,
entityStoreEnabled: boolean,
enablements: Enablements
userHasEnabled: Enablements
) => {
if (riskScoreEnabled) {
return enablements.entityStore;
return userHasEnabled.entityStore;
}
if (entityStoreEnabled) {
return enablements.riskScore;
return userHasEnabled.riskScore;
}
return enablements.riskScore || enablements.entityStore;
return userHasEnabled.riskScore || userHasEnabled.entityStore;
};

export const EntityStoreEnablementModal: React.FC<EntityStoreEnablementModalProps> = ({
Expand All @@ -85,8 +85,8 @@ export const EntityStoreEnablementModal: React.FC<EntityStoreEnablementModalProp
const riskEnginePrivileges = useMissingRiskEnginePrivileges();

const enablementOptions = shouldAllowEnablement(
!!riskScore.disabled,
!!entityStore.disabled,
!riskScore.canToggle,
!entityStore.canToggle,
enablements
);
const { AdditionalChargesMessage } = useContractComponents();
Expand Down Expand Up @@ -129,7 +129,7 @@ export const EntityStoreEnablementModal: React.FC<EntityStoreEnablementModalProp
}
checked={enablements.riskScore}
disabled={
riskScore.disabled ||
!riskScore.canToggle ||
(!riskEnginePrivileges.isLoading && !riskEnginePrivileges?.hasAllRequiredPrivileges)
}
onChange={() => setEnablements((prev) => ({ ...prev, riskScore: !prev.riskScore }))}
Expand All @@ -156,7 +156,7 @@ export const EntityStoreEnablementModal: React.FC<EntityStoreEnablementModalProp
}
checked={enablements.entityStore}
disabled={
entityStore.disabled ||
!entityStore.canToggle ||
(!isLoadingEntityEnginePrivileges && !entityEnginePrivileges?.has_all_required)
}
onChange={() =>
Expand Down

0 comments on commit 74665d2

Please sign in to comment.