lesgo 0.7.8 → 2.1.0

package/src/services/__tests__/SQSService.spec.js

@@ -1,47 +0,0 @@
-import aws from 'Config/aws'; // eslint-disable-line import/no-unresolved
-import { SQS } from 'aws-sdk';
-import SQSService from '../SQSService';
-
-describe('ServicesGroup: test SQSService instantiation', () => {
-  it('test instantiate default SQSService', () => {
-    // eslint-disable-next-line no-unused-vars
-    const sqs = new SQSService();
-
-    expect(SQS).toHaveBeenCalledWith({});
-  });
-
-  it('test instantiate SQSService with custom options', () => {
-    // eslint-disable-next-line no-unused-vars
-    const sqs = new SQSService({
-      accessKeyId: 'aws.sqs.options.accessKeyId',
-      secretAccessKey: 'aws.sqs.options.secretAccessKey',
-      region: 'aws.sqs.options.region',
-    });
-
-    expect(SQS).toHaveBeenCalledWith({
-      accessKeyId: 'aws.sqs.options.accessKeyId',
-      secretAccessKey: 'aws.sqs.options.secretAccessKey',
-      region: 'aws.sqs.options.region',
-    });
-  });
-});
-
-describe('ServicesGroup: test SQSService usage', () => {
-  it('test dispatch', () => {
-    // eslint-disable-next-line no-unused-vars
-    const sqs = new SQSService({}, aws.sqs.queues);
-
-    return expect(
-      sqs.dispatch({ someData: 'someValue' }, 'pingQueue')
-    ).resolves.toMatchObject({
-      MessageId: 'MessageId',
-      mocked: {
-        opts: {},
-        params: {
-          MessageBody: '{"someData":"someValue"}',
-          QueueUrl: `${aws.sqs.queues.pingQueue.url}`,
-        },
-      },
-    });
-  });
-});

package/src/services/__tests__/SignedRequest.spec.js

@@ -1,103 +0,0 @@
-/* eslint-disable no-console */
-/* eslint-disable no-unused-vars */
-import AWS from 'aws-sdk';
-import {
-  initialize,
-  handleSuccess,
-  handleFail,
-  sendRequest,
-  signedRequest,
-} from '../aws/SignedRequest';
-
-const httpResp = {
-  statusCode: 0,
-  on: (key, cb) => {
-    if (key === 'data') {
-      cb('{"data": "mockedData"}');
-    } else if (key === 'end') {
-      cb();
-    }
-  },
-};
-
-const wrongHttpResp = {
-  statusCode: 0,
-  on: (key, cb) => {
-    if (key === 'data') {
-      cb('notJsonFormat');
-    } else if (key === 'end') {
-      cb();
-    }
-  },
-};
-
-// mock the process.nextTick
-process.nextTick = jest.fn().mockImplementation(cb => {
-  cb();
-});
-
-describe('ServicesGroup: test SignedRequest', () => {
-  it('test handleSuccess', () => {
-    httpResp.statusCode = 200;
-    handleSuccess(httpResp, true, (key, body) => {});
-    handleSuccess(httpResp, false, (key, body) => {});
-    httpResp.statusCode = 500;
-    handleSuccess(httpResp, false, (key, body) => {});
-
-    // should throw error 'Invalid JSON response'
-    wrongHttpResp.statusCode = 200;
-    handleSuccess(wrongHttpResp, false, (key, body) => {});
-    wrongHttpResp.statusCode = 500;
-    handleSuccess(wrongHttpResp, false, (key, body) => {});
-
-    handleSuccess(
-      {
-        statusCode: 200,
-        on: (key, cb) => {
-          if (key === 'data') {
-            cb('notJsonFormat');
-          } else if (key === 'end') {
-            cb();
-          }
-        },
-      },
-      false,
-      (key, body) => {}
-    );
-  });
-
-  it('test handleFail', () => {
-    const cb = error => {
-      console.log(error);
-    };
-    handleFail('mockingErrorAsString', cb);
-    handleFail(new Error('mockingErrorAsInstance'), cb);
-  });
-
-  it('test initialize', () => {
-    initialize(AWS, {
-      awsCreds: null,
-    });
-  });
-
-  it('test sendRequest', () => {
-    sendRequest({ rawResponse: false, method: 'POST' }, () => {});
-  });
-
-  it('test signedRequest', () => {
-    // null params
-    signedRequest(AWS, {}).send(null, () => {});
-
-    // no method params
-    signedRequest(AWS, {}).send({}, () => {});
-
-    // with method params
-    // no AWS
-    signedRequest(AWS, {}).send(
-      {
-        method: 'POST',
-      },
-      () => {}
-    );
-  });
-});

package/src/services/aws/AwsElasticsearchConnection.js

@@ -1,59 +0,0 @@
-import AWS from 'aws-sdk'; // eslint-disable-line import/no-extraneous-dependencies
-import { Connection } from '@elastic/elasticsearch';
-import SignedRequest from './SignedRequest';
-import LesgoException from '../../exceptions/LesgoException';
-
-/* eslint-disable class-methods-use-this */
-export default class AwsElasticsearchConnection extends Connection {
-  constructor(opts) {
-    super(opts);
-
-    this.opts = opts;
-  }
-
-  async request(params, cb) {
-    try {
-      const awsCreds = await this.getCredentials();
-
-      /* istanbul ignore else */
-      if (!this.opts.awsRegion) {
-        throw new LesgoException('Please provide the awsRegion!');
-      }
-
-      const httpClient = SignedRequest(AWS, {
-        endpoint: this.opts.url.host,
-        region: this.opts.awsRegion,
-        service: 'es',
-        awsCreds,
-      });
-
-      httpClient.send(
-        {
-          method: params.method,
-          path: params.path,
-          message: params.body,
-          headers: params.headers,
-          rawResponse: true, // @elastic search expect Raw Response
-        },
-        cb
-      );
-    } catch (err) {
-      cb(err);
-    }
-  }
-
-  getCredentials() {
-    // eslint-disable-next-line consistent-return
-    return new Promise((resolve, reject) => {
-      if (AWS.config.credentials === null) {
-        return reject(new Error('Invalid AWS Credentials'));
-      }
-
-      AWS.config.getCredentials((err, creds) => {
-        if (err) return reject(err);
-
-        return resolve(creds);
-      });
-    });
-  }
-}

package/src/services/aws/SignedRequest.js

@@ -1,158 +0,0 @@
-/**
- * Create the utility that sends signed request
- *
- * @ref
- *    https://github.com/guardian/aws-signed-request
- *    https://github.com/TheDeveloper/http-aws-es
- *    https://github.com/elastic/elasticsearch-js
- *
- * @param {aws-sdk} AWS sdk
- * @param {Object} config Configuration containing
- *    * endpoint: AWS endpoint
- *    * region: AWS region
- *    * service: AWS service
- *    * rawResponse: Will return rawResponse from httprequest
- *    * awsCreds: Aws crendential to use. default to AWS default
- *    * region: AWS region
- * @return {Object} Utility with method `send`
- */
-let AWS;
-let awsEndpoint;
-let awsCreds;
-let service;
-let region;
-
-const initialize = (aws, config) => {
-  AWS = aws;
-  awsEndpoint = new AWS.Endpoint(config.endpoint);
-  awsCreds = config.awsCreds || new AWS.EnvironmentCredentials('AWS');
-  service = config.service;
-  region = config.region;
-};
-
-const handleSuccess = (httpResp, asPlainText, callback) => {
-  let respBody = '';
-  httpResp.on('data', chunk => {
-    respBody += chunk;
-  });
-  httpResp.on('end', () => {
-    if (httpResp.statusCode >= 200 && httpResp.statusCode < 400) {
-      if (asPlainText) {
-        process.nextTick(() => {
-          callback(null, respBody);
-        });
-      } else {
-        try {
-          const parsedRespBody = JSON.parse(respBody);
-          process.nextTick(() => {
-            callback(null, parsedRespBody);
-          });
-        } catch (ex) {
-          const error = new Error('Invalid JSON response');
-          error.responseText = respBody;
-          process.nextTick(() => {
-            callback(error);
-          });
-        }
-      }
-    } else {
-      let errorMessage;
-      try {
-        const errorResponse = JSON.parse(respBody);
-        errorMessage = errorResponse.Message;
-      } catch (ex) {
-        errorMessage = respBody;
-      }
-      process.nextTick(() => {
-        const error = new Error(errorMessage);
-        error.responseText = respBody;
-        callback(error);
-      });
-    }
-  });
-};
-
-const handleFail = (err, callback) => {
-  const error = typeof err === 'string' ? new Error(err) : err;
-  process.nextTick(() => {
-    callback(error);
-  });
-};
-
-const sendRequest = (params, callback) => {
-  const req = new AWS.HttpRequest(awsEndpoint);
-  const rawResponse = params.rawResponse || false;
-
-  req.method = params.method.toUpperCase();
-  req.path = params.path;
-  req.region = region;
-  req.headers = params.headers || {};
-  req.headers['presigned-expires'] = false;
-  req.headers.Host = awsEndpoint.host;
-
-  if (params.message) {
-    req.body =
-      typeof params.message === 'string'
-        ? params.message
-        : JSON.stringify(params.message);
-  }
-
-  const signer = new AWS.Signers.V4(req, service);
-  signer.addAuthorization(awsCreds, new Date());
-
-  const send = new AWS.NodeHttpClient();
-  send.handleRequest(
-    req,
-    AWS.config.httpOptions,
-    /* istanbul ignore next */
-    httpResp => {
-      // eslint-disable-next-line no-unused-expressions
-      rawResponse
-        ? callback(null, httpResp)
-        : handleSuccess(httpResp, params.json === false, callback);
-    },
-    /* istanbul ignore next */
-    err => {
-      // eslint-disable-next-line no-unused-expressions
-      rawResponse ? callback(err) : handleFail(err, callback);
-    }
-  );
-};
-
-const signedRequest = (aws, config) => {
-  initialize(aws, config);
-
-  return {
-    /**
-     * Send a request
-     * @param {Object} params Object containing
-     *    * method: HTTP method (e.g GET, POST)
-     *    * path: Request path (e.g. '/_cat/indices')
-     *    * message: Request body (String or JSON)
-     *    * json: Boolean, whether the response from the server should be parsed as JSON
-     * @return {[type]} [description]
-     */
-    send(params, callback) {
-      if (!params) {
-        process.nextTick(() => {
-          callback(new TypeError('Missing or invalid parameters'));
-        });
-      } else if (!params.method) {
-        process.nextTick(() => {
-          callback(new TypeError('Missing method'));
-        });
-      } else {
-        try {
-          sendRequest(params, callback);
-        } catch (ex) /* istanbul ignore next */ {
-          process.nextTick(() => {
-            callback(ex);
-          });
-        }
-      }
-    },
-  };
-};
-
-export { initialize, handleSuccess, handleFail, sendRequest, signedRequest };
-export default signedRequest;

package/src/services/index.js

@@ -1,19 +0,0 @@
-import AuroraDbService from './AuroraDbService';
-import DynamoDbService from './DynamoDbService';
-import ElastiCacheService from './ElastiCacheService';
-import ElasticsearchService from './ElasticsearchService';
-import JwtService from './JwtService';
-import LoggerService from './LoggerService';
-import S3Service from './S3Service';
-import SQSService from './SQSService';
-
-export {
-  AuroraDbService,
-  DynamoDbService,
-  ElastiCacheService,
-  ElasticsearchService,
-  JwtService,
-  LoggerService,
-  S3Service,
-  SQSService,
-};

package/src/services/pagination/LengthAwarePaginator.js

@@ -1,49 +0,0 @@
-import Paginator from './Paginator';
-import LesgoException from '../../exceptions/LesgoException';
-import validateFields from '../../utils/validateFields';
-
-const FILE = 'Services/pagination/LengthAwarePaginator';
-
-export default class LengthAwarePaginator extends Paginator {
-  /**
-   * Constructor
-   *
-   * @param db
-   * @param sql
-   * @param sqlParams
-   * @param options
-   * @param connection
-   */
-  constructor(db, sql, sqlParams, options, connection = {}) {
-    const validFields = [{ key: 'total', type: 'number', required: true }];
-
-    let validated = {};
-    try {
-      validated = validateFields(options, validFields);
-    } catch (error) {
-      throw new LesgoException(
-        error.message,
-        `${FILE}::FIELD_VALIDATION_EXCEPTION`,
-        500,
-        {
-          ...options,
-          error,
-        }
-      );
-    }
-
-    const { total } = validated;
-
-    super(db, sql, sqlParams, options, connection);
-    this.totalProp = total;
-  }
-
-  /**
-   * Total items in all pages.
-   *
-   * @returns {null|number}
-   */
-  async total() {
-    return this.totalProp;
-  }
-}

package/src/services/pagination/Paginator.js

@@ -1,260 +0,0 @@
-import LesgoException from '../../exceptions/LesgoException';
-import validateFields from '../../utils/validateFields';
-
-const FILE = 'Services/pagination/Paginator';
-
-export default class Paginator {
-  /**
-   * Constructor
-   *
-   * @param db
-   * @param sql
-   * @param sqlParams
-   * @param options
-   */
-  constructor(db, sql, sqlParams, options = {}, connection = {}) {
-    const validFields = [
-      { key: 'db', type: 'object', required: true },
-      { key: 'sql', type: 'string', required: true },
-      { key: 'sqlParams', type: 'object', required: true },
-      { key: 'perPage', type: 'number', required: false },
-      { key: 'currentPage', type: 'number', required: false },
-      { key: 'connection', type: 'object', required: false },
-    ];
-
-    let validated = {};
-    try {
-      validated = validateFields(
-        {
-          db,
-          sql,
-          sqlParams,
-          ...options,
-          connection,
-        },
-        validFields
-      );
-    } catch (error) {
-      throw new LesgoException(
-        error.message,
-        `${FILE}::FIELD_VALIDATION_EXCEPTION`,
-        500,
-        {
-          ...options,
-          error,
-        }
-      );
-    }
-
-    const { perPage, currentPage } = validated;
-
-    this.dbProp = db;
-    this.sqlProp = sql;
-    this.sqlParamsProp = sqlParams;
-    this.perPageProp = perPage || 10;
-    this.currentPageProp = currentPage || 1;
-
-    this.hasNext = false;
-
-    this.response = [];
-    this.totalProp = false;
-
-    this.connection = connection;
-  }
-
-  /**
-   * Count all items in the current page.
-   *
-   * @returns {number}
-   */
-  async count() {
-    return this.response.length || (await this.executeQuery()).length;
-  }
-
-  /**
-   * Previous page
-   *
-   * @returns {boolean|number}
-   */
-  previousPage() {
-    if (this.currentPage() > 1) {
-      return this.currentPage() - 1;
-    }
-
-    return false;
-  }
-
-  /**
-   * The current page.
-   *
-   * @returns {*|number}
-   */
-  currentPage() {
-    return this.currentPageProp;
-  }
-
-  /**
-   * Next page
-   *
-   * @returns {Promise<boolean|*>}
-   */
-  async nextPage() {
-    if (this.response.length <= 0) {
-      await this.executeQuery();
-    }
-
-    if (this.hasNext) {
-      return this.currentPage() + 1;
-    }
-
-    return false;
-  }
-
-  /**
-   * First item in the current page.
-   *
-   * @returns {*}
-   */
-  async firstItem() {
-    if (this.response.length <= 0) {
-      await this.executeQuery();
-    }
-
-    return this.response[0];
-  }
-
-  /**
-   * Last item in the current page.
-   */
-  async lastItem() {
-    if (this.response.length <= 0) {
-      await this.executeQuery();
-    }
-
-    return this.response[this.response.length - 1];
-  }
-
-  /**
-   * Number of items per page.
-   *
-   * @returns {*}
-   */
-  perPage() {
-    return this.perPageProp;
-  }
-
-  /**
-   * Get the last page.
-   *
-   * @returns {Promise<number>}
-   */
-  async lastPage() {
-    return this.calculateTotalNumberOfPages();
-  }
-
-  /**
-   * Total items in all pages.
-   *
-   * @returns {null|number}
-   */
-  async total() {
-    return this.totalProp || this.countTotalItems();
-  }
-
-  /**
-   * All items in the current page.
-   *
-   * @returns {[]}
-   */
-  async items() {
-    if (this.response.length <= 0) {
-      await this.executeQuery();
-    }
-
-    return this.response;
-  }
-
-  /**
-   * Convert to object.
-   *
-   * @returns {Promise<{per_page: *, count: *, items: *, current_page: (*|number)}>}
-   */
-  async toObject() {
-    if (this.response.length <= 0) {
-      await this.executeQuery();
-    }
-
-    return {
-      count: await this.count(),
-      previous_page: this.previousPage(),
-      current_page: this.currentPage(),
-      next_page: await this.nextPage(),
-      last_page: await this.lastPage(),
-      per_page: this.perPage(),
-      total: await this.total(),
-      items: await this.items(),
-    };
-  }
-
-  // They act as protected methods.
-
-  getLimitAndOffsetByPageAndContentPerPage() {
-    const offset = this.currentPage() * this.perPage() - this.perPage();
-    const limit = this.perPage();
-
-    return {
-      offset,
-      limit,
-    };
-  }
-
-  generatePaginationSqlSnippet() {
-    const values = this.getLimitAndOffsetByPageAndContentPerPage();
-    const limitWithExtraData = values.limit + 1;
-    return this.sqlProp.concat(
-      ` LIMIT ${limitWithExtraData} OFFSET ${values.offset}`
-    );
-  }
-
-  async executeQuery() {
-    const total = this.totalProp;
-    if (
-      (typeof total === 'number' && total > 0) ||
-      (typeof total !== 'number' && !total)
-    ) {
-      this.response = await this.dbProp.select(
-        this.generatePaginationSqlSnippet(),
-        this.sqlParamsProp,
-        this.connection
-      );
-    }
-
-    this.hasNext = this.response.length > this.perPage();
-    if (this.hasNext) {
-      this.response.pop();
-    }
-
-    return this.response;
-  }
-
-  /**
-   * Count total items with basic implementation.
-   *
-   * @returns {Promise<number>}
-   */
-  async countTotalItems() {
-    const resp = await this.dbProp.select(
-      this.sqlProp,
-      this.sqlParamsProp,
-      this.connection
-    );
-    this.totalProp = Object.keys(resp).length;
-
-    return this.totalProp;
-  }
-
-  async calculateTotalNumberOfPages() {
-    const total = await this.total();
-    return Math.ceil(total / this.perPage());
-  }
-}