Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Security Solution] Updates diff outcome logic to return CustomizedValueCanUpdate on scenario -AB #186435

Closed
wants to merge 2 commits into from
Closed

[Security Solution] Updates diff outcome logic to return CustomizedValueCanUpdate on scenario -AB #186435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d11c3c
updates logic to return certain missing version diff outcomes
dplumlee Jun 18, 2024
9fbf0cc
updates related unit tests
dplumlee Jun 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions ...n/api/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff_outcome.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,13 @@ export const determineDiffOutcome = <TValue>(
if (baseVersion === MissingVersion) {
/**
* We couldn't find the base version of the rule in the package so further
* version comparison is not possible. We assume that the rule is not
* customized and the value can be updated if there's an update.
* version comparison is not possible. We assume that the rule is not customized
* if both current and target versions are the same and customized if they
* are different.
*/
return currentEqlTarget
? ThreeWayDiffOutcome.StockValueNoUpdate
: ThreeWayDiffOutcome.StockValueCanUpdate;
: ThreeWayDiffOutcome.CustomizedValueCanUpdate;
}

if (baseEqlCurrent) {
Expand Down
4 changes: 2 additions & 2 deletions ...ion_engine/prebuilt_rules/logic/diff/calculation/algorithms/number_diff_algorithm.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,8 @@ describe('numberDiffAlgorithm', () => {
expect(result).toEqual(
expect.objectContaining({
merged_version: mockVersions.target_version,
diff_outcome: ThreeWayDiffOutcome.StockValueCanUpdate,
merge_outcome: ThreeWayMergeOutcome.Target,
diff_outcome: ThreeWayDiffOutcome.CustomizedValueCanUpdate,
merge_outcome: ThreeWayMergeOutcome.Merged,
has_conflict: false,
})
);
Expand Down
20 changes: 18 additions & 2 deletions ...etection_engine/prebuilt_rules/logic/diff/calculation/algorithms/simple_diff_algorithm.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import type {
ThreeWayDiff,
} from '../../../../../../../../common/api/detection_engine/prebuilt_rules';
import {
MissingVersion,
determineDiffOutcome,
determineIfValueCanUpdate,
ThreeWayDiffOutcome,
Expand All @@ -34,7 +35,8 @@ export const simpleDiffAlgorithm = <TValue>(
const diffOutcome = determineDiffOutcome(baseVersion, currentVersion, targetVersion);
const valueCanUpdate = determineIfValueCanUpdate(diffOutcome);

const { mergeOutcome, mergedVersion } = mergeVersions({
const { mergeOutcome, mergedVersion, hasConflict } = mergeVersions({
baseVersion,
currentVersion,
targetVersion,
diffOutcome,
Expand All @@ -49,22 +51,25 @@ export const simpleDiffAlgorithm = <TValue>(
diff_outcome: diffOutcome,
merge_outcome: mergeOutcome,
has_update: valueCanUpdate,
has_conflict: mergeOutcome === ThreeWayMergeOutcome.Conflict,
has_conflict: hasConflict,
};
};

interface MergeResult<TValue> {
mergeOutcome: ThreeWayMergeOutcome;
mergedVersion: TValue;
hasConflict: boolean;
}

interface MergeArgs<TValue> {
baseVersion: TValue | MissingVersion;
currentVersion: TValue;
targetVersion: TValue;
diffOutcome: ThreeWayDiffOutcome;
}

const mergeVersions = <TValue>({
baseVersion,
currentVersion,
targetVersion,
diffOutcome,
Expand All @@ -76,18 +81,29 @@ const mergeVersions = <TValue>({
return {
mergeOutcome: ThreeWayMergeOutcome.Current,
mergedVersion: currentVersion,
hasConflict: false,
};
}
case ThreeWayDiffOutcome.StockValueCanUpdate: {
return {
mergeOutcome: ThreeWayMergeOutcome.Target,
mergedVersion: targetVersion,
hasConflict: false,
};
}
case ThreeWayDiffOutcome.CustomizedValueCanUpdate: {
// Case for -AB scenario
if (baseVersion === MissingVersion) {
return {
mergeOutcome: ThreeWayMergeOutcome.Merged,
mergedVersion: targetVersion,
hasConflict: false,
};
}
return {
mergeOutcome: ThreeWayMergeOutcome.Conflict,
mergedVersion: currentVersion,
hasConflict: true,
};
}
default:
Expand Down
4 changes: 2 additions & 2 deletions ...rebuilt_rules/logic/diff/calculation/algorithms/single_line_string_diff_algorithm.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,8 @@ describe('singleLineStringDiffAlgorithm', () => {
expect(result).toEqual(
expect.objectContaining({
merged_version: mockVersions.target_version,
diff_outcome: ThreeWayDiffOutcome.StockValueCanUpdate,
merge_outcome: ThreeWayMergeOutcome.Target,
diff_outcome: ThreeWayDiffOutcome.CustomizedValueCanUpdate,
merge_outcome: ThreeWayMergeOutcome.Merged,
has_conflict: false,
})
);
Expand Down
24 changes: 12 additions & 12 deletions ...nt/prebuilt_rules/management/trial_license_complete_tier/upgrade_review_prebuilt_rules.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,8 +306,8 @@ export default ({ getService }: FtrProviderContext): void => {
current_version: 1,
target_version: 2,
merged_version: 2,
diff_outcome: ThreeWayDiffOutcome.StockValueCanUpdate,
merge_outcome: ThreeWayMergeOutcome.Target,
diff_outcome: ThreeWayDiffOutcome.CustomizedValueCanUpdate,
merge_outcome: ThreeWayMergeOutcome.Merged,
has_conflict: false,
has_update: true,
},
Expand Down Expand Up @@ -350,17 +350,17 @@ export default ({ getService }: FtrProviderContext): void => {
current_version: 'B',
target_version: 'C',
merged_version: 'C',
diff_outcome: ThreeWayDiffOutcome.StockValueCanUpdate,
merge_outcome: ThreeWayMergeOutcome.Target,
diff_outcome: ThreeWayDiffOutcome.CustomizedValueCanUpdate,
merge_outcome: ThreeWayMergeOutcome.Merged,
has_conflict: false,
has_update: true,
},
version: {
current_version: 1,
target_version: 2,
merged_version: 2,
diff_outcome: ThreeWayDiffOutcome.StockValueCanUpdate,
merge_outcome: ThreeWayMergeOutcome.Target,
diff_outcome: ThreeWayDiffOutcome.CustomizedValueCanUpdate,
merge_outcome: ThreeWayMergeOutcome.Merged,
has_conflict: false,
has_update: true,
},
Expand Down Expand Up @@ -645,8 +645,8 @@ export default ({ getService }: FtrProviderContext): void => {
current_version: 1,
target_version: 2,
merged_version: 2,
diff_outcome: ThreeWayDiffOutcome.StockValueCanUpdate,
merge_outcome: ThreeWayMergeOutcome.Target,
diff_outcome: ThreeWayDiffOutcome.CustomizedValueCanUpdate,
merge_outcome: ThreeWayMergeOutcome.Merged,
has_conflict: false,
has_update: true,
},
Expand Down Expand Up @@ -689,17 +689,17 @@ export default ({ getService }: FtrProviderContext): void => {
current_version: 2,
target_version: 3,
merged_version: 3,
diff_outcome: ThreeWayDiffOutcome.StockValueCanUpdate,
merge_outcome: ThreeWayMergeOutcome.Target,
diff_outcome: ThreeWayDiffOutcome.CustomizedValueCanUpdate,
merge_outcome: ThreeWayMergeOutcome.Merged,
has_conflict: false,
has_update: true,
},
version: {
current_version: 1,
target_version: 2,
merged_version: 2,
diff_outcome: ThreeWayDiffOutcome.StockValueCanUpdate,
merge_outcome: ThreeWayMergeOutcome.Target,
diff_outcome: ThreeWayDiffOutcome.CustomizedValueCanUpdate,
merge_outcome: ThreeWayMergeOutcome.Merged,
has_conflict: false,
has_update: true,
},
Expand Down