[Cases] Migrate attachment client/service layer to unified-only requests

x-pack/platform/plugins/shared/cases/common/types/api/attachment/latest.ts

@@ -7,3 +7,4 @@
 
 export * from './v1';
 export * from './v2';
+export * from './v2_union';

x-pack/platform/plugins/shared/cases/common/types/api/attachment/v2.ts

@@ -8,16 +8,7 @@
 import * as rt from 'io-ts';
 import { MAX_BULK_CREATE_ATTACHMENTS } from '../../../constants';
 import type { BulkGetAttachmentsRequest } from './v1';
-import {
-  AttachmentPatchRequestRt,
-  AttachmentRequestRt,
-  AttachmentRequestWithoutRefsRt,
-} from './v1';
-import {
-  AttachmentRtV2,
-  AttachmentsRtV2,
-  UnifiedAttachmentPayloadRt,
-} from '../../domain/attachment/v2';
+import { UnifiedAttachmentPayloadRt } from '../../domain/attachment/v2';
 import { limitedArraySchema } from '../../../schema';
 export type { BulkGetAttachmentsRequest as BulkGetAttachmentsRequestV2 };
 
@@ -26,44 +17,13 @@ export const UnifiedAttachmentPatchRequestRt = rt.intersection([
   rt.strict({ id: rt.string, version: rt.string }),
 ]);
 
-export const AttachmentRequestRtV2 = rt.union([AttachmentRequestRt, UnifiedAttachmentPayloadRt]);
-export const AttachmentRequestWithoutRefsRtV2 = rt.union([
-  AttachmentRequestWithoutRefsRt,
-  UnifiedAttachmentPayloadRt,
-]);
-export const AttachmentPatchRequestRtV2 = rt.union([
-  AttachmentPatchRequestRt,
-  UnifiedAttachmentPatchRequestRt,
-]);
-
-export const AttachmentsFindResponseRtV2 = rt.strict({
-  comments: rt.array(AttachmentRtV2),
-  page: rt.number,
-  per_page: rt.number,
-  total: rt.number,
-});
-
-export const BulkCreateAttachmentsRequestRtV2 = limitedArraySchema({
-  codec: AttachmentRequestRtV2,
+export const BulkCreateUnifiedAttachmentsRequestRt = limitedArraySchema({
+  codec: UnifiedAttachmentPayloadRt,
   min: 0,
   max: MAX_BULK_CREATE_ATTACHMENTS,
   fieldName: 'attachments',
 });
 
-export const BulkGetAttachmentsResponseRtV2 = rt.strict({
-  attachments: AttachmentsRtV2,
-  errors: rt.array(
-    rt.strict({
-      error: rt.string,
-      message: rt.string,
-      status: rt.union([rt.undefined, rt.number]),
-      savedObjectId: rt.string,
-    })
-  ),
-});
-
-export type AttachmentRequestV2 = rt.TypeOf<typeof AttachmentRequestRtV2>;
-export type AttachmentPatchRequestV2 = rt.TypeOf<typeof AttachmentPatchRequestRtV2>;
-export type AttachmentsFindResponseV2 = rt.TypeOf<typeof AttachmentsFindResponseRtV2>;
-export type BulkCreateAttachmentsRequestV2 = rt.TypeOf<typeof BulkCreateAttachmentsRequestRtV2>;
-export type BulkGetAttachmentsResponseV2 = rt.TypeOf<typeof BulkGetAttachmentsResponseRtV2>;
+export type BulkCreateUnifiedAttachmentsRequest = rt.TypeOf<
+  typeof BulkCreateUnifiedAttachmentsRequestRt
+>;

x-pack/platform/plugins/shared/cases/common/types/api/attachment/v2.test.ts → x-pack/platform/plugins/shared/cases/common/types/api/attachment/v2_union.test.ts

@@ -6,7 +6,7 @@
  */
 
 import { AttachmentType } from '../../domain/attachment/v1';
-import { AttachmentRequestRtV2, BulkCreateAttachmentsRequestRtV2 } from './v2';
+import { AttachmentRequestRtV2, BulkCreateAttachmentsRequestRtV2 } from './v2_union';
 import {
   AttachmentRequestSchemaV2,
   BulkCreateAttachmentsRequestSchemaV2,

x-pack/platform/plugins/shared/cases/common/types/api/attachment/v2_union.ts

@@ -0,0 +1,69 @@
+/*
+ * 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 * as rt from 'io-ts';
+import { MAX_BULK_CREATE_ATTACHMENTS } from '../../../constants';
+import {
+  AttachmentPatchRequestRt,
+  AttachmentRequestRt,
+  AttachmentRequestWithoutRefsRt,
+} from './v1';
+import {
+  AttachmentRtV2,
+  AttachmentsRtV2,
+  UnifiedAttachmentPayloadRt,
+} from '../../domain/attachment/v2';
+import { UnifiedAttachmentPatchRequestRt } from './v2';
+import { limitedArraySchema } from '../../../schema';
+
+export const AttachmentRequestRtV2 = rt.union([AttachmentRequestRt, UnifiedAttachmentPayloadRt]);
+export const AttachmentRequestWithoutRefsRtV2 = rt.union([
+  AttachmentRequestWithoutRefsRt,
+  UnifiedAttachmentPayloadRt,
+]);
+export const AttachmentPatchRequestRtV2 = rt.union([
+  AttachmentPatchRequestRt,
+  UnifiedAttachmentPatchRequestRt,
+]);
+
+export const AttachmentsFindResponseRtV2 = rt.strict({
+  comments: rt.array(AttachmentRtV2),
+  page: rt.number,
+  per_page: rt.number,
+  total: rt.number,
+});
+
+// Version-spanning bulk-create payload: the internal route still accepts both v1
+// legacy and unified wire shapes and converts to unified before the client call.
+export const BulkCreateAttachmentsRequestRtV2 = limitedArraySchema({
+  codec: AttachmentRequestRtV2,
+  min: 0,
+  max: MAX_BULK_CREATE_ATTACHMENTS,
+  fieldName: 'attachments',
+});
+
+// Bulk-get response tolerates legacy shapes: the getter (`AttachmentGetter.bulkGet`)
+// is mixed until every attachment type is migrated (see `toUnifiedAttributes`), so an
+// unmigrated type would fail a unified-only decode here and 500 the route. Narrow this
+// to unified-only once the getter is unified-only too.
+export const BulkGetAttachmentsResponseRtV2 = rt.strict({
+  attachments: AttachmentsRtV2,
+  errors: rt.array(
+    rt.strict({
+      error: rt.string,
+      message: rt.string,
+      status: rt.union([rt.undefined, rt.number]),
+      savedObjectId: rt.string,
+    })
+  ),
+});
+
+export type AttachmentRequestV2 = rt.TypeOf<typeof AttachmentRequestRtV2>;
+export type AttachmentPatchRequestV2 = rt.TypeOf<typeof AttachmentPatchRequestRtV2>;
+export type AttachmentsFindResponseV2 = rt.TypeOf<typeof AttachmentsFindResponseRtV2>;
+export type BulkCreateAttachmentsRequestV2 = rt.TypeOf<typeof BulkCreateAttachmentsRequestRtV2>;
+export type BulkGetAttachmentsResponseV2 = rt.TypeOf<typeof BulkGetAttachmentsResponseRtV2>;

x-pack/platform/plugins/shared/cases/common/types/api/index.ts

@@ -40,3 +40,4 @@ export * as fieldDefinitionApiV1 from './field_definition/v1';
 
 // V2
 export * as attachmentApiV2 from './attachment/v2';
+export * as attachmentApiV2Union from './attachment/v2_union';

x-pack/platform/plugins/shared/cases/common/types/domain/user_action/comment/v1.ts

@@ -10,7 +10,7 @@ import { UserActionTypes } from '../action/v1';
 import {
   AttachmentRequestRtV2,
   AttachmentRequestWithoutRefsRtV2,
-} from '../../../api/attachment/v2';
+} from '../../../api/attachment/v2_union';
 
 export const CommentUserActionPayloadRt = rt.strict({ comment: AttachmentRequestRtV2 });
 

x-pack/platform/plugins/shared/cases/public/containers/use_create_attachments.tsx

@@ -6,7 +6,7 @@
  */
 
 import { useMutation } from '@kbn/react-query';
-import type { attachmentApiV2 } from '../../common/types/api';
+import type { attachmentApiV2Union } from '../../common/types/api';
 import { createAttachments } from './api';
 import * as i18n from './translations';
 import type { CaseAttachmentsWithoutOwner, ServerError } from '../types';
@@ -37,7 +37,7 @@ export const useCreateAttachments = () => {
       // bridges the two type systems at the wire boundary. Server-side
       // validation re-runs through the per-type Zod schemas.
       return createAttachments({
-        attachments: attachments as unknown as attachmentApiV2.BulkCreateAttachmentsRequestV2,
+        attachments: attachments as unknown as attachmentApiV2Union.BulkCreateAttachmentsRequestV2,
         caseId: request.caseId,
       });
     },

x-pack/platform/plugins/shared/cases/server/client/attachments/add.test.ts

@@ -45,6 +45,15 @@ describe('addComment', () => {
     ).rejects.toThrow('invalid keys "foo"');
   });
 
+  it('rejects a legacy v1 body', async () => {
+    const v1Comment = { type: 'user', comment: 'a legacy comment', owner: SECURITY_SOLUTION_OWNER };
+
+    await expect(
+      // @ts-expect-error: legacy v1 shape is no longer accepted, client is unified-only
+      addComment({ comment: v1Comment, caseId }, clientArgs)
+    ).rejects.toThrow();
+  });
+
   it(`throws error when the case user actions become > ${MAX_USER_ACTIONS_PER_CASE}`, async () => {
     userActionService.getMultipleCasesUserActionsTotal.mockResolvedValue({
       [caseId]: MAX_USER_ACTIONS_PER_CASE,

x-pack/platform/plugins/shared/cases/server/client/attachments/add.ts

@@ -13,10 +13,9 @@ import { decodeWithExcessOrThrow } from '../../common/runtime_types';
 import { CaseCommentModel } from '../../common/models';
 import { createCaseError } from '../../common/error';
 import type { CasesClientArgs } from '..';
-import { decodeCommentRequestV2 } from '../utils';
 import { Operations } from '../../authorization';
 import type { AddArgs } from './types';
-import { validateRegisteredAttachments } from './validators';
+import { validateUnifiedAttachments } from './validators';
 import { validateMaxUserActions } from '../../common/validators';
 import { extractAndAddObservables } from './extract_observables';
 import { emitAttachmentsAddedEvent } from './trigger_utils';
@@ -38,7 +37,6 @@ export const addComment = async (addArgs: AddArgs, clientArgs: CasesClientArgs):
 
   try {
     const query = decodeWithExcessOrThrow(UnifiedAttachmentPayloadRt)(comment);
-    decodeCommentRequestV2(query, unifiedAttachmentTypeRegistry);
 
     await validateMaxUserActions({ caseId, userActionService, userActionsToAdd: 1 });
 
@@ -53,7 +51,7 @@ export const addComment = async (addArgs: AddArgs, clientArgs: CasesClientArgs):
       ],
     });
 
-    validateRegisteredAttachments({
+    validateUnifiedAttachments({
       query,
       unifiedAttachmentTypeRegistry,
     });

x-pack/platform/plugins/shared/cases/server/client/attachments/add_file.ts

@@ -17,7 +17,7 @@ import { createCaseError } from '../../common/error';
 import { validateMaxUserActions } from '../../common/validators';
 import { constructFileKindIdByOwner } from '../../../common/files';
 import { Operations } from '../../authorization';
-import { validateRegisteredAttachments } from './validators';
+import { validateUnifiedAttachments } from './validators';
 import { buildAttachmentRequestFromFileJSON } from '../utils';
 import { decodeWithExcessOrThrow } from '../../common/runtime_types';
 
@@ -77,7 +77,7 @@ export const addFile = async (
       fileMetadata: createdFile.toJSON(),
     });
 
-    validateRegisteredAttachments({
+    validateUnifiedAttachments({
       query: commentReq,
       unifiedAttachmentTypeRegistry,
     });

x-pack/platform/plugins/shared/cases/server/client/attachments/bulk_create.test.ts

@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { comment, actionComment, mockCases, mockCaseUnifiedAttachments } from '../../mocks';
+import { mockCases, mockCaseUnifiedAttachments } from '../../mocks';
 import { createCasesClientMockArgs } from '../mocks';
 import {
   MAX_COMMENT_LENGTH,
@@ -24,6 +24,12 @@ import { commentAttachmentType } from '../../attachment_framework/attachments';
 describe('bulkCreate', () => {
   const caseId = 'test-case';
 
+  const comment = {
+    type: 'comment' as const,
+    data: { content: 'a comment' },
+    owner: SECURITY_SOLUTION_OWNER,
+  };
+
   const clientArgs = createCasesClientMockArgs();
   const userActionService = createUserActionServiceMock();
   const caseService = createCaseServiceMock();
@@ -33,6 +39,12 @@ describe('bulkCreate', () => {
   clientArgs.services.caseService = caseService;
   clientArgs.services.attachmentService = attachmentService;
 
+  const registerCommentType = () => {
+    if (!clientArgs.unifiedAttachmentTypeRegistry.has(commentAttachmentType.id)) {
+      clientArgs.unifiedAttachmentTypeRegistry.register(commentAttachmentType);
+    }
+  };
+
   beforeEach(() => {
     jest.clearAllMocks();
   });
@@ -44,6 +56,15 @@ describe('bulkCreate', () => {
     ).rejects.toThrow('invalid keys "foo"');
   });
 
+  it('rejects a legacy v1 body', async () => {
+    const v1Comment = { type: 'user', comment: 'a legacy comment', owner: SECURITY_SOLUTION_OWNER };
+
+    await expect(
+      // @ts-expect-error: legacy v1 shape is no longer accepted, client is unified-only
+      bulkCreate({ attachments: [v1Comment], caseId }, clientArgs)
+    ).rejects.toThrow();
+  });
+
   it(`throws error when attachments are more than ${MAX_BULK_CREATE_ATTACHMENTS}`, async () => {
     const attachments = Array(MAX_BULK_CREATE_ATTACHMENTS + 1).fill(comment);
 
@@ -65,70 +86,38 @@ describe('bulkCreate', () => {
   });
 
   describe('comments', () => {
-    it('should throw an error if the comment length is too long', async () => {
-      const longComment = Array(MAX_COMMENT_LENGTH + 1)
-        .fill('x')
-        .toString();
-
-      await expect(
-        bulkCreate({ attachments: [{ ...comment, comment: longComment }], caseId }, clientArgs)
-      ).rejects.toThrow(
-        `Failed while bulk creating attachment to case id: test-case error: Error: The length of the comment is too long. The maximum length is ${MAX_COMMENT_LENGTH}.`
-      );
+    beforeEach(() => {
+      registerCommentType();
     });
 
-    it('should throw an error if the comment is an empty string', async () => {
-      await expect(
-        bulkCreate({ attachments: [{ ...comment, comment: '' }], caseId }, clientArgs)
-      ).rejects.toThrow(
-        'Failed while bulk creating attachment to case id: test-case error: Error: The comment field cannot be an empty string.'
-      );
-    });
-
-    it('should throw an error if the description is a string with empty characters', async () => {
-      await expect(
-        bulkCreate({ attachments: [{ ...comment, comment: '  ' }], caseId }, clientArgs)
-      ).rejects.toThrow(
-        'Failed while bulk creating attachment to case id: test-case error: Error: The comment field cannot be an empty string.'
-      );
-    });
-  });
-
-  describe('actions', () => {
     it('should throw an error if the comment length is too long', async () => {
       const longComment = Array(MAX_COMMENT_LENGTH + 1)
         .fill('x')
         .toString();
 
       await expect(
         bulkCreate(
-          { attachments: [{ ...actionComment, comment: longComment }], caseId },
+          { attachments: [{ ...comment, data: { content: longComment } }], caseId },
           clientArgs
         )
-      ).rejects.toThrow(
-        `Failed while bulk creating attachment to case id: test-case error: Error: The length of the comment is too long. The maximum length is ${MAX_COMMENT_LENGTH}.`
-      );
+      ).rejects.toThrow(/Comment content exceeds maximum length/);
     });
 
     it('should throw an error if the comment is an empty string', async () => {
       await expect(
-        bulkCreate({ attachments: [{ ...actionComment, comment: '' }], caseId }, clientArgs)
-      ).rejects.toThrow(
-        'Failed while bulk creating attachment to case id: test-case error: Error: The comment field cannot be an empty string.'
-      );
+        bulkCreate({ attachments: [{ ...comment, data: { content: '' } }], caseId }, clientArgs)
+      ).rejects.toThrow(/Comment content must be a non-empty string/);
     });
 
-    it('should throw an error if the description is a string with empty characters', async () => {
+    it('should throw an error if the comment is a string with empty characters', async () => {
       await expect(
-        bulkCreate({ attachments: [{ ...actionComment, comment: '  ' }], caseId }, clientArgs)
-      ).rejects.toThrow(
-        'Failed while bulk creating attachment to case id: test-case error: Error: The comment field cannot be an empty string.'
-      );
+        bulkCreate({ attachments: [{ ...comment, data: { content: '  ' } }], caseId }, clientArgs)
+      ).rejects.toThrow(/Comment content must be a non-empty string/);
     });
   });
 
-  it('accepts unified type (v2) attachments without owner and uses case owner', async () => {
-    clientArgs.unifiedAttachmentTypeRegistry.register(commentAttachmentType);
+  it('accepts unified comments', async () => {
+    registerCommentType();
     userActionService.getMultipleCasesUserActionsTotal.mockResolvedValue({ [caseId]: 0 });
 
     const theCase = { ...mockCases[0], id: caseId };