Merge branch 'main' into feature/O2B-1489/Add-filtering-panel-to-environments-page

Author: graduta

lib/database/models/typedefs/SequalizeBeamMode.js

@@ -0,0 +1,21 @@
+/**
+ * @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.
+ */
+
+/**
+ * @typedef SequelizeBeamMode
+ *
+ * BeamMode is currently a string column in the runs table, but we define this typedef as if it were a full model for future use.
+ * BeamMode should become independent entity in the future. [O2B-1499]
+ *
+ * @property {string} name
+ */

lib/database/seeders/20220503120937-lhc-fills.js

@@ -63,7 +63,7 @@ module.exports = {
                     },
                     {
                         fill_number: 6,
-                        beam_type: 'PROTON-PROTON',
+                        beam_type: ' PROTON-PROTON ',
                         stable_beams_start: '2019-08-08 11:00:00',
                         stable_beams_end: '2019-08-08 23:00:00',
                         stable_beams_duration: 60 * 60 * 12,

lib/public/components/common/selection/infoLoggerButtonGroup/buttonLinkWithDropdown.js

@@ -36,7 +36,7 @@ export const buttonLinkWithDropdown = (linkContent, page, parameters, dropdownBo
             DropdownComponent(
                 h('.btn.btn-group-item.last-item', iconCaretBottom()),
                 h(
-                    '.flex-column.p2.g3',
+                    '.flex-column.p2.g2',
                     dropdownBody,
                 ),
             ),

lib/public/components/common/table/table.js

@@ -94,6 +94,7 @@ const parseColumnsConfiguration = (columns, currentProfile) => {
  * all predecesors of the node returned by this function must have display property column-flex and height: 100%
  * @property {boolean} singleWrapper have effect only when some scroll is enabled.
  * If true all divs wrapping table element are merged to single on.
+ * @property {string} tableClasses The classes for the table, this appends to .freeze-first-column if present.
  */
 
 /**
@@ -137,6 +138,7 @@ export const table = (
         freezeFirstColumn = false,
         verticalScrollEnabled = false,
         singleWrapper = false,
+        tableClasses = '',
     } = tableConfiguration || {};
     const { idKey, displayedColumns } = parseColumnsConfiguration(columns, currentProfile);
 
@@ -150,7 +152,8 @@ export const table = (
     }
 
     const scrollEnabled = horizontalScrollEnabled || verticalScrollEnabled;
-    const optionalTableClassesExpression = freezeFirstColumn && horizontalScrollEnabled ? '.freeze-first-column' : '';
+    let optionalTableClassesExpression = freezeFirstColumn && horizontalScrollEnabled ? '.freeze-first-column' : '';
+    optionalTableClassesExpression += tableClasses;
 
     const firstLevelWrapperClasses =
         (verticalScrollEnabled ? '.sticky-table-wrapper' : '') +

lib/public/services/lhcFill/LhcFillStatisticsExtractor.js

@@ -31,7 +31,7 @@ export class LhcFillStatisticsExtractor {
      * @param {Run[]} [runs=[]] the list of runs to consider to compute statistics (only physics run will be added).
      *     This is optional and runs can be added independently later on using {@see addRun}, for performances purpose
      */
-    constructor({ stableBeamsStart, stableBeamsEnd, stableBeamsDuration }, runs = []) {
+    constructor({ stableBeamsStart, stableBeamsEnd, stableBeamsDuration, collidingBunchesCount }, runs = []) {
         this._stableBeamsStart = stableBeamsStart;
         this._stableBeamsEnd = stableBeamsEnd;
         // Stable beam duration is in seconds in LHC fill
@@ -45,6 +45,8 @@ export class LhcFillStatisticsExtractor {
         this._totalCtfFileSize = 0;
         this._totalTfFileSize = 0;
 
+        this._collidingBunchesCount = collidingBunchesCount;
+
         for (const run of runs) {
             this.addRun(run);
         }
@@ -151,6 +153,7 @@ export class LhcFillStatisticsExtractor {
             efficiencyLossAtEnd,
             meanRunDuration: totalRunsDuration / this._rawTimeSegments.length,
             runsCoverage,
+            collidingBunchesCount: this._collidingBunchesCount,
             totalCtfFileSize: this._totalCtfFileSize,
             totalTfFileSize: this._totalTfFileSize,
         };

lib/public/utilities/formatting/formatBeamType.js

@@ -0,0 +1,28 @@
+/**
+ *  @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.
+ */
+import { h } from '/js/src/index.js';
+
+/**
+ * Format the beam type into a formatted string
+ *
+ * @param {string|null} beamType the time loss to format
+ * @return {vnode} the formatted result
+ */
+export const formatBeamType = (beamType = '') => {
+    const [beamOneType = '', beamTwoType = ''] = beamType?.split('-') ?? [];
+    if (beamOneType !== '' && beamTwoType !== '') {
+        return h('', [beamOneType.trim(), h('br'), beamTwoType.trim()]);
+    } else {
+        return h('', '-');
+    }
+};

lib/public/views/LhcFills/ActiveColumns/lhcFillsActiveColumns.js

@@ -16,10 +16,13 @@ import { formatTimestamp } from '../../../utilities/formatting/formatTimestamp.j
 import { formatDuration } from '../../../utilities/formatting/formatDuration.mjs';
 import { formatPercentage } from '../../../utilities/formatting/formatPercentage.js';
 import { CopyToClipboardComponent, h } from '/js/src/index.js';
+import { iconPlus } from '/js/src/icons.js';
 import { formatRunsList } from '../../Runs/format/formatRunsList.js';
 import { formatLhcFillsTimeLoss } from '../format/formatLhcFillsTimeLoss.js';
 import { buttonLinkWithDropdown } from '../../../components/common/selection/infoLoggerButtonGroup/buttonLinkWithDropdown.js';
 import { infologgerLinksComponents } from '../../../components/common/externalLinks/infologgerLinksComponents.js';
+import { formatBeamType } from '../../../utilities/formatting/formatBeamType.js';
+import { frontLink } from '../../../components/common/navigation/frontLink.js';
 
 /**
  * List of active columns for a lhc fills table
@@ -37,6 +40,12 @@ export const lhcFillsActiveColumns = {
             [
                 h(CopyToClipboardComponent, { value: fillNumber, id: fillNumber }, 'Copy Fill Number'),
                 ...infologgerLinksComponents({ runNumbers: runs.map(({ runNumber }) => runNumber) }),
+                frontLink(
+                    [iconPlus(), ' Add log to this fill'],
+                    'log-create',
+                    { lhcFillNumbers: [fillNumber] },
+                    { id: 'create-log', class: 'btn btn-primary h2' },
+                ),
             ],
         ),
         profiles: {
@@ -98,25 +107,6 @@ export const lhcFillsActiveColumns = {
             },
         },
     },
-    beamType: {
-        name: 'Beam Type',
-        visible: true,
-        size: 'w-8',
-        format: (value) => value ? value : '-',
-    },
-    efficiency: {
-        name: 'Fill Efficiency',
-        visible: true,
-        size: 'w-8',
-        format: (efficiency) => formatPercentage(efficiency),
-        profiles: {
-            lhcFill: true,
-            environment: true,
-            home: {
-                size: 'w-20',
-            },
-        },
-    },
     timeLossAtStart: {
         name: 'Before 1st run',
         visible: true,
@@ -125,7 +115,7 @@ export const lhcFillsActiveColumns = {
     },
     timeLossAtEnd: {
         name: 'After last run',
-        visible: true,
+        visible: false,
         size: 'w-8',
         format: (duration, lhcFill) => formatLhcFillsTimeLoss(duration, lhcFill.efficiencyLossAtEnd, false),
     },
@@ -141,6 +131,31 @@ export const lhcFillsActiveColumns = {
         size: 'w-8',
         format: (duration) => formatDuration(duration),
     },
+    efficiency: {
+        name: 'Fill Efficiency',
+        visible: true,
+        size: 'w-8',
+        format: (efficiency) => formatPercentage(efficiency),
+        profiles: {
+            lhcFill: true,
+            environment: true,
+            home: {
+                size: 'w-20',
+            },
+        },
+    },
+    beamType: {
+        name: 'Beam Type',
+        visible: true,
+        size: 'w-8',
+        format: (value) => formatBeamType(value),
+    },
+    collidingBunches: {
+        name: 'Colliding bunches',
+        visible: true,
+        size: 'w-8',
+        format: (duration, lhcFill) => lhcFill.collidingBunchesCount ? lhcFill.collidingBunchesCount : '-',
+    },
     fillingSchemeName: {
         name: 'Scheme name',
         visible: true,

lib/public/views/LhcFills/LhcFills.js

@@ -29,7 +29,7 @@ export default class LhcFills extends Observable {
         this.model = model;
 
         // Sub-models
-        this._overviewModel = new LhcFillsOverviewModel();
+        this._overviewModel = new LhcFillsOverviewModel(true);
         this._overviewModel.bubbleTo(this);
 
         this._detailsModel = new LhcFillDetailsModel();

lib/public/views/LhcFills/Overview/index.js

@@ -65,7 +65,7 @@ const showLhcFillsTable = (lhcFillsOverviewModel) => {
             toggleStableBeamOnlyFilter(lhcFillsOverviewModel),
         ]),
         h('.w-100.flex-column', [
-            table(lhcFillsOverviewModel.items, lhcFillsActiveColumns, { classes: '.table-sm' }),
+            table(lhcFillsOverviewModel.items, lhcFillsActiveColumns, null, { tableClasses: '.table-sm' }),
             paginationComponent(lhcFillsOverviewModel.pagination),
         ]),
     ];

lib/server/controllers/runs.controller.js

@@ -37,6 +37,7 @@ const { dtoValidator } = require('../utilities');
 const { ApiConfig } = require('../../config/index.js');
 const { DtoFactory } = require('../../domain/dtos/DtoFactory.js');
 const { runService } = require('../services/run/RunService.js');
+const { getAllBeamModes } = require('../services/beam/getAllBeamModes.js');
 const { updateExpressResponseFromNativeError } = require('../express/updateExpressResponseFromNativeError.js');
 const { runToHttpView } = require('./runsToHttpView.js');
 
@@ -278,8 +279,7 @@ const updateRunByRunNumber = async (request, response) => {
  * @param {Object} _request The *request* object represents the HTTP request and has properties for the request query
  *                         string, parameters, body, HTTP headers, and so on.
  * @param {Object} response The *response* object represents the HTTP response that an Express app sends when it gets
- *     an
- *                          HTTP request.
+ *     an HTTP request.
  * @param {Function} _next The *next* object represents the next middleware function which is used to pass control to
  *     the next middleware function.
  * @returns {undefined}
@@ -297,6 +297,30 @@ const listReasonTypes = async (_request, response, _next) => {
     }
 };
 
+/**
+ * Retrieve a list of unique beam modes
+ *
+ * @param {Object} _request The *request* object represents the HTTP request and has properties for the request query
+ *                         string, parameters, body, HTTP headers, and so on.
+ * @param {Object} response The *response* object represents the HTTP response that an Express app sends when it gets
+ *     an HTTP request.
+ * @param {NextFunction} _next The *next* object represents the next middleware function which is used to pass control to
+ *     the next middleware function.
+ * @returns {undefined}
+ */
+const listBeamModes = async (_request, response, _next) => {
+    try {
+        const beamModes = await getAllBeamModes();
+        if (beamModes && beamModes.length > 0) {
+            response.status(200).json({ data: beamModes });
+        } else {
+            response.status(204).json({ data: [] });
+        }
+    } catch {
+        response.status(502).json({ errors: ['Unable to retrieve list of beam modes'] });
+    }
+};
+
 // eslint-disable-next-line jsdoc/require-param
 /**
  * Retrieve distinct combination of levels of alice L3 and dipole current rounded to kilo amperes
@@ -323,6 +347,7 @@ module.exports = {
     getLogsByRunNumberHandler,
     getFlpsByRunNumberHandler,
     listReasonTypes,
+    listBeamModes,
     listRuns,
     startRun,
     updateRunByRunNumber,