[ORCT-135] detectors in run views

app/lib/database/adapters/DetectorSubsystemAdapter.js

@@ -0,0 +1,45 @@
+/**
+ * @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.
+ */
+
+
+class DetectorSubsystemAdapter {
+    /**
+     * Converts the given database object to an entity object.
+     *
+     * @param {SequelizeDetectorSubsystem} databaseObject Object to convert.
+     * @returns {DetectorSubsystem} Converted entity object.
+     */
+    toEntity(databaseObject) {
+        const {
+            id,
+            name,
+        } = databaseObject;
+
+        return {
+            id,
+            name,
+        };
+    }
+
+    /**
+     * Converts the given entity object to database object.
+     *
+     * @param {DetectorSubsystem} databaseObject Object to convert.
+     * @returns {SequelizeDetectorSubsystem} Converted entity object.
+     */
+    toDatabase(entityObject) {
+        return entityObject;
+    }
+}
+
+module.exports = DetectorSubsystemAdapter;

app/lib/database/adapters/RunAdapter.js

@@ -11,11 +11,13 @@
  * or submit itself to any jurisdiction.
  */
 
+const DetectorSubsystemAdapter = require('./DetectorSubsystemAdapter');
 
-/**
- * RunAdapter
- */
 class RunAdapter {
+    constructor() {
+        this.detectorSubsystemAdapter = new DetectorSubsystemAdapter();
+    }
+
     /**
      * Converts the given database object to an entity object.
      *
@@ -36,6 +38,7 @@ class RunAdapter {
             lhcBeamEnergy,
             l3CurrentVal,
             dipoleCurrentVal,
+            DetectorSubsystems,
         } = databaseObject;
 
         return {
@@ -51,6 +54,7 @@ class RunAdapter {
             lhcBeamEnergy,
             l3CurrentVal,
             dipoleCurrentVal,
+            detectorSubsystems: DetectorSubsystems?.map(this.detectorSubsystemAdapter.toEntity.bind(this.detectorSubsystemAdapter)),
         }
     }
 

app/lib/database/adapters/index.js

@@ -14,13 +14,16 @@
 const PeriodAdapter = require('./PeriodAdapter');
 const RunAdapter = require('./RunAdapter');
 const DataPassAdapter = require('./DataPassAdapter');
+const DetectorSubsystemAdapter = require('./DetectorSubsystemAdapter');
 
 const runAdapter = new RunAdapter();
 const periodAdapter = new PeriodAdapter();
 const dataPassAdapter = new DataPassAdapter();
+const detectorSubsystemAdapter = new DetectorSubsystemAdapter();
 
 module.exports = {
     runAdapter,
     periodAdapter,
     dataPassAdapter,
+    detectorSubsystemAdapter,
 }

app/lib/database/models/DetectorSubsystem.js

@@ -0,0 +1,33 @@
+/**
+ * @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 Sequelize = require('sequelize');
+
+module.exports = (sequelize) => {
+    const DetectorSubsystem = sequelize.define('DetectorSubsystem', {
+        name: {
+            type: Sequelize.STRING,
+            unique: true,
+        },
+    }, { timestamps: false, tableName: 'detectors_subsystems' });
+
+    DetectorSubsystem.associate = (models) => {
+        DetectorSubsystem.belongsToMany(models.Run, {
+            through: 'runs_detectors', 
+            foreignKey: 'detector_id',
+            timestamps: false,
+        })
+    };
+
+    return DetectorSubsystem;
+};

app/lib/database/models/Run.js

@@ -96,6 +96,11 @@ module.exports = (sequelize) => {
 
     Run.associate = (models) => {
         Run.belongsTo(models.Period);
+        Run.belongsToMany(models.DetectorSubsystem, {
+            through: 'runs_detectors', 
+            foreignKey: 'run_number',
+            timestamps: false,
+        });
         Run.belongsToMany(models.DataPass, {
             through: 'data_passes_runs',
             foreignKey: 'run_number',

app/lib/database/models/index.js

@@ -17,6 +17,7 @@ const BeamType = require('./BeamType.js');
 const Period = require('./Period.js');
 const Run = require('./Run.js');
 const DataPass = require('./DataPass.js');
+const DetectorSubsystem = require('./DetectorSubsystem.js');
 
 /**
  * 
@@ -29,6 +30,7 @@ const modelsFactory = (sequelize) => {
         Period,
         Run,
         DataPass,
+        DetectorSubsystem,
     };
     models = Object.entries(models).map(([modelName, model]) => [modelName, model(sequelize)]); // instantiate models
     models.forEach(([_, modelInstance]) => modelInstance.associate?.(sequelize.models)); // associate models

app/lib/database/models/typdefs/SeqeulizeRun.js

@@ -23,4 +23,5 @@
  * @property {number|null} lhcBeamEnergy
  * @property {number|null} l3CurrentVal
  * @property {number|null} dipoleCurrentVal
+ * @property {SequelizeDetectorSubsystem[]|null} DetectorSubsystems
  */

app/lib/database/models/typdefs/SequelizeDetectorSubsystem.js

@@ -0,0 +1,19 @@
+/**
+ * @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 SequelizeDetectorSubsystem
+ *
+ * @property {number} id
+ * @property {string} name
+ */

app/lib/database/repositories/RunRepository.js

@@ -0,0 +1,41 @@
+/**
+ * @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 Repository = require("./Repository");
+const Sequelize = require('sequelize');
+const deepmerge = require('deepmerge');
+
+/**
+ * Sequelize implementation of the Repository.
+ */
+class RunRepository extends Repository  {
+    /**
+     * Returns all Run entities with associated DetectorSubsystem entities.
+     *
+     * @param {Object} queryClauses the find query (see sequelize findAll options) or a find query builder
+     * @returns {Promise<Run[]>} Promise object representing the full mock data
+     */
+    async findAllWithDetectors(queryClauses = {}) {
+        const baseClause = {
+            include: [{
+                model: this.model.sequelize.models.DetectorSubsystem,
+                raw:true,
+                required: true,
+            }],
+        };
+        console.log(deepmerge(baseClause, queryClauses))
+        return this.model.findAll(deepmerge(baseClause, queryClauses));
+    }
+}
+
+module.exports = RunRepository;

app/lib/database/repositories/index.js

@@ -14,14 +14,17 @@
 
 const Repository = require('./Repository.js');
 
+const RunRepository = require('./RunRepository.js');
 /**
  * Object for holding repository classes defined in files in this directory. 
  * If repository is not defined here explicitly then it will be created implicitly via models mapping
  * NOTE:
  *  1. Instances are created here, so metioned files should export classes not instances.
  *  2. The object have to keep each repository under key the same as corresponding model is kept. 
  */
-const specificallyDefinedRepositories = {};
+const specificallyDefinedRepositories = {
+    Run: RunRepository,
+};
 
 /**
  * @see specificallyDefinedRepositories

app/lib/domain/entities/DetectorSubsystem.js

@@ -0,0 +1,19 @@
+/**
+ * @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 DetectorSubsystem
+ *
+ * @property {number} id
+ * @property {string} name
+ */

app/lib/domain/entities/Run.js

@@ -26,4 +26,5 @@
  * @property {number|null} lhcBeamEnergy
  * @property {number|null} l3CurrentVal
  * @property {number|null} dipoleCurrentVal
+ * @property {DetectorSubsystem[]|null} detectorSubsystems
  */

app/lib/services/runs/RunService.js

@@ -31,7 +31,7 @@ class RunService {
      * @returns {Promise<Run[]>} Promise object represents the result of this use case.
      */
     async getAll({ filter }) {
-        const runs = await RunRepository.findAll({
+        const runs = await RunRepository.findAllWithDetectors({
             where: filterToSequelizeWhereClause(filter),
         });
         return runs.map((run) => runAdapter.toEntity(run));
@@ -44,7 +44,7 @@ class RunService {
      * @returns {Promise<Run[]>} Promise object represents the result of this use case.
      */
     async getRunsPerPeriod(periodId, { filter }) {
-        const runs = await RunRepository.findAll({
+        const runs = await RunRepository.findAllWithDetectors({
             where: {
                 period_id: periodId,
                 ...filterToSequelizeWhereClause(filter),
@@ -60,7 +60,7 @@ class RunService {
      * @returns {Promise<Run[]>} Promise object represents the result of this use case.
      */
     async getRunsPerDataPass(dataPassId, { filter }) {
-        const runs = await RunRepository.findAll({
+        const runs = await RunRepository.findAllWithDetectors({
             include: [
                 {
                     model: DataPass,

package.json

@@ -35,7 +35,7 @@
     "start:dev:local": "(export RCT_DB_HOST=${RCT_DB_HOST:-localhost}; bash -c 'set -o allexport && ls && source ./docker/dev.env && set +o allexport && npm run start:dev')",
     "deploy:db:local": "./database/setup-db.sh --env ./docker/dev.env",
     "dev": "./rctmake prune,db:export,run,app:attach,stop --target dev",
-    "idev": "node -e \"app = require('./app/application.js')\" -i",
+    "idev": "node -e \"app = require('./app/application.js'); const { databaseManager: dbm } = app\" -i",
     "node-dev-env": "(export RCT_DB_HOST=$(docker inspect o2rct_database-dev -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}'); bash -c 'set -o allexport && ls && source ./docker/dev.env && set +o allexport && node')",
     "dev:up": "./rctmake run[up],app:attach",
     "dev:up-re": "./rctmake run[up],dump:restore,app:attach -F ",
@@ -59,6 +59,7 @@
   "dependencies": {
     "@aliceo2/web-ui": "^2.0.0",
     "csvtojson": "^2.0.10",
+    "deepmerge": "^4.3.1",
     "esm": "^3.2.25",
     "joi": "^17.9.2",
     "less": "^4.1.3",
@@ -88,6 +89,7 @@
   ],
   "bundleDependencies": [
     "@aliceo2/web-ui",
+    "deepmerge",
     "esm",
     "joi",
     "less",