Merge pull request #546 from Hexastack/refactor/attachment-payload

feat: Refactor attachment payload + use public signed urls in web channel

api/src/cms/services/content.service.spec.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright © 2024 Hexastack. All rights reserved.
+ * Copyright © 2025 Hexastack. All rights reserved.
  *
  * Licensed under the GNU Affero General Public License v3.0 (AGPLv3) with the following additional terms:
  * 1. The name "Hexabot" is a trademark of Hexastack. You may not use this name in derivative works without express written permission.
@@ -13,11 +13,7 @@ import { Test, TestingModule } from '@nestjs/testing';
 import { AttachmentRepository } from '@/attachment/repositories/attachment.repository';
 import { AttachmentModel } from '@/attachment/schemas/attachment.schema';
 import { AttachmentService } from '@/attachment/services/attachment.service';
-import { FileType } from '@/chat/schemas/types/attachment';
-import {
-  ContentElement,
-  OutgoingMessageFormat,
-} from '@/chat/schemas/types/message';
+import { OutgoingMessageFormat } from '@/chat/schemas/types/message';
 import { ContentOptions } from '@/chat/schemas/types/options';
 import { LoggerService } from '@/logger/logger.service';
 import { IGNORED_TEST_FIELDS } from '@/utils/test/constants';
@@ -43,7 +39,6 @@ describe('ContentService', () => {
   let contentService: ContentService;
   let contentTypeService: ContentTypeService;
   let contentRepository: ContentRepository;
-  let attachmentService: AttachmentService;
 
   beforeAll(async () => {
     const module: TestingModule = await Test.createTestingModule({
@@ -69,7 +64,6 @@ describe('ContentService', () => {
     contentService = module.get<ContentService>(ContentService);
     contentTypeService = module.get<ContentTypeService>(ContentTypeService);
     contentRepository = module.get<ContentRepository>(ContentRepository);
-    attachmentService = module.get<AttachmentService>(AttachmentService);
   });
 
   afterAll(async () => {
@@ -111,103 +105,6 @@ describe('ContentService', () => {
     });
   });
 
-  describe('getAttachmentIds', () => {
-    const contents: Content[] = [
-      {
-        id: '1',
-        title: 'store 1',
-        entity: 'stores',
-        status: true,
-        dynamicFields: {
-          image: {
-            type: FileType.image,
-            payload: {
-              attachment_id: '123',
-            },
-          },
-        },
-        createdAt: new Date(),
-        updatedAt: new Date(),
-      },
-      {
-        id: '2',
-        title: 'store 2',
-        entity: 'stores',
-        status: true,
-        dynamicFields: {
-          image: {
-            type: FileType.image,
-            payload: {
-              attachment_id: '456',
-            },
-          },
-        },
-        createdAt: new Date(),
-        updatedAt: new Date(),
-      },
-      {
-        id: '3',
-        title: 'store 3',
-        entity: 'stores',
-        status: true,
-        dynamicFields: {
-          image: {
-            type: FileType.image,
-            payload: {
-              url: 'https://remote.file/image.jpg',
-            },
-          },
-        },
-        createdAt: new Date(),
-        updatedAt: new Date(),
-      },
-    ];
-    it('should return all content attachment ids', () => {
-      const result = contentService.getAttachmentIds(
-        contents.map(Content.toElement),
-        'image',
-      );
-      expect(result).toEqual(['123', '456']);
-    });
-
-    it('should not return any of the attachment ids', () => {
-      const result = contentService.getAttachmentIds(contents, 'file');
-      expect(result).toEqual([]);
-    });
-  });
-
-  describe('populateAttachments', () => {
-    it('should return populated content', async () => {
-      const storeContents = await contentService.find({ title: /^store/ });
-      const elements: ContentElement[] = await Promise.all(
-        storeContents.map(Content.toElement).map(async (store) => {
-          const attachmentId = store.image.payload.attachment_id;
-          if (attachmentId) {
-            const attachment = await attachmentService.findOne(attachmentId);
-            if (attachment) {
-              return {
-                ...store,
-                image: {
-                  type: 'image',
-                  payload: {
-                    ...attachment,
-                    url: `http://localhost:4000/attachment/download/${attachment.id}/${attachment.name}`,
-                  },
-                },
-              };
-            }
-          }
-          return store;
-        }),
-      );
-      const result = await contentService.populateAttachments(
-        storeContents.map(Content.toElement),
-        'image',
-      );
-      expect(result).toEqualPayload(elements);
-    });
-  });
-
   describe('getContent', () => {
     const contentOptions: ContentOptions = {
       display: OutgoingMessageFormat.list,

api/src/cms/services/content.service.ts

@@ -8,12 +8,8 @@
 
 import { Injectable } from '@nestjs/common';
 
-import { Attachment } from '@/attachment/schemas/attachment.schema';
 import { AttachmentService } from '@/attachment/services/attachment.service';
-import {
-  ContentElement,
-  StdOutgoingListMessage,
-} from '@/chat/schemas/types/message';
+import { StdOutgoingListMessage } from '@/chat/schemas/types/message';
 import { ContentOptions } from '@/chat/schemas/types/options';
 import { LoggerService } from '@/logger/logger.service';
 import { BaseService } from '@/utils/generics/base-service';
@@ -53,93 +49,6 @@ export class ContentService extends BaseService<
     return await this.repository.textSearch(query);
   }
 
-  /**
-   * Extracts attachment IDs from content entities, issuing warnings for any issues.
-   *
-   * @param contents - An array of content entities.
-   * @param attachmentFieldName - The name of the attachment field to check for.
-   *
-   * @return A list of attachment IDs.
-   */
-  getAttachmentIds(contents: ContentElement[], attachmentFieldName: string) {
-    return contents.reduce((acc, content) => {
-      if (attachmentFieldName in content) {
-        const attachment = content[attachmentFieldName];
-
-        if (
-          typeof attachment === 'object' &&
-          'attachment_id' in attachment.payload
-        ) {
-          acc.push(attachment.payload.attachment_id);
-        } else {
-          this.logger.error(
-            `Remote attachments have been deprecated, content "${content.title}" is missing the "attachment_id"`,
-          );
-        }
-      } else {
-        this.logger.warn(
-          `Field "${attachmentFieldName}" not found in content "${content.title}"`,
-        );
-      }
-      return acc;
-    }, [] as string[]);
-  }
-
-  /**
-   * Populates attachment fields within content entities with detailed attachment information.
-   *
-   * @param elements - An array of content entities.
-   * @param attachmentFieldName - The name of the attachment field to populate.
-   *
-   * @return A list of content with populated attachment data.
-   */
-  async populateAttachments(
-    elements: ContentElement[],
-    attachmentFieldName: string,
-  ): Promise<ContentElement[]> {
-    const attachmentIds = this.getAttachmentIds(elements, attachmentFieldName);
-
-    if (attachmentIds.length > 0) {
-      const attachments = await this.attachmentService.find({
-        _id: { $in: attachmentIds },
-      });
-
-      const attachmentsById = attachments.reduce(
-        (acc, curr) => {
-          acc[curr.id] = curr;
-          return acc;
-        },
-        {} as { [key: string]: Attachment },
-      );
-      const populatedContents = elements.map((content) => {
-        const attachmentField = content[attachmentFieldName];
-        if (
-          typeof attachmentField === 'object' &&
-          'attachment_id' in attachmentField.payload
-        ) {
-          const attachmentId = attachmentField?.payload?.attachment_id;
-          return {
-            ...content,
-            [attachmentFieldName]: {
-              type: attachmentField.type,
-              payload: {
-                ...(attachmentsById[attachmentId] || attachmentField.payload),
-                url: Attachment.getAttachmentUrl(
-                  attachmentId,
-                  attachmentsById[attachmentId].name,
-                ),
-              },
-            },
-          };
-        } else {
-          return content;
-        }
-      });
-      return populatedContents;
-    }
-    return elements;
-  }
-
   /**
    * Retrieves content based on the provided options and pagination settings.
    *
@@ -177,21 +86,6 @@ export class ContentService extends BaseService<
           sort: ['createdAt', 'desc'],
         });
         const elements = contents.map(Content.toElement);
-        const attachmentFieldName = options.fields.image_url;
-        if (attachmentFieldName) {
-          // Populate attachment when there's an image field
-          return {
-            elements: await this.populateAttachments(
-              elements,
-              attachmentFieldName,
-            ),
-            pagination: {
-              total,
-              skip,
-              limit,
-            },
-          };
-        }
         return {
           elements,
           pagination: {