[O2B-1118] Add migration files and models for quality control flag types

lib/database/migrations/20240226102034-create-quality-control-flags-tables.js

@@ -0,0 +1,73 @@
+'use strict';
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+    up: async (queryInterface, Sequelize) => queryInterface.sequelize.transaction(async (transaction) => {
+        await queryInterface.createTable('quality_control_flag_types', {
+            // Properties
+            id: {
+                type: Sequelize.INTEGER,
+                allowNull: false,
+                primaryKey: true,
+                autoIncrement: true,
+            },
+            name: {
+                type: Sequelize.STRING,
+                allowNull: false,
+                unique: true,
+            },
+            method: {
+                type: Sequelize.STRING,
+                unique: true,
+                allowNull: false,
+            },
+            bad: {
+                type: Sequelize.BOOLEAN,
+                allowNull: false,
+            },
+            color: {
+                type: Sequelize.STRING(7),
+                allowNull: true,
+            },
+
+            archived_at: {
+                type: Sequelize.DATE,
+                allowNull: true,
+            },
+
+            last_updated_by_id: {
+                type: Sequelize.INTEGER,
+                allowNull: true,
+                references: {
+                    model: 'users',
+                    key: 'id',
+                },
+            },
+
+            created_by_id: {
+                type: Sequelize.INTEGER,
+                allowNull: false,
+                references: {
+                    model: 'users',
+                    key: 'id',
+                },
+            },
+
+            // Timestamps
+            created_at: {
+                allowNull: false,
+                type: Sequelize.DATE,
+                defaultValue: Sequelize.literal('CURRENT_TIMESTAMP'),
+            },
+            updated_at: {
+                allowNull: false,
+                type: Sequelize.DATE,
+                defaultValue: Sequelize.literal('CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP'),
+            },
+        }, { transaction });
+    }),
+
+    down: async (queryInterface) => queryInterface.sequelize.transaction(async (transaction) => {
+        await queryInterface.dropTable('quality_control_flag_types', { transaction });
+    }),
+};

lib/database/models/index.js

@@ -37,6 +37,7 @@ const User = require('./user');
 const LhcPeriod = require('./lhcPeriod');
 const LhcPeriodStatistics = require('./lhcPeriodsStatistics');
 const DataPass = require('./dataPass.js');
+const QCFlagType = require('./qcFlagType.js');
 const SimulationPass = require('./simulationPass.js');
 
 module.exports = (sequelize) => {
@@ -67,6 +68,7 @@ module.exports = (sequelize) => {
         LhcPeriod: LhcPeriod(sequelize),
         LhcPeriodStatistics: LhcPeriodStatistics(sequelize),
         DataPass: DataPass(sequelize),
+        QCFlagType: QCFlagType(sequelize),
         SimulationPass: SimulationPass(sequelize),
     };
 

lib/database/models/qcFlagType.js

@@ -0,0 +1,69 @@
+/**
+ * @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 QCFlagType = sequelize.define(
+        'QCFlagType',
+        {
+            id: {
+                type: Sequelize.INTEGER,
+                allowNull: false,
+                primaryKey: true,
+                autoIncrement: true,
+            },
+            name: {
+                type: Sequelize.STRING,
+                allowNull: false,
+                unique: true,
+            },
+            method: {
+                type: Sequelize.STRING,
+                unique: true,
+                allowNull: false,
+            },
+            bad: {
+                type: Sequelize.BOOLEAN,
+                allowNull: false,
+            },
+            color: {
+                type: Sequelize.STRING(7),
+                allowNull: true,
+                validate: {
+                    is: /^#[0-9a-fA-F]{6}$/i,
+                },
+            },
+            archivedAt: {
+                type: Sequelize.DATE,
+                allowNull: true,
+            },
+            archived: {
+                type: Sequelize.VIRTUAL,
+                defaultValue: null,
+                // eslint-disable-next-line require-jsdoc
+                get() {
+                    return Boolean(this.getDataValue('archivedAt'));
+                },
+            },
+        },
+        { tableName: 'quality_control_flag_types' },
+    );
+
+    QCFlagType.associate = (models) => {
+        QCFlagType.belongsTo(models.User, { as: 'createdBy', foreignKey: 'createdById' });
+        QCFlagType.belongsTo(models.User, { as: 'lastUpdatedBy', foreignKey: 'lastUpdatedById' });
+    };
+
+    return QCFlagType;
+};

lib/database/models/typedefs/SequelizeQCFlagType.js

@@ -0,0 +1,32 @@
+/**
+ * @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 SequelizeQCFlagType
+ *
+ * @property {number} id
+ * @property {string} name
+ * @property {string} method
+ * @property {boolean} bad
+ * @property {string} color as hex
+ *
+ * @property {boolean} archived
+ * @property {Date} archivedAt
+ *
+ * @property {Date} createdAt
+ * @property {number} createdById
+ * @property {SequelizeUser} createdBy
+ * @property {Date} updatedAt
+ * @property {number} lastUpdatedById
+ * @property {SequelizeUser} lastUpdatedBy
+ */

lib/database/seeders/20240213120811-quality-control-flags.js

@@ -0,0 +1,63 @@
+/**
+ *  @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.
+ */
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+    up: async (queryInterface) =>
+        queryInterface.sequelize.transaction((transaction) =>
+            Promise.all([
+                queryInterface.bulkInsert('quality_control_flag_types', [
+                    {
+                        id: 2,
+                        name: 'UnknownQuality',
+                        method: 'Unknown Quality',
+                        bad: true,
+                        created_by_id: 1,
+                    },
+                    {
+                        id: 3,
+                        name: 'CertifiedByExpert',
+                        method: 'Certified by Expert',
+                        bad: false,
+                        created_by_id: 1,
+                    },
+                    {
+                        id: 11,
+                        name: 'LimitedAcceptance',
+                        method: 'Limited acceptance',
+                        bad: true,
+                        color: '#FFFF00',
+                        created_by_id: 1,
+                    },
+                    {
+                        id: 12,
+                        name: 'BadPID',
+                        method: 'Bad PID',
+                        bad: true,
+                        created_by_id: 1,
+                    },
+                    {
+                        id: 13,
+                        name: 'Bad',
+                        method: 'Bad',
+                        bad: true,
+                        created_by_id: 1,
+                    },
+
+                ], { transaction }),
+            ])),
+
+    down: async (queryInterface) =>
+        queryInterface.sequelize.transaction((transaction) =>
+            Promise.all([queryInterface.bulkDelete('quality_control_flag_types', null, { transaction })])),
+};