ml-modules.root.data-hub.5.endpoints.collectorLib.mjs Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of marklogic-data-hub Show documentation
Library for Creating an Operational Data Hub on MarkLogic
There is a newer version: 6.1.1
/*
 * Copyright 2016-2019 MarkLogic Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
'use strict';
import hubUtils from "/data-hub/5/impl/hub-utils.mjs";
import featuresCore from "/data-hub/features/core.mjs";
import entityLib from "/data-hub/5/impl/entity-lib.mjs";
import hubTemporal from "../temporal/hub-temporal.mjs";

/**
 * Determine the sourceQuery from the given options and stepDefinition and then prepare it for evaluation by the
 * collector endpoint.
 *
 * @param combinedOptions
 * @param stepDefinition
 * @return {string|*}
 */
function prepareSourceQueryWithoutUris(combinedOptions, stepDefinition) {
  let sourceQuery = combinedOptions.sourceQuery;

  if (combinedOptions.sourceQueryIsScript) {
    if (combinedOptions.sourceQueryLimit) {
      hubUtils.warn(`Ignoring 'sourceQueryLimit' property as 'sourceQueryIsScript' is set to true`);
    }
    return fn.normalizeSpace(`${sourceQuery}`);
  }

  if (true === combinedOptions.constrainSourceQueryToJob || "true" === combinedOptions.constrainSourceQueryToJob) {
    if (combinedOptions.jobId) {
      sourceQuery = fn.normalizeSpace(`cts.andQuery([cts.fieldWordQuery('datahubCreatedByJob', '${combinedOptions.jobId}'), ${sourceQuery}])`);
    } else {
      hubUtils.warn(`Ignoring constrainSourceQueryToJob=true because no jobId was provided in the options`);
    }
  }
  return invokeFeatureMethods(stepDefinition, sourceQuery);
}

function prepareSourceQuery(combinedOptions, stepDefinition) {
  let sourceQueryLimit = fn.number(combinedOptions.sourceQueryLimit);
  let sourceQuery = prepareSourceQueryWithoutUris(combinedOptions, stepDefinition);
  if (combinedOptions.sourceQueryIsScript) {
    return sourceQuery;
  }
  // This is retained only for backwards compatibility, though its existence is neither documented nor tested
  // prior to DHFPROD-4665. Prior to DHFPROD-3854, this did support cts.values, though it would not have worked had
  // someone tried to use that, since the rest of DHF was still expecting URIs to be returned, not values.
  if (/^\s*cts\.uris\(.*\)\s*$/.test(sourceQuery)) {
    return sourceQuery;
  }

  return sourceQueryLimit ? `cts.uris(null, ['limit=${sourceQueryLimit}', 'score-zero', 'concurrent'], ${sourceQuery}, 0)` : `cts.uris(null, ['score-zero', 'concurrent'], ${sourceQuery}, 0)`;
}

function invokeFeatureMethods(stepDefinition, sourceQuery) {
  let sourceQueryUpdated = sourceQuery;
  let targetEntityType = stepDefinition.targetEntity || stepDefinition.targetEntityType;
  let model = null;
  if (targetEntityType) {
    const modelNode = entityLib.findModelForEntityTypeId(targetEntityType);
    model = fn.exists(modelNode) ? modelNode.toObject() : null;
  }
  const features = Object.keys(featuresCore.getFeatures());
  features.forEach(feat => {
    const funct = featuresCore.getFeatureMethod(feat, "onBuildInstanceQuery");
    if (funct) {
      sourceQueryUpdated = funct(stepDefinition, model, sourceQueryUpdated);
    }
  });
  return sourceQueryUpdated;
}

export default {
  prepareSourceQuery,
  prepareSourceQueryWithoutUris
};