[O2B-1391] Allow to create verified QC flag (#1983)

xsalonx · web-flow · commit 4f1a59b54950 · 2025-09-26T16:46:59.000+02:00
* cherry-pick

* mv logic to serice

* add test

* fix

* test

* test

* fix
diff --git a/lib/public/components/common/form/createButton.js b/lib/public/components/common/form/createButton.js
@@ -18,10 +18,11 @@ import { h } from '/js/src/index.js';
  *
  * @param {function} onclick function called when button is clicked (if null, button will be disabled)
  * @param {string} [text='Create'] the button's text
+ * @param {string} [selector='button#submit.btn.btn-success'] the button selector
  * @return {vnode} the button component
  */
-export const createButton = (onclick, text = 'Create') => h(
-    'button#submit.btn.btn-success',
+export const createButton = (onclick, text = 'Create', selector = 'button#submit.btn.btn-success') => h(
+    selector,
     onclick ? { onclick } : { disabled: true },
     text,
 );
diff --git a/lib/public/components/common/form/creationFormComponent.js b/lib/public/components/common/form/creationFormComponent.js
@@ -19,15 +19,18 @@ import { h } from '/js/src/index.js';
  *
  * @param {CreationModel} creationFormModel the form model
  * @param {Component} formInputsComponent the component containing all the form inputs
+ * @param {{renderSubmitSection?: function(CreationModel): Component}} [options] optional configuration
  * @return {Component} the form component
  */
-export const creationFormComponent = (creationFormModel, formInputsComponent) => [
+export const creationFormComponent = (creationFormModel, formInputsComponent, { renderSubmitSection } = {}) => [
     creationFormModel.creationResult.isFailure() && errorAlert(creationFormModel.creationResult.payload),
     formInputsComponent,
-    h('.pv3', creationFormModel.creationResult.match({
-        Loading: () => createButton(null, 'Sending...'),
-        Success: () => createButton(null, 'Sent!'),
-        Failure: () => createButton(creationFormModel.isValid() ? () => creationFormModel.submit() : null),
-        NotAsked: () => createButton(creationFormModel.isValid() ? () => creationFormModel.submit() : null),
-    })),
+    renderSubmitSection
+        ? renderSubmitSection(creationFormModel)
+        : h('.pv3', creationFormModel.creationResult.match({
+            Loading: () => createButton(null, 'Sending...'),
+            Success: () => createButton(null, 'Sent!'),
+            Failure: () => createButton(creationFormModel.isValid() ? () => creationFormModel.submit() : null),
+            NotAsked: () => createButton(creationFormModel.isValid() ? () => creationFormModel.submit() : null),
+        })),
 ];
diff --git a/lib/public/models/CreationModel.js b/lib/public/models/CreationModel.js
@@ -48,14 +48,15 @@ export class CreationModel extends Observable {
 
     /**
      * Submit the current form data, handling errors appropriately
+     * @param {*} [options] optional submission options forwarded to serialization
      * @returns {void}
      */
-    async submit() {
+    async submit(options) {
         this._creationResult = RemoteData.loading();
         this.notify();
 
         try {
-            const { data } = await jsonPost(this._apiEndpoint, this._getSerializableData());
+            const { data } = await jsonPost(this._apiEndpoint, this._getSerializableData(options));
 
             this._creationResult = RemoteData.success(null);
             this._onCreationSuccess(data);
diff --git a/lib/public/views/QcFlags/Create/forDataPass/QcFlagCreationForDataPassModel.js b/lib/public/views/QcFlags/Create/forDataPass/QcFlagCreationForDataPassModel.js
@@ -57,14 +57,20 @@ export class QcFlagCreationForDataPassModel extends CreationModel {
     /**
      * @inheritDoc
      */
-    _getSerializableData() {
-        return {
+    _getSerializableData(options = {}) {
+        const serialized = {
             dataPassId: this._dataPassId,
             ...this._qcFlagCreationModel.match({
                 Success: ({ normalized }) => normalized,
                 Other: {},
             }),
         };
+
+        if (options?.verify) {
+            serialized.verify = true;
+        }
+
+        return serialized;
     }
 
     /**
diff --git a/lib/public/views/QcFlags/Create/forDataPass/QcFlagCreationForDataPassPage.js b/lib/public/views/QcFlags/Create/forDataPass/QcFlagCreationForDataPassPage.js
@@ -13,7 +13,7 @@
  */
 
 import { h } from '/js/src/index.js';
-import { qcFlagCreationComponent } from '../qcFlagCreationComponent.js';
+import { qcFlagCreationComponent, qcFlagCreationSubmitSection } from '../qcFlagCreationComponent.js';
 import { frontLink } from '../../../../components/common/navigation/frontLink.js';
 import { tooltip } from '../../../../components/common/popover/tooltip.js';
 import { iconWarning } from '/js/src/icons.js';
@@ -48,6 +48,7 @@ export const QcFlagCreationForDataPassPage = ({ qcFlags: { creationForDataPassMo
                             Failure: (errors) => errorAlert(errors),
                             NotAsked: () => null,
                         }),
+                        { renderSubmitSection: qcFlagCreationSubmitSection },
                     ),
                 ),
         ],
diff --git a/lib/public/views/QcFlags/Create/forSimulationPass/QcFlagCreationForSimulationPassModel.js b/lib/public/views/QcFlags/Create/forSimulationPass/QcFlagCreationForSimulationPassModel.js
@@ -58,14 +58,20 @@ export class QcFlagCreationForSimulationPassModel extends CreationModel {
     /**
      * @inheritDoc
      */
-    _getSerializableData() {
-        return {
+    _getSerializableData(options = {}) {
+        const serialized = {
             simulationPassId: this._simulationPassId,
             ...this._qcFlagCreationModel.match({
                 Success: ({ normalized }) => normalized,
                 Other: {},
             }),
         };
+
+        if (options?.verify) {
+            serialized.verify = true;
+        }
+
+        return serialized;
     }
 
     /**
diff --git a/lib/public/views/QcFlags/Create/forSimulationPass/QcFlagCreationForSimulationPassPage.js b/lib/public/views/QcFlags/Create/forSimulationPass/QcFlagCreationForSimulationPassPage.js
@@ -16,7 +16,7 @@ import { h, iconWarning } from '/js/src/index.js';
 import { creationFormComponent } from '../../../../components/common/form/creationFormComponent.js';
 import errorAlert from '../../../../components/common/errorAlert.js';
 import spinner from '../../../../components/common/spinner.js';
-import { qcFlagCreationComponent } from '../qcFlagCreationComponent.js';
+import { qcFlagCreationComponent, qcFlagCreationSubmitSection } from '../qcFlagCreationComponent.js';
 import { frontLink } from '../../../../components/common/navigation/frontLink.js';
 import { tooltip } from '../../../../components/common/popover/tooltip.js';
 
@@ -51,6 +51,7 @@ export const QcFlagCreationForSimulationPassPage = ({ qcFlags: { creationForSimu
                     Failure: (errors) => errorAlert(errors),
                     NotAsked: () => null,
                 }),
+                { renderSubmitSection: qcFlagCreationSubmitSection },
             ),
         ),
     ];
diff --git a/lib/public/views/QcFlags/Create/qcFlagCreationComponent.js b/lib/public/views/QcFlags/Create/qcFlagCreationComponent.js
@@ -24,6 +24,7 @@ import errorAlert from '../../../components/common/errorAlert.js';
 import { isRunNotSubjectToQc } from '../../../components/qcFlags/isRunNotSubjectToQc.js';
 import { frontLink } from '../../../components/common/navigation/frontLink.js';
 import { getRunQcExclusionReason } from '../../../components/qcFlags/getRunQcExclusionReason.js';
+import { createButton } from '../../../components/common/form/createButton.js';
 
 /**
  * Create table with selected detectors and runs information
@@ -160,3 +161,44 @@ export const qcFlagCreationComponent = (qcFlagCreationModel) => {
         ? qcFlagCreationForm(qcFlagCreationModel)
         : errorAlert(errors);
 };
+
+/**
+ * Render submit section for QC flag creation form
+ * @param {CreationModel} creationFormModel creation form model
+ * @return {Component} submit section component
+ */
+export const qcFlagCreationSubmitSection = (creationFormModel) => {
+    const interactiveButtons = () => {
+        const submitHandler = creationFormModel.isValid()
+            ? () => creationFormModel.submit()
+            : null;
+        const submitWithVerificationHandler = creationFormModel.isValid()
+            ? () => creationFormModel.submit({ verify: true })
+            : null;
+
+        return [
+            createButton(submitHandler),
+            createButton(
+                submitWithVerificationHandler,
+                'Create (with verification)',
+                'button#submit-with-verification.btn.btn-success',
+            ),
+        ];
+    };
+
+    return h(
+        '.pv3.flex-row.g3',
+        creationFormModel.creationResult.match({
+            Loading: () => [
+                createButton(null, 'Sending...'),
+                createButton(null, 'Sending...', 'button#submit-with-verification.btn.btn-success'),
+            ],
+            Success: () => [
+                createButton(null, 'Sent!'),
+                createButton(null, 'Sent!', 'button#submit-with-verification.btn.btn-success'),
+            ],
+            Failure: interactiveButtons,
+            NotAsked: interactiveButtons,
+        }),
+    );
+};
diff --git a/lib/server/controllers/qcFlag.controller.js b/lib/server/controllers/qcFlag.controller.js
@@ -185,6 +185,7 @@ const createQcFlagsHandler = async (req, res) => {
             }),
             dataPassId: Joi.number().allow(null),
             simulationPassId: Joi.number().allow(null),
+            verify: Joi.boolean().optional(),
             runDetectors: Joi.array().items(Joi.object({
                 runNumber: Joi.number().required(),
                 detectorIds: Joi.array().items(Joi.number().required()).min(1).required(),
diff --git a/lib/server/services/qualityControlFlag/QcFlagService.js b/lib/server/services/qualityControlFlag/QcFlagService.js
@@ -135,7 +135,7 @@ class QcFlagService {
             throw new BadParameterError('Cannot create QC flag for data pass and simulation pass simultaneously');
         }
 
-        return dataSource.transaction(async () => {
+        return dataSource.transaction(async (transaction) => {
             const user = await getUserOrFail({ userId, externalUserId });
             const detector = await getQcDetectorOrFail(detectorIdentifier);
 
@@ -156,7 +156,7 @@ class QcFlagService {
 
             const createdFlags = [];
             for (const qcFlag of qcFlags) {
-                const { comment, flagTypeId, origin } = qcFlag;
+                const { comment, flagTypeId, origin, verify } = qcFlag;
                 // Each flag should be treated separately and the for loop should not fail on the first error
                 try {
                     const { from, to } = this._prepareQcFlagPeriod({ from: qcFlag.from, to: qcFlag.to }, targetRun);
@@ -179,14 +179,7 @@ class QcFlagService {
                     }
 
                     /** @var {SequelizeQcFlag} createdFlag */
-                    const createdFlag = await QcFlagRepository.findOne({
-                        where: { id: newInstance.id },
-                        include: [
-                            { association: 'dataPasses' },
-                            { association: 'simulationPasses' },
-                            { association: 'createdBy' },
-                        ],
-                    });
+                    let createdFlag = await QcFlagRepository.findOne({ where: { id: newInstance.id } });
 
                     // Update effective periods
                     const effectivePeriodsToBeUpdated = await QcFlagEffectivePeriodRepository.findOverlappingPeriodsCreatedBeforeLimit(
@@ -202,6 +195,20 @@ class QcFlagService {
                         to: newInstance.to,
                     });
 
+                    if (verify) {
+                        await this.verifyFlag({ flagId: newInstance.id }, relations, { transaction });
+                    }
+
+                    createdFlag = await QcFlagRepository.findOne({
+                        where: { id: newInstance.id },
+                        include: [
+                            { association: 'dataPasses' },
+                            { association: 'simulationPasses' },
+                            { association: 'createdBy' },
+                            { association: 'verifications' },
+                        ],
+                    });
+
                     createdFlags.push(qcFlagAdapter.toEntity(createdFlag));
                 } catch (error) {
                     this._logger.warnMessage(`Failed to create QC flag with properties: ${JSON.stringify(qcFlag)}. Error: ${error}`);
@@ -359,9 +366,11 @@ class QcFlagService {
      * @param {object} relations QC Flag entity relations
      * @param {UserWithRoles} relations.user user identifier with roles
      * @return {Promise<QcFlag>} promise
+     * @param {object} [options] options
+     * @param {sequelize.Transaction} [options.transaction] sequelize transaction
      * @throws {NotFoundError|AccessDeniedError}
      */
-    async verifyFlag({ flagId, comment }, relations) {
+    async verifyFlag({ flagId, comment }, relations, { transaction } = {}) {
         return dataSource.transaction(async () => {
             const qcFlag = await this.getOneOrFail(flagId);
             if (qcFlag.deleted) {
@@ -381,7 +390,7 @@ class QcFlagService {
             });
 
             return await this.getOneOrFail(flagId);
-        });
+        }, { transaction });
     }
 
     /**
diff --git a/test/api/qcFlags.test.js b/test/api/qcFlags.test.js
@@ -18,6 +18,7 @@ const { resetDatabaseContent } = require('../utilities/resetDatabaseContent.js')
 const { qcFlagService } = require('../../lib/server/services/qualityControlFlag/QcFlagService');
 const { BkpRoles } = require('../../lib/domain/enums/BkpRoles.js');
 const { dataPassService } = require('../../lib/server/services/dataPasses/DataPassService.js');
+const { expectSuccessStatus } = require('./utils.js');
 
 module.exports = () => {
     before(resetDatabaseContent);
@@ -848,6 +849,33 @@ module.exports = () => {
             }
         });
 
+
+        it('should create and verify QC flag instance when verify option is provided', async () => {
+            const qcFlagCreationParameters = {
+                from: null,
+                to: null,
+                comment: 'Auto verified flag',
+                flagTypeId: 2,
+                runNumber: 106,
+                simulationPassId: 1,
+                dplDetectorId: 1,
+                verify: true,
+            };
+
+            const response = await request(server).post('/api/qcFlags?token=det-cpv').send(qcFlagCreationParameters);
+
+            expectSuccessStatus(response, 201);
+
+            const [createdQcFlag] = response.body.data;
+            expect(createdQcFlag.verifications).to.be.an('array').that.has.lengthOf(1);
+
+            const [verification] = createdQcFlag.verifications;
+            expect(verification.flagId).to.equal(createdQcFlag.id);
+            expect(verification.comment).to.be.null;
+            expect(verification.createdById).to.equal(createdQcFlag.createdById);
+        });
+
+
         it('should successfully create multiple QC flag instances for data pass', async () => {
             const qcFlagCreationParameters = {
                 from: 1565294400001,
diff --git a/test/api/utils.js b/test/api/utils.js
@@ -0,0 +1,23 @@
+const { expect, AssertionError } = require('chai');
+
+/**
+ * Check if request was succesful
+ * 
+ * @param {object} response server response
+ * @param {number} status  HTTP status
+ * @return {void}
+ */
+const expectSuccessStatus = (response, status) => {
+    try {
+        expect(response.status).to.be.equal(status);
+    } catch (exception) {
+        const apiErrors = JSON.stringify(response.body?.errors);
+        const detailedMessage = `${exception.message}\nAPI Error: ${apiErrors}`;
+        const error = new AssertionError(detailedMessage);
+        error.apiErrors = apiErrors;
+        throw error;
+    }
+}
+
+
+module.exports.expectSuccessStatus = expectSuccessStatus;
diff --git a/test/lib/server/services/qualityControlFlag/QcFlagService.test.js b/test/lib/server/services/qualityControlFlag/QcFlagService.test.js
@@ -1868,6 +1868,27 @@ module.exports = () => {
             );
         });
 
+        it('should allow QC flag creators to verify their own flags', async () => {
+            const relations = { user: { roles: ['admin'], externalUserId: 456 } };
+            const scope = {
+                runNumber: 106,
+                dataPassIdentifier: { id: 1 },
+                detectorIdentifier: { detectorId: 1 },
+            };
+
+            const [verifiedFlag] = await qcFlagService.create([
+                { flagTypeId: goodFlagTypeId, verify: true },
+            ], scope, relations);
+
+            expect(verifiedFlag.verifications).to.be.an('array');
+            expect(verifiedFlag.verifications).to.have.lengthOf(1);
+
+            const [verification] = verifiedFlag.verifications;
+            expect(verification.flagId).to.equal(verifiedFlag.id);
+            expect(verification.comment).to.be.null;
+            expect(verification.createdById).to.equal(verifiedFlag.createdById);
+        });
+
         it('should successfully verify QC flag when not being owner', async () => {
             const qcFlag = {
                 flagId: 3,
diff --git a/test/public/defaults.js b/test/public/defaults.js
@@ -163,6 +163,7 @@ const waitForTableToLength = async (page, expectedSize) => {
 
 module.exports.waitForTableLength = waitForTableToLength;
 
+
 /**
  * Wait for the total number of elements to be the expected one
  *
diff --git a/test/public/qcFlags/forDataPassCreation.test.js b/test/public/qcFlags/forDataPassCreation.test.js
