[O2B-1508] Refactor and relocate beam types API and service logic to be under LHCFills

isaachilly · isaachilly · commit 8797eb68c041 · 2026-01-27T17:05:56.000+01:00
Removed the dedicated beamsTypes controller, router, DTO, and use case.

Moved the beam types endpoint under the lhcFills controller and router, and implemented the service logic in lib/server/services/beam/getAllBeamTypes.js.

Updated frontend provider and imports to use the new endpoint and naming (beamTypes instead of beamsTypes).
diff --git a/lib/database/repositories/LhcFillRepository.js b/lib/database/repositories/LhcFillRepository.js
@@ -15,7 +15,7 @@ const { models: { LhcFill }, sequelize } = require('../');
 
 const Repository = require('./Repository');
 const { timestampToMysql } = require('../../server/utilities/timestampToMysql.js');
-const { QueryTypes, Op } = require('sequelize');
+const { QueryTypes } = require('sequelize');
 
 /**
  * Return the SQL query to use to fetch the list of LHC fills numbers for fills with stable beams that ended in the given period
@@ -45,23 +45,6 @@ class LhcFillRepository extends Repository {
         super(LhcFill);
     }
 
-    /**
-     * Return the list of LHC fills distict beam types.
-     * @returns {Promise<object[]>}
-     */
-    async getLhcFillDistinctBeamTypes() {
-        return await LhcFill.findAll({
-            attributes: [[sequelize.fn('DISTINCT', sequelize.col('beam_type')), 'beam_type']],
-            where: {
-                beamType: {
-                    [Op.not]: null,
-                },
-            },
-            order: [['beam_type', 'ASC']],
-            raw: true,
-        });
-    }
-
     /**
      * Return the list of LHC fills numbers for fills with stable beams that ended in the given period
      *
diff --git a/lib/domain/dtos/GetAllBeamsTypesDto.js b/lib/domain/dtos/GetAllBeamsTypesDto.js
diff --git a/lib/domain/dtos/index.js b/lib/domain/dtos/index.js
@@ -18,7 +18,6 @@ const CreateLhcFillDto = require('./CreateLhcFillDto');
 const CreateLogDto = require('./CreateLogDto');
 const CreateTagDto = require('./CreateTagDto');
 const EntityIdDto = require('./EntityIdDto');
-const GetAllBeamsTypesDto = require('./GetAllBeamsTypesDto.js');
 const GetAllEnvironmentsDto = require('./GetAllEnvironmentsDto');
 const GetAllLhcFillsDto = require('./GetAllLhcFillsDto');
 const GetAllLogAttachmentsDto = require('./GetAllLogAttachmentsDto');
@@ -57,7 +56,6 @@ module.exports = {
     CreateTagDto,
     EndRunDto,
     EntityIdDto,
-    GetAllBeamsTypesDto,
     GetAllEnvironmentsDto,
     GetAllLhcFillsDto,
     GetAllLogAttachmentsDto,
diff --git a/lib/public/components/Filters/LhcFillsFilter/BeamsTypeFilterModel.js b/lib/public/components/Filters/LhcFillsFilter/BeamsTypeFilterModel.js
@@ -11,7 +11,7 @@
  * or submit itself to any jurisdiction.
  */
 
-import { beamsTypesProvider } from '../../../services/beamsTypes/beamsTypesProvider.js';
+import { beamTypesProvider } from '../../../services/beamTypes/beamTypesProvider.js';
 import { SelectionModel } from '../../common/selection/SelectionModel.js';
 
 /**
@@ -28,8 +28,8 @@ export class BeamsTypeFilterModel extends SelectionModel {
             multiple: true,
             allowEmpty: true });
 
-        beamsTypesProvider.items$.observe(() => {
-            beamsTypesProvider.items$.getCurrent().apply({
+        beamTypesProvider.items$.observe(() => {
+            beamTypesProvider.items$.getCurrent().apply({
                 Success: (types) => {
                     beamTypes = types.map((type) => ({ value: String(type.beam_type) }));
                     this.setAvailableOptions(beamTypes);
diff --git a/lib/public/services/beamTypes/beamTypesProvider.js b/lib/public/services/beamTypes/beamTypesProvider.js
@@ -17,14 +17,14 @@ import { RemoteDataProvider } from '../RemoteDataProvider.js';
 /**
  * Service class to fetch beams types from the backend
  */
-export class BeamsTypesProvider extends RemoteDataProvider {
+export class BeamTypesProvider extends RemoteDataProvider {
     /**
      * @inheritDoc
      */
     async getRemoteData() {
-        const { data } = await getRemoteData('/api/beamsTypes');
+        const { data } = await getRemoteData('/api/lhcFills/beamTypes');
         return data;
     }
 }
 
-export const beamsTypesProvider = new BeamsTypesProvider();
+export const beamTypesProvider = new BeamTypesProvider();
diff --git a/lib/server/controllers/beamsTypes.controller.js b/lib/server/controllers/beamsTypes.controller.js
diff --git a/lib/server/controllers/index.js b/lib/server/controllers/index.js
@@ -12,7 +12,6 @@
  */
 
 const AttachmentsController = require('./attachments.controller');
-const BeamsTypeController = require('./beamsTypes.controller.js');
 const ConfigurationController = require('./configuration.controller.js');
 const DetectorsController = require('./detectors.controller');
 const EnvironmentsController = require('./environments.controller');
@@ -27,7 +26,6 @@ const CtpTriggerCountersController = require('./ctpTriggerCounters.controller');
 
 module.exports = {
     AttachmentsController,
-    BeamsTypeController,
     ConfigurationController,
     DetectorsController,
     EnvironmentsController,
diff --git a/lib/server/controllers/lhcFill.controller.js b/lib/server/controllers/lhcFill.controller.js
@@ -35,6 +35,7 @@ const { ApiConfig } = require('../../config/index.js');
 const { DtoFactory } = require('../../domain/dtos/DtoFactory.js');
 const Joi = require('joi');
 const { logService } = require('../services/log/LogService.js');
+const { getAllBeamTypes } = require('../services/beam/getAllBeamTypes.js');
 const { updateExpressResponseFromNativeError } = require('../express/updateExpressResponseFromNativeError.js');
 const { lhcFillService } = require('../services/lhcFill/LhcFillService.js');
 const { runToHttpView } = require('./runsToHttpView.js');
@@ -256,6 +257,30 @@ const getAllLhcFillsWithStableBeamsEndedInPeriodHandler = async (request, respon
     }
 };
 
+/**
+ * Retrieve a list of unique beam types
+ *
+ * @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 listBeamsTypes = async (_request, response, _next) => {
+    try {
+        const beamsTypes = await getAllBeamTypes();
+        if (beamsTypes && beamsTypes.length > 0) {
+            response.status(200).json({ data: beamsTypes });
+        } else {
+            response.status(204).json({ data: [] });
+        }
+    } catch {
+        response.status(502).json({ errors: ['Unable to retrieve list of beam types'] });
+    }
+};
+
 module.exports = {
     createLhcFill,
     listLhcFills,
@@ -265,4 +290,5 @@ module.exports = {
     getLhcFillById,
     getAllLhcFillLogsHandler,
     getAllLhcFillsWithStableBeamsEndedInPeriodHandler,
+    listBeamsTypes,
 };
diff --git a/lib/server/routers/beamsTypes.router.js b/lib/server/routers/beamsTypes.router.js
diff --git a/lib/server/routers/index.js b/lib/server/routers/index.js
@@ -15,7 +15,6 @@ const { deepmerge, isPromise } = require('../../utilities');
 
 const attachmentRoute = require('./attachments.router');
 const { configurationRouter } = require('./configuration.router.js');
-const { beamsTypesRouter } = require('./beamsTypes.router.js');
 const detectorsRoute = require('./detectors.router');
 const { dplProcessRouter } = require('./dplProcess.router.js');
 const environmentRoute = require('./environments.router');
@@ -41,7 +40,6 @@ const { ctpTriggerCountersRouter } = require('./ctpTriggerCounters.router.js');
 
 const routes = [
     attachmentRoute,
-    beamsTypesRouter,
     configurationRouter,
     detectorsRoute,
     dataPassesRouter,
diff --git a/lib/server/routers/lhcFills.router.js b/lib/server/routers/lhcFills.router.js
@@ -24,6 +24,11 @@ module.exports = {
             method: 'post',
             controller: LhcFillsController.createLhcFill,
         },
+        {
+            method: 'get',
+            path: 'beamTypes',
+            controller: LhcFillsController.listBeamsTypes,
+        },
         {
             path: 'stable-beams-ended-within',
             method: 'get',
diff --git a/lib/server/services/beam/getAllBeamTypes.js b/lib/server/services/beam/getAllBeamTypes.js
@@ -0,0 +1,34 @@
+/**
+ * @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.
+ */
+
+const { repositories: { LhcFillRepository }, sequelize } = require('../../../database');
+const { Op } = require('sequelize');
+
+/**
+ * Return the a list of unique beam types which is built from the runs data
+ *
+ * @returns {Promise<SequelizeBeamType[]>} Promise resolving with the list of unique beam types
+ */
+exports.getAllBeamTypes = async () => {
+    const beamTypes = await LhcFillRepository.findAll({
+        attributes: [[sequelize.fn('DISTINCT', sequelize.col('beam_type')), 'beam_type']],
+        where: {
+            beam_type: {
+                [Op.ne]: null,
+            },
+        },
+        order: [['beam_type', 'ASC']],
+        raw: true,
+    });
+    return beamTypes;
+};
diff --git a/lib/usecases/beamsType/GetAllBeamsTypesUseCase.js b/lib/usecases/beamsType/GetAllBeamsTypesUseCase.js
diff --git a/lib/usecases/beamsType/index.js b/lib/usecases/beamsType/index.js
diff --git a/lib/usecases/index.js b/lib/usecases/index.js
@@ -12,7 +12,6 @@
  */
 
 const attachment = require('./attachment');
-const beamsType = require('./beamsType');
 const environment = require('./environment');
 const flp = require('./flp');
 const lhcFill = require('./lhcFill');
@@ -25,7 +24,6 @@ const tag = require('./tag');
 
 module.exports = {
     attachment,
-    beamsType,
     environment,
     flp,
     lhcFill,
