feat: add bulk metadata to datasetorders

Author: PierreJeanjacquot

api/openapi.yaml

@@ -1135,6 +1135,12 @@ components:
         remaining:
           type: number
 
+    OrderBulkMetadata:
+      properties:
+        bulk:
+          type: boolean
+          example: false
+
     AppOrder:
       properties:
         app:
@@ -1248,6 +1254,7 @@ components:
     DatasetOrderWithMetadata:
       allOf:
         - $ref: '#/components/schemas/OrderMetadata'
+        - $ref: '#/components/schemas/OrderBulkMetadata'
         - type: object
           properties:
             order:

api/src/models/datasetorderModel.js

@@ -2,6 +2,7 @@ import { Schema } from 'mongoose';
 import { getMongoose } from '../loaders/mongoose.js';
 import { logger } from '../utils/logger.js';
 import { option, schema } from './common.js';
+import { isDatasetBulkOrder } from '../utils/order-utils.js';
 
 const {
   AddressSchema,
@@ -20,6 +21,16 @@ const log = logger.extend('models:datasetorderModel');
 
 const connectedModels = {};
 
+const toJSON = {
+  ...orderToJsonOption.toJSON,
+  transform(doc, ret) {
+    // Apply base transform
+    orderToJsonOption.toJSON.transform(doc, ret);
+    // Add bulk field
+    ret.bulk = isDatasetBulkOrder(ret?.order);
+  },
+};
+
 const datasetorderSchema = new Schema(
   {
     orderHash: { ...Bytes32Schema, unique: true, index: true },
@@ -42,7 +53,7 @@ const datasetorderSchema = new Schema(
     signer: { ...AddressSchema, index: true },
   },
   {
-    ...orderToJsonOption,
+    toJSON,
   },
 );
 

api/src/utils/order-utils.js

@@ -139,11 +139,16 @@ const excludeTagArray = (tagArray) =>
     })
     .filter((e) => e !== null);
 
+const isDatasetBulkOrder = (order = {}) => {
+  return order?.volume >= Number.MAX_SAFE_INTEGER && order?.datasetprice === 0;
+};
+
 export {
   OBJ_MAP,
   STATUS_MAP,
   TAG_MAP,
   UNPUBLISH_TARGET_MAP,
   tagToArray,
   excludeTagArray,
+  isDatasetBulkOrder,
 };

api/test/datasetorders.test.js

@@ -1829,7 +1829,7 @@ describe('Offchain marketplace', () => {
     });
 
     test('GET /datasetorders (bulkOnly filter)', async () => {
-      const { data, status } = await request
+      const onlyBulkRes = await request
         .get(
           buildQuery('/datasetorders', {
             chainId, // *
@@ -1838,12 +1838,40 @@ describe('Offchain marketplace', () => {
           }),
         )
         .then(parseResult);
-      expect(status).toBe(OK_STATUS);
-      expect(data.ok).toBe(true);
-      expect(data.count).toBe(bulkOrders.length);
-      expect(data.orders).toBeDefined();
-      expect(Array.isArray(data.orders)).toBe(true);
-      expect(data.orders.length).toBe(bulkOrders.length);
+      expect(onlyBulkRes.status).toBe(OK_STATUS);
+      expect(onlyBulkRes.data.ok).toBe(true);
+      expect(onlyBulkRes.data.count).toBe(bulkOrders.length);
+      expect(onlyBulkRes.data.orders).toBeDefined();
+      expect(Array.isArray(onlyBulkRes.data.orders)).toBe(true);
+      expect(onlyBulkRes.data.orders.length).toBe(bulkOrders.length);
+      onlyBulkRes.data.orders.forEach((e) => {
+        expect(e.bulk).toBe(true);
+      });
+
+      const notOnlyBulkRes = await request
+        .get(
+          buildQuery('/datasetorders', {
+            chainId, // *
+            dataset: datasetAddress, // *
+            // bulkOnly: false,
+          }),
+        )
+        .then(parseResult);
+      expect(notOnlyBulkRes.status).toBe(OK_STATUS);
+      expect(notOnlyBulkRes.data.ok).toBe(true);
+      expect(notOnlyBulkRes.data.count).toBe(publicOrders.length);
+      expect(notOnlyBulkRes.data.orders).toBeDefined();
+      expect(Array.isArray(notOnlyBulkRes.data.orders)).toBe(true);
+      notOnlyBulkRes.data.orders.forEach((e) => {
+        if (
+          e.order.volume >= Number.MAX_SAFE_INTEGER &&
+          e.order.datasetprice === 0
+        ) {
+          expect(e.bulk).toBe(true);
+        } else {
+          expect(e.bulk).toBe(false);
+        }
+      });
     });
 
     test('GET /datasetorders (isAppStrict = true & app = undefined): should return public orders including "any" app', async () => {