rallf-js-sdk/src/lib/checker.js

Toolset to create Tasks for RALLF

'use strict';

const fs = require('fs-extra');
const path = require('path');
const Validator = require('jsonschema').Validator;
const schemes = require('./schemes');

const Task = require('../integration/task');

module.exports = {

  /**
   * 
   * @param {string} task_path 
   */
  isValidTaskProject(task_path, manifest) {
    if (typeof task_path !== 'string') {
      return {
        error: 'ERROR: "task_path" must be a string'
      };
    }

    let manifestPath = path.join(task_path, 'config', 'manifest.json');
    if (!fs.existsSync(manifestPath)) {
      return {
        error: `Task "${task_path}" does not seem to be a rallf Task: 'config/manifest.json' is missing`
      };
    }


    let validManifest = this.validManifest(manifest);
    if (validManifest.errors) {
      for (let error of validManifest.errors) {
        return {
          error: `Task ${task_path} manifest is invalid: \n ${error.stack}`
        };
      }
    }

    return true;
  },

  /**
   * 
   * @param {any} manifest 
   */
  validManifest(manifest) {
    const vali = new Validator();
    const instance = manifest;
    const schema = schemes.manifest;
    let validation = vali.validate(instance, schema);

    if (validation.errors) return {
      valid: false,
      errors: validation.errors
    };

    return true;
  },


  /**
   * @TODO - Improve checking if class extends Task
   * This is not reliable, needs improving... 
   * Had problems when running with global `rallf-js run` command, running from local package worked
   * A hack is in place that check if the prototype of the export is a function
   */
  checkExportToBeTask(export_) {
    const isTaskInstance = Task.isPrototypeOf(export_) || (typeof export_.prototype._hasDoneWarmup === 'function');
    if (!isTaskInstance) {
      throw {
        error: `ERROR: Task seams to not be a valid rallf.Task, please make sure your class extends rallf.Task`
      };
    }
    return true;
  },

  hasMethod(object, method_name) {
    return (
      object &&
      method_name in object &&
      typeof object[method_name] === 'function'
    );
  }

};