ml-modules.root.data-hub.data-services.flow.flow-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.
 */
'use strict';
import Artifacts from "/data-hub/5/artifacts/core.mjs";
import config from "/com.marklogic.hub/config.mjs";
import hubUtils from "/data-hub/5/impl/hub-utils.mjs";
import httpUtils from "/data-hub/5/impl/http-utils.mjs";

const stepMap = {};

function getFlowsWithStepDetails(flowName = null) {
  if (flowName) {
    return getStepDetails(Artifacts.getArtifact("flow", flowName));
  } else {
    let flows = Artifacts.getArtifacts("flow");
    //stepMap is used only to get "sourceFormat" and "targetEntityType" which is not required when getting a flow with latest job info
    buildStepMap(flows);
    return flows.map(flow => {
      return getStepDetails(flow);
    });
  }
}

function findStepsByIds(stepIds) {
  return cts.search(cts.andQuery([
    cts.collectionQuery("http://marklogic.com/data-hub/steps"),
    cts.jsonPropertyValueQuery("stepId", stepIds, ["case-insensitive", "unstemmed"])
  ]), ["unfiltered", "score-zero", "unfaceted"]);
}

function getStepDetails(flow) {
  const flowWithStepDetails = {name: flow.name};
  if (flow.description) {
    flowWithStepDetails.description = flow.description;
  }
  if (flow.steps) {
    flowWithStepDetails.steps = [];
    Object.keys(flow.steps).forEach(stepNumber => {
      const stepDetails = {stepNumber};
      flowWithStepDetails.steps.push(stepDetails);
      let step = flow.steps[stepNumber];
      const stepId = flow.steps[stepNumber].stepId;
      if (stepId) {
        let stepDoc = stepMap[stepId];
        if (!stepDoc) {
          stepDoc = fn.head(findStepsByIds(stepId)).toObject();
        }
        stepDetails.stepName = stepDoc.name || stepId;
        stepDetails.stepDefinitionType = stepDoc.stepDefinitionType;
        //'stepMap' is generated only when getting all flows ('flowName' is null)
        if (Object.keys(stepMap).length > 0) {
          step = stepMap[stepId];
          if (!step) {
            httpUtils.throwBadRequest(`Unable to find referenced step with ID ${stepId} in flow ${flow.name}`);
          }
        }
      } else {
        stepDetails.stepName = step.name;
        stepDetails.stepDefinitionType = step.stepDefinitionType;
      }
      stepDetails.stepId = stepId;
      if (step) {
        stepDetails.sourceFormat = step.sourceFormat;
        // accommodating targetEntity which is still used by mastering (match/merge) for the time being
        stepDetails.targetEntityType = step.targetEntityType || step.targetEntity;
      }
    });
  }
  return flowWithStepDetails;
}

function buildStepMap(flows) {
  // Find all stepIds so we can retrieve them in one query
  const stepIds = [];
  flows.forEach(flow => {
    Object.keys(flow.steps).forEach(key => {
      if (flow.steps[key].stepId) {
        stepIds.push(flow.steps[key].stepId);
      }
    });
  });

  // Query for referenced steps, if any exist
  const steps = stepIds.length < 1 ? [] : findStepsByIds(stepIds);

  // Build a map of steps for fast access
  for (const step of steps) {
    const stepObject = step.toObject();
    stepMap[stepObject.stepId] = stepObject;
  }
}

function getFlowWithLatestJobInfo(flowName) {
  let flowWithStepDetails = getFlowsWithStepDetails(flowName);
  fn.head(hubUtils.invokeFunction(function() {
    flowWithStepDetails["steps"].forEach((step) => {
      const jobQueries = [];
      jobQueries.push(cts.collectionQuery('Job'));
      jobQueries.push(cts.jsonPropertyValueQuery("flow", flowWithStepDetails.name));
      jobQueries.push(cts.jsonPropertyValueQuery("stepName", step.stepName));
      //A flow may contain same step more then once. 'status' in step response always contains step number
      // jobQueries.push(cts.jsonPropertyWordQuery("status",step.stepNumber));

      let latestJob = fn.head(fn.subsequence(cts.search(cts.andQuery(jobQueries), [cts.indexOrder(cts.jsonPropertyReference("timeStarted"), "descending")]), 1, 1));
      if (latestJob) {
        latestJob = latestJob.toObject();
        let stepRunResponses = latestJob.job.stepResponses;
        if (stepRunResponses && hubUtils.getObjectValues(stepRunResponses).length > 0) {
          let stepRunResponse = hubUtils.getObjectValues(stepRunResponses).find(
            (el) => el.stepName === step.stepName
          );
          if (stepRunResponse) {
            step.jobId = latestJob.job.jobId;
            step.lastRunStatus = stepRunResponse.status;
            step.stepEndTime = stepRunResponse.stepEndTime;
          }
        }
      }
    });
  }, config.JOBDATABASE));
  return flowWithStepDetails;
}

export default {
  getFlowsWithStepDetails,
  getFlowWithLatestJobInfo
};