[O2B-1100] Delete subsystems

.github/workflows/bookkeeping.yml

@@ -22,7 +22,6 @@ jobs:
                     logs,
                     envs,
                     runs,
-                    subsystems,
                     tags,
                     flps,
                     home,

lib/database/adapters/LogAdapter.js

@@ -34,11 +34,6 @@ class LogAdapter {
          */
         this.environmentAdapter = null;
 
-        /**
-         * @type {SubsystemAdapter|null}
-         */
-        this.subsystemAdapter = null;
-
         /**
          * @type {TagAdapter|null}
          */
@@ -79,14 +74,12 @@ class LogAdapter {
             tags: sequelizeTags,
             runs,
             lhcFills: sequelizeLhcFills,
-            subsystems: sequelizeSubsytems,
             attachments: sequelizeAttachments,
             environments: sequelizeEnvironments,
         } = databaseObject;
 
         const minifiedRuns = (runs || []).map(this.runAdapter.toMinifiedEntity);
         const tags = (sequelizeTags || []).map(this.tagAdapter.toEntity);
-        const subsystems = (sequelizeSubsytems || []).map(this.subsystemAdapter.toEntity);
         const attachments = (sequelizeAttachments || []).map(this.attachmentAdapter.toEntity);
         const lhcFills = (sequelizeLhcFills || []).map(this.lhcFillAdapter.toEntity);
         const environments = (sequelizeEnvironments || []).map(this.environmentAdapter.toEntity);
@@ -104,7 +97,6 @@ class LogAdapter {
             runs: minifiedRuns,
             tags,
             lhcFills,
-            subsystems,
             attachments,
             environments,
         };

lib/database/adapters/index.js

@@ -43,7 +43,6 @@ const RunDetectorsAdapter = require('./RunDetectorsAdapter');
 const RunTypeAdapter = require('./RunTypeAdapter');
 const SimulationPassAdapter = require('./SimulationPassAdapter.js');
 const { SimulationPassQcFlagAdapter } = require('./SimulationPassQcFlagAdapter');
-const SubsystemAdapter = require('./SubsystemAdapter');
 const TagAdapter = require('./TagAdapter');
 const { TriggerCountersAdapter } = require('./TriggerCountersAdapter');
 const UserAdapter = require('./UserAdapter');
@@ -80,7 +79,6 @@ const runDetectorsAdapter = new RunDetectorsAdapter();
 const runTypeAdapter = new RunTypeAdapter();
 const simulationPassAdapter = new SimulationPassAdapter();
 const simulationPassQcFlagAdapter = new SimulationPassQcFlagAdapter();
-const subsystemAdapter = new SubsystemAdapter();
 const tagAdapter = new TagAdapter();
 const triggerCountersAdapter = new TriggerCountersAdapter();
 const userAdapter = new UserAdapter();
@@ -118,7 +116,6 @@ logAdapter.attachmentAdapter = attachmentAdapter;
 logAdapter.environmentAdapter = environmentAdapter;
 logAdapter.lhcFillAdapter = lhcFillAdapter;
 logAdapter.runAdapter = runAdapter;
-logAdapter.subsystemAdapter = subsystemAdapter;
 logAdapter.tagAdapter = tagAdapter;
 logAdapter.userAdapter = userAdapter;
 
@@ -175,7 +172,6 @@ module.exports = {
     runTypeAdapter,
     simulationPassAdapter,
     simulationPassQcFlagAdapter,
-    subsystemAdapter,
     tagAdapter,
     triggerCountersAdapter,
     userAdapter,

lib/database/migrations/20240430100347-delete-subsystems.js

@@ -0,0 +1,103 @@
+'use strict';
+
+const { QueryTypes, Sequelize } = require('sequelize');
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+    up: async (queryInterface) => queryInterface.sequelize.transaction(async (transaction) => {
+        const [{ count }] = await queryInterface.sequelize.query(
+            'SELECT COUNT(*) count FROM subsystems',
+            { type: QueryTypes.SELECT, transaction, raw: true },
+        );
+
+        // Put a security to avoid dropping subsystems if the table is not empty
+        if (parseInt(count, 10)) {
+            throw new Error('Subsystems table is not empty.' +
+                ' If the table is filled with seeders, please manually truncate it then re-run migrations');
+        }
+
+        // Transition all logs with "subsystem" type to "comment"
+        await queryInterface.sequelize.query(
+            'UPDATE logs SET subtype=\'comment\' WHERE subtype=\'subsystem\'',
+            { transaction, raw: true },
+        );
+        await queryInterface.changeColumn('logs', 'subtype', {
+            allowNull: false,
+            type: Sequelize.ENUM('run', 'announcement', 'intervention', 'comment'),
+        });
+
+        await queryInterface.dropTable('log_subsystems', { transaction });
+        await queryInterface.dropTable('subsystems', { transaction });
+    }),
+
+    down: async (queryInterface, Sequelize) => queryInterface.sequelize.transaction(async (transaction) => {
+        await queryInterface.createTable('subsystems', {
+            id: {
+                allowNull: false,
+                autoIncrement: true,
+                primaryKey: true,
+                type: Sequelize.INTEGER,
+            },
+            name: {
+                allowNull: false,
+                type: Sequelize.STRING,
+            },
+            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 });
+
+        await queryInterface.createTable('log_subsystems', {
+            log_id: {
+                primaryKey: true,
+                allowNull: false,
+                type: Sequelize.INTEGER,
+            },
+            subsystem_id: {
+                primaryKey: true,
+                allowNull: false,
+                type: Sequelize.INTEGER,
+            },
+            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 })
+            .then(() => queryInterface.addConstraint('log_subsystems', {
+                fields: ['log_id'],
+                type: 'foreign key',
+                name: 'fk_log_id_log_subsystems',
+                references: {
+                    table: 'logs',
+                    field: 'id',
+                },
+            }, { transaction }))
+            .then(() => queryInterface.addConstraint('log_subsystems', {
+                fields: ['subsystem_id'],
+                type: 'foreign key',
+                name: 'fk_subsystem_id_log_subsystems',
+                references: {
+                    table: 'subsystems',
+                    field: 'id',
+                },
+            }, { transaction }));
+
+        await queryInterface.changeColumn('logs', 'subtype', {
+            allowNull: false,
+            type: Sequelize.ENUM('run', 'subsystem', 'announcement', 'intervention', 'comment'),
+        });
+    }),
+};

lib/database/models/index.js

@@ -43,7 +43,6 @@ const RunType = require('./runType');
 const SimulationPass = require('./simulationPass.js');
 const SimulationPassQcFlag = require('./simulationPassQcFlag.js');
 const StableBeamRun = require('./stableBeamsRun.js');
-const Subsystem = require('./subsystem');
 const Tag = require('./tag');
 const TriggerCounters = require('./triggerCounters');
 const User = require('./user');
@@ -82,7 +81,6 @@ module.exports = (sequelize) => {
         SimulationPass: SimulationPass(sequelize),
         SimulationPassQcFlag: SimulationPassQcFlag(sequelize),
         StableBeamRun: StableBeamRun(sequelize),
-        Subsystem: Subsystem(sequelize),
         Tag: Tag(sequelize),
         TriggerCounters: TriggerCounters(sequelize),
         User: User(sequelize),

lib/database/models/log.js

@@ -25,7 +25,7 @@ module.exports = (sequelize) => {
         },
         subtype: {
             allowNull: false,
-            type: Sequelize.ENUM('run', 'subsystem', 'announcement', 'intervention', 'comment'),
+            type: Sequelize.ENUM('run', 'announcement', 'intervention', 'comment'),
         },
         origin: {
             allowNull: false,
@@ -55,7 +55,6 @@ module.exports = (sequelize) => {
         Log.belongsToMany(models.Run, { as: 'runs', through: 'log_runs' });
         Log.belongsToMany(models.Tag, { as: 'tags', through: 'log_tags' });
         Log.belongsToMany(models.Environment, { as: 'environments', through: 'log_environments' });
-        Log.belongsToMany(models.Subsystem, { as: 'subsystems', through: 'log_subsystems' });
         Log.belongsToMany(models.LhcFill, { as: 'lhcFills', through: 'log_lhc_fills', foreignKey: 'log_id' });
 
         Log.hasMany(models.Attachment, { as: 'attachments', foreignKey: 'log_id' });

lib/database/models/typedefs/SequelizeLog.js

@@ -29,7 +29,6 @@
  * @property {SequelizeLog|null} parentLog
  * @property {SequelizeRun[]|null} runs
  * @property {SequelizeTag[]|null} tags
- * @property {SequelizeSubsystem[]|null} subsystems
  * @property {SequelizeAttachment[]|null} attachments
  * @property {SequelizeEnvironment[]|null} environments
  */

lib/database/repositories/LogRepository.js

@@ -110,23 +110,6 @@ class LogRepository extends Repository {
         return this.findAll(queryBuilder);
     }
 
-    /**
-     * Returns all entities.
-     *
-     * @param {Object} subsystemId The QueryBuilder to use.
-     * @param {QueryBuilder} queryBuilder The QueryBuilder to use.
-     * @returns {Promise} Promise object representing the full mock data
-     */
-    async findAllBySubsystemId(subsystemId, queryBuilder = new QueryBuilder()) {
-        queryBuilder
-            .setModel(Log)
-            .include('user')
-            .include('tags')
-            .whereAssociation('subsystems', 'id').is(subsystemId);
-
-        return this.findAll(queryBuilder);
-    }
-
     /**
      * Returns the list of tags and their occurrences in the logs created in the given period
      *

lib/database/repositories/index.js

@@ -47,7 +47,6 @@ const RunTypeRepository = require('./RunTypeRepository');
 const SimulationPassRepository = require('./SimulationPassRepository.js');
 const SimulationPassQcFlagRepository = require('./SimulationPassQcFlagRepository.js');
 const StableBeamRunsRepository = require('./StableBeamRunsRepository.js');
-const SubsystemRepository = require('./SubsystemRepository');
 const TagRepository = require('./TagRepository');
 const TriggerCountersRepository = require('./TriggerCountersRepository');
 const UserRepository = require('./UserRepository');
@@ -89,7 +88,6 @@ module.exports = {
     SimulationPassRepository,
     SimulationPassQcFlagRepository,
     StableBeamRunsRepository,
-    SubsystemRepository,
     TagRepository,
     TriggerCountersRepository,
     UserRepository,