Merge branch 'dev' into feature/CNF/OGUI-1831/introduce-react-hook-form

Author: sKrzysieK

QualityControl/lib/services/ccdb/CcdbService.js

@@ -12,7 +12,7 @@
  * or submit itself to any jurisdiction.
  */
 
-import { FailedDependencyError, LogManager } from '@aliceo2/web-ui';
+import { FailedDependencyError, LogManager, NotFoundError } from '@aliceo2/web-ui';
 import { httpHeadJson, httpGetJson } from '../../utils/httpRequests.js';
 import {
   CCDB_MONITOR, CCDB_VERSION_KEY, CCDB_RESPONSE_BODY_KEYS, CCDB_FILTER_FIELDS, CCDB_RESPONSE_HEADER_KEYS,
@@ -176,7 +176,8 @@ export class CcdbService {
    * ```
    * @param {CcdbObjectIdentification} partialIdentification - fields such as path, validFrom, etc.
    * @returns {Promise.<CcdbObjectIdentification>} - returns object full identification
-   * @throws {Error}
+   * @throws {Error} throws if the object cannot be fetched
+   * @throws {NotFoundError} throws if the object cannot be found
    */
   async getObjectIdentification(partialIdentification) {
     const headers = {
@@ -185,18 +186,28 @@ export class CcdbService {
     };
     const url = `/latest${this._buildCcdbUrlPath(partialIdentification)}`;
 
-    const result = await httpGetJson(this._hostname, this._port, url, { headers });
-    if (result?.objects?.length > 0) {
-      const [qcObject] = result.objects;
-      return {
-        [CCDB_RESPONSE_BODY_KEYS.PATH]: qcObject[CCDB_RESPONSE_BODY_KEYS.PATH],
-        [CCDB_RESPONSE_BODY_KEYS.VALID_FROM]: qcObject[CCDB_RESPONSE_BODY_KEYS.VALID_FROM],
-        [CCDB_RESPONSE_BODY_KEYS.VALID_UNTIL]: qcObject[CCDB_RESPONSE_BODY_KEYS.VALID_UNTIL],
-        [CCDB_RESPONSE_BODY_KEYS.ID]: qcObject[CCDB_RESPONSE_BODY_KEYS.ID],
-      };
-    } else {
-      throw new Error(`Object: ${url} could not be found`);
+    let result = null;
+    try {
+      result = await httpGetJson(this._hostname, this._port, url, { headers });
+    } catch {
+      throw new Error(`Failed to fetch object at url '${url}' and path '${partialIdentification.path}'.`);
     }
+
+    if (!result?.objects?.length) {
+      const errorMessage = this._buildFilterErrorMessage(
+        `Object at url '${url}' and path '${partialIdentification.path}' could not be found.`,
+        partialIdentification.filters,
+      );
+      throw new NotFoundError(errorMessage);
+    }
+
+    const [qcObject] = result.objects;
+    return {
+      [CCDB_RESPONSE_BODY_KEYS.PATH]: qcObject[CCDB_RESPONSE_BODY_KEYS.PATH],
+      [CCDB_RESPONSE_BODY_KEYS.VALID_FROM]: qcObject[CCDB_RESPONSE_BODY_KEYS.VALID_FROM],
+      [CCDB_RESPONSE_BODY_KEYS.VALID_UNTIL]: qcObject[CCDB_RESPONSE_BODY_KEYS.VALID_UNTIL],
+      [CCDB_RESPONSE_BODY_KEYS.ID]: qcObject[CCDB_RESPONSE_BODY_KEYS.ID],
+    };
   }
 
   /**
@@ -215,7 +226,7 @@ export class CcdbService {
    * @throws {Error}
    */
   async getObjectDetails(identification) {
-    const { path = '', validFrom = undefined } = identification ?? {};
+    const { path = '', filters, validFrom = undefined } = identification ?? {};
     if (!path || !validFrom) {
       throw new Error('Missing mandatory parameters: path & validFrom');
     }
@@ -226,15 +237,23 @@ export class CcdbService {
         .split(', ')
         .filter((location) => !location.startsWith('alien') && !location.startsWith('file'));
       if (!location) {
-        throw new Error(`No location provided by CCDB for object with path: ${path}`);
+        const errorMessage = this._buildFilterErrorMessage(
+          `No location provided by CCDB for object with path: ${path}`,
+          filters,
+        );
+        throw new Error(errorMessage);
       }
       return {
         ...headers,
         location,
         path,
       };
     } else {
-      throw new Error(`Unable to retrieve object: ${path} due to status: ${status}`);
+      const errorMessage = this._buildFilterErrorMessage(
+        `Unable to retrieve object: ${path} due to status: ${status}`,
+        filters,
+      );
+      throw new Error(errorMessage);
     }
   }
 
@@ -243,7 +262,8 @@ export class CcdbService {
    * The minimum required parameter to provide is the `path`
    * @param {CcdbObjectIdentification} identification - attributes by which the object should be queried
    * @returns {Promise.<JSON>} - object details for a given timestamp
-   * @throws {Error}
+   * @throws {Error} Thrown when an error occurs whilst fetching the object
+   * @throws {NotFoundError} Thrown when the object cannot be found
    */
   async getObjectLatestVersionInfo(identification) {
     const { path } = identification ?? {};
@@ -257,7 +277,7 @@ export class CcdbService {
       const url = `/latest${this._buildCcdbUrlPath(identification)}`;
       const { objects } = await httpGetJson(this._hostname, this._port, url, { headers: timestampHeaders });
       if (objects?.length <= 0) {
-        throw new Error(`No object found for: ${path}`);
+        throw new NotFoundError(`No object found for: ${path}`);
       }
       return objects[0];
     } catch {
@@ -342,4 +362,32 @@ export class CcdbService {
     }
     return url;
   }
+
+  /**
+   * Builds a detailed error message for CCDB objects that may have been filtered out.
+   * This method appends a filter-specific hint to a base error message when
+   * the `filters` object contains one or more keys. It ensures proper punctuation
+   * and provides a clear explanation for why the object might not have been found.
+   * @param {string} baseMessage - The initial error message describing the failure.
+   * @param {object} [filters] - Optional object representing filters applied when searching for the object.
+   * @returns {string} - The final, human-readable error message including filter hints if applicable.
+   */
+  _buildFilterErrorMessage(baseMessage, filters) {
+    // Only append filter-specific hint if filters object exists and has keys
+    if (filters && Object.keys(filters).length > 0) {
+      // Ensure the base message ends with proper punctuation.
+      // If it does NOT end with any Unicode punctuation, append a period.
+      if (!/\p{P}$/u.test(baseMessage)) {
+        baseMessage += '.';
+      }
+      if (!baseMessage.endsWith(' ')) {
+        baseMessage += ' ';
+      }
+
+      // Append a clear, descriptive filter hint.
+      baseMessage += 'It was likely excluded by the applied filters.';
+    }
+
+    return baseMessage;
+  }
 }

QualityControl/test/api/objects/api-get-object.test.js

@@ -48,7 +48,11 @@ export const apiGetObjectsTests = () => {
 
     test('should return 500 if service fails to retrieve object', async () => {
       const url = `${URL_ADDRESS}/api/object?token=${OWNER_TEST_TOKEN}&path=invalid/path`;
-      await testResult(url, 500, { message: 'Non-2xx status code: 501', status: 500, title: 'Unknown Error' });
+      await testResult(url, 500, {
+        message: 'Failed to fetch object at url \'/latest/invalid/path\' and path \'invalid/path\'.',
+        status: 500,
+        title: 'Unknown Error',
+      });
     });
   });
 

QualityControl/test/lib/services/CcdbService.test.js

@@ -471,5 +471,39 @@ export const ccdbServiceTestSuite = async () => {
         strictEqual(ccdb._buildCcdbUrlPath(identification), '/qc/TPC/object/12322222/123332323/123-ffg/RunNumber=123456/PartName=Pass');
       });
     });
+
+    suite('CcdbService getObjectIdentification() Error Messages', () => {
+      let ccdb = null;
+
+      before(() => {
+        ccdb = new CcdbService(ccdbConfig);
+      });
+
+      test('should throw error if object not found with filters applied', async () => {
+        const filters = { RunNumber: 123456 };
+        const filterString = Object.entries(filters).map(([key, value]) => `${key}=${value}`).join('/');
+
+        nock('http://ccdb-local:8083')
+          .get(`/latest/path/${ID}/${filterString}`)
+          .reply(200, { objects: [] });
+
+        await rejects(
+          async () => ccdb.getObjectIdentification({ path: PATH, id: ID, filters }),
+          // eslint-disable-next-line @stylistic/js/max-len
+          new Error(`Object at url '/latest/path/${ID}/${filterString}' and path '${PATH}' could not be found. It was likely excluded by the applied filters.`),
+        );
+      });
+
+      test('should throw error if object not found without filters', async () => {
+        nock('http://ccdb-local:8083')
+          .get(`/latest/path/${ID}`)
+          .reply(200, { objects: [] });
+
+        await rejects(
+          async () => ccdb.getObjectIdentification({ path: PATH, id: ID }),
+          new Error(`Object at url '/latest/path/${ID}' and path '${PATH}' could not be found.`),
+        );
+      });
+    });
   });
 };