[Cases] Split attachment types for versioned http apis

x-pack/plugins/cases/server/common/types/attachments.ts

@@ -0,0 +1,37 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import type { User } from './user';
+
+interface AttachmentCommonPersistedAttributes {
+  created_at: string;
+  created_by: User;
+  owner: string;
+  pushed_at: string | null;
+  pushed_by: User | null;
+  updated_at: string | null;
+  updated_by: User | null;
+}
+
+export interface AttachmentRequestAttributes {
+  type: string;
+  alertId?: string | string[];
+  index?: string | string[];
+  rule?: Record<string, unknown>;
+  comment?: string;
+  actions?: Record<string, unknown>;
+  externalReferenceMetadata?: Record<string, unknown> | null;
+  externalReferenceAttachmentTypeId?: string;
+  externalReferenceStorage?: {
+    type: string;
+    soType?: string;
+  };
+  persistableStateAttachmentState?: Record<string, unknown>;
+}
+
+export type AttachmentPersistedAttributes = AttachmentRequestAttributes &
+  AttachmentCommonPersistedAttributes;

x-pack/plugins/cases/server/common/types/user.ts

@@ -0,0 +1,13 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export interface User {
+  email: undefined | null | string;
+  full_name: undefined | null | string;
+  username: undefined | null | string;
+  profile_uid?: string;
+}

x-pack/plugins/cases/server/common/utils.ts

@@ -56,6 +56,7 @@ import {
   getLensVisualizations,
 } from '../../common/utils/markdown_plugins/utils';
 import { dedupAssignees } from '../client/cases/utils';
+import type { AttachmentRequestAttributes } from './types/attachments';
 
 /**
  * Default sort field for querying saved objects.
@@ -258,7 +259,7 @@ export const isCommentRequestTypeAlert = (
  * A type narrowing function for external reference so attachments.
  */
 export const isCommentRequestTypeExternalReferenceSO = (
-  context: Partial<CommentRequest>
+  context: Partial<AttachmentRequestAttributes>
 ): context is CommentRequestExternalReferenceSOType => {
   return (
     context.type === CommentType.externalReference &&

x-pack/plugins/cases/server/services/attachments/index.ts

@@ -7,19 +7,16 @@
 
 import type {
   SavedObject,
-  SavedObjectReference,
   SavedObjectsBulkResponse,
   SavedObjectsBulkUpdateResponse,
   SavedObjectsFindResponse,
-  SavedObjectsUpdateOptions,
   SavedObjectsUpdateResponse,
 } from '@kbn/core/server';
 
 import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
 import type {
   CommentAttributes as AttachmentAttributes,
   CommentAttributesWithoutRefs as AttachmentAttributesWithoutRefs,
-  CommentPatchAttributes as AttachmentPatchAttributes,
 } from '../../../common/api';
 import { CommentType } from '../../../common/api';
 import { CASE_COMMENT_SAVED_OBJECT, CASE_SAVED_OBJECT } from '../../../common/constants';
@@ -32,50 +29,19 @@ import {
   injectAttachmentSOAttributesFromRefsForPatch,
 } from '../so_references';
 import type { SavedObjectFindOptionsKueryNode } from '../../common/types';
-import type { IndexRefresh } from '../types';
-import type { AttachedToCaseArgs, ServiceContext } from './types';
+import type {
+  AlertsAttachedToCaseArgs,
+  AttachmentsAttachedToCaseArgs,
+  BulkCreateAttachments,
+  BulkUpdateAttachmentArgs,
+  CountActionsAttachedToCaseArgs,
+  CreateAttachmentArgs,
+  DeleteAttachmentArgs,
+  ServiceContext,
+  UpdateAttachmentArgs,
+} from './types';
 import { AttachmentGetter } from './operations/get';
-
-type AlertsAttachedToCaseArgs = AttachedToCaseArgs;
-
-interface AttachmentsAttachedToCaseArgs extends AttachedToCaseArgs {
-  attachmentType: CommentType;
-  aggregations: Record<string, estypes.AggregationsAggregationContainer>;
-}
-
-interface CountActionsAttachedToCaseArgs extends AttachedToCaseArgs {
-  aggregations: Record<string, estypes.AggregationsAggregationContainer>;
-}
-
-interface DeleteAttachmentArgs extends IndexRefresh {
-  attachmentIds: string[];
-}
-
-interface CreateAttachmentArgs extends IndexRefresh {
-  attributes: AttachmentAttributes;
-  references: SavedObjectReference[];
-  id: string;
-}
-
-interface BulkCreateAttachments extends IndexRefresh {
-  attachments: Array<{
-    attributes: AttachmentAttributes;
-    references: SavedObjectReference[];
-    id: string;
-  }>;
-}
-
-interface UpdateArgs {
-  attachmentId: string;
-  updatedAttributes: AttachmentPatchAttributes;
-  options?: Omit<SavedObjectsUpdateOptions<AttachmentAttributes>, 'upsert'>;
-}
-
-export type UpdateAttachmentArgs = UpdateArgs;
-
-interface BulkUpdateAttachmentArgs extends IndexRefresh {
-  comments: UpdateArgs[];
-}
+import type { AttachmentPersistedAttributes } from '../../common/types/attachments';
 
 export class AttachmentService {
   private readonly _getter: AttachmentGetter;
@@ -207,7 +173,7 @@ export class AttachmentService {
         );
 
       const attachment =
-        await this.context.unsecuredSavedObjectsClient.create<AttachmentAttributesWithoutRefs>(
+        await this.context.unsecuredSavedObjectsClient.create<AttachmentPersistedAttributes>(
           CASE_COMMENT_SAVED_OBJECT,
           extractedAttributes,
           {
@@ -234,7 +200,7 @@ export class AttachmentService {
     try {
       this.context.log.debug(`Attempting to bulk create attachments`);
       const res =
-        await this.context.unsecuredSavedObjectsClient.bulkCreate<AttachmentAttributesWithoutRefs>(
+        await this.context.unsecuredSavedObjectsClient.bulkCreate<AttachmentPersistedAttributes>(
           attachments.map((attachment) => {
             const { attributes: extractedAttributes, references: extractedReferences } =
               extractAttachmentSORefsFromAttributes(
@@ -380,7 +346,7 @@ export class AttachmentService {
     try {
       this.context.log.debug(`Attempting to find comments`);
       const res =
-        await this.context.unsecuredSavedObjectsClient.find<AttachmentAttributesWithoutRefs>({
+        await this.context.unsecuredSavedObjectsClient.find<AttachmentPersistedAttributes>({
           sortField: defaultSortField,
           ...options,
           type: CASE_COMMENT_SAVED_OBJECT,

x-pack/plugins/cases/server/services/attachments/operations/get.ts

@@ -8,6 +8,7 @@
 import type { SavedObject } from '@kbn/core/server';
 import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
 import { FILE_SO_TYPE } from '@kbn/files-plugin/common';
+import type { AttachmentPersistedAttributes } from '../../../common/types/attachments';
 import {
   CASE_COMMENT_SAVED_OBJECT,
   CASE_SAVED_OBJECT,
@@ -19,13 +20,13 @@ import type {
   AttachmentTotals,
   AttributesTypeAlerts,
   CommentAttributes as AttachmentAttributes,
-  CommentAttributesWithoutRefs as AttachmentAttributesWithoutRefs,
   CommentAttributes,
 } from '../../../../common/api';
 import { CommentType } from '../../../../common/api';
 import type {
-  AttachedToCaseArgs,
+  AlertIdsAggsResult,
   BulkOptionalAttributes,
+  GetAllAlertsAttachToCaseArgs,
   GetAttachmentArgs,
   ServiceContext,
 } from '../types';
@@ -37,16 +38,6 @@ import { partitionByCaseAssociation } from '../../../common/partitioning';
 import type { AttachmentSavedObject } from '../../../common/types';
 import { getCaseReferenceId } from '../../../common/references';
 
-type GetAllAlertsAttachToCaseArgs = AttachedToCaseArgs;
-
-interface AlertIdsAggsResult {
-  alertIds: {
-    buckets: Array<{
-      key: string;
-    }>;
-  };
-}
-
 export class AttachmentGetter {
   constructor(private readonly context: ServiceContext) {}
 
@@ -59,7 +50,7 @@ export class AttachmentGetter {
       );
 
       const response =
-        await this.context.unsecuredSavedObjectsClient.bulkGet<AttachmentAttributesWithoutRefs>(
+        await this.context.unsecuredSavedObjectsClient.bulkGet<AttachmentPersistedAttributes>(
           attachmentIds.map((id) => ({ id, type: CASE_COMMENT_SAVED_OBJECT }))
         );
 
@@ -133,18 +124,24 @@ export class AttachmentGetter {
       const combinedFilter = combineFilters([alertsFilter, filter]);
 
       const finder =
-        this.context.unsecuredSavedObjectsClient.createPointInTimeFinder<AttributesTypeAlerts>({
-          type: CASE_COMMENT_SAVED_OBJECT,
-          hasReference: { type: CASE_SAVED_OBJECT, id: caseId },
-          sortField: 'created_at',
-          sortOrder: 'asc',
-          filter: combinedFilter,
-          perPage: MAX_DOCS_PER_PAGE,
-        });
+        this.context.unsecuredSavedObjectsClient.createPointInTimeFinder<AttachmentPersistedAttributes>(
+          {
+            type: CASE_COMMENT_SAVED_OBJECT,
+            hasReference: { type: CASE_SAVED_OBJECT, id: caseId },
+            sortField: 'created_at',
+            sortOrder: 'asc',
+            filter: combinedFilter,
+            perPage: MAX_DOCS_PER_PAGE,
+          }
+        );
 
       let result: Array<SavedObject<AttributesTypeAlerts>> = [];
       for await (const userActionSavedObject of finder.find()) {
-        result = result.concat(userActionSavedObject.saved_objects);
+        result = result.concat(
+          // We need a cast here because to limited attachment type conflicts with the expected result even though they
+          // should be the same
+          userActionSavedObject.saved_objects as unknown as Array<SavedObject<AttributesTypeAlerts>>
+        );
       }
 
       return result;
@@ -197,11 +194,10 @@ export class AttachmentGetter {
   }: GetAttachmentArgs): Promise<SavedObject<AttachmentAttributes>> {
     try {
       this.context.log.debug(`Attempting to GET attachment ${attachmentId}`);
-      const res =
-        await this.context.unsecuredSavedObjectsClient.get<AttachmentAttributesWithoutRefs>(
-          CASE_COMMENT_SAVED_OBJECT,
-          attachmentId
-        );
+      const res = await this.context.unsecuredSavedObjectsClient.get<AttachmentPersistedAttributes>(
+        CASE_COMMENT_SAVED_OBJECT,
+        attachmentId
+      );
 
       return injectAttachmentSOAttributesFromRefs(
         res,
@@ -324,7 +320,7 @@ export class AttachmentGetter {
        * to retrieve them all.
        */
       const finder =
-        this.context.unsecuredSavedObjectsClient.createPointInTimeFinder<AttachmentAttributesWithoutRefs>(
+        this.context.unsecuredSavedObjectsClient.createPointInTimeFinder<AttachmentPersistedAttributes>(
           {
             type: CASE_COMMENT_SAVED_OBJECT,
             hasReference: references,

x-pack/plugins/cases/server/services/attachments/types.ts

@@ -5,15 +5,24 @@
  * 2.0.
  */
 
+import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
 import type {
   Logger,
   SavedObject,
+  SavedObjectReference,
   SavedObjectsBulkResponse,
   SavedObjectsClientContract,
+  SavedObjectsUpdateOptions,
 } from '@kbn/core/server';
 import type { KueryNode } from '@kbn/es-query';
+import type { CommentType } from '../../../common';
+import type {
+  CommentAttributes as AttachmentAttributes,
+  CommentPatchAttributes as AttachmentPatchAttributes,
+} from '../../../common/api';
 import type { PersistableStateAttachmentTypeRegistry } from '../../attachment_framework/persistable_state_registry';
 import type { PartialField } from '../../types';
+import type { IndexRefresh } from '../types';
 
 export interface ServiceContext {
   log: Logger;
@@ -36,3 +45,54 @@ export interface BulkOptionalAttributes<T>
   extends Omit<SavedObjectsBulkResponse<T>, 'saved_objects'> {
   saved_objects: Array<OptionalAttributes<T>>;
 }
+
+export type GetAllAlertsAttachToCaseArgs = AttachedToCaseArgs;
+
+export interface AlertIdsAggsResult {
+  alertIds: {
+    buckets: Array<{
+      key: string;
+    }>;
+  };
+}
+
+export type AlertsAttachedToCaseArgs = AttachedToCaseArgs;
+
+export interface AttachmentsAttachedToCaseArgs extends AttachedToCaseArgs {
+  attachmentType: CommentType;
+  aggregations: Record<string, estypes.AggregationsAggregationContainer>;
+}
+
+export interface CountActionsAttachedToCaseArgs extends AttachedToCaseArgs {
+  aggregations: Record<string, estypes.AggregationsAggregationContainer>;
+}
+
+export interface DeleteAttachmentArgs extends IndexRefresh {
+  attachmentIds: string[];
+}
+
+export interface CreateAttachmentArgs extends IndexRefresh {
+  attributes: AttachmentAttributes;
+  references: SavedObjectReference[];
+  id: string;
+}
+
+export interface BulkCreateAttachments extends IndexRefresh {
+  attachments: Array<{
+    attributes: AttachmentAttributes;
+    references: SavedObjectReference[];
+    id: string;
+  }>;
+}
+
+export interface UpdateArgs {
+  attachmentId: string;
+  updatedAttributes: AttachmentPatchAttributes;
+  options?: Omit<SavedObjectsUpdateOptions<AttachmentAttributes>, 'upsert'>;
+}
+
+export type UpdateAttachmentArgs = UpdateArgs;
+
+export interface BulkUpdateAttachmentArgs extends IndexRefresh {
+  comments: UpdateArgs[];
+}