[Cloud Security] Versioning CSP rules type and api #172674

CohenIdo · 2023-12-06T13:06:47Z

This PR includes:

Versioning for types of CSP rules
Versioning for the CSP rules find API
Global renaming of csp_rule_template to csp_benchmark_rule throughout the code.

kfirpeled

LGTM 🚀

I added bunch of nit's
Prefer to use import type when possible

And I think of maybe rename CspRule to CspBenchmarkRule. To give more context to any kibana developer outside of our team. wdyt?

x-pack/plugins/cloud_security_posture/common/types.ts

x-pack/plugins/cloud_security_posture/common/types/index.ts

x-pack/plugins/cloud_security_posture/common/types/rules/v2.ts

x-pack/plugins/cloud_security_posture/public/pages/rules/rules_container.test.tsx

x-pack/plugins/cloud_security_posture/server/routes/rules/find/find_csp_rule.ts

kfirpeled · 2023-12-06T15:28:49Z

x-pack/plugins/cloud_security_posture/server/routes/rules/find/find_csp_rule.ts

+          request: {
+            query: findCspRuleRequest,
+          },
+        },


nit: consider to add response validation on the next PR/open a tech debt issue

Add Response Verification to Find CSP Benchmark Rule API #172800

x-pack/plugins/cloud_security_posture/server/routes/rules/find/v1.ts

x-pack/test/api_integration/apis/cloud_security_posture/find_csp_rule.ts

...test_serverless/api_integration/test_suites/security/cloud_security_posture/find_csp_rule.ts

kfirpeled · 2023-12-06T16:33:25Z

x-pack/plugins/cloud_security_posture/server/routes/rules/find/find_csp_rule.ts

+export const getSortedCspRulesTemplates = (cspRulesTemplates: CspRule[]) => {
+  return cspRulesTemplates.slice().sort((a, b) => {
+    const ruleNumberA = a?.metadata?.benchmark?.rule_number;
+    const ruleNumberB = b?.metadata?.benchmark?.rule_number;
+
+    const versionA = semverValid(ruleNumberA);
+    const versionB = semverValid(ruleNumberB);
+
+    if (versionA !== null && versionB !== null) {
+      return semverCompare(versionA, versionB);
+    } else {
+      return String(ruleNumberA).localeCompare(String(ruleNumberB));
+    }
+  });
+};
+
+export const getBenchmarkIdFromPackagePolicyId = async (
+  soClient: SavedObjectsClientContract,
+  packagePolicyId: string
+): Promise<string> => {
+  const res = await soClient.get<NewPackagePolicy>(
+    PACKAGE_POLICY_SAVED_OBJECT_TYPE,
+    packagePolicyId
+  );
+  return getBenchmarkFromPackagePolicy(res.attributes.inputs);
+};


move the a utility.ts/common.ts under the same folder to prevent circular dependencies

x-pack/plugins/cloud_security_posture/common/types/rules/v3.ts

CohenIdo · 2023-12-06T17:45:52Z

maybe rename CspRule to CspBenchmarkRule. To give more context to any kibana developer outside of our team. wdyt?

I agree, will do.

kfirpeled

💯
added another couple of comments

kfirpeled · 2023-12-06T21:03:08Z

x-pack/plugins/cloud_security_posture/public/pages/rules/rules_container.tsx

@@ -7,20 +7,20 @@
 import React, { useState, useMemo } from 'react';
 import { EuiPanel, EuiSpacer } from '@elastic/eui';
 import { useParams } from 'react-router-dom';
-import { CspRuleTemplate } from '../../../common/schemas';
+import { CspBenchmarkRule } from '../../../common/types/latest';


use import type

kfirpeled · 2023-12-06T21:07:26Z

x-pack/plugins/cloud_security_posture/server/routes/rules/find/find_csp_rule.ts

+export const getSortedCspBenchmarkRulesTemplates = (cspBenchmarkRules: CspBenchmarkRule[]) => {
+  return cspBenchmarkRules.slice().sort((a, b) => {
+    const ruleNumberA = a?.metadata?.benchmark?.rule_number;
+    const ruleNumberB = b?.metadata?.benchmark?.rule_number;
+
+    const versionA = semverValid(ruleNumberA);
+    const versionB = semverValid(ruleNumberB);
+
+    if (versionA !== null && versionB !== null) {
+      return semverCompare(versionA, versionB);
+    } else {
+      return String(ruleNumberA).localeCompare(String(ruleNumberB));
+    }
+  });
+};
+
+export const getBenchmarkIdFromPackagePolicyId = async (
+  soClient: SavedObjectsClientContract,
+  packagePolicyId: string
+): Promise<string> => {
+  const res = await soClient.get<NewPackagePolicy>(
+    PACKAGE_POLICY_SAVED_OBJECT_TYPE,
+    packagePolicyId
+  );
+  return getBenchmarkFromPackagePolicy(res.attributes.inputs);
+};


move the a utility.ts/common.ts under the same folder to prevent circular dependencies

…fix'

…-fix'

…fix'

kibana-ci · 2023-12-07T16:35:42Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: b576b5b

Failed CI Steps

Detection Engine - Security Solution Cypress Tests #6

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`cloudSecurityPosture`	446.3KB	446.3KB	+8.0B

History

💔 Build #182519 failed 603e0e6
💔 Build #182504 failed e9109a1
💔 Build #182467 failed 06f697ad76e386cc32bb9b440423829c7bdb1c4b
💔 Build #182455 failed b2c606c1376702b40147b2f57cc1d4e4a67d26aa
💔 Build #182427 failed fdd45a07b16e2580b24e7eeff4580e4ea57fe9a2
💔 Build #182408 failed d33a9d7d2816a00c2a06e32fa53593d2df539c9f

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

kfirpeled · 2023-12-12T18:49:46Z

x-pack/plugins/cloud_security_posture/server/routes/benchmark_rules/find/find.ts

+  FindCspBenchmarkRuleRequest,
+  FindCspBenchmarkRuleResponse,
+  findCspBenchmarkRuleRequestSchema,
+} from '../../../../common/types/latest';


better to explicitly use v1 here instead
think of the use case of adding a newer version

👍 will do as part of #173066

https://github.com/elastic/kibana/pull/173066/files#diff-75f8ea25f299cb586a1a72930204fefeed06db979233f267c60b0a48fa8a96efR12

kfirpeled · 2023-12-12T18:50:37Z

x-pack/plugins/cloud_security_posture/server/routes/benchmark_rules/find/v1.ts

+import { PACKAGE_POLICY_SAVED_OBJECT_TYPE } from '../../benchmarks/benchmarks';
+import { getBenchmarkFromPackagePolicy } from '../../../../common/utils/helpers';
+
+import type {


this should explicitly use v1 here instead (FindCspBenchmarkRuleRequest and FindCspBenchmarkRuleResponse only. the SO should always be the latest)
think of the use case of adding a newer version

👍 will do as part of #173066

elasticmachine · 2024-01-17T21:05:26Z

Pinging @elastic/kibana-cloud-security-posture (Team:Cloud Security)

bhavyarm · 2024-01-17T21:06:14Z

Hey team, bunch of PRs were missing the team label. I added the labels in. Thanks!

CohenIdo added 5 commits December 6, 2023 14:28

refactor rules types

107476e

refactor find rule api

4554367

refactor cspRuleTemplate to cspRule

d7e61db

refactor cspRuleTemplate to cspRule

d5c15be

refactor cspRuleTemplate to cspRule

ac2e27d

CohenIdo added the release_note:skip Skip the PR/issue when compiling release notes label Dec 6, 2023

CohenIdo marked this pull request as ready for review December 6, 2023 13:07

CohenIdo requested a review from a team as a code owner December 6, 2023 13:07

kfirpeled approved these changes Dec 6, 2023

View reviewed changes

kfirpeled reviewed Dec 6, 2023

View reviewed changes

x-pack/plugins/cloud_security_posture/common/types/rules/v3.ts Outdated Show resolved Hide resolved

code review comments

8cd05f0

CohenIdo force-pushed the rules-types-versioning branch from 95324e8 to 8cd05f0 Compare December 6, 2023 17:48

CohenIdo added 2 commits December 6, 2023 20:05

change cspRule to cspBenchmarkRule

bef120c

change cspRule to cspBenchmarkRule

29b357f

kfirpeled approved these changes Dec 6, 2023

View reviewed changes

Merge remote-tracking branch 'upstream/main' into rules-types-versioning

fcf536a

CohenIdo force-pushed the rules-types-versioning branch from 2cad88c to fcf536a Compare December 7, 2023 08:38

refactor cspRuleTemplate to cspRule

92a0e64

CohenIdo force-pushed the rules-types-versioning branch from 0b31a76 to 92a0e64 Compare December 7, 2023 09:20

CohenIdo added 2 commits December 7, 2023 11:21

Merge remote-tracking branch 'upstream/main' into rules-types-versioning

9cc8af6

refactor cspRuleTemplate to cspRule

d9d2723

CohenIdo force-pushed the rules-types-versioning branch from 67aef70 to d9d2723 Compare December 7, 2023 09:49

CohenIdo added 2 commits December 7, 2023 11:53

rename common/types to common/types_old

f3fbc91

rename common/types to common/types_old

cbfab6d

CohenIdo force-pushed the rules-types-versioning branch from fdd45a0 to cbfab6d Compare December 7, 2023 12:19

CohenIdo added 3 commits December 7, 2023 14:19

Merge remote-tracking branch 'upstream/main' into rules-types-versioning

dc6f64a

ts check error

516a0a1

Merge remote-tracking branch 'upstream/main' into rules-types-versioning

636d53a

CohenIdo force-pushed the rules-types-versioning branch from 06f697a to 636d53a Compare December 7, 2023 14:23

kibanamachine added 3 commits December 7, 2023 14:30

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

e9109a1

…fix'

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

603e0e6

…-fix'

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

b576b5b

…fix'

CohenIdo merged commit d4701aa into elastic:main Dec 7, 2023
37 checks passed

kibanamachine added v8.13.0 backport:skip This commit does not require backporting labels Dec 7, 2023

kfirpeled reviewed Dec 12, 2023

View reviewed changes

bhavyarm added the Team:Cloud Security Cloud Security team related label Jan 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Cloud Security] Versioning CSP rules type and api #172674

[Cloud Security] Versioning CSP rules type and api #172674

CohenIdo commented Dec 6, 2023 •

edited

Loading

kfirpeled left a comment

kfirpeled Dec 6, 2023

CohenIdo Dec 7, 2023 •

edited

Loading

kfirpeled Dec 6, 2023

CohenIdo commented Dec 6, 2023

kfirpeled left a comment

kfirpeled Dec 6, 2023

kfirpeled Dec 6, 2023

kibana-ci commented Dec 7, 2023

kfirpeled Dec 12, 2023

CohenIdo Dec 14, 2023

CohenIdo Dec 14, 2023

kfirpeled Dec 12, 2023 •

edited

Loading

CohenIdo Dec 14, 2023

elasticmachine commented Jan 17, 2024

bhavyarm commented Jan 17, 2024

[Cloud Security] Versioning CSP rules type and api #172674

[Cloud Security] Versioning CSP rules type and api #172674

Conversation

CohenIdo commented Dec 6, 2023 • edited Loading

kfirpeled left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CohenIdo Dec 7, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CohenIdo commented Dec 6, 2023

kfirpeled left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kibana-ci commented Dec 7, 2023

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Async chunks

History

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kfirpeled Dec 12, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Jan 17, 2024

bhavyarm commented Jan 17, 2024

CohenIdo commented Dec 6, 2023 •

edited

Loading

CohenIdo Dec 7, 2023 •

edited

Loading

kfirpeled Dec 12, 2023 •

edited

Loading