[O2B-1126] Show data passes counts (#1346)

* add migration

* add references

* add model associations

* add jsonRequest method

* add abstract synchronizer

* cleanup

* cleanup

* cleanup

* cleanup

* cleanup

* simplify

* cleanup

* cleanup

* add monalisa service

* docs annotation

* refactor

* change main method to return void instead of boolean

* db action

* handle field mappings

* remove abstract class

* single concrete class

* add variables

* use env vars

* linter

* refactor

* docs refactor

* typo

* refactor

* refactor

* fixes

* refactored

* not then chain

* refactor{

* types

* rename

* use seuqlize to fetch last runs

* add type, use URL class

* remove file read

* docs

* add synchronizer factory

* add docs

* cleanup

* no await

* refactor

* typdef

* refactor context

* rename

* docs

* docs

* rename

* working

* rename

* rename

* add test for getting data passes

* add test for getting data passes

* sync test

* add test for data pass sync

* amend data

* add details fetching

* add env

* fetching data passes and details

* rename

* add tests

* rename

* reduce test data size

* docs

* refactor

* typo

* typo

* docs

* rename

* docs

* cleanup

* remove dead code

* add service

* cleanup

* add filtering by periods

* add data passes seeders

* rename

* add data passes service tests

* test

* revoke unfound changes

* add controllers

* rename

* refactor

* refactor

* refactor

* no dependency

* refactor

* refactor

* refactor:

* reaname'

* rename

* cleanup

* docs

* reaname

* refactor

* add router

* restore

* amend test

* expose api

* add test

* add tests

* amend

* docs

* amend test

* amend

* add Data Passes page

* expose page

* styling

* add reset method

* rename

* use sorting

* add unit

* docs

* amend test

* rename

* rename

* use filtering by name

* add test

* use generic model

* aboid undefined destruciton error

* use proper method

* add to to api

* display on front

* add color

* docs

* amend test

* amend tests

* amend test

* amend test

* styling

* no await

* use new styling

* amend test

* amend sequelize association

* refactor

* put differnt styles

* move file

* refactor

* amend test

* amend

* revoke

* Update lib/public/views/lhcPeriods/ActiveColumns/lhcPeriodsActiveColumns.js

Co-authored-by: Martin Boulais <31805063+martinboulais@users.noreply.github.com>

* Update lib/public/views/lhcPeriods/ActiveColumns/lhcPeriodsActiveColumns.js

Co-authored-by: Martin Boulais <31805063+martinboulais@users.noreply.github.com>

* linter

* fix test

* resize

---------

Co-authored-by: Martin Boulais <31805063+martinboulais@users.noreply.github.com>

Author: xsalonx

lib/database/adapters/LhcPeriodStatisticsAdapter.js

@@ -33,12 +33,14 @@ class LhcPeriodStatisticsAdapter {
         const { id, avgCenterOfMassEnergy, lhcPeriod } = databaseObject;
         const distinctEnergies = databaseObject.get('distinctEnergies');
         const beamType = databaseObject.get('beamType');
+        const dataPassesCount = databaseObject.get('dataPassesCount');
         const runsCount = databaseObject.get('runsCount');
         const entity = {
             id,
             avgCenterOfMassEnergy,
             distinctEnergies: distinctEnergies?.split(',').map((energy) => Number(energy)) ?? [],
             beamType,
+            dataPassesCount,
             runsCount,
         };
         entity.lhcPeriod = lhcPeriod ? this.lhcPeriodAdapter.toEntity(lhcPeriod) : null;

lib/database/models/lhcPeriod.js

@@ -33,7 +33,7 @@ module.exports = (sequelize) => {
 
     LhcPeriod.associate = (models) => {
         LhcPeriod.hasMany(models.Run, { foreignKey: 'lhcPeriodId', as: 'runs' });
-        LhcPeriod.hasOne(models.DataPass);
+        LhcPeriod.hasMany(models.DataPass, { foreignKey: 'lhcPeriodId', as: 'dataPass' });
     };
 
     return LhcPeriod;

lib/database/models/typedefs/SequelizeLhcPeriodStatistics.js

@@ -18,5 +18,6 @@
  * @property {number|null} avgCenterOfMassEnergy
  * @property {number[]|null} distinctEnergies
  * @property {SequelizeLhcPeriod} lhcPeriod
+ * @property {number} dataPassesCount
  * @property {number} runsCount
  */

lib/domain/entities/LhcPeriodStatistics.js

@@ -18,5 +18,6 @@
  * @property {number|null} avgCenterOfMassEnergy
  * @property {number[]} distinctEnergies
  * @property {LhcPeriod} lhcPeriod
+ * @property {number} dataPassesCount
  * @property {number} runsCount
  */

lib/public/views/lhcPeriods/ActiveColumns/lhcPeriodsActiveColumns.js

@@ -14,8 +14,8 @@
 import { h } from '/js/src/index.js';
 import { formatDistinctLhcBeamEnergies } from '../format/formatDistinctLhcBeamEnergies.js';
 import { formatLhcPeriodYear } from '../format/formatYear.js';
-import { frontLink } from '../../../components/common/navigation/frontLink.js';
 import { textFilter } from '../../../components/Filters/common/filters/textFilter.js';
+import { frontLink } from '../../../components/common/navigation/frontLink.js';
 
 /**
  * List of active columns for a generic periods table
@@ -24,29 +24,48 @@ export const lhcPeriodsActiveColumns = {
     name: {
         name: 'Name',
         visible: true,
-        format: (name, { id, runsCount }) => h('.flex-row.flex-wrap', [
-            h('.ph1.mh1.w-10', name),
-            h('.mh4'),
-            frontLink(
-                ['Runs', h('.badge', `(${runsCount})`)],
-                'runs-per-lhc-period',
-                { lhcPeriodName: name },
-                { class: `mh1 ${runsCount === 0 ? 'gray-darker' : ''}` },
-            ),
-            frontLink('Data Passes', 'data-passes-per-lhc-period-overview', { lhcPeriodId: id }, { class: 'mh1' }),
-        ]),
         sortable: true,
         filter: ({ namesFilterModel }) => textFilter(
             namesFilterModel,
             { class: 'w-75 mt1', placeholder: 'e.g. LHC22a, lhc23b, ...' },
         ),
+        classes: 'w-15',
+    },
+
+    associatedRuns: {
+        name: 'Runs',
+        visible: true,
+        format: (_, { name, runsCount }) =>
+            runsCount === 0
+                ? 'No runs'
+                : frontLink(
+                    h('.flex-row.g3', [h('.f6.badge.bg-gray-light.black', runsCount), 'Runs']),
+                    'runs-per-lhc-period',
+                    { lhcPeriodName: name },
+                ),
+        classes: 'w-15',
+    },
+
+    associatedDataPasses: {
+        name: 'Data Passes',
+        visible: true,
+        format: (_, { id, dataPassesCount }) =>
+            dataPassesCount === 0
+                ? 'No data pass'
+                : frontLink(
+                    h('.flex-row.g3', [h('.f6.badge.bg-gray-light.black', dataPassesCount), 'Data Passes']),
+                    'data-passes-per-lhc-period-overview',
+                    { lhcPeriodId: id },
+                ),
+        classes: 'w-20',
     },
 
     avgCenterOfMassEnergy: {
-        name: ['Avg ', h('img', { src: '/assets/center-of-mass-energy.svg' }), ' [GeV]'],
+        name: h('.flex-wrap', ['Avg ', h('img', { src: '/assets/center-of-mass-energy.svg' }), '[GeV]']),
         visible: true,
         sortable: true,
         format: (avgCenterOfMassEnergy) => avgCenterOfMassEnergy ? `${Number(avgCenterOfMassEnergy).toFixed(2)}` : '-',
+        classes: 'w-10',
     },
 
     year: {
@@ -58,6 +77,7 @@ export const lhcPeriodsActiveColumns = {
             yearsFilterModel,
             { class: 'w-75 mt1', placeholder: 'e.g. 2022, 2023, ...' },
         ),
+        classes: 'w-7',
     },
 
     beamType: {
@@ -69,6 +89,7 @@ export const lhcPeriodsActiveColumns = {
             beamTypesFilterModel,
             { class: 'w-75 mt1', placeholder: 'e.g. pp, PbPb' },
         ),
+        classes: 'w-7',
     },
 
     distinctEnergies: {

lib/server/services/lhcPeriod/LhcPeriodStatisticsService.js

@@ -65,6 +65,15 @@ const RUNS_COUNT_SUBQUERY = `
 )
 `;
 
+/*
+ * Subquery to calculate number of data passes associated with given LHC Period
+ */
+const DATA_PASSES_COUNT_SUBQUERY = `
+   (SELECT COUNT(dp.id)
+       FROM data_passes as dp
+       WHERE dp.lhc_period_id = lhcPeriod.id
+   )`;
+
 /**
  * @typedef LhcPeriodIdentifier object to uniquely identify a lhc period
  * @property {string} [name] the lhc period name
@@ -105,6 +114,10 @@ class LhcPeriodStatisticsService {
             query: RUNS_COUNT_SUBQUERY,
             alias: 'runsCount',
         });
+        queryBuilder.includeAttribute({
+            query: DATA_PASSES_COUNT_SUBQUERY,
+            alias: 'dataPassesCount',
+        });
 
         const data = await LhcPeriodStatisticsRepository.findOne(queryBuilder);
         return data ? lhcPeriodStatisticsAdapter.toEntity(data) : null;
@@ -206,6 +219,10 @@ class LhcPeriodStatisticsService {
             query: PDP_BEAM_TYPES_IN_STATISTICS_SUBQUERY,
             alias: 'beamType',
         });
+        queryBuilder.includeAttribute({
+            query: DATA_PASSES_COUNT_SUBQUERY,
+            alias: 'dataPassesCount',
+        });
 
         queryBuilder.includeAttribute({
             query: RUNS_COUNT_SUBQUERY,

test/api/lhcPeriodsStatistics.test.js

@@ -26,6 +26,7 @@ const lhcPeriod_LHC22b = {
         name: 'LHC22b',
     },
     runsCount: 1,
+    dataPassesCount: 2,
 };
 
 const lhcPeriod_LHC22a = {
@@ -41,6 +42,8 @@ const lhcPeriod_LHC22a = {
         name: 'LHC22a',
     },
     runsCount: 3,
+    dataPassesCount: 1,
+
 };
 
 const lhcPeriod_LHC23f = {
@@ -52,6 +55,7 @@ const lhcPeriod_LHC23f = {
         id: 3,
         name: 'LHC23f',
     },
+    dataPassesCount: 0,
     runsCount: 0,
 };
 

test/lib/server/monalisa-synchronization/MonALISASynchronizer.test.js

@@ -18,10 +18,13 @@ const { repositories: { DataPassRepository, LhcPeriodRepository } } = require('.
 const { dataSource } = require('../../../../lib/database/DataSource.js');
 
 const { extractLhcPeriod } = require('../../../../lib/server/utilities/extractLhcPeriod');
+const { resetDatabaseContent } = require('../../../utilities/resetDatabaseContent.js');
 
 const YEAR_LOWER_LIMIT = 2023;
 
 module.exports = () => {
+    after(async () => resetDatabaseContent());
+
     it('Should get data with respect to given year limit and in correct format', async () => {
         const monALISAClient = getMockMonALISAClient(YEAR_LOWER_LIMIT);
         const mockDataPasses = await monALISAClient.getDataPasses();

test/lib/server/services/lhcPeriod/LhcPeriodStatisticsService.test.js

@@ -27,6 +27,7 @@ const lhcPeriod_LHC22b = {
         name: 'LHC22b',
     },
     runsCount: 1,
+    dataPassesCount: 2,
 };
 
 const lhcPeriod_LHC22a = {
@@ -42,6 +43,8 @@ const lhcPeriod_LHC22a = {
         name: 'LHC22a',
     },
     runsCount: 3,
+    dataPassesCount: 1,
+
 };
 
 const lhcPeriod_LHC23f = {
@@ -53,6 +56,7 @@ const lhcPeriod_LHC23f = {
         id: 3,
         name: 'LHC23f',
     },
+    dataPassesCount: 0,
     runsCount: 0,
 };
 

test/public/lhcPeriods/overview.test.js

@@ -52,6 +52,8 @@ module.exports = () => {
         // Expectations of header texts being of a certain datatype
         const headerDatatypes = {
             name: (name) => periodNameRegex.test(name),
+            associatedRuns: (display) => /(No runs)|(\d+\nRuns)/.test(display),
+            associatedDataPasses: (display) => /(No data passes)|(\d+\nData Passes)/.test(display),
             year: (year) => !isNaN(year),
             beamType: (beamType) => allowedBeamTypesDisplayes.has(beamType),
             avgCenterOfMassEnergy: (avgCenterOfMassEnergy) => !isNaN(avgCenterOfMassEnergy),
@@ -192,29 +194,16 @@ module.exports = () => {
 
         await page.waitForTimeout(100);
 
-        const countsPerLhcPeriod = {
-            LHC22b: 1,
-            LHC22a: 3,
-            LHC23f: 0,
-        };
-
-        /**
-         * As @see getAllDataFields returns innerText from cells, in case of lhcPeriod.name column, text from inner buttons is also taken.
-         * @param {string[]} periodNames list of names
-         * @return {string[]} cells content
-         */
-        const appendButtonsText = (periodNames) => periodNames.map((name) => `${name}\nRuns(${countsPerLhcPeriod[name]})\nData Passes`);
-
         let allLhcPeriodNameCellsContent = await getAllDataFields(page, 'name');
-        expect(allLhcPeriodNameCellsContent).to.has.all.deep.members(appendButtonsText(['LHC22a']));
+        expect(allLhcPeriodNameCellsContent).to.has.all.deep.members(['LHC22a']);
 
         const resetFiltersButton = await page.$('#reset-filters');
         expect(resetFiltersButton).to.not.be.null;
         await resetFiltersButton.evaluate((button) => button.click());
         await page.waitForTimeout(100);
 
         allLhcPeriodNameCellsContent = await getAllDataFields(page, 'name');
-        expect(allLhcPeriodNameCellsContent).to.has.all.deep.members(appendButtonsText(['LHC22a', 'LHC22b', 'LHC23f']));
+        expect(allLhcPeriodNameCellsContent).to.has.all.deep.members(['LHC22a', 'LHC22b', 'LHC23f']);
     });
 
     it('should successfuly apply lhc period year filter', async () => {