ml-modules.root.data-hub.5.flow.job.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 consts from "/data-hub/5/impl/consts.mjs";
import hubUtils from "/data-hub/5/impl/hub-utils.mjs";
import jobs from "/data-hub/5/impl/jobs.mjs";

/**
 * Encapsulates a Job object and provides convenience operations for updating the object and persisting it
 * to the jobs database.
 *
 * Note that nothing is written to the database unless either "create" or "update"
 * is invoked.
 */
export default class Job {

  static newJob(flowName, jobId) {
    const job = jobs.buildNewJob(jobId, flowName);
    return new Job(job);
  }

  static getRequiredJob(jobId) {
    const job = jobs.getRequiredJob(jobId);
    return new Job(job);
  }

  constructor(job) {
    this.data = job;
  }

  create() {
    jobs.saveNewJob(this.data);
    return this.data;
  }

  update() {
    jobs.updateJob(this.data);
    return this.data;
  }

  startStep(stepNumber, stepDetails) {
    const stepStatus = "running step " + stepNumber;
    hubUtils.hubTrace(consts.TRACE_FLOW, `Starting step '${stepNumber}' of job '${this.data.job.jobId}'; setting job status to '${stepStatus}'`);
    this.data.job.lastAttemptedStep = stepNumber;
    this.data.job.jobStatus = stepStatus;
    this.data.job.stepResponses[stepNumber] = {
      stepStartTime: fn.currentDateTime().add(xdmp.elapsedTime()),
      status: stepStatus,
      stepName: stepDetails ? stepDetails["name"] : undefined,
      stepDefinitionType: stepDetails ? stepDetails["stepDefinitionType"] : undefined
    };
    return this;
  }

  /**
   *
   * @param stepNumber
   * @param stepResponse
   * @param stepStatus {string} optional; if specified, the status in stepResponse will be ignored
   * @param outputContentArray {array} optional; will be passed along to the jobReport function for the step if one exists
   * @param writeQueue {object} optional; will be passed along to the jobReport function for the step if one exists
   * @returns
   */
  finishStep(stepNumber, stepResponse, stepStatus, outputContentArray, writeQueue) {
    stepStatus = stepStatus || stepResponse.status;

    hubUtils.hubTrace(consts.TRACE_FLOW, `Finishing step '${stepNumber}' of job '${this.data.job.jobId}'; setting job status to '${stepStatus}'`);

    this.data.job.jobStatus = stepStatus;

    if (stepStatus.startsWith("completed")) {
      this.data.job.lastCompletedStep = stepNumber;
    }

    // Ensure stepStartTime is not modified from what it was originally set to
    stepResponse.stepStartTime = this.data.job.stepResponses[stepNumber].stepStartTime;

    // If stepEndTime has been set - such as for connected steps - don't overwrite it
    if (!stepResponse.stepEndTime) {
      stepResponse.stepEndTime = fn.currentDateTime();
    }

    jobs.createJobReport(this.data.job.jobId, stepNumber, stepResponse, outputContentArray, writeQueue);

    this.data.job.stepResponses[stepNumber] = stepResponse;
    return this;
  }

  /**
   *
   * @param jobStatus
   * @param timeEnded
   * @param flowErrors {array} optional array of flow-level errors; as of 5.5, will only exist for connected steps
   * @returns
   */
  finishJob(jobStatus, timeEnded, flowErrors) {
    hubUtils.hubTrace(consts.TRACE_FLOW, `Setting status of job '${this.data.job.jobId}' to '${jobStatus}'`);
    this.data.job.jobStatus = jobStatus;
    this.data.job.timeEnded = timeEnded;

    if (flowErrors) {
      this.data.job.flowErrors = flowErrors;
    }

    return this;
  }
}