Updated deprecation message per PR comments

FrankHassanabad · FrankHassanabad · commit cdf4d8168d60 · 2021-09-27T14:19:22.000-06:00
diff --git a/x-pack/plugins/security_solution/common/constants.ts b/x-pack/plugins/security_solution/common/constants.ts
@@ -202,7 +202,7 @@ export const THRESHOLD_RULE_TYPE_ID = `${RULE_TYPE_PREFIX}.thresholdRule` as con
 
 /**
  * Id for the notifications alerting type
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export const LEGACY_NOTIFICATIONS_ID = `siem.notifications`;
 
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/notifications/legacy_add_tags.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/notifications/legacy_add_tags.ts
@@ -8,7 +8,7 @@
 import { INTERNAL_RULE_ALERT_ID_KEY } from '../../../../common/constants';
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export const legacyAddTags = (tags: string[], ruleAlertId: string): string[] =>
   Array.from(new Set([...tags, `${INTERNAL_RULE_ALERT_ID_KEY}:${ruleAlertId}`]));
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/notifications/legacy_create_notifications.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/notifications/legacy_create_notifications.test.ts
@@ -10,7 +10,7 @@ import { rulesClientMock } from '../../../../../alerting/server/mocks';
 import { legacyCreateNotifications } from './legacy_create_notifications';
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 describe('legacyCreateNotifications', () => {
   let rulesClient: ReturnType<typeof rulesClientMock.create>;
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/notifications/legacy_create_notifications.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/notifications/legacy_create_notifications.ts
@@ -13,7 +13,7 @@ import { CreateNotificationParams, LegacyRuleNotificationAlertTypeParams } from
 import { legacyAddTags } from './legacy_add_tags';
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export const legacyCreateNotifications = async ({
   rulesClient,
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/notifications/legacy_find_notifications.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/notifications/legacy_find_notifications.ts
@@ -11,7 +11,7 @@ import { LEGACY_NOTIFICATIONS_ID } from '../../../../common/constants';
 import { LegacyFindNotificationParams } from './legacy_types';
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export const legacyGetFilter = (filter: string | null | undefined) => {
   if (filter == null) {
@@ -22,7 +22,7 @@ export const legacyGetFilter = (filter: string | null | undefined) => {
 };
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export const legacyFindNotifications = async ({
   rulesClient,
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/notifications/legacy_read_notifications.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/notifications/legacy_read_notifications.ts
@@ -13,7 +13,7 @@ import { legacyFindNotifications } from './legacy_find_notifications';
 import { INTERNAL_RULE_ALERT_ID_KEY } from '../../../../common/constants';
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export const legacyReadNotifications = async ({
   rulesClient,
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/notifications/legacy_rules_notification_alert_type.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/notifications/legacy_rules_notification_alert_type.test.ts
@@ -25,7 +25,7 @@ import { getQueryRuleParams } from '../schemas/rule_schemas.mock';
 jest.mock('./build_signals_query');
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 describe('legacyRules_notification_alert_type', () => {
   let payload: LegacyNotificationExecutorOptions;
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/notifications/legacy_rules_notification_alert_type.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/notifications/legacy_rules_notification_alert_type.ts
@@ -23,7 +23,7 @@ import { getNotificationResultsLink } from './utils';
 import { getSignals } from './get_signals';
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should also be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export const legacyRulesNotificationAlertType = ({
   logger,
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/notifications/legacy_types.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/notifications/legacy_types.ts
@@ -19,19 +19,19 @@ import { Alert, AlertAction } from '../../../../../alerting/common';
 import { LEGACY_NOTIFICATIONS_ID } from '../../../../common/constants';
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export interface LegacyRuleNotificationAlertTypeParams extends AlertTypeParams {
   ruleAlertId: string;
 }
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export type LegacyRuleNotificationAlertType = Alert<LegacyRuleNotificationAlertTypeParams>;
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export interface LegacyFindNotificationParams {
   rulesClient: RulesClient;
@@ -44,14 +44,14 @@ export interface LegacyFindNotificationParams {
 }
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export interface LegacyClients {
   rulesClient: RulesClient;
 }
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export interface LegacyNotificationAlertParams {
   actions: AlertAction[];
@@ -62,12 +62,12 @@ export interface LegacyNotificationAlertParams {
 }
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export type CreateNotificationParams = LegacyNotificationAlertParams & LegacyClients;
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export interface LegacyReadNotificationParams {
   rulesClient: RulesClient;
@@ -76,7 +76,7 @@ export interface LegacyReadNotificationParams {
 }
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export const legacyIsAlertType = (
   partialAlert: PartialAlert<AlertTypeParams>
@@ -85,7 +85,7 @@ export const legacyIsAlertType = (
 };
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export type LegacyNotificationExecutorOptions = AlertExecutorOptions<
   LegacyRuleNotificationAlertTypeParams,
@@ -97,7 +97,7 @@ export type LegacyNotificationExecutorOptions = AlertExecutorOptions<
 /**
  * This returns true because by default a NotificationAlertTypeDefinition is an AlertType
  * since we are only increasing the strictness of params.
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export const legacyIsNotificationAlertExecutor = (
   obj: LegacyNotificationAlertTypeDefinition
@@ -112,7 +112,7 @@ export const legacyIsNotificationAlertExecutor = (
 };
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export type LegacyNotificationAlertTypeDefinition = Omit<
   AlertType<
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_responses.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_responses.ts
@@ -597,7 +597,7 @@ export const getSignalsMigrationStatusRequest = () =>
   });
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export const legacyGetNotificationResult = (): LegacyRuleNotificationAlertType => ({
   id: '200dbf2f-b269-4bf9-aa85-11ba32ba73ba',
@@ -641,7 +641,7 @@ export const legacyGetNotificationResult = (): LegacyRuleNotificationAlertType =
 });
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export const legacyGetFindNotificationsResultWithSingleHit =
   (): FindHit<LegacyRuleNotificationAlertType> => ({
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_create_rule_actions_saved_object.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_create_rule_actions_saved_object.ts
@@ -18,7 +18,7 @@ import { AlertAction } from '../../../../../alerting/common';
 import { transformAlertToRuleAction } from '../../../../common/detection_engine/transform_actions';
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 interface LegacyCreateRuleActionsSavedObject {
   ruleAlertId: string;
@@ -28,7 +28,7 @@ interface LegacyCreateRuleActionsSavedObject {
 }
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export const legacyCreateRuleActionsSavedObject = async ({
   ruleAlertId,
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_get_bulk_rule_actions_saved_object.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_get_bulk_rule_actions_saved_object.ts
@@ -17,15 +17,15 @@ import { LegacyRulesActionsSavedObject } from './legacy_get_rule_actions_saved_o
 import { buildChunkedOrFilter } from '../signals/utils';
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 interface LegacyGetBulkRuleActionsSavedObject {
   alertIds: string[];
   savedObjectsClient: AlertServices['savedObjectsClient'];
 }
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export const legacyGetBulkRuleActionsSavedObject = async ({
   alertIds,
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_get_rule_actions_saved_object.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_get_rule_actions_saved_object.ts
@@ -15,15 +15,15 @@ import { LegacyIRuleActionsAttributesSavedObjectAttributes } from './legacy_type
 import { legacyGetRuleActionsFromSavedObject } from './legacy_utils';
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 interface LegacyGetRuleActionsSavedObject {
   ruleAlertId: string;
   savedObjectsClient: AlertServices['savedObjectsClient'];
 }
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export interface LegacyRulesActionsSavedObject {
   id: string;
@@ -33,7 +33,7 @@ export interface LegacyRulesActionsSavedObject {
 }
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export const legacyGetRuleActionsSavedObject = async ({
   ruleAlertId,
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_migrations.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_migrations.ts
@@ -15,10 +15,7 @@ import {
 import { LegacyIRuleActionsAttributesSavedObjectAttributes } from './legacy_types';
 
 /**
- * We keep this around to migrate and update data for the old deprecated rule actions saved object mapping but we
- * do not use it anymore within the code base. Once we feel comfortable that users are upgrade far enough and this is no longer
- * needed then it will be safe to remove this saved object and all its migrations
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 function isEmptyObject(obj: {}) {
   for (const attr in obj) {
@@ -30,10 +27,7 @@ function isEmptyObject(obj: {}) {
 }
 
 /**
- * We keep this around to migrate and update data for the old deprecated rule actions saved object mapping but we
- * do not use it anymore within the code base. Once we feel comfortable that users are upgrade far enough and this is no longer
- * needed then it will be safe to remove this saved object and all its migrations
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export const legacyRuleActionsSavedObjectMigration = {
   '7.11.2': (
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_saved_object_mappings.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_saved_object_mappings.ts
@@ -10,18 +10,12 @@ import { SavedObjectsType } from '../../../../../../../src/core/server';
 import { legacyRuleActionsSavedObjectMigration } from './legacy_migrations';
 
 /**
- * We keep this around to migrate and update data for the old deprecated rule actions saved object mapping but we
- * do not use it anymore within the code base. Once we feel comfortable that users are upgrade far enough and this is no longer
- * needed then it will be safe to remove this saved object and all its migrations.
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export const legacyRuleActionsSavedObjectType = 'siem-detection-engine-rule-actions';
 
 /**
- * We keep this around to migrate and update data for the old deprecated rule actions saved object mapping but we
- * do not use it anymore within the code base. Once we feel comfortable that users are upgrade far enough and this is no longer
- * needed then it will be safe to remove this saved object and all its migrations.
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 const legacyRuleActionsSavedObjectMappings: SavedObjectsType['mappings'] = {
   properties: {
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_update_or_create_rule_actions_saved_object.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_update_or_create_rule_actions_saved_object.ts
@@ -17,7 +17,7 @@ import { legacyUpdateRuleActionsSavedObject } from './legacy_update_rule_actions
 import { LegacyRuleActions } from './legacy_types';
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 interface LegacyUpdateOrCreateRuleActionsSavedObject {
   ruleAlertId: string;
@@ -27,7 +27,7 @@ interface LegacyUpdateOrCreateRuleActionsSavedObject {
 }
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export const legacyUpdateOrCreateRuleActionsSavedObject = async ({
   savedObjectsClient,
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_update_rule_actions_saved_object.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_update_rule_actions_saved_object.ts
@@ -18,7 +18,7 @@ import { AlertAction } from '../../../../../alerting/common';
 import { transformAlertToRuleAction } from '../../../../common/detection_engine/transform_actions';
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 interface LegacyUpdateRuleActionsSavedObject {
   ruleAlertId: string;
@@ -29,7 +29,7 @@ interface LegacyUpdateRuleActionsSavedObject {
 }
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export const legacyUpdateRuleActionsSavedObject = async ({
   ruleAlertId,
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_utils.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_utils.ts
@@ -11,7 +11,7 @@ import { RuleAlertAction } from '../../../../common/detection_engine/types';
 import { LegacyIRuleActionsAttributesSavedObjectAttributes } from './legacy_types';
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export const legacyGetThrottleOptions = (
   throttle: string | undefined | null = 'no_actions'
@@ -24,7 +24,7 @@ export const legacyGetThrottleOptions = (
 });
 
 /**
- * @deprecated Once legacy notifications/"side car actions" goes away this should be removed
+ * @deprecated Once we are confident all rules relying on side-car actions SO's have been migrated to SO references we should remove this function
  */
 export const legacyGetRuleActionsFromSavedObject = (
   savedObject: SavedObjectsUpdateResponse<LegacyIRuleActionsAttributesSavedObjectAttributes>
