fiftyone.devicedetection.onpremise/dataFileMissingPropertyService.js

Device detection on-premise services for the 51Degrees Pipeline API

/* *********************************************************************
 * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
 * Copyright 2025 51 Degrees Mobile Experts Limited, Davidson House,
 * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
 *
 * This Original Work is licensed under the European Union Public Licence
 * (EUPL) v.1.2 and is subject to its terms as set out below.
 *
 * If a copy of the EUPL was not distributed with this file, You can obtain
 * one at https://opensource.org/licenses/EUPL-1.2.
 *
 * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
 * amended by the European Commission) shall be deemed incompatible for
 * the purposes of the Work and the provisions of the compatibility
 * clause in Article 5 of the EUPL shall not apply.
 *
 * If using the Work as, or as part of, a network application, by
 * including the attribution notice(s) required under Article 5 of the EUPL
 * in the end user terms of the application under an appropriate heading,
 * such notice(s) shall fulfill the requirements of that article.
 * ********************************************************************* */

const MissingPropertyService = require('fiftyone.pipeline.engines').MissingPropertyService;

const errorMessages = require('fiftyone.devicedetection.shared').errorMessages;
const util = require('util');

/**
 * @typedef {import('fiftyone.pipeline.core').FlowElement} FlowElement
 */

/**
 * Instance of the MissingPropertyService class that checks if a
 * property is available in the current dataFile
 */
class DeviceDetectionMissingPropertyService extends MissingPropertyService {
  /**
   * Constructor for Missing Property Service that receives a requested property
   * key that is missing in the data. If it is missing because the data does not
   * exist in the data file that was chosen, it returns an error which
   * states which data file the property can be found in.
   *
   * @param {string} key missing property key
   * @param {FlowElement} flowElement the FlowElement the key was missing from
   * @returns {never} throws an error
   */
  check (key, flowElement) {
    if (flowElement.properties[key]) {
      const currentDataFile = flowElement.engine.getProduct();
      const dataFiles = flowElement.properties[key].dataFiles;

      throw util.format(
        errorMessages.propertyKeyDataFiles,
        key,
        dataFiles.join(' '),
        currentDataFile);
    } else {
      throw util.format(
        errorMessages.propertyNotFound,
        key,
        flowElement.dataKey
      );
    }
  }
}

module.exports = DeviceDetectionMissingPropertyService;