feat: create summary view for data pass and data pass versions

NarrowsProjects · NarrowsProjects · commit e3037a976e2d · 2026-06-25T11:32:33.000+02:00
diff --git a/lib/database/adapters/DataPassAdapter.js b/lib/database/adapters/DataPassAdapter.js
@@ -20,6 +20,7 @@ class DataPassAdapter {
      */
     constructor() {
         this.toEntity = this.toEntity.bind(this);
+        this.toSummary = this.toSummary.bind(this);
         this.dataPassVersionAdapter = null;
     }
 
@@ -30,13 +31,22 @@ class DataPassAdapter {
      * @returns {DataPass} Converted entity object.
      */
     toEntity(databaseObject) {
-        const {
-            id,
-            name,
-            versions,
-            skimmingStage,
-            isFrozen,
-        } = databaseObject;
+        const { versions = [] } = databaseObject;
+
+        const entity = this.toSummary(databaseObject);
+        entity.versions = versions.map(this.dataPassVersionAdapter.toEntity);
+
+        return entity;
+    }
+
+    /**
+     * Converts the given database object to an entity object.
+     *
+     * @param {SequelizeDataPass} databaseObject Object to convert.
+     * @returns {DataPass} Converted entity object.
+     */
+    toSummary(databaseObject) {
+        const { id, name, skimmingStage, versions = [], isFrozen } = databaseObject;
 
         const runsCount = databaseObject.get('runsCount');
         const simulationPassesCount = databaseObject.get('simulationPassesCount');
@@ -45,9 +55,9 @@ class DataPassAdapter {
         return {
             id,
             name,
-            skimmingStage,
-            versions: (versions ?? []).map(this.dataPassVersionAdapter.toEntity),
+            versions: versions.map(this.dataPassVersionAdapter.toSummary),
             pdpBeamTypes,
+            skimmingStage,
             runsCount,
             simulationPassesCount,
             isFrozen,
diff --git a/lib/database/adapters/DataPassVersionAdapter.js b/lib/database/adapters/DataPassVersionAdapter.js
@@ -20,6 +20,7 @@ class DataPassVersionAdapter {
      */
     constructor() {
         this.toEntity = this.toEntity.bind(this);
+        this.toSummary = this.toSummary.bind(this);
         this.dataPassVersionStatusAdapter = null;
     }
 
@@ -30,32 +31,38 @@ class DataPassVersionAdapter {
      * @returns {DataPass} Converted entity object.
      */
     toEntity(databaseObject) {
+        const entity = this.toSummary(databaseObject);
+        const { id, dataPassId, lastSeen, statusHistory = [], createdAt, updatedAt } = databaseObject;
+
+        entity.statusHistory = statusHistory.map(this.dataPassVersionStatusAdapter.toEntity);
+        entity.id = id;
+        entity.dataPassId = dataPassId;
+        entity.lastSeen = lastSeen;
+        entity.createdAt = createdAt ? new Date(createdAt).getTime() : null;
+        entity.updatedAt = updatedAt ? new Date(updatedAt).getTime() : null;
+
+        return entity;
+    }
+
+    /**
+     * Converts the given database object to an summary object.
+     *
+     * @param {SequelizeDataPass} databaseObject Object to convert.
+     * @returns {DataPass} Converted summary object.
+     */
+    toSummary(databaseObject) {
         const {
-            id,
-            dataPassId,
             description,
             reconstructedEventsCount,
             outputSize,
-            lastSeen,
-
             statusHistory = [],
-
-            createdAt,
-            updatedAt,
         } = databaseObject;
 
         return {
-            id,
-            dataPassId,
             description,
             reconstructedEventsCount,
             outputSize,
-            lastSeen,
-
-            statusHistory: (statusHistory ?? []).map(this.dataPassVersionStatusAdapter.toEntity),
-
-            createdAt: createdAt ? new Date(createdAt).getTime() : null,
-            updatedAt: updatedAt ? new Date(updatedAt).getTime() : null,
+            statusHistory: statusHistory.map(this.dataPassVersionStatusAdapter.toSummary),
         };
     }
 }
diff --git a/lib/database/adapters/DataPassVersionStatusAdapter.js b/lib/database/adapters/DataPassVersionStatusAdapter.js
@@ -43,6 +43,17 @@ class DataPassVersionStatusAdapter {
             createdAt: createdAt ? new Date(createdAt).getTime() : null,
         };
     }
+
+    /**
+     * Converts the given database object to an summary object.
+     *
+     * @param {SequelizeDataPassVersionStatus} databaseObject Object to convert.
+     * @returns {DataPassVersionStatus} Converted summary object.
+     */
+    toSummary(databaseObject) {
+        const { status } = databaseObject;
+        return { status };
+    }
 }
 
 module.exports = { DataPassVersionStatusAdapter };
diff --git a/lib/server/services/dataPasses/DataPassService.js b/lib/server/services/dataPasses/DataPassService.js
@@ -11,7 +11,6 @@
  * or submit itself to any jurisdiction.
  */
 
-const { Op } = require('sequelize');
 const { repositories: { DataPassRepository, LhcPeriodRepository } } = require('../../../database');
 const { dataSource } = require('../../../database/DataSource.js');
 const { dataPassAdapter } = require('../../../database/adapters');
@@ -23,6 +22,7 @@ const { BadParameterError } = require('../../errors/BadParameterError');
 const { SkimmingStage } = require('../../../domain/enums/SkimmingStage');
 const { LogManager } = require('@aliceo2/web-ui');
 const { NonPhysicsProductionsNamesWords } = require('../../../domain/enums/NonPhysicsProductionsNamesWords.js');
+const { dataPassSumary, dataPassVersionSummary } = require('../../views/dataPasses/summary.js');
 
 /**
  * @typedef DataPassIdentifier
@@ -141,12 +141,17 @@ class DataPassService {
             queryBuilder.where('name').not().substring(`\\_${NonPhysicsProductionsNamesWords.DEBUG}`);
         }
 
+        queryBuilder.selectAttributes([...dataPassSumary.attributes]);
+
         const { count, rows } = await DataPassRepository.findAndCountAll(queryBuilder);
-        const dataPassesVersions = await DataPassVersionRepository.findAll({
-            include: 'statusHistory',
-            where: { dataPassId: { [Op.in]: rows.map(({ id }) => id) } },
-            order: [['statusHistory', 'createdAt', 'ASC']],
-        });
+        const dataPassVersionsQueryBuilder = dataSource.createQueryBuilder();
+
+        dataPassVersionsQueryBuilder.selectAttributes([...dataPassVersionSummary.attributes]);
+        dataPassVersionsQueryBuilder.includeAll([...dataPassVersionSummary.include]);
+        dataPassVersionsQueryBuilder.where('dataPassId').oneOf(...rows.map(({ id }) => id));
+        dataPassVersionsQueryBuilder.pushOrders([...dataPassVersionSummary.order]);
+        const dataPassesVersions = await DataPassVersionRepository.findAll(dataPassVersionsQueryBuilder);
+
         const dataPassIdToVersions = dataPassesVersions.reduce((acc, version) => {
             const { dataPassId } = version;
             acc[dataPassId] = [...acc[dataPassId] ?? [], version];
@@ -159,7 +164,7 @@ class DataPassService {
 
         return {
             count: count.length, // When using grouping sequelize returns from finAndCountAll counts per each group
-            rows: rows.map(dataPassAdapter.toEntity),
+            rows: rows.map(dataPassAdapter.toSummary),
         };
     }
 
diff --git a/lib/server/views/dataPasses/summary.js b/lib/server/views/dataPasses/summary.js
@@ -0,0 +1,22 @@
+/**
+ * @license
+ * Copyright CERN and copyright holders of ALICE O2. This software is
+ * distributed under the terms of the GNU General Public License v3 (GPL
+ * Version 3), copied verbatim in the file "COPYING".
+ *
+ * See http://alice-o2.web.cern.ch/license for full licensing information.
+ *
+ * In applying this license CERN does not waive the privileges and immunities
+ * granted to it by virtue of its status as an Intergovernmental Organization
+ * or submit itself to any jurisdiction.
+ */
+
+export const dataPassSumary = {
+    attributes: ['id', 'name', 'skimmingStage', 'isFrozen'],
+};
+
+export const dataPassVersionSummary = {
+    attributes: ['outputSize', 'reconstructedEventsCount', 'description', 'dataPassId'],
+    include: [{ association: 'statusHistory', attributes: ['status'] }],
+    order: [['statusHistory', 'createdAt', 'ASC']],
+};
diff --git a/test/api/dataPasses.test.js b/test/api/dataPasses.test.js
@@ -22,36 +22,18 @@ const { Op } = require('sequelize');
 const { buildUrl } = require('@aliceo2/web-ui');
 const { BkpRoles } = require('../../lib/domain/enums/BkpRoles.js');
 
-const LHC22b_apass1 = {
+const LHC22b_apass1_summary = {
     id: 1,
     name: 'LHC22b_apass1',
     pdpBeamTypes: ['pp'],
     skimmingStage: SkimmingStage.SKIMMABLE,
     isFrozen: false,
     versions: [
         {
-            id: 1,
-            dataPassId: 1,
             description: 'Some random desc',
             reconstructedEventsCount: 50948694,
             outputSize: 56875682112600,
-            lastSeen: 108,
-            statusHistory: [
-                {
-                    createdAt: 1704884400000,
-                    dataPassVersionId: 1,
-                    id: 1,
-                    status: 'Running',
-                },
-                {
-                    createdAt: 1704885060000,
-                    dataPassVersionId: 1,
-                    id: 2,
-                    status: 'Deleted',
-                },
-            ],
-            createdAt: 1704884400000,
-            updatedAt: 1704884400000,
+            statusHistory: [{ status: 'Running' }, { status: 'Deleted' }],
         },
     ],
     runsCount: 3,
@@ -94,7 +76,7 @@ module.exports = () => {
                     expect(meta).to.be.eql({ page: { totalCount: 1, pageCount: 1 } });
                     expect(data).to.be.an('array');
                     expect(data).to.be.lengthOf(1);
-                    expect(data[0]).to.be.eql(LHC22b_apass1);
+                    expect(data[0]).to.be.eql(LHC22b_apass1_summary);
 
                     done();
                 });
diff --git a/test/lib/server/services/dataPasses/DataPassService.test.js b/test/lib/server/services/dataPasses/DataPassService.test.js
@@ -59,6 +59,24 @@ const LHC22b_apass1 = {
     simulationPassesCount: 1,
 };
 
+const LHC22b_apass1_summary = {
+    id: 1,
+    name: 'LHC22b_apass1',
+    pdpBeamTypes: ['pp'],
+    skimmingStage: SkimmingStage.SKIMMABLE,
+    isFrozen: false,
+    versions: [
+        {
+            description: 'Some random desc',
+            reconstructedEventsCount: 50948694,
+            outputSize: 56875682112600,
+            statusHistory: [{ status: 'Running' }, { status: 'Deleted' }],
+        },
+    ],
+    runsCount: 3,
+    simulationPassesCount: 1,
+};
+
 module.exports = () => {
     before(resetDatabaseContent);
 
@@ -95,7 +113,7 @@ module.exports = () => {
             };
             const { rows: dataPasses } = await dataPassService.getAll(dto.query);
             expect(dataPasses).to.be.lengthOf(1);
-            expect(dataPasses[0]).to.be.eql(LHC22b_apass1);
+            expect(dataPasses[0]).to.be.eql(LHC22b_apass1_summary);
         });
 
         it('should successfully filter data passes on ids', async () => {
