Add new 'POST /vN/attachments/byIds' API endpoint

The new endpoint returns attachments by their IDs. Request body: {"ids": [...]}. Response body: { "attachments": [...], "users": [...], "idsNotFound": [...] }.

Author: davidmz

CHANGELOG.md

@@ -50,6 +50,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   [app/serializers/v2/attachment.ts](app/serializers/v2/attachment.ts) file.
 - The new `GET /vN/attachments/:attId` API endpoint returns the attachment by
   its ID.
+- The new `POST /vN/attachments/byIds` API endpoint returns attachments by their
+  IDs. Request body: `{"ids": [...]}`. Response body: `{ "attachments": [...],
+  "users": [...], "idsNotFound": [...] }`.
 - The new `GET /vN/attachments/:attId/:type` API endpoint returns the preview or
   the original of the attachment. The _type_ parameter can be 'original',
   'image', 'video' or 'audio'. The returned data is a JSON object with the following

app/controllers/api/v1/AttachmentsController.js

@@ -3,6 +3,7 @@ import compose from 'koa-compose';
 import { isInt } from 'validator';
 import { lookup } from 'mime-types';
 import { mediaType } from '@hapi/accept';
+import { difference } from 'lodash';
 
 import {
   reportError,
@@ -12,11 +13,12 @@ import {
 } from '../../../support/exceptions';
 import { serializeAttachment } from '../../../serializers/v2/attachment';
 import { serializeUsersByIds } from '../../../serializers/v2/user';
-import { authRequired } from '../../middlewares';
+import { authRequired, inputSchemaRequired } from '../../middlewares';
 import { dbAdapter, Attachment } from '../../../models';
 import { startAttachmentsSanitizeJob } from '../../../jobs/attachments-sanitize';
 import { currentConfig } from '../../../support/app-async-context';
 import { getBestVariant } from '../../../support/media-files/geometry';
+import { getAttachmentsByIdsInputSchema } from '../v2/data-schemes/attachmants';
 
 export default class AttachmentsController {
   app;
@@ -285,4 +287,36 @@ export default class AttachmentsController {
       ctx.body = response;
     }
   }
+
+  getByIds = compose([
+    inputSchemaRequired(getAttachmentsByIdsInputSchema),
+    async (ctx) => {
+      const maxAttByIds = 100;
+
+      const { user: viewer, apiVersion } = ctx.state;
+      const { ids } = ctx.request.body;
+
+      const hasMore = ids.length > maxAttByIds;
+
+      if (hasMore) {
+        ids.length = maxAttByIds;
+      }
+
+      const atts = (await dbAdapter.getAttachmentsByIds(ids)).filter(Boolean);
+
+      const attachments = atts.map((a) => serializeAttachment(a, apiVersion));
+      const users = await serializeUsersByIds(
+        atts.map((a) => a.userId),
+        viewer?.id,
+      );
+      const idsFound = atts.map((p) => p.id);
+      const idsNotFound = difference(ids, idsFound);
+
+      ctx.body = {
+        attachments,
+        users,
+        idsNotFound,
+      };
+    },
+  ]);
 }

app/controllers/api/v2/data-schemes/attachmants.js

@@ -0,0 +1,19 @@
+import definitions from '../../v1/data-schemes/definitions';
+
+export const getAttachmentsByIdsInputSchema = {
+  $schema: 'http://json-schema.org/schema#',
+
+  definitions,
+
+  type: 'object',
+  required: ['ids'],
+
+  properties: {
+    ids: {
+      type: 'array',
+      items: { $ref: '#/definitions/uuid' },
+      uniqueItems: true,
+      default: [],
+    },
+  },
+};

app/models/auth-tokens/app-tokens-scopes.ts

@@ -108,6 +108,7 @@ export const appTokensScopes = [
       'GET /vN/calendar/:username/:year/:month/:day',
       'GET /vN/attachments/:attId',
       'GET /vN/attachments/:attId/:type',
+      'POST /vN/attachments/byIds',
     ],
   },
   {

app/routes/api/v2/AttachmentsRoute.js

@@ -8,4 +8,6 @@ export default function addRoutes(app) {
   app.post('/attachments/my/sanitize', controller.mySanitize);
   app.get('/attachments/:attId', controller.getById);
   app.get('/attachments/:attId/:type', controller.getPreview);
+  // We use POST here because this method can accept many post IDs
+  app.post('/attachments/byIds', controller.getByIds);
 }

app/support/DbAdapter/index.d.ts

@@ -223,6 +223,7 @@ export class DbAdapter {
 
   // Attachments
   getAttachmentById(id: UUID): Promise<Attachment | null>;
+  getAttachmentsByIds(ids: UUID[]): Promise<(Attachment | null)[]>;
   getPostAttachments(id: UUID): Promise<UUID[]>;
   getAttachmentsOfPost(postId: UUID): Promise<Attachment[]>;
   listAttachments(options: ListAttachmentsOptions): Promise<Attachment[]>;

test/functional/attachments.js

@@ -419,10 +419,12 @@ describe('Attachments', () => {
   });
 
   describe('List attachments', () => {
-    let mars;
+    let mars, attIds;
     before(async () => {
       mars = await createTestUser('mars');
 
+      attIds = [];
+
       for (let i = 0; i < 10; i++) {
         const data = new FormData();
         data.append(
@@ -431,7 +433,8 @@ describe('Attachments', () => {
           `test${i + 1}.txt`,
         );
         // eslint-disable-next-line no-await-in-loop
-        await performJSONRequest('POST', '/v1/attachments', data, authHeaders(mars));
+        const resp = await performJSONRequest('POST', '/v1/attachments', data, authHeaders(mars));
+        attIds.push(resp.attachments.id);
       }
     });
 
@@ -474,6 +477,27 @@ describe('Attachments', () => {
       }
     });
 
+    it(`should get Mars'es attachments by ids`, async () => {
+      const otherId = '00000000-0000-4000-8000-000000000001';
+      const ids = [...attIds.slice(0, 4), otherId];
+      const resp = await performJSONRequest(
+        'POST',
+        '/v2/attachments/byIds',
+        { ids },
+        authHeaders(mars),
+      );
+      expect(resp, 'to satisfy', {
+        attachments: [
+          { fileName: 'test1.txt' },
+          { fileName: 'test2.txt' },
+          { fileName: 'test3.txt' },
+          { fileName: 'test4.txt' },
+        ],
+        users: [{ id: mars.user.id }],
+        idsNotFound: [otherId],
+      });
+    });
+
     it(`should list the rest of Mars'es attachments`, async () => {
       const resp = await performJSONRequest(
         'GET',