@ikonintegration/ikapi 4.0.1 → 5.0.0

package/src/Logger/IKLogger.js

@@ -1,136 +0,0 @@
-import abind from 'abind';
-import stackTrace from 'stack-trace';
-import stringify from 'json-stringify-safe';
-//
-import Utils from "./../API/IKUtils.js";
-//
-export const LOG_LEVELS = { DEBUG: 0, INFO: 1, WARN: 2, ERROR: 3 };
-const LOG_STRINGS = ['DEBUG', 'INFO', 'WARN', 'ERROR'];
-const PURE_CONSOLE = (console.flushLogs ? console.origin : console);
-const DEFAULT_LOG_FUNCTION = PURE_CONSOLE.log.bind(PURE_CONSOLE);
-//
-const blacklist = ['password','phonenumber'/*,'code'*/,'resetCode','recaptchaToken','token','mfa','REFRESH_TOKEN','SECRET_HASH','SecretHash','AccessToken','UserCode','paymentMethodNonce'];
-//
-export default class IKLogger {
-  constructor(_config, _LOG_LEVEL, transactionID) {
-    abind(this);
-    //
-    if (!_LOG_LEVEL && !(_config || {}).level) _LOG_LEVEL = LOG_LEVELS.DEBUG;
-    else {
-      _LOG_LEVEL = LOG_STRINGS.indexOf((_config || {}).level || _LOG_LEVEL);
-      if (_LOG_LEVEL == -1) _LOG_LEVEL = LOG_LEVELS.DEBUG;
-    }
-    //
-    this.origin = PURE_CONSOLE;
-    this._LOG_LEVEL = _LOG_LEVEL;
-    this._config = _config || {};
-    this._transactionID = transactionID;
-    this._filterBlacklist = this._config.sensitiveFilteringKeywords || blacklist;
-    //
-    this._setupBindings();
-    //
-    this.log("Using logger with level: " + LOG_STRINGS[this._LOG_LEVEL]);
-    this.debug("logger config: ", this._config);
-  }
-
-  //Public
-  debug(...args) { this._processLog(false, LOG_LEVELS.DEBUG, args); }
-  log(...args) { this._processLog(false, LOG_LEVELS.INFO, args); }
-  info(...args) { this._processLog(false, LOG_LEVELS.INFO, args); }
-  warning(...args) { this._processLog(false, LOG_LEVELS.WARN, args); }
-  warn(...args) { this._processLog(false, LOG_LEVELS.WARN, args); }
-  error(...args) { this._processLog(false, LOG_LEVELS.ERROR, args); }
-  exception(exception, ...args) { this._exception(false, exception, args); }
-  _exception(isRaw ,exception, ...args) {
-    //format message
-    let msg = [];
-    //push exeception
-    msg.push(exception + " -");
-    //get args
-    for (let arg of args) if (arg != exception) msg.push(arg);
-    msg.push(exception.stack); //push exeception stack at the end
-    //push into logs stack
-    this._pushLog(LOG_LEVELS.ERROR, this._formattedLog(LOG_LEVELS.ERROR, msg, this._callerName(3), isRaw));
-  }
-  //
-  cleanUp() { }
-  async flushLogs() {}
-
-
-  //initialization
-  _setupBindings() {
-    global.console = {
-      debug: (...args) => this._processLog(true, LOG_LEVELS.DEBUG, args),
-      log: (...args) => this._processLog(true, LOG_LEVELS.INFO, args),
-      info: (...args) => this._processLog(true, LOG_LEVELS.INFO, args),
-      warning: (...args) => this._processLog(true, LOG_LEVELS.WARN, args),
-      warn: (...args) => this._processLog(true, LOG_LEVELS.WARN, args),
-      error: (...args) => this._processLog(true, LOG_LEVELS.ERROR, args),
-      exception: (exception, ...args) => this._exception(true, exception, args),
-    };
-  }
-
-
-  /* Formatters */
-  _timestamp() {
-    let d = new Date();
-    return [Utils.toDoubleDigit(d.getMonth()+1), Utils.toDoubleDigit(d.getDate()), d.getFullYear()].join('/') +' ' +
-           [Utils.toDoubleDigit(d.getHours()), Utils.toDoubleDigit(d.getMinutes()), Utils.toDoubleDigit(d.getSeconds())].join(':');
-  }
-  _formattedLog(level, msg, caller, isRaw) {
-    if (Utils.isOffline()) {
-      return ` [${this._timestamp()} - ${LOG_STRINGS[level]}] [${caller}] ${msg.join(" ")}`;
-    } else if (Utils.isHybridlessContainer() && this._transactionID) {
-      return (isRaw ? '' : ` ${this._transactionID}`) + ` [${LOG_STRINGS[level]}] [${caller}] ${(msg.map(this._supressSensitiveInfo).join(" "))}`;
-    } else {
-      return ` [${LOG_STRINGS[level]}] [${caller}] ${msg.join(" ")}`;
-    }
-  }
-  _callerName(index) {
-    let safeIndex = Math.min(index, stackTrace.get().length);
-    if (stackTrace.get()[safeIndex]) {
-      let callerName = (stackTrace.get()[safeIndex] ? stackTrace.get()[safeIndex].getTypeName() : null);
-      if (!callerName) {
-        callerName = stackTrace.get()[safeIndex].getFileName().split("/");
-        callerName = callerName.slice(callerName.indexOf("src")).join("/");
-      } return callerName + ":" + stackTrace.get()[safeIndex].getLineNumber();
-    } return '';
-  }
-  /* Helpers (core functionality) */
-  _processLog(isRaw, level, args) {
-    if (level < this._LOG_LEVEL) return;
-    //get args
-    let msg = [];
-    for (let arg of args) msg.push(((typeof arg === 'object' && !(arg instanceof Error)) ? stringify(arg, null, 2) : arg));
-    //push into logs stack
-    // todo: improve error stack
-    this._pushLog(level, this._formattedLog(level, msg, this._callerName(3), isRaw));
-  }
-  _pushLog(level, fMsg) {
-    // push into logs stack
-    // this._logs.push(fMsg);
-    DEFAULT_LOG_FUNCTION.apply(PURE_CONSOLE, [fMsg]);
-  }
-  /* Sensitive information handling */
-  _supressSensitiveInfo(value) {
-    //realy false
-    if (this._config.enableSensitiveFiltering !== undefined && (!this._config.enableSensitiveFiltering || this._config.enableSensitiveFiltering == 'false')) return value;
-    if (typeof value == "string") {
-      //content based replacement
-      blacklist.forEach((f) => {
-        const match = blacklist.find((f) => value.toLowerCase().includes(f.toLowerCase()));
-        if (match) value = '**SUPRESSED_SENSITIVE_DATA**';
-      });
-      return value;
-    } else if (typeof value == 'object') {
-      //key based replacement
-      Object.keys(value).forEach(function (elt, i, array) {
-        const match = blacklist.find((f) => elt.toLowerCase().includes(f.toLowerCase()));
-        if (match) value[elt] = '**SUPRESSED_SENSITIVE_DATA**';
-        else value[elt] = value[elt];
-      });
-      return value;
-    } else if (Array.isArray(value)) return value.map(v=>this._supressSensitiveInfo(v));
-    return value;
-	}
-}

package/src/Mailer/IKMailer.js

@@ -1,69 +0,0 @@
-import nodemailer from "nodemailer";
-import Email from 'email-templates';
-import AWSSES from "@aws-sdk/client-ses";
-//
-import { defaultProvider } from '@aws-sdk/credential-provider-node';
-import Utils from "./../API/IKUtils.js";
-//
-export default class IKMailer {
-  constructor(_defaultFrom, region) {
-    this.from = _defaultFrom;
-    this.templateDefaultFile = 'html';
-    //setup local stuff
-    let configObj = {region: region};
-    if (Utils.isOffline()) configObj = {region: region, accessKeyId: process.env.AWS_ACCESS_KEY_ID, secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY};
-    //
-    this.transporter = nodemailer.createTransport({
-      SES: {
-        ses: new AWSSES.SESClient({ apiVersion: "2010-12-01", ...configObj, defaultProvider }),
-        aws: AWSSES
-      }
-    });
-  }
-
-  //to and cc can be an array, just one address or a comma separated string containing multiple addresses
-  async sendTemplatedEmail(_to, _templates, _data, _optionalCC, _optionalAttachments, _optionalHeaders, _optionalFrom) {
-    //Generate emails
-    const email = new Email({
-      message: {
-        ...(_optionalHeaders ? {headers: _optionalHeaders} : {}),
-        from: _optionalFrom ? _optionalFrom : this.from,
-        to: _to,
-        ...(_optionalAttachments ? {attachments: _optionalAttachments} : {}),
-        ...(_optionalCC ? {cc: _optionalCC} : {})
-      },
-      transport: this.transporter,
-      send: true,
-    });
-    //
-    let resp = null;
-    try {
-      const choosenTemplate = await this._chooseTemplate(_templates, _data);
-      resp = await email.send({template: choosenTemplate, locals: _data});
-      // console.debug('Mailer resp:', resp);
-    } catch (e) { console.error('Mailer error:', e); }
-    return resp;
-  }
-
-
-  /* private */
-  async _chooseTemplate(templates, data) {
-    if (Array.isArray(templates)) {
-      //For each template check if can render it
-      for (let template of templates) {
-        if (await this._canRenderTemplate(template, data)) return template;
-      }
-    } else if (templates) {
-      if (await this._canRenderTemplate(templates, data)) return templates;
-    } throw new Error(`Could not render email with template ${templates} and following data. Please, check logs above!`, data);
-  }
-  async _canRenderTemplate(template, data) {
-    let validRenderResp = null;
-    try {
-      const email = new Email();
-      validRenderResp = await email.render(`${template}/${this.templateDefaultFile}`, data);
-    } catch (e) {
-      console.log(`Error while checking renderability of email template ${template}`, e);
-    } return (validRenderResp != null);
-  }
-}

package/src/Publisher/IKPublisher.js

@@ -1,44 +0,0 @@
-import { SNSClient, PublishCommand } from "@aws-sdk/client-sns";
-import sha1 from 'sha1';
-//
-import Utils from "./../API/IKUtils.js";
-//reusable client
-var PUBLISHER_CONN = null;
-var PUBLISHER_CONN_HASH = null;
-//
-export default class IKPublisher {
-  constructor(config) {
-    if (config && config.region) {
-      this.region = config.region;
-      // console.debug(`Using region: ${this.region}`);
-    }
-  }
-  /* Public */
-  async publishOnTopic(messageObject, topic, additionalProps) {
-    let resp = null;
-    try {
-      this._connect();
-      //Send to SNS
-      const params = {
-        Message: JSON.stringify(messageObject),
-        TopicArn: topic,
-        ...(additionalProps ? additionalProps : {}),
-      };
-      resp = await PUBLISHER_CONN.send(new PublishCommand(params));
-    } catch (e) {
-      console.error(`Error while publishing into topic ${topic} with error: ${e}`);
-    }
-    console.debug('Publisher resp', resp);
-    return resp;
-  }
-  /* Private */
-  _connect() {
-    if ((!PUBLISHER_CONN && !PUBLISHER_CONN_HASH) || PUBLISHER_CONN_HASH != sha1(this.region)) {
-      //Configure when sending!
-      let configObj = { region: this.region };
-      if (Utils.isOffline()) configObj = { ...configObj, accessKeyId: process.env.AWS_ACCESS_KEY_ID, secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY };
-      PUBLISHER_CONN = (new SNSClient({ apiVersion: '2010-03-31', ...configObj }));
-      PUBLISHER_CONN_HASH = sha1(this.region);
-    }
-  }
-}

package/src/Tracker/IKExecutionTracker.js

@@ -1,79 +0,0 @@
-import RTClient from '@ikonintegration/mod-resources-tracker-client';
-//
-import Utils from "../API/IKUtils.js";
-//
-import fs from 'fs';
-//
-export default class IKExecutionTracker {
-  constructor(config, context, db) {
-    this.context = context;
-    this.db = db;
-    this.config = config;
-    this.startedOn = Date.now();
-    this.drainedExecution = false;
-    if (config) this.client = this._getClient(config);
-    this.claimers = {};
-  }
-  /* Public */
-  appendClaimer(value, key) { this.claimers[value] = key; }
-  appendEvent(event) { this.client.appendEvent(event); }
-  //
-  resetExecutionTrace() { 
-    this.startedOn = Date.now(); 
-    this.drainedExecution = false;
-  }
-  async quickDrain() {
-    try {
-      //Check for client but claimers
-      if (!this.client) return; //disabled
-      //drain stats (drain will filter for events with claimers only)
-      await this.client.drain(this.claimers);
-    } catch (e) { console.error(`Error while draining tracker events: ${e}`); }
-  }
-  async trackExecAndDrain() {
-    try {
-      //Check 
-      if (this.drainedExecution) return;
-      this.drainedExecution = true;
-      //Check for client and claimers
-      if (!this.client) return; //disabled
-      //detect execution and log (ECS or lambda)
-      this._detectExecutionAndLog();
-      //detect DB and log (DDB only for now)
-      this._collectDDBStats();
-      //drain stats (drain will filter for events with claimers only)
-      await this.client.drain(this.claimers);
-    } catch (e) { console.error(`Error while tracking execution: ${e}`); }
-  }
-  /* private tracker */
-  _detectExecutionAndLog() {
-    //Is running on container?
-    if (Utils.isHybridlessContainer()) {
-      //ECS, get metadata info and log if applicable and succeeded on it
-      const context = this._getECSMetadataObject();
-      // console.debug('Context', context);
-      if (context && context.ContainerInstanceARN) {
-        const extraDetails = { startTime: this.startedOn, endTime: Date.now(), taskConfig: { cpu: process.env.CPU, memory: process.env.MEMORY, taskName: context.TaskDefinitionFamily } };
-        const event = RTClient.newECSExecutionEvent(context.TaskARN, context.ContainerInstanceARN, extraDetails);
-        this.appendEvent(event);
-      }
-    } else {
-      const event = RTClient.newLambdaInvocationEvent(this.context ? this.context.awsRequestId : null);
-      this.appendEvent(event); //lambda logging
-    }
-  }
-  _collectDDBStats() {
-    const stats = this.db ? this.db.getTrackerStats() : null;
-    if (stats) this.client.appendEvent(RTClient.newDynamoEvent(stats.tableName, stats.readUnits, stats.writeUnits));
-  }
-  /* Private */
-  _getClient(config) {
-    return new RTClient({ busName: config.busName, region: config.region, source: config.appName });
-  }
-  /* ECS helper */
-  _getECSMetadataObject() {
-    try { return JSON.parse(fs.readFileSync(process.env.ECS_CONTAINER_METADATA_FILE)); }
-    catch (e) { console.error('Unable to retrieve metadata object: ' + e); }
-    return null;
-  }
-}

package/src/Validation/IKValidation.js

@@ -1,76 +0,0 @@
-import IKGlobals from './../IKGlobals.js';
-import Utils from './../API/IKUtils.js';
-import IKResponse, { IKBadRequestResponse } from './../API/IKResponse.js';
-//https://www.npmjs.com/package/superstruct
-import * as struct from 'superstruct';
-//validation libs
-import isUuid from 'is-uuid';
-import isEmail from 'is-email';
-//
-export default class IKValidation {
-  constructor(config) {
-    this.customStruct = {};
-    this._buildInternalTypes((config && config.additionalTypes ? config.additionalTypes : {}));
-  }
-  _buildInternalTypes(additionalTypes) {
-    for (const key in IKValidation.internalTypes()) {
-      this.customStruct[key] = struct.define(key, IKValidation.internalTypes()[key]);
-    }
-    for (const key in additionalTypes) {
-      this.customStruct[key] = struct.define(key, additionalTypes[key]);
-    }
-  }
-  async validate(spec, obj, request) {
-    let assertion = null;
-    let err = null;
-    try {
-      let parsedRawObj = obj;
-      if (typeof spec == 'function') spec = spec(this)
-      assertion = struct.assert(parsedRawObj, spec);
-    } catch (e) {
-      console.debug(e);
-      const { path, value, type } = e;
-      const key = (path ? path[0] : undefined);
-      let errorMessage = e;
-      //Check for value required error
-      if (value === undefined) errorMessage = `Required value '${key}' is missing.`
-      else if (type === undefined) errorMessage = `Unknown key '${key}'.`
-      else errorMessage = `Invalid value '${value}' for key '${key}'.`
-      //Generate error
-      err = IKBadRequestResponse(IKGlobals.ErrorResponseValidationFail + errorMessage, IKGlobals.ErrorCode_InvalidInput);
-    }
-    //Catch error as response
-    if (err) return err;
-    //run normal code out of this try/catch scope
-    return await request(obj);
-  }
-}
-//
-IKValidation.internalTypes = function() {
-  return {
-    email: value => { return (isEmail(value) && value.length < 256); },
-    fullAddress: value => {
-      if (!value) return false;
-      return true;
-    },
-    'date-yyyymmdd': value => {
-      if (!value) return false;
-      //TODO CHECK DATE FORMAT
-      let d = new Date(value);
-      return (d instanceof Date && !isNaN(d));
-    },
-    'arrayIDs': value => {
-      if (!value || !Array.isArray(value)) return false;
-      for (let id of value) if (id.length < 10) return false;
-      return true;
-    },
-    //TODO: this should be moved out to the project requiring this
-    ACEArray: value => {
-      if (!value || !value.length) return false;
-      for (let val of value) {
-        if (!val.accessType || !val.roleID) return false;
-      }
-      return true;
-    },
-  }
-}