[O2B-1094] Add runs counts to lhc periods view (#1334)

* calculate runsCount

* add some color

* add color

* add test

* amend test

* rename

Author: xsalonx

lib/database/adapters/LhcPeriodStatisticsAdapter.js

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

lib/database/models/typedefs/SequelizeLhcPeriodStatistics.js

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

lib/domain/entities/LhcPeriodStatistics.js

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

lib/public/app.css

@@ -24,6 +24,10 @@ html, body {
 .b-underline-good { border-bottom: 4px solid var(--color-success); }
 .b-underline-bad { border-bottom: 4px dashed var(--color-danger); }
 
+.bg-light-blue {
+    background-color: var(--color-light-blue) !important;
+}
+
 .overflow {
     height: 1.5rem;
     overflow: hidden;

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

@@ -24,10 +24,15 @@ export const lhcPeriodsActiveColumns = {
     name: {
         name: 'Name',
         visible: true,
-        format: (name) => h('.flex-row.flex-wrap', [
+        format: (name, { runsCount }) => h('.flex-row.flex-wrap', [
             h('.ph1.mh1.w-10', name),
             h('.mh4'),
-            frontLink('runs', 'runs-per-lhc-period', { lhcPeriodName: name }, { class: 'btn mh1' }),
+            frontLink(
+                ['runs', h('sub', `[${runsCount}]`)],
+                'runs-per-lhc-period',
+                { lhcPeriodName: name },
+                { class: `btn mh1 ${runsCount > 0 ? 'bg-light-blue' : ''}` },
+            ),
         ]),
         sortable: true,
         filter: ({ namesFilterModel }) => textFilter(

lib/server/services/lhcPeriod/LhcPeriodStatisticsService.js

@@ -53,6 +53,18 @@ const PDP_BEAM_TYPES_IN_STATISTICS_SUBQUERY = `
         LIMIT 1
     )`;
 
+/**
+ * Subquery to calculate number of runs associated with given LHC Period
+ */
+const RUNS_COUNT_SUBQUERY = `
+    (SELECT COUNT(r.run_number)
+        FROM runs as r
+        WHERE r.lhc_period_id = lhcPeriod.id
+            AND r.definition = 'PHYSICS'
+            AND r.run_quality = 'good'
+)
+`;
+
 /**
  * @typedef LhcPeriodIdentifier object to uniquely identify a lhc period
  * @property {string} [name] the lhc period name
@@ -89,6 +101,10 @@ class LhcPeriodStatisticsService {
             query: PDP_BEAM_TYPES_IN_STATISTICS_SUBQUERY,
             alias: 'beamType',
         });
+        queryBuilder.includeAttribute({
+            query: RUNS_COUNT_SUBQUERY,
+            alias: 'runsCount',
+        });
 
         const data = await LhcPeriodStatisticsRepository.findOne(queryBuilder);
         return data ? lhcPeriodStatisticsAdapter.toEntity(data) : null;
@@ -191,6 +207,11 @@ class LhcPeriodStatisticsService {
             alias: 'beamType',
         });
 
+        queryBuilder.includeAttribute({
+            query: RUNS_COUNT_SUBQUERY,
+            alias: 'runsCount',
+        });
+
         const { count, rows } = await LhcPeriodStatisticsRepository.findAndCountAll(queryBuilder);
 
         return {

test/api/lhcPeriodsStatistics.test.js

@@ -25,6 +25,7 @@ const lhcPeriod_LHC22b = {
         id: 2,
         name: 'LHC22b',
     },
+    runsCount: 1,
 };
 
 const lhcPeriod_LHC22a = {
@@ -39,6 +40,7 @@ const lhcPeriod_LHC22a = {
         id: 1,
         name: 'LHC22a',
     },
+    runsCount: 3,
 };
 
 const lhcPeriod_LHC23f = {
@@ -50,6 +52,7 @@ const lhcPeriod_LHC23f = {
         id: 3,
         name: 'LHC23f',
     },
+    runsCount: 0,
 };
 
 module.exports = () => {

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

@@ -26,6 +26,7 @@ const lhcPeriod_LHC22b = {
         id: 2,
         name: 'LHC22b',
     },
+    runsCount: 1,
 };
 
 const lhcPeriod_LHC22a = {
@@ -40,6 +41,7 @@ const lhcPeriod_LHC22a = {
         id: 1,
         name: 'LHC22a',
     },
+    runsCount: 3,
 };
 
 const lhcPeriod_LHC23f = {
@@ -51,6 +53,7 @@ const lhcPeriod_LHC23f = {
         id: 3,
         name: 'LHC23f',
     },
+    runsCount: 0,
 };
 
 module.exports = () => {

test/public/lhcPeriods/overview.test.js

@@ -192,23 +192,29 @@ 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((p) => `${p}\nruns`);
+        const appendButtonsText = (periodNames) => periodNames.map((name) => `${name}\nruns[${countsPerLhcPeriod[name]}]`);
 
-        let allLhcPeriodNames = await getAllDataFields(page, 'name');
-        expect(allLhcPeriodNames).to.has.all.deep.members(appendButtonsText(['LHC22a']));
+        let allLhcPeriodNameCellsContent = await getAllDataFields(page, 'name');
+        expect(allLhcPeriodNameCellsContent).to.has.all.deep.members(appendButtonsText(['LHC22a']));
 
         const resetFiltersButton = await page.$('#reset-filters');
         expect(resetFiltersButton).to.not.be.null;
         await resetFiltersButton.evaluate((button) => button.click());
         await page.waitForTimeout(100);
 
-        allLhcPeriodNames = await getAllDataFields(page, 'name');
-        expect(allLhcPeriodNames).to.has.all.deep.members(appendButtonsText(['LHC22a', 'LHC22b', 'LHC23f']));
+        allLhcPeriodNameCellsContent = await getAllDataFields(page, 'name');
+        expect(allLhcPeriodNameCellsContent).to.has.all.deep.members(appendButtonsText(['LHC22a', 'LHC22b', 'LHC23f']));
     });
 
     it('should successfuly apply lhc period year filter', async () => {