Use more specific types and rename newTransformValidate

Author: marshallmain

x-pack/plugins/security_solution/common/detection_engine/schemas/response/rules_schema.mocks.ts

@@ -6,7 +6,12 @@
  */
 
 import { DEFAULT_INDICATOR_SOURCE_PATH } from '../../../constants';
-import type { FullResponseSchema } from '../request';
+import type {
+  EqlResponseSchema,
+  MachineLearningResponseSchema,
+  QueryResponseSchema,
+  ThreatMatchResponseSchema,
+} from '../request';
 import { getListArrayMock } from '../types/lists.mock';
 
 export const ANCHOR_DATE = '2020-02-20T03:57:54.037Z';
@@ -58,7 +63,7 @@ const getResponseBaseParams = (anchorDate: string = ANCHOR_DATE) => ({
   namespace: undefined,
 });
 
-export const getRulesSchemaMock = (anchorDate: string = ANCHOR_DATE): FullResponseSchema => ({
+export const getRulesSchemaMock = (anchorDate: string = ANCHOR_DATE): QueryResponseSchema => ({
   ...getResponseBaseParams(anchorDate),
   query: 'user.name: root or user.name: admin',
   type: 'query',
@@ -69,7 +74,9 @@ export const getRulesSchemaMock = (anchorDate: string = ANCHOR_DATE): FullRespon
   saved_id: undefined,
 });
 
-export const getRulesMlSchemaMock = (anchorDate: string = ANCHOR_DATE): FullResponseSchema => {
+export const getRulesMlSchemaMock = (
+  anchorDate: string = ANCHOR_DATE
+): MachineLearningResponseSchema => {
   return {
     ...getResponseBaseParams(anchorDate),
     type: 'machine_learning',
@@ -80,7 +87,7 @@ export const getRulesMlSchemaMock = (anchorDate: string = ANCHOR_DATE): FullResp
 
 export const getThreatMatchingSchemaMock = (
   anchorDate: string = ANCHOR_DATE
-): FullResponseSchema => {
+): ThreatMatchResponseSchema => {
   return {
     ...getResponseBaseParams(anchorDate),
     type: 'threat_match',
@@ -124,7 +131,7 @@ export const getThreatMatchingSchemaMock = (
  */
 export const getThreatMatchingSchemaPartialMock = (
   enabled = false
-): Partial<FullResponseSchema> => {
+): Partial<ThreatMatchResponseSchema> => {
   return {
     author: [],
     created_by: 'elastic',
@@ -193,7 +200,7 @@ export const getThreatMatchingSchemaPartialMock = (
   };
 };
 
-export const getRulesEqlSchemaMock = (anchorDate: string = ANCHOR_DATE): FullResponseSchema => {
+export const getRulesEqlSchemaMock = (anchorDate: string = ANCHOR_DATE): EqlResponseSchema => {
   return {
     ...getResponseBaseParams(anchorDate),
     language: 'eql',

x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/create_rules_route.ts

@@ -16,7 +16,7 @@ import { readRules } from '../../rules/read_rules';
 import { buildSiemResponse } from '../utils';
 
 import { createRulesSchema } from '../../../../../common/detection_engine/schemas/request';
-import { newTransformValidate } from './validate';
+import { transformValidate } from './validate';
 import { createRuleValidateTypeDependents } from '../../../../../common/detection_engine/schemas/request/create_rules_type_dependents';
 import { createRules } from '../../rules/create_rules';
 
@@ -85,7 +85,7 @@ export const createRulesRoute = (
 
         const ruleExecutionSummary = await ruleExecutionLog.getExecutionSummary(createdRule.id);
 
-        const [validated, errors] = newTransformValidate(createdRule, ruleExecutionSummary);
+        const [validated, errors] = transformValidate(createdRule, ruleExecutionSummary);
         if (errors != null) {
           return siemResponse.error({ statusCode: 500, body: errors });
         } else {

x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/patch_rules_route.ts

@@ -18,7 +18,7 @@ import { patchRules } from '../../rules/patch_rules';
 import { buildSiemResponse } from '../utils';
 
 import { getIdError } from './utils';
-import { newTransformValidate } from './validate';
+import { transformValidate } from './validate';
 import { readRules } from '../../rules/read_rules';
 import { legacyMigrate } from '../../rules/utils';
 
@@ -83,7 +83,7 @@ export const patchRulesRoute = (router: SecuritySolutionPluginRouter, ml: SetupP
         if (rule != null && rule.enabled != null && rule.name != null) {
           const ruleExecutionSummary = await ruleExecutionLog.getExecutionSummary(rule.id);
 
-          const [validated, errors] = newTransformValidate(rule, ruleExecutionSummary);
+          const [validated, errors] = transformValidate(rule, ruleExecutionSummary);
           if (errors != null) {
             return siemResponse.error({ statusCode: 500, body: errors });
           } else {

x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/update_rules_route.ts

@@ -16,7 +16,7 @@ import { throwAuthzError } from '../../../machine_learning/validation';
 import { buildSiemResponse } from '../utils';
 
 import { getIdError } from './utils';
-import { newTransformValidate } from './validate';
+import { transformValidate } from './validate';
 import { updateRules } from '../../rules/update_rules';
 import { buildRouteValidation } from '../../../../utils/build_validation/route_validation';
 import { legacyMigrate } from '../../rules/utils';
@@ -73,7 +73,7 @@ export const updateRulesRoute = (router: SecuritySolutionPluginRouter, ml: Setup
         if (rule != null) {
           const ruleExecutionLog = ctx.securitySolution.getRuleExecutionLog();
           const ruleExecutionSummary = await ruleExecutionLog.getExecutionSummary(rule.id);
-          const [validated, errors] = newTransformValidate(rule, ruleExecutionSummary);
+          const [validated, errors] = transformValidate(rule, ruleExecutionSummary);
           if (errors != null) {
             return siemResponse.error({ statusCode: 500, body: errors });
           } else {

x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/validate.test.ts

@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { newTransformValidate, transformValidateBulkError } from './validate';
+import { transformValidate, transformValidateBulkError } from './validate';
 import type { BulkError } from '../utils';
 import { getRuleMock } from '../__mocks__/request_responses';
 import { ruleExecutionSummaryMock } from '../../../../../common/detection_engine/rule_monitoring/mocks';
@@ -82,7 +82,7 @@ describe('validate', () => {
   describe('transformValidate', () => {
     test('it should do a validation correctly of a partial alert', () => {
       const ruleAlert = getRuleMock(getQueryRuleParams());
-      const [validated, errors] = newTransformValidate(ruleAlert, null);
+      const [validated, errors] = transformValidate(ruleAlert, null);
       expect(validated).toEqual(ruleOutput());
       expect(errors).toEqual(null);
     });
@@ -91,7 +91,7 @@ describe('validate', () => {
       const ruleAlert = getRuleMock(getQueryRuleParams());
       // @ts-expect-error
       delete ruleAlert.name;
-      const [validated, errors] = newTransformValidate(ruleAlert, null);
+      const [validated, errors] = transformValidate(ruleAlert, null);
       expect(validated).toEqual(null);
       expect(errors).toEqual('Invalid value "undefined" supplied to "name"');
     });

x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/validate.ts

@@ -20,7 +20,7 @@ import type { RuleParams } from '../../schemas/rule_schemas';
 import type { LegacyRulesActionsSavedObject } from '../../rule_actions/legacy_get_rule_actions_saved_object';
 import { internalRuleToAPIResponse } from '../../schemas/rule_converters';
 
-export const newTransformValidate = (
+export const transformValidate = (
   rule: PartialRule<RuleParams>,
   ruleExecutionSummary: RuleExecutionSummary | null,
   legacyRuleActions?: LegacyRulesActionsSavedObject | null