ml-modules.root.data-hub.transforms.mlcp-flow-transform-lib.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 (c) 2021 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.
 */

import DataHubSingleton from "/data-hub/5/datahub-singleton.mjs";
import consts from "/data-hub/5/impl/consts.mjs";
import flowApi from "/data-hub/public/flow/flow-api.mjs";
import httpUtils from "/data-hub/5/impl/http-utils.mjs";
import hubUtils from "/data-hub/5/impl/hub-utils.mjs";

const emptySequence = Sequence.from([]);
const datahub = DataHubSingleton.instance();

export function transform(urisToContent, context = {}) {
  let params = {};
  let optionsString = null;
  let parsedTransformParam;
  let transformString = context.transform_param ? context.transform_param : '';
  let pattern = '^.*(options={.*}).*$';
  let match = new RegExp(pattern).exec(transformString);
  if (match === null) {
    parsedTransformParam = transformString;
  } else {
    optionsString = match[1];
    parsedTransformParam = transformString.replace(optionsString, '');
  }

  let splits = parsedTransformParam.split(',');
  for (let i in splits) {
    let pair = splits[i];
    let parts = pair.split('=');
    params[parts[0]] = parts[1];
  }

  const flowName = params['flow-name'] ? xdmp.urlDecode(params['flow-name']) : "default-ingestion";
  if (flowName === 'default-ingestion') {
    context.collections = hubUtils.normalizeToArray(context.collections);
    if (!context.collections.includes('default-ingestion')) {
      context.collections.push('default-ingestion');
    }
  }

  const jobId = params["job-id"] || `mlcp-${xdmp.transaction()}`;

  const options = optionsString ? parseOptionsString(optionsString) : {};
  options.sourceName = params["sourceName"];
  options.sourceType = params["sourceType"];

  const contentArray = buildContentArray(urisToContent, context);

  // Have to tokenize on ";" since the transform param value already tokenizes on ","
  const stepNumbers = params.steps ? params.steps.split(";") : null;

  if (stepNumbers) {
    options.throwStepError = true; // Let errors propagate to MLCP
    flowApi.runFlowOnContent(flowName, contentArray, jobId, options, stepNumbers);
    return {content: emptySequence, context};
  } else {
    // It would be possible to always use the above approach, thus removing all the code below. The only issue
    // is that instead of getting a useless Job document that is 'started' with no step responses, we instead get a
    // finished Job document, but it only represents one batch. It's hard to say that's an improvement, so leaving the
    // below code in place for now.

    const step = params['step'] ? xdmp.urlDecode(params['step']) : null;
    options.writeStepOutput = false;
    options.fullOutput = true;
    // This maps to the ResponseHolder Java class; it's not a RunFlowResponse or RunStepResponse
    const responseHolder = datahub.flow.runFlow(flowName, jobId, contentArray, options, step);

    // If the flow response has an error, propagate it up to MLCP so MLCP can report it
    if (responseHolder.errors && responseHolder.errors.length) {
      httpUtils.throwBadRequestWithArray([`Flow failed with error: ${responseHolder.errors[0].stack}`, contentUri]);
    }

    const contentDocuments = responseHolder.documents;
    if (contentDocuments && contentDocuments.length) {
      Object.assign(context, normolizeToXQueryContext(contentDocuments[0].context));
      for (let doc of contentDocuments) {
        delete doc.context;
        if (!doc.value) {
          httpUtils.throwNotFoundWithArray([`No content.value defined for URI: ${doc.uri}`, doc.uri]);
        }
        if (!(doc.value instanceof Node)) {
          doc.value = xdmp.toJSON(doc.value);
        }
      }
      return {content: Sequence.from(contentDocuments), context};
    }
  }
  return {content: emptySequence, context};
}

function normolizeToJsonContext(context) {
  const normalizedContextObject = Object.assign({}, context);
  for (const [key, value] of Object.entries(normalizedContextObject)) {
    if (fn.empty(value)) {
      normalizedContextObject[key] = key === "quality" ? "0": [];
    }
  }
  return normalizedContextObject;
}

function normolizeToXQueryContext(context) {
  const normalizedContextObject = Object.assign({}, context);
  for (let [key, value] of Object.entries(normalizedContextObject)) {
    if (Array.isArray(value)) {
      let newValue = value;
      if (key === "permissions") {
        newValue = value.map(perm => xdmp.permission(xdmp.roleName(perm.roleId), perm.capability, "element"));
      }
      normalizedContextObject[key] = Sequence.from(newValue);
    }
  }
  return normalizedContextObject;
}

function buildContentArray(urisToContent, context) {
  const normContext = normolizeToJsonContext(context);
  const contentArray = [];
  const urisToContentEntries =  Object.values(urisToContent);
  for (const content of urisToContentEntries) {
    if (content.value) {
      content.context = Object.assign({}, normContext);
      contentArray.push(content);
    }
  }
  return contentArray;
}

function parseOptionsString(optionsString) {
  let tokens = optionsString.split("=");
  if (tokens.length < 2) {
    // Using console.log so this always appears
    xdmp.log("Unable to parse JSON options; expecting options={json object}; found: " + optionsString);
    return {};
  }
  try {
    const options = JSON.parse(optionsString.split("=")[1]);
    hubUtils.hubTrace(consts.TRACE_FLOW, `Parsed options into JSON object: ${xdmp.toJsonString(options)}`);
    return options;
  } catch (e) {
    httpUtils.throwBadRequestWithArray([`Could not parse JSON options; cause: ${e.message}`]);
  }
}

export default {transform};